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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.

Synopsis

data DescribeLedger = DescribeLedger' {
- name :: Text
}
newDescribeLedger :: Text -> DescribeLedger
describeLedger_name :: Lens' DescribeLedger Text
data DescribeLedgerResponse = DescribeLedgerResponse' {
- state :: Maybe LedgerState
- deletionProtection :: Maybe Bool
- arn :: Maybe Text
- encryptionDescription :: Maybe LedgerEncryptionDescription
- name :: Maybe Text
- creationDateTime :: Maybe POSIX
- permissionsMode :: Maybe PermissionsMode
- httpStatus :: Int
}
newDescribeLedgerResponse :: Int -> DescribeLedgerResponse
describeLedgerResponse_state :: Lens' DescribeLedgerResponse (Maybe LedgerState)
describeLedgerResponse_deletionProtection :: Lens' DescribeLedgerResponse (Maybe Bool)
describeLedgerResponse_arn :: Lens' DescribeLedgerResponse (Maybe Text)
describeLedgerResponse_encryptionDescription :: Lens' DescribeLedgerResponse (Maybe LedgerEncryptionDescription)
describeLedgerResponse_name :: Lens' DescribeLedgerResponse (Maybe Text)
describeLedgerResponse_creationDateTime :: Lens' DescribeLedgerResponse (Maybe UTCTime)
describeLedgerResponse_permissionsMode :: Lens' DescribeLedgerResponse (Maybe PermissionsMode)
describeLedgerResponse_httpStatus :: Lens' DescribeLedgerResponse Int

Creating a Request

data DescribeLedger Source #

See: newDescribeLedger smart constructor.

Constructors

DescribeLedger'
Fields name :: Text The name of the ledger that you want to describe.

Instances

Instances details

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

newDescribeLedger Source #

Arguments

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

Create a value of DescribeLedger 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:DescribeLedger', describeLedger_name - The name of the ledger that you want to describe.

Request Lenses

describeLedger_name :: Lens' DescribeLedger Text Source #

The name of the ledger that you want to describe.

Destructuring the Response

data DescribeLedgerResponse Source #

See: newDescribeLedgerResponse smart constructor.

Constructors

DescribeLedgerResponse'

Fields

state :: Maybe LedgerState
The current status of the ledger.
deletionProtection :: Maybe Bool
The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.
If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false.
arn :: Maybe Text
The Amazon Resource Name (ARN) for the ledger.
encryptionDescription :: Maybe LedgerEncryptionDescription
Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error).
name :: Maybe Text
The name of the ledger.
creationDateTime :: Maybe POSIX
The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
permissionsMode :: Maybe PermissionsMode
The permissions mode of the ledger.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.DescribeLedger Methods (==) :: DescribeLedgerResponse -> DescribeLedgerResponse -> Bool # (/=) :: DescribeLedgerResponse -> DescribeLedgerResponse -> Bool #
Read DescribeLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.DescribeLedger Methods readsPrec :: Int -> ReadS DescribeLedgerResponse # readList :: ReadS [DescribeLedgerResponse] # readPrec :: ReadPrec DescribeLedgerResponse # readListPrec :: ReadPrec [DescribeLedgerResponse] #
Show DescribeLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.DescribeLedger Methods showsPrec :: Int -> DescribeLedgerResponse -> ShowS # show :: DescribeLedgerResponse -> String # showList :: [DescribeLedgerResponse] -> ShowS #
Generic DescribeLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.DescribeLedger Associated Types type Rep DescribeLedgerResponse :: Type -> Type # Methods from :: DescribeLedgerResponse -> Rep DescribeLedgerResponse x # to :: Rep DescribeLedgerResponse x -> DescribeLedgerResponse #
NFData DescribeLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.DescribeLedger Methods rnf :: DescribeLedgerResponse -> () #
type Rep DescribeLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.DescribeLedger type Rep DescribeLedgerResponse = D1 ('MetaData "DescribeLedgerResponse" "Amazonka.QLDB.DescribeLedger" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "DescribeLedgerResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LedgerState)) :: S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "encryptionDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LedgerEncryptionDescription)))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "permissionsMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PermissionsMode)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeLedgerResponse Source #

Arguments

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

Create a value of DescribeLedgerResponse 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:state:DescribeLedgerResponse', describeLedgerResponse_state - The current status of the ledger.

$sel:deletionProtection:DescribeLedgerResponse', describeLedgerResponse_deletionProtection - The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false.

$sel:arn:DescribeLedgerResponse', describeLedgerResponse_arn - The Amazon Resource Name (ARN) for the ledger.

$sel:encryptionDescription:DescribeLedgerResponse', describeLedgerResponse_encryptionDescription - Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error).

$sel:name:DescribeLedger', describeLedgerResponse_name - The name of the ledger.

$sel:creationDateTime:DescribeLedgerResponse', describeLedgerResponse_creationDateTime - The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

$sel:permissionsMode:DescribeLedgerResponse', describeLedgerResponse_permissionsMode - The permissions mode of the ledger.

$sel:httpStatus:DescribeLedgerResponse', describeLedgerResponse_httpStatus - The response's http status code.

Response Lenses

describeLedgerResponse_state :: Lens' DescribeLedgerResponse (Maybe LedgerState) Source #

The current status of the ledger.

describeLedgerResponse_deletionProtection :: Lens' DescribeLedgerResponse (Maybe Bool) Source #

The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false.

describeLedgerResponse_arn :: Lens' DescribeLedgerResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the ledger.

describeLedgerResponse_encryptionDescription :: Lens' DescribeLedgerResponse (Maybe LedgerEncryptionDescription) Source #

Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error).

describeLedgerResponse_name :: Lens' DescribeLedgerResponse (Maybe Text) Source #

The name of the ledger.

describeLedgerResponse_creationDateTime :: Lens' DescribeLedgerResponse (Maybe UTCTime) Source #

The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

describeLedgerResponse_permissionsMode :: Lens' DescribeLedgerResponse (Maybe PermissionsMode) Source #

The permissions mode of the ledger.

describeLedgerResponse_httpStatus :: Lens' DescribeLedgerResponse Int Source #

The response's http status code.