import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { PutBucketInventoryConfigurationRequest } from "../models/models_0"; import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link PutBucketInventoryConfigurationCommand}. */ export interface PutBucketInventoryConfigurationCommandInput extends PutBucketInventoryConfigurationRequest { } /** * @public * * The output of {@link PutBucketInventoryConfigurationCommand}. */ export interface PutBucketInventoryConfigurationCommandOutput extends __MetadataBearer { } declare const PutBucketInventoryConfigurationCommand_base: { new (input: PutBucketInventoryConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl; new (__0_0: PutBucketInventoryConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * *

This operation is not supported by directory buckets.

*
*

This implementation of the PUT 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 Amazon S3 Inventory in the * Amazon S3 User Guide.

* *

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 Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

*
*
*
Permissions
*
*

To use this operation, you must have permission to perform the * s3:PutInventoryConfiguration action. The bucket owner has this * permission by default and can grant this permission to others.

*

The s3:PutInventoryConfiguration permission allows a user to * create an S3 Inventory * report that includes all object metadata fields available and to specify the * destination bucket to store the inventory. A user with read access to objects in * the destination bucket can also access all object metadata fields that are * available in the inventory report.

*

To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the * Amazon S3 User Guide. For more information about the metadata * fields available in S3 Inventory, see Amazon S3 Inventory lists in the Amazon S3 User Guide. For * more information about permissions, see Permissions related to bucket subresource operations and Identity and access management in Amazon S3 in the * Amazon S3 User Guide.

*
*
*

* PutBucketInventoryConfiguration has the following special errors:

*
*
HTTP 400 Bad Request Error
*
*

* Code: InvalidArgument

*

* Cause: Invalid Argument

*
*
HTTP 400 Bad Request Error
*
*

* Code: TooManyConfigurations

*

* Cause: You are attempting to create a new configuration * but have already reached the 1,000-configuration limit.

*
*
HTTP 403 Forbidden Error
*
*

* Cause: You are not the owner of the specified bucket, or * you do not have the s3:PutInventoryConfiguration bucket permission to * set the configuration on the bucket.

*
*
*

The following operations are related to * PutBucketInventoryConfiguration:

* * @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" || "ObjectAccessControlList" || "ObjectOwner", * ], * 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. * * @throws {@link S3ServiceException} *

Base exception class for all service exceptions from S3 service.

* * @public */ export declare class PutBucketInventoryConfigurationCommand extends PutBucketInventoryConfigurationCommand_base { }