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

This operation is not supported for directory buckets.

*
*

Returns an S3 Inventory configuration (identified by the inventory configuration ID) from the * bucket.

*

To use this operation, you must have permissions to perform the * s3:GetInventoryConfiguration action. The bucket owner has this permission by default and * can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 * Resources.

*

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

*

The following operations are related to GetBucketInventoryConfiguration:

* * *

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3Client, GetBucketInventoryConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, GetBucketInventoryConfigurationCommand } = 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 = { // GetBucketInventoryConfigurationRequest * Bucket: "STRING_VALUE", // required * Id: "STRING_VALUE", // required * ExpectedBucketOwner: "STRING_VALUE", * }; * const command = new GetBucketInventoryConfigurationCommand(input); * const response = await client.send(command); * // { // GetBucketInventoryConfigurationOutput * // 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" || "LifecycleExpirationDate", * // ], * // Schedule: { // InventorySchedule * // Frequency: "Daily" || "Weekly", // required * // }, * // }, * // }; * * ``` * * @param GetBucketInventoryConfigurationCommandInput - {@link GetBucketInventoryConfigurationCommandInput} * @returns {@link GetBucketInventoryConfigurationCommandOutput} * @see {@link GetBucketInventoryConfigurationCommandInput} for command's `input` shape. * @see {@link GetBucketInventoryConfigurationCommandOutput} 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 GetBucketInventoryConfigurationCommand extends GetBucketInventoryConfigurationCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetBucketInventoryConfigurationRequest; output: GetBucketInventoryConfigurationOutput; }; sdk: { input: GetBucketInventoryConfigurationCommandInput; output: GetBucketInventoryConfigurationCommandOutput; }; }; }