Synthetics / Client / create_group

create_group#

Synthetics.Client.create_group(**kwargs)#

Creates a group which you can use to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.

Groups are global resources. When you create a group, it is replicated across Amazon Web Services Regions, and you can view it and add canaries to it from any Region. Although the group ARN format reflects the Region name where it was created, a group is not constrained to any Region. This means that you can put canaries from multiple Regions into the same group, and then use that group to view and manage all of those canaries in a single view.

Groups are supported in all Regions except the Regions that are disabled by default. For more information about these Regions, see Enabling a Region.

Each group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary can be a member of up to 10 groups.

See also: AWS API Documentation

Request Syntax

response = client.create_group(
    Name='string',
    Tags={
        'string': 'string'
    }
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name for the group. It can include any Unicode characters.

    The names for all groups in your account, across all Regions, must be unique.

  • Tags (dict) –

    A list of key-value pairs to associate with the group. You can associate as many as 50 tags with a group.

    Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Group': {
        'Id': 'string',
        'Name': 'string',
        'Arn': 'string',
        'Tags': {
            'string': 'string'
        },
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • Group (dict) –

      A structure that contains information about the group that was just created.

      • Id (string) –

        The unique ID of the group.

      • Name (string) –

        The name of the group.

      • Arn (string) –

        The ARN of the group.

      • Tags (dict) –

        The list of key-value pairs that are associated with the canary.

        • (string) –

          • (string) –

      • CreatedTime (datetime) –

        The date and time that the group was created.

      • LastModifiedTime (datetime) –

        The date and time that the group was most recently updated.

Exceptions