DirectConnect / Client / list_resiliency_groups

list_resiliency_groups¶

DirectConnect.Client.list_resiliency_groups(**kwargs)¶

Lists the resiliency groups owned by your Amazon Web Services account in the current Amazon Web Services Region.

Request Syntax

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

Parameters:

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',
            'resiliencyGroupArn': 'string',
            'resiliencyGroupName': 'string',
            'resiliencyGroupType': 'Managed',
            'ownerAccount': 'string',
            'state': 'pending'|'available'|'deleting'|'deleted'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  Summary information about the resiliency groups.
  - (dict) –
    
    Summary information about a resiliency group.
    - resiliencyGroupId (string) –
      
      The ID of the resiliency group.
    - resiliencyGroupArn (string) –
      
      The Amazon Resource Name (ARN) of the resiliency group.
    - resiliencyGroupName (string) –
      
      The name of the resiliency group.
    - resiliencyGroupType (string) –
      
      The type of the resiliency group. The valid value is Managed.
    - ownerAccount (string) –
      
      The ID of the Amazon Web Services account that owns the resiliency group.
    - state (string) –
      
      The state of the resiliency group.
- 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