S3 / Client / get_bucket_intelligent_tiering_configuration

get_bucket_intelligent_tiering_configuration#

S3.Client.get_bucket_intelligent_tiering_configuration(**kwargs)#

Note

This operation is not supported for directory buckets.

Gets the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to GetBucketIntelligentTieringConfiguration include:

Request Syntax

response = client.get_bucket_intelligent_tiering_configuration(
    Bucket='string',
    Id='string'
)

Parameters:

Bucket (string) –
[REQUIRED]

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
Id (string) –
[REQUIRED]

The ID used to identify the S3 Intelligent-Tiering configuration.

Return type:

dict

Returns:

Response Syntax

{
    'IntelligentTieringConfiguration': {
        'Id': 'string',
        'Filter': {
            'Prefix': 'string',
            'Tag': {
                'Key': 'string',
                'Value': 'string'
            },
            'And': {
                'Prefix': 'string',
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            }
        },
        'Status': 'Enabled'|'Disabled',
        'Tierings': [
            {
                'Days': 123,
                'AccessTier': 'ARCHIVE_ACCESS'|'DEEP_ARCHIVE_ACCESS'
            },
        ]
    }
}

Response Structure

(dict) –
- IntelligentTieringConfiguration (dict) –
  
  Container for S3 Intelligent-Tiering configuration.
  - Id (string) –
    
    The ID used to identify the S3 Intelligent-Tiering configuration.
  - Filter (dict) –
    
    Specifies a bucket filter. The configuration only includes objects that meet the filter’s criteria.
    - Prefix (string) –
      
      An object key name prefix that identifies the subset of 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) –
      
      A container of a key value name pair.
      - Key (string) –
        
        Name of the object key.
      - Value (string) –
        
        Value of the tag.
    - And (dict) –
      
      A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.
      - Prefix (string) –
        
        An object key name prefix that identifies the subset of objects to which the configuration applies.
      - Tags (list) –
        
        All of these tags must exist in the object’s tag set in order for the configuration to apply.
        
        (dict) –
        
        A container of a key value name pair.
        
        Key (string) –
        
        Name of the object key.
        
        Value (string) –
        
        Value of the tag.
  - Status (string) –
    
    Specifies the status of the configuration.
  - Tierings (list) –
    
    Specifies the S3 Intelligent-Tiering storage class tier of the configuration.
    - (dict) –
      
      The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead.
      - Days (integer) –
        
        The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days).
      - AccessTier (string) –
        
        S3 Intelligent-Tiering access tier. See Storage class for automatically optimizing frequently and infrequently accessed objects for a list of access tiers in the S3 Intelligent-Tiering storage class.