Class GetBucketIntelligentTieringConfigurationCommand

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:

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.

Example

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

import { S3Client, GetBucketIntelligentTieringConfigurationCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, GetBucketIntelligentTieringConfigurationCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
// import type { S3ClientConfig } from "ibm-cos-sdk-v2";
const config = {}; // type is S3ClientConfig
const client = new S3Client(config);
const input = { // GetBucketIntelligentTieringConfigurationRequest
  Bucket: "STRING_VALUE", // required
  Id: "STRING_VALUE", // required
  ExpectedBucketOwner: "STRING_VALUE",
};
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
//       },
//     ],
//   },
// };

Base exception class for all service exceptions from S3 service.

Hierarchy

CommandImpl<
    GetBucketIntelligentTieringConfigurationCommandInput,
    GetBucketIntelligentTieringConfigurationCommandOutput,
    S3ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- GetBucketIntelligentTieringConfigurationCommand

Index

Constructors

constructor

Constructors

constructor

new GetBucketIntelligentTieringConfigurationCommand(
input: GetBucketIntelligentTieringConfigurationCommandInput,
): GetBucketIntelligentTieringConfigurationCommand
Parameters
- input: GetBucketIntelligentTieringConfigurationCommandInput
Returns GetBucketIntelligentTieringConfigurationCommand
Inherited from $Command .classBuilder< GetBucketIntelligentTieringConfigurationCommandInput, GetBucketIntelligentTieringConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep({ ...commonParams, UseS3ExpressControlEndpoint: { type: "staticContextParams", value: true }, Bucket: { type: "contextParams", name: "Bucket" }, }) .m(function (this: any, Command: any, cs: any, config: S3ClientResolvedConfig, o: any) { return [ getEndpointPlugin(config, Command.getEndpointParameterInstructions()), getThrow200ExceptionsPlugin(config), ]; }) .s("AmazonS3", "GetBucketIntelligentTieringConfiguration", {}) .n("S3Client", "GetBucketIntelligentTieringConfigurationCommand") .sc(GetBucketIntelligentTieringConfiguration$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:103
new GetBucketIntelligentTieringConfigurationCommand(
    ...__namedParameters: [
        GetBucketIntelligentTieringConfigurationCommandInput,
    ],
): GetBucketIntelligentTieringConfigurationCommand
Parameters
- ...__namedParameters: [GetBucketIntelligentTieringConfigurationCommandInput]
Returns GetBucketIntelligentTieringConfigurationCommand
Inherited from $Command .classBuilder< GetBucketIntelligentTieringConfigurationCommandInput, GetBucketIntelligentTieringConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep({ ...commonParams, UseS3ExpressControlEndpoint: { type: "staticContextParams", value: true }, Bucket: { type: "contextParams", name: "Bucket" }, }) .m(function (this: any, Command: any, cs: any, config: S3ClientResolvedConfig, o: any) { return [ getEndpointPlugin(config, Command.getEndpointParameterInstructions()), getThrow200ExceptionsPlugin(config), ]; }) .s("AmazonS3", "GetBucketIntelligentTieringConfiguration", {}) .n("S3Client", "GetBucketIntelligentTieringConfigurationCommand") .sc(GetBucketIntelligentTieringConfiguration$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:104

Class GetBucketIntelligentTieringConfigurationCommand

Example

Param: GetBucketIntelligentTieringConfigurationCommandInput

Returns

See

Throws

Hierarchy

Index

Constructors

Constructors

constructor

Parameters

Returns GetBucketIntelligentTieringConfigurationCommand

Parameters

Returns GetBucketIntelligentTieringConfigurationCommand

Settings

On This Page