« blib/lib/Paws/ECS/DescribeTaskSetsResponse.pm
↑ Summary
blib/lib/Paws/ECS/DescribeTasksResponse.pm »
| 1 | |||
| 2 | package Paws::ECS::DescribeTasks; | ||
| 3 | use Moose; | ||
| 4 | has Cluster => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'cluster' ); | ||
| 5 | has Include => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'include' ); | ||
| 6 | has Tasks => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'tasks' , required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeTasks'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::DescribeTasksResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::ECS::DescribeTasks - Arguments for method DescribeTasks on L<Paws::ECS> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DescribeTasks on the | ||
| 24 | L<Amazon EC2 Container Service|Paws::ECS> service. Use the attributes of this class | ||
| 25 | as arguments to method DescribeTasks. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeTasks. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $ecs = Paws->service('ECS'); | ||
| 32 | # To describe a task | ||
| 33 | # This example provides a description of the specified task, using the task UUID | ||
| 34 | # as an identifier. | ||
| 35 | my $DescribeTasksResponse = $ecs->DescribeTasks( | ||
| 36 | 'Tasks' => ['c5cba4eb-5dad-405e-96db-71ef8eefe6a8'] ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $failures = $DescribeTasksResponse->failures; | ||
| 40 | my $tasks = $DescribeTasksResponse->tasks; | ||
| 41 | |||
| 42 | # Returns a L<Paws::ECS::DescribeTasksResponse> object. | ||
| 43 | |||
| 44 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ecs/DescribeTasks> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 Cluster => Str | ||
| 51 | |||
| 52 | The short name or full Amazon Resource Name (ARN) of the cluster that | ||
| 53 | hosts the task or tasks to describe. If you do not specify a cluster, | ||
| 54 | the default cluster is assumed. This parameter is required if the task | ||
| 55 | or tasks you are describing were launched in any cluster other than the | ||
| 56 | default cluster. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 Include => ArrayRef[Str|Undef] | ||
| 61 | |||
| 62 | Specifies whether you want to see the resource tags for the task. If | ||
| 63 | C<TAGS> is specified, the tags are included in the response. If this | ||
| 64 | field is omitted, tags are not included in the response. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> Tasks => ArrayRef[Str|Undef] | ||
| 69 | |||
| 70 | A list of up to 100 task IDs or full ARN entries. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, documenting arguments for method DescribeTasks in L<Paws::ECS> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |