@aws-sdk/client-s3
Version:
AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native
138 lines (137 loc) • 7.43 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 { PutBucketInventoryConfigurationRequest } from "../models/models_0";
import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
export interface PutBucketInventoryConfigurationCommandInput extends PutBucketInventoryConfigurationRequest {
}
export interface PutBucketInventoryConfigurationCommandOutput extends __MetadataBearer {
}
/**
* <p>This implementation of the <code>PUT</code> action adds an inventory configuration
* (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory
* configurations per bucket. </p>
* <p>Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly
* basis, and the results are published to a flat file. The bucket that is inventoried is
* called the <i>source</i> bucket, and the bucket where the inventory flat file
* is stored is called the <i>destination</i> bucket. The
* <i>destination</i> bucket must be in the same Amazon Web Services Region as the
* <i>source</i> bucket. </p>
* <p>When you configure an inventory for a <i>source</i> bucket, you specify
* the <i>destination</i> bucket where you want the inventory to be stored, and
* whether to generate the inventory daily or weekly. You can also configure what object
* metadata to include and whether to inventory all object versions or only current versions.
* For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3
* Inventory</a> in the Amazon S3 User Guide.</p>
* <important>
* <p>You must create a bucket policy on the <i>destination</i> bucket to
* grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an
* example policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9">
* Granting Permissions for Amazon S3 Inventory and Storage Class Analysis</a>.</p>
* </important>
* <p>To use this operation, you must have permissions to perform the
* <code>s3:PutInventoryConfiguration</code> action. The bucket owner has this permission
* by default and can grant this permission to others. For more information about permissions,
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
* Resources</a> in the Amazon S3 User Guide.</p>
*
* <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:PutInventoryConfiguration</code> bucket
* permission to set the configuration on the bucket. </p>
* </li>
* </ul>
* </li>
* </ul>
*
* <p class="title">
* <b>Related Resources</b>
* </p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html">GetBucketInventoryConfiguration</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html">DeleteBucketInventoryConfiguration</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html">ListBucketInventoryConfigurations</a>
* </p>
* </li>
* </ul>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { S3Client, PutBucketInventoryConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
* // const { S3Client, PutBucketInventoryConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
* const client = new S3Client(config);
* const command = new PutBucketInventoryConfigurationCommand(input);
* const response = await client.send(command);
* ```
*
* @see {@link PutBucketInventoryConfigurationCommandInput} for command's `input` shape.
* @see {@link PutBucketInventoryConfigurationCommandOutput} for command's `response` shape.
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
*
*/
export declare class PutBucketInventoryConfigurationCommand extends $Command<PutBucketInventoryConfigurationCommandInput, PutBucketInventoryConfigurationCommandOutput, S3ClientResolvedConfig> {
readonly input: PutBucketInventoryConfigurationCommandInput;
static getEndpointParameterInstructions(): EndpointParameterInstructions;
constructor(input: PutBucketInventoryConfigurationCommandInput);
/**
* @internal
*/
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketInventoryConfigurationCommandInput, PutBucketInventoryConfigurationCommandOutput>;
private serialize;
private deserialize;
}