DirectConnect / Client / list_resiliency_group_associations

list_resiliency_group_associations¶

DirectConnect.Client.list_resiliency_group_associations(**kwargs)¶

Lists the connection associations for the specified resiliency group.

Request Syntax

response = client.list_resiliency_group_associations(
    resiliencyGroupId='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

resiliencyGroupId (string) –
[REQUIRED]

The ID of the resiliency group.
maxResults (integer) –
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.
nextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'resiliencyGroupId': 'string',
            'connectionArn': 'string',
            'state': 'associating'|'associated'|'disassociating'|'disassociated'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  The connection associations for the resiliency group.
  - (dict) –
    
    Information about an association between a connection and a resiliency group.
    - resiliencyGroupId (string) –
      
      The ID of the resiliency group.
    - connectionArn (string) –
      
      The Amazon Resource Name (ARN) of the associated connection.
    - state (string) –
      
      The state of the association. The valid values are associating, associated, disassociating, and disassociated.
- nextToken (string) –
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

DirectConnect.Client.exceptions.DirectConnectServerException
DirectConnect.Client.exceptions.DirectConnectClientException