Get Bucket Metadata Table Configuration

s3_get_bucket_metadata_table_configuration

R Documentation

Description¶

We recommend that you retrieve your S3 Metadata configurations by using the V2 get_bucket_metadata_table_configuration API operation. We no longer recommend using the V1 get_bucket_metadata_table_configuration 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 create_bucket_metadata_configuration 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 get_bucket_metadata_configuration API operation with V1 or V2 metadata table configurations. However, if you try to use the V1 get_bucket_metadata_table_configuration 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 (create_bucket_metadata_configuration, get_bucket_metadata_configuration, and delete_bucket_metadata_configuration) 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 get_bucket_metadata_table_configuration:

create_bucket_metadata_table_configuration
delete_bucket_metadata_table_configuration

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⁠.

Usage¶

s3_get_bucket_metadata_table_configuration(Bucket, ExpectedBucketOwner)

Arguments¶

Bucket

[required] The general purpose bucket that corresponds to the metadata table configuration that you want to retrieve.

ExpectedBucketOwner

The expected owner of the general purpose bucket that you want to retrieve the metadata table configuration for.

Value¶

A list with the following syntax:

list(
  GetBucketMetadataTableConfigurationResult = list(
    MetadataTableConfigurationResult = list(
      S3TablesDestinationResult = list(
        TableBucketArn = "string",
        TableName = "string",
        TableArn = "string",
        TableNamespace = "string"
      )
    ),
    Status = "string",
    Error = list(
      ErrorCode = "string",
      ErrorMessage = "string"
    )
  )
)

Request syntax¶

svc$get_bucket_metadata_table_configuration(
  Bucket = "string",
  ExpectedBucketOwner = "string"
)