@aws-sdk/client-s3
Version:
AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native
120 lines (119 loc) • 6.79 kB
TypeScript
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
import { Command as $Command } from "@aws-sdk/smithy-client";
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
import { PutBucketIntelligentTieringConfigurationRequest } from "../models/models_0";
import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
export interface PutBucketIntelligentTieringConfigurationCommandInput extends PutBucketIntelligentTieringConfigurationRequest {
}
export interface PutBucketIntelligentTieringConfigurationCommandOutput extends __MetadataBearer {
}
/**
* <p>Puts a S3 Intelligent-Tiering configuration to the specified bucket.
* You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.</p>
* <p>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.</p>
* <p>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.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>.</p>
* <p>Operations related to
* <code>PutBucketIntelligentTieringConfiguration</code> include: </p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html">DeleteBucketIntelligentTieringConfiguration</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html">GetBucketIntelligentTieringConfiguration</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html">ListBucketIntelligentTieringConfigurations</a>
* </p>
* </li>
* </ul>
* <note>
* <p>You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically
* move objects stored in the S3 Intelligent-Tiering storage class to the
* Archive Access or Deep Archive Access tier.</p>
* </note>
*
* <p class="title">
* <b>Special Errors</b>
* </p>
* <ul>
* <li>
* <p class="title">
* <b>HTTP 400 Bad Request Error</b>
* </p>
* <ul>
* <li>
* <p>
* <i>Code:</i> InvalidArgument</p>
* </li>
* <li>
* <p>
* <i>Cause:</i> Invalid Argument</p>
* </li>
* </ul>
* </li>
* <li>
* <p class="title">
* <b>HTTP 400 Bad Request Error</b>
* </p>
* <ul>
* <li>
* <p>
* <i>Code:</i> TooManyConfigurations</p>
* </li>
* <li>
* <p>
* <i>Cause:</i> You are attempting to create a new configuration
* but have already reached the 1,000-configuration limit. </p>
* </li>
* </ul>
* </li>
* <li>
* <p class="title">
* <b>HTTP 403 Forbidden Error</b>
* </p>
* <ul>
* <li>
* <p>
* <i>Code:</i> AccessDenied</p>
* </li>
* <li>
* <p>
* <i>Cause:</i> You are not the owner of the specified bucket,
* or you do not have the <code>s3:PutIntelligentTieringConfiguration</code> bucket
* permission to set the configuration on the bucket. </p>
* </li>
* </ul>
* </li>
* </ul>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { S3Client, PutBucketIntelligentTieringConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
* // const { S3Client, PutBucketIntelligentTieringConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
* const client = new S3Client(config);
* const command = new PutBucketIntelligentTieringConfigurationCommand(input);
* const response = await client.send(command);
* ```
*
* @see {@link PutBucketIntelligentTieringConfigurationCommandInput} for command's `input` shape.
* @see {@link PutBucketIntelligentTieringConfigurationCommandOutput} for command's `response` shape.
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
*
*/
export declare class PutBucketIntelligentTieringConfigurationCommand extends $Command<PutBucketIntelligentTieringConfigurationCommandInput, PutBucketIntelligentTieringConfigurationCommandOutput, S3ClientResolvedConfig> {
readonly input: PutBucketIntelligentTieringConfigurationCommandInput;
static getEndpointParameterInstructions(): EndpointParameterInstructions;
constructor(input: PutBucketIntelligentTieringConfigurationCommandInput);
/**
* @internal
*/
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketIntelligentTieringConfigurationCommandInput, PutBucketIntelligentTieringConfigurationCommandOutput>;
private serialize;
private deserialize;
}