Class: AWS::DynamoDB::Client

Inherits:
ClientBase show all
Defined in:
lib/aws/dynamo_db/client.rb

Overview

Client class for Amazon DynamoDB.

Constant Summary

Constants inherited from ClientBase

AWS::DynamoDB::ClientBase::CACHEABLE_REQUESTS, AWS::DynamoDB::ClientBase::REGION_US_E1

Instance Attribute Summary

Attributes inherited from Core::Client

#config

Instance Method Summary collapse

Methods inherited from Core::Client

#initialize, #log_warning, #operations, operations, #with_http_handler, #with_options

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#batch_get_item(options = {}) ⇒ Core::Response

Calls the BatchGetItem API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :request_items - required - (Hash)
      • :keys - required - (Array)
      • :hash_key_element - required - (Hash) A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.
        • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
        • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
        • :b - (String) Binary attributes are sequences of unsigned bytes.
        • :ss - (Array) A set of strings.
        • :ns - (Array) A set of numbers.
        • :bs - (Array) A set of binary attributes.
      • :range_key_element - (Hash) A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.
        • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
        • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
        • :b - (String) Binary attributes are sequences of unsigned bytes.
        • :ss - (Array) A set of strings.
        • :ns - (Array) A set of numbers.
        • :bs - (Array) A set of binary attributes.
      • :attributes_to_get - (Array)
      • :consistent_read - (Boolean)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • Responses - (Hash)
      • member - (Hash)
      • S - (String)
      • N - (String)
      • B - (String)
      • SS - (Array)
      • NS - (Array)
      • BS - (Array)
      • ConsumedCapacityUnits - (Numeric)
    • UnprocessedKeys - (Hash)
      • Keys - (Array)
      • HashKeyElement - (Hash)
        • S - (String)
        • N - (String)
        • B - (String)
        • SS - (Array)
        • NS - (Array)
        • BS - (Array)
      • RangeKeyElement - (Hash)
        • S - (String)
        • N - (String)
        • B - (String)
        • SS - (Array)
        • NS - (Array)
        • BS - (Array)
      • AttributesToGet - (Array)
      • ConsistentRead - (Boolean)



# File 'lib/aws/dynamo_db/client.rb', line 22

#batch_write_item(options = {}) ⇒ Core::Response

Calls the BatchWriteItem API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :request_items - required - (Hash>) A map of table name to list-of-write-requests. Used as input to the BatchWriteItem API call
      • :put_request - (Hash)
      • :item - required - (Hash) The item to put
        • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
        • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
        • :b - (String) Binary attributes are sequences of unsigned bytes.
        • :ss - (Array) A set of strings.
        • :ns - (Array) A set of numbers.
        • :bs - (Array) A set of binary attributes.
      • :delete_request - (Hash)
      • :key - required - (Hash) The item's key to be delete
        • :hash_key_element - required - (Hash) A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.
        • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
        • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
        • :b - (String) Binary attributes are sequences of unsigned bytes.
        • :ss - (Array) A set of strings.
        • :ns - (Array) A set of numbers.
        • :bs - (Array) A set of binary attributes.
        • :range_key_element - (Hash) A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.
        • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
        • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
        • :b - (String) Binary attributes are sequences of unsigned bytes.
        • :ss - (Array) A set of strings.
        • :ns - (Array) A set of numbers.
        • :bs - (Array) A set of binary attributes.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • Responses - (Hash)
      • ConsumedCapacityUnits - (Numeric)
    • UnprocessedItems - (Hash)
      • value - (Array)
      • PutRequest - (Hash)
        • Item - (Hash)
        • S - (String)
        • N - (String)
        • B - (String)
        • SS - (Array)
        • NS - (Array)
        • BS - (Array)
      • DeleteRequest - (Hash)
        • Key - (Hash)
        • HashKeyElement - (Hash)
          • S - (String)
          • N - (String)
          • B - (String)
          • SS - (Array)
          • NS - (Array)
          • BS - (Array)
        • RangeKeyElement - (Hash)
          • S - (String)
          • N - (String)
          • B - (String)
          • SS - (Array)
          • NS - (Array)
          • BS - (Array)



# File 'lib/aws/dynamo_db/client.rb', line 93

#create_table(options = {}) ⇒ Core::Response

Calls the CreateTable API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :table_name - required - (String) The name of the table you want to create. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).
    • :key_schema - required - (Hash)
      • :hash_key_element - required - (Hash) A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.
      • :attribute_name - required - (String) The AttributeName of the KeySchemaElement.
      • :attribute_type - required - (String) The AttributeType of the KeySchemaElement which can be a String or a Number. Valid values include:
        • S
        • N
        • B
      • :range_key_element - (Hash) A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.
      • :attribute_name - required - (String) The AttributeName of the KeySchemaElement.
      • :attribute_type - required - (String) The AttributeType of the KeySchemaElement which can be a String or a Number. Valid values include:
        • S
        • N
        • B
    • :provisioned_throughput - required - (Hash)
      • :read_capacity_units - required - (Integer) ReadCapacityUnits are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the ReadCapacityUnits. Eventually-consistent reads only require half the ReadCapacityUnits of stirctly consistent reads.
      • :write_capacity_units - required - (Integer) WriteCapacityUnits are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the WriteCapacityUnits.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • TableDescription - (Hash)
      • TableName - (String)
      • KeySchema - (Hash)
      • HashKeyElement - (Hash)
        • AttributeName - (String)
        • AttributeType - (String)
      • RangeKeyElement - (Hash)
        • AttributeName - (String)
        • AttributeType - (String)
      • TableStatus - (String)
      • CreationDateTime - (Time)
      • ProvisionedThroughput - (Hash)
      • LastIncreaseDateTime - (Time)
      • LastDecreaseDateTime - (Time)
      • ReadCapacityUnits - (Integer)
      • WriteCapacityUnits - (Integer)
      • TableSizeBytes - (Integer)
      • ItemCount - (Integer)



# File 'lib/aws/dynamo_db/client.rb', line 180

#delete_item(options = {}) ⇒ Core::Response

Calls the DeleteItem API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :table_name - required - (String) The name of the table in which you want to delete an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).
    • :key - required - (Hash)
      • :hash_key_element - required - (Hash) A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.
      • :range_key_element - (Hash) A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.
    • :expected - (Hash)
      • :value - (Hash) Specify whether or not a value already exists and has a specific content for the attribute name-value pair.
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.
      • :exists - (Boolean) Specify whether or not a value already exists for the attribute name-value pair.
    • :return_values - (String) Valid values include:
      • NONE
      • ALL_OLD
      • UPDATED_OLD
      • ALL_NEW
      • UPDATED_NEW

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • Attributes - (Hash)
      • S - (String)
      • N - (String)
      • B - (String)
      • SS - (Array)
      • NS - (Array)
      • BS - (Array)
    • ConsumedCapacityUnits - (Numeric)



# File 'lib/aws/dynamo_db/client.rb', line 244

#delete_table(options = {}) ⇒ Core::Response

Calls the DeleteTable API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :table_name - required - (String) The name of the table you want to delete. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • TableDescription - (Hash)
      • TableName - (String)
      • KeySchema - (Hash)
      • HashKeyElement - (Hash)
        • AttributeName - (String)
        • AttributeType - (String)
      • RangeKeyElement - (Hash)
        • AttributeName - (String)
        • AttributeType - (String)
      • TableStatus - (String)
      • CreationDateTime - (Time)
      • ProvisionedThroughput - (Hash)
      • LastIncreaseDateTime - (Time)
      • LastDecreaseDateTime - (Time)
      • ReadCapacityUnits - (Integer)
      • WriteCapacityUnits - (Integer)
      • TableSizeBytes - (Integer)
      • ItemCount - (Integer)



# File 'lib/aws/dynamo_db/client.rb', line 319

#describe_table(options = {}) ⇒ Core::Response

Calls the DescribeTable API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :table_name - required - (String) The name of the table you want to describe. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • Table - (Hash)
      • TableName - (String)
      • KeySchema - (Hash)
      • HashKeyElement - (Hash)
        • AttributeName - (String)
        • AttributeType - (String)
      • RangeKeyElement - (Hash)
        • AttributeName - (String)
        • AttributeType - (String)
      • TableStatus - (String)
      • CreationDateTime - (Time)
      • ProvisionedThroughput - (Hash)
      • LastIncreaseDateTime - (Time)
      • LastDecreaseDateTime - (Time)
      • ReadCapacityUnits - (Integer)
      • WriteCapacityUnits - (Integer)
      • TableSizeBytes - (Integer)
      • ItemCount - (Integer)



# File 'lib/aws/dynamo_db/client.rb', line 347

#get_item(options = {}) ⇒ Core::Response

Calls the GetItem API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :table_name - required - (String) The name of the table in which you want to get an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).
    • :key - required - (Hash)
      • :hash_key_element - required - (Hash) A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.
      • :range_key_element - (Hash) A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.
    • :attributes_to_get - (Array)
    • :consistent_read - (Boolean)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • Item - (Hash)
      • S - (String)
      • N - (String)
      • B - (String)
      • SS - (Array)
      • NS - (Array)
      • BS - (Array)
    • ConsumedCapacityUnits - (Numeric)



# File 'lib/aws/dynamo_db/client.rb', line 375

#list_tables(options = {}) ⇒ Core::Response

Calls the ListTables API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :exclusive_start_table_name - (String) The name of the table that starts the list. If you already ran a ListTables operation and recieved a LastEvaluatedTableName value in the response, use that value here to continue the list.
    • :limit - (Integer)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • TableNames - (Array)
    • LastEvaluatedTableName - (String)



# File 'lib/aws/dynamo_db/client.rb', line 429

#put_item(options = {}) ⇒ Core::Response

Calls the PutItem API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :table_name - required - (String) The name of the table in which you want to put an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).
    • :item - required - (Hash)
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.
    • :expected - (Hash)
      • :value - (Hash) Specify whether or not a value already exists and has a specific content for the attribute name-value pair.
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.
      • :exists - (Boolean) Specify whether or not a value already exists for the attribute name-value pair.
    • :return_values - (String) Valid values include:
      • NONE
      • ALL_OLD
      • UPDATED_OLD
      • ALL_NEW
      • UPDATED_NEW

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • Attributes - (Hash)
      • S - (String)
      • N - (String)
      • B - (String)
      • SS - (Array)
      • NS - (Array)
      • BS - (Array)
    • ConsumedCapacityUnits - (Numeric)



# File 'lib/aws/dynamo_db/client.rb', line 443

#query(options = {}) ⇒ Core::Response

Calls the Query API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :table_name - required - (String) The name of the table in which you want to query. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).
    • :attributes_to_get - (Array)
    • :limit - (Integer) The maximum number of items to return. If Amazon DynamoDB hits this limit while querying the table, it stops the query and returns the matching values up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to continue the query. Also, if the result set size exceeds 1MB before Amazon DynamoDB hits this limit, it stops the query and returns the matching values, and a LastEvaluatedKey to apply in a subsequent operation to continue the query.
    • :consistent_read - (Boolean)
    • :count - (Boolean) If set to true , Amazon DynamoDB returns a total number of items that match the query parameters, instead of a list of the matching items and their attributes. Do not set Count to true while providing a list of AttributesToGet, otherwise Amazon DynamoDB returns a validation error.
    • :hash_key_value - required - (Hash) Attribute value of the hash component of the composite primary key.
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.
    • :range_key_condition - (Hash) A container for the attribute values and comparison operators to use for the query.
      • :attribute_value_list - (Array)
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.
      • :comparison_operator - required - (String) Valid values include:
      • EQ
      • NE
      • IN
      • LE
      • LT
      • GE
      • GT
      • BETWEEN
      • NOT_NULL
      • NULL
      • CONTAINS
      • NOT_CONTAINS
      • BEGINS_WITH
    • :scan_index_forward - (Boolean) Specifies forward or backward traversal of the index. Amazon DynamoDB returns results reflecting the requested order, determined by the range key. Default is true (forward).
    • :exclusive_start_key - (Hash) Primary key of the item from which to continue an earlier query. An earlier query might provide this value as the LastEvaluatedKey if that query operation was interrupted before completing the query; either because of the result set size or the Limit parameter. The LastEvaluatedKey can be passed back in a new query request to continue the operation from that point.
      • :hash_key_element - required - (Hash) A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.
      • :range_key_element - (Hash) A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • member - (Hash)
      • S - (String)
      • N - (String)
      • B - (String)
      • SS - (Array)
      • NS - (Array)
      • BS - (Array)
    • Count - (Integer)
    • LastEvaluatedKey - (Hash)
      • HashKeyElement - (Hash)
      • S - (String)
      • N - (String)
      • B - (String)
      • SS - (Array)
      • NS - (Array)
      • BS - (Array)
      • RangeKeyElement - (Hash)
      • S - (String)
      • N - (String)
      • B - (String)
      • SS - (Array)
      • NS - (Array)
      • BS - (Array)
    • ConsumedCapacityUnits - (Numeric)



# File 'lib/aws/dynamo_db/client.rb', line 497

#scan(options = {}) ⇒ Core::Response

Calls the Scan API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :table_name - required - (String) The name of the table in which you want to scan. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).
    • :attributes_to_get - (Array)
    • :limit - (Integer) The maximum number of items to return. If Amazon DynamoDB hits this limit while scanning the table, it stops the scan and returns the matching values up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to continue the scan. Also, if the scanned data set size exceeds 1MB before Amazon DynamoDB hits this limit, it stops the scan and returns the matching values up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to continue the scan.
    • :count - (Boolean) If set to true , Amazon DynamoDB returns a total number of items for the Scan operation, even if the operation has no matching items for the assigned filter. Do not set Count to true while providing a list of AttributesToGet, otherwise Amazon DynamoDB returns a validation error.
    • :scan_filter - (Hash) Evaluates the scan results and returns only the desired values.
      • :attribute_value_list - (Array)
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.
      • :comparison_operator - required - (String) Valid values include:
      • EQ
      • NE
      • IN
      • LE
      • LT
      • GE
      • GT
      • BETWEEN
      • NOT_NULL
      • NULL
      • CONTAINS
      • NOT_CONTAINS
      • BEGINS_WITH
    • :exclusive_start_key - (Hash) Primary key of the item from which to continue an earlier scan. An earlier scan might provide this value if that scan operation was interrupted before scanning the entire table; either because of the result set size or the Limit parameter. The LastEvaluatedKey can be passed back in a new scan request to continue the operation from that point.
      • :hash_key_element - required - (Hash) A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.
      • :range_key_element - (Hash) A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • member - (Hash)
      • S - (String)
      • N - (String)
      • B - (String)
      • SS - (Array)
      • NS - (Array)
      • BS - (Array)
    • Count - (Integer)
    • ScannedCount - (Integer)
    • LastEvaluatedKey - (Hash)
      • HashKeyElement - (Hash)
      • S - (String)
      • N - (String)
      • B - (String)
      • SS - (Array)
      • NS - (Array)
      • BS - (Array)
      • RangeKeyElement - (Hash)
      • S - (String)
      • N - (String)
      • B - (String)
      • SS - (Array)
      • NS - (Array)
      • BS - (Array)
    • ConsumedCapacityUnits - (Numeric)



# File 'lib/aws/dynamo_db/client.rb', line 634

#update_item(options = {}) ⇒ Core::Response

Calls the UpdateItem API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :table_name - required - (String) The name of the table in which you want to update an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).
    • :key - required - (Hash)
      • :hash_key_element - required - (Hash) A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.
      • :range_key_element - (Hash) A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.
    • :attribute_updates - required - (Hash)
      • :value - (Hash)
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.
      • :action - (String) Valid values include:
      • ADD
      • PUT
      • DELETE
    • :expected - (Hash)
      • :value - (Hash) Specify whether or not a value already exists and has a specific content for the attribute name-value pair.
      • :s - (String) Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • :n - (String) Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • :b - (String) Binary attributes are sequences of unsigned bytes.
      • :ss - (Array) A set of strings.
      • :ns - (Array) A set of numbers.
      • :bs - (Array) A set of binary attributes.
      • :exists - (Boolean) Specify whether or not a value already exists for the attribute name-value pair.
    • :return_values - (String) Valid values include:
      • NONE
      • ALL_OLD
      • UPDATED_OLD
      • ALL_NEW
      • UPDATED_NEW

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • Attributes - (Hash)
      • S - (String)
      • N - (String)
      • B - (String)
      • SS - (Array)
      • NS - (Array)
      • BS - (Array)
    • ConsumedCapacityUnits - (Numeric)



# File 'lib/aws/dynamo_db/client.rb', line 752

#update_table(options = {}) ⇒ Core::Response

Calls the UpdateTable API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :table_name - required - (String) The name of the table you want to update. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).
    • :provisioned_throughput - required - (Hash)
      • :read_capacity_units - required - (Integer) ReadCapacityUnits are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the ReadCapacityUnits. Eventually-consistent reads only require half the ReadCapacityUnits of stirctly consistent reads.
      • :write_capacity_units - required - (Integer) WriteCapacityUnits are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the WriteCapacityUnits.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • TableDescription - (Hash)
      • TableName - (String)
      • KeySchema - (Hash)
      • HashKeyElement - (Hash)
        • AttributeName - (String)
        • AttributeType - (String)
      • RangeKeyElement - (Hash)
        • AttributeName - (String)
        • AttributeType - (String)
      • TableStatus - (String)
      • CreationDateTime - (Time)
      • ProvisionedThroughput - (Hash)
      • LastIncreaseDateTime - (Time)
      • LastDecreaseDateTime - (Time)
      • ReadCapacityUnits - (Integer)
      • WriteCapacityUnits - (Integer)
      • TableSizeBytes - (Integer)
      • ItemCount - (Integer)



# File 'lib/aws/dynamo_db/client.rb', line 845