Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListGroupResources

This operation returns a list of the ARNs of the canaries that are associated with the specified group.

Request Syntax


POST /group/groupIdentifier/resources HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

groupIdentifier

Specifies the group to return information for. 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.

MaxResults

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 20.

Required: No

NextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^.+$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Resources": [ "string" ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^.+$

Resources

An array of ARNs. These ARNs are for the canaries that are associated with the group.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 1024.

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

ValidationException

A parameter could not be validated.

HTTP Status Code: 400