Amazonka.DynamoDB.BatchExecuteStatement

This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item.

The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.

A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each statement.

Creating a Request

data BatchExecuteStatement

See: newBatchExecuteStatement smart constructor.

Constructors

BatchExecuteStatement'

Fields

• returnConsumedCapacity :: Maybe ReturnConsumedCapacity
• statements :: NonEmpty BatchStatementRequest

  The list of PartiQL statements representing the batch to run.

Instances

ToJSON BatchExecuteStatement

Defined in Amazonka.DynamoDB.BatchExecuteStatement

Methods

toJSON :: BatchExecuteStatement -> Value

toEncoding :: BatchExecuteStatement -> Encoding

toJSONList :: [BatchExecuteStatement] -> Value

toEncodingList :: [BatchExecuteStatement] -> Encoding

ToHeaders BatchExecuteStatement

Defined in Amazonka.DynamoDB.BatchExecuteStatement

Methods

toHeaders :: BatchExecuteStatement -> [Header]

ToPath BatchExecuteStatement

Defined in Amazonka.DynamoDB.BatchExecuteStatement

Methods

toPath :: BatchExecuteStatement -> ByteString

ToQuery BatchExecuteStatement

Defined in Amazonka.DynamoDB.BatchExecuteStatement

Methods

toQuery :: BatchExecuteStatement -> QueryString

AWSRequest BatchExecuteStatement

Defined in Amazonka.DynamoDB.BatchExecuteStatement

Associated Types

type AWSResponse BatchExecuteStatement

Methods

request :: (Service -> Service) -> BatchExecuteStatement -> Request BatchExecuteStatement

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy BatchExecuteStatement -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse BatchExecuteStatement)))

Generic BatchExecuteStatement

Defined in Amazonka.DynamoDB.BatchExecuteStatement

Associated Types

type Rep BatchExecuteStatement :: Type -> Type

Methods

from :: BatchExecuteStatement -> Rep BatchExecuteStatement x

to :: Rep BatchExecuteStatement x -> BatchExecuteStatement

Read BatchExecuteStatement

Defined in Amazonka.DynamoDB.BatchExecuteStatement

Methods

readsPrec :: Int -> ReadS BatchExecuteStatement

readList :: ReadS [BatchExecuteStatement]

readPrec :: ReadPrec BatchExecuteStatement

readListPrec :: ReadPrec [BatchExecuteStatement]

Show BatchExecuteStatement

Defined in Amazonka.DynamoDB.BatchExecuteStatement

Methods

showsPrec :: Int -> BatchExecuteStatement -> ShowS

show :: BatchExecuteStatement -> String

showList :: [BatchExecuteStatement] -> ShowS

NFData BatchExecuteStatement

Defined in Amazonka.DynamoDB.BatchExecuteStatement

Methods

rnf :: BatchExecuteStatement -> ()

Eq BatchExecuteStatement

Defined in Amazonka.DynamoDB.BatchExecuteStatement

Methods

(==) :: BatchExecuteStatement -> BatchExecuteStatement -> Bool

(/=) :: BatchExecuteStatement -> BatchExecuteStatement -> Bool

Hashable BatchExecuteStatement

Defined in Amazonka.DynamoDB.BatchExecuteStatement

Methods

hashWithSalt :: Int -> BatchExecuteStatement -> Int

hash :: BatchExecuteStatement -> Int

type AWSResponse BatchExecuteStatement

Defined in Amazonka.DynamoDB.BatchExecuteStatement

type AWSResponse BatchExecuteStatement = BatchExecuteStatementResponse

type Rep BatchExecuteStatement

Defined in Amazonka.DynamoDB.BatchExecuteStatement

type Rep BatchExecuteStatement = D1 ('MetaData "BatchExecuteStatement" "Amazonka.DynamoDB.BatchExecuteStatement" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "BatchExecuteStatement'" 'PrefixI 'True) (S1 ('MetaSel ('Just "returnConsumedCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReturnConsumedCapacity)) :*: S1 ('MetaSel ('Just "statements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty BatchStatementRequest))))

newBatchExecuteStatement

Arguments

:: NonEmpty BatchStatementRequest

$sel:statements:BatchExecuteStatement'

-> BatchExecuteStatement

Create a value of BatchExecuteStatement with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:returnConsumedCapacity:BatchExecuteStatement', batchExecuteStatement_returnConsumedCapacity - Undocumented member.

$sel:statements:BatchExecuteStatement', batchExecuteStatement_statements - The list of PartiQL statements representing the batch to run.

Request Lenses

batchExecuteStatement_returnConsumedCapacity :: Lens' BatchExecuteStatement (Maybe ReturnConsumedCapacity)

Undocumented member.

batchExecuteStatement_statements :: Lens' BatchExecuteStatement (NonEmpty BatchStatementRequest)

The list of PartiQL statements representing the batch to run.

Destructuring the Response

data BatchExecuteStatementResponse

See: newBatchExecuteStatementResponse smart constructor.

Constructors

BatchExecuteStatementResponse'

Fields

• consumedCapacity :: Maybe [ConsumedCapacity]

  The capacity units consumed by the entire operation. The values of the list are ordered according to the ordering of the statements.

• responses :: Maybe [BatchStatementResponse]

  The response to each PartiQL statement in the batch.

• httpStatus :: Int

  The response's http status code.

Instances

Generic BatchExecuteStatementResponse

Defined in Amazonka.DynamoDB.BatchExecuteStatement

Associated Types

type Rep BatchExecuteStatementResponse :: Type -> Type

Methods

from :: BatchExecuteStatementResponse -> Rep BatchExecuteStatementResponse x

to :: Rep BatchExecuteStatementResponse x -> BatchExecuteStatementResponse

Read BatchExecuteStatementResponse

Defined in Amazonka.DynamoDB.BatchExecuteStatement

Methods

readsPrec :: Int -> ReadS BatchExecuteStatementResponse

readList :: ReadS [BatchExecuteStatementResponse]

readPrec :: ReadPrec BatchExecuteStatementResponse

readListPrec :: ReadPrec [BatchExecuteStatementResponse]

Show BatchExecuteStatementResponse

Defined in Amazonka.DynamoDB.BatchExecuteStatement

Methods

showsPrec :: Int -> BatchExecuteStatementResponse -> ShowS

show :: BatchExecuteStatementResponse -> String

showList :: [BatchExecuteStatementResponse] -> ShowS

NFData BatchExecuteStatementResponse

Defined in Amazonka.DynamoDB.BatchExecuteStatement

Methods

rnf :: BatchExecuteStatementResponse -> ()

Eq BatchExecuteStatementResponse

Defined in Amazonka.DynamoDB.BatchExecuteStatement

Methods

(==) :: BatchExecuteStatementResponse -> BatchExecuteStatementResponse -> Bool

(/=) :: BatchExecuteStatementResponse -> BatchExecuteStatementResponse -> Bool

type Rep BatchExecuteStatementResponse

Defined in Amazonka.DynamoDB.BatchExecuteStatement

type Rep BatchExecuteStatementResponse = D1 ('MetaData "BatchExecuteStatementResponse" "Amazonka.DynamoDB.BatchExecuteStatement" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "BatchExecuteStatementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "consumedCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConsumedCapacity])) :*: (S1 ('MetaSel ('Just "responses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BatchStatementResponse])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newBatchExecuteStatementResponse

Arguments

:: Int

$sel:httpStatus:BatchExecuteStatementResponse'

-> BatchExecuteStatementResponse

Create a value of BatchExecuteStatementResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:consumedCapacity:BatchExecuteStatementResponse', batchExecuteStatementResponse_consumedCapacity - The capacity units consumed by the entire operation. The values of the list are ordered according to the ordering of the statements.

$sel:responses:BatchExecuteStatementResponse', batchExecuteStatementResponse_responses - The response to each PartiQL statement in the batch.

$sel:httpStatus:BatchExecuteStatementResponse', batchExecuteStatementResponse_httpStatus - The response's http status code.

Response Lenses

batchExecuteStatementResponse_consumedCapacity :: Lens' BatchExecuteStatementResponse (Maybe [ConsumedCapacity])

The capacity units consumed by the entire operation. The values of the list are ordered according to the ordering of the statements.

batchExecuteStatementResponse_responses :: Lens' BatchExecuteStatementResponse (Maybe [BatchStatementResponse])

The response to each PartiQL statement in the batch.

batchExecuteStatementResponse_httpStatus :: Lens' BatchExecuteStatementResponse Int

The response's http status code.