Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14105855.2 KB

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

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

patch/rules/{identifier}/lock

Path parameters

identifierstring required

The unique ID of the retention rule.

Request body

Response

Success

Identifierstring

The unique ID of the retention rule.

Descriptionstring

The retention rule description.

ResourceType'EBS_SNAPSHOT' | 'EC2_IMAGE' | 'EBS_VOLUME'

The resource type retained by the retention rule.

Status'pending' | 'available'

The state of the retention rule. Only retention rules that are in the <code>available</code> state retain resources.

LockState'locked' | 'pending_unlock' | 'unlocked'
<p>[Region-level retention rules only] The lock state for the retention rule.</p> <ul> <li> <p> <code>locked</code> - The retention rule is locked and can't be modified or deleted.</p> </li> <li> <p> <code>pending_unlock</code> - 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.</p> </li> <li> <p> <code>unlocked</code> - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.</p> </li> <li> <p> <code>null</code> - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the <code>locked</code> and <code>unlocked</code> states only; it can never transition back to <code>null</code>.</p> </li> </ul>
RuleArnstring

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