Menu
AWS Resource Groups
Welcome (API Version 2017-11-27)

ListGroups

Returns a list of existing resource groups in your account.

Request Syntax

GET /groups?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

MaxResults

The maximum number of resource group results that are returned by ListGroups in paginated output. By default, this number is 50.

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

NextToken

The NextToken value that is returned in a paginated ListGroups request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Groups": [ { "Description": "string", "GroupArn": "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

A list of resource groups.

Type: Array of Group objects

NextToken

The NextToken value to include in a subsequent ListGroups request, to get more results.

Type: String

Errors

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

BadRequestException

The request does not comply with validation rules that are defined for the request parameters.

HTTP Status Code: 400

ForbiddenException

The caller is not authorized to make the request.

HTTP Status Code: 403

InternalServerErrorException

An internal error occurred while processing the request.

HTTP Status Code: 500

MethodNotAllowedException

The request uses an HTTP method which is not allowed for the specified resource.

HTTP Status Code: 405

TooManyRequestsException

The caller has exceeded throttling limits.

HTTP Status Code: 429

See Also

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