Class GetBucketMetadataConfigurationCommand

Retrieves the 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 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.

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 IAM policy action name is the same for the V1 and V2 API operations.

The following operations are related to GetBucketMetadataConfiguration:

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, GetBucketMetadataConfigurationCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, GetBucketMetadataConfigurationCommand } = 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 = { // GetBucketMetadataConfigurationRequest
  Bucket: "STRING_VALUE", // required
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new GetBucketMetadataConfigurationCommand(input);
const response = await client.send(command);
// { // GetBucketMetadataConfigurationOutput
//   GetBucketMetadataConfigurationResult: { // GetBucketMetadataConfigurationResult
//     MetadataConfigurationResult: { // MetadataConfigurationResult
//       DestinationResult: { // DestinationResult
//         TableBucketType: "aws" || "customer",
//         TableBucketArn: "STRING_VALUE",
//         TableNamespace: "STRING_VALUE",
//       },
//       JournalTableConfigurationResult: { // JournalTableConfigurationResult
//         TableStatus: "STRING_VALUE", // required
//         Error: { // ErrorDetails
//           ErrorCode: "STRING_VALUE",
//           ErrorMessage: "STRING_VALUE",
//         },
//         TableName: "STRING_VALUE", // required
//         TableArn: "STRING_VALUE",
//         RecordExpiration: { // RecordExpiration
//           Expiration: "ENABLED" || "DISABLED", // required
//           Days: Number("int"),
//         },
//       },
//       InventoryTableConfigurationResult: { // InventoryTableConfigurationResult
//         ConfigurationState: "ENABLED" || "DISABLED", // required
//         TableStatus: "STRING_VALUE",
//         Error: {
//           ErrorCode: "STRING_VALUE",
//           ErrorMessage: "STRING_VALUE",
//         },
//         TableName: "STRING_VALUE",
//         TableArn: "STRING_VALUE",
//       },
//     },
//   },
// };

Param: GetBucketMetadataConfigurationCommandInput

GetBucketMetadataConfigurationCommandInput

Returns

GetBucketMetadataConfigurationCommandOutput

See

GetBucketMetadataConfigurationCommandInput for command's input shape.
GetBucketMetadataConfigurationCommandOutput 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<
    GetBucketMetadataConfigurationCommandInput,
    GetBucketMetadataConfigurationCommandOutput,
    S3ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- GetBucketMetadataConfigurationCommand

Index

Constructors

constructor

Constructors

constructor

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

Class GetBucketMetadataConfigurationCommand

Example

Param: GetBucketMetadataConfigurationCommandInput

Returns

See

Throws

Hierarchy

Index

Constructors

Constructors

constructor

Parameters

Returns GetBucketMetadataConfigurationCommand

Parameters

Returns GetBucketMetadataConfigurationCommand

Settings

On This Page