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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb

Overview

Note:

When making an API call, you may pass ExecuteStatementInput data as a hash:

{
  statement: "PartiQLStatement", # required
  parameters: ["value"], # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  consistent_read: false,
  next_token: "PartiQLNextToken",
  return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#consistent_readBoolean

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)


3362
3363
3364
3365
3366
3367
3368
3369
3370
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 3362

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

#next_tokenString

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

Returns:

  • (String)


3362
3363
3364
3365
3366
3367
3368
3369
3370
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 3362

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

#parametersArray<Types::AttributeValue>

The parameters for the PartiQL statement, if any.

Returns:



3362
3363
3364
3365
3366
3367
3368
3369
3370
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 3362

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

#return_consumed_capacityString

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)


3362
3363
3364
3365
3366
3367
3368
3369
3370
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 3362

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

#statementString

The PartiQL statement representing the operation to run.

Returns:

  • (String)


3362
3363
3364
3365
3366
3367
3368
3369
3370
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 3362

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