Synthetics / Client / associate_resource

associate_resource#

Synthetics.Client.associate_resource(**kwargs)#

Associates a canary with a group. 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.

You must run this operation in the Region where the canary exists.

See also: AWS API Documentation

Request Syntax

response = client.associate_resource(
    GroupIdentifier='string',
    ResourceArn='string'
)
Parameters:

  • GroupIdentifier (string) –

    [REQUIRED]

    Specifies the group. You can specify the group name, the ARN, or the group ID as the GroupIdentifier.

  • ResourceArn (string) –

    [REQUIRED]

    The ARN of the canary that you want to associate with the specified group.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • Synthetics.Client.exceptions.InternalServerException

  • Synthetics.Client.exceptions.ValidationException

  • Synthetics.Client.exceptions.ResourceNotFoundException

  • Synthetics.Client.exceptions.ConflictException

  • Synthetics.Client.exceptions.ServiceQuotaExceededException