GroupResources - Amazon Resource Groups
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

GroupResources

Adds the specified resources to the specified group.

Important

You can use this operation with only resource groups that are configured with the following types:

  • AWS::EC2::HostManagement

  • AWS::EC2::CapacityReservationPool

Other resource group type and resource types aren't currently supported by this operation.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GroupResources

Request Syntax

POST /group-resources HTTP/1.1 Content-type: application/json { "Group": "string", "ResourceArns": [ "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 add resources to.

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,300}

Required: Yes

ResourceArns

The list of ARNs of the resources to be added to the group.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Pattern: arn:aws(-[a-z]+)*:[a-z0-9\-]*:([a-z]{2}(-[a-z]+)+-\d{1})?:([0-9]{12})?:.+

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Failed": [ { "ErrorCode": "string", "ErrorMessage": "string", "ResourceArn": "string" } ], "Pending": [ { "ResourceArn": "string" } ], "Succeeded": [ "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.

Failed

A list of ARNs of any resources that this operation failed to add to the group.

Type: Array of FailedResource objects

Pending

A list of ARNs of any resources that this operation is still in the process adding to the group. These pending additions continue asynchronously. You can check the status of pending additions by using the ListGroupResources operation, and checking the Resources array in the response and the Status field of each object in that array.

Type: Array of PendingResource objects

Succeeded

A list of ARNs of the resources that this operation successfully added to the group.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Pattern: arn:aws(-[a-z]+)*:[a-z0-9\-]*:([a-z]{2}(-[a-z]+)+-\d{1})?:([0-9]{12})?:.+

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 adds two Amazon EC2 capacity reservations to the specified resource group. The group is configured to allow only capacity reservations as group members.

Sample Request

POST /group-resources 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.group-resources X-Amz-Date: 20220114T203701Z 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: 199 { "Group": "CRPGroup", "ResourceArns": [ "arn:aws:ec2:us-west-2:123456789012:capacity-reservation/cr-0070b00d13EXAMPLE", "arn:aws:ec2:us-west-2:123456789012:capacity-reservation/cr-061abec820EXAMPLE" ] }

Sample Response

HTTP/1.1 200 OK Date: Fri, 14 Jan 2022 20:37:01 GMT Content-Type: application/json Content-Length: 119 x-amzn-RequestId: <VARIES> x-amz-apigw-id: <VARIES> X-Amzn-Trace-Id: Root=<VARIES> Connection: keep-alive { "Succeeded":[ "arn:aws:ec2:us-west-2:123456789012:capacity-reservation/cr-0070b00d13EXAMPLE", "arn:aws:ec2:us-west-2:123456789012:capacity-reservation/cr-061abec820EXAMPLE" ], "Failed":[], "Pending":[] }

See Also

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