/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ECS::ListContainerInstances

NAME

Paws::ECS::ListContainerInstances - Arguments for method ListContainerInstances on Paws::ECS

DESCRIPTION

This class represents the parameters used for calling the method ListContainerInstances on the Amazon EC2 Container Service service. Use the attributes of this class as arguments to method ListContainerInstances.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListContainerInstances.

SYNOPSIS

   my $ecs = Paws->service('ECS');
# To list your available container instances in a cluster
# This example lists all of your available container instances in the specified
# cluster in your default region.
   my $ListContainerInstancesResponse =
     $ecs->ListContainerInstances( 'Cluster' => 'default' );

   # Results:
   my $containerInstanceArns =
     $ListContainerInstancesResponse->containerInstanceArns;

   # Returns a L<Paws::ECS::ListContainerInstancesResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ecs/ListContainerInstances

ATTRIBUTES

Cluster => Str

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

Filter => Str

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the Amazon Elastic Container Service Developer Guide.

MaxResults => Int

The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

NextToken => Str

The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Status => Str

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container instances set to all states other than INACTIVE.

Valid values are: "ACTIVE", "DRAINING", "REGISTERING", "DEREGISTERING", "REGISTRATION_FAILED"

SEE ALSO

This class forms part of Paws, documenting arguments for method ListContainerInstances in Paws::ECS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues