Class GetBucketInventoryConfigurationCommand

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.

import { S3Client, GetBucketInventoryConfigurationCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, GetBucketInventoryConfigurationCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
// import type { S3ClientConfig } from "ibm-cos-sdk-v2";
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

GetBucketInventoryConfigurationCommandInput

Returns

GetBucketInventoryConfigurationCommandOutput

See

GetBucketInventoryConfigurationCommandInput for command's input shape.
GetBucketInventoryConfigurationCommandOutput for command's response shape.
config for S3Client's config shape.

Throws

S3ServiceException

Base exception class for all service exceptions from S3 service.

Hierarchy

CommandImpl<
    GetBucketInventoryConfigurationCommandInput,
    GetBucketInventoryConfigurationCommandOutput,
    S3ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- GetBucketInventoryConfigurationCommand

Index

Constructors

constructor

Constructors

constructor

new GetBucketInventoryConfigurationCommand(
input: GetBucketInventoryConfigurationCommandInput,
): GetBucketInventoryConfigurationCommand
Parameters
- input: GetBucketInventoryConfigurationCommandInput
Returns GetBucketInventoryConfigurationCommand
Inherited from $Command .classBuilder< GetBucketInventoryConfigurationCommandInput, GetBucketInventoryConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep({ ...commonParams, UseS3ExpressControlEndpoint: { type: "staticContextParams", value: true }, Bucket: { type: "contextParams", name: "Bucket" }, }) .m(function (this: any, Command: any, cs: any, config: S3ClientResolvedConfig, o: any) { return [ getEndpointPlugin(config, Command.getEndpointParameterInstructions()), getThrow200ExceptionsPlugin(config), ]; }) .s("AmazonS3", "GetBucketInventoryConfiguration", {}) .n("S3Client", "GetBucketInventoryConfigurationCommand") .sc(GetBucketInventoryConfiguration$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:103
new GetBucketInventoryConfigurationCommand(
...__namedParameters: [GetBucketInventoryConfigurationCommandInput],
): GetBucketInventoryConfigurationCommand
Parameters
- ...__namedParameters: [GetBucketInventoryConfigurationCommandInput]
Returns GetBucketInventoryConfigurationCommand
Inherited from $Command .classBuilder< GetBucketInventoryConfigurationCommandInput, GetBucketInventoryConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep({ ...commonParams, UseS3ExpressControlEndpoint: { type: "staticContextParams", value: true }, Bucket: { type: "contextParams", name: "Bucket" }, }) .m(function (this: any, Command: any, cs: any, config: S3ClientResolvedConfig, o: any) { return [ getEndpointPlugin(config, Command.getEndpointParameterInstructions()), getThrow200ExceptionsPlugin(config), ]; }) .s("AmazonS3", "GetBucketInventoryConfiguration", {}) .n("S3Client", "GetBucketInventoryConfigurationCommand") .sc(GetBucketInventoryConfiguration$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:104

Class GetBucketInventoryConfigurationCommand

Example

Param: GetBucketInventoryConfigurationCommandInput

Returns

See

Throws

Hierarchy

Index

Constructors

Constructors

constructor

Parameters

Returns GetBucketInventoryConfigurationCommand

Parameters

Returns GetBucketInventoryConfigurationCommand

Settings

On This Page