Describe Table

timestreamwrite_describe_table

R Documentation

Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store

Description

Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. Service quotas apply. See code sample for details.

Usage

timestreamwrite_describe_table(DatabaseName, TableName)

Arguments

DatabaseName

[required] The name of the Timestream database.

TableName

[required] The name of the Timestream 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$describe_table(
  DatabaseName = "string",
  TableName = "string"
)