Update Table

timestreamwrite_update_table

R Documentation

Modifies the retention duration of the memory store and magnetic store for your Timestream table

Description

Modifies the retention duration of the memory store and magnetic store for your Timestream table. Note that the change in retention duration takes effect immediately. For example, if the retention period of the memory store was initially set to 2 hours and then changed to 24 hours, the memory store will be capable of holding 24 hours of data, but will be populated with 24 hours of data 22 hours after this change was made. Timestream does not retrieve data from the magnetic store to populate the memory store.

See code sample for details.

Usage

timestreamwrite_update_table(DatabaseName, TableName,
  RetentionProperties, MagneticStoreWriteProperties, Schema)

Arguments

DatabaseName

[required] The name of the Timestream database.

TableName

[required] The name of the Timestream table.

RetentionProperties

The retention duration of the memory store and the magnetic store.

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$update_table(
  DatabaseName = "string",
  TableName = "string",
  RetentionProperties = list(
    MemoryStoreRetentionPeriodInHours = 123,
    MagneticStoreRetentionPeriodInDays = 123
  ),
  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"
      )
    )
  )
)