Class ListBucketInventoryConfigurationsCommand

This operation is not supported for directory buckets.

Returns a list of S3 Inventory configurations for the bucket. You can have up to 1,000 inventory configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner 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 ListBucketInventoryConfigurations:

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, ListBucketInventoryConfigurationsCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, ListBucketInventoryConfigurationsCommand } = 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 = { // ListBucketInventoryConfigurationsRequest
  Bucket: "STRING_VALUE", // required
  ContinuationToken: "STRING_VALUE",
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new ListBucketInventoryConfigurationsCommand(input);
const response = await client.send(command);
// { // ListBucketInventoryConfigurationsOutput
//   ContinuationToken: "STRING_VALUE",
//   InventoryConfigurationList: [ // InventoryConfigurationList
//     { // 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
//       },
//     },
//   ],
//   IsTruncated: true || false,
//   NextContinuationToken: "STRING_VALUE",
// };

Base exception class for all service exceptions from S3 service.

Hierarchy

CommandImpl<
    ListBucketInventoryConfigurationsCommandInput,
    ListBucketInventoryConfigurationsCommandOutput,
    S3ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- ListBucketInventoryConfigurationsCommand

Index

Constructors

constructor

Constructors

constructor

new ListBucketInventoryConfigurationsCommand(
input: ListBucketInventoryConfigurationsCommandInput,
): ListBucketInventoryConfigurationsCommand
Parameters
- input: ListBucketInventoryConfigurationsCommandInput
Returns ListBucketInventoryConfigurationsCommand
Inherited from $Command .classBuilder< ListBucketInventoryConfigurationsCommandInput, ListBucketInventoryConfigurationsCommandOutput, 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", "ListBucketInventoryConfigurations", {}) .n("S3Client", "ListBucketInventoryConfigurationsCommand") .sc(ListBucketInventoryConfigurations$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:103
new ListBucketInventoryConfigurationsCommand(
...__namedParameters: [ListBucketInventoryConfigurationsCommandInput],
): ListBucketInventoryConfigurationsCommand
Parameters
- ...__namedParameters: [ListBucketInventoryConfigurationsCommandInput]
Returns ListBucketInventoryConfigurationsCommand
Inherited from $Command .classBuilder< ListBucketInventoryConfigurationsCommandInput, ListBucketInventoryConfigurationsCommandOutput, 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", "ListBucketInventoryConfigurations", {}) .n("S3Client", "ListBucketInventoryConfigurationsCommand") .sc(ListBucketInventoryConfigurations$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:104

Class ListBucketInventoryConfigurationsCommand

Example

Param: ListBucketInventoryConfigurationsCommandInput

Returns

See

Throws

Hierarchy

Index

Constructors

Constructors

constructor

Parameters

Returns ListBucketInventoryConfigurationsCommand

Parameters

Returns ListBucketInventoryConfigurationsCommand

Settings

On This Page