@aws-sdk/client-s3
Version:
AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native
167 lines (166 loc) • 8.37 kB
TypeScript
import { Command as $Command } from "@smithy/smithy-client";
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
import type { UpdateBucketMetadataInventoryTableConfigurationRequest } from "../models/models_1";
import type { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link UpdateBucketMetadataInventoryTableConfigurationCommand}.
*/
export interface UpdateBucketMetadataInventoryTableConfigurationCommandInput extends UpdateBucketMetadataInventoryTableConfigurationRequest {
}
/**
* @public
*
* The output of {@link UpdateBucketMetadataInventoryTableConfigurationCommand}.
*/
export interface UpdateBucketMetadataInventoryTableConfigurationCommandOutput extends __MetadataBearer {
}
declare const UpdateBucketMetadataInventoryTableConfigurationCommand_base: {
new (input: UpdateBucketMetadataInventoryTableConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateBucketMetadataInventoryTableConfigurationCommandInput, UpdateBucketMetadataInventoryTableConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (input: UpdateBucketMetadataInventoryTableConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateBucketMetadataInventoryTableConfigurationCommandInput, UpdateBucketMetadataInventoryTableConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
* <p>Enables or disables a live inventory table for an S3 Metadata configuration on a general
* purpose bucket. For more information, see
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html">Accelerating
* data discovery with S3 Metadata</a> in the <i>Amazon S3 User Guide</i>.</p>
* <dl>
* <dt>Permissions</dt>
* <dd>
* <p>To use this operation, you must have the following permissions. For more information, see
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html">Setting up permissions for configuring metadata tables</a> in the
* <i>Amazon S3 User Guide</i>.</p>
* <p>If you want to encrypt your inventory table with server-side encryption with Key Management Service
* (KMS) keys (SSE-KMS), you need additional permissions in your KMS key policy. For more
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html">
* Setting up permissions for configuring metadata tables</a> in the
* <i>Amazon S3 User Guide</i>.</p>
* <ul>
* <li>
* <p>
* <code>s3:UpdateBucketMetadataInventoryTableConfiguration</code>
* </p>
* </li>
* <li>
* <p>
* <code>s3tables:CreateTableBucket</code>
* </p>
* </li>
* <li>
* <p>
* <code>s3tables:CreateNamespace</code>
* </p>
* </li>
* <li>
* <p>
* <code>s3tables:GetTable</code>
* </p>
* </li>
* <li>
* <p>
* <code>s3tables:CreateTable</code>
* </p>
* </li>
* <li>
* <p>
* <code>s3tables:PutTablePolicy</code>
* </p>
* </li>
* <li>
* <p>
* <code>s3tables:PutTableEncryption</code>
* </p>
* </li>
* <li>
* <p>
* <code>kms:DescribeKey</code>
* </p>
* </li>
* </ul>
* </dd>
* </dl>
* <p>The following operations are related to <code>UpdateBucketMetadataInventoryTableConfiguration</code>:</p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html">CreateBucketMetadataConfiguration</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetadataConfiguration.html">DeleteBucketMetadataConfiguration</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetadataConfiguration.html">GetBucketMetadataConfiguration</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UpdateBucketMetadataJournalTableConfiguration.html">UpdateBucketMetadataJournalTableConfiguration</a>
* </p>
* </li>
* </ul>
* <important>
* <p>You must URL encode any signed header values that contain spaces. For example, if your header value is <code>my file.txt</code>, containing two spaces after <code>my</code>, you must URL encode this value to <code>my%20%20file.txt</code>.</p>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { S3Client, UpdateBucketMetadataInventoryTableConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
* // const { S3Client, UpdateBucketMetadataInventoryTableConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
* // import type { S3ClientConfig } from "@aws-sdk/client-s3";
* const config = {}; // type is S3ClientConfig
* const client = new S3Client(config);
* const input = { // UpdateBucketMetadataInventoryTableConfigurationRequest
* Bucket: "STRING_VALUE", // required
* ContentMD5: "STRING_VALUE",
* ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME",
* InventoryTableConfiguration: { // InventoryTableConfigurationUpdates
* ConfigurationState: "ENABLED" || "DISABLED", // required
* EncryptionConfiguration: { // MetadataTableEncryptionConfiguration
* SseAlgorithm: "aws:kms" || "AES256", // required
* KmsKeyArn: "STRING_VALUE",
* },
* },
* ExpectedBucketOwner: "STRING_VALUE",
* };
* const command = new UpdateBucketMetadataInventoryTableConfigurationCommand(input);
* const response = await client.send(command);
* // {};
*
* ```
*
* @param UpdateBucketMetadataInventoryTableConfigurationCommandInput - {@link UpdateBucketMetadataInventoryTableConfigurationCommandInput}
* @returns {@link UpdateBucketMetadataInventoryTableConfigurationCommandOutput}
* @see {@link UpdateBucketMetadataInventoryTableConfigurationCommandInput} for command's `input` shape.
* @see {@link UpdateBucketMetadataInventoryTableConfigurationCommandOutput} for command's `response` shape.
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
*
* @throws {@link S3ServiceException}
* <p>Base exception class for all service exceptions from S3 service.</p>
*
*
* @public
*/
export declare class UpdateBucketMetadataInventoryTableConfigurationCommand extends UpdateBucketMetadataInventoryTableConfigurationCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: UpdateBucketMetadataInventoryTableConfigurationRequest;
output: {};
};
sdk: {
input: UpdateBucketMetadataInventoryTableConfigurationCommandInput;
output: UpdateBucketMetadataInventoryTableConfigurationCommandOutput;
};
};
}