RuleSummary - Recycle Bin
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 (PDF).


Information about a Recycle Bin retention rule.



The retention rule description.

Type: String

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

Required: No


The unique ID of the retention rule.

Type: String

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

Required: No


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

Required: No


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

Type: RetentionPeriod object

Required: No


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}$

Required: No

See Also

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