POST

/groups-list

http://resource-groups.{region}.amazonaws.com/groups-list

Returns a list of existing Resource Groups in your account. Minimum permissions To run this command, you must have the following permissions: <ul> <li> <code>resource-groups:ListGroups</code> </li> </ul>

Access Token Required: API Key

Query Params

maxResultsinteger

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.

nextTokenstring

The parameter for receiving additional results if you receive a <code>NextToken</code> response in a previous request. A <code>NextToken</code> response indicates that more output is available. Set this parameter to the value provided by a previous call's <code>NextToken</code> response to indicate where the output should continue from.

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Body Params

Filtersarray

Filters, formatted as <a>GroupFilter</a> objects, that you want to apply to a <code>ListGroups</code> operation. <ul> <li> <code>resource-type</code> - Filter the results to include only those of the specified resource types. Specify up to five resource types in the format <code>AWS::ServiceCode::ResourceType </code>. For example, <code>AWS::EC2::Instance</code>, or <code>AWS::S3::Bucket</code>. </li> <li> <code>configuration-type</code> - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are: <ul> <li> <code>AWS::EC2::CapacityReservationPool</code> </li> <li> <code>AWS::EC2::HostManagement</code> </li> </ul> </li> </ul>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://resource-groups.{region}.amazonaws.com/groups-list' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}