LockRule - Recycle Bin
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

LockRule

Locks a Region-level retention rule. A locked retention rule can't be modified or deleted.

Note

You can't lock tag-level retention rules, or Region-level retention rules that have exclusion tags.

Request Syntax

PATCH /rules/identifier/lock HTTP/1.1
Content-type: application/json

{
   "LockConfiguration": { 
      "UnlockDelay": { 
         "UnlockDelayUnit": "string",
         "UnlockDelayValue": number
      }
   }
}

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 accepts the following data in JSON format.

LockConfiguration

Information about the retention rule lock configuration.

Type: LockConfiguration object

Required: Yes

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "Description": "string",
   "ExcludeResourceTags": [ 
      { 
         "ResourceTagKey": "string",
         "ResourceTagValue": "string"
      }
   ],
   "Identifier": "string",
   "LockConfiguration": { 
      "UnlockDelay": { 
         "UnlockDelayUnit": "string",
         "UnlockDelayValue": number
      }
   },
   "LockState": "string",
   "ResourceTags": [ 
      { 
         "ResourceTagKey": "string",
         "ResourceTagValue": "string"
      }
   ],
   "ResourceType": "string",
   "RetentionPeriod": { 
      "RetentionPeriodUnit": "string",
      "RetentionPeriodValue": number
   },
   "RuleArn": "string",
   "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}$

ExcludeResourceTags

[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

Type: Array of ResourceTag objects

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

Identifier

The unique ID of the retention rule.

Type: String

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

LockConfiguration

Information about the retention rule lock configuration.

Type: LockConfiguration object

LockState

[Region-level retention rules only] The lock state for the retention rule.

  • locked - The retention rule is locked and can't be modified or deleted.

  • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

  • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

  • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

Type: String

Valid Values: locked | pending_unlock | unlocked

ResourceTags

[Tag-level retention rules only] 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

RuleArn

The Amazon Resource Name (ARN) of the retention rule.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1011.

Pattern: ^arn:aws(-[a-z]{1,3}){0,2}:rbin:[a-z\-0-9]{0,63}:[0-9]{12}:rule/[0-9a-zA-Z]{11}{0,1011}$

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.

ConflictException

The specified retention rule lock request can't be completed.

HTTP Status Code: 409

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: