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.QLDB.GetRevision

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if DigestTipAddress is provided.

Synopsis

Creating a Request

data GetRevision Source #

See: newGetRevision smart constructor.

Constructors

GetRevision'

Fields

digestTipAddress :: Maybe (Sensitive ValueHolder)
The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.
For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}.
name :: Text
The name of the ledger.
blockAddress :: Sensitive ValueHolder
The block location of the document revision to be verified. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.
For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}.
documentId :: Text
The UUID (represented in Base62-encoded text) of the document to be verified.

Instances

Instances details

Eq GetRevision Source #
Instance details Defined in Amazonka.QLDB.GetRevision Methods (==) :: GetRevision -> GetRevision -> Bool # (/=) :: GetRevision -> GetRevision -> Bool #
Show GetRevision Source #
Instance details Defined in Amazonka.QLDB.GetRevision Methods showsPrec :: Int -> GetRevision -> ShowS # show :: GetRevision -> String # showList :: [GetRevision] -> ShowS #
Generic GetRevision Source #
Instance details Defined in Amazonka.QLDB.GetRevision Associated Types type Rep GetRevision :: Type -> Type # Methods from :: GetRevision -> Rep GetRevision x # to :: Rep GetRevision x -> GetRevision #
NFData GetRevision Source #
Instance details Defined in Amazonka.QLDB.GetRevision Methods rnf :: GetRevision -> () #
Hashable GetRevision Source #
Instance details Defined in Amazonka.QLDB.GetRevision Methods hashWithSalt :: Int -> GetRevision -> Int # hash :: GetRevision -> Int #
ToJSON GetRevision Source #
Instance details Defined in Amazonka.QLDB.GetRevision Methods toJSON :: GetRevision -> Value # toEncoding :: GetRevision -> Encoding # toJSONList :: [GetRevision] -> Value # toEncodingList :: [GetRevision] -> Encoding #
AWSRequest GetRevision Source #
Instance details Defined in Amazonka.QLDB.GetRevision Associated Types type AWSResponse GetRevision # Methods request :: GetRevision -> Request GetRevision # response :: MonadResource m => Logger -> Service -> Proxy GetRevision -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRevision))) #
ToHeaders GetRevision Source #
Instance details Defined in Amazonka.QLDB.GetRevision Methods toHeaders :: GetRevision -> [Header] #
ToPath GetRevision Source #
Instance details Defined in Amazonka.QLDB.GetRevision Methods toPath :: GetRevision -> ByteString #
ToQuery GetRevision Source #
Instance details Defined in Amazonka.QLDB.GetRevision Methods toQuery :: GetRevision -> QueryString #
type Rep GetRevision Source #
Instance details Defined in Amazonka.QLDB.GetRevision type Rep GetRevision = D1 ('MetaData "GetRevision" "Amazonka.QLDB.GetRevision" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "GetRevision'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "digestTipAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive ValueHolder))) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "blockAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive ValueHolder)) :*: S1 ('MetaSel ('Just "documentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetRevision Source #
Instance details Defined in Amazonka.QLDB.GetRevision type AWSResponse GetRevision = GetRevisionResponse

newGetRevision Source #

Arguments

:: Text	`$sel:name:GetRevision'`
-> ValueHolder	`$sel:blockAddress:GetRevision'`
-> Text	`$sel:documentId:GetRevision'`
-> GetRevision

Create a value of GetRevision 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:digestTipAddress:GetRevision', getRevision_digestTipAddress - The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}.

$sel:name:GetRevision', getRevision_name - The name of the ledger.

$sel:blockAddress:GetRevision', getRevision_blockAddress - The block location of the document revision to be verified. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}.

$sel:documentId:GetRevision', getRevision_documentId - The UUID (represented in Base62-encoded text) of the document to be verified.

Request Lenses

getRevision_digestTipAddress :: Lens' GetRevision (Maybe ValueHolder) Source #

The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}.

getRevision_name :: Lens' GetRevision Text Source #

The name of the ledger.

getRevision_blockAddress :: Lens' GetRevision ValueHolder Source #

The block location of the document revision to be verified. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}.

getRevision_documentId :: Lens' GetRevision Text Source #

The UUID (represented in Base62-encoded text) of the document to be verified.

Destructuring the Response

data GetRevisionResponse Source #

See: newGetRevisionResponse smart constructor.

Constructors

GetRevisionResponse'

Fields

proof :: Maybe (Sensitive ValueHolder)
The proof object in Amazon Ion format returned by a GetRevision request. A proof contains the list of hash values that are required to recalculate the specified digest using a Merkle tree, starting with the specified document revision.
httpStatus :: Int
The response's http status code.
revision :: Sensitive ValueHolder
The document revision data object in Amazon Ion format.

Instances

Instances details

Eq GetRevisionResponse Source #
Instance details Defined in Amazonka.QLDB.GetRevision Methods (==) :: GetRevisionResponse -> GetRevisionResponse -> Bool # (/=) :: GetRevisionResponse -> GetRevisionResponse -> Bool #
Show GetRevisionResponse Source #
Instance details Defined in Amazonka.QLDB.GetRevision Methods showsPrec :: Int -> GetRevisionResponse -> ShowS # show :: GetRevisionResponse -> String # showList :: [GetRevisionResponse] -> ShowS #
Generic GetRevisionResponse Source #
Instance details Defined in Amazonka.QLDB.GetRevision Associated Types type Rep GetRevisionResponse :: Type -> Type # Methods from :: GetRevisionResponse -> Rep GetRevisionResponse x # to :: Rep GetRevisionResponse x -> GetRevisionResponse #
NFData GetRevisionResponse Source #
Instance details Defined in Amazonka.QLDB.GetRevision Methods rnf :: GetRevisionResponse -> () #
type Rep GetRevisionResponse Source #
Instance details Defined in Amazonka.QLDB.GetRevision type Rep GetRevisionResponse = D1 ('MetaData "GetRevisionResponse" "Amazonka.QLDB.GetRevision" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "GetRevisionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "proof") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive ValueHolder))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "revision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive ValueHolder)))))

newGetRevisionResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetRevisionResponse'`
-> ValueHolder	`$sel:revision:GetRevisionResponse'`
-> GetRevisionResponse

Create a value of GetRevisionResponse 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:proof:GetRevisionResponse', getRevisionResponse_proof - The proof object in Amazon Ion format returned by a GetRevision request. A proof contains the list of hash values that are required to recalculate the specified digest using a Merkle tree, starting with the specified document revision.

$sel:httpStatus:GetRevisionResponse', getRevisionResponse_httpStatus - The response's http status code.

$sel:revision:GetRevisionResponse', getRevisionResponse_revision - The document revision data object in Amazon Ion format.

Response Lenses

getRevisionResponse_proof :: Lens' GetRevisionResponse (Maybe ValueHolder) Source #

The proof object in Amazon Ion format returned by a GetRevision request. A proof contains the list of hash values that are required to recalculate the specified digest using a Merkle tree, starting with the specified document revision.

getRevisionResponse_httpStatus :: Lens' GetRevisionResponse Int Source #

The response's http status code.

getRevisionResponse_revision :: Lens' GetRevisionResponse ValueHolder Source #

The document revision data object in Amazon Ion format.