Skip to content

get_bucket_intelligent_tiering_configuration

Operation

get_bucket_intelligent_tiering_configuration

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:

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
request GetBucketIntelligentTieringConfigurationInput | GetBucketIntelligentTieringConfigurationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetBucketIntelligentTieringConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetBucketIntelligentTieringConfigurationOutput

An instance of GetBucketIntelligentTieringConfigurationOutput.

get_bucket_intelligent_tiering_configuration async

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:

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
request GetBucketIntelligentTieringConfigurationInput | GetBucketIntelligentTieringConfigurationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetBucketIntelligentTieringConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetBucketIntelligentTieringConfigurationOutput

An instance of GetBucketIntelligentTieringConfigurationOutput.

Input

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

GetBucketIntelligentTieringConfigurationInputDict

Bases: TypedDict

Dictionary form of GetBucketIntelligentTieringConfigurationInput.

Attributes

bucket instance-attribute
bucket: Required[str]

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

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).

id instance-attribute

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

GetBucketIntelligentTieringConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for GetBucketIntelligentTieringConfigurationInput structure.

Attributes

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

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

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).

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

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

Output

GetBucketIntelligentTieringConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for GetBucketIntelligentTieringConfigurationOutput structure.

Attributes

intelligent_tiering_configuration class-attribute instance-attribute
intelligent_tiering_configuration: IntelligentTieringConfiguration | None = ...

Container for S3 Intelligent-Tiering configuration.

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.