Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class GetBucketIntelligentTieringConfigurationCommandProtected

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:

Example

Use a bare-bones client and the command you need to make an API call.

import { S3Client, GetBucketIntelligentTieringConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, GetBucketIntelligentTieringConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // GetBucketIntelligentTieringConfigurationRequest
Bucket: "STRING_VALUE", // required
Id: "STRING_VALUE", // required
};
const command = new GetBucketIntelligentTieringConfigurationCommand(input);
const response = await client.send(command);
// { // GetBucketIntelligentTieringConfigurationOutput
// IntelligentTieringConfiguration: { // IntelligentTieringConfiguration
// Id: "STRING_VALUE", // required
// Filter: { // IntelligentTieringFilter
// Prefix: "STRING_VALUE",
// Tag: { // Tag
// Key: "STRING_VALUE", // required
// Value: "STRING_VALUE", // required
// },
// And: { // IntelligentTieringAndOperator
// Prefix: "STRING_VALUE",
// Tags: [ // TagSet
// {
// Key: "STRING_VALUE", // required
// Value: "STRING_VALUE", // required
// },
// ],
// },
// },
// Status: "Enabled" || "Disabled", // required
// Tierings: [ // TieringList // required
// { // Tiering
// Days: Number("int"), // required
// AccessTier: "ARCHIVE_ACCESS" || "DEEP_ARCHIVE_ACCESS", // required
// },
// ],
// },
// };

Param

GetBucketIntelligentTieringConfigurationCommandInput

Returns

GetBucketIntelligentTieringConfigurationCommandOutput

See

Throws

S3ServiceException

Base exception class for all service exceptions from S3 service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods