GetGroup
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 ARN of the resource group to retrieve.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
(arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\d{1}:[0-9]{12}:group/)?[a-zA-Z0-9_\.-]{1,128}
Required: No
- GroupName
-
Deprecated - don't use this parameter. Use
Group
instead.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_\.-]+
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Group": {
"Description": "string",
"GroupArn": "string",
"Name": "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.
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 shows details about a resource group with a tag-based query. Use GetGroupQuery to get the details of the attached resource query.
Sample Request
POST /get-group HTTP/1.1
Content-type: application/json
{"Group": "TestQueryGroup"}
Sample Response
HTTP/1.1 200
Content-type: application/json
{
"Group": {
"GroupArn": "arn:aws:resource-groups:us-east-1:123456789012:group/TestQueryGroup",
"Name": "TestQueryGroup",
}
}
Example
The following example shows details about a resource group with a service configuration. Use GetGroupConfiguration to get the details of the attached service configuration.
Sample Request
POST /get-group HTTP/1.1
Content-type: application/json
{"Group": "TestCRPGroup"}
Sample Response
HTTP/1.1 200
Content-type: application/json
{
"Group": {
"GroupArn": "arn:aws:resource-groups:us-east-1:123456789012:group/TestCRPGroup",
"Name": "TestCRPGroup",
}
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: