Class: Aws::DynamoDB::Types::ExecuteStatementInput

Inherits:

Struct

• Object
• Struct
• Aws::DynamoDB::Types::ExecuteStatementInput

Includes:

Structure

Defined in:

lib/aws-sdk-dynamodb/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #consistent_read ⇒ Boolean

  The consistency of a read operation.

• #limit ⇒ Integer

  The maximum number of items to evaluate (not necessarily the number of matching items).

• #next_token ⇒ String

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

• #parameters ⇒ Array<Types::AttributeValue>

  The parameters for the PartiQL statement, if any.

• #return_consumed_capacity ⇒ String

  Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:.

• #return_values_on_condition_check_failure ⇒ String

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

• #statement ⇒ String

  The PartiQL statement representing the operation to run.

Instance Attribute Details

#consistent_read ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3146

class ExecuteStatementInput < Struct.new(
  :statement,
  :parameters,
  :consistent_read,
  :next_token,
  :return_consumed_capacity,
  :limit,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

#limit ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3146

class ExecuteStatementInput < Struct.new(
  :statement,
  :parameters,
  :consistent_read,
  :next_token,
  :return_consumed_capacity,
  :limit,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3146

class ExecuteStatementInput < Struct.new(
  :statement,
  :parameters,
  :consistent_read,
  :next_token,
  :return_consumed_capacity,
  :limit,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Array<Types::AttributeValue>

The parameters for the PartiQL statement, if any.

Returns:

• (Array<Types::AttributeValue>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3146

class ExecuteStatementInput < Struct.new(
  :statement,
  :parameters,
  :consistent_read,
  :next_token,
  :return_consumed_capacity,
  :limit,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

#return_consumed_capacity ⇒ String

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 ‘GetItem` and `BatchGetItem`, 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.

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3146

class ExecuteStatementInput < Struct.new(
  :statement,
  :parameters,
  :consistent_read,
  :next_token,
  :return_consumed_capacity,
  :limit,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

#return_values_on_condition_check_failure ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3146

class ExecuteStatementInput < Struct.new(
  :statement,
  :parameters,
  :consistent_read,
  :next_token,
  :return_consumed_capacity,
  :limit,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

#statement ⇒ String

The PartiQL statement representing the operation to run.

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3146

class ExecuteStatementInput < Struct.new(
  :statement,
  :parameters,
  :consistent_read,
  :next_token,
  :return_consumed_capacity,
  :limit,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end