AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ExecuteStatement operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.DynamoDBv2.AmazonDynamoDBRequest
      Amazon.DynamoDBv2.Model.ExecuteStatementRequest

Namespace: Amazon.DynamoDBv2.Model
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z

Syntax

C# 
public class ExecuteStatementRequest : AmazonDynamoDBRequest
         IAmazonWebServiceRequest

The ExecuteStatementRequest type exposes the following members

Constructors

NameDescription
Public Method ExecuteStatementRequest()

Properties

NameTypeDescription
Public Property ConsistentRead System.Boolean

Gets and sets the property 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.

Public Property Limit System.Int32

Gets and sets the property 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.

Public Property NextToken System.String

Gets and sets the property NextToken.

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

Public Property Parameters System.Collections.Generic.List<Amazon.DynamoDBv2.Model.AttributeValue>

Gets and sets the property Parameters.

The parameters for the PartiQL statement, if any.

Public Property ReturnConsumedCapacity Amazon.DynamoDBv2.ReturnConsumedCapacity

Gets and sets the property ReturnConsumedCapacity.

Public Property ReturnValuesOnConditionCheckFailure Amazon.DynamoDBv2.ReturnValuesOnConditionCheckFailure

Gets and sets the property ReturnValuesOnConditionCheckFailure.

An optional parameter that returns the item attributes for an ExecuteStatement 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.

Public Property Statement System.String

Gets and sets the property Statement.

The PartiQL statement representing the operation to run.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5