Skip to content

ParameterizedStatement

Source code in docs_src/capo_dynamodb/types/parameterized_statement.py
class ParameterizedStatement(TypedDict, closed=True):
    statement: "capo_dynamodb.types.parti_ql_statement.PartiQLStatement"
    """<p> A PartiQL statement that uses parameters. </p>"""
    parameters: NotRequired[
        "capo_dynamodb.types.prepared_statement_parameters.PreparedStatementParameters"
    ]
    """<p> The parameter values. </p>"""
    return_values_on_condition_check_failure: NotRequired[
        "capo_dynamodb.types.return_values_on_condition_check_failure.ReturnValuesOnConditionCheckFailure"
    ]
    """<p>An optional parameter that returns the item attributes for a PartiQL <code>ParameterizedStatement</code> operation that failed a condition check.</p> <p>There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.</p>"""

parameters instance-attribute

parameters: NotRequired[PreparedStatementParameters]

The parameter values.

return_values_on_condition_check_failure instance-attribute

return_values_on_condition_check_failure: NotRequired[
    ReturnValuesOnConditionCheckFailure
]

An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement operation that failed a condition check.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

statement instance-attribute

statement: PartiQLStatement

A PartiQL statement that uses parameters.