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 |
- Service Configuration
- Errors
- Waiters
- Operations
- UpdateLedger
- DeleteLedger
- ListJournalKinesisStreamsForLedger
- ListTagsForResource
- GetRevision
- DescribeLedger
- CancelJournalKinesisStream
- ExportJournalToS3
- StreamJournalToKinesis
- CreateLedger
- ListLedgers
- ListJournalS3Exports
- UpdateLedgerPermissionsMode
- GetBlock
- ListJournalS3ExportsForLedger
- DescribeJournalKinesisStream
- DescribeJournalS3Export
- TagResource
- UntagResource
- GetDigest
- Types
Derived from API version 2019-01-02
of the AWS service descriptions, licensed under Apache 2.0.
The control plane for Amazon QLDB
Synopsis
- defaultService :: Service
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourcePreconditionNotMetException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- data UpdateLedger = UpdateLedger' (Maybe Bool) (Maybe Text) Text
- newUpdateLedger :: Text -> UpdateLedger
- data UpdateLedgerResponse = UpdateLedgerResponse' (Maybe LedgerState) (Maybe Bool) (Maybe Text) (Maybe LedgerEncryptionDescription) (Maybe Text) (Maybe POSIX) Int
- newUpdateLedgerResponse :: Int -> UpdateLedgerResponse
- data DeleteLedger = DeleteLedger' Text
- newDeleteLedger :: Text -> DeleteLedger
- data DeleteLedgerResponse = DeleteLedgerResponse' {
- newDeleteLedgerResponse :: DeleteLedgerResponse
- data ListJournalKinesisStreamsForLedger = ListJournalKinesisStreamsForLedger' (Maybe Text) (Maybe Natural) Text
- newListJournalKinesisStreamsForLedger :: Text -> ListJournalKinesisStreamsForLedger
- data ListJournalKinesisStreamsForLedgerResponse = ListJournalKinesisStreamsForLedgerResponse' (Maybe Text) (Maybe [JournalKinesisStreamDescription]) Int
- newListJournalKinesisStreamsForLedgerResponse :: Int -> ListJournalKinesisStreamsForLedgerResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data GetRevision = GetRevision' (Maybe (Sensitive ValueHolder)) Text (Sensitive ValueHolder) Text
- newGetRevision :: Text -> ValueHolder -> Text -> GetRevision
- data GetRevisionResponse = GetRevisionResponse' (Maybe (Sensitive ValueHolder)) Int (Sensitive ValueHolder)
- newGetRevisionResponse :: Int -> ValueHolder -> GetRevisionResponse
- data DescribeLedger = DescribeLedger' Text
- newDescribeLedger :: Text -> DescribeLedger
- data DescribeLedgerResponse = DescribeLedgerResponse' (Maybe LedgerState) (Maybe Bool) (Maybe Text) (Maybe LedgerEncryptionDescription) (Maybe Text) (Maybe POSIX) (Maybe PermissionsMode) Int
- newDescribeLedgerResponse :: Int -> DescribeLedgerResponse
- data CancelJournalKinesisStream = CancelJournalKinesisStream' Text Text
- newCancelJournalKinesisStream :: Text -> Text -> CancelJournalKinesisStream
- data CancelJournalKinesisStreamResponse = CancelJournalKinesisStreamResponse' (Maybe Text) Int
- newCancelJournalKinesisStreamResponse :: Int -> CancelJournalKinesisStreamResponse
- data ExportJournalToS3 = ExportJournalToS3' Text POSIX POSIX S3ExportConfiguration Text
- newExportJournalToS3 :: Text -> UTCTime -> UTCTime -> S3ExportConfiguration -> Text -> ExportJournalToS3
- data ExportJournalToS3Response = ExportJournalToS3Response' Int Text
- newExportJournalToS3Response :: Int -> Text -> ExportJournalToS3Response
- data StreamJournalToKinesis = StreamJournalToKinesis' (Maybe POSIX) (Maybe (HashMap Text Text)) Text Text POSIX KinesisConfiguration Text
- newStreamJournalToKinesis :: Text -> Text -> UTCTime -> KinesisConfiguration -> Text -> StreamJournalToKinesis
- data StreamJournalToKinesisResponse = StreamJournalToKinesisResponse' (Maybe Text) Int
- newStreamJournalToKinesisResponse :: Int -> StreamJournalToKinesisResponse
- data CreateLedger = CreateLedger' (Maybe Bool) (Maybe Text) (Maybe (HashMap Text Text)) Text PermissionsMode
- newCreateLedger :: Text -> PermissionsMode -> CreateLedger
- data CreateLedgerResponse = CreateLedgerResponse' (Maybe LedgerState) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe PermissionsMode) Int
- newCreateLedgerResponse :: Int -> CreateLedgerResponse
- data ListLedgers = ListLedgers' (Maybe Text) (Maybe Natural)
- newListLedgers :: ListLedgers
- data ListLedgersResponse = ListLedgersResponse' (Maybe [LedgerSummary]) (Maybe Text) Int
- newListLedgersResponse :: Int -> ListLedgersResponse
- data ListJournalS3Exports = ListJournalS3Exports' (Maybe Text) (Maybe Natural)
- newListJournalS3Exports :: ListJournalS3Exports
- data ListJournalS3ExportsResponse = ListJournalS3ExportsResponse' (Maybe [JournalS3ExportDescription]) (Maybe Text) Int
- newListJournalS3ExportsResponse :: Int -> ListJournalS3ExportsResponse
- data UpdateLedgerPermissionsMode = UpdateLedgerPermissionsMode' Text PermissionsMode
- newUpdateLedgerPermissionsMode :: Text -> PermissionsMode -> UpdateLedgerPermissionsMode
- data UpdateLedgerPermissionsModeResponse = UpdateLedgerPermissionsModeResponse' (Maybe Text) (Maybe Text) (Maybe PermissionsMode) Int
- newUpdateLedgerPermissionsModeResponse :: Int -> UpdateLedgerPermissionsModeResponse
- data GetBlock = GetBlock' (Maybe (Sensitive ValueHolder)) Text (Sensitive ValueHolder)
- newGetBlock :: Text -> ValueHolder -> GetBlock
- data GetBlockResponse = GetBlockResponse' (Maybe (Sensitive ValueHolder)) Int (Sensitive ValueHolder)
- newGetBlockResponse :: Int -> ValueHolder -> GetBlockResponse
- data ListJournalS3ExportsForLedger = ListJournalS3ExportsForLedger' (Maybe Text) (Maybe Natural) Text
- newListJournalS3ExportsForLedger :: Text -> ListJournalS3ExportsForLedger
- data ListJournalS3ExportsForLedgerResponse = ListJournalS3ExportsForLedgerResponse' (Maybe [JournalS3ExportDescription]) (Maybe Text) Int
- newListJournalS3ExportsForLedgerResponse :: Int -> ListJournalS3ExportsForLedgerResponse
- data DescribeJournalKinesisStream = DescribeJournalKinesisStream' Text Text
- newDescribeJournalKinesisStream :: Text -> Text -> DescribeJournalKinesisStream
- data DescribeJournalKinesisStreamResponse = DescribeJournalKinesisStreamResponse' (Maybe JournalKinesisStreamDescription) Int
- newDescribeJournalKinesisStreamResponse :: Int -> DescribeJournalKinesisStreamResponse
- data DescribeJournalS3Export = DescribeJournalS3Export' Text Text
- newDescribeJournalS3Export :: Text -> Text -> DescribeJournalS3Export
- data DescribeJournalS3ExportResponse = DescribeJournalS3ExportResponse' Int JournalS3ExportDescription
- newDescribeJournalS3ExportResponse :: Int -> JournalS3ExportDescription -> DescribeJournalS3ExportResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data GetDigest = GetDigest' Text
- newGetDigest :: Text -> GetDigest
- data GetDigestResponse = GetDigestResponse' Int Base64 (Sensitive ValueHolder)
- newGetDigestResponse :: Int -> ByteString -> ValueHolder -> GetDigestResponse
- newtype EncryptionStatus where
- EncryptionStatus' { }
- pattern EncryptionStatus_ENABLED :: EncryptionStatus
- pattern EncryptionStatus_KMS_KEY_INACCESSIBLE :: EncryptionStatus
- pattern EncryptionStatus_UPDATING :: EncryptionStatus
- newtype ErrorCause where
- ErrorCause' { }
- pattern ErrorCause_IAM_PERMISSION_REVOKED :: ErrorCause
- pattern ErrorCause_KINESIS_STREAM_NOT_FOUND :: ErrorCause
- newtype ExportStatus where
- ExportStatus' { }
- pattern ExportStatus_CANCELLED :: ExportStatus
- pattern ExportStatus_COMPLETED :: ExportStatus
- pattern ExportStatus_IN_PROGRESS :: ExportStatus
- newtype LedgerState where
- LedgerState' { }
- pattern LedgerState_ACTIVE :: LedgerState
- pattern LedgerState_CREATING :: LedgerState
- pattern LedgerState_DELETED :: LedgerState
- pattern LedgerState_DELETING :: LedgerState
- newtype PermissionsMode where
- PermissionsMode' { }
- pattern PermissionsMode_ALLOW_ALL :: PermissionsMode
- pattern PermissionsMode_STANDARD :: PermissionsMode
- newtype S3ObjectEncryptionType where
- newtype StreamStatus where
- StreamStatus' { }
- pattern StreamStatus_ACTIVE :: StreamStatus
- pattern StreamStatus_CANCELED :: StreamStatus
- pattern StreamStatus_COMPLETED :: StreamStatus
- pattern StreamStatus_FAILED :: StreamStatus
- pattern StreamStatus_IMPAIRED :: StreamStatus
- data JournalKinesisStreamDescription = JournalKinesisStreamDescription' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe ErrorCause) (Maybe POSIX) Text Text Text StreamStatus KinesisConfiguration Text
- newJournalKinesisStreamDescription :: Text -> Text -> Text -> StreamStatus -> KinesisConfiguration -> Text -> JournalKinesisStreamDescription
- data JournalS3ExportDescription = JournalS3ExportDescription' Text Text POSIX ExportStatus POSIX POSIX S3ExportConfiguration Text
- newJournalS3ExportDescription :: Text -> Text -> UTCTime -> ExportStatus -> UTCTime -> UTCTime -> S3ExportConfiguration -> Text -> JournalS3ExportDescription
- data KinesisConfiguration = KinesisConfiguration' (Maybe Bool) Text
- newKinesisConfiguration :: Text -> KinesisConfiguration
- data LedgerEncryptionDescription = LedgerEncryptionDescription' (Maybe POSIX) Text EncryptionStatus
- newLedgerEncryptionDescription :: Text -> EncryptionStatus -> LedgerEncryptionDescription
- data LedgerSummary = LedgerSummary' (Maybe LedgerState) (Maybe Text) (Maybe POSIX)
- newLedgerSummary :: LedgerSummary
- data S3EncryptionConfiguration = S3EncryptionConfiguration' (Maybe Text) S3ObjectEncryptionType
- newS3EncryptionConfiguration :: S3ObjectEncryptionType -> S3EncryptionConfiguration
- data S3ExportConfiguration = S3ExportConfiguration' Text Text S3EncryptionConfiguration
- newS3ExportConfiguration :: Text -> Text -> S3EncryptionConfiguration -> S3ExportConfiguration
- data ValueHolder = ValueHolder' (Maybe (Sensitive Text))
- newValueHolder :: ValueHolder
Service Configuration
defaultService :: Service Source #
API version 2019-01-02
of the Amazon QLDB SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by QLDB
.
InvalidParameterException
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more parameters in the request aren't valid.
ResourcePreconditionNotMetException
_ResourcePreconditionNotMetException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation failed because a condition wasn't satisfied in advance.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource already exists.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource doesn't exist.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have reached the limit on the maximum number of resources allowed.
ResourceInUseException
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource can't be modified at this time.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
UpdateLedger
data UpdateLedger Source #
See: newUpdateLedger
smart constructor.
Instances
Create a value of UpdateLedger
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:deletionProtection:UpdateLedger'
, updateLedger_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:kmsKey:UpdateLedger'
, updateLedger_kmsKey
- The key in Key Management Service (KMS) to use for encryption of data at
rest in the ledger. For more information, see
Encryption at rest
in the Amazon QLDB Developer Guide.
Use one of the following options to specify this parameter:
AWS_OWNED_KMS_KEY
: Use an KMS key that is owned and managed by Amazon Web Services on your behalf.- Undefined: Make no changes to the KMS key of the ledger.
A valid symmetric customer managed KMS key: Use the specified KMS key in your account that you create, own, and manage.
Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.
To specify a customer managed KMS key, you can use its key ID, Amazon
Resource Name (ARN), alias name, or alias ARN. When using an alias name,
prefix it with "alias/"
. To specify a key in a different account,
you must use the key ARN or alias ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Alias name:
alias/ExampleAlias
- Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
$sel:name:UpdateLedger'
, updateLedger_name
- The name of the ledger.
data UpdateLedgerResponse Source #
See: newUpdateLedgerResponse
smart constructor.
UpdateLedgerResponse' (Maybe LedgerState) (Maybe Bool) (Maybe Text) (Maybe LedgerEncryptionDescription) (Maybe Text) (Maybe POSIX) Int |
Instances
newUpdateLedgerResponse Source #
Create a value of UpdateLedgerResponse
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:UpdateLedgerResponse'
, updateLedgerResponse_state
- The current status of the ledger.
$sel:deletionProtection:UpdateLedger'
, updateLedgerResponse_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:UpdateLedgerResponse'
, updateLedgerResponse_arn
- The Amazon Resource Name (ARN) for the ledger.
$sel:encryptionDescription:UpdateLedgerResponse'
, updateLedgerResponse_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:UpdateLedger'
, updateLedgerResponse_name
- The name of the ledger.
$sel:creationDateTime:UpdateLedgerResponse'
, updateLedgerResponse_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:httpStatus:UpdateLedgerResponse'
, updateLedgerResponse_httpStatus
- The response's http status code.
DeleteLedger
data DeleteLedger Source #
See: newDeleteLedger
smart constructor.
Instances
Create a value of DeleteLedger
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:DeleteLedger'
, deleteLedger_name
- The name of the ledger that you want to delete.
data DeleteLedgerResponse Source #
See: newDeleteLedgerResponse
smart constructor.
Instances
Eq DeleteLedgerResponse Source # | |
Defined in Amazonka.QLDB.DeleteLedger (==) :: DeleteLedgerResponse -> DeleteLedgerResponse -> Bool # (/=) :: DeleteLedgerResponse -> DeleteLedgerResponse -> Bool # | |
Read DeleteLedgerResponse Source # | |
Defined in Amazonka.QLDB.DeleteLedger | |
Show DeleteLedgerResponse Source # | |
Defined in Amazonka.QLDB.DeleteLedger showsPrec :: Int -> DeleteLedgerResponse -> ShowS # show :: DeleteLedgerResponse -> String # showList :: [DeleteLedgerResponse] -> ShowS # | |
Generic DeleteLedgerResponse Source # | |
Defined in Amazonka.QLDB.DeleteLedger type Rep DeleteLedgerResponse :: Type -> Type # from :: DeleteLedgerResponse -> Rep DeleteLedgerResponse x # to :: Rep DeleteLedgerResponse x -> DeleteLedgerResponse # | |
NFData DeleteLedgerResponse Source # | |
Defined in Amazonka.QLDB.DeleteLedger rnf :: DeleteLedgerResponse -> () # | |
type Rep DeleteLedgerResponse Source # | |
newDeleteLedgerResponse :: DeleteLedgerResponse Source #
Create a value of DeleteLedgerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListJournalKinesisStreamsForLedger
data ListJournalKinesisStreamsForLedger Source #
See: newListJournalKinesisStreamsForLedger
smart constructor.
Instances
newListJournalKinesisStreamsForLedger Source #
Create a value of ListJournalKinesisStreamsForLedger
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:nextToken:ListJournalKinesisStreamsForLedger'
, listJournalKinesisStreamsForLedger_nextToken
- A pagination token, indicating that you want to retrieve the next page
of results. If you received a value for NextToken
in the response from
a previous ListJournalKinesisStreamsForLedger
call, you should use
that value as input here.
$sel:maxResults:ListJournalKinesisStreamsForLedger'
, listJournalKinesisStreamsForLedger_maxResults
- The maximum number of results to return in a single
ListJournalKinesisStreamsForLedger
request. (The actual number of
results returned might be fewer.)
$sel:ledgerName:ListJournalKinesisStreamsForLedger'
, listJournalKinesisStreamsForLedger_ledgerName
- The name of the ledger.
data ListJournalKinesisStreamsForLedgerResponse Source #
See: newListJournalKinesisStreamsForLedgerResponse
smart constructor.
ListJournalKinesisStreamsForLedgerResponse' (Maybe Text) (Maybe [JournalKinesisStreamDescription]) Int |
Instances
newListJournalKinesisStreamsForLedgerResponse Source #
Create a value of ListJournalKinesisStreamsForLedgerResponse
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:nextToken:ListJournalKinesisStreamsForLedger'
, listJournalKinesisStreamsForLedgerResponse_nextToken
- - If NextToken
is empty, the last page of results has been processed
and there are no more results to be retrieved.
- If
NextToken
is not empty, more results are available. To retrieve the next page of results, use the value ofNextToken
in a subsequentListJournalKinesisStreamsForLedger
call.
$sel:streams:ListJournalKinesisStreamsForLedgerResponse'
, listJournalKinesisStreamsForLedgerResponse_streams
- The array of QLDB journal stream descriptors that are associated with
the given ledger.
$sel:httpStatus:ListJournalKinesisStreamsForLedgerResponse'
, listJournalKinesisStreamsForLedgerResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The Amazon Resource Name (ARN) for which to list the tags. For example:
arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The tags that are currently associated with the specified Amazon QLDB
resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
GetRevision
data GetRevision Source #
See: newGetRevision
smart constructor.
Instances
:: Text | |
-> ValueHolder | |
-> Text | |
-> 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.
data GetRevisionResponse Source #
See: newGetRevisionResponse
smart constructor.
Instances
newGetRevisionResponse Source #
:: Int | |
-> ValueHolder | |
-> 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.
DescribeLedger
data DescribeLedger Source #
See: newDescribeLedger
smart constructor.
Instances
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.
data DescribeLedgerResponse Source #
See: newDescribeLedgerResponse
smart constructor.
DescribeLedgerResponse' (Maybe LedgerState) (Maybe Bool) (Maybe Text) (Maybe LedgerEncryptionDescription) (Maybe Text) (Maybe POSIX) (Maybe PermissionsMode) Int |
Instances
newDescribeLedgerResponse Source #
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.
CancelJournalKinesisStream
data CancelJournalKinesisStream Source #
See: newCancelJournalKinesisStream
smart constructor.
Instances
newCancelJournalKinesisStream Source #
:: Text | |
-> Text | |
-> CancelJournalKinesisStream |
Create a value of CancelJournalKinesisStream
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:CancelJournalKinesisStream'
, cancelJournalKinesisStream_ledgerName
- The name of the ledger.
$sel:streamId:CancelJournalKinesisStream'
, cancelJournalKinesisStream_streamId
- The UUID (represented in Base62-encoded text) of the QLDB journal stream
to be canceled.
data CancelJournalKinesisStreamResponse Source #
See: newCancelJournalKinesisStreamResponse
smart constructor.
Instances
Eq CancelJournalKinesisStreamResponse Source # | |
Read CancelJournalKinesisStreamResponse Source # | |
Show CancelJournalKinesisStreamResponse Source # | |
Generic CancelJournalKinesisStreamResponse Source # | |
NFData CancelJournalKinesisStreamResponse Source # | |
Defined in Amazonka.QLDB.CancelJournalKinesisStream rnf :: CancelJournalKinesisStreamResponse -> () # | |
type Rep CancelJournalKinesisStreamResponse Source # | |
Defined in Amazonka.QLDB.CancelJournalKinesisStream type Rep CancelJournalKinesisStreamResponse = D1 ('MetaData "CancelJournalKinesisStreamResponse" "Amazonka.QLDB.CancelJournalKinesisStream" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "CancelJournalKinesisStreamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCancelJournalKinesisStreamResponse Source #
Create a value of CancelJournalKinesisStreamResponse
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:streamId:CancelJournalKinesisStream'
, cancelJournalKinesisStreamResponse_streamId
- The UUID (Base62-encoded text) of the canceled QLDB journal stream.
$sel:httpStatus:CancelJournalKinesisStreamResponse'
, cancelJournalKinesisStreamResponse_httpStatus
- The response's http status code.
ExportJournalToS3
data ExportJournalToS3 Source #
See: newExportJournalToS3
smart constructor.
Instances
:: Text | |
-> UTCTime | |
-> UTCTime | |
-> S3ExportConfiguration | |
-> Text | |
-> ExportJournalToS3 |
Create a value of ExportJournalToS3
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:ExportJournalToS3'
, exportJournalToS3_name
- The name of the ledger.
$sel:inclusiveStartTime:ExportJournalToS3'
, exportJournalToS3_inclusiveStartTime
- The inclusive start date and time for the range of journal contents to
export.
The InclusiveStartTime
must be in ISO 8601
date and time format and
in Universal Coordinated Time (UTC). For example:
2019-06-13T21:36:34Z
.
The InclusiveStartTime
must be before ExclusiveEndTime
.
If you provide an InclusiveStartTime
that is before the ledger's
CreationDateTime
, Amazon QLDB defaults it to the ledger's
CreationDateTime
.
$sel:exclusiveEndTime:ExportJournalToS3'
, exportJournalToS3_exclusiveEndTime
- The exclusive end date and time for the range of journal contents to
export.
The ExclusiveEndTime
must be in ISO 8601
date and time format and in
Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
The ExclusiveEndTime
must be less than or equal to the current UTC
date and time.
$sel:s3ExportConfiguration:ExportJournalToS3'
, exportJournalToS3_s3ExportConfiguration
- The configuration settings of the Amazon S3 bucket destination for your
export request.
$sel:roleArn:ExportJournalToS3'
, exportJournalToS3_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.
data ExportJournalToS3Response Source #
See: newExportJournalToS3Response
smart constructor.
Instances
newExportJournalToS3Response Source #
:: Int | |
-> Text | |
-> ExportJournalToS3Response |
Create a value of ExportJournalToS3Response
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:ExportJournalToS3Response'
, exportJournalToS3Response_httpStatus
- The response's http status code.
$sel:exportId:ExportJournalToS3Response'
, exportJournalToS3Response_exportId
- The UUID (represented in Base62-encoded text) that QLDB assigns to each
journal export job.
To describe your export request and check the status of the job, you can
use ExportId
to call DescribeJournalS3Export
.
StreamJournalToKinesis
data StreamJournalToKinesis Source #
See: newStreamJournalToKinesis
smart constructor.
StreamJournalToKinesis' (Maybe POSIX) (Maybe (HashMap Text Text)) Text Text POSIX KinesisConfiguration Text |
Instances
newStreamJournalToKinesis Source #
:: Text | |
-> Text | |
-> UTCTime | |
-> KinesisConfiguration | |
-> Text | |
-> StreamJournalToKinesis |
Create a value of StreamJournalToKinesis
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:exclusiveEndTime:StreamJournalToKinesis'
, streamJournalToKinesis_exclusiveEndTime
- The exclusive date and time that specifies when the stream ends. If you
don't define this parameter, the stream runs indefinitely until you
cancel it.
The ExclusiveEndTime
must be in ISO 8601
date and time format and in
Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
$sel:tags:StreamJournalToKinesis'
, streamJournalToKinesis_tags
- The key-value pairs to add as tags to the stream that you want to
create. Tag keys are case sensitive. Tag values are case sensitive and
can be null.
$sel:ledgerName:StreamJournalToKinesis'
, streamJournalToKinesis_ledgerName
- The name of the ledger.
$sel:roleArn:StreamJournalToKinesis'
, streamJournalToKinesis_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:inclusiveStartTime:StreamJournalToKinesis'
, streamJournalToKinesis_inclusiveStartTime
- The inclusive start date and time from which to start streaming journal
data. This parameter must be in ISO 8601
date and time format and in
Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
The InclusiveStartTime
cannot be in the future and must be before
ExclusiveEndTime
.
If you provide an InclusiveStartTime
that is before the ledger's
CreationDateTime
, QLDB effectively defaults it to the ledger's
CreationDateTime
.
$sel:kinesisConfiguration:StreamJournalToKinesis'
, streamJournalToKinesis_kinesisConfiguration
- The configuration settings of the Kinesis Data Streams destination for
your stream request.
$sel:streamName:StreamJournalToKinesis'
, streamJournalToKinesis_streamName
- The name that you want to assign to the QLDB journal stream.
User-defined names can help identify and indicate the purpose of a
stream.
Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.
data StreamJournalToKinesisResponse Source #
See: newStreamJournalToKinesisResponse
smart constructor.
Instances
Eq StreamJournalToKinesisResponse Source # | |
Read StreamJournalToKinesisResponse Source # | |
Show StreamJournalToKinesisResponse Source # | |
Defined in Amazonka.QLDB.StreamJournalToKinesis | |
Generic StreamJournalToKinesisResponse Source # | |
NFData StreamJournalToKinesisResponse Source # | |
Defined in Amazonka.QLDB.StreamJournalToKinesis rnf :: StreamJournalToKinesisResponse -> () # | |
type Rep StreamJournalToKinesisResponse Source # | |
Defined in Amazonka.QLDB.StreamJournalToKinesis type Rep StreamJournalToKinesisResponse = D1 ('MetaData "StreamJournalToKinesisResponse" "Amazonka.QLDB.StreamJournalToKinesis" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "StreamJournalToKinesisResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newStreamJournalToKinesisResponse Source #
Create a value of StreamJournalToKinesisResponse
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:streamId:StreamJournalToKinesisResponse'
, streamJournalToKinesisResponse_streamId
- The UUID (represented in Base62-encoded text) that QLDB assigns to each
QLDB journal stream.
$sel:httpStatus:StreamJournalToKinesisResponse'
, streamJournalToKinesisResponse_httpStatus
- The response's http status code.
CreateLedger
data CreateLedger Source #
See: newCreateLedger
smart constructor.
Instances
Create a value of CreateLedger
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:deletionProtection:CreateLedger'
, createLedger_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:kmsKey:CreateLedger'
, createLedger_kmsKey
- The key in Key Management Service (KMS) to use for encryption of data at
rest in the ledger. For more information, see
Encryption at rest
in the Amazon QLDB Developer Guide.
Use one of the following options to specify this parameter:
AWS_OWNED_KMS_KEY
: Use an KMS key that is owned and managed by Amazon Web Services on your behalf.- Undefined: By default, use an Amazon Web Services owned KMS key.
A valid symmetric customer managed KMS key: Use the specified KMS key in your account that you create, own, and manage.
Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.
To specify a customer managed KMS key, you can use its key ID, Amazon
Resource Name (ARN), alias name, or alias ARN. When using an alias name,
prefix it with "alias/"
. To specify a key in a different account,
you must use the key ARN or alias ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Alias name:
alias/ExampleAlias
- Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
$sel:tags:CreateLedger'
, createLedger_tags
- The key-value pairs to add as tags to the ledger that you want to
create. Tag keys are case sensitive. Tag values are case sensitive and
can be null.
$sel:name:CreateLedger'
, createLedger_name
- The name of the ledger that you want to create. The name must be unique
among all of the ledgers in your account in the current Region.
Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.
$sel:permissionsMode:CreateLedger'
, createLedger_permissionsMode
- The permissions mode to assign to the ledger that you want to create.
This parameter can have one of the following values:
ALLOW_ALL
: A legacy permissions mode that enables access control with API-level granularity for ledgers.This mode allows users who have the
SendCommand
API permission for this ledger to run all PartiQL commands (hence,ALLOW_ALL
) on any tables in the specified ledger. This mode disregards any table-level or command-level IAM permissions policies that you create for the ledger.STANDARD
: (Recommended) A permissions mode that enables access control with finer granularity for ledgers, tables, and PartiQL commands.By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL actions, in addition to the
SendCommand
API permission for the ledger. For information, see Getting started with the standard permissions mode in the Amazon QLDB Developer Guide.
We strongly recommend using the STANDARD
permissions mode to maximize
the security of your ledger data.
data CreateLedgerResponse Source #
See: newCreateLedgerResponse
smart constructor.
CreateLedgerResponse' (Maybe LedgerState) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe PermissionsMode) Int |
Instances
newCreateLedgerResponse Source #
Create a value of CreateLedgerResponse
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:CreateLedgerResponse'
, createLedgerResponse_state
- The current status of the ledger.
$sel:deletionProtection:CreateLedger'
, createLedgerResponse_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:kmsKeyArn:CreateLedgerResponse'
, createLedgerResponse_kmsKeyArn
- The 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:arn:CreateLedgerResponse'
, createLedgerResponse_arn
- The Amazon Resource Name (ARN) for the ledger.
$sel:name:CreateLedger'
, createLedgerResponse_name
- The name of the ledger.
$sel:creationDateTime:CreateLedgerResponse'
, createLedgerResponse_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:CreateLedger'
, createLedgerResponse_permissionsMode
- The permissions mode of the ledger that you created.
$sel:httpStatus:CreateLedgerResponse'
, createLedgerResponse_httpStatus
- The response's http status code.
ListLedgers
data ListLedgers Source #
See: newListLedgers
smart constructor.
Instances
newListLedgers :: ListLedgers Source #
Create a value of ListLedgers
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:nextToken:ListLedgers'
, listLedgers_nextToken
- A pagination token, indicating that you want to retrieve the next page
of results. If you received a value for NextToken
in the response from
a previous ListLedgers
call, then you should use that value as input
here.
$sel:maxResults:ListLedgers'
, listLedgers_maxResults
- The maximum number of results to return in a single ListLedgers
request. (The actual number of results returned might be fewer.)
data ListLedgersResponse Source #
See: newListLedgersResponse
smart constructor.
Instances
newListLedgersResponse Source #
Create a value of ListLedgersResponse
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:ledgers:ListLedgersResponse'
, listLedgersResponse_ledgers
- The array of ledger summaries that are associated with the current
account and Region.
$sel:nextToken:ListLedgers'
, listLedgersResponse_nextToken
- A pagination token, indicating whether there are more results available:
- If
NextToken
is empty, then the last page of results has been processed and there are no more results to be retrieved. - If
NextToken
is not empty, then there are more results available. To retrieve the next page of results, use the value ofNextToken
in a subsequentListLedgers
call.
$sel:httpStatus:ListLedgersResponse'
, listLedgersResponse_httpStatus
- The response's http status code.
ListJournalS3Exports
data ListJournalS3Exports Source #
See: newListJournalS3Exports
smart constructor.
Instances
newListJournalS3Exports :: ListJournalS3Exports Source #
Create a value of ListJournalS3Exports
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:nextToken:ListJournalS3Exports'
, listJournalS3Exports_nextToken
- A pagination token, indicating that you want to retrieve the next page
of results. If you received a value for NextToken
in the response from
a previous ListJournalS3Exports
call, then you should use that value
as input here.
$sel:maxResults:ListJournalS3Exports'
, listJournalS3Exports_maxResults
- The maximum number of results to return in a single
ListJournalS3Exports
request. (The actual number of results returned
might be fewer.)
data ListJournalS3ExportsResponse Source #
See: newListJournalS3ExportsResponse
smart constructor.
Instances
newListJournalS3ExportsResponse Source #
Create a value of ListJournalS3ExportsResponse
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:journalS3Exports:ListJournalS3ExportsResponse'
, listJournalS3ExportsResponse_journalS3Exports
- The array of journal export job descriptions for all ledgers that are
associated with the current account and Region.
$sel:nextToken:ListJournalS3Exports'
, listJournalS3ExportsResponse_nextToken
- - If NextToken
is empty, then the last page of results has been
processed and there are no more results to be retrieved.
- If
NextToken
is not empty, then there are more results available. To retrieve the next page of results, use the value ofNextToken
in a subsequentListJournalS3Exports
call.
$sel:httpStatus:ListJournalS3ExportsResponse'
, listJournalS3ExportsResponse_httpStatus
- The response's http status code.
UpdateLedgerPermissionsMode
data UpdateLedgerPermissionsMode Source #
See: newUpdateLedgerPermissionsMode
smart constructor.
Instances
newUpdateLedgerPermissionsMode Source #
Create a value of UpdateLedgerPermissionsMode
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:UpdateLedgerPermissionsMode'
, updateLedgerPermissionsMode_name
- The name of the ledger.
$sel:permissionsMode:UpdateLedgerPermissionsMode'
, updateLedgerPermissionsMode_permissionsMode
- The permissions mode to assign to the ledger. This parameter can have
one of the following values:
ALLOW_ALL
: A legacy permissions mode that enables access control with API-level granularity for ledgers.This mode allows users who have the
SendCommand
API permission for this ledger to run all PartiQL commands (hence,ALLOW_ALL
) on any tables in the specified ledger. This mode disregards any table-level or command-level IAM permissions policies that you create for the ledger.STANDARD
: (Recommended) A permissions mode that enables access control with finer granularity for ledgers, tables, and PartiQL commands.By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL actions, in addition to the
SendCommand
API permission for the ledger. For information, see Getting started with the standard permissions mode in the Amazon QLDB Developer Guide.
We strongly recommend using the STANDARD
permissions mode to maximize
the security of your ledger data.
data UpdateLedgerPermissionsModeResponse Source #
See: newUpdateLedgerPermissionsModeResponse
smart constructor.
Instances
newUpdateLedgerPermissionsModeResponse Source #
Create a value of UpdateLedgerPermissionsModeResponse
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:arn:UpdateLedgerPermissionsModeResponse'
, updateLedgerPermissionsModeResponse_arn
- The Amazon Resource Name (ARN) for the ledger.
$sel:name:UpdateLedgerPermissionsMode'
, updateLedgerPermissionsModeResponse_name
- The name of the ledger.
$sel:permissionsMode:UpdateLedgerPermissionsMode'
, updateLedgerPermissionsModeResponse_permissionsMode
- The current permissions mode of the ledger.
$sel:httpStatus:UpdateLedgerPermissionsModeResponse'
, updateLedgerPermissionsModeResponse_httpStatus
- The response's http status code.
GetBlock
See: newGetBlock
smart constructor.
Instances
Create a value of GetBlock
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:GetBlock'
, getBlock_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:GetBlock'
, getBlock_name
- The name of the ledger.
$sel:blockAddress:GetBlock'
, getBlock_blockAddress
- The location of the block that you want to request. An address is an
Amazon Ion structure that has two fields: strandId
and sequenceNo
.
For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}
.
data GetBlockResponse Source #
See: newGetBlockResponse
smart constructor.
Instances
:: Int | |
-> ValueHolder | |
-> GetBlockResponse |
Create a value of GetBlockResponse
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:GetBlockResponse'
, getBlockResponse_proof
- The proof object in Amazon Ion format returned by a GetBlock
request.
A proof contains the list of hash values required to recalculate the
specified digest using a Merkle tree, starting with the specified block.
$sel:httpStatus:GetBlockResponse'
, getBlockResponse_httpStatus
- The response's http status code.
$sel:block:GetBlockResponse'
, getBlockResponse_block
- The block data object in Amazon Ion format.
ListJournalS3ExportsForLedger
data ListJournalS3ExportsForLedger Source #
See: newListJournalS3ExportsForLedger
smart constructor.
Instances
newListJournalS3ExportsForLedger Source #
Create a value of ListJournalS3ExportsForLedger
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:nextToken:ListJournalS3ExportsForLedger'
, listJournalS3ExportsForLedger_nextToken
- A pagination token, indicating that you want to retrieve the next page
of results. If you received a value for NextToken
in the response from
a previous ListJournalS3ExportsForLedger
call, then you should use
that value as input here.
$sel:maxResults:ListJournalS3ExportsForLedger'
, listJournalS3ExportsForLedger_maxResults
- The maximum number of results to return in a single
ListJournalS3ExportsForLedger
request. (The actual number of results
returned might be fewer.)
$sel:name:ListJournalS3ExportsForLedger'
, listJournalS3ExportsForLedger_name
- The name of the ledger.
data ListJournalS3ExportsForLedgerResponse Source #
See: newListJournalS3ExportsForLedgerResponse
smart constructor.
Instances
newListJournalS3ExportsForLedgerResponse Source #
Create a value of ListJournalS3ExportsForLedgerResponse
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:journalS3Exports:ListJournalS3ExportsForLedgerResponse'
, listJournalS3ExportsForLedgerResponse_journalS3Exports
- The array of journal export job descriptions that are associated with
the specified ledger.
$sel:nextToken:ListJournalS3ExportsForLedger'
, listJournalS3ExportsForLedgerResponse_nextToken
- - If NextToken
is empty, then the last page of results has been
processed and there are no more results to be retrieved.
- If
NextToken
is not empty, then there are more results available. To retrieve the next page of results, use the value ofNextToken
in a subsequentListJournalS3ExportsForLedger
call.
$sel:httpStatus:ListJournalS3ExportsForLedgerResponse'
, listJournalS3ExportsForLedgerResponse_httpStatus
- The response's http status code.
DescribeJournalKinesisStream
data DescribeJournalKinesisStream Source #
See: newDescribeJournalKinesisStream
smart constructor.
Instances
newDescribeJournalKinesisStream Source #
:: Text | |
-> Text | |
-> DescribeJournalKinesisStream |
Create a value of DescribeJournalKinesisStream
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:DescribeJournalKinesisStream'
, describeJournalKinesisStream_ledgerName
- The name of the ledger.
$sel:streamId:DescribeJournalKinesisStream'
, describeJournalKinesisStream_streamId
- The UUID (represented in Base62-encoded text) of the QLDB journal stream
to describe.
data DescribeJournalKinesisStreamResponse Source #
See: newDescribeJournalKinesisStreamResponse
smart constructor.
Instances
newDescribeJournalKinesisStreamResponse Source #
Create a value of DescribeJournalKinesisStreamResponse
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:stream:DescribeJournalKinesisStreamResponse'
, describeJournalKinesisStreamResponse_stream
- Information about the QLDB journal stream returned by a
DescribeJournalS3Export
request.
$sel:httpStatus:DescribeJournalKinesisStreamResponse'
, describeJournalKinesisStreamResponse_httpStatus
- The response's http status code.
DescribeJournalS3Export
data DescribeJournalS3Export Source #
See: newDescribeJournalS3Export
smart constructor.
Instances
newDescribeJournalS3Export Source #
:: Text | |
-> Text | |
-> DescribeJournalS3Export |
Create a value of DescribeJournalS3Export
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:DescribeJournalS3Export'
, describeJournalS3Export_name
- The name of the ledger.
$sel:exportId:DescribeJournalS3Export'
, describeJournalS3Export_exportId
- The UUID (represented in Base62-encoded text) of the journal export job
to describe.
data DescribeJournalS3ExportResponse Source #
See: newDescribeJournalS3ExportResponse
smart constructor.
Instances
Eq DescribeJournalS3ExportResponse Source # | |
Read DescribeJournalS3ExportResponse Source # | |
Show DescribeJournalS3ExportResponse Source # | |
Defined in Amazonka.QLDB.DescribeJournalS3Export | |
Generic DescribeJournalS3ExportResponse Source # | |
NFData DescribeJournalS3ExportResponse Source # | |
Defined in Amazonka.QLDB.DescribeJournalS3Export rnf :: DescribeJournalS3ExportResponse -> () # | |
type Rep DescribeJournalS3ExportResponse Source # | |
Defined in Amazonka.QLDB.DescribeJournalS3Export type Rep DescribeJournalS3ExportResponse = D1 ('MetaData "DescribeJournalS3ExportResponse" "Amazonka.QLDB.DescribeJournalS3Export" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "DescribeJournalS3ExportResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "exportDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JournalS3ExportDescription))) |
newDescribeJournalS3ExportResponse Source #
Create a value of DescribeJournalS3ExportResponse
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:DescribeJournalS3ExportResponse'
, describeJournalS3ExportResponse_httpStatus
- The response's http status code.
$sel:exportDescription:DescribeJournalS3ExportResponse'
, describeJournalS3ExportResponse_exportDescription
- Information about the journal export job returned by a
DescribeJournalS3Export
request.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceArn:TagResource'
, tagResource_resourceArn
- The Amazon Resource Name (ARN) to which you want to add the tags. For
example:
arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger
$sel:tags:TagResource'
, tagResource_tags
- The key-value pairs to add as tags to the specified QLDB resource. Tag
keys are case sensitive. If you specify a key that already exists for
the resource, your request fails and returns an error. Tag values are
case sensitive and can be null.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceArn:UntagResource'
, untagResource_resourceArn
- The Amazon Resource Name (ARN) from which to remove the tags. For
example:
arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The list of tag keys to remove.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
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:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
GetDigest
See: newGetDigest
smart constructor.
Instances
Eq GetDigest Source # | |
Read GetDigest Source # | |
Show GetDigest Source # | |
Generic GetDigest Source # | |
NFData GetDigest Source # | |
Defined in Amazonka.QLDB.GetDigest | |
Hashable GetDigest Source # | |
Defined in Amazonka.QLDB.GetDigest | |
ToJSON GetDigest Source # | |
Defined in Amazonka.QLDB.GetDigest | |
AWSRequest GetDigest Source # | |
Defined in Amazonka.QLDB.GetDigest type AWSResponse GetDigest # request :: GetDigest -> Request GetDigest # response :: MonadResource m => Logger -> Service -> Proxy GetDigest -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDigest))) # | |
ToHeaders GetDigest Source # | |
Defined in Amazonka.QLDB.GetDigest | |
ToPath GetDigest Source # | |
Defined in Amazonka.QLDB.GetDigest toPath :: GetDigest -> ByteString # | |
ToQuery GetDigest Source # | |
Defined in Amazonka.QLDB.GetDigest toQuery :: GetDigest -> QueryString # | |
type Rep GetDigest Source # | |
Defined in Amazonka.QLDB.GetDigest | |
type AWSResponse GetDigest Source # | |
Defined in Amazonka.QLDB.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.
data GetDigestResponse Source #
See: newGetDigestResponse
smart constructor.
Instances
:: Int | |
-> ByteString | |
-> ValueHolder | |
-> 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
.
Types
EncryptionStatus
newtype EncryptionStatus Source #
pattern EncryptionStatus_ENABLED :: EncryptionStatus | |
pattern EncryptionStatus_KMS_KEY_INACCESSIBLE :: EncryptionStatus | |
pattern EncryptionStatus_UPDATING :: EncryptionStatus |
Instances
ErrorCause
newtype ErrorCause Source #
pattern ErrorCause_IAM_PERMISSION_REVOKED :: ErrorCause | |
pattern ErrorCause_KINESIS_STREAM_NOT_FOUND :: ErrorCause |
Instances
ExportStatus
newtype ExportStatus Source #
pattern ExportStatus_CANCELLED :: ExportStatus | |
pattern ExportStatus_COMPLETED :: ExportStatus | |
pattern ExportStatus_IN_PROGRESS :: ExportStatus |
Instances
LedgerState
newtype LedgerState Source #
pattern LedgerState_ACTIVE :: LedgerState | |
pattern LedgerState_CREATING :: LedgerState | |
pattern LedgerState_DELETED :: LedgerState | |
pattern LedgerState_DELETING :: LedgerState |
Instances
PermissionsMode
newtype PermissionsMode Source #
pattern PermissionsMode_ALLOW_ALL :: PermissionsMode | |
pattern PermissionsMode_STANDARD :: PermissionsMode |
Instances
S3ObjectEncryptionType
newtype S3ObjectEncryptionType Source #
pattern S3ObjectEncryptionType_NO_ENCRYPTION :: S3ObjectEncryptionType | |
pattern S3ObjectEncryptionType_SSE_KMS :: S3ObjectEncryptionType | |
pattern S3ObjectEncryptionType_SSE_S3 :: S3ObjectEncryptionType |
Instances
StreamStatus
newtype StreamStatus Source #
pattern StreamStatus_ACTIVE :: StreamStatus | |
pattern StreamStatus_CANCELED :: StreamStatus | |
pattern StreamStatus_COMPLETED :: StreamStatus | |
pattern StreamStatus_FAILED :: StreamStatus | |
pattern StreamStatus_IMPAIRED :: StreamStatus |
Instances
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.
JournalKinesisStreamDescription' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe ErrorCause) (Maybe POSIX) Text Text Text StreamStatus KinesisConfiguration Text |
Instances
newJournalKinesisStreamDescription Source #
:: Text | |
-> Text | |
-> Text | |
-> StreamStatus | |
-> KinesisConfiguration | |
-> Text | |
-> JournalKinesisStreamDescription |
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.
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.
Instances
newJournalS3ExportDescription Source #
:: Text | |
-> Text | |
-> UTCTime | |
-> ExportStatus | |
-> UTCTime | |
-> UTCTime | |
-> S3ExportConfiguration | |
-> Text | |
-> JournalS3ExportDescription |
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.
KinesisConfiguration
data KinesisConfiguration Source #
The configuration settings of the Amazon Kinesis Data Streams destination for an Amazon QLDB journal stream.
See: newKinesisConfiguration
smart constructor.
Instances
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.
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.
Instances
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.
LedgerSummary
data LedgerSummary Source #
Information about a ledger, including its name, state, and when it was created.
See: newLedgerSummary
smart constructor.
Instances
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.)
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.
Instances
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.
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.
Instances
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.
ValueHolder
data ValueHolder Source #
A structure that can contain a value in multiple encoding formats.
See: newValueHolder
smart constructor.
Instances
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.