{ "uuid": "b853216e-41f5-4495-bdb5-310fef88aa94", "lastMigration": 29, "name": "Amazon QLDB", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "8893ae20-8c8b-4cf2-8f12-abad94aacee7", "documentation": "
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.
", "method": "delete", "endpoint": "ledgers/:name/journal-kinesis-streams/:streamId", "responses": [ { "uuid": "95559fcc-36c4-4105-a2ab-8dd55c6aeeb9", "body": "{\n \"StreamId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2349fb56-3be3-4f6d-b626-4bc85f3f0047", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidParameterException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2095a6a8-1783-4b52-b881-6e6d034d6c59", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "ResourceNotFoundException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ec7d15c2-d532-4615-8d8e-ed3197f89460", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "ResourcePreconditionNotMetException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "86f55ab3-d039-40b0-a519-8f46ddf5961a", "documentation": "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.
", "method": "get", "endpoint": "ledgers/:name/journal-kinesis-streams/:streamId", "responses": [ { "uuid": "feffd0b5-3e9c-46d9-8ad2-30b54e1e4a98", "body": "{\n \"Stream\": {\n \"LedgerName\": \"\",\n \"CreationTime\": \"{{faker 'date.recent' 365}}\",\n \"InclusiveStartTime\": \"{{faker 'date.recent' 365}}\",\n \"ExclusiveEndTime\": \"{{faker 'date.recent' 365}}\",\n \"RoleArn\": \"\",\n \"StreamId\": \"\",\n \"Arn\": \"\",\n \"Status\": \"\",\n \"KinesisConfiguration\": {\n \"StreamArn\": \"\",\n \"AggregationEnabled\": {{faker 'datatype.boolean'}}\n },\n \"ErrorCause\": \"\",\n \"StreamName\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2c2db968-d871-492e-a295-e580c067709d", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidParameterException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "56b2d209-9f84-449d-bd8c-81c10a03790d", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "ResourceNotFoundException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e361cb89-8b6e-4b5b-a456-d3edcfe765a4", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "ResourcePreconditionNotMetException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e813d503-e8f5-4baf-a7e5-b9e851282c25", "documentation": "Creates a new ledger in your account in the current Region.", "method": "post", "endpoint": "ledgers", "responses": [ { "uuid": "73b6eba2-3657-4229-a045-a85c7e495128", "body": "{\n \"Name\": \"\",\n \"Arn\": \"\",\n \"State\": \"\",\n \"CreationDateTime\": \"{{faker 'date.recent' 365}}\",\n \"PermissionsMode\": \"\",\n \"DeletionProtection\": {{faker 'datatype.boolean'}},\n \"KmsKeyArn\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3dc5fc23-50e9-4625-b6d8-db50a4ab1547", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidParameterException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "515d93e4-85f8-4bb2-a40c-63dfbf91c303", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "ResourceAlreadyExistsException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7145a86d-e32f-4289-a96e-797aa3080503", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "LimitExceededException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "51d44df1-b51b-4272-82ea-011820fccf8e", "body": "\"\"", "latency": 0, "statusCode": 483, "label": "ResourceInUseException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f0298e47-2dd5-43c5-8d4a-66e68fb9d48a", "documentation": "Returns an array of ledger summaries that are associated with the current 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 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. The data is written as files in Amazon Ion format.
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
.
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.
", "method": "get", "endpoint": "ledgers/:name/journal-s3-exports", "responses": [ { "uuid": "a81e95c2-6376-4b96-8af2-e9f7465a4a14", "body": "{\n \"JournalS3Exports\": [\n {\n \"LedgerName\": \"\",\n \"ExportId\": \"\",\n \"ExportCreationTime\": \"{{faker 'date.recent' 365}}\",\n \"Status\": \"\",\n \"InclusiveStartTime\": \"{{faker 'date.recent' 365}}\",\n \"ExclusiveEndTime\": \"{{faker 'date.recent' 365}}\",\n \"S3ExportConfiguration\": {\n \"Bucket\": \"\",\n \"Prefix\": \"\",\n \"EncryptionConfiguration\": {\n \"ObjectEncryptionType\": \"\",\n \"KmsKeyArn\": \"\"\n }\n },\n \"RoleArn\": \"\"\n }\n ],\n \"NextToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9c1c46d6-033d-48c2-aa16-ca77c60bb835", "documentation": "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
.
DigestTipAddress
is provided.",
"method": "post",
"endpoint": "ledgers/:name/revision",
"responses": [
{
"uuid": "63671c2a-5c42-4dd1-bf31-cf106c64caec",
"body": "{\n \"Proof\": {\n \"IonText\": \"\"\n },\n \"Revision\": {\n \"IonText\": \"\"\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Success",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "e0aee491-6008-4d6f-bba7-65281ac44bfd",
"body": "\"\"",
"latency": 0,
"statusCode": 480,
"label": "InvalidParameterException",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
},
{
"uuid": "016374f2-4f7f-4c70-82b3-073f632780c3",
"body": "\"\"",
"latency": 0,
"statusCode": 481,
"label": "ResourceNotFoundException",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
},
{
"uuid": "7b56cbd9-79cb-4432-88de-73e34f026a73",
"body": "\"\"",
"latency": 0,
"statusCode": 482,
"label": "ResourcePreconditionNotMetException",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "01717930-07fe-4b94-ad57-7074e88182be",
"documentation": "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.
Returns an array of journal export job descriptions for all ledgers that are associated with the current account and Region.
This action returns a maximum of MaxResults
items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports
multiple times.
This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.
", "method": "get", "endpoint": "journal-s3-exports", "responses": [ { "uuid": "7a53e81c-6179-4421-8823-cb5bc2765b75", "body": "{\n \"JournalS3Exports\": [\n {\n \"LedgerName\": \"\",\n \"ExportId\": \"\",\n \"ExportCreationTime\": \"{{faker 'date.recent' 365}}\",\n \"Status\": \"\",\n \"InclusiveStartTime\": \"{{faker 'date.recent' 365}}\",\n \"ExclusiveEndTime\": \"{{faker 'date.recent' 365}}\",\n \"S3ExportConfiguration\": {\n \"Bucket\": \"\",\n \"Prefix\": \"\",\n \"EncryptionConfiguration\": {\n \"ObjectEncryptionType\": \"\",\n \"KmsKeyArn\": \"\"\n }\n },\n \"RoleArn\": \"\"\n }\n ],\n \"NextToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "997b56e9-82c1-41f5-99ca-3e7bbb3ec831", "documentation": "Returns all tags for a specified Amazon QLDB resource.", "method": "get", "endpoint": "tags/:resourceArn", "responses": [ { "uuid": "15139488-57d5-4816-aa05-28f48f1a4b52", "body": "{\n \"Tags\": {}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "05f20f9b-ce5e-473e-945b-ff500b7beaa9", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidParameterException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a1f699fe-7ebe-44d6-83ac-d0b443891e36", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "ResourceNotFoundException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b62085a3-bddf-46de-8d24-86185ac01719", "documentation": "Adds one or more tags to a specified Amazon QLDB resource.
A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.
", "method": "post", "endpoint": "tags/:resourceArn", "responses": [ { "uuid": "32c6111e-8b8a-4600-8fff-0a8a633a276c", "body": "{}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9eaafa8f-4114-4e7c-8989-2714fba7c111", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidParameterException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "69ba43ca-6836-47ad-808c-899a70e79bda", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "ResourceNotFoundException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "885c691c-aac2-452b-9dbd-ab9aad1e1143", "documentation": "Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.", "method": "delete", "endpoint": "tags/:resourceArn#tagKeys", "responses": [ { "uuid": "b8f616fb-e641-45a4-bb45-e447f6efb38d", "body": "{}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5b55349d-edd2-40b7-af47-c24202da9117", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidParameterException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c41082a6-0baf-4224-88d4-f8ef30d9c74c", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "ResourceNotFoundException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "06b1b332-264d-4a28-8190-b166756034a7", "documentation": "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.