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

ListGroups

Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned.

Request Syntax


POST /groups HTTP/1.1
Content-type: application/json

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

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MaxResults

Specify this parameter to limit how many groups are returned each time you use the ListGroups 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

{
   "Groups": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "Name": "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

An array of structures that each contain information about one group.

Type: Array of GroupSummary objects

NextToken

A token that indicates that there is more data available. You can use this token in a subsequent ListGroups operation to retrieve the next set of results.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 252.

Errors

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

InternalServerException

An unknown internal error occurred.

HTTP Status Code: 500

ValidationException

A parameter could not be validated.

HTTP Status Code: 400