@aws-sdk/client-s3

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"; /** * @public * * The input for {@link PutBucketInventoryConfigurationCommand}. */ export interface PutBucketInventoryConfigurationCommandInput extends PutBucketInventoryConfigurationRequest { } /** * @public * * The output of {@link PutBucketInventoryConfigurationCommand}. */ export interface PutBucketInventoryConfigurationCommandOutput extends __MetadataBearer { } /** * @public * 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. * 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 source bucket, and the bucket where the inventory flat file * is stored is called the destination bucket. The * destination bucket must be in the same Amazon Web Services Region as the * source bucket. * When you configure an inventory for a source bucket, you specify * the destination 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. * <important> * You must create a bucket policy on the destination 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>. * </important> * 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. * * Special Errors * * <ul> * <li> * * HTTP 400 Bad Request Error * * <ul> * <li> * * Code: InvalidArgument * </li> * <li> * * Cause: Invalid Argument * </li> * </ul> * </li> * <li> * * HTTP 400 Bad Request Error * * <ul> * <li> * * Code: TooManyConfigurations * </li> * <li> * * Cause: You are attempting to create a new configuration * but have already reached the 1,000-configuration limit. * </li> * </ul> * </li> * <li> * * HTTP 403 Forbidden Error * * <ul> * <li> * * Code: AccessDenied * </li> * <li> * * Cause: 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. * </li> * </ul> * </li> * </ul> * * Related Resources * * <ul> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html">GetBucketInventoryConfiguration</a> * * </li> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html">DeleteBucketInventoryConfiguration</a> * * </li> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html">ListBucketInventoryConfigurations</a> * * </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 input = { // PutBucketInventoryConfigurationRequest * Bucket: "STRING_VALUE", // required * Id: "STRING_VALUE", // required * InventoryConfiguration: { // InventoryConfiguration * Destination: { // InventoryDestination * S3BucketDestination: { // InventoryS3BucketDestination * AccountId: "STRING_VALUE", * Bucket: "STRING_VALUE", // required * Format: "CSV" || "ORC" || "Parquet", // required * Prefix: "STRING_VALUE", * Encryption: { // InventoryEncryption * SSES3: {}, * SSEKMS: { // SSEKMS * KeyId: "STRING_VALUE", // required * }, * }, * }, * }, * IsEnabled: true || false, // required * Filter: { // InventoryFilter * Prefix: "STRING_VALUE", // required * }, * Id: "STRING_VALUE", // required * IncludedObjectVersions: "All" || "Current", // required * OptionalFields: [ // InventoryOptionalFields * "Size" || "LastModifiedDate" || "StorageClass" || "ETag" || "IsMultipartUploaded" || "ReplicationStatus" || "EncryptionStatus" || "ObjectLockRetainUntilDate" || "ObjectLockMode" || "ObjectLockLegalHoldStatus" || "IntelligentTieringAccessTier" || "BucketKeyStatus" || "ChecksumAlgorithm", * ], * Schedule: { // InventorySchedule * Frequency: "Daily" || "Weekly", // required * }, * }, * ExpectedBucketOwner: "STRING_VALUE", * }; * const command = new PutBucketInventoryConfigurationCommand(input); * const response = await client.send(command); * ``` * * @param PutBucketInventoryConfigurationCommandInput - {@link PutBucketInventoryConfigurationCommandInput} * @returns {@link PutBucketInventoryConfigurationCommandOutput} * @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; /** * @public */ constructor(input: PutBucketInventoryConfigurationCommandInput); /** * @internal */ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketInventoryConfigurationCommandInput, PutBucketInventoryConfigurationCommandOutput>; /** * @internal */ private serialize; /** * @internal */ private deserialize; }