AWS X-Ray
API Reference (API Version 2016-04-12)

GetGroups

Retrieves all active group details.

Request Syntax

POST /Groups HTTP/1.1 Content-type: application/json { "NextToken": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

NextToken

Pagination token. Not used.

Type: String

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

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Groups": [ { "FilterExpression": "string", "GroupARN": "string", "GroupName": "string" } ], "NextToken": "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.

Groups

The collection of all active groups.

Type: Array of GroupSummary objects

NextToken

Pagination token. Not used.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidRequestException

The request is missing required parameters or has invalid parameters.

HTTP Status Code: 400

ThrottledException

The request exceeds the maximum number of requests per second.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: