ECS / Paginator / ListGatewayClusterAssociations

ListGatewayClusterAssociations

class ECS.Paginator.ListGatewayClusterAssociations

paginator = client.get_paginator('list_gateway_cluster_associations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ECS.Client.list_gateway_cluster_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    gateway='string',
    cluster='string',
    status=[
        'ACTIVE'|'DISASSOCIATING'|'INACTIVE',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• gateway (string) – The name or Amazon Resource Name (ARN) of a gateway to filter the results by.

• cluster (string) – The name or Amazon Resource Name (ARN) of a cluster to filter the results by.

• status (list) –

  The association status to filter the results by.

  • (string) –

    The status of an association between a gateway and a cluster.

• 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

{
    'gatewayClusterAssociations': [
        {
            'gatewayArn': 'string',
            'clusterArn': 'string',
            'status': 'ACTIVE'|'DISASSOCIATING'|'INACTIVE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • gatewayClusterAssociations (list) –

    The gateway-cluster associations that match the request.

    • (dict) –

      A summary of an association between a gateway and a cluster.

      • gatewayArn (string) –

        The Amazon Resource Name (ARN) of the gateway.

      • clusterArn (string) –

        The Amazon Resource Name (ARN) of the cluster.

      • status (string) –

        The status of the association.

  • NextToken (string) –

    A token to resume pagination.