Skip to content

list_bucket_intelligent_tiering_configurations

Operation

list_bucket_intelligent_tiering_configurations

Note

This operation is not supported for directory buckets.

Lists 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 ListBucketIntelligentTieringConfigurations 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 ListBucketIntelligentTieringConfigurationsInput | ListBucketIntelligentTieringConfigurationsInputDict | 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[ListBucketIntelligentTieringConfigurationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListBucketIntelligentTieringConfigurationsOutput

An instance of ListBucketIntelligentTieringConfigurationsOutput.

list_bucket_intelligent_tiering_configurations async

Note

This operation is not supported for directory buckets.

Lists 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 ListBucketIntelligentTieringConfigurations 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 ListBucketIntelligentTieringConfigurationsInput | ListBucketIntelligentTieringConfigurationsInputDict | 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[ListBucketIntelligentTieringConfigurationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListBucketIntelligentTieringConfigurationsOutput

An instance of ListBucketIntelligentTieringConfigurationsOutput.

Input

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

ListBucketIntelligentTieringConfigurationsInputDict

Bases: TypedDict

Dictionary form of ListBucketIntelligentTieringConfigurationsInput.

Attributes

bucket instance-attribute
bucket: Required[str]

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

continuation_token instance-attribute
continuation_token: str | None

The ContinuationToken that represents a placeholder from where this request should begin.

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

ListBucketIntelligentTieringConfigurationsInput dataclass

Bases: _SerdeShape

Dataclass for ListBucketIntelligentTieringConfigurationsInput 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.

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

The ContinuationToken that represents a placeholder from where this request should begin.

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

Output

ListBucketIntelligentTieringConfigurationsOutput dataclass

Bases: _SerdeShape

Dataclass for ListBucketIntelligentTieringConfigurationsOutput structure.

Attributes

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

The ContinuationToken that represents a placeholder from where this request should begin.

intelligent_tiering_configuration_list class-attribute instance-attribute
intelligent_tiering_configuration_list: list[IntelligentTieringConfiguration] | None = ...

The list of S3 Intelligent-Tiering configurations for a bucket.

is_truncated class-attribute instance-attribute
is_truncated: bool | None = ...

Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

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

The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.

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.