UngroupResources - AWS Resource Groups

UngroupResources

Removes the specified resources from the specified group. This operation works only with static groups that you populated using the GroupResources operation. It doesn't work with any resource groups that are automatically populated by tag-based or AWS CloudFormation stack-based queries.

Minimum permissions

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

  • resource-groups:UngroupResources

Request Syntax

POST /ungroup-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 from which to remove the resources.

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 ARNs of the resources to be removed from 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 any resources that failed to be removed from the group by this operation.

Type: Array of FailedResource objects

Pending

A list of any resources that are still in the process of being removed from the group by this operation. These pending removals continue asynchronously. You can check the status of pending removals by using the ListGroupResources operation. After the resource is successfully removed, it no longer appears in the response.

Type: Array of PendingResource objects

Succeeded

A list of resources that were successfully removed from the group by this operation.

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 removes two resources from the specified group.

Sample Request

POST /ungroup-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.ungroup-resources X-Amz-Date: 20220114T205720Z 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:57:20 GMT Content-Type: application/json Content-Length: 198 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 AWS SDKs, see the following: