Skip to content

BatchStatementRequest

Source code in docs_src/capo_dynamodb/types/batch_statement_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class BatchStatementRequest(TypedDict, closed=True):
    statement: "capo_dynamodb.types.parti_ql_statement.PartiQLStatement"
    """<p> A valid PartiQL statement. </p>"""
    parameters: NotRequired[
        "capo_dynamodb.types.prepared_statement_parameters.PreparedStatementParameters"
    ]
    """<p> The parameters associated with a PartiQL statement in the batch request. </p>"""
    consistent_read: NotRequired["capo_dynamodb.types.consistent_read.ConsistentRead"]
    """<p> The read consistency of the PartiQL batch request. </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 batch request 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>"""

consistent_read instance-attribute 

consistent_read: NotRequired[ConsistentRead]

The read consistency of the PartiQL batch request.

parameters instance-attribute 

parameters: NotRequired[PreparedStatementParameters]

The parameters associated with a PartiQL statement in the batch request.

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 batch request 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 valid PartiQL statement.