Synthetics / Client / list_group_resources
list_group_resources#
- Synthetics.Client.list_group_resources(**kwargs)#
This operation returns a list of the ARNs of the canaries that are associated with the specified group.
See also: AWS API Documentation
Request Syntax
response = client.list_group_resources( NextToken='string', MaxResults=123, GroupIdentifier='string' )
- Parameters:
NextToken (string) – A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.
MaxResults (integer) – Specify this parameter to limit how many canary ARNs are returned each time you use the
ListGroupResources
operation. If you omit this parameter, the default of 20 is used.GroupIdentifier (string) –
[REQUIRED]
Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the
GroupIdentifier
.
- Return type:
dict
- Returns:
Response Syntax
{ 'Resources': [ 'string', ], 'NextToken': 'string' }
Response Structure
(dict) –
Resources (list) –
An array of ARNs. These ARNs are for the canaries that are associated with the group.
(string) –
NextToken (string) –
A token that indicates that there is more data available. You can use this token in a subsequent
ListGroupResources
operation to retrieve the next set of results.
Exceptions
Synthetics.Client.exceptions.InternalServerException
Synthetics.Client.exceptions.ValidationException
Synthetics.Client.exceptions.ResourceNotFoundException
Synthetics.Client.exceptions.ConflictException