Class: Aws::DynamoDB::Types::PutItemInput

Inherits:

Struct

Object
Struct
Aws::DynamoDB::Types::PutItemInput

show all

Includes:: Structure

Defined in:: lib/aws-sdk-dynamodb/types.rb

Overview

Represents the input of a ‘PutItem` operation.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#condition_expression ⇒ String

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

This is a legacy parameter.
#expected ⇒ Hash<String,Types::ExpectedAttributeValue>

This is a legacy parameter.
#expression_attribute_names ⇒ Hash<String,String>

One or more substitution tokens for attribute names in an expression.
#expression_attribute_values ⇒ Hash<String,Types::AttributeValue>

One or more values that can be substituted in an expression.
#item ⇒ Hash<String,Types::AttributeValue>

A map of attribute name/value pairs, one for each attribute.
#return_consumed_capacity ⇒ String

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

Determines whether item collection metrics are returned.
#return_values ⇒ String

Use ‘ReturnValues` if you want to get the item attributes as they appeared before they were updated with the `PutItem` request.
#return_values_on_condition_check_failure ⇒ String

An optional parameter that returns the item attributes for a ‘PutItem` operation that failed a condition check.
#table_name ⇒ String

The name of the table to contain the item.

Instance Attribute Details

#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*.

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

Returns:

(String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 6231

class PutItemInput < Struct.new(
  :table_name,
  :item,
  :expected,
  :return_values,
  :return_consumed_capacity,
  :return_item_collection_metrics,
  :conditional_operator,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

#conditional_operator ⇒ `String`

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

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

Returns:

(String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 6231

class PutItemInput < Struct.new(
  :table_name,
  :item,
  :expected,
  :return_values,
  :return_consumed_capacity,
  :return_item_collection_metrics,
  :conditional_operator,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

#expected ⇒ `Hash<String,Types::ExpectedAttributeValue>`

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

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

Returns:

(Hash<String,Types::ExpectedAttributeValue>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 6231

class PutItemInput < Struct.new(
  :table_name,
  :item,
  :expected,
  :return_values,
  :return_consumed_capacity,
  :return_item_collection_metrics,
  :conditional_operator,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

#expression_attribute_names ⇒ `Hash<String,String>`

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

To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.

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

‘Percentile`

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

‘“#P”:“Percentile”`

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

‘#P = :val`

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

</note>

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

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

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 6231

class PutItemInput < Struct.new(
  :table_name,
  :item,
  :expected,
  :return_values,
  :return_consumed_capacity,
  :return_item_collection_metrics,
  :conditional_operator,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

#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*.

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

Returns:

(Hash<String,Types::AttributeValue>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 6231

class PutItemInput < Struct.new(
  :table_name,
  :item,
  :expected,
  :return_values,
  :return_consumed_capacity,
  :return_item_collection_metrics,
  :conditional_operator,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

#item ⇒ `Hash<String,Types::AttributeValue>`

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

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

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

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

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

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

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.PrimaryKey

Returns:

(Hash<String,Types::AttributeValue>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 6231

class PutItemInput < Struct.new(
  :table_name,
  :item,
  :expected,
  :return_values,
  :return_consumed_capacity,
  :return_item_collection_metrics,
  :conditional_operator,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

#return_consumed_capacity ⇒ `String`

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

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

Note that some operations, such as ‘GetItem` and `BatchGetItem`, do not access any indexes at all. In these cases, specifying `INDEXES` will only return `ConsumedCapacity` information for table(s).
‘TOTAL` - The response includes only the aggregate `ConsumedCapacity` for the operation.
‘NONE` - No `ConsumedCapacity` details are included in the response.

Returns:

(String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 6231

class PutItemInput < Struct.new(
  :table_name,
  :item,
  :expected,
  :return_values,
  :return_consumed_capacity,
  :return_item_collection_metrics,
  :conditional_operator,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

#return_item_collection_metrics ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 6231

class PutItemInput < Struct.new(
  :table_name,
  :item,
  :expected,
  :return_values,
  :return_consumed_capacity,
  :return_item_collection_metrics,
  :conditional_operator,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

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

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

</note>

Returns:

(String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 6231

class PutItemInput < Struct.new(
  :table_name,
  :item,
  :expected,
  :return_values,
  :return_consumed_capacity,
  :return_item_collection_metrics,
  :conditional_operator,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

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

(String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 6231

class PutItemInput < Struct.new(
  :table_name,
  :item,
  :expected,
  :return_values,
  :return_consumed_capacity,
  :return_item_collection_metrics,
  :conditional_operator,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

#table_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 6231

class PutItemInput < Struct.new(
  :table_name,
  :item,
  :expected,
  :return_values,
  :return_consumed_capacity,
  :return_item_collection_metrics,
  :conditional_operator,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::DynamoDB::Types::PutItemInput

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#condition_expression ⇒ String

#conditional_operator ⇒ String

#expected ⇒ Hash<String,Types::ExpectedAttributeValue>

#expression_attribute_names ⇒ Hash<String,String>

#expression_attribute_values ⇒ Hash<String,Types::AttributeValue>

#item ⇒ Hash<String,Types::AttributeValue>

#return_consumed_capacity ⇒ String

#return_item_collection_metrics ⇒ String

#return_values ⇒ String

#return_values_on_condition_check_failure ⇒ String

#table_name ⇒ String

#condition_expression ⇒ `String`

#conditional_operator ⇒ `String`

#expected ⇒ `Hash<String,Types::ExpectedAttributeValue>`

#expression_attribute_names ⇒ `Hash<String,String>`

#expression_attribute_values ⇒ `Hash<String,Types::AttributeValue>`

#item ⇒ `Hash<String,Types::AttributeValue>`

#return_consumed_capacity ⇒ `String`

#return_item_collection_metrics ⇒ `String`

#return_values ⇒ `String`

#return_values_on_condition_check_failure ⇒ `String`

#table_name ⇒ `String`