Skip to content

S3  >  Operations  >  get_bucket_lifecycle_configuration

get_bucket_lifecycle_configuration

Operation

get_bucket_lifecycle_configuration async

get_bucket_lifecycle_configuration(request: GetBucketLifecycleConfigurationInput | GetBucketLifecycleConfigurationInputDict, /, *, plugins: list[Plugin] | None = None) -> GetBucketLifecycleConfigurationOutput
get_bucket_lifecycle_configuration(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBucketLifecycleConfigurationInputDict]) -> GetBucketLifecycleConfigurationOutput

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. Accordingly, this section describes the latest API, which is compatible with the new functionality. The previous version of the API supported filtering based only on an object key name prefix, which is supported for general purpose buckets for backward compatibility. For the related API description, see GetBucketLifecycle.

Note

Lifecyle configurations for directory buckets only support expiring objects and cancelling multipart uploads. Expiring of versioned objects, transitions and tag filters are not supported.

Permissions
  • General purpose bucket permissions - By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must have the s3:GetLifecycleConfiguration permission.

For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.

  • Directory bucket permissions - You must have the s3express:GetLifecycleConfiguration permission in an IAM identity-based policy to use this operation. Cross-account access to this API operation isn't supported. The resource owner can optionally grant access permissions to others by creating a role or user for them as long as they are within the same account as the owner and resource.

For more information about directory bucket policies and permissions, see Authorizing Regional endpoint APIs with IAM in the Amazon S3 User Guide.

Note: Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name. Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

GetBucketLifecycleConfiguration has the following special error:

  • Error code: NoSuchLifecycleConfiguration

  • Description: The lifecycle configuration does not exist.

  • HTTP Status Code: 404 Not Found

  • SOAP Fault Code Prefix: Client

The following operations are related to GetBucketLifecycleConfiguration:

Warning

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
GetBucketLifecycleConfigurationOutput

An instance of GetBucketLifecycleConfigurationOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

GetBucketLifecycleConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for GetBucketLifecycleConfigurationInput structure.

Attributes
bucket class-attribute instance-attribute
bucket: str | None = ...

The name of the bucket for which to get the lifecycle information.

expected_bucket_owner class-attribute instance-attribute
expected_bucket_owner: str | None = ...

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Note

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

Dictionaries

GetBucketLifecycleConfigurationInputDict

Bases: TypedDict

Dictionary form of GetBucketLifecycleConfigurationInput.

Attributes
bucket instance-attribute
bucket: Required[str]

The name of the bucket for which to get the lifecycle information.

expected_bucket_owner instance-attribute
expected_bucket_owner: str | None

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Note

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

Output

GetBucketLifecycleConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for GetBucketLifecycleConfigurationOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

rules class-attribute instance-attribute
rules: list[LifecycleRule] | None = ...

Container for a lifecycle rule.

transition_default_minimum_object_size class-attribute instance-attribute
transition_default_minimum_object_size: str | None = ...

Indicates which default minimum object size behavior is applied to the lifecycle configuration.

Note

This parameter applies to general purpose buckets only. It isn't supported for directory bucket lifecycle configurations.

  • all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.

  • varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.

To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.