@aws-sdk/client-s3

import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; import { PutBucketInventoryConfigurationRequest } from "../models/models_0"; import { deserializeAws_restXmlPutBucketInventoryConfigurationCommand, serializeAws_restXmlPutBucketInventoryConfigurationCommand, } from "../protocols/Aws_restXml"; import { getBucketEndpointPlugin } from "@aws-sdk/middleware-bucket-endpoint"; import { getSerdePlugin } from "@aws-sdk/middleware-serde"; import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; import { Command as $Command } from "@aws-sdk/smithy-client"; import { FinalizeHandlerArguments, Handler, HandlerExecutionContext, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, SerdeContext as __SerdeContext, } from "@aws-sdk/types"; export type PutBucketInventoryConfigurationCommandInput = PutBucketInventoryConfigurationRequest; export type PutBucketInventoryConfigurationCommandOutput = __MetadataBearer; /** * This implementation of the <code>PUT</code> operation 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 AWS 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 Simple Storage Service Developer 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/dev/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/dev/s3-access-control.html">Managing Access Permissions to Your Amazon S3 * Resources</a> in the Amazon Simple Storage Service Developer 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> */ export class PutBucketInventoryConfigurationCommand extends $Command< PutBucketInventoryConfigurationCommandInput, PutBucketInventoryConfigurationCommandOutput, S3ClientResolvedConfig > { // Start section: command_properties // End section: command_properties constructor(readonly input: PutBucketInventoryConfigurationCommandInput) { // Start section: command_constructor super(); // End section: command_constructor } /** * @internal */ resolveMiddleware( clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions ): Handler<PutBucketInventoryConfigurationCommandInput, PutBucketInventoryConfigurationCommandOutput> { this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); this.middlewareStack.use(getBucketEndpointPlugin(configuration)); const stack = clientStack.concat(this.middlewareStack); const { logger } = configuration; const clientName = "S3Client"; const commandName = "PutBucketInventoryConfigurationCommand"; const handlerExecutionContext: HandlerExecutionContext = { logger, clientName, commandName, inputFilterSensitiveLog: PutBucketInventoryConfigurationRequest.filterSensitiveLog, outputFilterSensitiveLog: (output: any) => output, }; const { requestHandler } = configuration; return stack.resolve( (request: FinalizeHandlerArguments<any>) => requestHandler.handle(request.request as __HttpRequest, options || {}), handlerExecutionContext ); } private serialize( input: PutBucketInventoryConfigurationCommandInput, context: __SerdeContext ): Promise<__HttpRequest> { return serializeAws_restXmlPutBucketInventoryConfigurationCommand(input, context); } private deserialize( output: __HttpResponse, context: __SerdeContext ): Promise<PutBucketInventoryConfigurationCommandOutput> { return deserializeAws_restXmlPutBucketInventoryConfigurationCommand(output, context); } // Start section: command_body_extra // End section: command_body_extra }