AssociateResource
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.
Request Syntax
PATCH /group/groupIdentifier/associate HTTP/1.1
Content-type: application/json
{
"ResourceArn": "string"
}URI Request Parameters
The request uses the following URI parameters.
- groupIdentifier
-
Specifies the group. You can specify the group name, the ARN, or the group ID as the
GroupIdentifier.Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- ResourceArn
-
The ARN of the canary that you want to associate with the specified group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:canary:[0-9a-z_\-]{1,21}Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
A conflicting operation is already in progress.
HTTP Status Code: 409
- InternalServerException
-
An unknown internal error occurred.
HTTP Status Code: 500
- ResourceNotFoundException
-
One of the specified resources was not found.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The request exceeded a service quota value.
HTTP Status Code: 402
- ValidationException
-
A parameter could not be validated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
