ECS / Paginator / ListContainerInstances
ListContainerInstances#
- class ECS.Paginator.ListContainerInstances#
paginator = client.get_paginator('list_container_instances')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
ECS.Client.list_container_instances()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( cluster='string', filter='string', status='ACTIVE'|'DRAINING'|'REGISTERING'|'DEREGISTERING'|'REGISTRATION_FAILED', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
cluster (string) – 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 (string) – You can filter the results of a
ListContainerInstances
operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.status (string) – Filters the container instances by status. For example, if you specify the
DRAINING
status, the results include only container instances that have been set toDRAINING
using UpdateContainerInstancesState. If you don’t specify this parameter, the default is to include container instances set to all states other thanINACTIVE
.PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'containerInstanceArns': [ 'string', ], 'NextToken': 'string' }
Response Structure
(dict) –
containerInstanceArns (list) –
The list of container instances with full ARN entries for each container instance associated with the specified cluster.
(string) –
NextToken (string) –
A token to resume pagination.