Returns information about a specified resource group.
Minimum permissions
To run this command, you must have the following permissions:
-
resource-groups:GetGroup
Request Syntax
POST /get-group HTTP/1.1
Content-type: application/json
{
"Group": "string",
"GroupName": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- Group
-
The name or the Amazon resource name (ARN) of the resource group to retrieve.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
[a-zA-Z0-9_\.-]{1,300}|[a-zA-Z0-9_\.-]{1,150}/[a-z0-9]{26}|arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\d{1}:[0-9]{12}:group/([a-zA-Z0-9_\.-]{1,300}|[a-zA-Z0-9_\.-]{1,150}/[a-z0-9]{26})Required: No
- GroupName
-
Deprecated - don't use this parameter. Use
Groupinstead.Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Pattern:
[a-zA-Z0-9_\.-]{1,300}|[a-zA-Z0-9_\.-]{1,150}/[a-z0-9]{26}Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Group": {
"ApplicationTag": {
"string" : "string"
},
"Criticality": number,
"Description": "string",
"DisplayName": "string",
"GroupArn": "string",
"Name": "string",
"Owner": "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.
- Group
-
A structure that contains the metadata details for the specified resource group. Use GetGroupQuery and GetGroupConfiguration to get those additional details of the resource group.
Type: Group object
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
- NotFoundException
-
One or more of the specified resources don't exist.
HTTP Status Code: 404
- 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 displays the metadata about a resource group in the
us-west-2 Region for the calling AWS account. You can then
use GetGroupQuery and GetGroupConfiguration
to get the details of the resource group.
Sample Request
POST /get-group 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.get-group
X-Amz-Date: 20220113T211658Z
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: 21
{"Group": "CRPGroup"}Sample Response
HTTP/1.1 200 OK
Date: Thu, 13 Jan 2022 21:16:58 GMT
Content-Type: application/json
Content-Length: 193
x-amzn-RequestId: <VARIES>
x-amz-apigw-id: <VARIES>
X-Amzn-Trace-Id: Root=<VARIES>
Connection: keep-alive
{
"Group":{
"GroupArn":"arn:aws:resource-groups:us-west-2:123456789012:group/CRPGroup",
"Name":"CRPGroup",
"Description":"Resource group for capacity reservations.",
"OwnerId":"123456789012"
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
