Get Table

keyspaces_get_table

R Documentation

Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata

Description

Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.

To read table metadata using get_table, the IAM principal needs Select action permissions for the table and the system keyspace.

Usage

keyspaces_get_table(keyspaceName, tableName)

Arguments

keyspaceName

[required] The name of the keyspace that the table is stored in.

tableName

[required] The name of the table.

Value

A list with the following syntax:

list(
  keyspaceName = "string",
  tableName = "string",
  resourceArn = "string",
  creationTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  status = "ACTIVE"|"CREATING"|"UPDATING"|"DELETING"|"DELETED"|"RESTORING"|"INACCESSIBLE_ENCRYPTION_CREDENTIALS",
  schemaDefinition = list(
    allColumns = list(
      list(
        name = "string",
        type = "string"
      )
    ),
    partitionKeys = list(
      list(
        name = "string"
      )
    ),
    clusteringKeys = list(
      list(
        name = "string",
        orderBy = "ASC"|"DESC"
      )
    ),
    staticColumns = list(
      list(
        name = "string"
      )
    )
  ),
  capacitySpecification = list(
    throughputMode = "PAY_PER_REQUEST"|"PROVISIONED",
    readCapacityUnits = 123,
    writeCapacityUnits = 123,
    lastUpdateToPayPerRequestTimestamp = as.POSIXct(
      "2015-01-01"
    )
  ),
  encryptionSpecification = list(
    type = "CUSTOMER_MANAGED_KMS_KEY"|"AWS_OWNED_KMS_KEY",
    kmsKeyIdentifier = "string"
  ),
  pointInTimeRecovery = list(
    status = "ENABLED"|"DISABLED",
    earliestRestorableTimestamp = as.POSIXct(
      "2015-01-01"
    )
  ),
  ttl = list(
    status = "ENABLED"
  ),
  defaultTimeToLive = 123,
  comment = list(
    message = "string"
  ),
  clientSideTimestamps = list(
    status = "ENABLED"
  ),
  replicaSpecifications = list(
    list(
      region = "string",
      status = "ACTIVE"|"CREATING"|"UPDATING"|"DELETING"|"DELETED"|"RESTORING"|"INACCESSIBLE_ENCRYPTION_CREDENTIALS",
      capacitySpecification = list(
        throughputMode = "PAY_PER_REQUEST"|"PROVISIONED",
        readCapacityUnits = 123,
        writeCapacityUnits = 123,
        lastUpdateToPayPerRequestTimestamp = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  )
)

Request syntax

svc$get_table(
  keyspaceName = "string",
  tableName = "string"
)