Skip to content

ConditionCheck

Source code in docs_src/capo_dynamodb/types/condition_check.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class ConditionCheck(TypedDict, closed=True):
    key: "capo_dynamodb.types.key.Key"
    """<p>The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.</p>"""
    table_name: "capo_dynamodb.types.table_arn.TableArn"
    """<p>Name of the table for the check item request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.</p>"""
    condition_expression: "capo_dynamodb.types.condition_expression.ConditionExpression"
    """<p>A condition that must be satisfied in order for a conditional update to succeed. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html">Condition expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"""
    expression_attribute_names: NotRequired[
        "capo_dynamodb.types.expression_attribute_name_map.ExpressionAttributeNameMap"
    ]
    """<p>One or more substitution tokens for attribute names in an expression. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeNames.html">Expression attribute names</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"""
    expression_attribute_values: NotRequired[
        "capo_dynamodb.types.expression_attribute_value_map.ExpressionAttributeValueMap"
    ]
    """<p>One or more values that can be substituted in an expression. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html">Condition expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"""
    return_values_on_condition_check_failure: NotRequired[
        "capo_dynamodb.types.return_values_on_condition_check_failure.ReturnValuesOnConditionCheckFailure"
    ]
    """<p>Use <code>ReturnValuesOnConditionCheckFailure</code> to get the item attributes if the <code>ConditionCheck</code> condition fails. For <code>ReturnValuesOnConditionCheckFailure</code>, the valid values are: NONE and ALL_OLD.</p>"""

condition_expression instance-attribute 

condition_expression: ConditionExpression

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.

expression_attribute_names instance-attribute 

expression_attribute_names: NotRequired[ExpressionAttributeNameMap]

One or more substitution tokens for attribute names in an expression. For more information, see Expression attribute names in the Amazon DynamoDB Developer Guide.

expression_attribute_values instance-attribute 

expression_attribute_values: NotRequired[ExpressionAttributeValueMap]

One or more values that can be substituted in an expression. For more information, see Condition expressions in the Amazon DynamoDB Developer Guide.

key instance-attribute 

key: Key

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

return_values_on_condition_check_failure instance-attribute 

return_values_on_condition_check_failure: NotRequired[
    ReturnValuesOnConditionCheckFailure
]

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

table_name instance-attribute 

table_name: TableArn

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