Class: Aws::DynamoDB::Types::ConditionCheck

Inherits:

Struct

• Object
• Struct
• Aws::DynamoDB::Types::ConditionCheck

Includes:

Structure

Defined in:

lib/aws-sdk-dynamodb/types.rb

Overview

Represents a request to perform a check that an item exists or to check the condition of specific attributes of the item.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #condition_expression ⇒ String

  A condition that must be satisfied in order for a conditional update to succeed.

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

• #key ⇒ Hash<String,Types::AttributeValue>

  The primary key of the item to be checked.

• #return_values_on_condition_check_failure ⇒ String

  Use ‘ReturnValuesOnConditionCheckFailure` to get the item attributes if the `ConditionCheck` condition fails.

• #table_name ⇒ String

  Name of the table for the check item request.

Instance Attribute Details

#condition_expression ⇒ String

A condition that must be satisfied in order for a conditional update to succeed. For more information, see [Condition expressions] in the *Amazon DynamoDB Developer Guide*.

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

Returns:

• (String)

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

class ConditionCheck < Struct.new(
  :key,
  :table_name,
  :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. For more information, see [Expression attribute names] in the *Amazon DynamoDB Developer Guide*.

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

Returns:

• (Hash<String,String>)

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

class ConditionCheck < Struct.new(
  :key,
  :table_name,
  :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. For more information, see [Condition expressions] in the *Amazon DynamoDB Developer Guide*.

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

Returns:

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

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

class ConditionCheck < Struct.new(
  :key,
  :table_name,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

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

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

Returns:

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

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

class ConditionCheck < Struct.new(
  :key,
  :table_name,
  :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

Use ‘ReturnValuesOnConditionCheckFailure` to get the item attributes if the `ConditionCheck` condition fails. For `ReturnValuesOnConditionCheckFailure`, the valid values are: NONE and ALL_OLD.

Returns:

• (String)

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

class ConditionCheck < Struct.new(
  :key,
  :table_name,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end

#table_name ⇒ String

Name of the table for the check item request.

Returns:

• (String)

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

class ConditionCheck < Struct.new(
  :key,
  :table_name,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  SENSITIVE = []
  include Aws::Structure
end