Skip to contents

This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL

Source: R/dynamodb_operations.R
dynamodb_execute_statement.Rd

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

See https://www.paws-r-sdk.com/docs/dynamodb_execute_statement/ for full documentation.

Usage

dynamodb_execute_statement(
  Statement,
  Parameters = NULL,
  ConsistentRead = NULL,
  NextToken = NULL,
  ReturnConsumedCapacity = NULL,
  Limit = NULL,
  ReturnValuesOnConditionCheckFailure = NULL
)

Arguments

Statement

[required] The PartiQL statement representing the operation to run.

Parameters

The parameters for the PartiQL statement, if any.

ConsistentRead

The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

NextToken

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:

  • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

    Note that some operations, such as get_item and batch_get_item, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

  • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

  • NONE - No ConsumedCapacity details are included in the response.

Limit

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, along with a key in LastEvaluatedKey to apply in a subsequent operation so you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation.

ReturnValuesOnConditionCheckFailure

An optional parameter that returns the item attributes for an execute_statement operation that failed a condition check.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.