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 Deve" }, { "info": { "name": "Amazon QLDB Cancel Journal Kinesis Stream", "type": "http" }, "http": { "method": "DELETE", "url": "http://qldb.{region}.amazonaws.com/ledgers/:name/journal-kinesis-streams/:streamId", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the ledger." }, { "name": "streamId", "value": "", "type": "path", "description": "The UUID (represented in Base62-encoded text) of the QLDB journal stream to be canceled." } ] }, "docs": "
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.
" }, { "info": { "name": "Amazon QLDB List Ledgers", "type": "http" }, "http": { "method": "GET", "url": "http://qldb.{region}.amazonaws.com/ledgers", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "max_results", "value": "", "type": "query", "description": "The maximum number of results to return in a singleListLedgers request. (The actual number of results returned might be fewer.)"
},
{
"name": "next_token",
"value": "",
"type": "query",
"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."
},
{
"name": "MaxResults",
"value": "",
"type": "query",
"description": "Pagination limit"
},
{
"name": "NextToken",
"value": "",
"type": "query",
"description": "Pagination token"
}
]
},
"docs": "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.
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.
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 give"
},
{
"info": {
"name": "Amazon QLDB List Journal S3 Exports For Ledger",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://qldb.{region}.amazonaws.com/ledgers/:name/journal-s3-exports",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "The name of the ledger."
},
{
"name": "max_results",
"value": "",
"type": "query",
"description": "The maximum number of results to return in a single ListJournalS3ExportsForLedger request. (The actual number of results returned might be fewer.)"
},
{
"name": "next_token",
"value": "",
"type": "query",
"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."
},
{
"name": "MaxResults",
"value": "",
"type": "query",
"description": "Pagination limit"
},
{
"name": "NextToken",
"value": "",
"type": "query",
"description": "Pagination token"
}
]
},
"docs": "
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 "
},
{
"info": {
"name": "Amazon QLDB Export Journal To S3",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://qldb.{region}.amazonaws.com/ledgers/:name/journal-s3-exports",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "The name of the ledger."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": " 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 su"
},
{
"info": {
"name": "Amazon QLDB Get Block",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://qldb.{region}.amazonaws.com/ledgers/:name/block",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "The name of the ledger."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": " Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if 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 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 This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.<"
},
{
"info": {
"name": "Amazon QLDB Stream Journal To Kinesis",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://qldb.{region}.amazonaws.com/ledgers/:name/journal-kinesis-streams",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "The name of the ledger."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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."
},
{
"info": {
"name": "Amazon QLDB Update Ledger Permissions Mode",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://qldb.{region}.amazonaws.com/ledgers/:name/permissions-mode",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "The name of the ledger."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": " Updates the permissions mode of a ledger. Before you switch to the DigestTipAddress is provided.DELETING status, then throws ResourceNotFou"
},
{
"info": {
"name": "Amazon QLDB Get Digest",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://qldb.{region}.amazonaws.com/ledgers/:name/digest",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "The name of the ledger."
}
]
},
"docs": "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."
},
{
"info": {
"name": "Amazon QLDB Get Revision",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://qldb.{region}.amazonaws.com/ledgers/:name/revision",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "The name of the ledger."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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."
},
{
"info": {
"name": "Amazon QLDB List Journal Kinesis Streams For Ledger",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://qldb.{region}.amazonaws.com/ledgers/:name/journal-kinesis-streams",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "The name of the ledger."
},
{
"name": "max_results",
"value": "",
"type": "query",
"description": "The maximum number of results to return in a single ListJournalKinesisStreamsForLedger request. (The actual number of results returned might be fewer.)"
},
{
"name": "next_token",
"value": "",
"type": "query",
"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."
},
{
"name": "MaxResults",
"value": "",
"type": "query",
"description": "Pagination limit"
},
{
"name": "NextToken",
"value": "",
"type": "query",
"description": "Pagination token"
}
]
},
"docs": "DescribeJournalKinesisStream.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.