GetRule - Recycle Bin

GetRule

Gets information about a Recycle Bin retention rule.

Request Syntax

GET /rules/identifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

identifier

The unique ID of the retention rule.

Pattern: [0-9a-zA-Z]{11}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Description": "string", "Identifier": "string", "ResourceTags": [ { "ResourceTagKey": "string", "ResourceTagValue": "string" } ], "ResourceType": "string", "RetentionPeriod": { "RetentionPeriodUnit": "string", "RetentionPeriodValue": number }, "Status": "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.

Description

The retention rule description.

Type: String

Pattern: ^[\S ]{0,255}$

Identifier

The unique ID of the retention rule.

Type: String

Pattern: [0-9a-zA-Z]{11}

ResourceTags

Information about the resource tags used to identify resources that are retained by the retention rule.

Type: Array of ResourceTag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

ResourceType

The resource type retained by the retention rule.

Type: String

Valid Values: EBS_SNAPSHOT | EC2_IMAGE

RetentionPeriod

Information about the retention period for which the retention rule is to retain resources.

Type: RetentionPeriod object

Status

The state of the retention rule. Only retention rules that are in the available state retain resources.

Type: String

Valid Values: pending | available

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The service could not respond to the request due to an internal problem.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ValidationException

One or more of the parameters in the request is not valid.

HTTP Status Code: 400

See Also

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