« blib/lib/Paws/ECS/ListClustersResponse.pm
↑ Summary
blib/lib/Paws/ECS/ListContainerInstancesResponse.pm »
| 1 | |||
| 2 | package Paws::ECS::ListContainerInstances; | ||
| 3 | use Moose; | ||
| 4 | has Cluster => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'cluster' ); | ||
| 5 | has Filter => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'filter' ); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' ); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' ); | ||
| 8 | has Status => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'status' ); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListContainerInstances'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::ListContainerInstancesResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::ECS::ListContainerInstances - Arguments for method ListContainerInstances on L<Paws::ECS> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ListContainerInstances on the | ||
| 26 | L<Amazon EC2 Container Service|Paws::ECS> service. Use the attributes of this class | ||
| 27 | as arguments to method ListContainerInstances. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListContainerInstances. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $ecs = Paws->service('ECS'); | ||
| 34 | # To list your available container instances in a cluster | ||
| 35 | # This example lists all of your available container instances in the specified | ||
| 36 | # cluster in your default region. | ||
| 37 | my $ListContainerInstancesResponse = | ||
| 38 | $ecs->ListContainerInstances( 'Cluster' => 'default' ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $containerInstanceArns = | ||
| 42 | $ListContainerInstancesResponse->containerInstanceArns; | ||
| 43 | |||
| 44 | # Returns a L<Paws::ECS::ListContainerInstancesResponse> object. | ||
| 45 | |||
| 46 | 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. | ||
| 47 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ecs/ListContainerInstances> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 Cluster => Str | ||
| 53 | |||
| 54 | The short name or full Amazon Resource Name (ARN) of the cluster that | ||
| 55 | hosts the container instances to list. If you do not specify a cluster, | ||
| 56 | the default cluster is assumed. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 Filter => Str | ||
| 61 | |||
| 62 | You can filter the results of a C<ListContainerInstances> operation | ||
| 63 | with cluster query language statements. For more information, see | ||
| 64 | Cluster Query Language | ||
| 65 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) | ||
| 66 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 MaxResults => Int | ||
| 71 | |||
| 72 | The maximum number of container instance results returned by | ||
| 73 | C<ListContainerInstances> in paginated output. When this parameter is | ||
| 74 | used, C<ListContainerInstances> only returns C<maxResults> results in a | ||
| 75 | single page along with a C<nextToken> response element. The remaining | ||
| 76 | results of the initial request can be seen by sending another | ||
| 77 | C<ListContainerInstances> request with the returned C<nextToken> value. | ||
| 78 | This value can be between 1 and 100. If this parameter is not used, | ||
| 79 | then C<ListContainerInstances> returns up to 100 results and a | ||
| 80 | C<nextToken> value if applicable. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 NextToken => Str | ||
| 85 | |||
| 86 | The C<nextToken> value returned from a C<ListContainerInstances> | ||
| 87 | request indicating that more results are available to fulfill the | ||
| 88 | request and further calls will be needed. If C<maxResults> was | ||
| 89 | provided, it is possible the number of results to be fewer than | ||
| 90 | C<maxResults>. | ||
| 91 | |||
| 92 | This token should be treated as an opaque identifier that is only used | ||
| 93 | to retrieve the next items in a list and not for other programmatic | ||
| 94 | purposes. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 Status => Str | ||
| 99 | |||
| 100 | Filters the container instances by status. For example, if you specify | ||
| 101 | the C<DRAINING> status, the results include only container instances | ||
| 102 | that have been set to C<DRAINING> using UpdateContainerInstancesState. | ||
| 103 | If you do not specify this parameter, the default is to include | ||
| 104 | container instances set to all states other than C<INACTIVE>. | ||
| 105 | |||
| 106 | Valid values are: C<"ACTIVE">, C<"DRAINING">, C<"REGISTERING">, C<"DEREGISTERING">, C<"REGISTRATION_FAILED"> | ||
| 107 | |||
| 108 | |||
| 109 | =head1 SEE ALSO | ||
| 110 | |||
| 111 | This class forms part of L<Paws>, documenting arguments for method ListContainerInstances in L<Paws::ECS> | ||
| 112 | |||
| 113 | =head1 BUGS and CONTRIBUTIONS | ||
| 114 | |||
| 115 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 116 | |||
| 117 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 118 | |||
| 119 | =cut | ||
| 120 |