ListBucketInventoryConfigurationsCommand

Suggest an Edit

This operation is not supported for directory buckets.

Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics 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:

Example Syntax

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

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

ListBucketInventoryConfigurationsCommand Input

See ListBucketInventoryConfigurationsCommandInput for more details

Parameter
Type
Description
Bucket
Required
string | undefined

The name of the bucket containing the inventory configurations to retrieve.

Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues

ContinuationToken
string | undefined

The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

ExpectedBucketOwner
string | undefined

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

ListBucketInventoryConfigurationsCommand Output

See ListBucketInventoryConfigurationsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ContinuationToken
string | undefined

If sent in the request, the marker that is used as a starting point for this inventory configuration list response.

InventoryConfigurationList
InventoryConfiguration[] | undefined

The list of inventory configurations for a bucket.

IsTruncated
boolean | undefined

Tells whether the returned list of inventory configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken is provided for a subsequent request.

NextContinuationToken
string | undefined

The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.

Throws

Name
Fault
Details
S3ServiceException
Base exception class for all service exceptions from S3 service.