List Tables

timestreamwrite_list_tables

R Documentation

Provides a list of tables, along with the name, status, and retention properties of each table

Description

Provides a list of tables, along with the name, status, and retention properties of each table. See code sample for details.

Usage

timestreamwrite_list_tables(DatabaseName, NextToken, MaxResults)

Arguments

DatabaseName

The name of the Timestream database.

NextToken

The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

MaxResults

The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

Value

A list with the following syntax:

list(
  Tables = list(
    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"
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_tables(
  DatabaseName = "string",
  NextToken = "string",
  MaxResults = 123
)