Class: Aws::DynamoDB::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-dynamodb/customizations/client.rb,
lib/aws-sdk-dynamodb/client.rb

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::SharedCredentials` - Used for loading credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` to enable retries and extended timeouts.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is search for in the following locations:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :compute_checksums (Boolean) — default: true —

    When ‘true`, a CRC32 checksum is computed of every HTTP response body and compared against the `X-Amz-Crc32` header. If the checksums do not match, the request is re-sent. Failures can be retried up to `:retry_limit` times.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the ‘:region` option. You should only configure an `:endpoint` when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 10 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials.

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_attributes (Boolean) — default: true —

    Enables working with DynamoDB attribute values using hashes, arrays, sets, integers, floats, booleans, and nil.

    Disabling this option requires that all attribute values have their types specified, e.g. ‘{ s: ’abc’ }‘ instead of simply `’abc’‘.

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When ‘:simple_json` is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.



239
240
241
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 239

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



5408
5409
5410
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 5408

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



5411
5412
5413
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 5411

def errors_module
  Errors
end

Instance Method Details

#batch_get_item(params = {}) ⇒ Types::BatchGetItemOutput

The ‘BatchGetItem` operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.

A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. ‘BatchGetItem` will return a partial result if the response size limit is exceeded, the table’s provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for ‘UnprocessedKeys`. You can use this value to retry the operation starting with the next item to get.

If you request more than 100 items ‘BatchGetItem` will return a `ValidationException` with the message “Too many items requested for the BatchGetItem call”.

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate ‘UnprocessedKeys` value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then ‘BatchGetItem` will return a `ProvisionedThroughputExceededException`. If *at least one* of the items is successfully processed, then `BatchGetItem` completes successfully, while returning the keys of the unread items in `UnprocessedKeys`.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, *we strongly recommend that you use an exponential backoff algorithm*. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, see [Batch Operations and Error Handling][1] in

the *Amazon DynamoDB Developer Guide*.

By default, ‘BatchGetItem` performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set `ConsistentRead` to `true` for any or all tables.

In order to minimize response latency, ‘BatchGetItem` retrieves items in parallel.

When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the ‘ProjectionExpression` parameter.

If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see [Capacity Units Calculations] in the *Amazon DynamoDB Developer Guide*.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations [2]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations

Examples:

Request syntax with placeholder values


resp = client.batch_get_item({
  request_items: { # required
    "TableName" => {
      keys: [ # required
        {
          "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
        },
      ],
      attributes_to_get: ["AttributeName"],
      consistent_read: false,
      projection_expression: "ProjectionExpression",
      expression_attribute_names: {
        "ExpressionAttributeNameVariable" => "AttributeName",
      },
    },
  },
  return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
})

Response structure


resp.responses #=> Hash
resp.responses["TableName"] #=> Array
resp.responses["TableName"][0] #=> Hash
resp.responses["TableName"][0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.unprocessed_keys #=> Hash
resp.unprocessed_keys["TableName"].keys #=> Array
resp.unprocessed_keys["TableName"].keys[0] #=> Hash
resp.unprocessed_keys["TableName"].keys[0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.unprocessed_keys["TableName"].attributes_to_get #=> Array
resp.unprocessed_keys["TableName"].attributes_to_get[0] #=> String
resp.unprocessed_keys["TableName"].consistent_read #=> Boolean
resp.unprocessed_keys["TableName"].projection_expression #=> String
resp.unprocessed_keys["TableName"].expression_attribute_names #=> Hash
resp.unprocessed_keys["TableName"].expression_attribute_names["ExpressionAttributeNameVariable"] #=> String
resp.consumed_capacity #=> Array
resp.consumed_capacity[0].table_name #=> String
resp.consumed_capacity[0].capacity_units #=> Float
resp.consumed_capacity[0].read_capacity_units #=> Float
resp.consumed_capacity[0].write_capacity_units #=> Float
resp.consumed_capacity[0].table.read_capacity_units #=> Float
resp.consumed_capacity[0].table.write_capacity_units #=> Float
resp.consumed_capacity[0].table.capacity_units #=> Float
resp.consumed_capacity[0].local_secondary_indexes #=> Hash
resp.consumed_capacity[0].local_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity[0].local_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity[0].local_secondary_indexes["IndexName"].capacity_units #=> Float
resp.consumed_capacity[0].global_secondary_indexes #=> Hash
resp.consumed_capacity[0].global_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity[0].global_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity[0].global_secondary_indexes["IndexName"].capacity_units #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :request_items (required, Hash<String,Types::KeysAndAttributes>) —

    A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per ‘BatchGetItem` request.

    Each element in the map of items to retrieve consists of the following:

    • ‘ConsistentRead` - If `true`, a strongly consistent read is used; if `false` (the default), an eventually consistent read is used.

    • ‘ExpressionAttributeNames` - One or more substitution tokens for attribute names in the `ProjectionExpression` parameter. The following are some use cases for using `ExpressionAttributeNames`:

      • To access an attribute whose name conflicts with a DynamoDB reserved word.

      • To create a placeholder for repeating occurrences of an attribute name in an expression.

      • To prevent special characters in an attribute name from being misinterpreted in an expression.

      Use the **#** character in an expression to dereference an attribute name. For example, consider the following attribute name:

      • ‘Percentile`

      ^

      The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see [Reserved Words] in the *Amazon DynamoDB Developer Guide*). To work around this, you could specify the following for ‘ExpressionAttributeNames`:

      • ‘“#P”:“Percentile”`

      ^

      You could then use this substitution in an expression, as in this example:

      • ‘#P = :val`

      ^

      <note markdown=“1”> Tokens that begin with the : character are *expression attribute values*, which are placeholders for the actual value at runtime.

      </note>

      For more information on expression attribute names, see [Accessing Item Attributes] in the *Amazon DynamoDB Developer Guide*.

    • ‘Keys` - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide both the partition key value and the sort key value.

    • ‘ProjectionExpression` - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

      If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

      For more information, see [Accessing Item Attributes] in the *Amazon DynamoDB Developer Guide*.

    • ‘AttributesToGet` - This is a legacy parameter. Use `ProjectionExpression` instead. For more information, see

      AttributesToGet][3

      in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html [2]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html [3]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html

  • :return_consumed_capacity (String) —

    Determines the level of detail about provisioned 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:

See Also:



475
476
477
478
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 475

def batch_get_item(params = {}, options = {})
  req = build_request(:batch_get_item, params)
  req.send_request(options)
end

#batch_write_item(params = {}) ⇒ Types::BatchWriteItemOutput

The ‘BatchWriteItem` operation puts or deletes multiple items in one or more tables. A single call to `BatchWriteItem` can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB.

<note markdown=“1”> ‘BatchWriteItem` cannot update items. To update items, use the `UpdateItem` action.

</note>

The individual ‘PutItem` and `DeleteItem` operations specified in `BatchWriteItem` are atomic; however `BatchWriteItem` as a whole is not. If any requested operations fail because the table’s provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the ‘UnprocessedItems` response parameter. You can investigate and optionally resend the requests. Typically, you would call `BatchWriteItem` in a loop. Each iteration would check for unprocessed items and submit a new `BatchWriteItem` request with those unprocessed items until all items have been processed.

Note that if none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then ‘BatchWriteItem` will return a `ProvisionedThroughputExceededException`.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, *we strongly recommend that you use an exponential backoff algorithm*. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, see [Batch Operations and Error Handling][1] in

the *Amazon DynamoDB Developer Guide*.

With ‘BatchWriteItem`, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, `BatchWriteItem` does not behave in the same way as individual `PutItem` and `DeleteItem` calls would. For example, you cannot specify conditions on individual put and delete requests, and `BatchWriteItem` does not return deleted items in the response.

If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don’t support threading, you must update or delete the specified items one at a time. In both situations, ‘BatchWriteItem` performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.

Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.

If one or more of the following is true, DynamoDB rejects the entire batch write operation:

  • One or more tables specified in the ‘BatchWriteItem` request does not exist.

  • Primary key attributes specified on an item in the request do not match those in the corresponding table’s primary key schema.

  • You try to perform multiple operations on the same item in the same ‘BatchWriteItem` request. For example, you cannot put and delete the same item in the same `BatchWriteItem` request.

  • Your request contains at least two items with identical hash and range keys (which essentially is two put operations).

  • There are more than 25 requests in the batch.

  • Any individual item in a batch exceeds 400 KB.

  • The total request size exceeds 16 MB.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations

Examples:

Request syntax with placeholder values


resp = client.batch_write_item({
  request_items: { # required
    "TableName" => [
      {
        put_request: {
          item: { # required
            "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
          },
        },
        delete_request: {
          key: { # required
            "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
          },
        },
      },
    ],
  },
  return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
  return_item_collection_metrics: "SIZE", # accepts SIZE, NONE
})

Response structure


resp.unprocessed_items #=> Hash
resp.unprocessed_items["TableName"] #=> Array
resp.unprocessed_items["TableName"][0].put_request.item #=> Hash
resp.unprocessed_items["TableName"][0].put_request.item["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.unprocessed_items["TableName"][0].delete_request.key #=> Hash
resp.unprocessed_items["TableName"][0].delete_request.key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.item_collection_metrics #=> Hash
resp.item_collection_metrics["TableName"] #=> Array
resp.item_collection_metrics["TableName"][0].item_collection_key #=> Hash
resp.item_collection_metrics["TableName"][0].item_collection_key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.item_collection_metrics["TableName"][0].size_estimate_range_gb #=> Array
resp.item_collection_metrics["TableName"][0].size_estimate_range_gb[0] #=> Float
resp.consumed_capacity #=> Array
resp.consumed_capacity[0].table_name #=> String
resp.consumed_capacity[0].capacity_units #=> Float
resp.consumed_capacity[0].read_capacity_units #=> Float
resp.consumed_capacity[0].write_capacity_units #=> Float
resp.consumed_capacity[0].table.read_capacity_units #=> Float
resp.consumed_capacity[0].table.write_capacity_units #=> Float
resp.consumed_capacity[0].table.capacity_units #=> Float
resp.consumed_capacity[0].local_secondary_indexes #=> Hash
resp.consumed_capacity[0].local_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity[0].local_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity[0].local_secondary_indexes["IndexName"].capacity_units #=> Float
resp.consumed_capacity[0].global_secondary_indexes #=> Hash
resp.consumed_capacity[0].global_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity[0].global_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity[0].global_secondary_indexes["IndexName"].capacity_units #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :request_items (required, Hash<String,Array>) —

    A map of one or more table names and, for each table, a list of operations to be performed (‘DeleteRequest` or `PutRequest`). Each element in the map consists of the following:

    • ‘DeleteRequest` - Perform a `DeleteItem` operation on the specified item. The item to be deleted is identified by a `Key` subelement:

      • ‘Key` - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

      ^

    • ‘PutRequest` - Perform a `PutItem` operation on the specified item. The item to be put is identified by an `Item` subelement:

      • ‘Item` - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a `ValidationException` exception.

        If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table’s attribute definition.

  • :return_consumed_capacity (String) —

    Determines the level of detail about provisioned 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.

  • :return_item_collection_metrics (String) —

    Determines whether item collection metrics are returned. If set to ‘SIZE`, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to `NONE` (the default), no statistics are returned.

Returns:

See Also:



685
686
687
688
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 685

def batch_write_item(params = {}, options = {})
  req = build_request(:batch_write_item, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 5271

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-dynamodb'
  context[:gem_version] = '1.21.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_backup(params = {}) ⇒ Types::CreateBackupOutput

Creates a backup for an existing table.

Each time you create an On-Demand Backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.

When you create an On-Demand Backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.

You can call ‘CreateBackup` at a maximum rate of 50 times per second.

All backups in DynamoDB work without consuming any provisioned throughput on the table.

If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup may or may not contain data modifications made between 14:24:00 and 14:26:00. On-Demand Backup does not support causal consistency.

Along with data, the following are also included on the backups:

  • Global secondary indexes (GSIs)

  • Local secondary indexes (LSIs)

  • Streams

  • Provisioned read and write capacity

Examples:

Request syntax with placeholder values


resp = client.create_backup({
  table_name: "TableName", # required
  backup_name: "BackupName", # required
})

Response structure


resp.backup_details.backup_arn #=> String
resp.backup_details.backup_name #=> String
resp.backup_details.backup_size_bytes #=> Integer
resp.backup_details.backup_status #=> String, one of "CREATING", "DELETED", "AVAILABLE"
resp.backup_details.backup_type #=> String, one of "USER", "SYSTEM", "AWS_BACKUP"
resp.backup_details.backup_creation_date_time #=> Time
resp.backup_details.backup_expiry_date_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_name (required, String) —

    The name of the table.

  • :backup_name (required, String) —

    Specified name for the backup.

Returns:

See Also:



754
755
756
757
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 754

def create_backup(params = {}, options = {})
  req = build_request(:create_backup, params)
  req.send_request(options)
end

#create_global_table(params = {}) ⇒ Types::CreateGlobalTableOutput

Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided regions.

If you want to add a new replica table to a global table, each of the following conditions must be true:

  • The table must have the same primary key as all of the other replicas.

  • The table must have the same name as all of the other replicas.

  • The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.

  • None of the replica tables in the global table can contain any data.

If global secondary indexes are specified, then the following conditions must also be met:

  • The global secondary indexes must have the same name.

  • The global secondary indexes must have the same hash key and sort key (if present).

Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.

If you prefer to manage write capacity settings manually, you should

provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.

Examples:

Request syntax with placeholder values


resp = client.create_global_table({
  global_table_name: "TableName", # required
  replication_group: [ # required
    {
      region_name: "RegionName",
    },
  ],
})

Response structure


resp.global_table_description.replication_group #=> Array
resp.global_table_description.replication_group[0].region_name #=> String
resp.global_table_description.global_table_arn #=> String
resp.global_table_description.creation_date_time #=> Time
resp.global_table_description.global_table_status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING"
resp.global_table_description.global_table_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :global_table_name (required, String) —

    The global table name.

  • :replication_group (required, Array<Types::Replica>) —

    The regions where the global table needs to be created.

Returns:

See Also:



828
829
830
831
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 828

def create_global_table(params = {}, options = {})
  req = build_request(:create_global_table, params)
  req.send_request(options)
end

#create_table(params = {}) ⇒ Types::CreateTableOutput

The ‘CreateTable` operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions.

‘CreateTable` is an asynchronous operation. Upon receiving a `CreateTable` request, DynamoDB immediately returns a response with a `TableStatus` of `CREATING`. After the table is created, DynamoDB sets the `TableStatus` to `ACTIVE`. You can perform read and write operations only on an `ACTIVE` table.

You can optionally define secondary indexes on the new table, as part of the ‘CreateTable` operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the `CREATING` state at any given time.

You can use the ‘DescribeTable` action to check the table status.

Examples:

Request syntax with placeholder values


resp = client.create_table({
  attribute_definitions: [ # required
    {
      attribute_name: "KeySchemaAttributeName", # required
      attribute_type: "S", # required, accepts S, N, B
    },
  ],
  table_name: "TableName", # required
  key_schema: [ # required
    {
      attribute_name: "KeySchemaAttributeName", # required
      key_type: "HASH", # required, accepts HASH, RANGE
    },
  ],
  local_secondary_indexes: [
    {
      index_name: "IndexName", # required
      key_schema: [ # required
        {
          attribute_name: "KeySchemaAttributeName", # required
          key_type: "HASH", # required, accepts HASH, RANGE
        },
      ],
      projection: { # required
        projection_type: "ALL", # accepts ALL, KEYS_ONLY, INCLUDE
        non_key_attributes: ["NonKeyAttributeName"],
      },
    },
  ],
  global_secondary_indexes: [
    {
      index_name: "IndexName", # required
      key_schema: [ # required
        {
          attribute_name: "KeySchemaAttributeName", # required
          key_type: "HASH", # required, accepts HASH, RANGE
        },
      ],
      projection: { # required
        projection_type: "ALL", # accepts ALL, KEYS_ONLY, INCLUDE
        non_key_attributes: ["NonKeyAttributeName"],
      },
      provisioned_throughput: {
        read_capacity_units: 1, # required
        write_capacity_units: 1, # required
      },
    },
  ],
  billing_mode: "PROVISIONED", # accepts PROVISIONED, PAY_PER_REQUEST
  provisioned_throughput: {
    read_capacity_units: 1, # required
    write_capacity_units: 1, # required
  },
  stream_specification: {
    stream_enabled: false,
    stream_view_type: "NEW_IMAGE", # accepts NEW_IMAGE, OLD_IMAGE, NEW_AND_OLD_IMAGES, KEYS_ONLY
  },
  sse_specification: {
    enabled: false,
    sse_type: "AES256", # accepts AES256, KMS
    kms_master_key_id: "KMSMasterKeyId",
  },
})

Response structure


resp.table_description.attribute_definitions #=> Array
resp.table_description.attribute_definitions[0].attribute_name #=> String
resp.table_description.attribute_definitions[0].attribute_type #=> String, one of "S", "N", "B"
resp.table_description.table_name #=> String
resp.table_description.key_schema #=> Array
resp.table_description.key_schema[0].attribute_name #=> String
resp.table_description.key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table_description.table_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.table_description.creation_date_time #=> Time
resp.table_description.provisioned_throughput.last_increase_date_time #=> Time
resp.table_description.provisioned_throughput.last_decrease_date_time #=> Time
resp.table_description.provisioned_throughput.number_of_decreases_today #=> Integer
resp.table_description.provisioned_throughput.read_capacity_units #=> Integer
resp.table_description.provisioned_throughput.write_capacity_units #=> Integer
resp.table_description.table_size_bytes #=> Integer
resp.table_description.item_count #=> Integer
resp.table_description.table_arn #=> String
resp.table_description.table_id #=> String
resp.table_description.billing_mode_summary.billing_mode #=> String, one of "PROVISIONED", "PAY_PER_REQUEST"
resp.table_description.billing_mode_summary.last_update_to_pay_per_request_date_time #=> Time
resp.table_description.local_secondary_indexes #=> Array
resp.table_description.local_secondary_indexes[0].index_name #=> String
resp.table_description.local_secondary_indexes[0].key_schema #=> Array
resp.table_description.local_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.table_description.local_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table_description.local_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.table_description.local_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.table_description.local_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.table_description.local_secondary_indexes[0].index_size_bytes #=> Integer
resp.table_description.local_secondary_indexes[0].item_count #=> Integer
resp.table_description.local_secondary_indexes[0].index_arn #=> String
resp.table_description.global_secondary_indexes #=> Array
resp.table_description.global_secondary_indexes[0].index_name #=> String
resp.table_description.global_secondary_indexes[0].key_schema #=> Array
resp.table_description.global_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.table_description.global_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table_description.global_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.table_description.global_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.table_description.global_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.table_description.global_secondary_indexes[0].index_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.table_description.global_secondary_indexes[0].backfilling #=> Boolean
resp.table_description.global_secondary_indexes[0].provisioned_throughput.last_increase_date_time #=> Time
resp.table_description.global_secondary_indexes[0].provisioned_throughput.last_decrease_date_time #=> Time
resp.table_description.global_secondary_indexes[0].provisioned_throughput.number_of_decreases_today #=> Integer
resp.table_description.global_secondary_indexes[0].provisioned_throughput.read_capacity_units #=> Integer
resp.table_description.global_secondary_indexes[0].provisioned_throughput.write_capacity_units #=> Integer
resp.table_description.global_secondary_indexes[0].index_size_bytes #=> Integer
resp.table_description.global_secondary_indexes[0].item_count #=> Integer
resp.table_description.global_secondary_indexes[0].index_arn #=> String
resp.table_description.stream_specification.stream_enabled #=> Boolean
resp.table_description.stream_specification.stream_view_type #=> String, one of "NEW_IMAGE", "OLD_IMAGE", "NEW_AND_OLD_IMAGES", "KEYS_ONLY"
resp.table_description.latest_stream_label #=> String
resp.table_description.latest_stream_arn #=> String
resp.table_description.restore_summary.source_backup_arn #=> String
resp.table_description.restore_summary.source_table_arn #=> String
resp.table_description.restore_summary.restore_date_time #=> Time
resp.table_description.restore_summary.restore_in_progress #=> Boolean
resp.table_description.sse_description.status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED", "UPDATING"
resp.table_description.sse_description.sse_type #=> String, one of "AES256", "KMS"
resp.table_description.sse_description.kms_master_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :attribute_definitions (required, Array<Types::AttributeDefinition>) —

    An array of attributes that describe the key schema for the table and indexes.

  • :table_name (required, String) —

    The name of the table to create.

  • :key_schema (required, Array<Types::KeySchemaElement>) —

    Specifies the attributes that make up the primary key for a table or an index. The attributes in ‘KeySchema` must also be defined in the `AttributeDefinitions` array. For more information, see [Data Model] in the *Amazon DynamoDB Developer Guide*.

    Each ‘KeySchemaElement` in the array is composed of:

    • ‘AttributeName` - The name of this key attribute.

    • ‘KeyType` - The role that the key attribute will assume:

      • ‘HASH` - partition key

      • ‘RANGE` - sort key

    <note markdown=“1”> The partition key of an item is also known as its *hash attribute*. The term “hash attribute” derives from DynamoDB’ usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

    The sort key of an item is also known as its *range attribute*. The

    term “range attribute” derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

    </note>

    For a simple primary key (partition key), you must provide exactly one element with a ‘KeyType` of `HASH`.

    For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a ‘KeyType` of `HASH`, and the second element must have a `KeyType` of `RANGE`.

    For more information, see [Specifying the Primary Key] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html [2]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key

  • :local_secondary_indexes (Array<Types::LocalSecondaryIndex>) —

    One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

    Each local secondary index in the array includes the following:

    • ‘IndexName` - The name of the local secondary index. Must be unique only for this table.

    • ‘KeySchema` - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.

    • ‘Projection` - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

      • ‘ProjectionType` - One of the following:

        • ‘KEYS_ONLY` - Only the index and primary keys are projected into the index.

        • ‘INCLUDE` - Only the specified table attributes are projected into the index. The list of projected attributes are in `NonKeyAttributes`.

        • ‘ALL` - All of the table attributes are projected into the index.

      • ‘NonKeyAttributes` - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in `NonKeyAttributes`, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

  • :global_secondary_indexes (Array<Types::GlobalSecondaryIndex>) —

    One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:

    • ‘IndexName` - The name of the global secondary index. Must be unique only for this table.

    • ‘KeySchema` - Specifies the key schema for the global secondary index.

    • ‘Projection` - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

      • ‘ProjectionType` - One of the following:

        • ‘KEYS_ONLY` - Only the index and primary keys are projected into the index.

        • ‘INCLUDE` - Only the specified table attributes are projected into the index. The list of projected attributes are in `NonKeyAttributes`.

        • ‘ALL` - All of the table attributes are projected into the index.

      • ‘NonKeyAttributes` - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in `NonKeyAttributes`, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

    • ‘ProvisionedThroughput` - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

  • :billing_mode (String) —

    Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

    • ‘PROVISIONED` - Sets the billing mode to `PROVISIONED`. We recommend using `PROVISIONED` for predictable workloads.

    • ‘PAY_PER_REQUEST` - Sets the billing mode to `PAY_PER_REQUEST`. We recommend using `PAY_PER_REQUEST` for unpredictable workloads.

  • :provisioned_throughput (Types::ProvisionedThroughput) —

    Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the ‘UpdateTable` operation.

    If you set BillingMode as ‘PROVISIONED`, you must specify this property. If you set BillingMode as `PAY_PER_REQUEST`, you cannot specify this property.

    For current minimum and maximum provisioned throughput values, see

    Limits][1

    in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html

  • :stream_specification (Types::StreamSpecification) —

    The settings for DynamoDB Streams on the table. These settings consist of:

    • ‘StreamEnabled` - Indicates whether Streams is to be enabled (true) or disabled (false).

    • ‘StreamViewType` - When an item in the table is modified, `StreamViewType` determines what information is written to the table’s stream. Valid values for ‘StreamViewType` are:

      • ‘KEYS_ONLY` - Only the key attributes of the modified item are written to the stream.

      • ‘NEW_IMAGE` - The entire item, as it appears after it was modified, is written to the stream.

      • ‘OLD_IMAGE` - The entire item, as it appeared before it was modified, is written to the stream.

      • ‘NEW_AND_OLD_IMAGES` - Both the new and the old item images of the item are written to the stream.

  • :sse_specification (Types::SSESpecification) —

    Represents the settings used to enable server-side encryption.

Returns:

See Also:



1174
1175
1176
1177
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 1174

def create_table(params = {}, options = {})
  req = build_request(:create_table, params)
  req.send_request(options)
end

#delete_backup(params = {}) ⇒ Types::DeleteBackupOutput

Deletes an existing backup of a table.

You can call ‘DeleteBackup` at a maximum rate of 10 times per second.

Examples:

Request syntax with placeholder values


resp = client.delete_backup({
  backup_arn: "BackupArn", # required
})

Response structure


resp.backup_description.backup_details.backup_arn #=> String
resp.backup_description.backup_details.backup_name #=> String
resp.backup_description.backup_details.backup_size_bytes #=> Integer
resp.backup_description.backup_details.backup_status #=> String, one of "CREATING", "DELETED", "AVAILABLE"
resp.backup_description.backup_details.backup_type #=> String, one of "USER", "SYSTEM", "AWS_BACKUP"
resp.backup_description.backup_details.backup_creation_date_time #=> Time
resp.backup_description.backup_details.backup_expiry_date_time #=> Time
resp.backup_description.source_table_details.table_name #=> String
resp.backup_description.source_table_details.table_id #=> String
resp.backup_description.source_table_details.table_arn #=> String
resp.backup_description.source_table_details.table_size_bytes #=> Integer
resp.backup_description.source_table_details.key_schema #=> Array
resp.backup_description.source_table_details.key_schema[0].attribute_name #=> String
resp.backup_description.source_table_details.key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.backup_description.source_table_details.table_creation_date_time #=> Time
resp.backup_description.source_table_details.provisioned_throughput.read_capacity_units #=> Integer
resp.backup_description.source_table_details.provisioned_throughput.write_capacity_units #=> Integer
resp.backup_description.source_table_details.item_count #=> Integer
resp.backup_description.source_table_details.billing_mode #=> String, one of "PROVISIONED", "PAY_PER_REQUEST"
resp.backup_description.source_table_feature_details.local_secondary_indexes #=> Array
resp.backup_description.source_table_feature_details.local_secondary_indexes[0].index_name #=> String
resp.backup_description.source_table_feature_details.local_secondary_indexes[0].key_schema #=> Array
resp.backup_description.source_table_feature_details.local_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.backup_description.source_table_feature_details.local_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.backup_description.source_table_feature_details.local_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.backup_description.source_table_feature_details.local_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.backup_description.source_table_feature_details.local_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.backup_description.source_table_feature_details.global_secondary_indexes #=> Array
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].index_name #=> String
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].key_schema #=> Array
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].provisioned_throughput.read_capacity_units #=> Integer
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].provisioned_throughput.write_capacity_units #=> Integer
resp.backup_description.source_table_feature_details.stream_description.stream_enabled #=> Boolean
resp.backup_description.source_table_feature_details.stream_description.stream_view_type #=> String, one of "NEW_IMAGE", "OLD_IMAGE", "NEW_AND_OLD_IMAGES", "KEYS_ONLY"
resp.backup_description.source_table_feature_details.time_to_live_description.time_to_live_status #=> String, one of "ENABLING", "DISABLING", "ENABLED", "DISABLED"
resp.backup_description.source_table_feature_details.time_to_live_description.attribute_name #=> String
resp.backup_description.source_table_feature_details.sse_description.status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED", "UPDATING"
resp.backup_description.source_table_feature_details.sse_description.sse_type #=> String, one of "AES256", "KMS"
resp.backup_description.source_table_feature_details.sse_description.kms_master_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :backup_arn (required, String) —

    The ARN associated with the backup.

Returns:

See Also:



1247
1248
1249
1250
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 1247

def delete_backup(params = {}, options = {})
  req = build_request(:delete_backup, params)
  req.send_request(options)
end

#delete_item(params = {}) ⇒ Types::DeleteItemOutput

Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.

In addition to deleting an item, you can also return the item’s attribute values in the same operation, using the ‘ReturnValues` parameter.

Unless you specify conditions, the ‘DeleteItem` is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

Examples:

Request syntax with placeholder values


resp = client.delete_item({
  table_name: "TableName", # required
  key: { # required
    "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  expected: {
    "AttributeName" => {
      value: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
      exists: false,
      comparison_operator: "EQ", # accepts EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
      attribute_value_list: ["value"], # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
    },
  },
  conditional_operator: "AND", # accepts AND, OR
  return_values: "NONE", # accepts NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
  return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
  return_item_collection_metrics: "SIZE", # accepts SIZE, NONE
  condition_expression: "ConditionExpression",
  expression_attribute_names: {
    "ExpressionAttributeNameVariable" => "AttributeName",
  },
  expression_attribute_values: {
    "ExpressionAttributeValueVariable" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
})

Response structure


resp.attributes #=> Hash
resp.attributes["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.consumed_capacity.table_name #=> String
resp.consumed_capacity.capacity_units #=> Float
resp.consumed_capacity.read_capacity_units #=> Float
resp.consumed_capacity.write_capacity_units #=> Float
resp.consumed_capacity.table.read_capacity_units #=> Float
resp.consumed_capacity.table.write_capacity_units #=> Float
resp.consumed_capacity.table.capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes #=> Hash
resp.consumed_capacity.local_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes["IndexName"].capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes #=> Hash
resp.consumed_capacity.global_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes["IndexName"].capacity_units #=> Float
resp.item_collection_metrics.item_collection_key #=> Hash
resp.item_collection_metrics.item_collection_key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.item_collection_metrics.size_estimate_range_gb #=> Array
resp.item_collection_metrics.size_estimate_range_gb[0] #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_name (required, String) —

    The name of the table from which to delete the item.

  • :key (required, Hash<String,Types::AttributeValue>) —

    A map of attribute names to ‘AttributeValue` objects, representing the primary key of the item to delete.

    For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

  • :expected (Hash<String,Types::ExpectedAttributeValue>) —

    This is a legacy parameter. Use ‘ConditionExpression` instead. For more information, see [Expected] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html

  • :conditional_operator (String) —

    This is a legacy parameter. Use ‘ConditionExpression` instead. For more information, see [ConditionalOperator] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html

  • :return_values (String) —

    Use ‘ReturnValues` if you want to get the item attributes as they appeared before they were deleted. For `DeleteItem`, the valid values are:

    • ‘NONE` - If `ReturnValues` is not specified, or if its value is `NONE`, then nothing is returned. (This setting is the default for `ReturnValues`.)

    • ‘ALL_OLD` - The content of the old item is returned.

    <note markdown=“1”> The ‘ReturnValues` parameter is used by several DynamoDB operations; however, `DeleteItem` does not recognize any values other than `NONE` or `ALL_OLD`.

    </note>
  • :return_consumed_capacity (String) —

    Determines the level of detail about provisioned 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.

  • :return_item_collection_metrics (String) —

    Determines whether item collection metrics are returned. If set to ‘SIZE`, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to `NONE` (the default), no statistics are returned.

  • :condition_expression (String) —

    A condition that must be satisfied in order for a conditional ‘DeleteItem` to succeed.

    An expression can contain any of the following:

    • Functions: ‘attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size`

      These function names are case-sensitive.

    • Comparison operators: ‘= | <> | < | > | <= | >= | BETWEEN | IN `

    • Logical operators: ‘AND | OR | NOT`

    For more information on condition expressions, see [Specifying Conditions] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html

  • :expression_attribute_names (Hash<String,String>) —

    One or more substitution tokens for attribute names in an expression. The following are some use cases for using ‘ExpressionAttributeNames`:

    • To access an attribute whose name conflicts with a DynamoDB reserved word.

    • To create a placeholder for repeating occurrences of an attribute name in an expression.

    • To prevent special characters in an attribute name from being misinterpreted in an expression.

    Use the **#** character in an expression to dereference an attribute name. For example, consider the following attribute name:

    • ‘Percentile`

    ^

    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see [Reserved Words] in the *Amazon DynamoDB Developer Guide*). To work around this, you could specify the following for ‘ExpressionAttributeNames`:

    • ‘“#P”:“Percentile”`

    ^

    You could then use this substitution in an expression, as in this example:

    • ‘#P = :val`

    ^

    <note markdown=“1”> Tokens that begin with the : character are *expression attribute values*, which are placeholders for the actual value at runtime.

    </note>

    For more information on expression attribute names, see [Accessing Item Attributes] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html [2]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html

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

    One or more values that can be substituted in an expression.

    Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

    ‘Available | Backordered | Discontinued`

    You would first need to specify ‘ExpressionAttributeValues` as follows:

    ‘{ “:avail”:“S”:“Available”, “:back”:“S”:“Backordered”, “:disc”:“S”:“Discontinued” }`

    You could then use these values in an expression, such as this:

    ‘ProductStatus IN (:avail, :back, :disc)`

    For more information on expression attribute values, see [Specifying Conditions] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html

Returns:

See Also:



1499
1500
1501
1502
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 1499

def delete_item(params = {}, options = {})
  req = build_request(:delete_item, params)
  req.send_request(options)
end

#delete_table(params = {}) ⇒ Types::DeleteTableOutput

The ‘DeleteTable` operation deletes a table and all of its items. After a `DeleteTable` request, the specified table is in the `DELETING` state until DynamoDB completes the deletion. If the table is in the `ACTIVE` state, you can delete it. If a table is in `CREATING` or `UPDATING` states, then DynamoDB returns a `ResourceInUseException`. If the specified table does not exist, DynamoDB returns a `ResourceNotFoundException`. If table is already in the `DELETING` state, no error is returned.

<note markdown=“1”> DynamoDB might continue to accept data read and write operations, such as ‘GetItem` and `PutItem`, on a table in the `DELETING` state until the table deletion is complete.

</note>

When you delete a table, any indexes on that table are also deleted.

If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the ‘DISABLED` state, and the stream is automatically deleted after 24 hours.

Use the ‘DescribeTable` action to check the status of the table.

Examples:

Request syntax with placeholder values


resp = client.delete_table({
  table_name: "TableName", # required
})

Response structure


resp.table_description.attribute_definitions #=> Array
resp.table_description.attribute_definitions[0].attribute_name #=> String
resp.table_description.attribute_definitions[0].attribute_type #=> String, one of "S", "N", "B"
resp.table_description.table_name #=> String
resp.table_description.key_schema #=> Array
resp.table_description.key_schema[0].attribute_name #=> String
resp.table_description.key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table_description.table_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.table_description.creation_date_time #=> Time
resp.table_description.provisioned_throughput.last_increase_date_time #=> Time
resp.table_description.provisioned_throughput.last_decrease_date_time #=> Time
resp.table_description.provisioned_throughput.number_of_decreases_today #=> Integer
resp.table_description.provisioned_throughput.read_capacity_units #=> Integer
resp.table_description.provisioned_throughput.write_capacity_units #=> Integer
resp.table_description.table_size_bytes #=> Integer
resp.table_description.item_count #=> Integer
resp.table_description.table_arn #=> String
resp.table_description.table_id #=> String
resp.table_description.billing_mode_summary.billing_mode #=> String, one of "PROVISIONED", "PAY_PER_REQUEST"
resp.table_description.billing_mode_summary.last_update_to_pay_per_request_date_time #=> Time
resp.table_description.local_secondary_indexes #=> Array
resp.table_description.local_secondary_indexes[0].index_name #=> String
resp.table_description.local_secondary_indexes[0].key_schema #=> Array
resp.table_description.local_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.table_description.local_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table_description.local_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.table_description.local_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.table_description.local_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.table_description.local_secondary_indexes[0].index_size_bytes #=> Integer
resp.table_description.local_secondary_indexes[0].item_count #=> Integer
resp.table_description.local_secondary_indexes[0].index_arn #=> String
resp.table_description.global_secondary_indexes #=> Array
resp.table_description.global_secondary_indexes[0].index_name #=> String
resp.table_description.global_secondary_indexes[0].key_schema #=> Array
resp.table_description.global_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.table_description.global_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table_description.global_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.table_description.global_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.table_description.global_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.table_description.global_secondary_indexes[0].index_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.table_description.global_secondary_indexes[0].backfilling #=> Boolean
resp.table_description.global_secondary_indexes[0].provisioned_throughput.last_increase_date_time #=> Time
resp.table_description.global_secondary_indexes[0].provisioned_throughput.last_decrease_date_time #=> Time
resp.table_description.global_secondary_indexes[0].provisioned_throughput.number_of_decreases_today #=> Integer
resp.table_description.global_secondary_indexes[0].provisioned_throughput.read_capacity_units #=> Integer
resp.table_description.global_secondary_indexes[0].provisioned_throughput.write_capacity_units #=> Integer
resp.table_description.global_secondary_indexes[0].index_size_bytes #=> Integer
resp.table_description.global_secondary_indexes[0].item_count #=> Integer
resp.table_description.global_secondary_indexes[0].index_arn #=> String
resp.table_description.stream_specification.stream_enabled #=> Boolean
resp.table_description.stream_specification.stream_view_type #=> String, one of "NEW_IMAGE", "OLD_IMAGE", "NEW_AND_OLD_IMAGES", "KEYS_ONLY"
resp.table_description.latest_stream_label #=> String
resp.table_description.latest_stream_arn #=> String
resp.table_description.restore_summary.source_backup_arn #=> String
resp.table_description.restore_summary.source_table_arn #=> String
resp.table_description.restore_summary.restore_date_time #=> Time
resp.table_description.restore_summary.restore_in_progress #=> Boolean
resp.table_description.sse_description.status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED", "UPDATING"
resp.table_description.sse_description.sse_type #=> String, one of "AES256", "KMS"
resp.table_description.sse_description.kms_master_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_name (required, String) —

    The name of the table to delete.

Returns:

See Also:



1607
1608
1609
1610
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 1607

def delete_table(params = {}, options = {})
  req = build_request(:delete_table, params)
  req.send_request(options)
end

#describe_backup(params = {}) ⇒ Types::DescribeBackupOutput

Describes an existing backup of a table.

You can call ‘DescribeBackup` at a maximum rate of 10 times per second.

Examples:

Request syntax with placeholder values


resp = client.describe_backup({
  backup_arn: "BackupArn", # required
})

Response structure


resp.backup_description.backup_details.backup_arn #=> String
resp.backup_description.backup_details.backup_name #=> String
resp.backup_description.backup_details.backup_size_bytes #=> Integer
resp.backup_description.backup_details.backup_status #=> String, one of "CREATING", "DELETED", "AVAILABLE"
resp.backup_description.backup_details.backup_type #=> String, one of "USER", "SYSTEM", "AWS_BACKUP"
resp.backup_description.backup_details.backup_creation_date_time #=> Time
resp.backup_description.backup_details.backup_expiry_date_time #=> Time
resp.backup_description.source_table_details.table_name #=> String
resp.backup_description.source_table_details.table_id #=> String
resp.backup_description.source_table_details.table_arn #=> String
resp.backup_description.source_table_details.table_size_bytes #=> Integer
resp.backup_description.source_table_details.key_schema #=> Array
resp.backup_description.source_table_details.key_schema[0].attribute_name #=> String
resp.backup_description.source_table_details.key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.backup_description.source_table_details.table_creation_date_time #=> Time
resp.backup_description.source_table_details.provisioned_throughput.read_capacity_units #=> Integer
resp.backup_description.source_table_details.provisioned_throughput.write_capacity_units #=> Integer
resp.backup_description.source_table_details.item_count #=> Integer
resp.backup_description.source_table_details.billing_mode #=> String, one of "PROVISIONED", "PAY_PER_REQUEST"
resp.backup_description.source_table_feature_details.local_secondary_indexes #=> Array
resp.backup_description.source_table_feature_details.local_secondary_indexes[0].index_name #=> String
resp.backup_description.source_table_feature_details.local_secondary_indexes[0].key_schema #=> Array
resp.backup_description.source_table_feature_details.local_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.backup_description.source_table_feature_details.local_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.backup_description.source_table_feature_details.local_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.backup_description.source_table_feature_details.local_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.backup_description.source_table_feature_details.local_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.backup_description.source_table_feature_details.global_secondary_indexes #=> Array
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].index_name #=> String
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].key_schema #=> Array
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].provisioned_throughput.read_capacity_units #=> Integer
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].provisioned_throughput.write_capacity_units #=> Integer
resp.backup_description.source_table_feature_details.stream_description.stream_enabled #=> Boolean
resp.backup_description.source_table_feature_details.stream_description.stream_view_type #=> String, one of "NEW_IMAGE", "OLD_IMAGE", "NEW_AND_OLD_IMAGES", "KEYS_ONLY"
resp.backup_description.source_table_feature_details.time_to_live_description.time_to_live_status #=> String, one of "ENABLING", "DISABLING", "ENABLED", "DISABLED"
resp.backup_description.source_table_feature_details.time_to_live_description.attribute_name #=> String
resp.backup_description.source_table_feature_details.sse_description.status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED", "UPDATING"
resp.backup_description.source_table_feature_details.sse_description.sse_type #=> String, one of "AES256", "KMS"
resp.backup_description.source_table_feature_details.sse_description.kms_master_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :backup_arn (required, String) —

    The ARN associated with the backup.

Returns:

See Also:



1681
1682
1683
1684
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 1681

def describe_backup(params = {}, options = {})
  req = build_request(:describe_backup, params)
  req.send_request(options)
end

#describe_continuous_backups(params = {}) ⇒ Types::DescribeContinuousBackupsOutput

Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are ‘ENABLED` on all tables at table creation. If point in time recovery is enabled, `PointInTimeRecoveryStatus` will be set to ENABLED.

Once continuous backups and point in time recovery are enabled, you can restore to any point in time within ‘EarliestRestorableDateTime` and `LatestRestorableDateTime`.

‘LatestRestorableDateTime` is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.

You can call ‘DescribeContinuousBackups` at a maximum rate of 10 times per second.

Examples:

Request syntax with placeholder values


resp = client.describe_continuous_backups({
  table_name: "TableName", # required
})

Response structure


resp.continuous_backups_description.continuous_backups_status #=> String, one of "ENABLED", "DISABLED"
resp.continuous_backups_description.point_in_time_recovery_description.point_in_time_recovery_status #=> String, one of "ENABLED", "DISABLED"
resp.continuous_backups_description.point_in_time_recovery_description.earliest_restorable_date_time #=> Time
resp.continuous_backups_description.point_in_time_recovery_description.latest_restorable_date_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_name (required, String) —

    Name of the table for which the customer wants to check the continuous backups and point in time recovery settings.

Returns:

See Also:



1727
1728
1729
1730
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 1727

def describe_continuous_backups(params = {}, options = {})
  req = build_request(:describe_continuous_backups, params)
  req.send_request(options)
end

#describe_endpoints(params = {}) ⇒ Types::DescribeEndpointsResponse

Returns the regional endpoint information.

Examples:

Response structure


resp.endpoints #=> Array
resp.endpoints[0].address #=> String
resp.endpoints[0].cache_period_in_minutes #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



1748
1749
1750
1751
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 1748

def describe_endpoints(params = {}, options = {})
  req = build_request(:describe_endpoints, params)
  req.send_request(options)
end

#describe_global_table(params = {}) ⇒ Types::DescribeGlobalTableOutput

Returns information about the specified global table.

Examples:

Request syntax with placeholder values


resp = client.describe_global_table({
  global_table_name: "TableName", # required
})

Response structure


resp.global_table_description.replication_group #=> Array
resp.global_table_description.replication_group[0].region_name #=> String
resp.global_table_description.global_table_arn #=> String
resp.global_table_description.creation_date_time #=> Time
resp.global_table_description.global_table_status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING"
resp.global_table_description.global_table_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :global_table_name (required, String) —

    The name of the global table.

Returns:

See Also:



1781
1782
1783
1784
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 1781

def describe_global_table(params = {}, options = {})
  req = build_request(:describe_global_table, params)
  req.send_request(options)
end

#describe_global_table_settings(params = {}) ⇒ Types::DescribeGlobalTableSettingsOutput

Describes region specific settings for a global table.

Examples:

Request syntax with placeholder values


resp = client.describe_global_table_settings({
  global_table_name: "TableName", # required
})

Response structure


resp.global_table_name #=> String
resp.replica_settings #=> Array
resp.replica_settings[0].region_name #=> String
resp.replica_settings[0].replica_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.replica_settings[0].replica_billing_mode_summary.billing_mode #=> String, one of "PROVISIONED", "PAY_PER_REQUEST"
resp.replica_settings[0].replica_billing_mode_summary.last_update_to_pay_per_request_date_time #=> Time
resp.replica_settings[0].replica_provisioned_read_capacity_units #=> Integer
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.minimum_units #=> Integer
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.maximum_units #=> Integer
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.auto_scaling_disabled #=> Boolean
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.auto_scaling_role_arn #=> String
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies #=> Array
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].policy_name #=> String
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.disable_scale_in #=> Boolean
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_in_cooldown #=> Integer
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_out_cooldown #=> Integer
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.target_value #=> Float
resp.replica_settings[0].replica_provisioned_write_capacity_units #=> Integer
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.minimum_units #=> Integer
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.maximum_units #=> Integer
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.auto_scaling_disabled #=> Boolean
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.auto_scaling_role_arn #=> String
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies #=> Array
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].policy_name #=> String
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.disable_scale_in #=> Boolean
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_in_cooldown #=> Integer
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_out_cooldown #=> Integer
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.target_value #=> Float
resp.replica_settings[0].replica_global_secondary_index_settings #=> Array
resp.replica_settings[0].replica_global_secondary_index_settings[0].index_name #=> String
resp.replica_settings[0].replica_global_secondary_index_settings[0].index_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_units #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.minimum_units #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.maximum_units #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.auto_scaling_disabled #=> Boolean
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.auto_scaling_role_arn #=> String
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies #=> Array
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].policy_name #=> String
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.disable_scale_in #=> Boolean
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_in_cooldown #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_out_cooldown #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.target_value #=> Float
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_units #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.minimum_units #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.maximum_units #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.auto_scaling_disabled #=> Boolean
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.auto_scaling_role_arn #=> String
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies #=> Array
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].policy_name #=> String
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.disable_scale_in #=> Boolean
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_in_cooldown #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_out_cooldown #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.target_value #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :global_table_name (required, String) —

    The name of the global table to describe.

Returns:

See Also:



1862
1863
1864
1865
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 1862

def describe_global_table_settings(params = {}, options = {})
  req = build_request(:describe_global_table_settings, params)
  req.send_request(options)
end

#describe_limits(params = {}) ⇒ Types::DescribeLimitsOutput

Returns the current provisioned-capacity limits for your AWS account in a region, both for the region as a whole and for any one DynamoDB table that you create there.

When you establish an AWS account, the account has initial limits on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given region. Also, there are per-table limits that apply when you create a table there. For more information, see [Limits] page in the *Amazon DynamoDB Developer Guide*.

Although you can increase these limits by filing a case at [AWS Support Center], obtaining the increase is not instantaneous. The ‘DescribeLimits` action lets you write code to compare the capacity you are currently using to those limits imposed by your account so that you have enough time to apply for an increase before you hit a limit.

For example, you could use one of the AWS SDKs to do the following:

  1. Call ‘DescribeLimits` for a particular region to obtain your current account limits on provisioned capacity there.

  2. Create a variable to hold the aggregate read capacity units provisioned for all your tables in that region, and one to hold the aggregate write capacity units. Zero them both.

  3. Call ‘ListTables` to obtain a list of all your DynamoDB tables.

  4. For each table name listed by ‘ListTables`, do the following:

    • Call ‘DescribeTable` with the table name.

    • Use the data returned by ‘DescribeTable` to add the read capacity units and write capacity units provisioned for the table itself to your variables.

    • If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.

  5. Report the account limits for that region returned by ‘DescribeLimits`, along with the total current provisioned capacity levels you have calculated.

This will let you see whether you are getting close to your account-level limits.

The per-table limits apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.

For existing tables and their GSIs, DynamoDB will not let you increase provisioned capacity extremely rapidly, but the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits.

<note markdown=“1”> ‘DescribeLimits` should only be called periodically. You can expect throttling errors if you call it more than once in a minute.

</note>

The ‘DescribeLimits` Request element has no content.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html [2]: console.aws.amazon.com/support/home#/

Examples:

Response structure


resp. #=> Integer
resp. #=> Integer
resp.table_max_read_capacity_units #=> Integer
resp.table_max_write_capacity_units #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



1954
1955
1956
1957
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 1954

def describe_limits(params = {}, options = {})
  req = build_request(:describe_limits, params)
  req.send_request(options)
end

#describe_table(params = {}) ⇒ Types::DescribeTableOutput

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

<note markdown=“1”> If you issue a ‘DescribeTable` request immediately after a `CreateTable` request, DynamoDB might return a `ResourceNotFoundException`. This is because `DescribeTable` uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the `DescribeTable` request again.

</note>

Examples:

Request syntax with placeholder values


resp = client.describe_table({
  table_name: "TableName", # required
})

Response structure


resp.table.attribute_definitions #=> Array
resp.table.attribute_definitions[0].attribute_name #=> String
resp.table.attribute_definitions[0].attribute_type #=> String, one of "S", "N", "B"
resp.table.table_name #=> String
resp.table.key_schema #=> Array
resp.table.key_schema[0].attribute_name #=> String
resp.table.key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table.table_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.table.creation_date_time #=> Time
resp.table.provisioned_throughput.last_increase_date_time #=> Time
resp.table.provisioned_throughput.last_decrease_date_time #=> Time
resp.table.provisioned_throughput.number_of_decreases_today #=> Integer
resp.table.provisioned_throughput.read_capacity_units #=> Integer
resp.table.provisioned_throughput.write_capacity_units #=> Integer
resp.table.table_size_bytes #=> Integer
resp.table.item_count #=> Integer
resp.table.table_arn #=> String
resp.table.table_id #=> String
resp.table.billing_mode_summary.billing_mode #=> String, one of "PROVISIONED", "PAY_PER_REQUEST"
resp.table.billing_mode_summary.last_update_to_pay_per_request_date_time #=> Time
resp.table.local_secondary_indexes #=> Array
resp.table.local_secondary_indexes[0].index_name #=> String
resp.table.local_secondary_indexes[0].key_schema #=> Array
resp.table.local_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.table.local_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table.local_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.table.local_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.table.local_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.table.local_secondary_indexes[0].index_size_bytes #=> Integer
resp.table.local_secondary_indexes[0].item_count #=> Integer
resp.table.local_secondary_indexes[0].index_arn #=> String
resp.table.global_secondary_indexes #=> Array
resp.table.global_secondary_indexes[0].index_name #=> String
resp.table.global_secondary_indexes[0].key_schema #=> Array
resp.table.global_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.table.global_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table.global_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.table.global_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.table.global_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.table.global_secondary_indexes[0].index_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.table.global_secondary_indexes[0].backfilling #=> Boolean
resp.table.global_secondary_indexes[0].provisioned_throughput.last_increase_date_time #=> Time
resp.table.global_secondary_indexes[0].provisioned_throughput.last_decrease_date_time #=> Time
resp.table.global_secondary_indexes[0].provisioned_throughput.number_of_decreases_today #=> Integer
resp.table.global_secondary_indexes[0].provisioned_throughput.read_capacity_units #=> Integer
resp.table.global_secondary_indexes[0].provisioned_throughput.write_capacity_units #=> Integer
resp.table.global_secondary_indexes[0].index_size_bytes #=> Integer
resp.table.global_secondary_indexes[0].item_count #=> Integer
resp.table.global_secondary_indexes[0].index_arn #=> String
resp.table.stream_specification.stream_enabled #=> Boolean
resp.table.stream_specification.stream_view_type #=> String, one of "NEW_IMAGE", "OLD_IMAGE", "NEW_AND_OLD_IMAGES", "KEYS_ONLY"
resp.table.latest_stream_label #=> String
resp.table.latest_stream_arn #=> String
resp.table.restore_summary.source_backup_arn #=> String
resp.table.restore_summary.source_table_arn #=> String
resp.table.restore_summary.restore_date_time #=> Time
resp.table.restore_summary.restore_in_progress #=> Boolean
resp.table.sse_description.status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED", "UPDATING"
resp.table.sse_description.sse_type #=> String, one of "AES256", "KMS"
resp.table.sse_description.kms_master_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_name (required, String) —

    The name of the table to describe.

Returns:

See Also:



2052
2053
2054
2055
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 2052

def describe_table(params = {}, options = {})
  req = build_request(:describe_table, params)
  req.send_request(options)
end

#describe_time_to_live(params = {}) ⇒ Types::DescribeTimeToLiveOutput

Gives a description of the Time to Live (TTL) status on the specified table.

Examples:

Request syntax with placeholder values


resp = client.describe_time_to_live({
  table_name: "TableName", # required
})

Response structure


resp.time_to_live_description.time_to_live_status #=> String, one of "ENABLING", "DISABLING", "ENABLED", "DISABLED"
resp.time_to_live_description.attribute_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_name (required, String) —

    The name of the table to be described.

Returns:

See Also:



2082
2083
2084
2085
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 2082

def describe_time_to_live(params = {}, options = {})
  req = build_request(:describe_time_to_live, params)
  req.send_request(options)
end

#get_item(params = {}) ⇒ Types::GetItemOutput

The ‘GetItem` operation returns a set of attributes for the item with the given primary key. If there is no matching item, `GetItem` does not return any data and there will be no `Item` element in the response.

‘GetItem` provides an eventually consistent read by default. If your application requires a strongly consistent read, set `ConsistentRead` to `true`. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.

Examples:

Request syntax with placeholder values


resp = client.get_item({
  table_name: "TableName", # required
  key: { # required
    "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  attributes_to_get: ["AttributeName"],
  consistent_read: false,
  return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
  projection_expression: "ProjectionExpression",
  expression_attribute_names: {
    "ExpressionAttributeNameVariable" => "AttributeName",
  },
})

Response structure


resp.item #=> Hash
resp.item["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.consumed_capacity.table_name #=> String
resp.consumed_capacity.capacity_units #=> Float
resp.consumed_capacity.read_capacity_units #=> Float
resp.consumed_capacity.write_capacity_units #=> Float
resp.consumed_capacity.table.read_capacity_units #=> Float
resp.consumed_capacity.table.write_capacity_units #=> Float
resp.consumed_capacity.table.capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes #=> Hash
resp.consumed_capacity.local_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes["IndexName"].capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes #=> Hash
resp.consumed_capacity.global_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes["IndexName"].capacity_units #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_name (required, String) —

    The name of the table containing the requested item.

  • :key (required, Hash<String,Types::AttributeValue>) —

    A map of attribute names to ‘AttributeValue` objects, representing the primary key of the item to retrieve.

    For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

  • :attributes_to_get (Array<String>) —

    This is a legacy parameter. Use ‘ProjectionExpression` instead. For more information, see [AttributesToGet] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html

  • :consistent_read (Boolean) —

    Determines the read consistency model: If set to ‘true`, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

  • :return_consumed_capacity (String) —

    Determines the level of detail about provisioned 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.

  • :projection_expression (String) —

    A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

    If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

    For more information, see [Accessing Item Attributes] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html

  • :expression_attribute_names (Hash<String,String>) —

    One or more substitution tokens for attribute names in an expression. The following are some use cases for using ‘ExpressionAttributeNames`:

    • To access an attribute whose name conflicts with a DynamoDB reserved word.

    • To create a placeholder for repeating occurrences of an attribute name in an expression.

    • To prevent special characters in an attribute name from being misinterpreted in an expression.

    Use the **#** character in an expression to dereference an attribute name. For example, consider the following attribute name:

    • ‘Percentile`

    ^

    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see [Reserved Words] in the *Amazon DynamoDB Developer Guide*). To work around this, you could specify the following for ‘ExpressionAttributeNames`:

    • ‘“#P”:“Percentile”`

    ^

    You could then use this substitution in an expression, as in this example:

    • ‘#P = :val`

    ^

    <note markdown=“1”> Tokens that begin with the : character are *expression attribute values*, which are placeholders for the actual value at runtime.

    </note>

    For more information on expression attribute names, see [Accessing Item Attributes] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html [2]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html

Returns:

See Also:



2254
2255
2256
2257
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 2254

def get_item(params = {}, options = {})
  req = build_request(:get_item, params)
  req.send_request(options)
end

#list_backups(params = {}) ⇒ Types::ListBackupsOutput

List backups associated with an AWS account. To list backups for a given table, specify ‘TableName`. `ListBackups` returns a paginated list of results with at most 1MB worth of items in a page. You can also specify a limit for the maximum number of entries to be returned in a page.

In the request, start time is inclusive but end time is exclusive. Note that these limits are for the time at which the original backup was requested.

You can call ‘ListBackups` a maximum of 5 times per second.

Examples:

Request syntax with placeholder values


resp = client.list_backups({
  table_name: "TableName",
  limit: 1,
  time_range_lower_bound: Time.now,
  time_range_upper_bound: Time.now,
  exclusive_start_backup_arn: "BackupArn",
  backup_type: "USER", # accepts USER, SYSTEM, AWS_BACKUP, ALL
})

Response structure


resp.backup_summaries #=> Array
resp.backup_summaries[0].table_name #=> String
resp.backup_summaries[0].table_id #=> String
resp.backup_summaries[0].table_arn #=> String
resp.backup_summaries[0].backup_arn #=> String
resp.backup_summaries[0].backup_name #=> String
resp.backup_summaries[0].backup_creation_date_time #=> Time
resp.backup_summaries[0].backup_expiry_date_time #=> Time
resp.backup_summaries[0].backup_status #=> String, one of "CREATING", "DELETED", "AVAILABLE"
resp.backup_summaries[0].backup_type #=> String, one of "USER", "SYSTEM", "AWS_BACKUP"
resp.backup_summaries[0].backup_size_bytes #=> Integer
resp.last_evaluated_backup_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_name (String) —

    The backups from the table specified by ‘TableName` are listed.

  • :limit (Integer) —

    Maximum number of backups to return at once.

  • :time_range_lower_bound (Time, DateTime, Date, Integer, String) —

    Only backups created after this time are listed. ‘TimeRangeLowerBound` is inclusive.

  • :time_range_upper_bound (Time, DateTime, Date, Integer, String) —

    Only backups created before this time are listed. ‘TimeRangeUpperBound` is exclusive.

  • :exclusive_start_backup_arn (String) —

    ‘LastEvaluatedBackupArn` is the ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the `ExclusiveStartBackupArn` of a new `ListBackups` operation in order to fetch the next page of results.

  • :backup_type (String) —

    The backups from the table specified by ‘BackupType` are listed.

    Where ‘BackupType` can be:

    • ‘USER` - On-demand backup created by you.

    • ‘SYSTEM` - On-demand backup automatically created by DynamoDB.

    • ‘ALL` - All types of on-demand backups (USER and SYSTEM).

Returns:

See Also:



2338
2339
2340
2341
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 2338

def list_backups(params = {}, options = {})
  req = build_request(:list_backups, params)
  req.send_request(options)
end

#list_global_tables(params = {}) ⇒ Types::ListGlobalTablesOutput

Lists all global tables that have a replica in the specified region.

Examples:

Request syntax with placeholder values


resp = client.list_global_tables({
  exclusive_start_global_table_name: "TableName",
  limit: 1,
  region_name: "RegionName",
})

Response structure


resp.global_tables #=> Array
resp.global_tables[0].global_table_name #=> String
resp.global_tables[0].replication_group #=> Array
resp.global_tables[0].replication_group[0].region_name #=> String
resp.last_evaluated_global_table_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :exclusive_start_global_table_name (String) —

    The first global table name that this operation will evaluate.

  • :limit (Integer) —

    The maximum number of table names to return.

  • :region_name (String) —

    Lists the global tables in a specific region.

Returns:

See Also:



2379
2380
2381
2382
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 2379

def list_global_tables(params = {}, options = {})
  req = build_request(:list_global_tables, params)
  req.send_request(options)
end

#list_tables(params = {}) ⇒ Types::ListTablesOutput

Returns an array of table names associated with the current account and endpoint. The output from ‘ListTables` is paginated, with each page returning a maximum of 100 table names.

Examples:

Request syntax with placeholder values


resp = client.list_tables({
  exclusive_start_table_name: "TableName",
  limit: 1,
})

Response structure


resp.table_names #=> Array
resp.table_names[0] #=> String
resp.last_evaluated_table_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :exclusive_start_table_name (String) —

    The first table name that this operation will evaluate. Use the value that was returned for ‘LastEvaluatedTableName` in a previous operation, so that you can obtain the next page of results.

  • :limit (Integer) —

    A maximum number of table names to return. If this parameter is not specified, the limit is 100.

Returns:

See Also:



2419
2420
2421
2422
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 2419

def list_tables(params = {}, options = {})
  req = build_request(:list_tables, params)
  req.send_request(options)
end

#list_tags_of_resource(params = {}) ⇒ Types::ListTagsOfResourceOutput

List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.

For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB] in the *Amazon DynamoDB Developer Guide*.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html

Examples:

Request syntax with placeholder values


resp = client.list_tags_of_resource({
  resource_arn: "ResourceArnString", # required
  next_token: "NextTokenString",
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

  • :next_token (String) —

    An optional string that, if supplied, must be copied from the output of a previous call to ListTagOfResource. When provided in this manner, this API fetches the next page of results.

Returns:

See Also:



2466
2467
2468
2469
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 2466

def list_tags_of_resource(params = {}, options = {})
  req = build_request(:list_tags_of_resource, params)
  req.send_request(options)
end

#put_item(params = {}) ⇒ Types::PutItemOutput

Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn’t exist), or replace an existing item if it has certain attribute values. You can return the item’s attribute values in the same operation, using the ‘ReturnValues` parameter.

This topic provides general information about the ‘PutItem` API.

For information on how to call the `PutItem` API using the AWS SDK in

specific languages, see the following:

* [ PutItem in the AWS Command Line Interface ][1]
  • PutItem in the AWS SDK for .NET ][2
  • PutItem in the AWS SDK for C++ ][3
  • PutItem in the AWS SDK for Go ][4
  • PutItem in the AWS SDK for Java ][5
  • PutItem in the AWS SDK for JavaScript ][6
  • PutItem in the AWS SDK for PHP V3 ][7
  • PutItem in the AWS SDK for Python ][8
  • PutItem in the AWS SDK for Ruby V2 ][9

When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a ‘ValidationException` exception.

<note markdown=“1”> To prevent a new item from replacing an existing item, use a conditional expression that contains the ‘attribute_not_exists` function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the `attribute_not_exists` function will only succeed if no matching item exists.

</note>

For more information about ‘PutItem`, see [Working with Items] in the *Amazon DynamoDB Developer Guide*.

[1]: docs.aws.amazon.com/goto/aws-cli/dynamodb-2012-08-10/PutItem [2]: docs.aws.amazon.com/goto/DotNetSDKV3/dynamodb-2012-08-10/PutItem [3]: docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/PutItem [4]: docs.aws.amazon.com/goto/SdkForGoV1/dynamodb-2012-08-10/PutItem [5]: docs.aws.amazon.com/goto/SdkForJava/dynamodb-2012-08-10/PutItem [6]: docs.aws.amazon.com/goto/AWSJavaScriptSDK/dynamodb-2012-08-10/PutItem [7]: docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/PutItem [8]: docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/PutItem [9]: docs.aws.amazon.com/goto/SdkForRubyV2/dynamodb-2012-08-10/PutItem [10]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html

Examples:

Request syntax with placeholder values


resp = client.put_item({
  table_name: "TableName", # required
  item: { # required
    "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  expected: {
    "AttributeName" => {
      value: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
      exists: false,
      comparison_operator: "EQ", # accepts EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
      attribute_value_list: ["value"], # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
    },
  },
  return_values: "NONE", # accepts NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
  return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
  return_item_collection_metrics: "SIZE", # accepts SIZE, NONE
  conditional_operator: "AND", # accepts AND, OR
  condition_expression: "ConditionExpression",
  expression_attribute_names: {
    "ExpressionAttributeNameVariable" => "AttributeName",
  },
  expression_attribute_values: {
    "ExpressionAttributeValueVariable" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
})

Response structure


resp.attributes #=> Hash
resp.attributes["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.consumed_capacity.table_name #=> String
resp.consumed_capacity.capacity_units #=> Float
resp.consumed_capacity.read_capacity_units #=> Float
resp.consumed_capacity.write_capacity_units #=> Float
resp.consumed_capacity.table.read_capacity_units #=> Float
resp.consumed_capacity.table.write_capacity_units #=> Float
resp.consumed_capacity.table.capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes #=> Hash
resp.consumed_capacity.local_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes["IndexName"].capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes #=> Hash
resp.consumed_capacity.global_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes["IndexName"].capacity_units #=> Float
resp.item_collection_metrics.item_collection_key #=> Hash
resp.item_collection_metrics.item_collection_key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.item_collection_metrics.size_estimate_range_gb #=> Array
resp.item_collection_metrics.size_estimate_range_gb[0] #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_name (required, String) —

    The name of the table to contain the item.

  • :item (required, Hash<String,Types::AttributeValue>) —

    A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

    You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

    If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table’s attribute definition.

    For more information about primary keys, see [Primary Key] in the *Amazon DynamoDB Developer Guide*.

    Each element in the ‘Item` map is an `AttributeValue` object.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey

  • :expected (Hash<String,Types::ExpectedAttributeValue>) —

    This is a legacy parameter. Use ‘ConditionExpression` instead. For more information, see [Expected] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html

  • :return_values (String) —

    Use ‘ReturnValues` if you want to get the item attributes as they appeared before they were updated with the `PutItem` request. For `PutItem`, the valid values are:

    • ‘NONE` - If `ReturnValues` is not specified, or if its value is `NONE`, then nothing is returned. (This setting is the default for `ReturnValues`.)

    • ‘ALL_OLD` - If `PutItem` overwrote an attribute name-value pair, then the content of the old item is returned.

    <note markdown=“1”> The ‘ReturnValues` parameter is used by several DynamoDB operations; however, `PutItem` does not recognize any values other than `NONE` or `ALL_OLD`.

    </note>
  • :return_consumed_capacity (String) —

    Determines the level of detail about provisioned 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.

  • :return_item_collection_metrics (String) —

    Determines whether item collection metrics are returned. If set to ‘SIZE`, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to `NONE` (the default), no statistics are returned.

  • :conditional_operator (String) —

    This is a legacy parameter. Use ‘ConditionExpression` instead. For more information, see [ConditionalOperator] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html

  • :condition_expression (String) —

    A condition that must be satisfied in order for a conditional ‘PutItem` operation to succeed.

    An expression can contain any of the following:

    • Functions: ‘attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size`

      These function names are case-sensitive.

    • Comparison operators: ‘= | <> | < | > | <= | >= | BETWEEN | IN `

    • Logical operators: ‘AND | OR | NOT`

    For more information on condition expressions, see [Specifying Conditions] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html

  • :expression_attribute_names (Hash<String,String>) —

    One or more substitution tokens for attribute names in an expression. The following are some use cases for using ‘ExpressionAttributeNames`:

    • To access an attribute whose name conflicts with a DynamoDB reserved word.

    • To create a placeholder for repeating occurrences of an attribute name in an expression.

    • To prevent special characters in an attribute name from being misinterpreted in an expression.

    Use the **#** character in an expression to dereference an attribute name. For example, consider the following attribute name:

    • ‘Percentile`

    ^

    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see [Reserved Words] in the *Amazon DynamoDB Developer Guide*). To work around this, you could specify the following for ‘ExpressionAttributeNames`:

    • ‘“#P”:“Percentile”`

    ^

    You could then use this substitution in an expression, as in this example:

    • ‘#P = :val`

    ^

    <note markdown=“1”> Tokens that begin with the : character are *expression attribute values*, which are placeholders for the actual value at runtime.

    </note>

    For more information on expression attribute names, see [Accessing Item Attributes] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html [2]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html

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

    One or more values that can be substituted in an expression.

    Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

    ‘Available | Backordered | Discontinued`

    You would first need to specify ‘ExpressionAttributeValues` as follows:

    ‘{ “:avail”:“S”:“Available”, “:back”:“S”:“Backordered”, “:disc”:“S”:“Discontinued” }`

    You could then use these values in an expression, such as this:

    ‘ProductStatus IN (:avail, :back, :disc)`

    For more information on expression attribute values, see [Specifying Conditions] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html

Returns:

See Also:



2780
2781
2782
2783
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 2780

def put_item(params = {}, options = {})
  req = build_request(:put_item, params)
  req.send_request(options)
end

#query(params = {}) ⇒ Types::QueryOutput

The ‘Query` operation finds items based on primary key values. You can query any table or secondary index that has a composite primary key (a partition key and a sort key).

Use the ‘KeyConditionExpression` parameter to provide a specific value for the partition key. The `Query` operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the `Query` operation by specifying a sort key value and a comparison operator in `KeyConditionExpression`. To further refine the `Query` results, you can optionally provide a `FilterExpression`. A `FilterExpression` determines which items within the results should be returned to you. All of the other results are discarded.

A ‘Query` operation always returns a result set. If no matching items are found, the result set will be empty. Queries that do not return results consume the minimum number of read capacity units for that type of read operation.

<note markdown=“1”> DynamoDB calculates the number of read capacity units consumed based on item size, not on the amount of data that is returned to an application. The number of capacity units consumed will be the same whether you request all of the attributes (the default behavior) or just some of them (using a projection expression). The number will also be the same whether or not you use a ‘FilterExpression`.

</note>

‘Query` results are always sorted by the sort key value. If the data type of the sort key is Number, the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes. By default, the sort order is ascending. To reverse the order, set the `ScanIndexForward` parameter to false.

A single ‘Query` operation will read up to the maximum number of items set (if using the `Limit` parameter) or a maximum of 1 MB of data and then apply any filtering to the results using `FilterExpression`. If `LastEvaluatedKey` is present in the response, you will need to paginate the result set. For more information, see [Paginating the Results] in the *Amazon DynamoDB Developer Guide*.

‘FilterExpression` is applied after a `Query` finishes, but before the results are returned. A `FilterExpression` cannot contain partition key or sort key attributes. You need to specify those attributes in the `KeyConditionExpression`.

<note markdown=“1”> A ‘Query` operation can return an empty result set and a `LastEvaluatedKey` if all the items read for the page of results are filtered out.

</note>

You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the ‘ConsistentRead` parameter to `true` and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify `ConsistentRead` when querying a global secondary index.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination

Examples:

Request syntax with placeholder values


resp = client.query({
  table_name: "TableName", # required
  index_name: "IndexName",
  select: "ALL_ATTRIBUTES", # accepts ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
  attributes_to_get: ["AttributeName"],
  limit: 1,
  consistent_read: false,
  key_conditions: {
    "AttributeName" => {
      attribute_value_list: ["value"], # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
      comparison_operator: "EQ", # required, accepts EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
    },
  },
  query_filter: {
    "AttributeName" => {
      attribute_value_list: ["value"], # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
      comparison_operator: "EQ", # required, accepts EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
    },
  },
  conditional_operator: "AND", # accepts AND, OR
  scan_index_forward: false,
  exclusive_start_key: {
    "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
  projection_expression: "ProjectionExpression",
  filter_expression: "ConditionExpression",
  key_condition_expression: "KeyExpression",
  expression_attribute_names: {
    "ExpressionAttributeNameVariable" => "AttributeName",
  },
  expression_attribute_values: {
    "ExpressionAttributeValueVariable" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
})

Response structure


resp.items #=> Array
resp.items[0] #=> Hash
resp.items[0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.count #=> Integer
resp.scanned_count #=> Integer
resp.last_evaluated_key #=> Hash
resp.last_evaluated_key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.consumed_capacity.table_name #=> String
resp.consumed_capacity.capacity_units #=> Float
resp.consumed_capacity.read_capacity_units #=> Float
resp.consumed_capacity.write_capacity_units #=> Float
resp.consumed_capacity.table.read_capacity_units #=> Float
resp.consumed_capacity.table.write_capacity_units #=> Float
resp.consumed_capacity.table.capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes #=> Hash
resp.consumed_capacity.local_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes["IndexName"].capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes #=> Hash
resp.consumed_capacity.global_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes["IndexName"].capacity_units #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_name (required, String) —

    The name of the table containing the requested items.

  • :index_name (String) —

    The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that if you use the ‘IndexName` parameter, you must also provide `TableName.`

  • :select (String) —

    The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

    • ‘ALL_ATTRIBUTES` - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

    • ‘ALL_PROJECTED_ATTRIBUTES` - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying `ALL_ATTRIBUTES`.

    • ‘COUNT` - Returns the number of matching items, rather than the matching items themselves.

    • ‘SPECIFIC_ATTRIBUTES` - Returns only the attributes listed in `AttributesToGet`. This return value is equivalent to specifying `AttributesToGet` without specifying any value for `Select`.

      If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

      If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

    If neither ‘Select` nor `AttributesToGet` are specified, DynamoDB defaults to `ALL_ATTRIBUTES` when accessing a table, and `ALL_PROJECTED_ATTRIBUTES` when accessing an index. You cannot use both `Select` and `AttributesToGet` together in a single request, unless the value for `Select` is `SPECIFIC_ATTRIBUTES`. (This usage is equivalent to specifying `AttributesToGet` without any value for `Select`.)

    <note markdown=“1”> If you use the ‘ProjectionExpression` parameter, then the value for `Select` can only be `SPECIFIC_ATTRIBUTES`. Any other value for `Select` will return an error.

    </note>
  • :attributes_to_get (Array<String>) —

    This is a legacy parameter. Use ‘ProjectionExpression` instead. For more information, see [AttributesToGet] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html

  • :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, and a key in ‘LastEvaluatedKey` to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set 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. For more information, see [Query and Scan] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html

  • :consistent_read (Boolean) —

    Determines the read consistency model: If set to ‘true`, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

    Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with ‘ConsistentRead` set to `true`, you will receive a `ValidationException`.

  • :key_conditions (Hash<String,Types::Condition>) —

    This is a legacy parameter. Use ‘KeyConditionExpression` instead. For more information, see [KeyConditions] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.KeyConditions.html

  • :query_filter (Hash<String,Types::Condition>) —

    This is a legacy parameter. Use ‘FilterExpression` instead. For more information, see [QueryFilter] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.QueryFilter.html

  • :conditional_operator (String) —

    This is a legacy parameter. Use ‘FilterExpression` instead. For more information, see [ConditionalOperator] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html

  • :scan_index_forward (Boolean) —

    Specifies the order for index traversal: If ‘true` (default), the traversal is performed in ascending order; if `false`, the traversal is performed in descending order.

    Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned.

    If ‘ScanIndexForward` is `true`, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If `ScanIndexForward` is `false`, DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.

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

    The primary key of the first item that this operation will evaluate. Use the value that was returned for ‘LastEvaluatedKey` in the previous operation.

    The data type for ‘ExclusiveStartKey` must be String, Number or Binary. No set data types are allowed.

  • :return_consumed_capacity (String) —

    Determines the level of detail about provisioned 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.

  • :projection_expression (String) —

    A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

    If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

    For more information, see [Accessing Item Attributes] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html

  • :filter_expression (String) —

    A string that contains conditions that DynamoDB applies after the ‘Query` operation, but before the data is returned to you. Items that do not satisfy the `FilterExpression` criteria are not returned.

    A ‘FilterExpression` does not allow key attributes. You cannot define a filter expression based on a partition key or a sort key.

    <note markdown=“1”> A ‘FilterExpression` is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

    </note>

    For more information, see [Filter Expressions] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#FilteringResults

  • :key_condition_expression (String) —

    The condition that specifies the key value(s) for items to be retrieved by the ‘Query` action.

    The condition must perform an equality test on a single partition key value.

    The condition can optionally perform one of several comparison tests on a single sort key value. This allows ‘Query` to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.

    The partition key equality test is required, and must be specified in the following format:

    ‘partitionKeyName` *=* `:partitionkeyval`

    If you also want to provide a condition for the sort key, it must be combined using ‘AND` with the condition for the sort key. Following is an example, using the **=** comparison operator for the sort key:

    ‘partitionKeyName` `=` `:partitionkeyval` `AND` `sortKeyName` `=` `:sortkeyval`

    Valid comparisons for the sort key condition are as follows:

    • ‘sortKeyName` `=` `:sortkeyval` - true if the sort key value is equal to `:sortkeyval`.

    • ‘sortKeyName` `<` `:sortkeyval` - true if the sort key value is less than `:sortkeyval`.

    • ‘sortKeyName` `<=` `:sortkeyval` - true if the sort key value is less than or equal to `:sortkeyval`.

    • ‘sortKeyName` `>` `:sortkeyval` - true if the sort key value is greater than `:sortkeyval`.

    • ‘sortKeyName` `>= ` `:sortkeyval` - true if the sort key value is greater than or equal to `:sortkeyval`.

    • ‘sortKeyName` `BETWEEN` `:sortkeyval1` `AND` `:sortkeyval2` - true if the sort key value is greater than or equal to `:sortkeyval1`, and less than or equal to `:sortkeyval2`.

    • ‘begins_with (` `sortKeyName`, `:sortkeyval` `)` - true if the sort key value begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note that the function name `begins_with` is case-sensitive.

    Use the ‘ExpressionAttributeValues` parameter to replace tokens such as `:partitionval` and `:sortval` with actual values at runtime.

    You can optionally use the ‘ExpressionAttributeNames` parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following `KeyConditionExpression` parameter causes an error because Size is a reserved word:

    • ‘Size = :myval`

    ^

    To work around this, define a placeholder (such a ‘#S`) to represent the attribute name Size. `KeyConditionExpression` then is as follows:

    • ‘#S = :myval`

    ^

    For a list of reserved words, see [Reserved Words] in the *Amazon DynamoDB Developer Guide*.

    For more information on ‘ExpressionAttributeNames` and `ExpressionAttributeValues`, see [Using Placeholders for Attribute Names and Values] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html [2]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html

  • :expression_attribute_names (Hash<String,String>) —

    One or more substitution tokens for attribute names in an expression. The following are some use cases for using ‘ExpressionAttributeNames`:

    • To access an attribute whose name conflicts with a DynamoDB reserved word.

    • To create a placeholder for repeating occurrences of an attribute name in an expression.

    • To prevent special characters in an attribute name from being misinterpreted in an expression.

    Use the **#** character in an expression to dereference an attribute name. For example, consider the following attribute name:

    • ‘Percentile`

    ^

    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see [Reserved Words] in the *Amazon DynamoDB Developer Guide*). To work around this, you could specify the following for ‘ExpressionAttributeNames`:

    • ‘“#P”:“Percentile”`

    ^

    You could then use this substitution in an expression, as in this example:

    • ‘#P = :val`

    ^

    <note markdown=“1”> Tokens that begin with the : character are *expression attribute values*, which are placeholders for the actual value at runtime.

    </note>

    For more information on expression attribute names, see [Accessing Item Attributes] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html [2]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html

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

    One or more values that can be substituted in an expression.

    Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

    ‘Available | Backordered | Discontinued`

    You would first need to specify ‘ExpressionAttributeValues` as follows:

    ‘{ “:avail”:“S”:“Available”, “:back”:“S”:“Backordered”, “:disc”:“S”:“Discontinued” }`

    You could then use these values in an expression, such as this:

    ‘ProductStatus IN (:avail, :back, :disc)`

    For more information on expression attribute values, see [Specifying Conditions] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html

Returns:

See Also:



3284
3285
3286
3287
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 3284

def query(params = {}, options = {})
  req = build_request(:query, params)
  req.send_request(options)
end

#restore_table_from_backup(params = {}) ⇒ Types::RestoreTableFromBackupOutput

Creates a new table from an existing backup. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

You can call ‘RestoreTableFromBackup` at a maximum rate of 10 times per second.

You must manually set up the following on the restored table:

  • Auto scaling policies

  • IAM policies

  • Cloudwatch metrics and alarms

  • Tags

  • Stream settings

  • Time to Live (TTL) settings

Examples:

Request syntax with placeholder values


resp = client.restore_table_from_backup({
  target_table_name: "TableName", # required
  backup_arn: "BackupArn", # required
})

Response structure


resp.table_description.attribute_definitions #=> Array
resp.table_description.attribute_definitions[0].attribute_name #=> String
resp.table_description.attribute_definitions[0].attribute_type #=> String, one of "S", "N", "B"
resp.table_description.table_name #=> String
resp.table_description.key_schema #=> Array
resp.table_description.key_schema[0].attribute_name #=> String
resp.table_description.key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table_description.table_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.table_description.creation_date_time #=> Time
resp.table_description.provisioned_throughput.last_increase_date_time #=> Time
resp.table_description.provisioned_throughput.last_decrease_date_time #=> Time
resp.table_description.provisioned_throughput.number_of_decreases_today #=> Integer
resp.table_description.provisioned_throughput.read_capacity_units #=> Integer
resp.table_description.provisioned_throughput.write_capacity_units #=> Integer
resp.table_description.table_size_bytes #=> Integer
resp.table_description.item_count #=> Integer
resp.table_description.table_arn #=> String
resp.table_description.table_id #=> String
resp.table_description.billing_mode_summary.billing_mode #=> String, one of "PROVISIONED", "PAY_PER_REQUEST"
resp.table_description.billing_mode_summary.last_update_to_pay_per_request_date_time #=> Time
resp.table_description.local_secondary_indexes #=> Array
resp.table_description.local_secondary_indexes[0].index_name #=> String
resp.table_description.local_secondary_indexes[0].key_schema #=> Array
resp.table_description.local_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.table_description.local_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table_description.local_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.table_description.local_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.table_description.local_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.table_description.local_secondary_indexes[0].index_size_bytes #=> Integer
resp.table_description.local_secondary_indexes[0].item_count #=> Integer
resp.table_description.local_secondary_indexes[0].index_arn #=> String
resp.table_description.global_secondary_indexes #=> Array
resp.table_description.global_secondary_indexes[0].index_name #=> String
resp.table_description.global_secondary_indexes[0].key_schema #=> Array
resp.table_description.global_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.table_description.global_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table_description.global_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.table_description.global_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.table_description.global_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.table_description.global_secondary_indexes[0].index_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.table_description.global_secondary_indexes[0].backfilling #=> Boolean
resp.table_description.global_secondary_indexes[0].provisioned_throughput.last_increase_date_time #=> Time
resp.table_description.global_secondary_indexes[0].provisioned_throughput.last_decrease_date_time #=> Time
resp.table_description.global_secondary_indexes[0].provisioned_throughput.number_of_decreases_today #=> Integer
resp.table_description.global_secondary_indexes[0].provisioned_throughput.read_capacity_units #=> Integer
resp.table_description.global_secondary_indexes[0].provisioned_throughput.write_capacity_units #=> Integer
resp.table_description.global_secondary_indexes[0].index_size_bytes #=> Integer
resp.table_description.global_secondary_indexes[0].item_count #=> Integer
resp.table_description.global_secondary_indexes[0].index_arn #=> String
resp.table_description.stream_specification.stream_enabled #=> Boolean
resp.table_description.stream_specification.stream_view_type #=> String, one of "NEW_IMAGE", "OLD_IMAGE", "NEW_AND_OLD_IMAGES", "KEYS_ONLY"
resp.table_description.latest_stream_label #=> String
resp.table_description.latest_stream_arn #=> String
resp.table_description.restore_summary.source_backup_arn #=> String
resp.table_description.restore_summary.source_table_arn #=> String
resp.table_description.restore_summary.restore_date_time #=> Time
resp.table_description.restore_summary.restore_in_progress #=> Boolean
resp.table_description.sse_description.status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED", "UPDATING"
resp.table_description.sse_description.sse_type #=> String, one of "AES256", "KMS"
resp.table_description.sse_description.kms_master_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :target_table_name (required, String) —

    The name of the new table to which the backup must be restored.

  • :backup_arn (required, String) —

    The ARN associated with the backup.

Returns:

See Also:



3394
3395
3396
3397
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 3394

def restore_table_from_backup(params = {}, options = {})
  req = build_request(:restore_table_from_backup, params)
  req.send_request(options)
end

#restore_table_to_point_in_time(params = {}) ⇒ Types::RestoreTableToPointInTimeOutput

Restores the specified table to the specified point in time within ‘EarliestRestorableDateTime` and `LatestRestorableDateTime`. You can restore your table to any point in time during the last 35 days. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

When you restore using point in time recovery, DynamoDB restores your table data to the state based on the selected date and time (day:hour:minute:second) to a new table.

Along with data, the following are also included on the new restored table using point in time recovery:

  • Global secondary indexes (GSIs)

  • Local secondary indexes (LSIs)

  • Provisioned read and write capacity

  • Encryption settings

    All these settings come from the current settings of the source table at the time of restore.

You must manually set up the following on the restored table:

  • Auto scaling policies

  • IAM policies

  • Cloudwatch metrics and alarms

  • Tags

  • Stream settings

  • Time to Live (TTL) settings

  • Point in time recovery settings

Examples:

Request syntax with placeholder values


resp = client.restore_table_to_point_in_time({
  source_table_name: "TableName", # required
  target_table_name: "TableName", # required
  use_latest_restorable_time: false,
  restore_date_time: Time.now,
})

Response structure


resp.table_description.attribute_definitions #=> Array
resp.table_description.attribute_definitions[0].attribute_name #=> String
resp.table_description.attribute_definitions[0].attribute_type #=> String, one of "S", "N", "B"
resp.table_description.table_name #=> String
resp.table_description.key_schema #=> Array
resp.table_description.key_schema[0].attribute_name #=> String
resp.table_description.key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table_description.table_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.table_description.creation_date_time #=> Time
resp.table_description.provisioned_throughput.last_increase_date_time #=> Time
resp.table_description.provisioned_throughput.last_decrease_date_time #=> Time
resp.table_description.provisioned_throughput.number_of_decreases_today #=> Integer
resp.table_description.provisioned_throughput.read_capacity_units #=> Integer
resp.table_description.provisioned_throughput.write_capacity_units #=> Integer
resp.table_description.table_size_bytes #=> Integer
resp.table_description.item_count #=> Integer
resp.table_description.table_arn #=> String
resp.table_description.table_id #=> String
resp.table_description.billing_mode_summary.billing_mode #=> String, one of "PROVISIONED", "PAY_PER_REQUEST"
resp.table_description.billing_mode_summary.last_update_to_pay_per_request_date_time #=> Time
resp.table_description.local_secondary_indexes #=> Array
resp.table_description.local_secondary_indexes[0].index_name #=> String
resp.table_description.local_secondary_indexes[0].key_schema #=> Array
resp.table_description.local_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.table_description.local_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table_description.local_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.table_description.local_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.table_description.local_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.table_description.local_secondary_indexes[0].index_size_bytes #=> Integer
resp.table_description.local_secondary_indexes[0].item_count #=> Integer
resp.table_description.local_secondary_indexes[0].index_arn #=> String
resp.table_description.global_secondary_indexes #=> Array
resp.table_description.global_secondary_indexes[0].index_name #=> String
resp.table_description.global_secondary_indexes[0].key_schema #=> Array
resp.table_description.global_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.table_description.global_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table_description.global_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.table_description.global_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.table_description.global_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.table_description.global_secondary_indexes[0].index_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.table_description.global_secondary_indexes[0].backfilling #=> Boolean
resp.table_description.global_secondary_indexes[0].provisioned_throughput.last_increase_date_time #=> Time
resp.table_description.global_secondary_indexes[0].provisioned_throughput.last_decrease_date_time #=> Time
resp.table_description.global_secondary_indexes[0].provisioned_throughput.number_of_decreases_today #=> Integer
resp.table_description.global_secondary_indexes[0].provisioned_throughput.read_capacity_units #=> Integer
resp.table_description.global_secondary_indexes[0].provisioned_throughput.write_capacity_units #=> Integer
resp.table_description.global_secondary_indexes[0].index_size_bytes #=> Integer
resp.table_description.global_secondary_indexes[0].item_count #=> Integer
resp.table_description.global_secondary_indexes[0].index_arn #=> String
resp.table_description.stream_specification.stream_enabled #=> Boolean
resp.table_description.stream_specification.stream_view_type #=> String, one of "NEW_IMAGE", "OLD_IMAGE", "NEW_AND_OLD_IMAGES", "KEYS_ONLY"
resp.table_description.latest_stream_label #=> String
resp.table_description.latest_stream_arn #=> String
resp.table_description.restore_summary.source_backup_arn #=> String
resp.table_description.restore_summary.source_table_arn #=> String
resp.table_description.restore_summary.restore_date_time #=> Time
resp.table_description.restore_summary.restore_in_progress #=> Boolean
resp.table_description.sse_description.status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED", "UPDATING"
resp.table_description.sse_description.sse_type #=> String, one of "AES256", "KMS"
resp.table_description.sse_description.kms_master_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_table_name (required, String) —

    Name of the source table that is being restored.

  • :target_table_name (required, String) —

    The name of the new table to which it must be restored to.

  • :use_latest_restorable_time (Boolean) —

    Restore the table to the latest possible time. ‘LatestRestorableDateTime` is typically 5 minutes before the current time.

  • :restore_date_time (Time, DateTime, Date, Integer, String) —

    Time in the past to restore the table to.

Returns:

See Also:



3533
3534
3535
3536
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 3533

def restore_table_to_point_in_time(params = {}, options = {})
  req = build_request(:restore_table_to_point_in_time, params)
  req.send_request(options)
end

#scan(params = {}) ⇒ Types::ScanOutput

The ‘Scan` operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a `FilterExpression` operation.

If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a ‘LastEvaluatedKey` value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.

A single ‘Scan` operation will read up to the maximum number of items set (if using the `Limit` parameter) or a maximum of 1 MB of data and then apply any filtering to the results using `FilterExpression`. If `LastEvaluatedKey` is present in the response, you will need to paginate the result set. For more information, see [Paginating the Results] in the *Amazon DynamoDB Developer Guide*.

‘Scan` operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel `Scan` operation by providing the `Segment` and `TotalSegments` parameters. For more information, see [Parallel Scan] in the *Amazon DynamoDB Developer Guide*.

‘Scan` uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the `Scan` begins, you can set the `ConsistentRead` parameter to `true`.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination [2]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan

Examples:

Request syntax with placeholder values


resp = client.scan({
  table_name: "TableName", # required
  index_name: "IndexName",
  attributes_to_get: ["AttributeName"],
  limit: 1,
  select: "ALL_ATTRIBUTES", # accepts ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
  scan_filter: {
    "AttributeName" => {
      attribute_value_list: ["value"], # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
      comparison_operator: "EQ", # required, accepts EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
    },
  },
  conditional_operator: "AND", # accepts AND, OR
  exclusive_start_key: {
    "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
  total_segments: 1,
  segment: 1,
  projection_expression: "ProjectionExpression",
  filter_expression: "ConditionExpression",
  expression_attribute_names: {
    "ExpressionAttributeNameVariable" => "AttributeName",
  },
  expression_attribute_values: {
    "ExpressionAttributeValueVariable" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  consistent_read: false,
})

Response structure


resp.items #=> Array
resp.items[0] #=> Hash
resp.items[0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.count #=> Integer
resp.scanned_count #=> Integer
resp.last_evaluated_key #=> Hash
resp.last_evaluated_key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.consumed_capacity.table_name #=> String
resp.consumed_capacity.capacity_units #=> Float
resp.consumed_capacity.read_capacity_units #=> Float
resp.consumed_capacity.write_capacity_units #=> Float
resp.consumed_capacity.table.read_capacity_units #=> Float
resp.consumed_capacity.table.write_capacity_units #=> Float
resp.consumed_capacity.table.capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes #=> Hash
resp.consumed_capacity.local_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes["IndexName"].capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes #=> Hash
resp.consumed_capacity.global_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes["IndexName"].capacity_units #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_name (required, String) —

    The name of the table containing the requested items; or, if you provide ‘IndexName`, the name of the table to which that index belongs.

  • :index_name (String) —

    The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the ‘IndexName` parameter, you must also provide `TableName`.

  • :attributes_to_get (Array<String>) —

    This is a legacy parameter. Use ‘ProjectionExpression` instead. For more information, see [AttributesToGet] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html

  • :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, and a key in ‘LastEvaluatedKey` to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set 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. For more information, see [Query and Scan] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html

  • :select (String) —

    The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

    • ‘ALL_ATTRIBUTES` - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

    • ‘ALL_PROJECTED_ATTRIBUTES` - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying `ALL_ATTRIBUTES`.

    • ‘COUNT` - Returns the number of matching items, rather than the matching items themselves.

    • ‘SPECIFIC_ATTRIBUTES` - Returns only the attributes listed in `AttributesToGet`. This return value is equivalent to specifying `AttributesToGet` without specifying any value for `Select`.

      If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

      If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

    If neither ‘Select` nor `AttributesToGet` are specified, DynamoDB defaults to `ALL_ATTRIBUTES` when accessing a table, and `ALL_PROJECTED_ATTRIBUTES` when accessing an index. You cannot use both `Select` and `AttributesToGet` together in a single request, unless the value for `Select` is `SPECIFIC_ATTRIBUTES`. (This usage is equivalent to specifying `AttributesToGet` without any value for `Select`.)

    <note markdown=“1”> If you use the ‘ProjectionExpression` parameter, then the value for `Select` can only be `SPECIFIC_ATTRIBUTES`. Any other value for `Select` will return an error.

    </note>
  • :scan_filter (Hash<String,Types::Condition>) —

    This is a legacy parameter. Use ‘FilterExpression` instead. For more information, see [ScanFilter] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html

  • :conditional_operator (String) —

    This is a legacy parameter. Use ‘FilterExpression` instead. For more information, see [ConditionalOperator] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html

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

    The primary key of the first item that this operation will evaluate. Use the value that was returned for ‘LastEvaluatedKey` in the previous operation.

    The data type for ‘ExclusiveStartKey` must be String, Number or Binary. No set data types are allowed.

    In a parallel scan, a ‘Scan` request that includes `ExclusiveStartKey` must specify the same segment whose previous `Scan` returned the corresponding value of `LastEvaluatedKey`.

  • :return_consumed_capacity (String) —

    Determines the level of detail about provisioned 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.

  • :total_segments (Integer) —

    For a parallel ‘Scan` request, `TotalSegments` represents the total number of segments into which the `Scan` operation will be divided. The value of `TotalSegments` corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a `TotalSegments` value of 4.

    The value for ‘TotalSegments` must be greater than or equal to 1, and less than or equal to 1000000. If you specify a `TotalSegments` value of 1, the `Scan` operation will be sequential rather than parallel.

    If you specify ‘TotalSegments`, you must also specify `Segment`.

  • :segment (Integer) —

    For a parallel ‘Scan` request, `Segment` identifies an individual segment to be scanned by an application worker.

    Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a ‘Segment` value of 0, the second thread specifies 1, and so on.

    The value of ‘LastEvaluatedKey` returned from a parallel `Scan` request must be used as `ExclusiveStartKey` with the same segment ID in a subsequent `Scan` operation.

    The value for ‘Segment` must be greater than or equal to 0, and less than the value provided for `TotalSegments`.

    If you provide ‘Segment`, you must also provide `TotalSegments`.

  • :projection_expression (String) —

    A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

    If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

    For more information, see [Accessing Item Attributes] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html

  • :filter_expression (String) —

    A string that contains conditions that DynamoDB applies after the ‘Scan` operation, but before the data is returned to you. Items that do not satisfy the `FilterExpression` criteria are not returned.

    <note markdown=“1”> A ‘FilterExpression` is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

    </note>

    For more information, see [Filter Expressions] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#FilteringResults

  • :expression_attribute_names (Hash<String,String>) —

    One or more substitution tokens for attribute names in an expression. The following are some use cases for using ‘ExpressionAttributeNames`:

    • To access an attribute whose name conflicts with a DynamoDB reserved word.

    • To create a placeholder for repeating occurrences of an attribute name in an expression.

    • To prevent special characters in an attribute name from being misinterpreted in an expression.

    Use the **#** character in an expression to dereference an attribute name. For example, consider the following attribute name:

    • ‘Percentile`

    ^

    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see [Reserved Words] in the *Amazon DynamoDB Developer Guide*). To work around this, you could specify the following for ‘ExpressionAttributeNames`:

    • ‘“#P”:“Percentile”`

    ^

    You could then use this substitution in an expression, as in this example:

    • ‘#P = :val`

    ^

    <note markdown=“1”> Tokens that begin with the : character are *expression attribute values*, which are placeholders for the actual value at runtime.

    </note>

    For more information on expression attribute names, see [Accessing Item Attributes] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html [2]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html

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

    One or more values that can be substituted in an expression.

    Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

    ‘Available | Backordered | Discontinued`

    You would first need to specify ‘ExpressionAttributeValues` as follows:

    ‘{ “:avail”:“S”:“Available”, “:back”:“S”:“Backordered”, “:disc”:“S”:“Discontinued” }`

    You could then use these values in an expression, such as this:

    ‘ProductStatus IN (:avail, :back, :disc)`

    For more information on expression attribute values, see [Specifying Conditions] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html

  • :consistent_read (Boolean) —

    A Boolean value that determines the read consistency model during the scan:

    • If ‘ConsistentRead` is `false`, then the data returned from `Scan` might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem).

    • If ‘ConsistentRead` is `true`, then all of the write operations that completed before the `Scan` began are guaranteed to be contained in the `Scan` response.

    The default setting for ‘ConsistentRead` is `false`.

    The ‘ConsistentRead` parameter is not supported on global secondary indexes. If you scan a global secondary index with `ConsistentRead` set to true, you will receive a `ValidationException`.

Returns:

See Also:



3936
3937
3938
3939
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 3936

def scan(params = {}, options = {})
  req = build_request(:scan, params)
  req.send_request(options)
end

#stub_data(operation_name, data = {}) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
 
# File 'lib/aws-sdk-dynamodb/customizations/client.rb', line 5

def stub_data(operation_name, data = {})
  if config.simple_attributes
    rules = config.api.operation(operation_name).output
    translator = Plugins::SimpleAttributes::ValueTranslator
    data = translator.apply(rules, :marshal, data)
    data = super(operation_name, data)
    translator.apply(rules, :unmarshal, data)
  else
    super
  end
end

#tag_resource(params = {}) ⇒ Struct

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to 5 times per second, per account.

For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB] in the *Amazon DynamoDB Developer Guide*.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArnString", # required
  tags: [ # required
    {
      key: "TagKeyString", # required
      value: "TagValueString", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN).

  • :tags (required, Array<Types::Tag>) —

    The tags to be assigned to the Amazon DynamoDB resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3978
3979
3980
3981
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 3978

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#transact_get_items(params = {}) ⇒ Types::TransactGetItemsOutput

‘TransactGetItems` is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and region. A `TransactGetItems` call can contain up to 10 `TransactGetItem` objects, each of which contains a `Get` structure that specifies an item to retrieve from a table in the account and region. A call to `TransactGetItems` cannot retrieve items from tables in more than one AWS account or region.

DynamoDB rejects the entire ‘TransactGetItems` request if any of the following is true:

  • A conflicting operation is in the process of updating an item to be read.

  • There is insufficient provisioned capacity for the transaction to be completed.

  • There is a user error, such as an invalid data format.

Examples:

Request syntax with placeholder values


resp = client.transact_get_items({
  transact_items: [ # required
    {
      get: { # required
        key: { # required
          "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
        },
        table_name: "TableName", # required
        projection_expression: "ProjectionExpression",
        expression_attribute_names: {
          "ExpressionAttributeNameVariable" => "AttributeName",
        },
      },
    },
  ],
  return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
})

Response structure


resp.consumed_capacity #=> Array
resp.consumed_capacity[0].table_name #=> String
resp.consumed_capacity[0].capacity_units #=> Float
resp.consumed_capacity[0].read_capacity_units #=> Float
resp.consumed_capacity[0].write_capacity_units #=> Float
resp.consumed_capacity[0].table.read_capacity_units #=> Float
resp.consumed_capacity[0].table.write_capacity_units #=> Float
resp.consumed_capacity[0].table.capacity_units #=> Float
resp.consumed_capacity[0].local_secondary_indexes #=> Hash
resp.consumed_capacity[0].local_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity[0].local_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity[0].local_secondary_indexes["IndexName"].capacity_units #=> Float
resp.consumed_capacity[0].global_secondary_indexes #=> Hash
resp.consumed_capacity[0].global_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity[0].global_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity[0].global_secondary_indexes["IndexName"].capacity_units #=> Float
resp.responses #=> Array
resp.responses[0].item #=> Hash
resp.responses[0].item["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transact_items (required, Array<Types::TransactGetItem>) —

    An ordered array of up to 10 ‘TransactGetItem` objects, each of which contains a `Get` structure.

  • :return_consumed_capacity (String) —

    A value of ‘TOTAL` causes consumed capacity information to be returned, and a value of `NONE` prevents that information from being returned. No other value is valid.

Returns:

See Also:



4062
4063
4064
4065
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 4062

def transact_get_items(params = {}, options = {})
  req = build_request(:transact_get_items, params)
  req.send_request(options)
end

#transact_write_items(params = {}) ⇒ Types::TransactWriteItemsOutput

‘TransactWriteItems` is a synchronous write operation that groups up to 10 action requests. These actions can target items in different tables, but not in different AWS accounts or regions, and no two actions can target the same item. For example, you cannot both `ConditionCheck` and `Update` the same item.

The actions are completed atomically so that either all of them succeed, or all of them fail. They are defined by the following objects:

  • ‘Put`  —   Initiates a `PutItem` operation to write a new item. This structure specifies the primary key of the item to be written, the name of the table to write it in, an optional condition expression that must be satisfied for the write to succeed, a list of the item’s attributes, and a field indicating whether or not to retrieve the item’s attributes if the condition is not met.

  • ‘Update`  —   Initiates an `UpdateItem` operation to update an existing item. This structure specifies the primary key of the item to be updated, the name of the table where it resides, an optional condition expression that must be satisfied for the update to succeed, an expression that defines one or more attributes to be updated, and a field indicating whether or not to retrieve the item’s attributes if the condition is not met.

  • ‘Delete`  —   Initiates a `DeleteItem` operation to delete an existing item. This structure specifies the primary key of the item to be deleted, the name of the table where it resides, an optional condition expression that must be satisfied for the deletion to succeed, and a field indicating whether or not to retrieve the item’s attributes if the condition is not met.

  • ‘ConditionCheck`  —   Applies a condition to an item that is not being modified by the transaction. This structure specifies the primary key of the item to be checked, the name of the table where it resides, a condition expression that must be satisfied for the transaction to succeed, and a field indicating whether or not to retrieve the item’s attributes if the condition is not met.

DynamoDB rejects the entire ‘TransactWriteItems` request if any of the following is true:

  • A condition in one of the condition expressions is not met.

  • A conflicting operation is in the process of updating the same item.

  • There is insufficient provisioned capacity for the transaction to be completed.

  • An item size becomes too large (bigger than 400 KB), a Local Secondary Index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.

  • There is a user error, such as an invalid data format.

Examples:

Request syntax with placeholder values


resp = client.transact_write_items({
  transact_items: [ # required
    {
      condition_check: {
        key: { # required
          "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
        },
        table_name: "TableName", # required
        condition_expression: "ConditionExpression", # required
        expression_attribute_names: {
          "ExpressionAttributeNameVariable" => "AttributeName",
        },
        expression_attribute_values: {
          "ExpressionAttributeValueVariable" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
        },
        return_values_on_condition_check_failure: "ALL_OLD", # accepts ALL_OLD, NONE
      },
      put: {
        item: { # required
          "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
        },
        table_name: "TableName", # required
        condition_expression: "ConditionExpression",
        expression_attribute_names: {
          "ExpressionAttributeNameVariable" => "AttributeName",
        },
        expression_attribute_values: {
          "ExpressionAttributeValueVariable" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
        },
        return_values_on_condition_check_failure: "ALL_OLD", # accepts ALL_OLD, NONE
      },
      delete: {
        key: { # required
          "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
        },
        table_name: "TableName", # required
        condition_expression: "ConditionExpression",
        expression_attribute_names: {
          "ExpressionAttributeNameVariable" => "AttributeName",
        },
        expression_attribute_values: {
          "ExpressionAttributeValueVariable" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
        },
        return_values_on_condition_check_failure: "ALL_OLD", # accepts ALL_OLD, NONE
      },
      update: {
        key: { # required
          "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
        },
        update_expression: "UpdateExpression", # required
        table_name: "TableName", # required
        condition_expression: "ConditionExpression",
        expression_attribute_names: {
          "ExpressionAttributeNameVariable" => "AttributeName",
        },
        expression_attribute_values: {
          "ExpressionAttributeValueVariable" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
        },
        return_values_on_condition_check_failure: "ALL_OLD", # accepts ALL_OLD, NONE
      },
    },
  ],
  return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
  return_item_collection_metrics: "SIZE", # accepts SIZE, NONE
  client_request_token: "ClientRequestToken",
})

Response structure


resp.consumed_capacity #=> Array
resp.consumed_capacity[0].table_name #=> String
resp.consumed_capacity[0].capacity_units #=> Float
resp.consumed_capacity[0].read_capacity_units #=> Float
resp.consumed_capacity[0].write_capacity_units #=> Float
resp.consumed_capacity[0].table.read_capacity_units #=> Float
resp.consumed_capacity[0].table.write_capacity_units #=> Float
resp.consumed_capacity[0].table.capacity_units #=> Float
resp.consumed_capacity[0].local_secondary_indexes #=> Hash
resp.consumed_capacity[0].local_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity[0].local_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity[0].local_secondary_indexes["IndexName"].capacity_units #=> Float
resp.consumed_capacity[0].global_secondary_indexes #=> Hash
resp.consumed_capacity[0].global_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity[0].global_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity[0].global_secondary_indexes["IndexName"].capacity_units #=> Float
resp.item_collection_metrics #=> Hash
resp.item_collection_metrics["TableName"] #=> Array
resp.item_collection_metrics["TableName"][0].item_collection_key #=> Hash
resp.item_collection_metrics["TableName"][0].item_collection_key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.item_collection_metrics["TableName"][0].size_estimate_range_gb #=> Array
resp.item_collection_metrics["TableName"][0].size_estimate_range_gb[0] #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transact_items (required, Array<Types::TransactWriteItem>) —

    An ordered array of up to 10 ‘TransactWriteItem` objects, each of which contains a `ConditionCheck`, `Put`, `Update`, or `Delete` object. These can operate on items in different tables, but the tables must reside in the same AWS account and region, and no two of them can operate on the same item.

  • :return_consumed_capacity (String) —

    Determines the level of detail about provisioned 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.

  • :return_item_collection_metrics (String) —

    Determines whether item collection metrics are returned. If set to ‘SIZE`, the response includes statistics about item collections (if any), that were modified during the operation and are returned in the response. If set to `NONE` (the default), no statistics are returned.

  • :client_request_token (String) —

    Providing a ‘ClientRequestToken` makes the call to `TransactWriteItems` idempotent, meaning that multiple identical calls have the same effect as one single call.

    Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls may not be the same. If the ‘ReturnConsumedCapacity>` parameter is set, then the initial `TransactWriteItems` call returns the amount of write capacity units consumed in making the changes, and subsequent `TransactWriteItems` calls with the same client token return the amount of read capacity units consumed in reading the item.

    A client request token is valid for 10 minutes after the first request that uses it completes. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes or the result may not be idempotent.

    If you submit a request with the same client token but a change in other parameters within the 10 minute idempotency window, DynamoDB returns an ‘IdempotentParameterMismatch` exception.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

See Also:



4281
4282
4283
4284
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 4281

def transact_write_items(params = {}, options = {})
  req = build_request(:transact_write_items, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to 5 times per second, per account.

For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB] in the *Amazon DynamoDB Developer Guide*.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArnString", # required
  tag_keys: ["TagKeyString"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon DyanamoDB resource the tags will be removed from. This value is an Amazon Resource Name (ARN).

  • :tag_keys (required, Array<String>) —

    A list of tag keys. Existing tags of the resource whose keys are members of this list will be removed from the Amazon DynamoDB resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4318
4319
4320
4321
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 4318

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_continuous_backups(params = {}) ⇒ Types::UpdateContinuousBackupsOutput

‘UpdateContinuousBackups` enables or disables point in time recovery for the specified table. A successful `UpdateContinuousBackups` call returns the current `ContinuousBackupsDescription`. Continuous backups are `ENABLED` on all tables at table creation. If point in time recovery is enabled, `PointInTimeRecoveryStatus` will be set to ENABLED.

Once continuous backups and point in time recovery are enabled, you can restore to any point in time within ‘EarliestRestorableDateTime` and `LatestRestorableDateTime`.

‘LatestRestorableDateTime` is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days..

Examples:

Request syntax with placeholder values


resp = client.update_continuous_backups({
  table_name: "TableName", # required
  point_in_time_recovery_specification: { # required
    point_in_time_recovery_enabled: false, # required
  },
})

Response structure


resp.continuous_backups_description.continuous_backups_status #=> String, one of "ENABLED", "DISABLED"
resp.continuous_backups_description.point_in_time_recovery_description.point_in_time_recovery_status #=> String, one of "ENABLED", "DISABLED"
resp.continuous_backups_description.point_in_time_recovery_description.earliest_restorable_date_time #=> Time
resp.continuous_backups_description.point_in_time_recovery_description.latest_restorable_date_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_name (required, String) —

    The name of the table.

  • :point_in_time_recovery_specification (required, Types::PointInTimeRecoverySpecification) —

    Represents the settings used to enable point in time recovery.

Returns:

See Also:



4368
4369
4370
4371
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 4368

def update_continuous_backups(params = {}, options = {})
  req = build_request(:update_continuous_backups, params)
  req.send_request(options)
end

#update_global_table(params = {}) ⇒ Types::UpdateGlobalTableOutput

Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, must have the same name as the global table, must have the same key schema, and must have DynamoDB Streams enabled and must have same provisioned and maximum write capacity units.

<note markdown=“1”> Although you can use ‘UpdateGlobalTable` to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.

</note>

If global secondary indexes are specified, then the following conditions must also be met:

  • The global secondary indexes must have the same name.

  • The global secondary indexes must have the same hash key and sort key (if present).

  • The global secondary indexes must have the same provisioned and maximum write capacity units.

Examples:

Request syntax with placeholder values


resp = client.update_global_table({
  global_table_name: "TableName", # required
  replica_updates: [ # required
    {
      create: {
        region_name: "RegionName", # required
      },
      delete: {
        region_name: "RegionName", # required
      },
    },
  ],
})

Response structure


resp.global_table_description.replication_group #=> Array
resp.global_table_description.replication_group[0].region_name #=> String
resp.global_table_description.global_table_arn #=> String
resp.global_table_description.creation_date_time #=> Time
resp.global_table_description.global_table_status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING"
resp.global_table_description.global_table_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :global_table_name (required, String) —

    The global table name.

  • :replica_updates (required, Array<Types::ReplicaUpdate>) —

    A list of regions that should be added or removed from the global table.

Returns:

See Also:



4437
4438
4439
4440
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 4437

def update_global_table(params = {}, options = {})
  req = build_request(:update_global_table, params)
  req.send_request(options)
end

#update_global_table_settings(params = {}) ⇒ Types::UpdateGlobalTableSettingsOutput

Updates settings for a global table.

Examples:

Request syntax with placeholder values


resp = client.update_global_table_settings({
  global_table_name: "TableName", # required
  global_table_billing_mode: "PROVISIONED", # accepts PROVISIONED, PAY_PER_REQUEST
  global_table_provisioned_write_capacity_units: 1,
  global_table_provisioned_write_capacity_auto_scaling_settings_update: {
    minimum_units: 1,
    maximum_units: 1,
    auto_scaling_disabled: false,
    auto_scaling_role_arn: "AutoScalingRoleArn",
    scaling_policy_update: {
      policy_name: "AutoScalingPolicyName",
      target_tracking_scaling_policy_configuration: { # required
        disable_scale_in: false,
        scale_in_cooldown: 1,
        scale_out_cooldown: 1,
        target_value: 1.0, # required
      },
    },
  },
  global_table_global_secondary_index_settings_update: [
    {
      index_name: "IndexName", # required
      provisioned_write_capacity_units: 1,
      provisioned_write_capacity_auto_scaling_settings_update: {
        minimum_units: 1,
        maximum_units: 1,
        auto_scaling_disabled: false,
        auto_scaling_role_arn: "AutoScalingRoleArn",
        scaling_policy_update: {
          policy_name: "AutoScalingPolicyName",
          target_tracking_scaling_policy_configuration: { # required
            disable_scale_in: false,
            scale_in_cooldown: 1,
            scale_out_cooldown: 1,
            target_value: 1.0, # required
          },
        },
      },
    },
  ],
  replica_settings_update: [
    {
      region_name: "RegionName", # required
      replica_provisioned_read_capacity_units: 1,
      replica_provisioned_read_capacity_auto_scaling_settings_update: {
        minimum_units: 1,
        maximum_units: 1,
        auto_scaling_disabled: false,
        auto_scaling_role_arn: "AutoScalingRoleArn",
        scaling_policy_update: {
          policy_name: "AutoScalingPolicyName",
          target_tracking_scaling_policy_configuration: { # required
            disable_scale_in: false,
            scale_in_cooldown: 1,
            scale_out_cooldown: 1,
            target_value: 1.0, # required
          },
        },
      },
      replica_global_secondary_index_settings_update: [
        {
          index_name: "IndexName", # required
          provisioned_read_capacity_units: 1,
          provisioned_read_capacity_auto_scaling_settings_update: {
            minimum_units: 1,
            maximum_units: 1,
            auto_scaling_disabled: false,
            auto_scaling_role_arn: "AutoScalingRoleArn",
            scaling_policy_update: {
              policy_name: "AutoScalingPolicyName",
              target_tracking_scaling_policy_configuration: { # required
                disable_scale_in: false,
                scale_in_cooldown: 1,
                scale_out_cooldown: 1,
                target_value: 1.0, # required
              },
            },
          },
        },
      ],
    },
  ],
})

Response structure


resp.global_table_name #=> String
resp.replica_settings #=> Array
resp.replica_settings[0].region_name #=> String
resp.replica_settings[0].replica_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.replica_settings[0].replica_billing_mode_summary.billing_mode #=> String, one of "PROVISIONED", "PAY_PER_REQUEST"
resp.replica_settings[0].replica_billing_mode_summary.last_update_to_pay_per_request_date_time #=> Time
resp.replica_settings[0].replica_provisioned_read_capacity_units #=> Integer
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.minimum_units #=> Integer
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.maximum_units #=> Integer
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.auto_scaling_disabled #=> Boolean
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.auto_scaling_role_arn #=> String
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies #=> Array
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].policy_name #=> String
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.disable_scale_in #=> Boolean
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_in_cooldown #=> Integer
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_out_cooldown #=> Integer
resp.replica_settings[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.target_value #=> Float
resp.replica_settings[0].replica_provisioned_write_capacity_units #=> Integer
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.minimum_units #=> Integer
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.maximum_units #=> Integer
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.auto_scaling_disabled #=> Boolean
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.auto_scaling_role_arn #=> String
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies #=> Array
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].policy_name #=> String
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.disable_scale_in #=> Boolean
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_in_cooldown #=> Integer
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_out_cooldown #=> Integer
resp.replica_settings[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.target_value #=> Float
resp.replica_settings[0].replica_global_secondary_index_settings #=> Array
resp.replica_settings[0].replica_global_secondary_index_settings[0].index_name #=> String
resp.replica_settings[0].replica_global_secondary_index_settings[0].index_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_units #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.minimum_units #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.maximum_units #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.auto_scaling_disabled #=> Boolean
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.auto_scaling_role_arn #=> String
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies #=> Array
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].policy_name #=> String
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.disable_scale_in #=> Boolean
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_in_cooldown #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_out_cooldown #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.target_value #=> Float
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_units #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.minimum_units #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.maximum_units #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.auto_scaling_disabled #=> Boolean
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.auto_scaling_role_arn #=> String
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies #=> Array
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].policy_name #=> String
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.disable_scale_in #=> Boolean
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_in_cooldown #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_out_cooldown #=> Integer
resp.replica_settings[0].replica_global_secondary_index_settings[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.target_value #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :global_table_name (required, String) —

    The name of the global table

  • :global_table_billing_mode (String) —

    The billing mode of the global table. If ‘GlobalTableBillingMode` is not specified, the global table defaults to `PROVISIONED` capacity billing mode.

  • :global_table_provisioned_write_capacity_units (Integer) —

    The maximum number of writes consumed per second before DynamoDB returns a ‘ThrottlingException.`

  • :global_table_provisioned_write_capacity_auto_scaling_settings_update (Types::AutoScalingSettingsUpdate) —

    AutoScaling settings for managing provisioned write capacity for the global table.

  • :global_table_global_secondary_index_settings_update (Array<Types::GlobalTableGlobalSecondaryIndexSettingsUpdate>) —

    Represents the settings of a global secondary index for a global table that will be modified.

  • :replica_settings_update (Array<Types::ReplicaSettingsUpdate>) —

    Represents the settings for a global table in a region that will be modified.

Returns:

See Also:



4619
4620
4621
4622
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 4619

def update_global_table_settings(params = {}, options = {})
  req = build_request(:update_global_table_settings, params)
  req.send_request(options)
end

#update_item(params = {}) ⇒ Types::UpdateItemOutput

Edits an existing item’s attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn’t exist, or replace an existing name-value pair if it has certain expected attribute values).

You can also return the item’s attribute values in the same ‘UpdateItem` operation using the `ReturnValues` parameter.

Examples:

Request syntax with placeholder values


resp = client.update_item({
  table_name: "TableName", # required
  key: { # required
    "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  attribute_updates: {
    "AttributeName" => {
      value: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
      action: "ADD", # accepts ADD, PUT, DELETE
    },
  },
  expected: {
    "AttributeName" => {
      value: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
      exists: false,
      comparison_operator: "EQ", # accepts EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
      attribute_value_list: ["value"], # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
    },
  },
  conditional_operator: "AND", # accepts AND, OR
  return_values: "NONE", # accepts NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
  return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
  return_item_collection_metrics: "SIZE", # accepts SIZE, NONE
  update_expression: "UpdateExpression",
  condition_expression: "ConditionExpression",
  expression_attribute_names: {
    "ExpressionAttributeNameVariable" => "AttributeName",
  },
  expression_attribute_values: {
    "ExpressionAttributeValueVariable" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
})

Response structure


resp.attributes #=> Hash
resp.attributes["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.consumed_capacity.table_name #=> String
resp.consumed_capacity.capacity_units #=> Float
resp.consumed_capacity.read_capacity_units #=> Float
resp.consumed_capacity.write_capacity_units #=> Float
resp.consumed_capacity.table.read_capacity_units #=> Float
resp.consumed_capacity.table.write_capacity_units #=> Float
resp.consumed_capacity.table.capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes #=> Hash
resp.consumed_capacity.local_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity.local_secondary_indexes["IndexName"].capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes #=> Hash
resp.consumed_capacity.global_secondary_indexes["IndexName"].read_capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes["IndexName"].write_capacity_units #=> Float
resp.consumed_capacity.global_secondary_indexes["IndexName"].capacity_units #=> Float
resp.item_collection_metrics.item_collection_key #=> Hash
resp.item_collection_metrics.item_collection_key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.item_collection_metrics.size_estimate_range_gb #=> Array
resp.item_collection_metrics.size_estimate_range_gb[0] #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_name (required, String) —

    The name of the table containing the item to update.

  • :key (required, Hash<String,Types::AttributeValue>) —

    The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

    For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

  • :attribute_updates (Hash<String,Types::AttributeValueUpdate>) —

    This is a legacy parameter. Use ‘UpdateExpression` instead. For more information, see [AttributeUpdates] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html

  • :expected (Hash<String,Types::ExpectedAttributeValue>) —

    This is a legacy parameter. Use ‘ConditionExpression` instead. For more information, see [Expected] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html

  • :conditional_operator (String) —

    This is a legacy parameter. Use ‘ConditionExpression` instead. For more information, see [ConditionalOperator] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html

  • :return_values (String) —

    Use ‘ReturnValues` if you want to get the item attributes as they appear before or after they are updated. For `UpdateItem`, the valid values are:

    • ‘NONE` - If `ReturnValues` is not specified, or if its value is `NONE`, then nothing is returned. (This setting is the default for `ReturnValues`.)

    • ‘ALL_OLD` - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.

    • ‘UPDATED_OLD` - Returns only the updated attributes, as they appeared before the UpdateItem operation.

    • ‘ALL_NEW` - Returns all of the attributes of the item, as they appear after the UpdateItem operation.

    • ‘UPDATED_NEW` - Returns only the updated attributes, as they appear after the UpdateItem operation.

    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.

    The values returned are strongly consistent.

  • :return_consumed_capacity (String) —

    Determines the level of detail about provisioned 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.

  • :return_item_collection_metrics (String) —

    Determines whether item collection metrics are returned. If set to ‘SIZE`, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to `NONE` (the default), no statistics are returned.

  • :update_expression (String) —

    An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.

    The following action values are available for ‘UpdateExpression`.

    • ‘SET` - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use `SET` to add or subtract from an attribute that is of type Number. For example: `SET myNum = myNum + :val`

      ‘SET` supports the following functions:

      • ‘if_not_exists (path, operand)` - if the item does not contain an attribute at the specified path, then `if_not_exists` evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.

      • ‘list_append (operand, operand)` - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.

      These function names are case-sensitive.

    • ‘REMOVE` - Removes one or more attributes from an item.

    • ‘ADD` - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of `ADD` depends on the data type of the attribute:

      • If the existing attribute is a number, and if ‘Value` is also a number, then `Value` is mathematically added to the existing attribute. If `Value` is a negative number, then it is subtracted from the existing attribute.

        <note markdown=“1”> If you use ‘ADD` to increment or decrement a number value for an item that doesn’t exist before the update, DynamoDB uses ‘0` as the initial value.

        Similarly, if you use `ADD` for an existing item to increment or

        decrement an attribute value that doesn’t exist before the update, DynamoDB uses ‘0` as the initial value. For example, suppose that the item you want to update doesn’t have an attribute named itemcount, but you decide to ‘ADD` the number `3` to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to `0`, and finally add `3` to it. The result will be a new itemcount attribute in the item, with a value of `3`.

        </note>

      • If the existing data type is a set and if ‘Value` is also a set, then `Value` is added to the existing set. For example, if the attribute value is the set `[1,2]`, and the `ADD` action specified `[3]`, then the final attribute value is `[1,2,3]`. An error occurs if an `ADD` action is specified for a set attribute and the attribute type specified does not match the existing set type.

        Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the ‘Value` must also be a set of strings.

      The ‘ADD` action only supports Number and set data types. In addition, `ADD` can only be used on top-level attributes, not nested attributes.

    • ‘DELETE` - Deletes an element from a set.

      If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set ‘[a,b,c]` and the `DELETE` action specifies `[a,c]`, then the final attribute value is `[b]`. Specifying an empty set is an error.

      The ‘DELETE` action only supports set data types. In addition, `DELETE` can only be used on top-level attributes, not nested attributes.

    You can have many actions in a single expression, such as the following: ‘SET a=:value1, b=:value2 DELETE :value3, :value4, :value5`

    For more information on update expressions, see [Modifying Items and Attributes] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html

  • :condition_expression (String) —

    A condition that must be satisfied in order for a conditional update to succeed.

    An expression can contain any of the following:

    • Functions: ‘attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size`

      These function names are case-sensitive.

    • Comparison operators: ‘= | <> | < | > | <= | >= | BETWEEN | IN `

    • Logical operators: ‘AND | OR | NOT`

    For more information on condition expressions, see [Specifying Conditions] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html

  • :expression_attribute_names (Hash<String,String>) —

    One or more substitution tokens for attribute names in an expression. The following are some use cases for using ‘ExpressionAttributeNames`:

    • To access an attribute whose name conflicts with a DynamoDB reserved word.

    • To create a placeholder for repeating occurrences of an attribute name in an expression.

    • To prevent special characters in an attribute name from being misinterpreted in an expression.

    Use the **#** character in an expression to dereference an attribute name. For example, consider the following attribute name:

    • ‘Percentile`

    ^

    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see [Reserved Words] in the *Amazon DynamoDB Developer Guide*). To work around this, you could specify the following for ‘ExpressionAttributeNames`:

    • ‘“#P”:“Percentile”`

    ^

    You could then use this substitution in an expression, as in this example:

    • ‘#P = :val`

    ^

    <note markdown=“1”> Tokens that begin with the : character are *expression attribute values*, which are placeholders for the actual value at runtime.

    </note>

    For more information on expression attribute names, see [Accessing Item Attributes] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html [2]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html

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

    One or more values that can be substituted in an expression.

    Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

    ‘Available | Backordered | Discontinued`

    You would first need to specify ‘ExpressionAttributeValues` as follows:

    ‘{ “:avail”:“S”:“Available”, “:back”:“S”:“Backordered”, “:disc”:“S”:“Discontinued” }`

    You could then use these values in an expression, such as this:

    ‘ProductStatus IN (:avail, :back, :disc)`

    For more information on expression attribute values, see [Specifying Conditions] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html

Returns:

See Also:



4979
4980
4981
4982
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 4979

def update_item(params = {}, options = {})
  req = build_request(:update_item, params)
  req.send_request(options)
end

#update_table(params = {}) ⇒ Types::UpdateTableOutput

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

You can only perform one of the following operations at once:

  • Modify the provisioned throughput settings of the table.

  • Enable or disable Streams on the table.

  • Remove a global secondary index from the table.

  • Create a new global secondary index on the table. Once the index begins backfilling, you can use ‘UpdateTable` to perform other operations.

‘UpdateTable` is an asynchronous operation; while it is executing, the table status changes from `ACTIVE` to `UPDATING`. While it is `UPDATING`, you cannot issue another `UpdateTable` request. When the table returns to the `ACTIVE` state, the `UpdateTable` operation is complete.

Examples:

Request syntax with placeholder values


resp = client.update_table({
  attribute_definitions: [
    {
      attribute_name: "KeySchemaAttributeName", # required
      attribute_type: "S", # required, accepts S, N, B
    },
  ],
  table_name: "TableName", # required
  billing_mode: "PROVISIONED", # accepts PROVISIONED, PAY_PER_REQUEST
  provisioned_throughput: {
    read_capacity_units: 1, # required
    write_capacity_units: 1, # required
  },
  global_secondary_index_updates: [
    {
      update: {
        index_name: "IndexName", # required
        provisioned_throughput: { # required
          read_capacity_units: 1, # required
          write_capacity_units: 1, # required
        },
      },
      create: {
        index_name: "IndexName", # required
        key_schema: [ # required
          {
            attribute_name: "KeySchemaAttributeName", # required
            key_type: "HASH", # required, accepts HASH, RANGE
          },
        ],
        projection: { # required
          projection_type: "ALL", # accepts ALL, KEYS_ONLY, INCLUDE
          non_key_attributes: ["NonKeyAttributeName"],
        },
        provisioned_throughput: {
          read_capacity_units: 1, # required
          write_capacity_units: 1, # required
        },
      },
      delete: {
        index_name: "IndexName", # required
      },
    },
  ],
  stream_specification: {
    stream_enabled: false,
    stream_view_type: "NEW_IMAGE", # accepts NEW_IMAGE, OLD_IMAGE, NEW_AND_OLD_IMAGES, KEYS_ONLY
  },
  sse_specification: {
    enabled: false,
    sse_type: "AES256", # accepts AES256, KMS
    kms_master_key_id: "KMSMasterKeyId",
  },
})

Response structure


resp.table_description.attribute_definitions #=> Array
resp.table_description.attribute_definitions[0].attribute_name #=> String
resp.table_description.attribute_definitions[0].attribute_type #=> String, one of "S", "N", "B"
resp.table_description.table_name #=> String
resp.table_description.key_schema #=> Array
resp.table_description.key_schema[0].attribute_name #=> String
resp.table_description.key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table_description.table_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.table_description.creation_date_time #=> Time
resp.table_description.provisioned_throughput.last_increase_date_time #=> Time
resp.table_description.provisioned_throughput.last_decrease_date_time #=> Time
resp.table_description.provisioned_throughput.number_of_decreases_today #=> Integer
resp.table_description.provisioned_throughput.read_capacity_units #=> Integer
resp.table_description.provisioned_throughput.write_capacity_units #=> Integer
resp.table_description.table_size_bytes #=> Integer
resp.table_description.item_count #=> Integer
resp.table_description.table_arn #=> String
resp.table_description.table_id #=> String
resp.table_description.billing_mode_summary.billing_mode #=> String, one of "PROVISIONED", "PAY_PER_REQUEST"
resp.table_description.billing_mode_summary.last_update_to_pay_per_request_date_time #=> Time
resp.table_description.local_secondary_indexes #=> Array
resp.table_description.local_secondary_indexes[0].index_name #=> String
resp.table_description.local_secondary_indexes[0].key_schema #=> Array
resp.table_description.local_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.table_description.local_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table_description.local_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.table_description.local_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.table_description.local_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.table_description.local_secondary_indexes[0].index_size_bytes #=> Integer
resp.table_description.local_secondary_indexes[0].item_count #=> Integer
resp.table_description.local_secondary_indexes[0].index_arn #=> String
resp.table_description.global_secondary_indexes #=> Array
resp.table_description.global_secondary_indexes[0].index_name #=> String
resp.table_description.global_secondary_indexes[0].key_schema #=> Array
resp.table_description.global_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.table_description.global_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.table_description.global_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.table_description.global_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.table_description.global_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.table_description.global_secondary_indexes[0].index_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.table_description.global_secondary_indexes[0].backfilling #=> Boolean
resp.table_description.global_secondary_indexes[0].provisioned_throughput.last_increase_date_time #=> Time
resp.table_description.global_secondary_indexes[0].provisioned_throughput.last_decrease_date_time #=> Time
resp.table_description.global_secondary_indexes[0].provisioned_throughput.number_of_decreases_today #=> Integer
resp.table_description.global_secondary_indexes[0].provisioned_throughput.read_capacity_units #=> Integer
resp.table_description.global_secondary_indexes[0].provisioned_throughput.write_capacity_units #=> Integer
resp.table_description.global_secondary_indexes[0].index_size_bytes #=> Integer
resp.table_description.global_secondary_indexes[0].item_count #=> Integer
resp.table_description.global_secondary_indexes[0].index_arn #=> String
resp.table_description.stream_specification.stream_enabled #=> Boolean
resp.table_description.stream_specification.stream_view_type #=> String, one of "NEW_IMAGE", "OLD_IMAGE", "NEW_AND_OLD_IMAGES", "KEYS_ONLY"
resp.table_description.latest_stream_label #=> String
resp.table_description.latest_stream_arn #=> String
resp.table_description.restore_summary.source_backup_arn #=> String
resp.table_description.restore_summary.source_table_arn #=> String
resp.table_description.restore_summary.restore_date_time #=> Time
resp.table_description.restore_summary.restore_in_progress #=> Boolean
resp.table_description.sse_description.status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED", "UPDATING"
resp.table_description.sse_description.sse_type #=> String, one of "AES256", "KMS"
resp.table_description.sse_description.kms_master_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :attribute_definitions (Array<Types::AttributeDefinition>) —

    An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, ‘AttributeDefinitions` must include the key element(s) of the new index.

  • :table_name (required, String) —

    The name of the table to be updated.

  • :billing_mode (String) —

    Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

    • ‘PROVISIONED` - Sets the billing mode to `PROVISIONED`. We recommend using `PROVISIONED` for predictable workloads.

    • ‘PAY_PER_REQUEST` - Sets the billing mode to `PAY_PER_REQUEST`. We recommend using `PAY_PER_REQUEST` for unpredictable workloads.

  • :provisioned_throughput (Types::ProvisionedThroughput) —

    The new provisioned throughput settings for the specified table or index.

  • :global_secondary_index_updates (Array<Types::GlobalSecondaryIndexUpdate>) —

    An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

    • ‘Create` - add a new global secondary index to the table.

    • ‘Update` - modify the provisioned throughput settings of an existing global secondary index.

    • ‘Delete` - remove a global secondary index from the table.

    For more information, see [Managing Global Secondary Indexes] in the *Amazon DynamoDB Developer Guide*.

    [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.OnlineOps.html

  • :stream_specification (Types::StreamSpecification) —

    Represents the DynamoDB Streams configuration for the table.

    <note markdown=“1”> You will receive a ‘ResourceInUseException` if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.

    </note>
  • :sse_specification (Types::SSESpecification) —

    The new server-side encryption settings for the specified table.

Returns:

See Also:



5190
5191
5192
5193
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 5190

def update_table(params = {}, options = {})
  req = build_request(:update_table, params)
  req.send_request(options)
end

#update_time_to_live(params = {}) ⇒ Types::UpdateTimeToLiveOutput

The UpdateTimeToLive method will enable or disable TTL for the specified table. A successful ‘UpdateTimeToLive` call returns the current `TimeToLiveSpecification`; it may take up to one hour for the change to fully process. Any additional `UpdateTimeToLive` calls for the same table during this one hour duration result in a `ValidationException`.

TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.

<note markdown=“1”> The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1st, 1970 UTC.

</note>

DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.

DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.

As items are deleted, they are removed from any Local Secondary Index and Global Secondary Index immediately in the same eventually consistent way as a standard delete operation.

For more information, see [Time To Live] in the Amazon DynamoDB Developer Guide.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html

Examples:

Request syntax with placeholder values


resp = client.update_time_to_live({
  table_name: "TableName", # required
  time_to_live_specification: { # required
    enabled: false, # required
    attribute_name: "TimeToLiveAttributeName", # required
  },
})

Response structure


resp.time_to_live_specification.enabled #=> Boolean
resp.time_to_live_specification.attribute_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_name (required, String) —

    The name of the table to be configured.

  • :time_to_live_specification (required, Types::TimeToLiveSpecification) —

    Represents the settings used to enable or disable Time to Live for the specified table.

Returns:

See Also:



5262
5263
5264
5265
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 5262

def update_time_to_live(params = {}, options = {})
  req = build_request(:update_time_to_live, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

## Basic Usage

A waiter will call an API operation until:

  • It is successful

  • It enters a terminal state

  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.waiter_until(waiter_name, params)

## Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

## Callbacks

You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

## Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

## Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default ‘:delay` and `:max_attempts` values.

| waiter_name | params | :delay | :max_attempts | | —————- | —————– | ——– | ————- | | table_exists | #describe_table | 20 | 25 | | table_not_exists | #describe_table | 20 | 25 |

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns ‘true` if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



5373
5374
5375
5376
5377
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 5373

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


5381
5382
5383
 
# File 'lib/aws-sdk-dynamodb/client.rb', line 5381

def waiter_names
  waiters.keys
end