Synthetics / Client / list_associated_groups

list_associated_groups#

Synthetics.Client.list_associated_groups(**kwargs)#

Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.

See also: AWS API Documentation

Request Syntax

response = client.list_associated_groups(
    NextToken='string',
    MaxResults=123,
    ResourceArn='string'
)
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 ListAssociatedGroups operation. If you omit this parameter, the default of 20 is used.

  • ResourceArn (string) –

    [REQUIRED]

    The ARN of the canary that you want to view groups for.

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 contain information about the groups that this canary is associated with.

      • (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 ListAssociatedGroups operation to retrieve the next set of results.

Exceptions

  • Synthetics.Client.exceptions.InternalServerException

  • Synthetics.Client.exceptions.ValidationException

  • Synthetics.Client.exceptions.ResourceNotFoundException