AWSDynamoDBConditionCheck

Objective-C

@interface AWSDynamoDBConditionCheck

Swift

class AWSDynamoDBConditionCheck

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

Required parameters: [Key, TableName, 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable conditionExpression;

    Swift

    var conditionExpression: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable expressionAttributeNames;

    Swift

    var expressionAttributeNames: [String : String]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, AWSDynamoDBAttributeValue *> *_Nullable expressionAttributeValues;

    Swift

    var expressionAttributeValues: [String : AWSDynamoDBAttributeValue]? { get set }
  • key

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, AWSDynamoDBAttributeValue *> *_Nullable key;

    Swift

    var key: [String : AWSDynamoDBAttributeValue]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSDynamoDBReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure;

    Swift

    var returnValuesOnConditionCheckFailure: AWSDynamoDBReturnValuesOnConditionCheckFailure { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable tableName;

    Swift

    var tableName: String? { get set }