PATCH

/group/{groupIdentifier}/associate

http://synthetics.{region}.amazonaws.com/group/{groupIdentifier}/associate

<p>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. </p> <p>You must run this operation in the Region where the canary exists.</p>

Access Token Required: API Key

Path Parameters

groupIdentifierstringrequired

Specifies the group. You can specify the group name, the ARN, or the group ID as the <code>GroupIdentifier</code>.

Body Params

ResourceArnstringrequired

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PATCH \
2     --url 'http://synthetics.{region}.amazonaws.com/group/{groupIdentifier}/associate' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}