Class GetBucketMetadataTableConfigurationCommand

We recommend that you retrieve your S3 Metadata configurations by using the V2 GetBucketMetadataTableConfiguration API operation. We no longer recommend using the V1 GetBucketMetadataTableConfiguration API operation.

If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table.

Retrieves the V1 S3 Metadata configuration for a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide.

You can use the V2 GetBucketMetadataConfiguration API operation with V1 or V2 metadata table configurations. However, if you try to use the V1 GetBucketMetadataTableConfiguration API operation with V2 configurations, you will receive an HTTP 405 Method Not Allowed error.

Make sure that you update your processes to use the new V2 API operations (CreateBucketMetadataConfiguration, GetBucketMetadataConfiguration, and DeleteBucketMetadataConfiguration) instead of the V1 API operations.

Permissions: To use this operation, you must have the s3:GetBucketMetadataTableConfiguration permission. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.

The following operations are related to GetBucketMetadataTableConfiguration:

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, GetBucketMetadataTableConfigurationCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, GetBucketMetadataTableConfigurationCommand } = 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 = { // GetBucketMetadataTableConfigurationRequest
  Bucket: "STRING_VALUE", // required
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new GetBucketMetadataTableConfigurationCommand(input);
const response = await client.send(command);
// { // GetBucketMetadataTableConfigurationOutput
//   GetBucketMetadataTableConfigurationResult: { // GetBucketMetadataTableConfigurationResult
//     MetadataTableConfigurationResult: { // MetadataTableConfigurationResult
//       S3TablesDestinationResult: { // S3TablesDestinationResult
//         TableBucketArn: "STRING_VALUE", // required
//         TableName: "STRING_VALUE", // required
//         TableArn: "STRING_VALUE", // required
//         TableNamespace: "STRING_VALUE", // required
//       },
//     },
//     Status: "STRING_VALUE", // required
//     Error: { // ErrorDetails
//       ErrorCode: "STRING_VALUE",
//       ErrorMessage: "STRING_VALUE",
//     },
//   },
// };

Base exception class for all service exceptions from S3 service.

Hierarchy

CommandImpl<
    GetBucketMetadataTableConfigurationCommandInput,
    GetBucketMetadataTableConfigurationCommandOutput,
    S3ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- GetBucketMetadataTableConfigurationCommand

Index

Constructors

constructor

Constructors

constructor

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

Class GetBucketMetadataTableConfigurationCommand

Example

Param: GetBucketMetadataTableConfigurationCommandInput

Returns

See

Throws

Hierarchy

Index

Constructors

Constructors

constructor

Parameters

Returns GetBucketMetadataTableConfigurationCommand

Parameters

Returns GetBucketMetadataTableConfigurationCommand

Settings

On This Page