CreateTableBucketCommand

Suggest an Edit

Creates a table bucket. For more information, see Creating a table bucket  in the Amazon Simple Storage Service User Guide.

Permissions

  • You must have the s3tables:CreateTableBucket permission to use this operation.

  • If you use this operation with the optional encryptionConfiguration parameter you must have the s3tables:PutTableBucketEncryption permission.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { S3TablesClient, CreateTableBucketCommand } from "@aws-sdk/client-s3tables"; // ES Modules import
// const { S3TablesClient, CreateTableBucketCommand } = require("@aws-sdk/client-s3tables"); // CommonJS import
const client = new S3TablesClient(config);
const input = { // CreateTableBucketRequest
  name: "STRING_VALUE", // required
  encryptionConfiguration: { // EncryptionConfiguration
    sseAlgorithm: "AES256" || "aws:kms", // required
    kmsKeyArn: "STRING_VALUE",
  },
};
const command = new CreateTableBucketCommand(input);
const response = await client.send(command);
// { // CreateTableBucketResponse
//   arn: "STRING_VALUE", // required
// };

CreateTableBucketCommand Input

See CreateTableBucketCommandInput for more details

Parameter
Type
Description
name
Required
string | undefined

The name for the table bucket.

encryptionConfiguration
EncryptionConfiguration | undefined

The encryption configuration to use for the table bucket. This configuration specifies the default encryption settings that will be applied to all tables created in this bucket unless overridden at the table level. The configuration includes the encryption algorithm and, if using SSE-KMS, the KMS key to use.

CreateTableBucketCommand Output

See CreateTableBucketCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
arn
Required
string | undefined

The Amazon Resource Name (ARN) of the table bucket.

Throws

Name
Fault
Details
BadRequestException
client

The request is invalid or malformed.

ConflictException
client

The request failed because there is a conflict with a previous write. You can retry the request.

ForbiddenException
client

The caller isn't authorized to make the request.

InternalServerErrorException
server

The request failed due to an internal server error.

NotFoundException
client

The request was rejected because the specified resource could not be found.

TooManyRequestsException
client

The limit on the number of requests per second was exceeded.

S3TablesServiceException
Base exception class for all service exceptions from S3Tables service.