Function buildConditionCheck

  • Create a map to build the ConditionCheck operation to use transactWrite.

    Returns

    A map in the format { TableName, Key, ... }

    Parameters

    • tableName: string

      The name of the table that should contain the item

    • key: Key

      The primary key of the item to be checked

    • condition: AttributeMap

      An object describing the comparisons to generate ConditionExpression, ExpressionAttributeNames, and ExpressionAttributeValues

    • Optional options: Partial<ConditionCheck>

      The same parameters accepted by the original Document.transactWrite condition check items

    Returns { ConditionExpression?: string; ExpressionAttributeNames?: ExpressionAttributeNameMap; ExpressionAttributeValues?: ExpressionAttributeValueMap; Key: Key; ReturnValuesOnConditionCheckFailure?: string; TableName: string }

    • Optional ConditionExpression?: string

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

    • Optional ExpressionAttributeNames?: ExpressionAttributeNameMap

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

    • Optional ExpressionAttributeValues?: ExpressionAttributeValueMap

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

    • Key: Key

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

    • Optional ReturnValuesOnConditionCheckFailure?: string

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

    • TableName: string

      Name of the table for the check item request.

Settings

Member Visibility

Theme

Generated using TypeDoc