Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DynamoDB.ExecuteStatement

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data ExecuteStatement = ExecuteStatement' {
- consistentRead :: Maybe Bool
- nextToken :: Maybe Text
- parameters :: Maybe (NonEmpty AttributeValue)
- statement :: Text
}
newExecuteStatement :: Text -> ExecuteStatement
executeStatement_consistentRead :: Lens' ExecuteStatement (Maybe Bool)
executeStatement_nextToken :: Lens' ExecuteStatement (Maybe Text)
executeStatement_parameters :: Lens' ExecuteStatement (Maybe (NonEmpty AttributeValue))
executeStatement_statement :: Lens' ExecuteStatement Text
data ExecuteStatementResponse = ExecuteStatementResponse' {
- items :: Maybe [HashMap Text AttributeValue]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newExecuteStatementResponse :: Int -> ExecuteStatementResponse
executeStatementResponse_items :: Lens' ExecuteStatementResponse (Maybe [HashMap Text AttributeValue])
executeStatementResponse_nextToken :: Lens' ExecuteStatementResponse (Maybe Text)
executeStatementResponse_httpStatus :: Lens' ExecuteStatementResponse Int

Creating a Request

data ExecuteStatement Source #

See: newExecuteStatement smart constructor.

Constructors

ExecuteStatement'

Fields

consistentRead :: Maybe Bool
The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
nextToken :: Maybe Text
Set this value to get remaining results, if NextToken was returned in the statement response.
parameters :: Maybe (NonEmpty AttributeValue)
The parameters for the PartiQL statement, if any.
statement :: Text
The PartiQL statement representing the operation to run.

Instances

Instances details

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

newExecuteStatement Source #

Arguments

:: Text	`$sel:statement:ExecuteStatement'`
-> ExecuteStatement

Create a value of ExecuteStatement 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:consistentRead:ExecuteStatement', executeStatement_consistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

$sel:nextToken:ExecuteStatement', executeStatement_nextToken - Set this value to get remaining results, if NextToken was returned in the statement response.

$sel:parameters:ExecuteStatement', executeStatement_parameters - The parameters for the PartiQL statement, if any.

$sel:statement:ExecuteStatement', executeStatement_statement - The PartiQL statement representing the operation to run.

Request Lenses

executeStatement_consistentRead :: Lens' ExecuteStatement (Maybe Bool) Source #

The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

executeStatement_nextToken :: Lens' ExecuteStatement (Maybe Text) Source #

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

executeStatement_parameters :: Lens' ExecuteStatement (Maybe (NonEmpty AttributeValue)) Source #

The parameters for the PartiQL statement, if any.

executeStatement_statement :: Lens' ExecuteStatement Text Source #

The PartiQL statement representing the operation to run.

Destructuring the Response

data ExecuteStatementResponse Source #

See: newExecuteStatementResponse smart constructor.

Constructors

ExecuteStatementResponse'

Fields

items :: Maybe [HashMap Text AttributeValue]
If a read operation was used, this property will contain the result of the reade operation; a map of attribute names and their values. For the write operations this value will be empty.
nextToken :: Maybe Text
If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ExecuteStatementResponse Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteStatement Methods (==) :: ExecuteStatementResponse -> ExecuteStatementResponse -> Bool # (/=) :: ExecuteStatementResponse -> ExecuteStatementResponse -> Bool #
Read ExecuteStatementResponse Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteStatement Methods readsPrec :: Int -> ReadS ExecuteStatementResponse # readList :: ReadS [ExecuteStatementResponse] # readPrec :: ReadPrec ExecuteStatementResponse # readListPrec :: ReadPrec [ExecuteStatementResponse] #
Show ExecuteStatementResponse Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteStatement Methods showsPrec :: Int -> ExecuteStatementResponse -> ShowS # show :: ExecuteStatementResponse -> String # showList :: [ExecuteStatementResponse] -> ShowS #
Generic ExecuteStatementResponse Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteStatement Associated Types type Rep ExecuteStatementResponse :: Type -> Type # Methods from :: ExecuteStatementResponse -> Rep ExecuteStatementResponse x # to :: Rep ExecuteStatementResponse x -> ExecuteStatementResponse #
NFData ExecuteStatementResponse Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteStatement Methods rnf :: ExecuteStatementResponse -> () #
type Rep ExecuteStatementResponse Source #
Instance details Defined in Amazonka.DynamoDB.ExecuteStatement type Rep ExecuteStatementResponse = D1 ('MetaData "ExecuteStatementResponse" "Amazonka.DynamoDB.ExecuteStatement" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "ExecuteStatementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HashMap Text AttributeValue])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newExecuteStatementResponse Source #

Arguments

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

Create a value of ExecuteStatementResponse 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:items:ExecuteStatementResponse', executeStatementResponse_items - If a read operation was used, this property will contain the result of the reade operation; a map of attribute names and their values. For the write operations this value will be empty.

$sel:nextToken:ExecuteStatement', executeStatementResponse_nextToken - If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results.

$sel:httpStatus:ExecuteStatementResponse', executeStatementResponse_httpStatus - The response's http status code.

Response Lenses

executeStatementResponse_items :: Lens' ExecuteStatementResponse (Maybe [HashMap Text AttributeValue]) Source #

If a read operation was used, this property will contain the result of the reade operation; a map of attribute names and their values. For the write operations this value will be empty.

executeStatementResponse_nextToken :: Lens' ExecuteStatementResponse (Maybe Text) Source #

If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results.

executeStatementResponse_httpStatus :: Lens' ExecuteStatementResponse Int Source #

The response's http status code.