Class: Aws::DynamoDB::Client

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

Overview

An API client for DynamoDB. To construct a client, you need to configure a :region and :credentials.

client = Aws::DynamoDB::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []]

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :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::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

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

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

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

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :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 searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_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.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :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_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :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.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy"

    See Aws::DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false

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

  • :disable_request_compression (Boolean) — default: false

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP)

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
    'https://example.com'
    'http://example.com:123'
    
  • :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.

  • :ignore_configured_endpoint_urls (Boolean)

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :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.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

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

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

  • :request_min_compression_size_bytes (Integer) — default: 10240

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

    @see https://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_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String)

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array)

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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'.

    See Plugins::SimpleAttributes for more information.

  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.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.

  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider)

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean)

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true

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

  • :account_id_endpoint_mode (String)

    The account ID endpoint mode to use. This can be one of the following values: * preferred - The default behavior. Use the account ID endpoint if available, otherwise use the standard endpoint. * disabled - Never use the account ID endpoint. Only use the standard endpoint. * required - Always use the account ID endpoint. If the account ID cannot be retrieved from credentials, an error is raised.

  • :endpoint_provider (Aws::DynamoDB::EndpointProvider)

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::DynamoDB::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc)

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc)

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String)

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate)

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey)

    Sets a client key when creating http connections.

  • :ssl_timeout (Float)

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.



481
482
483
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 481

def initialize(*args)
  super
end

Instance Method Details

#batch_execute_statement(params = {}) ⇒ Types::BatchExecuteStatementOutput

This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item. For more information, see Running batch operations with PartiQL for DynamoDB .

The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.

A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each statement.

Examples:

Request syntax with placeholder values


resp = client.batch_execute_statement({
  statements: [ # required
    {
      statement: "PartiQLStatement", # required
      parameters: ["value"], # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
      consistent_read: false,
      return_values_on_condition_check_failure: "ALL_OLD", # accepts ALL_OLD, NONE
    },
  ],
  return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
})

Response structure


resp.responses #=> Array
resp.responses[0].error.code #=> String, one of "ConditionalCheckFailed", "ItemCollectionSizeLimitExceeded", "RequestLimitExceeded", "ValidationError", "ProvisionedThroughputExceeded", "TransactionConflict", "ThrottlingError", "InternalServerError", "ResourceNotFound", "AccessDenied", "DuplicateItem"
resp.responses[0].error.message #=> String
resp.responses[0].error.item #=> Hash
resp.responses[0].error.item["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.responses[0].table_name #=> String
resp.responses[0].item #=> Hash
resp.responses[0].item["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
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):

  • :statements (required, Array<Types::BatchStatementRequest>)

    The list of PartiQL statements representing the batch to run.

  • :return_consumed_capacity (String)

    Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

    • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

      Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

    • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

    • NONE - No ConsumedCapacity details are included in the response.

Returns:

See Also:



579
580
581
582
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 579

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

#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 returns a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is requested, 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 returns 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 dataset.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem returns 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 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 may retrieve 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 Working with Tables in the Amazon DynamoDB Developer Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To retrieve multiple items from a table


# This example reads multiple items from the Music table using a batch of three GetItem requests.  Only the AlbumTitle
# attribute is returned.

resp = client.batch_get_item({
  request_items: {
    "Music" => {
      keys: [
        {
          "Artist" => "No One You Know", 
          "SongTitle" => "Call Me Today", 
        }, 
        {
          "Artist" => "Acme Band", 
          "SongTitle" => "Happy Day", 
        }, 
        {
          "Artist" => "No One You Know", 
          "SongTitle" => "Scared of My Shadow", 
        }, 
      ], 
      projection_expression: "AlbumTitle", 
    }, 
  }, 
})

resp.to_h outputs the following:
{
  responses: {
    "Music" => [
      {
        "AlbumTitle" => "Somewhat Famous", 
      }, 
      {
        "AlbumTitle" => "Blue Sky Blues", 
      }, 
      {
        "AlbumTitle" => "Louder Than Ever", 
      }, 
    ], 
  }, 
}

Request syntax with placeholder values


resp = client.batch_get_item({
  request_items: { # required
    "TableArn" => {
      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["TableArn"] #=> Array
resp.responses["TableArn"][0] #=> Hash
resp.responses["TableArn"][0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.unprocessed_keys #=> Hash
resp.unprocessed_keys["TableArn"].keys #=> Array
resp.unprocessed_keys["TableArn"].keys[0] #=> Hash
resp.unprocessed_keys["TableArn"].keys[0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.unprocessed_keys["TableArn"].attributes_to_get #=> Array
resp.unprocessed_keys["TableArn"].attributes_to_get[0] #=> String
resp.unprocessed_keys["TableArn"].consistent_read #=> Boolean
resp.unprocessed_keys["TableArn"].projection_expression #=> String
resp.unprocessed_keys["TableArn"].expression_attribute_names #=> Hash
resp.unprocessed_keys["TableArn"].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 or table ARNs and, for each table, a map that describes one or more items to retrieve from that table. Each table name or ARN 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

      ^ Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

      For more information about 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 are returned. If any of the requested attributes are not found, they do 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 in the Amazon DynamoDB Developer Guide.

  • :return_consumed_capacity (String)

    Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

    • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

      Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

    • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

    • NONE - No ConsumedCapacity details are included in the response.

Returns:

See Also:



858
859
860
861
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 858

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 transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.

BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action.

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.

For tables and indexes with provisioned capacity, if none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException. For all tables and indexes, if none of the items can be processed due to other throttling scenarios (such as exceeding partition level limits), then BatchWriteItem returns a ThrottlingException.

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 in the Amazon DynamoDB Developer Guide.

With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon 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.

  • Any individual items with keys exceeding the key length limits. For a partition key, the limit is 2048 bytes and for a sort key, the limit is 1024 bytes.

Examples:

Example: To add multiple items to a table


# This example adds three new items to the Music table using a batch of three PutItem requests.

resp = client.batch_write_item({
  request_items: {
    "Music" => [
      {
        put_request: {
          item: {
            "AlbumTitle" => "Somewhat Famous", 
            "Artist" => "No One You Know", 
            "SongTitle" => "Call Me Today", 
          }, 
        }, 
      }, 
      {
        put_request: {
          item: {
            "AlbumTitle" => "Songs About Life", 
            "Artist" => "Acme Band", 
            "SongTitle" => "Happy Day", 
          }, 
        }, 
      }, 
      {
        put_request: {
          item: {
            "AlbumTitle" => "Blue Sky Blues", 
            "Artist" => "No One You Know", 
            "SongTitle" => "Scared of My Shadow", 
          }, 
        }, 
      }, 
    ], 
  }, 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.batch_write_item({
  request_items: { # required
    "TableArn" => [
      {
        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["TableArn"] #=> Array
resp.unprocessed_items["TableArn"][0].put_request.item #=> Hash
resp.unprocessed_items["TableArn"][0].put_request.item["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.unprocessed_items["TableArn"][0].delete_request.key #=> Hash
resp.unprocessed_items["TableArn"][0].delete_request.key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.item_collection_metrics #=> Hash
resp.item_collection_metrics["TableArn"] #=> Array
resp.item_collection_metrics["TableArn"][0].item_collection_key #=> Hash
resp.item_collection_metrics["TableArn"][0].item_collection_key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.item_collection_metrics["TableArn"][0].size_estimate_range_gb #=> Array
resp.item_collection_metrics["TableArn"][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 or table ARNs 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 are 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 either provisioned or on-demand throughput consumption that is returned in the response:

    • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

      Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

    • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

    • NONE - No ConsumedCapacity details are included in the response.

  • :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:



1124
1125
1126
1127
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 1124

def batch_write_item(params = {}, options = {})
  req = build_request(:batch_write_item, params)
  req.send_request(options)
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 might 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: "TableArn", # 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. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

  • :backup_name (required, String)

    Specified name for the backup.

Returns:

See Also:



1194
1195
1196
1197
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 1194

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.

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

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).

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

  • The local secondary indexes must have the same name.

  • The local 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.replication_group[0].replica_status #=> String, one of "CREATING", "CREATION_FAILED", "UPDATING", "DELETING", "ACTIVE", "REGION_DISABLED", "INACCESSIBLE_ENCRYPTION_CREDENTIALS"
resp.global_table_description.replication_group[0].replica_status_description #=> String
resp.global_table_description.replication_group[0].replica_status_percent_progress #=> String
resp.global_table_description.replication_group[0].kms_master_key_id #=> String
resp.global_table_description.replication_group[0].provisioned_throughput_override.read_capacity_units #=> Integer
resp.global_table_description.replication_group[0].on_demand_throughput_override.max_read_request_units #=> Integer
resp.global_table_description.replication_group[0].warm_throughput.read_units_per_second #=> Integer
resp.global_table_description.replication_group[0].warm_throughput.write_units_per_second #=> Integer
resp.global_table_description.replication_group[0].warm_throughput.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS", "ARCHIVING", "ARCHIVED"
resp.global_table_description.replication_group[0].global_secondary_indexes #=> Array
resp.global_table_description.replication_group[0].global_secondary_indexes[0].index_name #=> String
resp.global_table_description.replication_group[0].global_secondary_indexes[0].provisioned_throughput_override.read_capacity_units #=> Integer
resp.global_table_description.replication_group[0].global_secondary_indexes[0].on_demand_throughput_override.max_read_request_units #=> Integer
resp.global_table_description.replication_group[0].global_secondary_indexes[0].warm_throughput.read_units_per_second #=> Integer
resp.global_table_description.replication_group[0].global_secondary_indexes[0].warm_throughput.write_units_per_second #=> Integer
resp.global_table_description.replication_group[0].global_secondary_indexes[0].warm_throughput.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.global_table_description.replication_group[0].replica_inaccessible_date_time #=> Time
resp.global_table_description.replication_group[0].replica_table_class_summary.table_class #=> String, one of "STANDARD", "STANDARD_INFREQUENT_ACCESS"
resp.global_table_description.replication_group[0].replica_table_class_summary.last_update_date_time #=> Time
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:



1312
1313
1314
1315
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 1312

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 Amazon Web Services 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:

Example: To create a table


# This example creates a table named Music.

resp = client.create_table({
  attribute_definitions: [
    {
      attribute_name: "Artist", 
      attribute_type: "S", 
    }, 
    {
      attribute_name: "SongTitle", 
      attribute_type: "S", 
    }, 
  ], 
  key_schema: [
    {
      attribute_name: "Artist", 
      key_type: "HASH", 
    }, 
    {
      attribute_name: "SongTitle", 
      key_type: "RANGE", 
    }, 
  ], 
  provisioned_throughput: {
    read_capacity_units: 5, 
    write_capacity_units: 5, 
  }, 
  table_name: "Music", 
})

resp.to_h outputs the following:
{
  table_description: {
    attribute_definitions: [
      {
        attribute_name: "Artist", 
        attribute_type: "S", 
      }, 
      {
        attribute_name: "SongTitle", 
        attribute_type: "S", 
      }, 
    ], 
    creation_date_time: Time.parse("1421866952.062"), 
    item_count: 0, 
    key_schema: [
      {
        attribute_name: "Artist", 
        key_type: "HASH", 
      }, 
      {
        attribute_name: "SongTitle", 
        key_type: "RANGE", 
      }, 
    ], 
    provisioned_throughput: {
      read_capacity_units: 5, 
      write_capacity_units: 5, 
    }, 
    table_name: "Music", 
    table_size_bytes: 0, 
    table_status: "CREATING", 
  }, 
}

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: "TableArn", # 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
      },
      on_demand_throughput: {
        max_read_request_units: 1,
        max_write_request_units: 1,
      },
      warm_throughput: {
        read_units_per_second: 1,
        write_units_per_second: 1,
      },
    },
  ],
  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, # required
    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",
  },
  tags: [
    {
      key: "TagKeyString", # required
      value: "TagValueString", # required
    },
  ],
  table_class: "STANDARD", # accepts STANDARD, STANDARD_INFREQUENT_ACCESS
  deletion_protection_enabled: false,
  warm_throughput: {
    read_units_per_second: 1,
    write_units_per_second: 1,
  },
  resource_policy: "ResourcePolicy",
  on_demand_throughput: {
    max_read_request_units: 1,
    max_write_request_units: 1,
  },
})

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", "INACCESSIBLE_ENCRYPTION_CREDENTIALS", "ARCHIVING", "ARCHIVED"
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.global_secondary_indexes[0].on_demand_throughput.max_read_request_units #=> Integer
resp.table_description.global_secondary_indexes[0].on_demand_throughput.max_write_request_units #=> Integer
resp.table_description.global_secondary_indexes[0].warm_throughput.read_units_per_second #=> Integer
resp.table_description.global_secondary_indexes[0].warm_throughput.write_units_per_second #=> Integer
resp.table_description.global_secondary_indexes[0].warm_throughput.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
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.global_table_version #=> String
resp.table_description.replicas #=> Array
resp.table_description.replicas[0].region_name #=> String
resp.table_description.replicas[0].replica_status #=> String, one of "CREATING", "CREATION_FAILED", "UPDATING", "DELETING", "ACTIVE", "REGION_DISABLED", "INACCESSIBLE_ENCRYPTION_CREDENTIALS"
resp.table_description.replicas[0].replica_status_description #=> String
resp.table_description.replicas[0].replica_status_percent_progress #=> String
resp.table_description.replicas[0].kms_master_key_id #=> String
resp.table_description.replicas[0].provisioned_throughput_override.read_capacity_units #=> Integer
resp.table_description.replicas[0].on_demand_throughput_override.max_read_request_units #=> Integer
resp.table_description.replicas[0].warm_throughput.read_units_per_second #=> Integer
resp.table_description.replicas[0].warm_throughput.write_units_per_second #=> Integer
resp.table_description.replicas[0].warm_throughput.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS", "ARCHIVING", "ARCHIVED"
resp.table_description.replicas[0].global_secondary_indexes #=> Array
resp.table_description.replicas[0].global_secondary_indexes[0].index_name #=> String
resp.table_description.replicas[0].global_secondary_indexes[0].provisioned_throughput_override.read_capacity_units #=> Integer
resp.table_description.replicas[0].global_secondary_indexes[0].on_demand_throughput_override.max_read_request_units #=> Integer
resp.table_description.replicas[0].global_secondary_indexes[0].warm_throughput.read_units_per_second #=> Integer
resp.table_description.replicas[0].global_secondary_indexes[0].warm_throughput.write_units_per_second #=> Integer
resp.table_description.replicas[0].global_secondary_indexes[0].warm_throughput.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.table_description.replicas[0].replica_inaccessible_date_time #=> Time
resp.table_description.replicas[0].replica_table_class_summary.table_class #=> String, one of "STANDARD", "STANDARD_INFREQUENT_ACCESS"
resp.table_description.replicas[0].replica_table_class_summary.last_update_date_time #=> Time
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
resp.table_description.sse_description.inaccessible_encryption_date_time #=> Time
resp.table_description.archival_summary.archival_date_time #=> Time
resp.table_description.archival_summary.archival_reason #=> String
resp.table_description.archival_summary.archival_backup_arn #=> String
resp.table_description.table_class_summary.table_class #=> String, one of "STANDARD", "STANDARD_INFREQUENT_ACCESS"
resp.table_description.table_class_summary.last_update_date_time #=> Time
resp.table_description.deletion_protection_enabled #=> Boolean
resp.table_description.on_demand_throughput.max_read_request_units #=> Integer
resp.table_description.on_demand_throughput.max_write_request_units #=> Integer
resp.table_description.warm_throughput.read_units_per_second #=> Integer
resp.table_description.warm_throughput.write_units_per_second #=> Integer
resp.table_description.warm_throughput.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS", "ARCHIVING", "ARCHIVED"
resp.table_description.multi_region_consistency #=> String, one of "EVENTUAL", "STRONG"

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. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

  • :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

    The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the 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.

    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 Working with Tables in the Amazon DynamoDB Developer Guide.

  • :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 is 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 is 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 - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.

    • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

  • :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 Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

  • :stream_specification (Types::StreamSpecification)

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

    • StreamEnabled - Indicates whether DynamoDB 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.

  • :tags (Array<Types::Tag>)

    A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

  • :table_class (String)

    The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

  • :deletion_protection_enabled (Boolean)

    Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

  • :warm_throughput (Types::WarmThroughput)

    Represents the warm throughput (in read units per second and write units per second) for creating a table.

  • :resource_policy (String)

    An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.

    When you attach a resource-based policy while creating a table, the policy application is strongly consistent.

    The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.

    You need to specify the CreateTable and PutResourcePolicy IAM actions for authorizing a user to create a table with a resource-based policy.

  • :on_demand_throughput (Types::OnDemandThroughput)

    Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

Returns:

See Also:



1845
1846
1847
1848
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 1845

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.on_demand_throughput.max_read_request_units #=> Integer
resp.backup_description.source_table_details.on_demand_throughput.max_write_request_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.global_secondary_indexes[0].on_demand_throughput.max_read_request_units #=> Integer
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].on_demand_throughput.max_write_request_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
resp.backup_description.source_table_feature_details.sse_description.inaccessible_encryption_date_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :backup_arn (required, String)

    The ARN associated with the backup.

Returns:

See Also:



1923
1924
1925
1926
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 1923

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:

Example: To delete an item


# This example deletes an item from the Music table.

resp = client.delete_item({
  key: {
    "Artist" => "No One You Know", 
    "SongTitle" => "Scared of My Shadow", 
  }, 
  table_name: "Music", 
})

resp.to_h outputs the following:
{
  consumed_capacity: {
    capacity_units: 1, 
    table_name: "Music", 
  }, 
}

Request syntax with placeholder values


resp = client.delete_item({
  table_name: "TableArn", # 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>
  },
  return_values_on_condition_check_failure: "ALL_OLD", # accepts ALL_OLD, NONE
})

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. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

  • :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 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.

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

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

  • :conditional_operator (String)

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

  • :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.

    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 ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.

  • :return_consumed_capacity (String)

    Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

    • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

      Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

    • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

    • NONE - No ConsumedCapacity details are included in the response.

  • :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 about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.

  • :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

    ^

    Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

    For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

  • :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 Condition Expressions in the Amazon DynamoDB Developer Guide.

  • :return_values_on_condition_check_failure (String)

    An optional parameter that returns the item attributes for a DeleteItem operation that failed a condition check.

    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.

Returns:

See Also:



2209
2210
2211
2212
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 2209

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

#delete_resource_policy(params = {}) ⇒ Types::DeleteResourcePolicyOutput

Deletes the resource-based policy attached to the resource, which can be a table or stream.

DeleteResourcePolicy is an idempotent operation; running it multiple times on the same resource doesn't result in an error response, unless you specify an ExpectedRevisionId, which will then return a PolicyNotFoundException.

To make sure that you don't inadvertently lock yourself out of your own resources, the root principal in your Amazon Web Services account can perform DeleteResourcePolicy requests, even if your resource-based policy explicitly denies the root principal's access.

DeleteResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after running the DeleteResourcePolicy request, DynamoDB might still return the deleted policy. This is because the policy for your resource might not have been deleted yet. Wait for a few seconds, and then try the GetResourcePolicy request again.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_policy({
  resource_arn: "ResourceArnString", # required
  expected_revision_id: "PolicyRevisionId",
})

Response structure


resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the DynamoDB resource from which the policy will be removed. The resources you can specify include tables and streams. If you remove the policy of a table, it will also remove the permissions for the table's indexes defined in that policy document. This is because index permissions are defined in the table's policy.

  • :expected_revision_id (String)

    A string value that you can use to conditionally delete your policy. When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, the request will fail and return a PolicyNotFoundException.

Returns:

See Also:



2270
2271
2272
2273
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 2270

def delete_resource_policy(params = {}, options = {})
  req = build_request(:delete_resource_policy, 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.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

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. For the full list of table states, see TableStatus.

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:

Example: To delete a table


# This example deletes the Music table.

resp = client.delete_table({
  table_name: "Music", 
})

resp.to_h outputs the following:
{
  table_description: {
    item_count: 0, 
    provisioned_throughput: {
      number_of_decreases_today: 1, 
      read_capacity_units: 5, 
      write_capacity_units: 5, 
    }, 
    table_name: "Music", 
    table_size_bytes: 0, 
    table_status: "DELETING", 
  }, 
}

Request syntax with placeholder values


resp = client.delete_table({
  table_name: "TableArn", # 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", "INACCESSIBLE_ENCRYPTION_CREDENTIALS", "ARCHIVING", "ARCHIVED"
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.global_secondary_indexes[0].on_demand_throughput.max_read_request_units #=> Integer
resp.table_description.global_secondary_indexes[0].on_demand_throughput.max_write_request_units #=> Integer
resp.table_description.global_secondary_indexes[0].warm_throughput.read_units_per_second #=> Integer
resp.table_description.global_secondary_indexes[0].warm_throughput.write_units_per_second #=> Integer
resp.table_description.global_secondary_indexes[0].warm_throughput.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
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.global_table_version #=> String
resp.table_description.replicas #=> Array
resp.table_description.replicas[0].region_name #=> String
resp.table_description.replicas[0].replica_status #=> String, one of "CREATING", "CREATION_FAILED", "UPDATING", "DELETING", "ACTIVE", "REGION_DISABLED", "INACCESSIBLE_ENCRYPTION_CREDENTIALS"
resp.table_description.replicas[0].replica_status_description #=> String
resp.table_description.replicas[0].replica_status_percent_progress #=> String
resp.table_description.replicas[0].kms_master_key_id #=> String
resp.table_description.replicas[0].provisioned_throughput_override.read_capacity_units #=> Integer
resp.table_description.replicas[0].on_demand_throughput_override.max_read_request_units #=> Integer
resp.table_description.replicas[0].warm_throughput.read_units_per_second #=> Integer
resp.table_description.replicas[0].warm_throughput.write_units_per_second #=> Integer
resp.table_description.replicas[0].warm_throughput.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS", "ARCHIVING", "ARCHIVED"
resp.table_description.replicas[0].global_secondary_indexes #=> Array
resp.table_description.replicas[0].global_secondary_indexes[0].index_name #=> String
resp.table_description.replicas[0].global_secondary_indexes[0].provisioned_throughput_override.read_capacity_units #=> Integer
resp.table_description.replicas[0].global_secondary_indexes[0].on_demand_throughput_override.max_read_request_units #=> Integer
resp.table_description.replicas[0].global_secondary_indexes[0].warm_throughput.read_units_per_second #=> Integer
resp.table_description.replicas[0].global_secondary_indexes[0].warm_throughput.write_units_per_second #=> Integer
resp.table_description.replicas[0].global_secondary_indexes[0].warm_throughput.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.table_description.replicas[0].replica_inaccessible_date_time #=> Time
resp.table_description.replicas[0].replica_table_class_summary.table_class #=> String, one of "STANDARD", "STANDARD_INFREQUENT_ACCESS"
resp.table_description.replicas[0].replica_table_class_summary.last_update_date_time #=> Time
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
resp.table_description.sse_description.inaccessible_encryption_date_time #=> Time
resp.table_description.archival_summary.archival_date_time #=> Time
resp.table_description.archival_summary.archival_reason #=> String
resp.table_description.archival_summary.archival_backup_arn #=> String
resp.table_description.table_class_summary.table_class #=> String, one of "STANDARD", "STANDARD_INFREQUENT_ACCESS"
resp.table_description.table_class_summary.last_update_date_time #=> Time
resp.table_description.deletion_protection_enabled #=> Boolean
resp.table_description.on_demand_throughput.max_read_request_units #=> Integer
resp.table_description.on_demand_throughput.max_write_request_units #=> Integer
resp.table_description.warm_throughput.read_units_per_second #=> Integer
resp.table_description.warm_throughput.write_units_per_second #=> Integer
resp.table_description.warm_throughput.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS", "ARCHIVING", "ARCHIVED"
resp.table_description.multi_region_consistency #=> String, one of "EVENTUAL", "STRONG"

Parameters:

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

    ({})

Options Hash (params):

  • :table_name (required, String)

    The name of the table to delete. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Returns:

See Also:



2451
2452
2453
2454
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 2451

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.on_demand_throughput.max_read_request_units #=> Integer
resp.backup_description.source_table_details.on_demand_throughput.max_write_request_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.global_secondary_indexes[0].on_demand_throughput.max_read_request_units #=> Integer
resp.backup_description.source_table_feature_details.global_secondary_indexes[0].on_demand_throughput.max_write_request_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
resp.backup_description.source_table_feature_details.sse_description.inaccessible_encryption_date_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :backup_arn (required, String)

    The Amazon Resource Name (ARN) associated with the backup.

Returns:

See Also:



2530
2531
2532
2533
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 2530

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.

After 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: "TableArn", # 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.

    You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Returns:

See Also:



2579
2580
2581
2582
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 2579

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

#describe_contributor_insights(params = {}) ⇒ Types::DescribeContributorInsightsOutput

Returns information about contributor insights for a given table or global secondary index.

Examples:

Request syntax with placeholder values


resp = client.describe_contributor_insights({
  table_name: "TableArn", # required
  index_name: "IndexName",
})

Response structure


resp.table_name #=> String
resp.index_name #=> String
resp.contributor_insights_rule_list #=> Array
resp.contributor_insights_rule_list[0] #=> String
resp.contributor_insights_status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED", "FAILED"
resp.last_update_date_time #=> Time
resp.failure_exception.exception_name #=> String
resp.failure_exception.exception_description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :table_name (required, String)

    The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

  • :index_name (String)

    The name of the global secondary index to describe, if applicable.

Returns:

See Also:



2625
2626
2627
2628
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 2625

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

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

Returns the regional endpoint information. For more information on policy permissions, please see Internetwork traffic privacy.

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:



2651
2652
2653
2654
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 2651

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

#describe_export(params = {}) ⇒ Types::DescribeExportOutput

Describes an existing table export.

Examples:

Request syntax with placeholder values


resp = client.describe_export({
  export_arn: "ExportArn", # required
})

Response structure


resp.export_description.export_arn #=> String
resp.export_description.export_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
resp.export_description.start_time #=> Time
resp.export_description.end_time #=> Time
resp.export_description.export_manifest #=> String
resp.export_description.table_arn #=> String
resp.export_description.table_id #=> String
resp.export_description.export_time #=> Time
resp.export_description.client_token #=> String
resp.export_description.s3_bucket #=> String
resp.export_description.s3_bucket_owner #=> String
resp.export_description.s3_prefix #=> String
resp.export_description.s3_sse_algorithm #=> String, one of "AES256", "KMS"
resp.export_description.s3_sse_kms_key_id #=> String
resp.export_description.failure_code #=> String
resp.export_description.failure_message #=> String
resp.export_description.export_format #=> String, one of "DYNAMODB_JSON", "ION"
resp.export_description.billed_size_bytes #=> Integer
resp.export_description.item_count #=> Integer
resp.export_description.export_type #=> String, one of "FULL_EXPORT", "INCREMENTAL_EXPORT"
resp.export_description.incremental_export_specification.export_from_time #=> Time
resp.export_description.incremental_export_specification.export_to_time #=> Time
resp.export_description.incremental_export_specification.export_view_type #=> String, one of "NEW_IMAGE", "NEW_AND_OLD_IMAGES"

Parameters:

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

    ({})

Options Hash (params):

  • :export_arn (required, String)

    The Amazon Resource Name (ARN) associated with the export.

Returns:

See Also:



2701
2702
2703
2704
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 2701

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

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

Returns information about the specified global table.

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

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.replication_group[0].replica_status #=> String, one of "CREATING", "CREATION_FAILED", "UPDATING", "DELETING", "ACTIVE", "REGION_DISABLED", "INACCESSIBLE_ENCRYPTION_CREDENTIALS"
resp.global_table_description.replication_group[0].replica_status_description #=> String
resp.global_table_description.replication_group[0].replica_status_percent_progress #=> String
resp.global_table_description.replication_group[0].kms_master_key_id #=> String
resp.global_table_description.replication_group[0].provisioned_throughput_override.read_capacity_units #=> Integer
resp.global_table_description.replication_group[0].on_demand_throughput_override.max_read_request_units #=> Integer
resp.global_table_description.replication_group[0].warm_throughput.read_units_per_second #=> Integer
resp.global_table_description.replication_group[0].warm_throughput.write_units_per_second #=> Integer
resp.global_table_description.replication_group[0].warm_throughput.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS", "ARCHIVING", "ARCHIVED"
resp.global_table_description.replication_group[0].global_secondary_indexes #=> Array
resp.global_table_description.replication_group[0].global_secondary_indexes[0].index_name #=> String
resp.global_table_description.replication_group[0].global_secondary_indexes[0].provisioned_throughput_override.read_capacity_units #=> Integer
resp.global_table_description.replication_group[0].global_secondary_indexes[0].on_demand_throughput_override.max_read_request_units #=> Integer
resp.global_table_description.replication_group[0].global_secondary_indexes[0].warm_throughput.read_units_per_second #=> Integer
resp.global_table_description.replication_group[0].global_secondary_indexes[0].warm_throughput.write_units_per_second #=> Integer
resp.global_table_description.replication_group[0].global_secondary_indexes[0].warm_throughput.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.global_table_description.replication_group[0].replica_inaccessible_date_time #=> Time
resp.global_table_description.replication_group[0].replica_table_class_summary.table_class #=> String, one of "STANDARD", "STANDARD_INFREQUENT_ACCESS"
resp.global_table_description.replication_group[0].replica_table_class_summary.last_update_date_time #=> Time
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:



2770
2771
2772
2773
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 2770

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.

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

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", "CREATION_FAILED", "UPDATING", "DELETING", "ACTIVE", "REGION_DISABLED", "INACCESSIBLE_ENCRYPTION_CREDENTIALS"
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
resp.replica_settings[0].replica_table_class_summary.table_class #=> String, one of "STANDARD", "STANDARD_INFREQUENT_ACCESS"
resp.replica_settings[0].replica_table_class_summary.last_update_date_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :global_table_name (required, String)

    The name of the global table to describe.

Returns:

See Also:



2870
2871
2872
2873
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 2870

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

#describe_import(params = {}) ⇒ Types::DescribeImportOutput

Represents the properties of the import.

Examples:

Request syntax with placeholder values


resp = client.describe_import({
  import_arn: "ImportArn", # required
})

Response structure


resp.import_table_description.import_arn #=> String
resp.import_table_description.import_status #=> String, one of "IN_PROGRESS", "COMPLETED", "CANCELLING", "CANCELLED", "FAILED"
resp.import_table_description.table_arn #=> String
resp.import_table_description.table_id #=> String
resp.import_table_description.client_token #=> String
resp.import_table_description.s3_bucket_source.s3_bucket_owner #=> String
resp.import_table_description.s3_bucket_source.s3_bucket #=> String
resp.import_table_description.s3_bucket_source.s3_key_prefix #=> String
resp.import_table_description.error_count #=> Integer
resp.import_table_description.cloud_watch_log_group_arn #=> String
resp.import_table_description.input_format #=> String, one of "DYNAMODB_JSON", "ION", "CSV"
resp.import_table_description.input_format_options.csv.delimiter #=> String
resp.import_table_description.input_format_options.csv.header_list #=> Array
resp.import_table_description.input_format_options.csv.header_list[0] #=> String
resp.import_table_description.input_compression_type #=> String, one of "GZIP", "ZSTD", "NONE"
resp.import_table_description.table_creation_parameters.table_name #=> String
resp.import_table_description.table_creation_parameters.attribute_definitions #=> Array
resp.import_table_description.table_creation_parameters.attribute_definitions[0].attribute_name #=> String
resp.import_table_description.table_creation_parameters.attribute_definitions[0].attribute_type #=> String, one of "S", "N", "B"
resp.import_table_description.table_creation_parameters.key_schema #=> Array
resp.import_table_description.table_creation_parameters.key_schema[0].attribute_name #=> String
resp.import_table_description.table_creation_parameters.key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.import_table_description.table_creation_parameters.billing_mode #=> String, one of "PROVISIONED", "PAY_PER_REQUEST"
resp.import_table_description.table_creation_parameters.provisioned_throughput.read_capacity_units #=> Integer
resp.import_table_description.table_creation_parameters.provisioned_throughput.write_capacity_units #=> Integer
resp.import_table_description.table_creation_parameters.on_demand_throughput.max_read_request_units #=> Integer
resp.import_table_description.table_creation_parameters.on_demand_throughput.max_write_request_units #=> Integer
resp.import_table_description.table_creation_parameters.sse_specification.enabled #=> Boolean
resp.import_table_description.table_creation_parameters.sse_specification.sse_type #=> String, one of "AES256", "KMS"
resp.import_table_description.table_creation_parameters.sse_specification.kms_master_key_id #=> String
resp.import_table_description.table_creation_parameters.global_secondary_indexes #=> Array
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].index_name #=> String
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].key_schema #=> Array
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].provisioned_throughput.read_capacity_units #=> Integer
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].provisioned_throughput.write_capacity_units #=> Integer
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].on_demand_throughput.max_read_request_units #=> Integer
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].on_demand_throughput.max_write_request_units #=> Integer
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].warm_throughput.read_units_per_second #=> Integer
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].warm_throughput.write_units_per_second #=> Integer
resp.import_table_description.start_time #=> Time
resp.import_table_description.end_time #=> Time
resp.import_table_description.processed_size_bytes #=> Integer
resp.import_table_description.processed_item_count #=> Integer
resp.import_table_description.imported_item_count #=> Integer
resp.import_table_description.failure_code #=> String
resp.import_table_description.failure_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :import_arn (required, String)

    The Amazon Resource Name (ARN) associated with the table you're importing to.

Returns:

See Also:



2949
2950
2951
2952
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 2949

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

#describe_kinesis_streaming_destination(params = {}) ⇒ Types::DescribeKinesisStreamingDestinationOutput

Returns information about the status of Kinesis streaming.

Examples:

Request syntax with placeholder values


resp = client.describe_kinesis_streaming_destination({
  table_name: "TableArn", # required
})

Response structure


resp.table_name #=> String
resp.kinesis_data_stream_destinations #=> Array
resp.kinesis_data_stream_destinations[0].stream_arn #=> String
resp.kinesis_data_stream_destinations[0].destination_status #=> String, one of "ENABLING", "ACTIVE", "DISABLING", "DISABLED", "ENABLE_FAILED", "UPDATING"
resp.kinesis_data_stream_destinations[0].destination_status_description #=> String
resp.kinesis_data_stream_destinations[0].approximate_creation_date_time_precision #=> String, one of "MILLISECOND", "MICROSECOND"

Parameters:

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

    ({})

Options Hash (params):

  • :table_name (required, String)

    The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Returns:

See Also:



2984
2985
2986
2987
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 2984

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

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

Returns the current provisioned-capacity quotas for your Amazon Web Services 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 Amazon Web Services account, the account has initial quotas 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 quotas that apply when you create a table there. For more information, see Service, Account, and Table Quotas page in the Amazon DynamoDB Developer Guide.

Although you can increase these quotas by filing a case at Amazon Web Services 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 quotas imposed by your account so that you have enough time to apply for an increase before you hit a quota.

For example, you could use one of the Amazon Web Services SDKs to do the following:

  1. Call DescribeLimits for a particular Region to obtain your current account quotas 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 quotas 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 quotas.

The per-table quotas 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 doesn't let you increase provisioned capacity extremely rapidly, but the only quota that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account quotas.

DescribeLimits should only be called periodically. You can expect throttling errors if you call it more than once in a minute.

The DescribeLimits Request element has no content.

Examples:

Example: To determine capacity limits per table and account, in the current AWS region


# The following example returns the maximum read and write capacity units per table, and for the AWS account, in the
# current AWS region.

resp = client.describe_limits({
})

resp.to_h outputs the following:
{
  account_max_read_capacity_units: 20000, 
  account_max_write_capacity_units: 20000, 
  table_max_read_capacity_units: 10000, 
  table_max_write_capacity_units: 10000, 
}

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:



3093
3094
3095
3096
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 3093

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.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

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.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • table_exists
  • table_not_exists

Examples:

Example: To describe a table


# This example describes the Music table.

resp = client.describe_table({
  table_name: "Music", 
})

resp.to_h outputs the following:
{
  table: {
    attribute_definitions: [
      {
        attribute_name: "Artist", 
        attribute_type: "S", 
      }, 
      {
        attribute_name: "SongTitle", 
        attribute_type: "S", 
      }, 
    ], 
    creation_date_time: Time.parse("1421866952.062"), 
    item_count: 0, 
    key_schema: [
      {
        attribute_name: "Artist", 
        key_type: "HASH", 
      }, 
      {
        attribute_name: "SongTitle", 
        key_type: "RANGE", 
      }, 
    ], 
    provisioned_throughput: {
      number_of_decreases_today: 1, 
      read_capacity_units: 5, 
      write_capacity_units: 5, 
    }, 
    table_name: "Music", 
    table_size_bytes: 0, 
    table_status: "ACTIVE", 
  }, 
}

Request syntax with placeholder values


resp = client.describe_table({
  table_name: "TableArn", # 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", "INACCESSIBLE_ENCRYPTION_CREDENTIALS", "ARCHIVING", "ARCHIVED"
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.global_secondary_indexes[0].on_demand_throughput.max_read_request_units #=> Integer
resp.table.global_secondary_indexes[0].on_demand_throughput.max_write_request_units #=> Integer
resp.table.global_secondary_indexes[0].warm_throughput.read_units_per_second #=> Integer
resp.table.global_secondary_indexes[0].warm_throughput.write_units_per_second #=> Integer
resp.table.global_secondary_indexes[0].warm_throughput.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
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.global_table_version #=> String
resp.table.replicas #=> Array
resp.table.replicas[0].region_name #=> String
resp.table.replicas[0].replica_status #=> String, one of "CREATING", "CREATION_FAILED", "UPDATING", "DELETING", "ACTIVE", "REGION_DISABLED", "INACCESSIBLE_ENCRYPTION_CREDENTIALS"
resp.table.replicas[0].replica_status_description #=> String
resp.table.replicas[0].replica_status_percent_progress #=> String
resp.table.replicas[0].kms_master_key_id #=> String
resp.table.replicas[0].provisioned_throughput_override.read_capacity_units #=> Integer
resp.table.replicas[0].on_demand_throughput_override.max_read_request_units #=> Integer
resp.table.replicas[0].warm_throughput.read_units_per_second #=> Integer
resp.table.replicas[0].warm_throughput.write_units_per_second #=> Integer
resp.table.replicas[0].warm_throughput.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS", "ARCHIVING", "ARCHIVED"
resp.table.replicas[0].global_secondary_indexes #=> Array
resp.table.replicas[0].global_secondary_indexes[0].index_name #=> String
resp.table.replicas[0].global_secondary_indexes[0].provisioned_throughput_override.read_capacity_units #=> Integer
resp.table.replicas[0].global_secondary_indexes[0].on_demand_throughput_override.max_read_request_units #=> Integer
resp.table.replicas[0].global_secondary_indexes[0].warm_throughput.read_units_per_second #=> Integer
resp.table.replicas[0].global_secondary_indexes[0].warm_throughput.write_units_per_second #=> Integer
resp.table.replicas[0].global_secondary_indexes[0].warm_throughput.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.table.replicas[0].replica_inaccessible_date_time #=> Time
resp.table.replicas[0].replica_table_class_summary.table_class #=> String, one of "STANDARD", "STANDARD_INFREQUENT_ACCESS"
resp.table.replicas[0].replica_table_class_summary.last_update_date_time #=> Time
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
resp.table.sse_description.inaccessible_encryption_date_time #=> Time
resp.table.archival_summary.archival_date_time #=> Time
resp.table.archival_summary.archival_reason #=> String
resp.table.archival_summary.archival_backup_arn #=> String
resp.table.table_class_summary.table_class #=> String, one of "STANDARD", "STANDARD_INFREQUENT_ACCESS"
resp.table.table_class_summary.last_update_date_time #=> Time
resp.table.deletion_protection_enabled #=> Boolean
resp.table.on_demand_throughput.max_read_request_units #=> Integer
resp.table.on_demand_throughput.max_write_request_units #=> Integer
resp.table.warm_throughput.read_units_per_second #=> Integer
resp.table.warm_throughput.write_units_per_second #=> Integer
resp.table.warm_throughput.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS", "ARCHIVING", "ARCHIVED"
resp.table.multi_region_consistency #=> String, one of "EVENTUAL", "STRONG"

Parameters:

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

    ({})

Options Hash (params):

  • :table_name (required, String)

    The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Returns:

See Also:



3286
3287
3288
3289
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 3286

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

#describe_table_replica_auto_scaling(params = {}) ⇒ Types::DescribeTableReplicaAutoScalingOutput

Describes auto scaling settings across replicas of the global table at once.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

Examples:

Request syntax with placeholder values


resp = client.describe_table_replica_auto_scaling({
  table_name: "TableArn", # required
})

Response structure


resp.table_auto_scaling_description.table_name #=> String
resp.table_auto_scaling_description.table_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS", "ARCHIVING", "ARCHIVED"
resp.table_auto_scaling_description.replicas #=> Array
resp.table_auto_scaling_description.replicas[0].region_name #=> String
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes #=> Array
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].index_name #=> String
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].index_status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE"
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_read_capacity_auto_scaling_settings.minimum_units #=> Integer
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_read_capacity_auto_scaling_settings.maximum_units #=> Integer
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_read_capacity_auto_scaling_settings.auto_scaling_disabled #=> Boolean
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_read_capacity_auto_scaling_settings.auto_scaling_role_arn #=> String
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies #=> Array
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].policy_name #=> String
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.disable_scale_in #=> Boolean
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_in_cooldown #=> Integer
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_out_cooldown #=> Integer
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.target_value #=> Float
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_write_capacity_auto_scaling_settings.minimum_units #=> Integer
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_write_capacity_auto_scaling_settings.maximum_units #=> Integer
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_write_capacity_auto_scaling_settings.auto_scaling_disabled #=> Boolean
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_write_capacity_auto_scaling_settings.auto_scaling_role_arn #=> String
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies #=> Array
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].policy_name #=> String
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.disable_scale_in #=> Boolean
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_in_cooldown #=> Integer
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_out_cooldown #=> Integer
resp.table_auto_scaling_description.replicas[0].global_secondary_indexes[0].provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.target_value #=> Float
resp.table_auto_scaling_description.replicas[0].replica_provisioned_read_capacity_auto_scaling_settings.minimum_units #=> Integer
resp.table_auto_scaling_description.replicas[0].replica_provisioned_read_capacity_auto_scaling_settings.maximum_units #=> Integer
resp.table_auto_scaling_description.replicas[0].replica_provisioned_read_capacity_auto_scaling_settings.auto_scaling_disabled #=> Boolean
resp.table_auto_scaling_description.replicas[0].replica_provisioned_read_capacity_auto_scaling_settings.auto_scaling_role_arn #=> String
resp.table_auto_scaling_description.replicas[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies #=> Array
resp.table_auto_scaling_description.replicas[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].policy_name #=> String
resp.table_auto_scaling_description.replicas[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.disable_scale_in #=> Boolean
resp.table_auto_scaling_description.replicas[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_in_cooldown #=> Integer
resp.table_auto_scaling_description.replicas[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_out_cooldown #=> Integer
resp.table_auto_scaling_description.replicas[0].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.target_value #=> Float
resp.table_auto_scaling_description.replicas[0].replica_provisioned_write_capacity_auto_scaling_settings.minimum_units #=> Integer
resp.table_auto_scaling_description.replicas[0].replica_provisioned_write_capacity_auto_scaling_settings.maximum_units #=> Integer
resp.table_auto_scaling_description.replicas[0].replica_provisioned_write_capacity_auto_scaling_settings.auto_scaling_disabled #=> Boolean
resp.table_auto_scaling_description.replicas[0].replica_provisioned_write_capacity_auto_scaling_settings.auto_scaling_role_arn #=> String
resp.table_auto_scaling_description.replicas[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies #=> Array
resp.table_auto_scaling_description.replicas[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].policy_name #=> String
resp.table_auto_scaling_description.replicas[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.disable_scale_in #=> Boolean
resp.table_auto_scaling_description.replicas[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_in_cooldown #=> Integer
resp.table_auto_scaling_description.replicas[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_out_cooldown #=> Integer
resp.table_auto_scaling_description.replicas[0].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[0].target_tracking_scaling_policy_configuration.target_value #=> Float
resp.table_auto_scaling_description.replicas[0].replica_status #=> String, one of "CREATING", "CREATION_FAILED", "UPDATING", "DELETING", "ACTIVE", "REGION_DISABLED", "INACCESSIBLE_ENCRYPTION_CREDENTIALS"

Parameters:

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

    ({})

Options Hash (params):

  • :table_name (required, String)

    The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Returns:

See Also:



3366
3367
3368
3369
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 3366

def describe_table_replica_auto_scaling(params = {}, options = {})
  req = build_request(:describe_table_replica_auto_scaling, 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: "TableArn", # 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. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Returns:

See Also:



3397
3398
3399
3400
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 3397

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

#disable_kinesis_streaming_destination(params = {}) ⇒ Types::KinesisStreamingDestinationOutput

Stops replication from the DynamoDB table to the Kinesis data stream. This is done without deleting either of the resources.

Examples:

Request syntax with placeholder values


resp = client.disable_kinesis_streaming_destination({
  table_name: "TableArn", # required
  stream_arn: "StreamArn", # required
  enable_kinesis_streaming_configuration: {
    approximate_creation_date_time_precision: "MILLISECOND", # accepts MILLISECOND, MICROSECOND
  },
})

Response structure


resp.table_name #=> String
resp.stream_arn #=> String
resp.destination_status #=> String, one of "ENABLING", "ACTIVE", "DISABLING", "DISABLED", "ENABLE_FAILED", "UPDATING"
resp.enable_kinesis_streaming_configuration.approximate_creation_date_time_precision #=> String, one of "MILLISECOND", "MICROSECOND"

Parameters:

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

    ({})

Options Hash (params):

  • :table_name (required, String)

    The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

  • :stream_arn (required, String)

    The ARN for a Kinesis data stream.

  • :enable_kinesis_streaming_configuration (Types::EnableKinesisStreamingConfiguration)

    The source for the Kinesis streaming information that is being enabled.

Returns:

See Also:



3444
3445
3446
3447
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 3444

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

#enable_kinesis_streaming_destination(params = {}) ⇒ Types::KinesisStreamingDestinationOutput

Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow. If this operation doesn't return results immediately, use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream is ACTIVE.

Examples:

Request syntax with placeholder values


resp = client.enable_kinesis_streaming_destination({
  table_name: "TableArn", # required
  stream_arn: "StreamArn", # required
  enable_kinesis_streaming_configuration: {
    approximate_creation_date_time_precision: "MILLISECOND", # accepts MILLISECOND, MICROSECOND
  },
})

Response structure


resp.table_name #=> String
resp.stream_arn #=> String
resp.destination_status #=> String, one of "ENABLING", "ACTIVE", "DISABLING", "DISABLED", "ENABLE_FAILED", "UPDATING"
resp.enable_kinesis_streaming_configuration.approximate_creation_date_time_precision #=> String, one of "MILLISECOND", "MICROSECOND"

Parameters:

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

    ({})

Options Hash (params):

  • :table_name (required, String)

    The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

  • :stream_arn (required, String)

    The ARN for a Kinesis data stream.

  • :enable_kinesis_streaming_configuration (Types::EnableKinesisStreamingConfiguration)

    The source for the Kinesis streaming information that is being enabled.

Returns:

See Also:



3494
3495
3496
3497
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 3494

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

#execute_statement(params = {}) ⇒ Types::ExecuteStatementOutput

This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.

For PartiQL reads (SELECT statement), if the total number of processed items exceeds the maximum dataset size limit of 1 MB, the read stops and results are returned to the user as a LastEvaluatedKey value to continue the read in a subsequent operation. If the filter criteria in WHERE clause does not match any data, the read will return an empty result set.

A single SELECT statement response can return up to the maximum number of items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any filtering to the results using WHERE clause). If LastEvaluatedKey is present in the response, you need to paginate the result set. If NextToken is present, you need to paginate the result set and include NextToken.

Examples:

Request syntax with placeholder values


resp = client.execute_statement({
  statement: "PartiQLStatement", # required
  parameters: ["value"], # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  consistent_read: false,
  next_token: "PartiQLNextToken",
  return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
  limit: 1,
  return_values_on_condition_check_failure: "ALL_OLD", # accepts ALL_OLD, NONE
})

Response structure


resp.items #=> Array
resp.items[0] #=> Hash
resp.items[0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.next_token #=> String
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.last_evaluated_key #=> Hash
resp.last_evaluated_key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>

Parameters:

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

    ({})

Options Hash (params):

  • :statement (required, String)

    The PartiQL statement representing the operation to run.

  • :parameters (Array<Types::AttributeValue>)

    The parameters for the PartiQL statement, if any.

  • :consistent_read (Boolean)

    The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

  • :next_token (String)

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

  • :return_consumed_capacity (String)

    Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

    • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

      Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

    • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

    • NONE - No ConsumedCapacity details are included in the response.

  • :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, along with a key in LastEvaluatedKey to apply in a subsequent operation so you can pick up where you left off. Also, if the processed dataset 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.

  • :return_values_on_condition_check_failure (String)

    An optional parameter that returns the item attributes for an ExecuteStatement operation that failed a condition check.

    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.

Returns:

See Also:



3615
3616
3617
3618
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 3615

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

#execute_transaction(params = {}) ⇒ Types::ExecuteTransactionOutput

This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.

The entire transaction must consist of either read statements or write statements, you cannot mix both in one transaction. The EXISTS function is an exception and can be used to check the condition of specific attributes of the item in a similar manner to ConditionCheck in the TransactWriteItems API.

Examples:

Request syntax with placeholder values


resp = client.execute_transaction({
  transact_statements: [ # required
    {
      statement: "PartiQLStatement", # required
      parameters: ["value"], # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
      return_values_on_condition_check_failure: "ALL_OLD", # accepts ALL_OLD, NONE
    },
  ],
  client_request_token: "ClientRequestToken",
  return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
})

Response structure


resp.responses #=> Array
resp.responses[0].item #=> Hash
resp.responses[0].item["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
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):

  • :transact_statements (required, Array<Types::ParameterizedStatement>)

    The list of PartiQL statements representing the transaction to run.

  • :client_request_token (String)

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

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

  • :return_consumed_capacity (String)

    Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response. For more information, see TransactGetItems and TransactWriteItems.

Returns:

See Also:



3700
3701
3702
3703
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 3700

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

#export_table_to_point_in_time(params = {}) ⇒ Types::ExportTableToPointInTimeOutput

Exports table data to an S3 bucket. The table must have point in time recovery enabled, and you can export data from any time within the point in time recovery window.

Examples:

Request syntax with placeholder values


resp = client.export_table_to_point_in_time({
  table_arn: "TableArn", # required
  export_time: Time.now,
  client_token: "ClientToken",
  s3_bucket: "S3Bucket", # required
  s3_bucket_owner: "S3BucketOwner",
  s3_prefix: "S3Prefix",
  s3_sse_algorithm: "AES256", # accepts AES256, KMS
  s3_sse_kms_key_id: "S3SseKmsKeyId",
  export_format: "DYNAMODB_JSON", # accepts DYNAMODB_JSON, ION
  export_type: "FULL_EXPORT", # accepts FULL_EXPORT, INCREMENTAL_EXPORT
  incremental_export_specification: {
    export_from_time: Time.now,
    export_to_time: Time.now,
    export_view_type: "NEW_IMAGE", # accepts NEW_IMAGE, NEW_AND_OLD_IMAGES
  },
})

Response structure


resp.export_description.export_arn #=> String
resp.export_description.export_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
resp.export_description.start_time #=> Time
resp.export_description.end_time #=> Time
resp.export_description.export_manifest #=> String
resp.export_description.table_arn #=> String
resp.export_description.table_id #=> String
resp.export_description.export_time #=> Time
resp.export_description.client_token #=> String
resp.export_description.s3_bucket #=> String
resp.export_description.s3_bucket_owner #=> String
resp.export_description.s3_prefix #=> String
resp.export_description.s3_sse_algorithm #=> String, one of "AES256", "KMS"
resp.export_description.s3_sse_kms_key_id #=> String
resp.export_description.failure_code #=> String
resp.export_description.failure_message #=> String
resp.export_description.export_format #=> String, one of "DYNAMODB_JSON", "ION"
resp.export_description.billed_size_bytes #=> Integer
resp.export_description.item_count #=> Integer
resp.export_description.export_type #=> String, one of "FULL_EXPORT", "INCREMENTAL_EXPORT"
resp.export_description.incremental_export_specification.export_from_time #=> Time
resp.export_description.incremental_export_specification.export_to_time #=> Time
resp.export_description.incremental_export_specification.export_view_type #=> String, one of "NEW_IMAGE", "NEW_AND_OLD_IMAGES"

Parameters:

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

    ({})

Options Hash (params):

  • :table_arn (required, String)

    The Amazon Resource Name (ARN) associated with the table to export.

  • :export_time (Time, DateTime, Date, Integer, String)

    Time in the past from which to export table data, counted in seconds from the start of the Unix epoch. The table export will be a snapshot of the table's state at this point in time.

  • :client_token (String)

    Providing a ClientToken makes the call to ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect as one single call.

    A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, 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 8 hours, or the result might not be idempotent.

    If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an ImportConflictException.

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

  • :s3_bucket (required, String)

    The name of the Amazon S3 bucket to export the snapshot to.

  • :s3_bucket_owner (String)

    The ID of the Amazon Web Services account that owns the bucket the export will be stored in.

    S3BucketOwner is a required parameter when exporting to a S3 bucket in another account.

  • :s3_prefix (String)

    The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

  • :s3_sse_algorithm (String)

    Type of encryption used on the bucket where export data will be stored. Valid values for S3SseAlgorithm are:

    • AES256 - server-side encryption with Amazon S3 managed keys

    • KMS - server-side encryption with KMS managed keys

  • :s3_sse_kms_key_id (String)

    The ID of the KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

  • :export_format (String)

    The format for the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.

  • :export_type (String)

    Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.

  • :incremental_export_specification (Types::IncrementalExportSpecification)

    Optional object containing the parameters specific to an incremental export.

Returns:

See Also:



3831
3832
3833
3834
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 3831

def export_table_to_point_in_time(params = {}, options = {})
  req = build_request(:export_table_to_point_in_time, 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:

Example: To read an item from a table


# This example retrieves an item from the Music table. The table has a partition key and a sort key (Artist and
# SongTitle), so you must specify both of these attributes.

resp = client.get_item({
  key: {
    "Artist" => "Acme Band", 
    "SongTitle" => "Happy Day", 
  }, 
  table_name: "Music", 
})

resp.to_h outputs the following:
{
  item: {
    "AlbumTitle" => "Songs About Life", 
    "Artist" => "Acme Band", 
    "SongTitle" => "Happy Day", 
  }, 
}

Request syntax with placeholder values


resp = client.get_item({
  table_name: "TableArn", # 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. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

  • :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.

  • :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 either provisioned or on-demand throughput consumption that is returned in the response:

    • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

      Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

    • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

    • NONE - No ConsumedCapacity details are included in the response.

  • :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 are returned. If any of the requested attributes are not found, they do not appear in the result.

    For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

  • :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

    ^

    Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

    For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

Returns:

See Also:



4026
4027
4028
4029
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 4026

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

#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyOutput

Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.

GetResourcePolicy follows an eventually consistent model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request:

  • If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException.

  • If you issue a GetResourcePolicyrequest immediately after a DeleteResourcePolicy request, DynamoDB might return the policy that was present before the deletion request.

  • If you issue a GetResourcePolicy request immediately after a CreateTable request, which includes a resource-based policy, DynamoDB might return a ResourceNotFoundException or a PolicyNotFoundException.

Because GetResourcePolicy uses an eventually consistent query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request.

After a GetResourcePolicy request returns a policy created using the PutResourcePolicy request, the policy will be applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the CreateTable request will always be applied to all requests for that table.

Examples:

Request syntax with placeholder values


resp = client.get_resource_policy({
  resource_arn: "ResourceArnString", # required
})

Response structure


resp.policy #=> String
resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy is attached. The resources you can specify include tables and streams.

Returns:

See Also:



4093
4094
4095
4096
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 4093

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

#import_table(params = {}) ⇒ Types::ImportTableOutput

Imports table data from an S3 bucket.

Examples:

Request syntax with placeholder values


resp = client.import_table({
  client_token: "ClientToken",
  s3_bucket_source: { # required
    s3_bucket_owner: "S3BucketOwner",
    s3_bucket: "S3Bucket", # required
    s3_key_prefix: "S3Prefix",
  },
  input_format: "DYNAMODB_JSON", # required, accepts DYNAMODB_JSON, ION, CSV
  input_format_options: {
    csv: {
      delimiter: "CsvDelimiter",
      header_list: ["CsvHeader"],
    },
  },
  input_compression_type: "GZIP", # accepts GZIP, ZSTD, NONE
  table_creation_parameters: { # required
    table_name: "TableName", # required
    attribute_definitions: [ # required
      {
        attribute_name: "KeySchemaAttributeName", # required
        attribute_type: "S", # required, accepts S, N, B
      },
    ],
    key_schema: [ # required
      {
        attribute_name: "KeySchemaAttributeName", # required
        key_type: "HASH", # required, accepts HASH, RANGE
      },
    ],
    billing_mode: "PROVISIONED", # accepts PROVISIONED, PAY_PER_REQUEST
    provisioned_throughput: {
      read_capacity_units: 1, # required
      write_capacity_units: 1, # required
    },
    on_demand_throughput: {
      max_read_request_units: 1,
      max_write_request_units: 1,
    },
    sse_specification: {
      enabled: false,
      sse_type: "AES256", # accepts AES256, KMS
      kms_master_key_id: "KMSMasterKeyId",
    },
    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
        },
        on_demand_throughput: {
          max_read_request_units: 1,
          max_write_request_units: 1,
        },
        warm_throughput: {
          read_units_per_second: 1,
          write_units_per_second: 1,
        },
      },
    ],
  },
})

Response structure


resp.import_table_description.import_arn #=> String
resp.import_table_description.import_status #=> String, one of "IN_PROGRESS", "COMPLETED", "CANCELLING", "CANCELLED", "FAILED"
resp.import_table_description.table_arn #=> String
resp.import_table_description.table_id #=> String
resp.import_table_description.client_token #=> String
resp.import_table_description.s3_bucket_source.s3_bucket_owner #=> String
resp.import_table_description.s3_bucket_source.s3_bucket #=> String
resp.import_table_description.s3_bucket_source.s3_key_prefix #=> String
resp.import_table_description.error_count #=> Integer
resp.import_table_description.cloud_watch_log_group_arn #=> String
resp.import_table_description.input_format #=> String, one of "DYNAMODB_JSON", "ION", "CSV"
resp.import_table_description.input_format_options.csv.delimiter #=> String
resp.import_table_description.input_format_options.csv.header_list #=> Array
resp.import_table_description.input_format_options.csv.header_list[0] #=> String
resp.import_table_description.input_compression_type #=> String, one of "GZIP", "ZSTD", "NONE"
resp.import_table_description.table_creation_parameters.table_name #=> String
resp.import_table_description.table_creation_parameters.attribute_definitions #=> Array
resp.import_table_description.table_creation_parameters.attribute_definitions[0].attribute_name #=> String
resp.import_table_description.table_creation_parameters.attribute_definitions[0].attribute_type #=> String, one of "S", "N", "B"
resp.import_table_description.table_creation_parameters.key_schema #=> Array
resp.import_table_description.table_creation_parameters.key_schema[0].attribute_name #=> String
resp.import_table_description.table_creation_parameters.key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.import_table_description.table_creation_parameters.billing_mode #=> String, one of "PROVISIONED", "PAY_PER_REQUEST"
resp.import_table_description.table_creation_parameters.provisioned_throughput.read_capacity_units #=> Integer
resp.import_table_description.table_creation_parameters.provisioned_throughput.write_capacity_units #=> Integer
resp.import_table_description.table_creation_parameters.on_demand_throughput.max_read_request_units #=> Integer
resp.import_table_description.table_creation_parameters.on_demand_throughput.max_write_request_units #=> Integer
resp.import_table_description.table_creation_parameters.sse_specification.enabled #=> Boolean
resp.import_table_description.table_creation_parameters.sse_specification.sse_type #=> String, one of "AES256", "KMS"
resp.import_table_description.table_creation_parameters.sse_specification.kms_master_key_id #=> String
resp.import_table_description.table_creation_parameters.global_secondary_indexes #=> Array
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].index_name #=> String
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].key_schema #=> Array
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].key_schema[0].attribute_name #=> String
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].projection.projection_type #=> String, one of "ALL", "KEYS_ONLY", "INCLUDE"
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].projection.non_key_attributes #=> Array
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].projection.non_key_attributes[0] #=> String
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].provisioned_throughput.read_capacity_units #=> Integer
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].provisioned_throughput.write_capacity_units #=> Integer
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].on_demand_throughput.max_read_request_units #=> Integer
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].on_demand_throughput.max_write_request_units #=> Integer
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].warm_throughput.read_units_per_second #=> Integer
resp.import_table_description.table_creation_parameters.global_secondary_indexes[0].warm_throughput.write_units_per_second #=> Integer
resp.import_table_description.start_time #=> Time
resp.import_table_description.end_time #=> Time
resp.import_table_description.processed_size_bytes #=> Integer
resp.import_table_description.processed_item_count #=> Integer
resp.import_table_description.imported_item_count #=> Integer
resp.import_table_description.failure_code #=> String
resp.import_table_description.failure_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Providing a ClientToken makes the call to ImportTableInput idempotent, meaning that multiple identical calls have the same effect as one single call.

    A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, 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 8 hours, or the result might not be idempotent.

    If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

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

  • :s3_bucket_source (required, Types::S3BucketSource)

    The S3 bucket that provides the source for the import.

  • :input_format (required, String)

    The format of the source data. Valid values for ImportFormat are CSV, DYNAMODB_JSON or ION.

  • :input_format_options (Types::InputFormatOptions)

    Additional properties that specify how the input is formatted,

  • :input_compression_type (String)

    Type of compression to be used on the input coming from the imported table.

  • :table_creation_parameters (required, Types::TableCreationParameters)

    Parameters for the table to import the data into.

Returns:

See Also:



4272
4273
4274
4275
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 4272

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

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

List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup. To list these backups for a given table, specify TableName. ListBackups returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a 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 boundaries are for the time at which the original backup was requested.

You can call ListBackups a maximum of five times per second.

If you want to retrieve the complete list of backups made with Amazon Web Services Backup, use the Amazon Web Services Backup list API.

Examples:

Request syntax with placeholder values


resp = client.list_backups({
  table_name: "TableArn",
  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)

    Lists the backups from the table specified in TableName. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

  • :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 Amazon Resource Name (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. (The default setting if no other backup types are specified.)

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

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

Returns:

See Also:



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

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

#list_contributor_insights(params = {}) ⇒ Types::ListContributorInsightsOutput

Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_contributor_insights({
  table_name: "TableArn",
  next_token: "NextTokenString",
  max_results: 1,
})

Response structure


resp.contributor_insights_summaries #=> Array
resp.contributor_insights_summaries[0].table_name #=> String
resp.contributor_insights_summaries[0].index_name #=> String
resp.contributor_insights_summaries[0].contributor_insights_status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED", "FAILED"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :table_name (String)

    The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

  • :next_token (String)

    A token to for the desired page, if there is one.

  • :max_results (Integer)

    Maximum number of results to return per page.

Returns:

See Also:



4412
4413
4414
4415
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 4412

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

#list_exports(params = {}) ⇒ Types::ListExportsOutput

Lists completed exports within the past 90 days.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_exports({
  table_arn: "TableArn",
  max_results: 1,
  next_token: "ExportNextToken",
})

Response structure


resp.export_summaries #=> Array
resp.export_summaries[0].export_arn #=> String
resp.export_summaries[0].export_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
resp.export_summaries[0].export_type #=> String, one of "FULL_EXPORT", "INCREMENTAL_EXPORT"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :table_arn (String)

    The Amazon Resource Name (ARN) associated with the exported table.

  • :max_results (Integer)

    Maximum number of results to return per page.

  • :next_token (String)

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

Returns:

See Also:



4457
4458
4459
4460
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 4457

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

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

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

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

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, if the parameter is not specified DynamoDB defaults to 100.

    If the number of global tables DynamoDB finds reaches this limit, it stops the operation and returns the table names collected up to that point, with a table name in the LastEvaluatedGlobalTableName to apply in a subsequent operation to the ExclusiveStartGlobalTableName parameter.

  • :region_name (String)

    Lists the global tables in a specific Region.

Returns:

See Also:



4522
4523
4524
4525
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 4522

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

#list_imports(params = {}) ⇒ Types::ListImportsOutput

Lists completed imports within the past 90 days.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_imports({
  table_arn: "TableArn",
  page_size: 1,
  next_token: "ImportNextToken",
})

Response structure


resp.import_summary_list #=> Array
resp.import_summary_list[0].import_arn #=> String
resp.import_summary_list[0].import_status #=> String, one of "IN_PROGRESS", "COMPLETED", "CANCELLING", "CANCELLED", "FAILED"
resp.import_summary_list[0].table_arn #=> String
resp.import_summary_list[0].s3_bucket_source.s3_bucket_owner #=> String
resp.import_summary_list[0].s3_bucket_source.s3_bucket #=> String
resp.import_summary_list[0].s3_bucket_source.s3_key_prefix #=> String
resp.import_summary_list[0].cloud_watch_log_group_arn #=> String
resp.import_summary_list[0].input_format #=> String, one of "DYNAMODB_JSON", "ION", "CSV"
resp.import_summary_list[0].start_time #=> Time
resp.import_summary_list[0].end_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :table_arn (String)

    The Amazon Resource Name (ARN) associated with the table that was imported to.

  • :page_size (Integer)

    The number of ImportSummaryobjects returned in a single page.

  • :next_token (String)

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

Returns:

See Also:



4575
4576
4577
4578
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 4575

def list_imports(params = {}, options = {})
  req = build_request(:list_imports, 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list tables


# This example lists all of the tables associated with the current AWS account and endpoint.

resp = client.list_tables({
})

resp.to_h outputs the following:
{
  table_names: [
    "Forum", 
    "ProductCatalog", 
    "Reply", 
    "Thread", 
  ], 
}

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:



4635
4636
4637
4638
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 4635

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.

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:



4682
4683
4684
4685
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 4682

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.

When you add an item, the primary key attributes are the only required attributes.

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. Set type attributes cannot be empty.

Invalid Requests with empty values will be rejected with a ValidationException exception.

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.

For more information about PutItem, see Working with Items in the Amazon DynamoDB Developer Guide.

Examples:

Example: To add an item to a table


# This example adds a new item to the Music table.

resp = client.put_item({
  item: {
    "AlbumTitle" => "Somewhat Famous", 
    "Artist" => "No One You Know", 
    "SongTitle" => "Call Me Today", 
  }, 
  return_consumed_capacity: "TOTAL", 
  table_name: "Music", 
})

resp.to_h outputs the following:
{
  consumed_capacity: {
    capacity_units: 1, 
    table_name: "Music", 
  }, 
}

Request syntax with placeholder values


resp = client.put_item({
  table_name: "TableArn", # 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>
  },
  return_values_on_condition_check_failure: "ALL_OLD", # accepts ALL_OLD, NONE
})

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. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

  • :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.

    Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.

    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.

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

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

  • :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.

    The values returned are strongly consistent.

    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 ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.

  • :return_consumed_capacity (String)

    Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

    • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

      Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

    • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

    • NONE - No ConsumedCapacity details are included in the response.

  • :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.

  • :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 Condition Expressions in the Amazon DynamoDB Developer Guide.

  • :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

    ^

    Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

    For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

  • :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 Condition Expressions in the Amazon DynamoDB Developer Guide.

  • :return_values_on_condition_check_failure (String)

    An optional parameter that returns the item attributes for a PutItem operation that failed a condition check.

    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.

Returns:

See Also:



5011
5012
5013
5014
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 5011

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

#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyOutput

Attaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is eventually consistent .

PutResourcePolicy is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an ExpectedRevisionId that doesn't match the current policy's RevisionId, the PolicyNotFoundException will be returned.

PutResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return your previous policy, if there was one, or return the PolicyNotFoundException. This is because GetResourcePolicy uses an eventually consistent query, and the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then try the GetResourcePolicy request again.

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  resource_arn: "ResourceArnString", # required
  policy: "ResourcePolicy", # required
  expected_revision_id: "PolicyRevisionId",
  confirm_remove_self_resource_access: false,
})

Response structure


resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy will be attached. The resources you can specify include tables and streams.

    You can control index permissions using the base table's policy. To specify the same permission level for your table and its indexes, you can provide both the table and index Amazon Resource Name (ARN)s in the Resource field of a given Statement in your policy document. Alternatively, to specify different permissions for your table, indexes, or both, you can define multiple Statement fields in your policy document.

  • :policy (required, String)

    An Amazon Web Services resource-based policy document in JSON format.

    • The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit.

    • Within a resource-based policy, if the action for a DynamoDB service-linked role (SLR) to replicate data for a global table is denied, adding or deleting a replica will fail with an error.

    For a full list of all considerations that apply while attaching a resource-based policy, see Resource-based policy considerations.

  • :expected_revision_id (String)

    A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy.

    When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, your request will be rejected with a PolicyNotFoundException.

    To conditionally attach a policy when no policy exists for the resource, specify NO_POLICY for the revision ID.

  • :confirm_remove_self_resource_access (Boolean)

    Set this parameter to true to confirm that you want to remove your permissions to change the policy of this resource in the future.

Returns:

See Also:



5112
5113
5114
5115
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb', line 5112

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

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

You must provide the name of the partition key attribute and a single value for that attribute. Query returns all items with that partition key value. Optionally, you can provide a sort key attribute and use a comparison operator to refine the search results.

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.

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.

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.

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.

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To query an item


# This example queries items in the Music table. The table has a partition key and sort key (Artist and SongTitle), but
# this query only specifies the partition key value. It returns song titles by the artist named "No One You Know".

resp = client.query({
  expression_attribute_values: {
    ":v1" => "No One You Know", 
  }, 
  key_condition_expression: "Artist = :v1", 
  projection_expression: "SongTitle", 
  table_name: "Music", 
})

resp.to_h outputs the following:
{
  consumed_capacity: {
  }, 
  count: 2, 
  items: [
    {
      "SongTitle" => "Call Me Today", 
    }, 
  ], 
  scanned_count: 2, 
}

Request syntax with placeholder values


resp = client.query({
  table_name: "TableArn", # 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. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

  • :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 fetches 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. Note that this uses the same quantity of read capacity units as getting the items, and is subject to the same item size calculations.

    • SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression. This return value is equivalent to specifying ProjectionExpression 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 fetches 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 ProjectionExpression 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 ProjectionExpression together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying ProjectionExpression without any value for Select.)

    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.

  • :attributes_to_get (Array<String>)

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

  • :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 dataset 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.

  • :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.

  • :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.

  • :conditional_operator (String)

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

  • :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 either provisioned or on-demand throughput consumption that is returned in the response:

    • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

      Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

    • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

    • NONE - No ConsumedCapacity details are included in the response.

  • :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.

  • :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.

    A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

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

  • :key_condition_expression (String)

    The condition that specifies the key values 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.

  • :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

    ^

    Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

    For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

  • :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.

Returns:

See Also: