Create Table

s3tables_create_table

R Documentation

Creates a new table associated with the given namespace in a table bucket

Description

Creates a new table associated with the given namespace in a table bucket. For more information, see Creating an Amazon S3 table in the Amazon Simple Storage Service User Guide.

Permissions

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

• If you use this operation with the optional metadata request parameter you must have the s3tables:PutTableData permission.

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

• If you use this operation with the storageClassConfiguration request parameter, you must have the s3tables:PutTableStorageClass permission.

• To create a table with tags, you must have the s3tables:TagResource permission in addition to s3tables:CreateTable permission.

Additionally, If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.

Usage

s3tables_create_table(tableBucketARN, namespace, name, format, metadata,
  encryptionConfiguration, storageClassConfiguration, tags)

Arguments

tableBucketARN	[required] The Amazon Resource Name (ARN) of the table bucket to create the table in.
namespace	[required] The namespace to associated with the table.
name	[required] The name for the table.
format	[required] The format for the table.
metadata	The metadata for the table.
encryptionConfiguration	The encryption configuration to use for the table. This configuration specifies the encryption algorithm and, if using SSE-KMS, the KMS key to use for encrypting the table. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.
storageClassConfiguration	The storage class configuration for the table. If not specified, the table inherits the storage class configuration from its table bucket. Specify this parameter to override the bucket's default storage class for this table.
tags	A map of user-defined tags that you would like to apply to the table that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize, track costs for, and control access to resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC). You must have the s3tables:TagResource permission in addition to s3tables:CreateTable permission to create a table with tags.

Value

A list with the following syntax:

list(
  tableARN = "string",
  versionToken = "string"
)

Request syntax

svc$create_table(
  tableBucketARN = "string",
  namespace = "string",
  name = "string",
  format = "ICEBERG",
  metadata = list(
    iceberg = list(
      schema = list(
        fields = list(
          list(
            id = 123,
            name = "string",
            type = "string",
            required = TRUE|FALSE
          )
        )
      ),
      schemaV2 = list(
        type = "struct",
        fields = list(
          list(
            id = 123,
            name = "string",
            type = list(),
            required = TRUE|FALSE,
            doc = "string"
          )
        ),
        schemaId = 123,
        identifierFieldIds = list(
          123
        )
      ),
      partitionSpec = list(
        fields = list(
          list(
            sourceId = 123,
            transform = "string",
            name = "string",
            fieldId = 123
          )
        ),
        specId = 123
      ),
      writeOrder = list(
        orderId = 123,
        fields = list(
          list(
            sourceId = 123,
            transform = "string",
            direction = "asc"|"desc",
            nullOrder = "nulls-first"|"nulls-last"
          )
        )
      ),
      properties = list(
        "string"
      )
    )
  ),
  encryptionConfiguration = list(
    sseAlgorithm = "AES256"|"aws:kms",
    kmsKeyArn = "string"
  ),
  storageClassConfiguration = list(
    storageClass = "STANDARD"|"INTELLIGENT_TIERING"
  ),
  tags = list(
    "string"
  )
)