S3 / Client / get_bucket_lifecycle_configuration

get_bucket_lifecycle_configuration#

S3.Client.get_bucket_lifecycle_configuration(**kwargs)#

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 Available Local Zone for directory buckets 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:

Request Syntax

response = client.get_bucket_lifecycle_configuration(
    Bucket='string',
    ExpectedBucketOwner='string'
)

Parameters:

Bucket (string) –
[REQUIRED]

The name of the bucket for which to get the lifecycle information.
ExpectedBucketOwner (string) –
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.

Return type:

dict

Returns:

Response Syntax

{
    'Rules': [
        {
            'Expiration': {
                'Date': datetime(2015, 1, 1),
                'Days': 123,
                'ExpiredObjectDeleteMarker': True|False
            },
            'ID': 'string',
            'Prefix': 'string',
            'Filter': {
                'Prefix': 'string',
                'Tag': {
                    'Key': 'string',
                    'Value': 'string'
                },
                'ObjectSizeGreaterThan': 123,
                'ObjectSizeLessThan': 123,
                'And': {
                    'Prefix': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'ObjectSizeGreaterThan': 123,
                    'ObjectSizeLessThan': 123
                }
            },
            'Status': 'Enabled'|'Disabled',
            'Transitions': [
                {
                    'Date': datetime(2015, 1, 1),
                    'Days': 123,
                    'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'DEEP_ARCHIVE'|'GLACIER_IR'
                },
            ],
            'NoncurrentVersionTransitions': [
                {
                    'NoncurrentDays': 123,
                    'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'DEEP_ARCHIVE'|'GLACIER_IR',
                    'NewerNoncurrentVersions': 123
                },
            ],
            'NoncurrentVersionExpiration': {
                'NoncurrentDays': 123,
                'NewerNoncurrentVersions': 123
            },
            'AbortIncompleteMultipartUpload': {
                'DaysAfterInitiation': 123
            }
        },
    ],
    'TransitionDefaultMinimumObjectSize': 'varies_by_storage_class'|'all_storage_classes_128K'
}

Response Structure

(dict) –
- Rules (list) –
  
  Container for a lifecycle rule.
  - (dict) –
    
    A lifecycle rule for individual objects in an Amazon S3 bucket.
    
    For more information see, Managing your storage lifecycle in the Amazon S3 User Guide.
    - Expiration (dict) –
      
      Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.
      - Date (datetime) –
        
        Indicates at what date the object is to be moved or deleted. The date value must conform to the ISO 8601 format. The time is always midnight UTC.
        
        Note
        This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
      - Days (integer) –
        
        Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
      - ExpiredObjectDeleteMarker (boolean) –
        
        Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.
        
        Note
        This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
    - ID (string) –
      
      Unique identifier for the rule. The value cannot be longer than 255 characters.
    - Prefix (string) –
      
      Prefix identifying one or more objects to which the rule applies. This is no longer used; use Filter instead.
      
      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.
    - Filter (dict) –
      
      The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified. Filter is required if the LifecycleRule does not contain a Prefix element.
      
      Note
      Tag filters are not supported for directory buckets.
      - Prefix (string) –
        
        Prefix identifying one or more objects to which the rule applies.
        
        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.
      - Tag (dict) –
        
        This tag must exist in the object’s tag set in order for the rule to apply.
        
        Note
        This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
        
        Key (string) –
        
        Name of the object key.
        
        Value (string) –
        
        Value of the tag.
      - ObjectSizeGreaterThan (integer) –
        
        Minimum object size to which the rule applies.
      - ObjectSizeLessThan (integer) –
        
        Maximum object size to which the rule applies.
      - And (dict) –
        
        This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.
        
        Prefix (string) –
        
        Prefix identifying one or more objects to which the rule applies.
        
        Tags (list) –
        
        All of these tags must exist in the object’s tag set in order for the rule to apply.
        
        (dict) –
        
        A container of a key value name pair.
        
        Key (string) –
        
        Name of the object key.
        
        Value (string) –
        
        Value of the tag.
        
        ObjectSizeGreaterThan (integer) –
        
        Minimum object size to which the rule applies.
        
        ObjectSizeLessThan (integer) –
        
        Maximum object size to which the rule applies.
    - Status (string) –
      
      If ‘Enabled’, the rule is currently being applied. If ‘Disabled’, the rule is not currently being applied.
    - Transitions (list) –
      
      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.
      - (dict) –
        
        Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.
        
        Date (datetime) –
        
        Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.
        
        Days (integer) –
        
        Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.
        
        StorageClass (string) –
        
        The storage class to which you want the object to transition.
    - NoncurrentVersionTransitions (list) –
      
      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.
      - (dict) –
        
        Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE 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 the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class at a specific period in the object’s lifetime.
        
        NoncurrentDays (integer) –
        
        Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon S3 User Guide.
        
        StorageClass (string) –
        
        The class of storage used to store the object.
        
        NewerNoncurrentVersions (integer) –
        
        Specifies how many noncurrent versions Amazon S3 will retain in the same storage class before transitioning objects. You can specify up to 100 noncurrent versions to retain. Amazon S3 will transition any additional noncurrent versions beyond the specified number to retain. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.
    - NoncurrentVersionExpiration (dict) –
      
      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.
      - NoncurrentDays (integer) –
        
        Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. The value must be a non-zero positive integer. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide.
        
        Note
        This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
      - NewerNoncurrentVersions (integer) –
        
        Specifies how many noncurrent versions Amazon S3 will retain. You can specify up to 100 noncurrent versions to retain. Amazon S3 will permanently delete any additional noncurrent versions beyond the specified number to retain. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.
        
        Note
        This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
    - AbortIncompleteMultipartUpload (dict) –
      
      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.
      - DaysAfterInitiation (integer) –
        
        Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.
- TransitionDefaultMinimumObjectSize (string) –
  
  Indicates which default minimum object size behavior is applied to the lifecycle configuration.
  
  Note
  This parameter applies to general purpose buckets only. It is not 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.

Examples

The following example retrieves lifecycle configuration on set on a bucket.

response = client.get_bucket_lifecycle_configuration(
    Bucket='examplebucket',
)

print(response)

Expected Output:

{
    'Rules': [
        {
            'ID': 'Rule for TaxDocs/',
            'Prefix': 'TaxDocs',
            'Status': 'Enabled',
            'Transitions': [
                {
                    'Days': 365,
                    'StorageClass': 'STANDARD_IA',
                },
            ],
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

get_bucket_lifecycle_configuration#

Note

Note

Request Syntax

Note

Response Syntax

Response Structure

Note

Note

Warning

Note

Warning

Note

Note

Note

Note

Note

Note

Note

Examples