Class: Aws::DynamoDB::Types::ExecuteStatementOutput

Inherits:

Struct

• Object
• Struct
• Aws::DynamoDB::Types::ExecuteStatementOutput

Includes:

Structure

Defined in:

lib/aws-sdk-dynamodb/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #consumed_capacity ⇒ Types::ConsumedCapacity

  The capacity units consumed by an operation.

• #items ⇒ Array<Hash<String,Types::AttributeValue>>

  If a read operation was used, this property will contain the result of the read operation; a map of attribute names and their values.

• #last_evaluated_key ⇒ Hash<String,Types::AttributeValue>

  The primary key of the item where the operation stopped, inclusive of the previous result set.

• #next_token ⇒ String

  If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response.

Instance Attribute Details

#consumed_capacity ⇒ Types::ConsumedCapacity

The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ‘ConsumedCapacity` is only returned if the request asked for it. For more information, see [Provisioned capacity mode] in the *Amazon DynamoDB Developer Guide*.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html

Returns:

• (Types::ConsumedCapacity)

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

class ExecuteStatementOutput < Struct.new(
  :items,
  :next_token,
  :consumed_capacity,
  :last_evaluated_key)
  SENSITIVE = []
  include Aws::Structure
end

#items ⇒ Array<Hash<String,Types::AttributeValue>>

If a read operation was used, this property will contain the result of the read operation; a map of attribute names and their values. For the write operations this value will be empty.

Returns:

• (Array<Hash<String,Types::AttributeValue>>)

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

class ExecuteStatementOutput < Struct.new(
  :items,
  :next_token,
  :consumed_capacity,
  :last_evaluated_key)
  SENSITIVE = []
  include Aws::Structure
end

#last_evaluated_key ⇒ Hash<String,Types::AttributeValue>

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If ‘LastEvaluatedKey` is empty, then the “last page” of results has been processed and there is no more data to be retrieved. If `LastEvaluatedKey` is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when `LastEvaluatedKey` is empty.

Returns:

• (Hash<String,Types::AttributeValue>)

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

class ExecuteStatementOutput < Struct.new(
  :items,
  :next_token,
  :consumed_capacity,
  :last_evaluated_key)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results.

Returns:

• (String)

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

class ExecuteStatementOutput < Struct.new(
  :items,
  :next_token,
  :consumed_capacity,
  :last_evaluated_key)
  SENSITIVE = []
  include Aws::Structure
end