Import Table

dynamodb_import_table

R Documentation

Imports table data from an S3 bucket

Description

Imports table data from an S3 bucket.

Usage

dynamodb_import_table(ClientToken, S3BucketSource, InputFormat,
  InputFormatOptions, InputCompressionType, TableCreationParameters)

Arguments

ClientToken

Providing a ClientToken makes the call to ImportTableInput idempotent, meaning that multiple identical calls have the same effect as one single call.

A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

S3BucketSource

[required] The S3 bucket that provides the source for the import.

InputFormat

[required] The format of the source data. Valid values for ImportFormat are CSV, DYNAMODB_JSON or ION.

InputFormatOptions

Additional properties that specify how the input is formatted,

InputCompressionType

Type of compression to be used on the input coming from the imported table.

TableCreationParameters

[required] Parameters for the table to import the data into.

Value

A list with the following syntax:

list(
  ImportTableDescription = list(
    ImportArn = "string",
    ImportStatus = "IN_PROGRESS"|"COMPLETED"|"CANCELLING"|"CANCELLED"|"FAILED",
    TableArn = "string",
    TableId = "string",
    ClientToken = "string",
    S3BucketSource = list(
      S3BucketOwner = "string",
      S3Bucket = "string",
      S3KeyPrefix = "string"
    ),
    ErrorCount = 123,
    CloudWatchLogGroupArn = "string",
    InputFormat = "DYNAMODB_JSON"|"ION"|"CSV",
    InputFormatOptions = list(
      Csv = list(
        Delimiter = "string",
        HeaderList = list(
          "string"
        )
      )
    ),
    InputCompressionType = "GZIP"|"ZSTD"|"NONE",
    TableCreationParameters = list(
      TableName = "string",
      AttributeDefinitions = list(
        list(
          AttributeName = "string",
          AttributeType = "S"|"N"|"B"
        )
      ),
      KeySchema = list(
        list(
          AttributeName = "string",
          KeyType = "HASH"|"RANGE"
        )
      ),
      BillingMode = "PROVISIONED"|"PAY_PER_REQUEST",
      ProvisionedThroughput = list(
        ReadCapacityUnits = 123,
        WriteCapacityUnits = 123
      ),
      OnDemandThroughput = list(
        MaxReadRequestUnits = 123,
        MaxWriteRequestUnits = 123
      ),
      SSESpecification = list(
        Enabled = TRUE|FALSE,
        SSEType = "AES256"|"KMS",
        KMSMasterKeyId = "string"
      ),
      GlobalSecondaryIndexes = list(
        list(
          IndexName = "string",
          KeySchema = list(
            list(
              AttributeName = "string",
              KeyType = "HASH"|"RANGE"
            )
          ),
          Projection = list(
            ProjectionType = "ALL"|"KEYS_ONLY"|"INCLUDE",
            NonKeyAttributes = list(
              "string"
            )
          ),
          ProvisionedThroughput = list(
            ReadCapacityUnits = 123,
            WriteCapacityUnits = 123
          ),
          OnDemandThroughput = list(
            MaxReadRequestUnits = 123,
            MaxWriteRequestUnits = 123
          )
        )
      )
    ),
    StartTime = as.POSIXct(
      "2015-01-01"
    ),
    EndTime = as.POSIXct(
      "2015-01-01"
    ),
    ProcessedSizeBytes = 123,
    ProcessedItemCount = 123,
    ImportedItemCount = 123,
    FailureCode = "string",
    FailureMessage = "string"
  )
)

Request syntax

svc$import_table(
  ClientToken = "string",
  S3BucketSource = list(
    S3BucketOwner = "string",
    S3Bucket = "string",
    S3KeyPrefix = "string"
  ),
  InputFormat = "DYNAMODB_JSON"|"ION"|"CSV",
  InputFormatOptions = list(
    Csv = list(
      Delimiter = "string",
      HeaderList = list(
        "string"
      )
    )
  ),
  InputCompressionType = "GZIP"|"ZSTD"|"NONE",
  TableCreationParameters = list(
    TableName = "string",
    AttributeDefinitions = list(
      list(
        AttributeName = "string",
        AttributeType = "S"|"N"|"B"
      )
    ),
    KeySchema = list(
      list(
        AttributeName = "string",
        KeyType = "HASH"|"RANGE"
      )
    ),
    BillingMode = "PROVISIONED"|"PAY_PER_REQUEST",
    ProvisionedThroughput = list(
      ReadCapacityUnits = 123,
      WriteCapacityUnits = 123
    ),
    OnDemandThroughput = list(
      MaxReadRequestUnits = 123,
      MaxWriteRequestUnits = 123
    ),
    SSESpecification = list(
      Enabled = TRUE|FALSE,
      SSEType = "AES256"|"KMS",
      KMSMasterKeyId = "string"
    ),
    GlobalSecondaryIndexes = list(
      list(
        IndexName = "string",
        KeySchema = list(
          list(
            AttributeName = "string",
            KeyType = "HASH"|"RANGE"
          )
        ),
        Projection = list(
          ProjectionType = "ALL"|"KEYS_ONLY"|"INCLUDE",
          NonKeyAttributes = list(
            "string"
          )
        ),
        ProvisionedThroughput = list(
          ReadCapacityUnits = 123,
          WriteCapacityUnits = 123
        ),
        OnDemandThroughput = list(
          MaxReadRequestUnits = 123,
          MaxWriteRequestUnits = 123
        )
      )
    )
  )
)