New API Documentation - Developer Preview Available
We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
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.
Example
Use a bare-bones client and the command you need to make an API call.
Your request rate is too high. The Amazon Web Services SDKs for DynamoDB
automatically retry requests that receive this exception. Your request is eventually
successful, unless your retry queue is too large to finish. Reduce the frequency of
requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
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 aLastEvaluatedKey
value to continue the read in a subsequent operation. If the filter criteria inWHERE
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 usingWHERE
clause). IfLastEvaluatedKey
is present in the response, you need to paginate the result set. IfNextToken
is present, you need to paginate the result set and includeNextToken
.Example
Use a bare-bones client and the command you need to make an API call.
Param
ExecuteStatementCommandInput
Returns
ExecuteStatementCommandOutput
See
input
shape.response
shape.config
shape.Throws
ConditionalCheckFailedException (client fault)
A condition specified in the operation could not be evaluated.
Throws
DuplicateItemException (client fault)
There was an attempt to insert an item with the same primary key as an item that already exists in the DynamoDB table.
Throws
InternalServerError (server fault)
An error occurred on the server side.
Throws
ItemCollectionSizeLimitExceededException (client fault)
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
Throws
ProvisionedThroughputExceededException (client fault)
Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
Throws
RequestLimitExceeded (client fault)
Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
Throws
ResourceNotFoundException (client fault)
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be
ACTIVE
.Throws
TransactionConflictException (client fault)
Operation was rejected because there is an ongoing transaction for the item.
Throws
DynamoDBServiceException
Base exception class for all service exceptions from DynamoDB service.