Class: Aws::DynamoDB::Table

Inherits:

Object

Object
Aws::DynamoDB::Table

show all

Defined in:: gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

#archival_summary ⇒ Types::ArchivalSummary
Contains information about the table archive.
#attribute_definitions ⇒ Array<Types::AttributeDefinition>
An array of AttributeDefinition objects.
#billing_mode_summary ⇒ Types::BillingModeSummary
Contains the details for the read/write capacity mode.
#creation_date_time ⇒ Time
The date and time when the table was created, in [UNIX epoch time][1] format.
#deletion_protection_enabled ⇒ Boolean
Indicates whether deletion protection is enabled (true) or disabled (false) on the table.
#disassociation_protection_enabled ⇒ Boolean
Specifies whether disassociation protection is enabled (true) or disabled (false) for the local global table replica.
#global_secondary_indexes ⇒ Array<Types::GlobalSecondaryIndexDescription>
The global secondary indexes, if any, on the table.
#global_table_settings_replication_mode ⇒ String
Indicates one of the settings synchronization modes for the global table:.
#global_table_version ⇒ String
Represents the version of [global tables][1] in use, if the table is replicated across Amazon Web Services Regions.
#global_table_witnesses ⇒ Array<Types::GlobalTableWitnessDescription>
The witness Region and its current status in the MRSC global table.
#item_count ⇒ Integer
The number of items in the specified table.
#key_schema ⇒ Array<Types::KeySchemaElement>
The primary key structure for the table.
#latest_stream_arn ⇒ String
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
#latest_stream_label ⇒ String
A timestamp, in ISO 8601 format, for this stream.
#local_secondary_indexes ⇒ Array<Types::LocalSecondaryIndexDescription>
Represents one or more local secondary indexes on the table.
#multi_region_consistency ⇒ String
Indicates one of the following consistency modes for a global table:.
#name ⇒ String (also: #table_name)
#on_demand_throughput ⇒ Types::OnDemandThroughput
The maximum number of read and write units for the specified on-demand table.
#provisioned_throughput ⇒ Types::ProvisionedThroughputDescription
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
#replicas ⇒ Array<Types::ReplicaDescription>
Represents replicas of the table.
#restore_summary ⇒ Types::RestoreSummary
Contains details for the restore.
#sse_description ⇒ Types::SSEDescription
The description of the server-side encryption status on the specified table.
#stream_specification ⇒ Types::StreamSpecification
The current DynamoDB Streams configuration for the table.
#table_arn ⇒ String
The Amazon Resource Name (ARN) that uniquely identifies the table.
#table_class_summary ⇒ Types::TableClassSummary
Contains details of the table class.
#table_id ⇒ String
A unique identifier for the table, in UUID format, generated by DynamoDB when the table is created.
#table_size_bytes ⇒ Integer
The total size of the specified table, in bytes.
#table_status ⇒ String
The current state of the table:.
#vector_indexes ⇒ Array<Types::VectorIndexDescription>
The vector indexes, if any, on the table.
#warm_throughput ⇒ Types::TableWarmThroughputDescription
Describes the warm throughput value of the base table.

Actions collapse

#delete(options = {}) ⇒ Types::DeleteTableOutput
#delete_item(options = {}) ⇒ Types::DeleteItemOutput
#get_item(options = {}) ⇒ Types::GetItemOutput
#put_item(options = {}) ⇒ Types::PutItemOutput
#query(options = {}) ⇒ Types::QueryOutput
#scan(options = {}) ⇒ Types::ScanOutput
#update(options = {}) ⇒ Table
#update_item(options = {}) ⇒ Types::UpdateItemOutput

Instance Method Summary collapse

#client ⇒ Client
#data ⇒ Types::TableDescription
Returns the data for this Table.
#data_loaded? ⇒ Boolean
Returns true if this resource is loaded.
#initialize(*args) ⇒ Table constructor
A new instance of Table.
#load ⇒ self (also: #reload)
Loads, or reloads #data for the current Table.
#wait_until(options = {}) {|resource| ... } ⇒ Resource deprecated Deprecated.
Use [Aws::DynamoDB::Client] #wait_until instead

Constructor Details

#initialize(name, options = {}) ⇒ `Table` #initialize(options = {}) ⇒ `Table`

Returns a new instance of Table.

Overloads:

#initialize(name, options = {}) ⇒ Table
Parameters:
- name (String)
Options Hash (options):
- :client (Client)
#initialize(options = {}) ⇒ Table
Options Hash (options):
- :name (required, String)
- :client (Client)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @name = extract_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#archival_summary ⇒ `Types::ArchivalSummary`

Contains information about the table archive.

Returns:

(Types::ArchivalSummary)



386
387
388

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 386

def archival_summary
  data[:archival_summary]
end

#attribute_definitions ⇒ `Array<Types::AttributeDefinition>`

An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

Each AttributeDefinition object in this array is composed of:

AttributeName - The name of the attribute.
AttributeType - The data type for the attribute.

Returns:

(Array<Types::AttributeDefinition>)



47
48
49

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 47

def attribute_definitions
  data[:attribute_definitions]
end

#billing_mode_summary ⇒ `Types::BillingModeSummary`

Contains the details for the read/write capacity mode.

Returns:

(Types::BillingModeSummary)



161
162
163

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 161

def billing_mode_summary
  data[:billing_mode_summary]
end

#client ⇒ `Client`

Returns:

(Client)



488
489
490

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 488

def client
  @client
end

#creation_date_time ⇒ `Time`

The date and time when the table was created, in UNIX epoch time format.

Returns:

(Time)



118
119
120

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 118

def creation_date_time
  data[:creation_date_time]
end

#data ⇒ `Types::TableDescription`

Returns the data for this Aws::DynamoDB::Table. Calls Client#describe_table if #data_loaded? is false.

Returns:

(Types::TableDescription) —
Returns the data for this Aws::DynamoDB::Table. Calls Client#describe_table if #data_loaded? is false.

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 510

def data
  load unless @data
  @data
end

#data_loaded? ⇒ `Boolean`

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

(Boolean) —
Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



518
519
520

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 518

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ `Types::DeleteTableOutput`

Examples:

Request syntax with placeholder values


table.delete()

Parameters:

options (Hash) (defaults to: {}) —
({})

Returns:

(Types::DeleteTableOutput)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 628

def delete(options = {})
  options = options.merge(table_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_table(options)
  end
  resp.data
end

#delete_item(options = {}) ⇒ `Types::DeleteItemOutput`

Examples:

Request syntax with placeholder values


table.delete_item({
  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
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

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

(Types::DeleteItemOutput)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 832

def delete_item(options = {})
  options = options.merge(table_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_item(options)
  end
  resp.data
end

#deletion_protection_enabled ⇒ `Boolean`

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

Returns:

(Boolean)



399
400
401

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 399

def deletion_protection_enabled
  data[:deletion_protection_enabled]
end

#disassociation_protection_enabled ⇒ `Boolean`

Specifies whether disassociation protection is enabled (true) or disabled (false) for the local global table replica. Protection is enabled by default.

Returns:

(Boolean)



407
408
409

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 407

def disassociation_protection_enabled
  data[:disassociation_protection_enabled]
end

#get_item(options = {}) ⇒ `Types::GetItemOutput`

Examples:

Request syntax with placeholder values


table.get_item({
  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",
  },
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

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

(Types::GetItemOutput)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 957

def get_item(options = {})
  options = options.merge(table_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.get_item(options)
  end
  resp.data
end

#global_secondary_indexes ⇒ `Array<Types::GlobalSecondaryIndexDescription>`

The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)

You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false. (This attribute does not appear for indexes that were created during a CreateTable operation.)
IndexName - The name of the global secondary index.
IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexStatus - The current status of the global secondary index:
- CREATING - The index is being created.
- UPDATING - The index is being updated.
- DELETING - The index is being deleted.
- ACTIVE - The index is ready for use.
ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). 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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
  - 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.

If the table is in the DELETING state, no information about indexes will be returned.

Returns:

(Array<Types::GlobalSecondaryIndexDescription>)



293
294
295

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 293

def global_secondary_indexes
  data[:global_secondary_indexes]
end

#global_table_settings_replication_mode ⇒ `String`

Indicates one of the settings synchronization modes for the global table:

ENABLED: Indicates that the settings synchronization mode for the global table is enabled.
DISABLED: Indicates that the settings synchronization mode for the global table is disabled.
ENABLED_WITH_OVERRIDES: This mode is set by default for a same account global table. Indicates that certain global table settings can be overridden.

Returns:

(String)



367
368
369

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 367

def global_table_settings_replication_mode
  data[:global_table_settings_replication_mode]
end

#global_table_version ⇒ `String`

Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.

Returns:

(String)



334
335
336

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 334

def global_table_version
  data[:global_table_version]
end

#global_table_witnesses ⇒ `Array<Types::GlobalTableWitnessDescription>`

The witness Region and its current status in the MRSC global table. Only one witness Region can be configured per MRSC global table.

Returns:

(Array<Types::GlobalTableWitnessDescription>)



350
351
352

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 350

def global_table_witnesses
  data[:global_table_witnesses]
end

#item_count ⇒ `Integer`

The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Returns:

(Integer)



142
143
144

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 142

def item_count
  data[:item_count]
end

#key_schema ⇒ `Array<Types::KeySchemaElement>`

The primary key structure for the table. Each KeySchemaElement consists of:

AttributeName - The name of the attribute.
KeyType - The role of the attribute:
- 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 DynamoDB's 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 more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Returns:

(Array<Types::KeySchemaElement>)



80
81
82

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 80

def key_schema
  data[:key_schema]
end

#latest_stream_arn ⇒ `String`

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

Returns:

(String)



323
324
325

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 323

def latest_stream_arn
  data[:latest_stream_arn]
end

#latest_stream_label ⇒ `String`

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

Amazon Web Services customer ID
Table name
StreamLabel

Returns:

(String)



316
317
318

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 316

def latest_stream_label
  data[:latest_stream_label]
end

#load ⇒ `self` Also known as: reload

Loads, or reloads #data for the current Aws::DynamoDB::Table. Returns self making it possible to chain methods.

table.reload.data

Returns:

(self)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 498

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.describe_table(table_name: @name)
  end
  @data = resp.table
  self
end

#local_secondary_indexes ⇒ `Array<Types::LocalSecondaryIndexDescription>`

Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

IndexName - The name of the local secondary index.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

If the table is in the DELETING state, no information about indexes will be returned.

Returns:

(Array<Types::LocalSecondaryIndexDescription>)



215
216
217

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 215

def local_secondary_indexes
  data[:local_secondary_indexes]
end

#multi_region_consistency ⇒ `String`

Indicates one of the following consistency modes for a global table:

EVENTUAL: Indicates that the global table is configured for multi-Region eventual consistency (MREC).
STRONG: Indicates that the global table is configured for multi-Region strong consistency (MRSC).

If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.

Returns:

(String)



442
443
444

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 442

def multi_region_consistency
  data[:multi_region_consistency]
end

#name ⇒ `String` Also known as: table_name

Returns:

(String)



33
34
35

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 33

def name
  @name
end

#on_demand_throughput ⇒ `Types::OnDemandThroughput`

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

Returns:

(Types::OnDemandThroughput)



415
416
417

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 415

def on_demand_throughput
  data[:on_demand_throughput]
end

#provisioned_throughput ⇒ `Types::ProvisionedThroughputDescription`

The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

Returns:

(Types::ProvisionedThroughputDescription)



126
127
128

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 126

def provisioned_throughput
  data[:provisioned_throughput]
end

#put_item(options = {}) ⇒ `Types::PutItemOutput`

Examples:

Request syntax with placeholder values


table.put_item({
  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
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

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

If the table has vector indexes, the following validations apply to write operations. A violation of any of these constraints results in a ValidationException:
- The vector attribute must be a list of numbers with dimensions matching the index configuration.
- Vector values must fit in 32-bit IEEE-754 floating point format (f32).
- Partition key and inline filter attributes defined in the search schema must have data types matching the index schema 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:

(Types::PutItemOutput)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 1195

def put_item(options = {})
  options = options.merge(table_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.put_item(options)
  end
  resp.data
end

#query(options = {}) ⇒ `Types::QueryOutput`

Examples:

Request syntax with placeholder values


table.query({
  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>
  },
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

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

(Types::QueryOutput)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 1585

def query(options = {})
  options = options.merge(table_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.query(options)
  end
  resp.data
end

#replicas ⇒ `Array<Types::ReplicaDescription>`

Represents replicas of the table.

After a successful disassociation, this list is absent or empty. To confirm disassociation, also verify that TableStatus is ACTIVE.

Returns:

(Array<Types::ReplicaDescription>)



343
344
345

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 343

def replicas
  data[:replicas]
end

#restore_summary ⇒ `Types::RestoreSummary`

Contains details for the restore.

Returns:

(Types::RestoreSummary)



373
374
375

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 373

def restore_summary
  data[:restore_summary]
end

#scan(options = {}) ⇒ `Types::ScanOutput`

Examples:

Request syntax with placeholder values


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

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:index_name (String) —
The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.
:attributes_to_get (Array<String>) —
This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
: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 Working with Queries in the Amazon DynamoDB Developer Guide.
: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 reads 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.
:scan_filter (Hash<String,Types::Condition>) —
This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.
:conditional_operator (String) —
This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
:exclusive_start_key (Hash<String,Types::AttributeValue>) —
The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

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

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
:return_consumed_capacity (String) —
Determines the level of detail about 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.
:total_segments (Integer) —
For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.

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

If you specify TotalSegments, you must also specify Segment.
:segment (Integer) —
For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.

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

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

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

If you provide Segment, you must also provide TotalSegments.
:projection_expression (String) —
A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

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

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
:filter_expression (String) —
A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

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.
: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.
:consistent_read (Boolean) —
A Boolean value that determines the read consistency model during the scan:
- If ConsistentRead is false, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem, or DeleteItem).
- If ConsistentRead is true, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is false.

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

Returns:

(Types::ScanOutput)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 1902

def scan(options = {})
  options = options.merge(table_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.scan(options)
  end
  resp.data
end

#sse_description ⇒ `Types::SSEDescription`

The description of the server-side encryption status on the specified table.

Returns:

(Types::SSEDescription)



380
381
382

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 380

def sse_description
  data[:sse_description]
end

#stream_specification ⇒ `Types::StreamSpecification`

The current DynamoDB Streams configuration for the table.

Returns:

(Types::StreamSpecification)



299
300
301

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 299

def stream_specification
  data[:stream_specification]
end

#table_arn ⇒ `String`

The Amazon Resource Name (ARN) that uniquely identifies the table.

Returns:

(String)



148
149
150

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 148

def table_arn
  data[:table_arn]
end

#table_class_summary ⇒ `Types::TableClassSummary`

Contains details of the table class.

Returns:

(Types::TableClassSummary)



392
393
394

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 392

def table_class_summary
  data[:table_class_summary]
end

#table_id ⇒ `String`

A unique identifier for the table, in UUID format, generated by DynamoDB when the table is created.

Returns:

(String)



155
156
157

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 155

def table_id
  data[:table_id]
end

#table_size_bytes ⇒ `Integer`

The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Returns:

(Integer)



134
135
136

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 134

def table_size_bytes
  data[:table_size_bytes]
end

#table_status ⇒ `String`

The current state of the table:

CREATING - The table is being created.
UPDATING - The table/index configuration is being updated. The table/index remains available for data operations when UPDATING.
DELETING - The table is being deleted.
ACTIVE - The table is ready for use.
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival process when a table's KMS key remains inaccessible for more than seven days.
ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.
ARCHIVED - The table has been archived. See the ArchivalReason for more information.

Returns:

(String)



107
108
109

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 107

def table_status
  data[:table_status]
end

#update(options = {}) ⇒ `Table`

Examples:

Request syntax with placeholder values


table = table.update({
  attribute_definitions: [
    {
      attribute_name: "KeySchemaAttributeName", # required
      attribute_type: "S", # required, accepts S, N, B
    },
  ],
  billing_mode: "PROVISIONED", # accepts PROVISIONED, PAY_PER_REQUEST
  provisioned_throughput: {
    read_capacity_units: 1, # required
    write_capacity_units: 1, # required
  },
  global_secondary_index_updates: [
    {
      update: {
        index_name: "IndexName", # required
        provisioned_throughput: {
          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,
        },
      },
      create: {
        index_name: "IndexName", # required
        key_schema: [ # required
          {
            attribute_name: "KeySchemaAttributeName", # required
            key_type: "HASH", # required, accepts HASH, RANGE
          },
        ],
        projection: { # required
          projection_type: "ALL", # accepts ALL, KEYS_ONLY, INCLUDE
          non_key_attributes: ["NonKeyAttributeName"],
        },
        provisioned_throughput: {
          read_capacity_units: 1, # required
          write_capacity_units: 1, # required
        },
        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,
        },
      },
      delete: {
        index_name: "IndexName", # 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",
  },
  replica_updates: [
    {
      create: {
        region_name: "RegionName", # required
        kms_master_key_id: "KMSMasterKeyId",
        provisioned_throughput_override: {
          read_capacity_units: 1,
        },
        on_demand_throughput_override: {
          max_read_request_units: 1,
        },
        global_secondary_indexes: [
          {
            index_name: "IndexName", # required
            provisioned_throughput_override: {
              read_capacity_units: 1,
            },
            on_demand_throughput_override: {
              max_read_request_units: 1,
            },
          },
        ],
        table_class_override: "STANDARD", # accepts STANDARD, STANDARD_INFREQUENT_ACCESS
      },
      update: {
        region_name: "RegionName", # required
        kms_master_key_id: "KMSMasterKeyId",
        provisioned_throughput_override: {
          read_capacity_units: 1,
        },
        on_demand_throughput_override: {
          max_read_request_units: 1,
        },
        global_secondary_indexes: [
          {
            index_name: "IndexName", # required
            provisioned_throughput_override: {
              read_capacity_units: 1,
            },
            on_demand_throughput_override: {
              max_read_request_units: 1,
            },
          },
        ],
        table_class_override: "STANDARD", # accepts STANDARD, STANDARD_INFREQUENT_ACCESS
      },
      delete: {
        region_name: "RegionName", # required
      },
      disassociate: {
        region_name: "RegionName", # required
        disassociation_mode: "WAIT_FOR_REPLICATION", # required, accepts WAIT_FOR_REPLICATION
      },
    },
  ],
  table_class: "STANDARD", # accepts STANDARD, STANDARD_INFREQUENT_ACCESS
  deletion_protection_enabled: false,
  multi_region_consistency: "EVENTUAL", # accepts EVENTUAL, STRONG
  global_table_witness_updates: [
    {
      create: {
        region_name: "RegionName", # required
      },
      delete: {
        region_name: "RegionName", # 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,
  },
  global_table_settings_replication_mode: "ENABLED", # accepts ENABLED, DISABLED, ENABLED_WITH_OVERRIDES
  disassociation_protection_enabled: false,
  vector_index_updates: [
    {
      create: {
        index_name: "IndexName", # required
        vector_attribute: { # required
          attribute_name: "VectorAttributeName", # required
        },
        search_schema: [
          {
            attribute_name: "AttributeName", # required
            search_schema_element_type: "HASH", # required, accepts HASH, INLINE_FILTER
          },
        ],
        projection: { # required
          projection_type: "ALL", # accepts ALL, KEYS_ONLY, INCLUDE
          non_key_attributes: ["NonKeyAttributeName"],
        },
        dimensions: 1, # required
        distance_function: "COSINE", # required, accepts COSINE, DOT_PRODUCT, EUCLIDEAN
      },
      delete: {
        index_name: "IndexName", # required
      },
    },
  ],
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:attribute_definitions (Array<Types::AttributeDefinition>) —
An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.
:billing_mode (String) —
Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.
- PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
- PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity mode.
:provisioned_throughput (Types::ProvisionedThroughput) —
The new provisioned throughput settings for the specified table or index.
:global_secondary_index_updates (Array<Types::GlobalSecondaryIndexUpdate>) —
An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:
- Create - add a new global secondary index to the table.
- Update - modify the provisioned throughput settings of an existing global secondary index.
- Delete - remove a global secondary index from the table.
You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
:stream_specification (Types::StreamSpecification) —
Represents the DynamoDB Streams configuration for the table.

You receive a ValidationException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.
:sse_specification (Types::SSESpecification) —
The new server-side encryption settings for the specified table.
:replica_updates (Array<Types::ReplicationGroupUpdate>) —
A list of replica update actions (create, delete, update, or disassociate) for the table.
:table_class (String) —
The table class of the table to be updated. 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.
:multi_region_consistency (String) —
Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.

You can specify one of the following consistency modes:
- EVENTUAL: Configures a new global table for multi-Region eventual consistency (MREC). This is the default consistency mode for global tables.
- STRONG: Configures a new global table for multi-Region strong consistency (MRSC).
If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.
:global_table_witness_updates (Array<Types::GlobalTableWitnessGroupUpdate>) —
A list of witness updates for a MRSC global table. A witness provides a cost-effective alternative to a full replica in a MRSC global table by maintaining replicated change data written to global table replicas. You cannot perform read or write operations on a witness. For each witness, you can request one action:
- Create - add a new witness to the global table.
- Delete - remove a witness from the global table.
You can create or delete only one witness per UpdateTable operation.

For more information, see Multi-Region strong consistency (MRSC) in the Amazon DynamoDB Developer Guide
:on_demand_throughput (Types::OnDemandThroughput) —
Updates 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.
:warm_throughput (Types::WarmThroughput) —
Represents the warm throughput (in read units per second and write units per second) for updating a table.
:global_table_settings_replication_mode (String) —
Controls the settings replication mode for a global table replica. This attribute can be defined using UpdateTable operation only on a regional table with values:
- ENABLED: Defines settings replication on a regional table to be used as a source table for creating Multi-Account Global Table.
- DISABLED: Remove settings replication on a regional table. Settings replication needs to be defined to ENABLED again in order to create a Multi-Account Global Table using this table.
:disassociation_protection_enabled (Boolean) —
Specifies whether disassociation protection is enabled (true) or disabled (false) for the local replica of a multi-Region eventual consistency (MREC) global table using Version 2019.11.21.

Disassociation protection is enabled by default. If you omit this parameter, the existing setting is unchanged. This setting is independent of DeletionProtectionEnabled.

You can't combine this change with any other change in the same UpdateTable request.
:vector_index_updates (Array<Types::VectorIndexUpdate>) —
A list of vector indexes to be added to or removed from the table. You can add or remove one vector index for each UpdateTable operation.

To add a vector index, specify IndexName, VectorAttribute, Dimensions, DistanceFunction, and Projection. To remove a vector index, specify only the IndexName.

Returns:

(Table)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 2233

def update(options = {})
  options = options.merge(table_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.update_table(options)
  end
  Table.new(
    name: @name,
    data: resp.data.table_description,
    client: @client
  )
end

#update_item(options = {}) ⇒ `Types::UpdateItemOutput`

Examples:

Request syntax with placeholder values


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

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:key (required, Hash<String,Types::AttributeValue>) —
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
:attribute_updates (Hash<String,Types::AttributeValueUpdate>) —
This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
: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 appear before or after they are successfully updated. For UpdateItem, the valid values are:
- NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
- ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
- UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
- ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
- UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

The values returned are strongly consistent.
:return_consumed_capacity (String) —
Determines the level of detail about 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.
:update_expression (String) —
An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

The following action values are available for UpdateExpression.
- SET - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val
  
  SET supports the following functions:
  - if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.
  - list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands. These function names are case-sensitive.
- REMOVE - Removes one or more attributes from an item.
- ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
  - If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
    
    If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
    
    Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
  - If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
    
    Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The ADD action only supports Number and set data types.
- DELETE - Deletes an element from a set.
  
  If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
  
  The DELETE action only supports set data types.
You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5

For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
:condition_expression (String) —
A condition that must be satisfied in order for a conditional update to succeed.

An expression can contain any of the following:
- Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
  
  These function names are case-sensitive.
- Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
- Logical operators: AND | OR | NOT
For more information about condition expressions, see Specifying Conditions 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 about 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 an UpdateItem 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:

(Types::UpdateItemOutput)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 2543

def update_item(options = {})
  options = options.merge(table_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.update_item(options)
  end
  resp.data
end

#vector_indexes ⇒ `Array<Types::VectorIndexDescription>`

The vector indexes, if any, on the table. Each element is composed of:

IndexName - The name of the vector index.
IndexStatus - The current status of the vector index: CREATING, ACTIVE, or DELETING.
Backfilling - Specifies whether the index is currently backfilling. During backfill, SearchVectors operations might return incomplete results.
VectorAttribute - The attribute that contains vector embeddings.
Dimensions - The number of dimensions in each vector.
DistanceFunction - The distance function used to calculate similarity (COSINE, EUCLIDEAN, or DOT_PRODUCT).
SearchSchema - The partition key and inline filter attributes for the vector index.
Projection - Specifies attributes that are copied (projected) from the table into the vector index.
IndexArn - The Amazon Resource Name (ARN) that uniquely identifies the index.
IndexSizeBytes - The total size of the vector index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount - The number of items indexed in the vector index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Returns:

(Array<Types::VectorIndexDescription>)



481
482
483

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 481

def vector_indexes
  data[:vector_indexes]
end

#wait_until(options = {}) {|resource| ... } ⇒ `Resource`

Deprecated.

Use [Aws::DynamoDB::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged.

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) do |instance|
  instance.state.name == 'running'
end

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

options (Hash) (defaults to: {}) —
a customizable set of options

Options Hash (options):

:max_attempts (Integer) — default: 10 —
Maximum number of
:delay (Integer) — default: 10 —
Delay between each
:before_attempt (Proc) — default: nil —
Callback
:before_wait (Proc) — default: nil —
Callback

Yield Parameters:

resource (Resource) —
to be used in the waiting condition.

Returns:

(Resource) —
if the waiter was successful

Raises:

(Aws::Waiters::Errors::FailureStateError) —
Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

yet successful.
(Aws::Waiters::Errors::UnexpectedError) —
Raised when an error is encountered while polling for a resource that is not expected.
(NotImplementedError) —
Raised when the resource does not

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 602

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end

#warm_throughput ⇒ `Types::TableWarmThroughputDescription`

Describes the warm throughput value of the base table.

Returns:

(Types::TableWarmThroughputDescription)



421
422
423

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/table.rb', line 421

def warm_throughput
  data[:warm_throughput]
end

Class: Aws::DynamoDB::Table

Defined Under Namespace

Read-Only Attributes collapse

Actions collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ Table #initialize(options = {}) ⇒ Table

Instance Method Details

#archival_summary ⇒ Types::ArchivalSummary

#attribute_definitions ⇒ Array<Types::AttributeDefinition>

#billing_mode_summary ⇒ Types::BillingModeSummary

#client ⇒ Client

#creation_date_time ⇒ Time

#data ⇒ Types::TableDescription

#data_loaded? ⇒ Boolean

#delete(options = {}) ⇒ Types::DeleteTableOutput

Examples:

Request syntax with placeholder values

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

Examples:

Request syntax with placeholder values

#deletion_protection_enabled ⇒ Boolean

#disassociation_protection_enabled ⇒ Boolean

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

Examples:

Request syntax with placeholder values

#global_secondary_indexes ⇒ Array<Types::GlobalSecondaryIndexDescription>

#global_table_settings_replication_mode ⇒ String

#global_table_version ⇒ String

#global_table_witnesses ⇒ Array<Types::GlobalTableWitnessDescription>

#item_count ⇒ Integer

#key_schema ⇒ Array<Types::KeySchemaElement>

#latest_stream_arn ⇒ String

#latest_stream_label ⇒ String

#load ⇒ self Also known as: reload

#local_secondary_indexes ⇒ Array<Types::LocalSecondaryIndexDescription>

#multi_region_consistency ⇒ String

#name ⇒ String Also known as: table_name

#on_demand_throughput ⇒ Types::OnDemandThroughput

#provisioned_throughput ⇒ Types::ProvisionedThroughputDescription

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

Examples:

Request syntax with placeholder values

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

Examples:

Request syntax with placeholder values

#replicas ⇒ Array<Types::ReplicaDescription>

#restore_summary ⇒ Types::RestoreSummary

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

Examples:

Request syntax with placeholder values

#sse_description ⇒ Types::SSEDescription

#stream_specification ⇒ Types::StreamSpecification

#table_arn ⇒ String

#table_class_summary ⇒ Types::TableClassSummary

#table_id ⇒ String

#table_size_bytes ⇒ Integer

#table_status ⇒ String

#update(options = {}) ⇒ Table

Examples:

Request syntax with placeholder values

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

Examples:

Request syntax with placeholder values

#vector_indexes ⇒ Array<Types::VectorIndexDescription>

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Basic Usage

Example

Configuration

Callbacks

Handling Errors

#warm_throughput ⇒ Types::TableWarmThroughputDescription

#initialize(name, options = {}) ⇒ `Table` #initialize(options = {}) ⇒ `Table`

#archival_summary ⇒ `Types::ArchivalSummary`

#attribute_definitions ⇒ `Array<Types::AttributeDefinition>`

#billing_mode_summary ⇒ `Types::BillingModeSummary`

#client ⇒ `Client`

#creation_date_time ⇒ `Time`

#data ⇒ `Types::TableDescription`

#data_loaded? ⇒ `Boolean`

#delete(options = {}) ⇒ `Types::DeleteTableOutput`

#delete_item(options = {}) ⇒ `Types::DeleteItemOutput`

#deletion_protection_enabled ⇒ `Boolean`

#disassociation_protection_enabled ⇒ `Boolean`

#get_item(options = {}) ⇒ `Types::GetItemOutput`

#global_secondary_indexes ⇒ `Array<Types::GlobalSecondaryIndexDescription>`

#global_table_settings_replication_mode ⇒ `String`

#global_table_version ⇒ `String`

#global_table_witnesses ⇒ `Array<Types::GlobalTableWitnessDescription>`

#item_count ⇒ `Integer`

#key_schema ⇒ `Array<Types::KeySchemaElement>`

#latest_stream_arn ⇒ `String`

#latest_stream_label ⇒ `String`

#load ⇒ `self` Also known as: reload

#local_secondary_indexes ⇒ `Array<Types::LocalSecondaryIndexDescription>`

#multi_region_consistency ⇒ `String`

#name ⇒ `String` Also known as: table_name

#on_demand_throughput ⇒ `Types::OnDemandThroughput`

#provisioned_throughput ⇒ `Types::ProvisionedThroughputDescription`

#put_item(options = {}) ⇒ `Types::PutItemOutput`

#query(options = {}) ⇒ `Types::QueryOutput`

#replicas ⇒ `Array<Types::ReplicaDescription>`

#restore_summary ⇒ `Types::RestoreSummary`

#scan(options = {}) ⇒ `Types::ScanOutput`

#sse_description ⇒ `Types::SSEDescription`

#stream_specification ⇒ `Types::StreamSpecification`

#table_arn ⇒ `String`

#table_class_summary ⇒ `Types::TableClassSummary`

#table_id ⇒ `String`

#table_size_bytes ⇒ `Integer`

#table_status ⇒ `String`

#update(options = {}) ⇒ `Table`

#update_item(options = {}) ⇒ `Types::UpdateItemOutput`

#vector_indexes ⇒ `Array<Types::VectorIndexDescription>`

#wait_until(options = {}) {|resource| ... } ⇒ `Resource`

#warm_throughput ⇒ `Types::TableWarmThroughputDescription`