S3Control / Client / get_bucket_lifecycle_configuration

get_bucket_lifecycle_configuration#

S3Control.Client.get_bucket_lifecycle_configuration(**kwargs)#

Note

This action gets an Amazon S3 on Outposts bucket’s lifecycle configuration. To get an S3 bucket’s lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference.

Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon S3 User Guide.

To use this action, you must have permission to perform the s3-outposts:GetLifecycleConfiguration action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

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 actions are related to GetBucketLifecycleConfiguration:

Request Syntax

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

Parameters:

AccountId (string) –
[REQUIRED]

The Amazon Web Services account ID of the Outposts bucket.
Bucket (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the bucket.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

Return type:

dict

Returns:

Response Syntax

{
    'Rules': [
        {
            'Expiration': {
                'Date': datetime(2015, 1, 1),
                'Days': 123,
                'ExpiredObjectDeleteMarker': True|False
            },
            'ID': 'string',
            'Filter': {
                'Prefix': 'string',
                'Tag': {
                    'Key': 'string',
                    'Value': 'string'
                },
                'And': {
                    'Prefix': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'ObjectSizeGreaterThan': 123,
                    'ObjectSizeLessThan': 123
                },
                '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'
                },
            ],
            'NoncurrentVersionTransitions': [
                {
                    'NoncurrentDays': 123,
                    'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'DEEP_ARCHIVE'
                },
            ],
            'NoncurrentVersionExpiration': {
                'NoncurrentDays': 123,
                'NewerNoncurrentVersions': 123
            },
            'AbortIncompleteMultipartUpload': {
                'DaysAfterInitiation': 123
            }
        },
    ]
}

Response Structure

(dict) –
- Rules (list) –
  
  Container for the lifecycle rule of the Outposts bucket.
  - (dict) –
    
    The container for the Outposts bucket lifecycle rule.
    - 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 deleted. Should be in GMT ISO 8601 format.
      - 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.
    - ID (string) –
      
      Unique identifier for the rule. The value cannot be longer than 255 characters.
    - Filter (dict) –
      
      The container for the filter of lifecycle rule.
      - Prefix (string) –
        
        Prefix identifying one or more objects to which the rule applies.
        
        Warning
        When you’re using XML requests, you must replace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. For more information, see XML-related object key constraints in the Amazon S3 User Guide.
      - Tag (dict) –
        
        A container for a key-value name pair.
        
        Key (string) –
        
        Key of the tag
        
        Value (string) –
        
        Value of the tag
      - And (dict) –
        
        The container for the AND condition for the lifecycle rule.
        
        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 for a key-value name pair.
        
        Key (string) –
        
        Key of the tag
        
        Value (string) –
        
        Value of the tag
        
        ObjectSizeGreaterThan (integer) –
        
        The non-inclusive minimum object size for the lifecycle rule. Setting this property to 7 means the rule applies to objects with a size that is greater than 7.
        
        ObjectSizeLessThan (integer) –
        
        The non-inclusive maximum object size for the lifecycle rule. Setting this property to 77 means the rule applies to objects with a size that is less than 77.
      - 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 is not supported by Amazon S3 on Outposts buckets.
      - (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 is not supported by Amazon S3 on Outposts buckets.
      - (dict) –
        
        The container for the noncurrent version transition.
        
        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.
    - NoncurrentVersionExpiration (dict) –
      
      The noncurrent version expiration of the lifecycle rule.
      - 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 When an Object Became Noncurrent in the Amazon S3 User Guide.
      - NewerNoncurrentVersions (integer) –
        
        Specifies how many noncurrent versions S3 on Outposts will retain. If there are this many more recent noncurrent versions, S3 on Outposts will take the associated action. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.
    - AbortIncompleteMultipartUpload (dict) –
      
      Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits 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 to the Outposts bucket.