DELETE

/ledgers/{name}/journal-kinesis-streams/{streamId}

http://qldb.{region}.amazonaws.com/ledgers/{name}/journal-kinesis-streams/{streamId}

<p>Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be <code>ACTIVE</code>.</p> <p>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.</p>

Access Token Required: API Key

Path Parameters

namestringrequired

The name of the ledger.

streamIdstringrequired

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request DELETE \
2     --url 'http://qldb.{region}.amazonaws.com/ledgers/{name}/journal-kinesis-streams/{streamId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}