Skip to content

S3  >  Dictionaries  >  LifecycleRuleDict

LifecycleRuleDict

Dictionary Type

LifecycleRuleDict

Bases: TypedDict

Dictionary form of LifecycleRule.

Attributes

abort_incomplete_multipart_upload instance-attribute
abort_incomplete_multipart_upload: AbortIncompleteMultipartUpload | AbortIncompleteMultipartUploadDict | None

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in the Amazon S3 User Guide.

expiration instance-attribute

Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

filter instance-attribute

The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, ObjectSizeGreaterThan, ObjectSizeLessThan, or And specified. Filter is required if the LifecycleRule does not contain a Prefix element.

For more information about Tag filters, see Adding filters to Lifecycle rules in the Amazon S3 User Guide.

Note

Tag filters are not supported for directory buckets.

id instance-attribute
id: str | None

Unique identifier for the rule. The value cannot be longer than 255 characters.

noncurrent_version_expiration instance-attribute
noncurrent_version_expiration: NoncurrentVersionExpiration | NoncurrentVersionExpirationDict | None

Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.

Note

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

noncurrent_version_transitions instance-attribute
noncurrent_version_transitions: Sequence[NoncurrentVersionTransition | NoncurrentVersionTransitionDict] | None

Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

Note

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

prefix instance-attribute
prefix: str | None

The general purpose bucket prefix that identifies one or more objects to which the rule applies. We recommend using Filter instead of Prefix for new PUTs. Previous configurations where a prefix is defined will continue to operate as before.

Warning

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

status instance-attribute
status: Required[str]

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

transitions instance-attribute
transitions: Sequence[Transition | TransitionDict] | None

Specifies when an Amazon S3 object transitions to a specified storage class.

Note

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.