ListGroups
Returns a list of existing Resource Groups in your account.
Minimum permissions
To run this command, you must have the following permissions:
-
resource-groups:ListGroups
Request Syntax
POST /groups-list?maxResults=MaxResults
&nextToken=NextToken
HTTP/1.1
Content-type: application/json
{
"Filters": [
{
"Name": "string
",
"Values": [ "string
" ]
}
]
}
URI Request Parameters
The request uses the following URI parameters.
- MaxResults
-
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
NextToken
response element is present and has a value (is not null). Include that value as theNextToken
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 checkNextToken
after every operation to ensure that you receive all of the results.Valid Range: Minimum value of 1. Maximum value of 50.
- NextToken
-
The parameter for receiving additional results if you receive a
NextToken
response in a previous request. ANextToken
response indicates that more output is available. Set this parameter to the value provided by a previous call'sNextToken
response to indicate where the output should continue from.Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
^[a-zA-Z0-9+/]*={0,2}$
Request Body
The request accepts the following data in JSON format.
- Filters
-
Filters, formatted as GroupFilter objects, that you want to apply to a
ListGroups
operation.-
resource-type
- Filter the results to include only those resource groups that have the specified resource type in theirResourceTypeFilter
. For example,AWS::EC2::Instance
would return any resource group with aResourceTypeFilter
that includesAWS::EC2::Instance
. -
configuration-type
- Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:-
AWS::ResourceGroups::ApplicationGroup
-
AWS::AppRegistry::Application
-
AWS::AppRegistry::ApplicationResourceGroup
-
AWS::CloudFormation::Stack
-
AWS::EC2::CapacityReservationPool
-
AWS::EC2::HostManagement
-
AWS::NetworkFirewall::RuleGroup
-
Type: Array of GroupFilter objects
Required: No
-
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"GroupIdentifiers": [
{
"Criticality": number,
"Description": "string",
"DisplayName": "string",
"GroupArn": "string",
"GroupName": "string",
"Owner": "string"
}
],
"Groups": [
{
"ApplicationTag": {
"string" : "string"
},
"Criticality": number,
"Description": "string",
"DisplayName": "string",
"GroupArn": "string",
"Name": "string",
"Owner": "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.
- GroupIdentifiers
-
A list of GroupIdentifier objects. Each identifier is an object that contains both the
Name
and theGroupArn
.Type: Array of GroupIdentifier objects
- Groups
-
Important
Deprecated - don't use this field. Use the
GroupIdentifiers
response field instead.Type: Array of Group objects
- NextToken
-
If present, indicates that more output is available than is included in the current response. Use this value in the
NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
.Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
^[a-zA-Z0-9+/]*={0,2}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The request includes one or more parameters that violate validation rules.
HTTP Status Code: 400
- ForbiddenException
-
The caller isn't authorized to make the request. Check permissions.
HTTP Status Code: 403
- InternalServerErrorException
-
An internal error occurred while processing the request. Try again later.
HTTP Status Code: 500
- MethodNotAllowedException
-
The request uses an HTTP method that isn't allowed for the specified resource.
HTTP Status Code: 405
- TooManyRequestsException
-
You've exceeded throttling limits by making too many requests in a period of time.
HTTP Status Code: 429
Examples
Example
The following example lists all of the resource groups in the specified AWS Region and account.
Sample Request
POST /groups-list HTTP/1.1
Host: resource-groups.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.2.40 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/resource-groups.list-groups
X-Amz-Date: 20220119T231526Z
X-Amz-Security-Token: <SECURITY-TOKEN>
Authorization: AWS4-HMAC-SHA256 Credential=<ACCESS-KEY>/20220113/us-west-2/resource-groups/aws4_request,SignedHeaders=host;x-amz-date;x-amz-security-token,Signature=<SIGV4-SIGNATURE>
Content-Length: 0
Sample Response
HTTP/1.1 200 OK
Date: Wed, 19 Jan 2022 23:15:26 GMT
Content-Type: application/json
Content-Length: 5655
x-amzn-RequestId: <VARIES>
x-amz-apigw-id: <VARIES>
X-Amzn-Trace-Id: Root=<VARIES>
Connection: keep-alive
{
"GroupIdentifiers": [
{
"GroupName": "Group1",
"GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/Group1",
"OwnerId": "123456789012"
},
{
"GroupName": "Group2",
"GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/Group2",
"OwnerId": "123456789012"
},
{
"GroupName": "Group3",
"GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/Group3",
"OwnerId": "123456789012"
}
],
"Groups": [ ... DEPRECATED ... DO NOT USE ... ]
}
Example
The following example lists all resource groups that are configured with a
configure type of AWS::EC2::HostMangement
.
Sample Request
POST /groups-list HTTP/1.1
Host: resource-groups.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.2.40 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/resource-groups.list-groups
X-Amz-Date: 20220119T232648Z
X-Amz-Security-Token: <SECURITY-TOKEN>
Authorization: AWS4-HMAC-SHA256 Credential=<ACCESS-KEY>/20220113/us-west-2/resource-groups/aws4_request,SignedHeaders=host;x-amz-date;x-amz-security-token,Signature=<SIGV4-SIGNATURE>
Content-Length: 85
{
"Filters": [
{
"Name": "configuration-type",
"Values": [
"AWS::EC2::HostManagement"
]
}
]
}
Sample Response
HTTP/1.1 200 OK
Date: Wed, 19 Jan 2022 23:26:48 GMT
Content-Type: application/json
Content-Length: 621
x-amzn-RequestId: <VARIES>
x-amz-apigw-id: <VARIES>
X-Amzn-Trace-Id: Root=<VARIES>
Connection: keep-alive
{
"GroupIdentifiers": [
{
"GroupName": "HostManagementGroup1",
"GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/HostManagementGroup1",
"OwnerId": "123456789012"
},
{
"GroupName": "HostManagementGroup2",
"GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/HostManagementGroup2",
"OwnerId": "123456789012"
}
],
"Groups": [ ... DEPRECATED ... DO NOT USE ... ]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: