get_group

Synthetics.Client.get_group(**kwargs)

Returns information about one group. Groups are a global resource, so you can use this operation from any Region.

See also: AWS API Documentation

Request Syntax

response = client.get_group(
    GroupIdentifier='string'
)

Parameters

GroupIdentifier (string) --

[REQUIRED]

Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the GroupIdentifier .

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.

    • 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

• Synthetics.Client.exceptions.InternalServerException
• Synthetics.Client.exceptions.ValidationException
• Synthetics.Client.exceptions.ResourceNotFoundException
• Synthetics.Client.exceptions.ConflictException