GetBucketMetadataTableConfiguration
Retrieves the metadata table configuration for a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide.
- 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
:
Request Syntax
GET /?metadataTable HTTP/1.1
Host: Bucket
.s3.amazonaws.com
x-amz-expected-bucket-owner: ExpectedBucketOwner
URI Request Parameters
The request uses the following URI parameters.
- Bucket
-
The general purpose bucket that contains the metadata table configuration that you want to retrieve.
Required: Yes
- x-amz-expected-bucket-owner
-
The expected owner of the general purpose bucket that you want to retrieve the metadata table configuration from.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<GetBucketMetadataTableConfigurationResult>
<MetadataTableConfigurationResult>
<S3TablesDestinationResult>
<TableArn>string</TableArn>
<TableBucketArn>string</TableBucketArn>
<TableName>string</TableName>
<TableNamespace>string</TableNamespace>
</S3TablesDestinationResult>
</MetadataTableConfigurationResult>
<Status>string</Status>
<Error>
<ErrorCode>string</ErrorCode>
<ErrorMessage>string</ErrorMessage>
</Error>
</GetBucketMetadataTableConfigurationResult>
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service.
- GetBucketMetadataTableConfigurationResult
-
Root level tag for the GetBucketMetadataTableConfigurationResult parameters.
Required: Yes
- Error
-
If the
CreateBucketMetadataTableConfiguration
request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code and error message.Type: ErrorDetails data type
- MetadataTableConfigurationResult
-
The metadata table configuration for a general purpose bucket.
Type: MetadataTableConfigurationResult data type
- Status
-
The status of the metadata table. The status values are:
-
CREATING
- The metadata table is in the process of being created in the specified table bucket. -
ACTIVE
- The metadata table has been created successfully and records are being delivered to the table. -
FAILED
- Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records. SeeErrorDetails
for details.
Type: String
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: