associated_groups

Creates, updates, deletes, gets or lists an associated_groups resource.

Overview

Name	associated_groups
Type	Resource
Id	aws.synthetics.associated_groups

Fields

The following fields are returned by SELECT queries:

list_associated_groups

Name	Datatype	Description
groups	array	An array of structures that contain information about the groups that this canary is associated with.
next_token	string	A token that indicates that there is more data available. You can use this token in a subsequent ListAssociatedGroups operation to retrieve the next set of results. (pattern: <code>^.+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_associated_groups	select	resource_arn, region		Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
resource_arn	string	The ARN of the canary that you want to view groups for.

SELECT examples

list_associated_groups

Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.

SELECT
groups,
next_token
FROM aws.synthetics.associated_groups
WHERE resource_arn = '{{ resource_arn }}' -- required
AND region = '{{ region }}' -- required
;