Execute Transaction

dynamodb_execute_transaction

R Documentation

This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL¶

Description¶

This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.

The entire transaction must consist of either read statements or write statements, you cannot mix both in one transaction. The EXISTS function is an exception and can be used to check the condition of specific attributes of the item in a similar manner to ConditionCheck in the transact_write_items API.

Usage¶

dynamodb_execute_transaction(TransactStatements, ClientRequestToken,
  ReturnConsumedCapacity)

Arguments¶

TransactStatements

[required] The list of PartiQL statements representing the transaction to run.

ClientRequestToken

Set this value to get remaining results, if NextToken was returned in the statement response.

ReturnConsumedCapacity

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response. For more information, see transact_get_items and transact_write_items.

Value¶

A list with the following syntax:

list(
  Responses = list(
    list(
      Item = list(
        list(
          S = "string",
          N = "string",
          B = raw,
          SS = list(
            "string"
          ),
          NS = list(
            "string"
          ),
          BS = list(
            raw
          ),
          M = list(
            list()
          ),
          L = list(
            list()
          ),
          NULL = TRUE|FALSE,
          BOOL = TRUE|FALSE
        )
      )
    )
  ),
  ConsumedCapacity = list(
    list(
      TableName = "string",
      CapacityUnits = 123.0,
      ReadCapacityUnits = 123.0,
      WriteCapacityUnits = 123.0,
      Table = list(
        ReadCapacityUnits = 123.0,
        WriteCapacityUnits = 123.0,
        CapacityUnits = 123.0
      ),
      LocalSecondaryIndexes = list(
        list(
          ReadCapacityUnits = 123.0,
          WriteCapacityUnits = 123.0,
          CapacityUnits = 123.0
        )
      ),
      GlobalSecondaryIndexes = list(
        list(
          ReadCapacityUnits = 123.0,
          WriteCapacityUnits = 123.0,
          CapacityUnits = 123.0
        )
      )
    )
  )
)

Request syntax¶

svc$execute_transaction(
  TransactStatements = list(
    list(
      Statement = "string",
      Parameters = list(
        list(
          S = "string",
          N = "string",
          B = raw,
          SS = list(
            "string"
          ),
          NS = list(
            "string"
          ),
          BS = list(
            raw
          ),
          M = list(
            list()
          ),
          L = list(
            list()
          ),
          NULL = TRUE|FALSE,
          BOOL = TRUE|FALSE
        )
      ),
      ReturnValuesOnConditionCheckFailure = "ALL_OLD"|"NONE"
    )
  ),
  ClientRequestToken = "string",
  ReturnConsumedCapacity = "INDEXES"|"TOTAL"|"NONE"
)