Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DynamoDB.ExecuteTransaction

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.

The entire transaction must consist of either read statements or write statements, you cannot mix both in one transaction. The EXISTS function is an exception and can be used to check the condition of specific attributes of the item in a similar manner to ConditionCheck in the TransactWriteItems API.

Synopsis

Creating a Request

data ExecuteTransaction Source #

See: newExecuteTransaction smart constructor.

Constructors

ExecuteTransaction'

Fields

clientRequestToken :: Maybe Text
Set this value to get remaining results, if NextToken was returned in the statement response.
returnConsumedCapacity :: Maybe ReturnConsumedCapacity
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response. For more information, see TransactGetItems and TransactWriteItems.
transactStatements :: NonEmpty ParameterizedStatement
The list of PartiQL statements representing the transaction to run.

Instances

Instances details

ToJSON ExecuteTransaction Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction Methods toJSON :: ExecuteTransaction -> Value # toEncoding :: ExecuteTransaction -> Encoding # toJSONList :: [ExecuteTransaction] -> Value # toEncodingList :: [ExecuteTransaction] -> Encoding #
ToHeaders ExecuteTransaction Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction Methods toHeaders :: ExecuteTransaction -> [Header] #
ToPath ExecuteTransaction Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction Methods toPath :: ExecuteTransaction -> ByteString #
ToQuery ExecuteTransaction Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction Methods toQuery :: ExecuteTransaction -> QueryString #
AWSRequest ExecuteTransaction Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction Associated Types type AWSResponse ExecuteTransaction # Methods request :: (Service -> Service) -> ExecuteTransaction -> Request ExecuteTransaction # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ExecuteTransaction -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ExecuteTransaction))) #
Generic ExecuteTransaction Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction Associated Types type Rep ExecuteTransaction :: Type -> Type # Methods from :: ExecuteTransaction -> Rep ExecuteTransaction x # to :: Rep ExecuteTransaction x -> ExecuteTransaction #
Read ExecuteTransaction Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction Methods readsPrec :: Int -> ReadS ExecuteTransaction # readList :: ReadS [ExecuteTransaction] # readPrec :: ReadPrec ExecuteTransaction # readListPrec :: ReadPrec [ExecuteTransaction] #
Show ExecuteTransaction Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction Methods showsPrec :: Int -> ExecuteTransaction -> ShowS # show :: ExecuteTransaction -> String # showList :: [ExecuteTransaction] -> ShowS #
NFData ExecuteTransaction Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction Methods rnf :: ExecuteTransaction -> () #
Eq ExecuteTransaction Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction Methods (==) :: ExecuteTransaction -> ExecuteTransaction -> Bool # (/=) :: ExecuteTransaction -> ExecuteTransaction -> Bool #
Hashable ExecuteTransaction Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction Methods hashWithSalt :: Int -> ExecuteTransaction -> Int # hash :: ExecuteTransaction -> Int #
type AWSResponse ExecuteTransaction Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction type AWSResponse ExecuteTransaction = ExecuteTransactionResponse
type Rep ExecuteTransaction Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction type Rep ExecuteTransaction = D1 ('MetaData "ExecuteTransaction" "Amazonka.DynamoDB.ExecuteTransaction" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "ExecuteTransaction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "returnConsumedCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReturnConsumedCapacity)) :: S1 ('MetaSel ('Just "transactStatements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty ParameterizedStatement)))))

newExecuteTransaction Source #

Arguments

:: NonEmpty ParameterizedStatement	`$sel:transactStatements:ExecuteTransaction'`
-> ExecuteTransaction

Create a value of ExecuteTransaction 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:clientRequestToken:ExecuteTransaction', executeTransaction_clientRequestToken - Set this value to get remaining results, if NextToken was returned in the statement response.

$sel:returnConsumedCapacity:ExecuteTransaction', executeTransaction_returnConsumedCapacity - Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response. For more information, see TransactGetItems and TransactWriteItems.

$sel:transactStatements:ExecuteTransaction', executeTransaction_transactStatements - The list of PartiQL statements representing the transaction to run.

Request Lenses

executeTransaction_clientRequestToken :: Lens' ExecuteTransaction (Maybe Text) Source #

Set this value to get remaining results, if NextToken was returned in the statement response.

executeTransaction_returnConsumedCapacity :: Lens' ExecuteTransaction (Maybe ReturnConsumedCapacity) Source #

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response. For more information, see TransactGetItems and TransactWriteItems.

executeTransaction_transactStatements :: Lens' ExecuteTransaction (NonEmpty ParameterizedStatement) Source #

The list of PartiQL statements representing the transaction to run.

Destructuring the Response

data ExecuteTransactionResponse Source #

See: newExecuteTransactionResponse smart constructor.

Constructors

ExecuteTransactionResponse'
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 (NonEmpty ItemResponse) The response to a PartiQL transaction. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ExecuteTransactionResponse Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction Associated Types type Rep ExecuteTransactionResponse :: Type -> Type # Methods from :: ExecuteTransactionResponse -> Rep ExecuteTransactionResponse x # to :: Rep ExecuteTransactionResponse x -> ExecuteTransactionResponse #
Read ExecuteTransactionResponse Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction Methods readsPrec :: Int -> ReadS ExecuteTransactionResponse # readList :: ReadS [ExecuteTransactionResponse] # readPrec :: ReadPrec ExecuteTransactionResponse # readListPrec :: ReadPrec [ExecuteTransactionResponse] #
Show ExecuteTransactionResponse Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction Methods showsPrec :: Int -> ExecuteTransactionResponse -> ShowS # show :: ExecuteTransactionResponse -> String # showList :: [ExecuteTransactionResponse] -> ShowS #
NFData ExecuteTransactionResponse Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction Methods rnf :: ExecuteTransactionResponse -> () #
Eq ExecuteTransactionResponse Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction Methods (==) :: ExecuteTransactionResponse -> ExecuteTransactionResponse -> Bool # (/=) :: ExecuteTransactionResponse -> ExecuteTransactionResponse -> Bool #
type Rep ExecuteTransactionResponse Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteTransaction type Rep ExecuteTransactionResponse = D1 ('MetaData "ExecuteTransactionResponse" "Amazonka.DynamoDB.ExecuteTransaction" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "ExecuteTransactionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "consumedCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConsumedCapacity])) :: (S1 ('MetaSel ('Just "responses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ItemResponse))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newExecuteTransactionResponse Source #

Arguments

:: Int	`$sel:httpStatus:ExecuteTransactionResponse'`
-> ExecuteTransactionResponse

Create a value of ExecuteTransactionResponse 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:ExecuteTransactionResponse', executeTransactionResponse_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:ExecuteTransactionResponse', executeTransactionResponse_responses - The response to a PartiQL transaction.

$sel:httpStatus:ExecuteTransactionResponse', executeTransactionResponse_httpStatus - The response's http status code.

Response Lenses

executeTransactionResponse_consumedCapacity :: Lens' ExecuteTransactionResponse (Maybe [ConsumedCapacity]) Source #

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

executeTransactionResponse_responses :: Lens' ExecuteTransactionResponse (Maybe (NonEmpty ItemResponse)) Source #

The response to a PartiQL transaction.

executeTransactionResponse_httpStatus :: Lens' ExecuteTransactionResponse Int Source #

The response's http status code.