Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetRuleCommandOutput

Hierarchy

Index

Properties

$metadata

$metadata: ResponseMetadata

Metadata pertaining to this request.

Optional Description

Description: undefined | string

The retention rule description.

Optional Identifier

Identifier: undefined | string

The unique ID of the retention rule.

Optional LockConfiguration

LockConfiguration: LockConfiguration

Information about the retention rule lock configuration.

Optional LockEndTime

LockEndTime: Date

The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

Optional LockState

LockState: LockState | string

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.

Optional ResourceTags

ResourceTags: ResourceTag[]

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

Optional ResourceType

ResourceType: ResourceType | string

The resource type retained by the retention rule.

Optional RetentionPeriod

RetentionPeriod: RetentionPeriod

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

Optional Status

Status: RuleStatus | string

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