Execute Statement
dynamodb_execute_statement | R Documentation |
This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL¶
Description¶
This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.
For PartiQL reads (SELECT
statement), if the total number of processed
items exceeds the maximum dataset size limit of 1 MB, the read stops and
results are returned to the user as a LastEvaluatedKey
value to
continue the read in a subsequent operation. If the filter criteria in
WHERE
clause does not match any data, the read will return an empty
result set.
A single SELECT
statement response can return up to the maximum number
of items (if using the Limit parameter) or a maximum of 1 MB of data
(and then apply any filtering to the results using WHERE
clause). If
LastEvaluatedKey
is present in the response, you need to paginate the
result set. If NextToken
is present, you need to paginate the result
set and include NextToken
.
Usage¶
dynamodb_execute_statement(Statement, Parameters, ConsistentRead,
NextToken, ReturnConsumedCapacity, Limit,
ReturnValuesOnConditionCheckFailure)
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
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 inLastEvaluatedKey
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.
Value¶
A list with the following syntax:
list(
Items = list(
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
)
)
),
NextToken = "string",
ConsumedCapacity = 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
)
)
),
LastEvaluatedKey = 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
)
)
)
Request syntax¶
svc$execute_statement(
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
)
),
ConsistentRead = TRUE|FALSE,
NextToken = "string",
ReturnConsumedCapacity = "INDEXES"|"TOTAL"|"NONE",
Limit = 123,
ReturnValuesOnConditionCheckFailure = "ALL_OLD"|"NONE"
)