aws-sdk-dynamodb 1.21.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a80356e6d33de84b90ea46ad2977d15d2ebe18c
-  data.tar.gz: 5427579f97376ce7bc6629bd3af444043727dba6
+  metadata.gz: 0b52f276a76146c8dfa7b4b07feefbebbbf3c640
+  data.tar.gz: '06437951610953978ec3c76316bc1f3f1bcbdf54'
 SHA512:
-  metadata.gz: 9895c44dd358b1201e370c170135f3612b9b93bc61701cb52ee0f77ddf7a70b9b9ea34efa297b021ae91e667c09c4cf47f165cc7447fc063e3412abb7e88006b
-  data.tar.gz: d2bc7af2e215cedd1feaef28aea7caad267cf4c41e5933fa925ce3c866c8500d243081e717be9b240ec11b363a1c402bbf35a93b03a83bb7c11a5dfd8aea78a8
+  metadata.gz: 490f156d1764829059e57a56ab5e5d31158a97039f46d043e4aeed3c7c6778e4805e1d3428d88eb884c931d1dbf5232628ebe869fae277bc73f9c4fd3d3a0f5a
+  data.tar.gz: 22aa88a00fb17dad21afdb13a50a278ad696033a456d5395d4fc7ea7aca70c370c2077273c4f8fcad3aaeb4de5751a1ad047d660cda823238bf088ddb1266750

data/lib/aws-sdk-dynamodb.rb

@@ -44,6 +44,6 @@ require_relative 'aws-sdk-dynamodb/customizations'
 # @service
 module Aws::DynamoDB
 
-  GEM_VERSION = '1.21.0'
+  GEM_VERSION = '1.22.0'
 
 end

data/lib/aws-sdk-dynamodb/client.rb

@@ -414,6 +414,51 @@ module Aws::DynamoDB
     #   * {Types::BatchGetItemOutput#unprocessed_keys #unprocessed_keys} => Hash<String,Types::KeysAndAttributes>
     #   * {Types::BatchGetItemOutput#consumed_capacity #consumed_capacity} => Array<Types::ConsumedCapacity>
     #
+    #
+    # @example Example: To retrieve multiple items from a table
+    #
+    #   # This example reads multiple items from the Music table using a batch of three GetItem requests.  Only the AlbumTitle
+    #   # attribute is returned.
+    #
+    #   resp = client.batch_get_item({
+    #     request_items: {
+    #       "Music" => {
+    #         keys: [
+    #           {
+    #             "Artist" => "No One You Know", 
+    #             "SongTitle" => "Call Me Today", 
+    #           }, 
+    #           {
+    #             "Artist" => "Acme Band", 
+    #             "SongTitle" => "Happy Day", 
+    #           }, 
+    #           {
+    #             "Artist" => "No One You Know", 
+    #             "SongTitle" => "Scared of My Shadow", 
+    #           }, 
+    #         ], 
+    #         projection_expression: "AlbumTitle", 
+    #       }, 
+    #     }, 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     responses: {
+    #       "Music" => [
+    #         {
+    #           "AlbumTitle" => "Somewhat Famous", 
+    #         }, 
+    #         {
+    #           "AlbumTitle" => "Blue Sky Blues", 
+    #         }, 
+    #         {
+    #           "AlbumTitle" => "Louder Than Ever", 
+    #         }, 
+    #       ], 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.batch_get_item({
@@ -624,6 +669,49 @@ module Aws::DynamoDB
     #   * {Types::BatchWriteItemOutput#item_collection_metrics #item_collection_metrics} => Hash<String,Array<Types::ItemCollectionMetrics>>
     #   * {Types::BatchWriteItemOutput#consumed_capacity #consumed_capacity} => Array<Types::ConsumedCapacity>
     #
+    #
+    # @example Example: To add multiple items to a table
+    #
+    #   # This example adds three new items to the Music table using a batch of three PutItem requests.
+    #
+    #   resp = client.batch_write_item({
+    #     request_items: {
+    #       "Music" => [
+    #         {
+    #           put_request: {
+    #             item: {
+    #               "AlbumTitle" => "Somewhat Famous", 
+    #               "Artist" => "No One You Know", 
+    #               "SongTitle" => "Call Me Today", 
+    #             }, 
+    #           }, 
+    #         }, 
+    #         {
+    #           put_request: {
+    #             item: {
+    #               "AlbumTitle" => "Songs About Life", 
+    #               "Artist" => "Acme Band", 
+    #               "SongTitle" => "Happy Day", 
+    #             }, 
+    #           }, 
+    #         }, 
+    #         {
+    #           put_request: {
+    #             item: {
+    #               "AlbumTitle" => "Blue Sky Blues", 
+    #               "Artist" => "No One You Know", 
+    #               "SongTitle" => "Scared of My Shadow", 
+    #             }, 
+    #           }, 
+    #         }, 
+    #       ], 
+    #     }, 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.batch_write_item({
@@ -1038,6 +1126,74 @@ module Aws::DynamoDB
     #
     #   * {Types::CreateTableOutput#table_description #table_description} => Types::TableDescription
     #
+    #
+    # @example Example: To create a table
+    #
+    #   # This example creates a table named Music.
+    #
+    #   resp = client.create_table({
+    #     attribute_definitions: [
+    #       {
+    #         attribute_name: "Artist", 
+    #         attribute_type: "S", 
+    #       }, 
+    #       {
+    #         attribute_name: "SongTitle", 
+    #         attribute_type: "S", 
+    #       }, 
+    #     ], 
+    #     key_schema: [
+    #       {
+    #         attribute_name: "Artist", 
+    #         key_type: "HASH", 
+    #       }, 
+    #       {
+    #         attribute_name: "SongTitle", 
+    #         key_type: "RANGE", 
+    #       }, 
+    #     ], 
+    #     provisioned_throughput: {
+    #       read_capacity_units: 5, 
+    #       write_capacity_units: 5, 
+    #     }, 
+    #     table_name: "Music", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     table_description: {
+    #       attribute_definitions: [
+    #         {
+    #           attribute_name: "Artist", 
+    #           attribute_type: "S", 
+    #         }, 
+    #         {
+    #           attribute_name: "SongTitle", 
+    #           attribute_type: "S", 
+    #         }, 
+    #       ], 
+    #       creation_date_time: Time.parse("1421866952.062"), 
+    #       item_count: 0, 
+    #       key_schema: [
+    #         {
+    #           attribute_name: "Artist", 
+    #           key_type: "HASH", 
+    #         }, 
+    #         {
+    #           attribute_name: "SongTitle", 
+    #           key_type: "RANGE", 
+    #         }, 
+    #       ], 
+    #       provisioned_throughput: {
+    #         read_capacity_units: 5, 
+    #         write_capacity_units: 5, 
+    #       }, 
+    #       table_name: "Music", 
+    #       table_size_bytes: 0, 
+    #       table_status: "CREATING", 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_table({
@@ -1440,6 +1596,27 @@ module Aws::DynamoDB
     #   * {Types::DeleteItemOutput#consumed_capacity #consumed_capacity} => Types::ConsumedCapacity
     #   * {Types::DeleteItemOutput#item_collection_metrics #item_collection_metrics} => Types::ItemCollectionMetrics
     #
+    #
+    # @example Example: To delete an item
+    #
+    #   # This example deletes an item from the Music table.
+    #
+    #   resp = client.delete_item({
+    #     key: {
+    #       "Artist" => "No One You Know", 
+    #       "SongTitle" => "Scared of My Shadow", 
+    #     }, 
+    #     table_name: "Music", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     consumed_capacity: {
+    #       capacity_units: 1, 
+    #       table_name: "Music", 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.delete_item({
@@ -1531,6 +1708,30 @@ module Aws::DynamoDB
     #
     #   * {Types::DeleteTableOutput#table_description #table_description} => Types::TableDescription
     #
+    #
+    # @example Example: To delete a table
+    #
+    #   # This example deletes the Music table.
+    #
+    #   resp = client.delete_table({
+    #     table_name: "Music", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     table_description: {
+    #       item_count: 0, 
+    #       provisioned_throughput: {
+    #         number_of_decreases_today: 1, 
+    #         read_capacity_units: 5, 
+    #         write_capacity_units: 5, 
+    #       }, 
+    #       table_name: "Music", 
+    #       table_size_bytes: 0, 
+    #       table_status: "DELETING", 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.delete_table({
@@ -1940,6 +2141,23 @@ module Aws::DynamoDB
     #   * {Types::DescribeLimitsOutput#table_max_read_capacity_units #table_max_read_capacity_units} => Integer
     #   * {Types::DescribeLimitsOutput#table_max_write_capacity_units #table_max_write_capacity_units} => Integer
     #
+    #
+    # @example Example: To determine capacity limits per table and account, in the current AWS region
+    #
+    #   # The following example returns the maximum read and write capacity units per table, and for the AWS account, in the
+    #   # current AWS region.
+    #
+    #   resp = client.describe_limits({
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     account_max_read_capacity_units: 20000, 
+    #     account_max_write_capacity_units: 20000, 
+    #     table_max_read_capacity_units: 10000, 
+    #     table_max_write_capacity_units: 10000, 
+    #   }
+    #
     # @example Response structure
     #
     #   resp.account_max_read_capacity_units #=> Integer
@@ -1976,6 +2194,51 @@ module Aws::DynamoDB
     #
     #   * {Types::DescribeTableOutput#table #table} => Types::TableDescription
     #
+    #
+    # @example Example: To describe a table
+    #
+    #   # This example describes the Music table.
+    #
+    #   resp = client.describe_table({
+    #     table_name: "Music", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     table: {
+    #       attribute_definitions: [
+    #         {
+    #           attribute_name: "Artist", 
+    #           attribute_type: "S", 
+    #         }, 
+    #         {
+    #           attribute_name: "SongTitle", 
+    #           attribute_type: "S", 
+    #         }, 
+    #       ], 
+    #       creation_date_time: Time.parse("1421866952.062"), 
+    #       item_count: 0, 
+    #       key_schema: [
+    #         {
+    #           attribute_name: "Artist", 
+    #           key_type: "HASH", 
+    #         }, 
+    #         {
+    #           attribute_name: "SongTitle", 
+    #           key_type: "RANGE", 
+    #         }, 
+    #       ], 
+    #       provisioned_throughput: {
+    #         number_of_decreases_today: 1, 
+    #         read_capacity_units: 5, 
+    #         write_capacity_units: 5, 
+    #       }, 
+    #       table_name: "Music", 
+    #       table_size_bytes: 0, 
+    #       table_status: "ACTIVE", 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_table({
@@ -2211,6 +2474,29 @@ module Aws::DynamoDB
     #   * {Types::GetItemOutput#item #item} => Hash<String,Types::AttributeValue>
     #   * {Types::GetItemOutput#consumed_capacity #consumed_capacity} => Types::ConsumedCapacity
     #
+    #
+    # @example Example: To read an item from a table
+    #
+    #   # This example retrieves an item from the Music table. The table has a partition key and a sort key (Artist and
+    #   # SongTitle), so you must specify both of these attributes.
+    #
+    #   resp = client.get_item({
+    #     key: {
+    #       "Artist" => "Acme Band", 
+    #       "SongTitle" => "Happy Day", 
+    #     }, 
+    #     table_name: "Music", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     item: {
+    #       "AlbumTitle" => "Songs About Life", 
+    #       "Artist" => "Acme Band", 
+    #       "SongTitle" => "Happy Day", 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_item({
@@ -2399,6 +2685,24 @@ module Aws::DynamoDB
     #   * {Types::ListTablesOutput#table_names #table_names} => Array<String>
     #   * {Types::ListTablesOutput#last_evaluated_table_name #last_evaluated_table_name} => String
     #
+    #
+    # @example Example: To list tables
+    #
+    #   # This example lists all of the tables associated with the current AWS account and endpoint.
+    #
+    #   resp = client.list_tables({
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     table_names: [
+    #       "Forum", 
+    #       "ProductCatalog", 
+    #       "Reply", 
+    #       "Thread", 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_tables({
@@ -2721,6 +3025,29 @@ module Aws::DynamoDB
     #   * {Types::PutItemOutput#consumed_capacity #consumed_capacity} => Types::ConsumedCapacity
     #   * {Types::PutItemOutput#item_collection_metrics #item_collection_metrics} => Types::ItemCollectionMetrics
     #
+    #
+    # @example Example: To add an item to a table
+    #
+    #   # This example adds a new item to the Music table.
+    #
+    #   resp = client.put_item({
+    #     item: {
+    #       "AlbumTitle" => "Somewhat Famous", 
+    #       "Artist" => "No One You Know", 
+    #       "SongTitle" => "Call Me Today", 
+    #     }, 
+    #     return_consumed_capacity: "TOTAL", 
+    #     table_name: "Music", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     consumed_capacity: {
+    #       capacity_units: 1, 
+    #       table_name: "Music", 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.put_item({
@@ -3214,6 +3541,34 @@ module Aws::DynamoDB
     #   * {Types::QueryOutput#last_evaluated_key #last_evaluated_key} => Hash<String,Types::AttributeValue>
     #   * {Types::QueryOutput#consumed_capacity #consumed_capacity} => Types::ConsumedCapacity
     #
+    #
+    # @example Example: To query an item
+    #
+    #   # This example queries items in the Music table. The table has a partition key and sort key (Artist and SongTitle), but
+    #   # this query only specifies the partition key value. It returns song titles by the artist named "No One You Know".
+    #
+    #   resp = client.query({
+    #     expression_attribute_values: {
+    #       ":v1" => "No One You Know", 
+    #     }, 
+    #     key_condition_expression: "Artist = :v1", 
+    #     projection_expression: "SongTitle", 
+    #     table_name: "Music", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     consumed_capacity: {
+    #     }, 
+    #     count: 2, 
+    #     items: [
+    #       {
+    #         "SongTitle" => "Call Me Today", 
+    #       }, 
+    #     ], 
+    #     scanned_count: 2, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.query({
@@ -3872,6 +4227,43 @@ module Aws::DynamoDB
     #   * {Types::ScanOutput#last_evaluated_key #last_evaluated_key} => Hash<String,Types::AttributeValue>
     #   * {Types::ScanOutput#consumed_capacity #consumed_capacity} => Types::ConsumedCapacity
     #
+    #
+    # @example Example: To scan a table
+    #
+    #   # This example scans the entire Music table, and then narrows the results to songs by the artist "No One You Know". For
+    #   # each item, only the album title and song title are returned.
+    #
+    #   resp = client.scan({
+    #     expression_attribute_names: {
+    #       "AT" => "AlbumTitle", 
+    #       "ST" => "SongTitle", 
+    #     }, 
+    #     expression_attribute_values: {
+    #       ":a" => "No One You Know", 
+    #     }, 
+    #     filter_expression: "Artist = :a", 
+    #     projection_expression: "#ST, #AT", 
+    #     table_name: "Music", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     consumed_capacity: {
+    #     }, 
+    #     count: 2, 
+    #     items: [
+    #       {
+    #         "AlbumTitle" => "Somewhat Famous", 
+    #         "SongTitle" => "Call Me Today", 
+    #       }, 
+    #       {
+    #         "AlbumTitle" => "Blue Sky Blues", 
+    #         "SongTitle" => "Scared of My Shadow", 
+    #       }, 
+    #     ], 
+    #     scanned_count: 3, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.scan({
@@ -4913,6 +5305,40 @@ module Aws::DynamoDB
     #   * {Types::UpdateItemOutput#consumed_capacity #consumed_capacity} => Types::ConsumedCapacity
     #   * {Types::UpdateItemOutput#item_collection_metrics #item_collection_metrics} => Types::ItemCollectionMetrics
     #
+    #
+    # @example Example: To update an item in a table
+    #
+    #   # This example updates an item in the Music table. It adds a new attribute (Year) and modifies the AlbumTitle attribute. 
+    #   # All of the attributes in the item, as they appear after the update, are returned in the response.
+    #
+    #   resp = client.update_item({
+    #     expression_attribute_names: {
+    #       "#AT" => "AlbumTitle", 
+    #       "#Y" => "Year", 
+    #     }, 
+    #     expression_attribute_values: {
+    #       ":t" => "Louder Than Ever", 
+    #       ":y" => "2015", 
+    #     }, 
+    #     key: {
+    #       "Artist" => "Acme Band", 
+    #       "SongTitle" => "Happy Day", 
+    #     }, 
+    #     return_values: "ALL_NEW", 
+    #     table_name: "Music", 
+    #     update_expression: "SET #Y = :y, #AT = :t", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     attributes: {
+    #       "AlbumTitle" => "Louder Than Ever", 
+    #       "Artist" => "Acme Band", 
+    #       "SongTitle" => "Happy Day", 
+    #       "Year" => "2015", 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.update_item({
@@ -5063,6 +5489,56 @@ module Aws::DynamoDB
     #
     #   * {Types::UpdateTableOutput#table_description #table_description} => Types::TableDescription
     #
+    #
+    # @example Example: To modify a table's provisioned throughput
+    #
+    #   # This example increases the provisioned read and write capacity on the Music table.
+    #
+    #   resp = client.update_table({
+    #     provisioned_throughput: {
+    #       read_capacity_units: 10, 
+    #       write_capacity_units: 10, 
+    #     }, 
+    #     table_name: "MusicCollection", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     table_description: {
+    #       attribute_definitions: [
+    #         {
+    #           attribute_name: "Artist", 
+    #           attribute_type: "S", 
+    #         }, 
+    #         {
+    #           attribute_name: "SongTitle", 
+    #           attribute_type: "S", 
+    #         }, 
+    #       ], 
+    #       creation_date_time: Time.parse("1421866952.062"), 
+    #       item_count: 0, 
+    #       key_schema: [
+    #         {
+    #           attribute_name: "Artist", 
+    #           key_type: "HASH", 
+    #         }, 
+    #         {
+    #           attribute_name: "SongTitle", 
+    #           key_type: "RANGE", 
+    #         }, 
+    #       ], 
+    #       provisioned_throughput: {
+    #         last_increase_date_time: Time.parse("1421874759.194"), 
+    #         number_of_decreases_today: 1, 
+    #         read_capacity_units: 1, 
+    #         write_capacity_units: 1, 
+    #       }, 
+    #       table_name: "MusicCollection", 
+    #       table_size_bytes: 0, 
+    #       table_status: "UPDATING", 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.update_table({
@@ -5277,7 +5753,7 @@ module Aws::DynamoDB
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-dynamodb'
-      context[:gem_version] = '1.21.0'
+      context[:gem_version] = '1.22.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-dynamodb
 version: !ruby/object:Gem::Version
-  version: 1.21.0
+  version: 1.22.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-13 00:00:00.000000000 Z
+date: 2019-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.39.0
+        version: 3.47.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,21 +29,21 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.39.0
+        version: 3.47.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 description: Official AWS Ruby gem for Amazon DynamoDB (DynamoDB). This gem is part
   of the AWS SDK for Ruby.
 email: