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.GetDigest

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address.

Synopsis

Creating a Request

data GetDigest Source #

See: newGetDigest smart constructor.

Constructors

GetDigest'
Fields name :: Text The name of the ledger.

Instances

Instances details

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

newGetDigest Source #

Arguments

:: Text	`$sel:name:GetDigest'`
-> GetDigest

Create a value of GetDigest 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:name:GetDigest', getDigest_name - The name of the ledger.

Request Lenses

getDigest_name :: Lens' GetDigest Text Source #

The name of the ledger.

Destructuring the Response

data GetDigestResponse Source #

See: newGetDigestResponse smart constructor.

Constructors

GetDigestResponse'
Fields httpStatus :: Int The response's http status code. digest :: Base64 The 256-bit hash value representing the digest returned by a `GetDigest` request. digestTipAddress :: Sensitive ValueHolder The latest block location covered by the digest that you requested. An address is an Amazon Ion structure that has two fields: `strandId` and `sequenceNo`.

Instances

Instances details

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

newGetDigestResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDigestResponse'`
-> ByteString	`$sel:digest:GetDigestResponse'`
-> ValueHolder	`$sel:digestTipAddress:GetDigestResponse'`
-> GetDigestResponse

Create a value of GetDigestResponse 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:httpStatus:GetDigestResponse', getDigestResponse_httpStatus - The response's http status code.

$sel:digest:GetDigestResponse', getDigestResponse_digest - The 256-bit hash value representing the digest returned by a GetDigest request.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:digestTipAddress:GetDigestResponse', getDigestResponse_digestTipAddress - The latest block location covered by the digest that you requested. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

Response Lenses

getDigestResponse_httpStatus :: Lens' GetDigestResponse Int Source #

The response's http status code.

getDigestResponse_digest :: Lens' GetDigestResponse ByteString Source #

The 256-bit hash value representing the digest returned by a GetDigest request.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

getDigestResponse_digestTipAddress :: Lens' GetDigestResponse ValueHolder Source #

The latest block location covered by the digest that you requested. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.