Skip to content

Create Batch Load Task

timestreamwrite_create_batch_load_task R Documentation

Creates a new Timestream batch load task

Description

Creates a new Timestream batch load task. A batch load task processes data from a CSV source in an S3 location and writes to a Timestream table. A mapping from source to target is defined in a batch load task. Errors and events are written to a report at an S3 location. For the report, if the KMS key is not specified, the report will be encrypted with an S3 managed key when SSE_S3 is the option. Otherwise an error is thrown. For more information, see Amazon Web Services managed keys. Service quotas apply. For details, see code sample.

Usage

timestreamwrite_create_batch_load_task(ClientToken,
  DataModelConfiguration, DataSourceConfiguration, ReportConfiguration,
  TargetDatabaseName, TargetTableName, RecordVersion)

Arguments

ClientToken
DataModelConfiguration
DataSourceConfiguration

[required] Defines configuration details about the data source for a batch load task.

ReportConfiguration

[required]

TargetDatabaseName

[required] Target Timestream database for a batch load task.

TargetTableName

[required] Target Timestream table for a batch load task.

RecordVersion

Value

A list with the following syntax:

list(
  TaskId = "string"
)

Request syntax

svc$create_batch_load_task(
  ClientToken = "string",
  DataModelConfiguration = list(
    DataModel = list(
      TimeColumn = "string",
      TimeUnit = "MILLISECONDS"|"SECONDS"|"MICROSECONDS"|"NANOSECONDS",
      DimensionMappings = list(
        list(
          SourceColumn = "string",
          DestinationColumn = "string"
        )
      ),
      MultiMeasureMappings = list(
        TargetMultiMeasureName = "string",
        MultiMeasureAttributeMappings = list(
          list(
            SourceColumn = "string",
            TargetMultiMeasureAttributeName = "string",
            MeasureValueType = "DOUBLE"|"BIGINT"|"BOOLEAN"|"VARCHAR"|"TIMESTAMP"
          )
        )
      ),
      MixedMeasureMappings = list(
        list(
          MeasureName = "string",
          SourceColumn = "string",
          TargetMeasureName = "string",
          MeasureValueType = "DOUBLE"|"BIGINT"|"VARCHAR"|"BOOLEAN"|"TIMESTAMP"|"MULTI",
          MultiMeasureAttributeMappings = list(
            list(
              SourceColumn = "string",
              TargetMultiMeasureAttributeName = "string",
              MeasureValueType = "DOUBLE"|"BIGINT"|"BOOLEAN"|"VARCHAR"|"TIMESTAMP"
            )
          )
        )
      ),
      MeasureNameColumn = "string"
    ),
    DataModelS3Configuration = list(
      BucketName = "string",
      ObjectKey = "string"
    )
  ),
  DataSourceConfiguration = list(
    DataSourceS3Configuration = list(
      BucketName = "string",
      ObjectKeyPrefix = "string"
    ),
    CsvConfiguration = list(
      ColumnSeparator = "string",
      EscapeChar = "string",
      QuoteChar = "string",
      NullValue = "string",
      TrimWhiteSpace = TRUE|FALSE
    ),
    DataFormat = "CSV"
  ),
  ReportConfiguration = list(
    ReportS3Configuration = list(
      BucketName = "string",
      ObjectKeyPrefix = "string",
      EncryptionOption = "SSE_S3"|"SSE_KMS",
      KmsKeyId = "string"
    )
  ),
  TargetDatabaseName = "string",
  TargetTableName = "string",
  RecordVersion = 123
)