Skip to content

Create Table

timestreamwrite_create_table R Documentation

Adds a new table to an existing database in your account

Description

Adds a new table to an existing database in your account. In an Amazon Web Services account, table names must be at least unique within each Region if they are in the same database. You might have identical table names in the same Region if the tables are in separate databases. While creating the table, you must specify the table name, database name, and the retention properties. Service quotas apply. See code sample for details.

Usage

timestreamwrite_create_table(DatabaseName, TableName,
  RetentionProperties, Tags, MagneticStoreWriteProperties, Schema)

Arguments

DatabaseName

[required] The name of the Timestream database.

TableName

[required] The name of the Timestream table.

RetentionProperties

The duration for which your time-series data must be stored in the memory store and the magnetic store.

Tags

A list of key-value pairs to label the table.

MagneticStoreWriteProperties

Contains properties to set on the table when enabling magnetic store writes.

Schema

The schema of the table.

Value

A list with the following syntax: 

list(
  Table = list(
    Arn = "string",
    TableName = "string",
    DatabaseName = "string",
    TableStatus = "ACTIVE"|"DELETING"|"RESTORING",
    RetentionProperties = list(
      MemoryStoreRetentionPeriodInHours = 123,
      MagneticStoreRetentionPeriodInDays = 123
    ),
    CreationTime = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedTime = as.POSIXct(
      "2015-01-01"
    ),
    MagneticStoreWriteProperties = list(
      EnableMagneticStoreWrites = TRUE|FALSE,
      MagneticStoreRejectedDataLocation = list(
        S3Configuration = list(
          BucketName = "string",
          ObjectKeyPrefix = "string",
          EncryptionOption = "SSE_S3"|"SSE_KMS",
          KmsKeyId = "string"
        )
      )
    ),
    Schema = list(
      CompositePartitionKey = list(
        list(
          Type = "DIMENSION"|"MEASURE",
          Name = "string",
          EnforcementInRecord = "REQUIRED"|"OPTIONAL"
        )
      )
    )
  )
)

Request syntax

svc$create_table(
  DatabaseName = "string",
  TableName = "string",
  RetentionProperties = list(
    MemoryStoreRetentionPeriodInHours = 123,
    MagneticStoreRetentionPeriodInDays = 123
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  MagneticStoreWriteProperties = list(
    EnableMagneticStoreWrites = TRUE|FALSE,
    MagneticStoreRejectedDataLocation = list(
      S3Configuration = list(
        BucketName = "string",
        ObjectKeyPrefix = "string",
        EncryptionOption = "SSE_S3"|"SSE_KMS",
        KmsKeyId = "string"
      )
    )
  ),
  Schema = list(
    CompositePartitionKey = list(
      list(
        Type = "DIMENSION"|"MEASURE",
        Name = "string",
        EnforcementInRecord = "REQUIRED"|"OPTIONAL"
      )
    )
  )
)