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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb

Overview

Note:

When making an API call, you may pass ConditionCheck data as a hash:

{
  key: { # required
    "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  table_name: "TableName", # required
  condition_expression: "ConditionExpression", # required
  expression_attribute_names: {
    "ExpressionAttributeNameVariable" => "AttributeName",
  },
  expression_attribute_values: {
    "ExpressionAttributeValueVariable" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  return_values_on_condition_check_failure: "ALL_OLD", # accepts ALL_OLD, NONE
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#condition_expressionString

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

Returns:

  • (String)


1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1646

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_namesHash<String,String>

One or more substitution tokens for attribute names in an expression.

Returns:

  • (Hash<String,String>)


1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1646

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_valuesHash<String,Types::AttributeValue>

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

Returns:



1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1646

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

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



1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1646

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_failureString

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

Returns:

  • (String)


1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1646

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_nameString

Name of the table for the check item request.

Returns:

  • (String)


1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1646

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