« blib/lib/Paws/ECS/ListTaskDefinitionsResponse.pm
↑ Summary
blib/lib/Paws/ECS/ListTasksResponse.pm »
| 1 | |||
| 2 | package Paws::ECS::ListTasks; | ||
| 3 | use Moose; | ||
| 4 | has Cluster => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'cluster' ); | ||
| 5 | has ContainerInstance => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'containerInstance' ); | ||
| 6 | has DesiredStatus => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'desiredStatus' ); | ||
| 7 | has Family => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'family' ); | ||
| 8 | has LaunchType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'launchType' ); | ||
| 9 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' ); | ||
| 10 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' ); | ||
| 11 | has ServiceName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'serviceName' ); | ||
| 12 | has StartedBy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'startedBy' ); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListTasks'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::ListTasksResponse'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::ECS::ListTasks - Arguments for method ListTasks on L<Paws::ECS> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method ListTasks on the | ||
| 30 | L<Amazon EC2 Container Service|Paws::ECS> service. Use the attributes of this class | ||
| 31 | as arguments to method ListTasks. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListTasks. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $ecs = Paws->service('ECS'); | ||
| 38 | # To list the tasks in a cluster | ||
| 39 | # This example lists all of the tasks in a cluster. | ||
| 40 | my $ListTasksResponse = $ecs->ListTasks( 'Cluster' => 'default' ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $taskArns = $ListTasksResponse->taskArns; | ||
| 44 | |||
| 45 | # Returns a L<Paws::ECS::ListTasksResponse> object. | ||
| 46 | # To list the tasks on a particular container instance | ||
| 47 | # This example lists the tasks of a specified container instance. Specifying a | ||
| 48 | # ``containerInstance`` value limits the results to tasks that belong to | ||
| 49 | # that container instance. | ||
| 50 | my $ListTasksResponse = $ecs->ListTasks( | ||
| 51 | 'Cluster' => 'default', | ||
| 52 | 'ContainerInstance' => 'f6bbb147-5370-4ace-8c73-c7181ded911f' | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $taskArns = $ListTasksResponse->taskArns; | ||
| 57 | |||
| 58 | # Returns a L<Paws::ECS::ListTasksResponse> object. | ||
| 59 | |||
| 60 | 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. | ||
| 61 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ecs/ListTasks> | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 Cluster => Str | ||
| 67 | |||
| 68 | The short name or full Amazon Resource Name (ARN) of the cluster to use | ||
| 69 | when filtering the C<ListTasks> results. If you do not specify a | ||
| 70 | cluster, the default cluster is assumed. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 ContainerInstance => Str | ||
| 75 | |||
| 76 | The container instance ID or full ARN of the container instance to use | ||
| 77 | when filtering the C<ListTasks> results. Specifying a | ||
| 78 | C<containerInstance> limits the results to tasks that belong to that | ||
| 79 | container instance. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 DesiredStatus => Str | ||
| 84 | |||
| 85 | The task desired status to use when filtering the C<ListTasks> results. | ||
| 86 | Specifying a C<desiredStatus> of C<STOPPED> limits the results to tasks | ||
| 87 | that Amazon ECS has set the desired status to C<STOPPED>. This can be | ||
| 88 | useful for debugging tasks that are not starting properly or have died | ||
| 89 | or finished. The default status filter is C<RUNNING>, which shows tasks | ||
| 90 | that Amazon ECS has set the desired status to C<RUNNING>. | ||
| 91 | |||
| 92 | Although you can filter results based on a desired status of | ||
| 93 | C<PENDING>, this does not return any results. Amazon ECS never sets the | ||
| 94 | desired status of a task to that value (only a task's C<lastStatus> may | ||
| 95 | have a value of C<PENDING>). | ||
| 96 | |||
| 97 | Valid values are: C<"RUNNING">, C<"PENDING">, C<"STOPPED"> | ||
| 98 | |||
| 99 | =head2 Family => Str | ||
| 100 | |||
| 101 | The name of the task definition family to use when filtering the | ||
| 102 | C<ListTasks> results. Specifying a C<family> limits the results to | ||
| 103 | tasks that belong to that family. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 LaunchType => Str | ||
| 108 | |||
| 109 | The launch type to use when filtering the C<ListTasks> results. | ||
| 110 | |||
| 111 | Valid values are: C<"EC2">, C<"FARGATE">, C<"EXTERNAL"> | ||
| 112 | |||
| 113 | =head2 MaxResults => Int | ||
| 114 | |||
| 115 | The maximum number of task results returned by C<ListTasks> in | ||
| 116 | paginated output. When this parameter is used, C<ListTasks> only | ||
| 117 | returns C<maxResults> results in a single page along with a | ||
| 118 | C<nextToken> response element. The remaining results of the initial | ||
| 119 | request can be seen by sending another C<ListTasks> request with the | ||
| 120 | returned C<nextToken> value. This value can be between 1 and 100. If | ||
| 121 | this parameter is not used, then C<ListTasks> returns up to 100 results | ||
| 122 | and a C<nextToken> value if applicable. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 NextToken => Str | ||
| 127 | |||
| 128 | The C<nextToken> value returned from a C<ListTasks> request indicating | ||
| 129 | that more results are available to fulfill the request and further | ||
| 130 | calls will be needed. If C<maxResults> was provided, it is possible the | ||
| 131 | number of results to be fewer than C<maxResults>. | ||
| 132 | |||
| 133 | This token should be treated as an opaque identifier that is only used | ||
| 134 | to retrieve the next items in a list and not for other programmatic | ||
| 135 | purposes. | ||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head2 ServiceName => Str | ||
| 140 | |||
| 141 | The name of the service to use when filtering the C<ListTasks> results. | ||
| 142 | Specifying a C<serviceName> limits the results to tasks that belong to | ||
| 143 | that service. | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | =head2 StartedBy => Str | ||
| 148 | |||
| 149 | The C<startedBy> value with which to filter the task results. | ||
| 150 | Specifying a C<startedBy> value limits the results to tasks that were | ||
| 151 | started with that value. | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | =head1 SEE ALSO | ||
| 157 | |||
| 158 | This class forms part of L<Paws>, documenting arguments for method ListTasks in L<Paws::ECS> | ||
| 159 | |||
| 160 | =head1 BUGS and CONTRIBUTIONS | ||
| 161 | |||
| 162 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 163 | |||
| 164 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 165 | |||
| 166 | =cut | ||
| 167 |