Get Bucket Metadata Configuration

s3_get_bucket_metadata_configuration

R Documentation

Retrieves the S3 Metadata configuration for a general purpose bucket

Description

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 get_bucket_metadata_configuration API operation with V1 or V2 metadata 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.

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 get_bucket_metadata_configuration:

• create_bucket_metadata_configuration

• delete_bucket_metadata_configuration

• update_bucket_metadata_inventory_table_configuration

• update_bucket_metadata_journal_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_configuration(Bucket, ExpectedBucketOwner)

Arguments

Bucket	[required] The general purpose bucket that corresponds to the metadata 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(
  GetBucketMetadataConfigurationResult = list(
    MetadataConfigurationResult = list(
      DestinationResult = list(
        TableBucketType = "aws"|"customer",
        TableBucketArn = "string",
        TableNamespace = "string"
      ),
      JournalTableConfigurationResult = list(
        TableStatus = "string",
        Error = list(
          ErrorCode = "string",
          ErrorMessage = "string"
        ),
        TableName = "string",
        TableArn = "string",
        RecordExpiration = list(
          Expiration = "ENABLED"|"DISABLED",
          Days = 123
        )
      ),
      InventoryTableConfigurationResult = list(
        ConfigurationState = "ENABLED"|"DISABLED",
        TableStatus = "string",
        Error = list(
          ErrorCode = "string",
          ErrorMessage = "string"
        ),
        TableName = "string",
        TableArn = "string"
      )
    )
  )
)

Request syntax

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