Synthetics / Client / list_groups

list_groups#

Synthetics.Client.list_groups(**kwargs)#

Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned.

Request Syntax

response = client.list_groups(
    NextToken='string',
    MaxResults=123
)

Parameters:

NextToken (string) – A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.
MaxResults (integer) – Specify this parameter to limit how many groups are returned each time you use the ListGroups operation. If you omit this parameter, the default of 20 is used.

Return type:

dict

Returns:

Response Syntax

{
    'Groups': [
        {
            'Id': 'string',
            'Name': 'string',
            'Arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Groups (list) –
  
  An array of structures that each contain information about one group.
  - (dict) –
    
    A structure containing some information about a group.
    - Id (string) –
      
      The unique ID of the group.
    - Name (string) –
      
      The name of the group.
    - Arn (string) –
      
      The ARN of the group.
- NextToken (string) –
  
  A token that indicates that there is more data available. You can use this token in a subsequent ListGroups operation to retrieve the next set of results.

Exceptions

Synthetics.Client.exceptions.InternalServerException
Synthetics.Client.exceptions.ValidationException