Skip to content

Associates a canary with a group

Description

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.

Usage

synthetics_associate_resource(GroupIdentifier, ResourceArn)

Arguments

  • GroupIdentifier

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

  • ResourceArn

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

Value

An empty list.

Request syntax

svc$associate_resource(
  GroupIdentifier = "string",
  ResourceArn = "string"
)