libZSservicesZSamazonka-qldbZSamazonka-qldb
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.QLDB.Types

Description

 
Synopsis

Service Configuration

defaultService :: Service Source #

API version 2019-01-02 of the Amazon QLDB SDK configuration.

Errors

_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #

One or more parameters in the request aren't valid.

_ResourcePreconditionNotMetException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The operation failed because a condition wasn't satisfied in advance.

_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified resource already exists.

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified resource doesn't exist.

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

You have reached the limit on the maximum number of resources allowed.

_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified resource can't be modified at this time.

EncryptionStatus

newtype EncryptionStatus Source #

Instances

Instances details
Eq EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

Ord EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

Read EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

Show EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

Generic EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

Associated Types

type Rep EncryptionStatus :: Type -> Type #

NFData EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

Methods

rnf :: EncryptionStatus -> () #

Hashable EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

ToJSON EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

ToJSONKey EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

FromJSON EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

FromJSONKey EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

ToLog EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

ToHeader EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

ToQuery EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

FromXML EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

ToXML EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

ToByteString EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

FromText EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

ToText EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

type Rep EncryptionStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.EncryptionStatus

type Rep EncryptionStatus = D1 ('MetaData "EncryptionStatus" "Amazonka.QLDB.Types.EncryptionStatus" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'True) (C1 ('MetaCons "EncryptionStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEncryptionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ErrorCause

newtype ErrorCause Source #

Constructors

ErrorCause' 

Fields

Instances

Instances details
Eq ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

Ord ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

Read ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

Show ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

Generic ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

Associated Types

type Rep ErrorCause :: Type -> Type #

NFData ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

Methods

rnf :: ErrorCause -> () #

Hashable ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

ToJSON ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

ToJSONKey ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

FromJSON ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

FromJSONKey ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

ToLog ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

ToHeader ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

ToQuery ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

FromXML ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

ToXML ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

Methods

toXML :: ErrorCause -> XML #

ToByteString ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

FromText ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

ToText ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

Methods

toText :: ErrorCause -> Text #

type Rep ErrorCause Source # 
Instance details

Defined in Amazonka.QLDB.Types.ErrorCause

type Rep ErrorCause = D1 ('MetaData "ErrorCause" "Amazonka.QLDB.Types.ErrorCause" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'True) (C1 ('MetaCons "ErrorCause'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromErrorCause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ExportStatus

newtype ExportStatus Source #

Constructors

ExportStatus' 

Instances

Instances details
Eq ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

Ord ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

Read ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

Show ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

Generic ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

Associated Types

type Rep ExportStatus :: Type -> Type #

NFData ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

Methods

rnf :: ExportStatus -> () #

Hashable ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

ToJSON ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

ToJSONKey ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

FromJSON ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

FromJSONKey ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

ToLog ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

ToHeader ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

ToQuery ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

FromXML ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

ToXML ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

Methods

toXML :: ExportStatus -> XML #

ToByteString ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

FromText ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

ToText ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

Methods

toText :: ExportStatus -> Text #

type Rep ExportStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.ExportStatus

type Rep ExportStatus = D1 ('MetaData "ExportStatus" "Amazonka.QLDB.Types.ExportStatus" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'True) (C1 ('MetaCons "ExportStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromExportStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

LedgerState

newtype LedgerState Source #

Constructors

LedgerState' 

Instances

Instances details
Eq LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

Ord LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

Read LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

Show LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

Generic LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

Associated Types

type Rep LedgerState :: Type -> Type #

NFData LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

Methods

rnf :: LedgerState -> () #

Hashable LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

ToJSON LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

ToJSONKey LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

FromJSON LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

FromJSONKey LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

ToLog LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

ToHeader LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

ToQuery LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

FromXML LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

ToXML LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

Methods

toXML :: LedgerState -> XML #

ToByteString LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

FromText LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

ToText LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

Methods

toText :: LedgerState -> Text #

type Rep LedgerState Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerState

type Rep LedgerState = D1 ('MetaData "LedgerState" "Amazonka.QLDB.Types.LedgerState" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'True) (C1 ('MetaCons "LedgerState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromLedgerState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

PermissionsMode

newtype PermissionsMode Source #

Constructors

PermissionsMode' 

Instances

Instances details
Eq PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

Ord PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

Read PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

Show PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

Generic PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

Associated Types

type Rep PermissionsMode :: Type -> Type #

NFData PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

Methods

rnf :: PermissionsMode -> () #

Hashable PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

ToJSON PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

ToJSONKey PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

FromJSON PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

FromJSONKey PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

ToLog PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

ToHeader PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

ToQuery PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

FromXML PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

ToXML PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

Methods

toXML :: PermissionsMode -> XML #

ToByteString PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

FromText PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

ToText PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

type Rep PermissionsMode Source # 
Instance details

Defined in Amazonka.QLDB.Types.PermissionsMode

type Rep PermissionsMode = D1 ('MetaData "PermissionsMode" "Amazonka.QLDB.Types.PermissionsMode" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'True) (C1 ('MetaCons "PermissionsMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPermissionsMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

S3ObjectEncryptionType

newtype S3ObjectEncryptionType Source #

Instances

Instances details
Eq S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

Ord S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

Read S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

Show S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

Generic S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

Associated Types

type Rep S3ObjectEncryptionType :: Type -> Type #

NFData S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

Methods

rnf :: S3ObjectEncryptionType -> () #

Hashable S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

ToJSON S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

ToJSONKey S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

FromJSON S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

FromJSONKey S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

ToLog S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

ToHeader S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

ToQuery S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

FromXML S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

ToXML S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

ToByteString S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

FromText S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

ToText S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

type Rep S3ObjectEncryptionType Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ObjectEncryptionType

type Rep S3ObjectEncryptionType = D1 ('MetaData "S3ObjectEncryptionType" "Amazonka.QLDB.Types.S3ObjectEncryptionType" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'True) (C1 ('MetaCons "S3ObjectEncryptionType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromS3ObjectEncryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

StreamStatus

newtype StreamStatus Source #

Constructors

StreamStatus' 

Instances

Instances details
Eq StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

Ord StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

Read StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

Show StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

Generic StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

Associated Types

type Rep StreamStatus :: Type -> Type #

NFData StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

Methods

rnf :: StreamStatus -> () #

Hashable StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

ToJSON StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

ToJSONKey StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

FromJSON StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

FromJSONKey StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

ToLog StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

ToHeader StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

ToQuery StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

FromXML StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

ToXML StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

Methods

toXML :: StreamStatus -> XML #

ToByteString StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

FromText StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

ToText StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

Methods

toText :: StreamStatus -> Text #

type Rep StreamStatus Source # 
Instance details

Defined in Amazonka.QLDB.Types.StreamStatus

type Rep StreamStatus = D1 ('MetaData "StreamStatus" "Amazonka.QLDB.Types.StreamStatus" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'True) (C1 ('MetaCons "StreamStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromStreamStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

JournalKinesisStreamDescription

data JournalKinesisStreamDescription Source #

Information about an Amazon QLDB journal stream, including the Amazon Resource Name (ARN), stream name, creation time, current status, and the parameters of the original stream creation request.

See: newJournalKinesisStreamDescription smart constructor.

Constructors

JournalKinesisStreamDescription' 

Fields

  • creationTime :: Maybe POSIX

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

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the QLDB journal stream.

  • inclusiveStartTime :: Maybe POSIX

    The inclusive start date and time from which to start streaming journal data.

  • errorCause :: Maybe ErrorCause

    The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.

  • exclusiveEndTime :: Maybe POSIX

    The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.

  • ledgerName :: Text

    The name of the ledger.

  • roleArn :: Text

    The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.

  • streamId :: Text

    The UUID (represented in Base62-encoded text) of the QLDB journal stream.

  • status :: StreamStatus

    The current state of the QLDB journal stream.

  • kinesisConfiguration :: KinesisConfiguration

    The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.

  • streamName :: Text

    The user-defined name of the QLDB journal stream.

Instances

Instances details
Eq JournalKinesisStreamDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.JournalKinesisStreamDescription

Read JournalKinesisStreamDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.JournalKinesisStreamDescription

Show JournalKinesisStreamDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.JournalKinesisStreamDescription

Generic JournalKinesisStreamDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.JournalKinesisStreamDescription

Associated Types

type Rep JournalKinesisStreamDescription :: Type -> Type #

NFData JournalKinesisStreamDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.JournalKinesisStreamDescription

Hashable JournalKinesisStreamDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.JournalKinesisStreamDescription

FromJSON JournalKinesisStreamDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.JournalKinesisStreamDescription

type Rep JournalKinesisStreamDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.JournalKinesisStreamDescription

type Rep JournalKinesisStreamDescription = D1 ('MetaData "JournalKinesisStreamDescription" "Amazonka.QLDB.Types.JournalKinesisStreamDescription" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "JournalKinesisStreamDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "inclusiveStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "errorCause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorCause)) :*: S1 ('MetaSel ('Just "exclusiveEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "ledgerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StreamStatus) :*: (S1 ('MetaSel ('Just "kinesisConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 KinesisConfiguration) :*: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newJournalKinesisStreamDescription Source #

Create a value of JournalKinesisStreamDescription 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:creationTime:JournalKinesisStreamDescription', journalKinesisStreamDescription_creationTime - The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

$sel:arn:JournalKinesisStreamDescription', journalKinesisStreamDescription_arn - The Amazon Resource Name (ARN) of the QLDB journal stream.

$sel:inclusiveStartTime:JournalKinesisStreamDescription', journalKinesisStreamDescription_inclusiveStartTime - The inclusive start date and time from which to start streaming journal data.

$sel:errorCause:JournalKinesisStreamDescription', journalKinesisStreamDescription_errorCause - The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.

$sel:exclusiveEndTime:JournalKinesisStreamDescription', journalKinesisStreamDescription_exclusiveEndTime - The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.

$sel:ledgerName:JournalKinesisStreamDescription', journalKinesisStreamDescription_ledgerName - The name of the ledger.

$sel:roleArn:JournalKinesisStreamDescription', journalKinesisStreamDescription_roleArn - The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.

$sel:streamId:JournalKinesisStreamDescription', journalKinesisStreamDescription_streamId - The UUID (represented in Base62-encoded text) of the QLDB journal stream.

$sel:status:JournalKinesisStreamDescription', journalKinesisStreamDescription_status - The current state of the QLDB journal stream.

$sel:kinesisConfiguration:JournalKinesisStreamDescription', journalKinesisStreamDescription_kinesisConfiguration - The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.

$sel:streamName:JournalKinesisStreamDescription', journalKinesisStreamDescription_streamName - The user-defined name of the QLDB journal stream.

journalKinesisStreamDescription_creationTime :: Lens' JournalKinesisStreamDescription (Maybe UTCTime) Source #

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

journalKinesisStreamDescription_arn :: Lens' JournalKinesisStreamDescription (Maybe Text) Source #

The Amazon Resource Name (ARN) of the QLDB journal stream.

journalKinesisStreamDescription_inclusiveStartTime :: Lens' JournalKinesisStreamDescription (Maybe UTCTime) Source #

The inclusive start date and time from which to start streaming journal data.

journalKinesisStreamDescription_errorCause :: Lens' JournalKinesisStreamDescription (Maybe ErrorCause) Source #

The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.

journalKinesisStreamDescription_exclusiveEndTime :: Lens' JournalKinesisStreamDescription (Maybe UTCTime) Source #

The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.

journalKinesisStreamDescription_roleArn :: Lens' JournalKinesisStreamDescription Text Source #

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.

journalKinesisStreamDescription_streamId :: Lens' JournalKinesisStreamDescription Text Source #

The UUID (represented in Base62-encoded text) of the QLDB journal stream.

journalKinesisStreamDescription_kinesisConfiguration :: Lens' JournalKinesisStreamDescription KinesisConfiguration Source #

The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.

JournalS3ExportDescription

data JournalS3ExportDescription Source #

Information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request.

See: newJournalS3ExportDescription smart constructor.

Constructors

JournalS3ExportDescription' 

Fields

  • ledgerName :: Text

    The name of the ledger.

  • exportId :: Text

    The UUID (represented in Base62-encoded text) of the journal export job.

  • exportCreationTime :: POSIX

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

  • status :: ExportStatus

    The current state of the journal export job.

  • inclusiveStartTime :: POSIX

    The inclusive start date and time for the range of journal contents that are specified in the original export request.

  • exclusiveEndTime :: POSIX

    The exclusive end date and time for the range of journal contents that are specified in the original export request.

  • s3ExportConfiguration :: S3ExportConfiguration
     
  • roleArn :: Text

    The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

    • Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.
    • (Optional) Use your customer master key (CMK) in Key Management Service (KMS) for server-side encryption of your exported data.

Instances

Instances details
Eq JournalS3ExportDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.JournalS3ExportDescription

Read JournalS3ExportDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.JournalS3ExportDescription

Show JournalS3ExportDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.JournalS3ExportDescription

Generic JournalS3ExportDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.JournalS3ExportDescription

Associated Types

type Rep JournalS3ExportDescription :: Type -> Type #

NFData JournalS3ExportDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.JournalS3ExportDescription

Hashable JournalS3ExportDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.JournalS3ExportDescription

FromJSON JournalS3ExportDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.JournalS3ExportDescription

type Rep JournalS3ExportDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.JournalS3ExportDescription

type Rep JournalS3ExportDescription = D1 ('MetaData "JournalS3ExportDescription" "Amazonka.QLDB.Types.JournalS3ExportDescription" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "JournalS3ExportDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "ledgerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "exportId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "exportCreationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExportStatus))) :*: ((S1 ('MetaSel ('Just "inclusiveStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "exclusiveEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :*: (S1 ('MetaSel ('Just "s3ExportConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3ExportConfiguration) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newJournalS3ExportDescription Source #

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

$sel:exportId:JournalS3ExportDescription', journalS3ExportDescription_exportId - The UUID (represented in Base62-encoded text) of the journal export job.

$sel:exportCreationTime:JournalS3ExportDescription', journalS3ExportDescription_exportCreationTime - The date and time, in epoch time format, when the export job was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

$sel:status:JournalS3ExportDescription', journalS3ExportDescription_status - The current state of the journal export job.

$sel:inclusiveStartTime:JournalS3ExportDescription', journalS3ExportDescription_inclusiveStartTime - The inclusive start date and time for the range of journal contents that are specified in the original export request.

$sel:exclusiveEndTime:JournalS3ExportDescription', journalS3ExportDescription_exclusiveEndTime - The exclusive end date and time for the range of journal contents that are specified in the original export request.

$sel:s3ExportConfiguration:JournalS3ExportDescription', journalS3ExportDescription_s3ExportConfiguration - Undocumented member.

$sel:roleArn:JournalS3ExportDescription', journalS3ExportDescription_roleArn - The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

  • Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.
  • (Optional) Use your customer master key (CMK) in Key Management Service (KMS) for server-side encryption of your exported data.

journalS3ExportDescription_exportId :: Lens' JournalS3ExportDescription Text Source #

The UUID (represented in Base62-encoded text) of the journal export job.

journalS3ExportDescription_exportCreationTime :: Lens' JournalS3ExportDescription UTCTime Source #

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

journalS3ExportDescription_inclusiveStartTime :: Lens' JournalS3ExportDescription UTCTime Source #

The inclusive start date and time for the range of journal contents that are specified in the original export request.

journalS3ExportDescription_exclusiveEndTime :: Lens' JournalS3ExportDescription UTCTime Source #

The exclusive end date and time for the range of journal contents that are specified in the original export request.

journalS3ExportDescription_roleArn :: Lens' JournalS3ExportDescription Text Source #

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

  • Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.
  • (Optional) Use your customer master key (CMK) in Key Management Service (KMS) for server-side encryption of your exported data.

KinesisConfiguration

data KinesisConfiguration Source #

The configuration settings of the Amazon Kinesis Data Streams destination for an Amazon QLDB journal stream.

See: newKinesisConfiguration smart constructor.

Constructors

KinesisConfiguration' 

Fields

  • aggregationEnabled :: Maybe Bool

    Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.

    This option is enabled by default. Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide.

  • streamArn :: Text

    The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.

Instances

Instances details
Eq KinesisConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.KinesisConfiguration

Read KinesisConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.KinesisConfiguration

Show KinesisConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.KinesisConfiguration

Generic KinesisConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.KinesisConfiguration

Associated Types

type Rep KinesisConfiguration :: Type -> Type #

NFData KinesisConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.KinesisConfiguration

Methods

rnf :: KinesisConfiguration -> () #

Hashable KinesisConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.KinesisConfiguration

ToJSON KinesisConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.KinesisConfiguration

FromJSON KinesisConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.KinesisConfiguration

type Rep KinesisConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.KinesisConfiguration

type Rep KinesisConfiguration = D1 ('MetaData "KinesisConfiguration" "Amazonka.QLDB.Types.KinesisConfiguration" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "KinesisConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "aggregationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "streamArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newKinesisConfiguration Source #

Create a value of KinesisConfiguration 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:aggregationEnabled:KinesisConfiguration', kinesisConfiguration_aggregationEnabled - Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.

This option is enabled by default. Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide.

$sel:streamArn:KinesisConfiguration', kinesisConfiguration_streamArn - The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.

kinesisConfiguration_aggregationEnabled :: Lens' KinesisConfiguration (Maybe Bool) Source #

Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.

This option is enabled by default. Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide.

kinesisConfiguration_streamArn :: Lens' KinesisConfiguration Text Source #

The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.

LedgerEncryptionDescription

data LedgerEncryptionDescription Source #

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

For more information, see Encryption at rest in the Amazon QLDB Developer Guide.

See: newLedgerEncryptionDescription smart constructor.

Constructors

LedgerEncryptionDescription' 

Fields

  • inaccessibleKmsKeyDateTime :: Maybe POSIX

    The date and time, in epoch time format, when the KMS key first became inaccessible, in the case of an error. (Epoch time format is the number of seconds that have elapsed since 12:00:00 AM January 1, 1970 UTC.)

    This parameter is undefined if the KMS key is accessible.

  • kmsKeyArn :: Text

    The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

  • encryptionStatus :: EncryptionStatus

    The current state of encryption at rest for the ledger. This can be one of the following values:

    • ENABLED: Encryption is fully enabled using the specified key.
    • UPDATING: The ledger is actively processing the specified key change.

      Key changes in QLDB are asynchronous. The ledger is fully accessible without any performance impact while the key change is being processed. The amount of time it takes to update a key varies depending on the ledger size.

    • KMS_KEY_INACCESSIBLE: The specified customer managed KMS key is not accessible, and the ledger is impaired. Either the key was disabled or deleted, or the grants on the key were revoked. When a ledger is impaired, it is not accessible and does not accept any read or write requests.

      An impaired ledger automatically returns to an active state after you restore the grants on the key, or re-enable the key that was disabled. However, deleting a customer managed KMS key is irreversible. After a key is deleted, you can no longer access the ledgers that are protected with that key, and the data becomes unrecoverable permanently.

Instances

Instances details
Eq LedgerEncryptionDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerEncryptionDescription

Read LedgerEncryptionDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerEncryptionDescription

Show LedgerEncryptionDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerEncryptionDescription

Generic LedgerEncryptionDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerEncryptionDescription

Associated Types

type Rep LedgerEncryptionDescription :: Type -> Type #

NFData LedgerEncryptionDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerEncryptionDescription

Hashable LedgerEncryptionDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerEncryptionDescription

FromJSON LedgerEncryptionDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerEncryptionDescription

type Rep LedgerEncryptionDescription Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerEncryptionDescription

type Rep LedgerEncryptionDescription = D1 ('MetaData "LedgerEncryptionDescription" "Amazonka.QLDB.Types.LedgerEncryptionDescription" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "LedgerEncryptionDescription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "inaccessibleKmsKeyDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "kmsKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "encryptionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EncryptionStatus))))

newLedgerEncryptionDescription Source #

Create a value of LedgerEncryptionDescription 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:inaccessibleKmsKeyDateTime:LedgerEncryptionDescription', ledgerEncryptionDescription_inaccessibleKmsKeyDateTime - The date and time, in epoch time format, when the KMS key first became inaccessible, in the case of an error. (Epoch time format is the number of seconds that have elapsed since 12:00:00 AM January 1, 1970 UTC.)

This parameter is undefined if the KMS key is accessible.

$sel:kmsKeyArn:LedgerEncryptionDescription', ledgerEncryptionDescription_kmsKeyArn - The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

$sel:encryptionStatus:LedgerEncryptionDescription', ledgerEncryptionDescription_encryptionStatus - The current state of encryption at rest for the ledger. This can be one of the following values:

  • ENABLED: Encryption is fully enabled using the specified key.
  • UPDATING: The ledger is actively processing the specified key change.

    Key changes in QLDB are asynchronous. The ledger is fully accessible without any performance impact while the key change is being processed. The amount of time it takes to update a key varies depending on the ledger size.

  • KMS_KEY_INACCESSIBLE: The specified customer managed KMS key is not accessible, and the ledger is impaired. Either the key was disabled or deleted, or the grants on the key were revoked. When a ledger is impaired, it is not accessible and does not accept any read or write requests.

    An impaired ledger automatically returns to an active state after you restore the grants on the key, or re-enable the key that was disabled. However, deleting a customer managed KMS key is irreversible. After a key is deleted, you can no longer access the ledgers that are protected with that key, and the data becomes unrecoverable permanently.

ledgerEncryptionDescription_inaccessibleKmsKeyDateTime :: Lens' LedgerEncryptionDescription (Maybe UTCTime) Source #

The date and time, in epoch time format, when the KMS key first became inaccessible, in the case of an error. (Epoch time format is the number of seconds that have elapsed since 12:00:00 AM January 1, 1970 UTC.)

This parameter is undefined if the KMS key is accessible.

ledgerEncryptionDescription_kmsKeyArn :: Lens' LedgerEncryptionDescription Text Source #

The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

ledgerEncryptionDescription_encryptionStatus :: Lens' LedgerEncryptionDescription EncryptionStatus Source #

The current state of encryption at rest for the ledger. This can be one of the following values:

  • ENABLED: Encryption is fully enabled using the specified key.
  • UPDATING: The ledger is actively processing the specified key change.

    Key changes in QLDB are asynchronous. The ledger is fully accessible without any performance impact while the key change is being processed. The amount of time it takes to update a key varies depending on the ledger size.

  • KMS_KEY_INACCESSIBLE: The specified customer managed KMS key is not accessible, and the ledger is impaired. Either the key was disabled or deleted, or the grants on the key were revoked. When a ledger is impaired, it is not accessible and does not accept any read or write requests.

    An impaired ledger automatically returns to an active state after you restore the grants on the key, or re-enable the key that was disabled. However, deleting a customer managed KMS key is irreversible. After a key is deleted, you can no longer access the ledgers that are protected with that key, and the data becomes unrecoverable permanently.

LedgerSummary

data LedgerSummary Source #

Information about a ledger, including its name, state, and when it was created.

See: newLedgerSummary smart constructor.

Constructors

LedgerSummary' 

Fields

Instances

Instances details
Eq LedgerSummary Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerSummary

Read LedgerSummary Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerSummary

Show LedgerSummary Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerSummary

Generic LedgerSummary Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerSummary

Associated Types

type Rep LedgerSummary :: Type -> Type #

NFData LedgerSummary Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerSummary

Methods

rnf :: LedgerSummary -> () #

Hashable LedgerSummary Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerSummary

FromJSON LedgerSummary Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerSummary

type Rep LedgerSummary Source # 
Instance details

Defined in Amazonka.QLDB.Types.LedgerSummary

type Rep LedgerSummary = D1 ('MetaData "LedgerSummary" "Amazonka.QLDB.Types.LedgerSummary" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "LedgerSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LedgerState)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))

newLedgerSummary :: LedgerSummary Source #

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

$sel:name:LedgerSummary', ledgerSummary_name - The name of the ledger.

$sel:creationDateTime:LedgerSummary', ledgerSummary_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.)

ledgerSummary_state :: Lens' LedgerSummary (Maybe LedgerState) Source #

The current status of the ledger.

ledgerSummary_creationDateTime :: Lens' LedgerSummary (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.)

S3EncryptionConfiguration

data S3EncryptionConfiguration Source #

The encryption settings that are used by a journal export job to write data in an Amazon Simple Storage Service (Amazon S3) bucket.

See: newS3EncryptionConfiguration smart constructor.

Constructors

S3EncryptionConfiguration' 

Fields

  • kmsKeyArn :: Maybe Text

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) in Key Management Service (KMS). Amazon S3 does not support asymmetric CMKs.

    You must provide a KmsKeyArn if you specify SSE_KMS as the ObjectEncryptionType.

    KmsKeyArn is not required if you specify SSE_S3 as the ObjectEncryptionType.

  • objectEncryptionType :: S3ObjectEncryptionType

    The Amazon S3 object encryption type.

    To learn more about server-side encryption options in Amazon S3, see Protecting Data Using Server-Side Encryption in the Amazon S3 Developer Guide.

Instances

Instances details
Eq S3EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3EncryptionConfiguration

Read S3EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3EncryptionConfiguration

Show S3EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3EncryptionConfiguration

Generic S3EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3EncryptionConfiguration

Associated Types

type Rep S3EncryptionConfiguration :: Type -> Type #

NFData S3EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3EncryptionConfiguration

Hashable S3EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3EncryptionConfiguration

ToJSON S3EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3EncryptionConfiguration

FromJSON S3EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3EncryptionConfiguration

type Rep S3EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3EncryptionConfiguration

type Rep S3EncryptionConfiguration = D1 ('MetaData "S3EncryptionConfiguration" "Amazonka.QLDB.Types.S3EncryptionConfiguration" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "S3EncryptionConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "objectEncryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3ObjectEncryptionType)))

newS3EncryptionConfiguration Source #

Create a value of S3EncryptionConfiguration 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:kmsKeyArn:S3EncryptionConfiguration', s3EncryptionConfiguration_kmsKeyArn - The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) in Key Management Service (KMS). Amazon S3 does not support asymmetric CMKs.

You must provide a KmsKeyArn if you specify SSE_KMS as the ObjectEncryptionType.

KmsKeyArn is not required if you specify SSE_S3 as the ObjectEncryptionType.

$sel:objectEncryptionType:S3EncryptionConfiguration', s3EncryptionConfiguration_objectEncryptionType - The Amazon S3 object encryption type.

To learn more about server-side encryption options in Amazon S3, see Protecting Data Using Server-Side Encryption in the Amazon S3 Developer Guide.

s3EncryptionConfiguration_kmsKeyArn :: Lens' S3EncryptionConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) in Key Management Service (KMS). Amazon S3 does not support asymmetric CMKs.

You must provide a KmsKeyArn if you specify SSE_KMS as the ObjectEncryptionType.

KmsKeyArn is not required if you specify SSE_S3 as the ObjectEncryptionType.

s3EncryptionConfiguration_objectEncryptionType :: Lens' S3EncryptionConfiguration S3ObjectEncryptionType Source #

The Amazon S3 object encryption type.

To learn more about server-side encryption options in Amazon S3, see Protecting Data Using Server-Side Encryption in the Amazon S3 Developer Guide.

S3ExportConfiguration

data S3ExportConfiguration Source #

The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal contents.

See: newS3ExportConfiguration smart constructor.

Constructors

S3ExportConfiguration' 

Fields

  • bucket :: Text

    The Amazon S3 bucket name in which a journal export job writes the journal contents.

    The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and Limitations in the Amazon S3 Developer Guide.

  • prefix :: Text

    The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.

    The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in the Amazon S3 Developer Guide.

    The following are examples of valid Prefix values:

    • JournalExports-ForMyLedger/Testing/
    • JournalExports
    • My:Tests/
  • encryptionConfiguration :: S3EncryptionConfiguration

    The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.

Instances

Instances details
Eq S3ExportConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ExportConfiguration

Read S3ExportConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ExportConfiguration

Show S3ExportConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ExportConfiguration

Generic S3ExportConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ExportConfiguration

Associated Types

type Rep S3ExportConfiguration :: Type -> Type #

NFData S3ExportConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ExportConfiguration

Methods

rnf :: S3ExportConfiguration -> () #

Hashable S3ExportConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ExportConfiguration

ToJSON S3ExportConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ExportConfiguration

FromJSON S3ExportConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ExportConfiguration

type Rep S3ExportConfiguration Source # 
Instance details

Defined in Amazonka.QLDB.Types.S3ExportConfiguration

type Rep S3ExportConfiguration = D1 ('MetaData "S3ExportConfiguration" "Amazonka.QLDB.Types.S3ExportConfiguration" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "S3ExportConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "encryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3EncryptionConfiguration))))

newS3ExportConfiguration Source #

Create a value of S3ExportConfiguration 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:bucket:S3ExportConfiguration', s3ExportConfiguration_bucket - The Amazon S3 bucket name in which a journal export job writes the journal contents.

The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and Limitations in the Amazon S3 Developer Guide.

$sel:prefix:S3ExportConfiguration', s3ExportConfiguration_prefix - The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.

The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in the Amazon S3 Developer Guide.

The following are examples of valid Prefix values:

  • JournalExports-ForMyLedger/Testing/
  • JournalExports
  • My:Tests/

$sel:encryptionConfiguration:S3ExportConfiguration', s3ExportConfiguration_encryptionConfiguration - The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.

s3ExportConfiguration_bucket :: Lens' S3ExportConfiguration Text Source #

The Amazon S3 bucket name in which a journal export job writes the journal contents.

The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and Limitations in the Amazon S3 Developer Guide.

s3ExportConfiguration_prefix :: Lens' S3ExportConfiguration Text Source #

The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.

The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in the Amazon S3 Developer Guide.

The following are examples of valid Prefix values:

  • JournalExports-ForMyLedger/Testing/
  • JournalExports
  • My:Tests/

s3ExportConfiguration_encryptionConfiguration :: Lens' S3ExportConfiguration S3EncryptionConfiguration Source #

The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.

ValueHolder

data ValueHolder Source #

A structure that can contain a value in multiple encoding formats.

See: newValueHolder smart constructor.

Constructors

ValueHolder' 

Fields

Instances

Instances details
Eq ValueHolder Source # 
Instance details

Defined in Amazonka.QLDB.Types.ValueHolder

Show ValueHolder Source # 
Instance details

Defined in Amazonka.QLDB.Types.ValueHolder

Generic ValueHolder Source # 
Instance details

Defined in Amazonka.QLDB.Types.ValueHolder

Associated Types

type Rep ValueHolder :: Type -> Type #

NFData ValueHolder Source # 
Instance details

Defined in Amazonka.QLDB.Types.ValueHolder

Methods

rnf :: ValueHolder -> () #

Hashable ValueHolder Source # 
Instance details

Defined in Amazonka.QLDB.Types.ValueHolder

ToJSON ValueHolder Source # 
Instance details

Defined in Amazonka.QLDB.Types.ValueHolder

FromJSON ValueHolder Source # 
Instance details

Defined in Amazonka.QLDB.Types.ValueHolder

type Rep ValueHolder Source # 
Instance details

Defined in Amazonka.QLDB.Types.ValueHolder

type Rep ValueHolder = D1 ('MetaData "ValueHolder" "Amazonka.QLDB.Types.ValueHolder" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "ValueHolder'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ionText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))

newValueHolder :: ValueHolder Source #

Create a value of ValueHolder 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:ionText:ValueHolder', valueHolder_ionText - An Amazon Ion plaintext value contained in a ValueHolder structure.

valueHolder_ionText :: Lens' ValueHolder (Maybe Text) Source #

An Amazon Ion plaintext value contained in a ValueHolder structure.