ECS / Client / list_gateway_cluster_associations

list_gateway_cluster_associations

ECS.Client.list_gateway_cluster_associations(**kwargs)

Returns a list of the associations between gateways and clusters. You can filter the results by gateway, cluster, and status. The results are paginated. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

See also: AWS API Documentation

Request Syntax

response = client.list_gateway_cluster_associations(
    gateway='string',
    cluster='string',
    status=[
        'ACTIVE'|'DISASSOCIATING'|'INACTIVE',
    ],
    maxResults=123,
    nextToken='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.

  • maxResults (integer) – The maximum number of results that the operation returns in a single page. The default is 100.

  • nextToken (string) – The nextToken value returned from a previous paginated request.

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) –

      The nextToken value to include in a future request to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions