Class GetBucketInventoryConfigurationCommandProtected

Returns an 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:

• DeleteBucketInventoryConfiguration

• ListBucketInventoryConfigurations

• PutBucketInventoryConfiguration

Example

Use a bare-bones client and the command you need to make an API call.

import { S3Client, GetBucketInventoryConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, GetBucketInventoryConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
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",
//     ],
//     Schedule: { // InventorySchedule
//       Frequency: "Daily" || "Weekly", // required
//     },
//   },
// };

Param

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.