Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be ACTIVE.
You can't restart a stream after you cancel it. Canceled QLDB stream resources are subject to a 7-day retention period, so they are automatically deleted after this limit expires.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CancelJournalKinesisStreamResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ResourcePreconditionNotMetException content: application/json: schema: $ref: '#/components/schemas/ResourcePreconditionNotMetException' parameters: - name: name in: path required: true description: The name of the ledger. schema: type: string pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$ minLength: 1 maxLength: 32 - name: streamId in: path required: true description: The UUID (represented in Base62-encoded text) of the QLDB journal stream to be canceled. schema: type: string pattern: ^[A-Za-z-0-9]+$ minLength: 22 maxLength: 22 summary: Amazon QLDB Cancel Journal Kinesis Stream x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Ledgers get: operationId: DescribeJournalKinesisStream description:Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of the original stream creation request.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeJournalKinesisStreamResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ResourcePreconditionNotMetException content: application/json: schema: $ref: '#/components/schemas/ResourcePreconditionNotMetException' parameters: - name: name in: path required: true description: The name of the ledger. schema: type: string pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$ minLength: 1 maxLength: 32 - name: streamId in: path required: true description: The UUID (represented in Base62-encoded text) of the QLDB journal stream to describe. schema: type: string pattern: ^[A-Za-z-0-9]+$ minLength: 22 maxLength: 22 summary: Amazon QLDB Describe Journal Kinesis Stream x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Ledgers /ledgers: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateLedger description: Creates a new ledger in your Amazon Web Services account in the current Region. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateLedgerResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - Name - PermissionsMode properties: Name: description:The name of the ledger that you want to create. The name must be unique among all of the ledgers in your Amazon Web Services account in the current Region.
Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.
type: string pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$ minLength: 1 maxLength: 32 Tags: description: 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. type: object minProperties: 0 maxProperties: 200 additionalProperties: $ref: '#/components/schemas/TagValue' PermissionsMode: description: '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.
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.
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 Amazon Web Services 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.
' type: string maxLength: 1600 summary: Amazon QLDB Create Ledger x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Ledgers get: operationId: ListLedgers description:Returns an array of ledger summaries that are associated with the current Amazon Web Services account and Region.
This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times.
ListLedgers request. (The actual number of results returned might be fewer.)
schema:
type: integer
minimum: 1
maximum: 100
- name: next_token
in: query
required: false
description: 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.
schema:
type: string
pattern: ^[A-Za-z-0-9+/=]+$
minLength: 4
maxLength: 1024
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
summary: Amazon QLDB List Ledgers
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Ledgers
/ledgers/{name}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
delete:
operationId: DeleteLedger
description: Deletes a ledger and all of its contents. This action is irreversible.
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.
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.
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 Amazon Web Services 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.
' type: string maxLength: 1600 summary: Amazon QLDB Update Ledger x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Ledgers /ledgers/{name}/journal-s3-exports/{exportId}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: DescribeJournalS3Export description:Returns 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.
This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.
If the export job with the given ExportId doesn't exist, then throws ResourceNotFoundException.
If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.
Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.
In JSON Lines format, each journal block in the exported data object is a valid JSON object that is delimited by a newline. You can use this format to easily integrate JSON exports with analytics tools such as Glue and Amazon Athena because these services can parse newline-delimited JSON automatically. For more information about the format, see JSON Lines.
If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.
If the ledger with the given Name is in CREATING status, then throws ResourcePreconditionNotMetException.
You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw LimitExceededException.
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.
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.
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: allOf: - $ref: '#/components/schemas/S3Prefix' - description: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/
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 managed key in Key Management Service (KMS) for server-side encryption of your exported data.
To pass a role to QLDB when requesting a journal export, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal export requests.
ION_TEXT format.
type: string
enum:
- ION_BINARY
- ION_TEXT
- JSON
summary: Amazon QLDB Export Journal To S3
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Ledgers
get:
operationId: ListJournalS3ExportsForLedger
description: Returns an array of journal export job descriptions for a specified ledger.
This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger multiple times.
This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListJournalS3ExportsForLedgerResponse' parameters: - name: name in: path required: true description: The name of the ledger. schema: type: string pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$ minLength: 1 maxLength: 32 - name: max_results in: query required: false description: The maximum number of results to return in a singleListJournalS3ExportsForLedger request. (The actual number of results returned might be fewer.)
schema:
type: integer
minimum: 1
maximum: 100
- name: next_token
in: query
required: false
description: 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.
schema:
type: string
pattern: ^[A-Za-z-0-9+/=]+$
minLength: 4
maxLength: 1024
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
summary: Amazon QLDB List Journal S3 Exports For Ledger
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Ledgers
/ledgers/{name}/block:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetBlock
description: Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if DigestTipAddress is provided.
For information about the data contents in a block, see Journal contents in the Amazon QLDB Developer Guide.
If the specified ledger doesn't exist or is in DELETING status, then throws ResourceNotFoundException.
If the specified ledger is in CREATING status, then throws ResourcePreconditionNotMetException.
If no block exists with the specified address, then throws InvalidParameterException.
ValueHolder structure.
DigestTipAddress:
description: A structure that can contain a value in multiple encoding formats.
type: object
properties:
IonText:
allOf:
- $ref: '#/components/schemas/IonText'
- description: An Amazon Ion plaintext value contained in a ValueHolder structure.
summary: Amazon QLDB Get Block
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Ledgers
/ledgers/{name}/digest:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetDigest
description: Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetDigestResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ResourcePreconditionNotMetException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourcePreconditionNotMetException'
parameters:
- name: name
in: path
required: true
description: The name of the ledger.
schema:
type: string
pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$
minLength: 1
maxLength: 32
summary: Amazon QLDB Get Digest
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Ledgers
/ledgers/{name}/revision:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetRevision
description: Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if DigestTipAddress is provided.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetRevisionResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ResourcePreconditionNotMetException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourcePreconditionNotMetException'
parameters:
- name: name
in: path
required: true
description: The name of the ledger.
schema:
type: string
pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$
minLength: 1
maxLength: 32
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- BlockAddress
- DocumentId
properties:
BlockAddress:
description: A structure that can contain a value in multiple encoding formats.
type: object
properties:
IonText:
allOf:
- $ref: '#/components/schemas/IonText'
- description: An Amazon Ion plaintext value contained in a ValueHolder structure.
DocumentId:
description: The UUID (represented in Base62-encoded text) of the document to be verified.
type: string
pattern: ^[A-Za-z-0-9]+$
minLength: 22
maxLength: 22
DigestTipAddress:
description: A structure that can contain a value in multiple encoding formats.
type: object
properties:
IonText:
allOf:
- $ref: '#/components/schemas/IonText'
- description: An Amazon Ion plaintext value contained in a ValueHolder structure.
summary: Amazon QLDB Get Revision
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Ledgers
/ledgers/{name}/journal-kinesis-streams:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: ListJournalKinesisStreamsForLedger
description: Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The output of each stream descriptor includes the same details that are returned by DescribeJournalKinesisStream.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.
This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger multiple times.
ListJournalKinesisStreamsForLedger request. (The actual number of results returned might be fewer.)
schema:
type: integer
minimum: 1
maximum: 100
- name: next_token
in: query
required: false
description: 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.
schema:
type: string
pattern: ^[A-Za-z-0-9+/=]+$
minLength: 4
maxLength: 1024
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
summary: Amazon QLDB List Journal Kinesis Streams For Ledger
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Ledgers
post:
operationId: StreamJournalToKinesis
description: Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StreamJournalToKinesisResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ResourcePreconditionNotMetException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourcePreconditionNotMetException'
parameters:
- name: name
in: path
required: true
description: The name of the ledger.
schema:
type: string
pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$
minLength: 1
maxLength: 32
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- RoleArn
- InclusiveStartTime
- KinesisConfiguration
- StreamName
properties:
RoleArn:
description: 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.
To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal stream requests.
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.
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.
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.
StreamName: description: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.
type: string pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$ minLength: 1 maxLength: 32 summary: Amazon QLDB Stream Journal To Kinesis x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Ledgers /ledgers/{name}/permissions-mode: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' patch: operationId: UpdateLedgerPermissionsMode description:Updates the permissions mode of a ledger.
Before you switch to the STANDARD permissions mode, you must first create all required IAM policies and table tags to avoid disruption to your users. To learn more, see Migrating to the standard permissions mode in the Amazon QLDB Developer Guide.
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.
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.
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.
KmsKeyArn: allOf: - $ref: '#/components/schemas/Arn' - description:The Amazon Resource Name (ARN) of a symmetric key in Key Management Service (KMS). Amazon S3 does not support asymmetric KMS keys.
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.
IMPAIRED or FAILED. This is not applicable to streams that have other status values.
StreamName:
allOf:
- $ref: '#/components/schemas/StreamName'
- description: The user-defined name of the QLDB journal stream.
description: 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.
S3Prefix:
type: string
minLength: 0
maxLength: 128
ResourceAlreadyExistsException: {}
InvalidParameterException: {}
LedgerSummary:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/LedgerName'
- description: The name of the ledger.
State:
allOf:
- $ref: '#/components/schemas/LedgerState'
- description: The current status of the ledger.
CreationDateTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 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.)
description: Information about a ledger, including its name, state, and when it was created.
NextToken:
type: string
pattern: ^[A-Za-z-0-9+/=]+$
minLength: 4
maxLength: 1024
DescribeJournalKinesisStreamResponse:
type: object
properties:
Stream:
allOf:
- $ref: '#/components/schemas/JournalKinesisStreamDescription'
- description: Information about the QLDB journal stream returned by a DescribeJournalS3Export request.
UpdateLedgerResponse:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/LedgerName'
- description: The name of the ledger.
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) for the ledger.
State:
allOf:
- $ref: '#/components/schemas/LedgerState'
- description: The current status of the ledger.
CreationDateTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 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.)
DeletionProtection:
allOf:
- $ref: '#/components/schemas/DeletionProtection'
- description: 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.
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 of NextToken in a subsequent ListJournalS3ExportsForLedger call.
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 of NextToken in a subsequent ListJournalKinesisStreamsForLedger call.
DescribeJournalS3Export request.
StreamJournalToKinesisResponse:
type: object
properties:
StreamId:
allOf:
- $ref: '#/components/schemas/UniqueId'
- description: The UUID (represented in Base62-encoded text) that QLDB assigns to each QLDB journal stream.
LedgerEncryptionDescription:
type: object
required:
- KmsKeyArn
- EncryptionStatus
properties:
KmsKeyArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: 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:
allOf:
- $ref: '#/components/schemas/EncryptionStatus'
- description: '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.
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.
description: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.
GetBlockResponse: type: object required: - Block properties: Block: allOf: - $ref: '#/components/schemas/ValueHolder' - description: The block data object in Amazon Ion format. Proof: allOf: - $ref: '#/components/schemas/ValueHolder' - description: The proof object in Amazon Ion format returned by aGetBlock request. A proof contains the list of hash values required to recalculate the specified digest using a Merkle tree, starting with the specified block.
Digest:
type: string
minLength: 32
maxLength: 32
LimitExceededException: {}
OutputFormat:
type: string
enum:
- ION_BINARY
- ION_TEXT
- JSON
ExportJournalToS3Response:
type: object
required:
- ExportId
properties:
ExportId:
allOf:
- $ref: '#/components/schemas/UniqueId'
- description: 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.
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 of NextToken in a subsequent ListLedgers call.
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.
description: The configuration settings of the Amazon Kinesis Data Streams destination for an Amazon QLDB journal stream. JournalS3ExportList: type: array items: $ref: '#/components/schemas/JournalS3ExportDescription' ValueHolder: type: object properties: IonText: allOf: - $ref: '#/components/schemas/IonText' - description: An Amazon Ion plaintext value contained in aValueHolder structure.
description: A structure that can contain a value in multiple encoding formats.
EncryptionStatus:
type: string
enum:
- ENABLED
- UPDATING
- KMS_KEY_INACCESSIBLE
DeletionProtection:
type: boolean
PermissionsMode:
type: string
enum:
- ALLOW_ALL
- STANDARD
UpdateLedgerPermissionsModeResponse:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/LedgerName'
- description: The name of the ledger.
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) for the ledger.
PermissionsMode:
allOf:
- $ref: '#/components/schemas/PermissionsMode'
- description: The current permissions mode of the ledger.
S3ExportConfiguration:
type: object
required:
- Bucket
- Prefix
- EncryptionConfiguration
properties:
Bucket:
allOf:
- $ref: '#/components/schemas/S3Bucket'
- description: 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: allOf: - $ref: '#/components/schemas/S3Prefix' - description: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/
GetDigest request.
DigestTipAddress:
allOf:
- $ref: '#/components/schemas/ValueHolder'
- description: '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.'
StreamName:
type: string
pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$
minLength: 1
maxLength: 32
Boolean:
type: boolean
JournalS3ExportDescription:
type: object
required:
- LedgerName
- ExportId
- ExportCreationTime
- Status
- InclusiveStartTime
- ExclusiveEndTime
- S3ExportConfiguration
- RoleArn
properties:
LedgerName:
allOf:
- $ref: '#/components/schemas/LedgerName'
- description: The name of the ledger.
ExportId:
allOf:
- $ref: '#/components/schemas/UniqueId'
- description: The UUID (represented in Base62-encoded text) of the journal export job.
ExportCreationTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 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:
allOf:
- $ref: '#/components/schemas/ExportStatus'
- description: The current state of the journal export job.
InclusiveStartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The inclusive start date and time for the range of journal contents that was specified in the original export request.
ExclusiveEndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The exclusive end date and time for the range of journal contents that was specified in the original export request.
S3ExportConfiguration:
$ref: '#/components/schemas/S3ExportConfiguration'
RoleArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: 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 managed key in Key Management Service (KMS) for server-side encryption of your exported data.
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.
Revision:
allOf:
- $ref: '#/components/schemas/ValueHolder'
- description: The document revision data object in Amazon Ion format.
DescribeLedgerResponse:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/LedgerName'
- description: The name of the ledger.
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) for the ledger.
State:
allOf:
- $ref: '#/components/schemas/LedgerState'
- description: The current status of the ledger.
CreationDateTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
PermissionsMode:
allOf:
- $ref: '#/components/schemas/PermissionsMode'
- description: The permissions mode of the ledger.
DeletionProtection:
allOf:
- $ref: '#/components/schemas/DeletionProtection'
- description: 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.