Own AWS? Customize your docs with AI search, analytics, and more.

GET

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

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

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 <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration">Expiration for terminal streams</a> in the Amazon QLDB Developer Guide.

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 describe.

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 GET \
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}

GET

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

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

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 <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration">Expiration for terminal streams</a> in the Amazon QLDB Developer Guide.

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 describe.

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 GET \
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}

GET

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

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

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 <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration">Expiration for terminal streams</a> in the Amazon QLDB Developer Guide.

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 describe.

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 GET \
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}

GET

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

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

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 <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration">Expiration for terminal streams</a> in the Amazon QLDB Developer Guide.

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 describe.

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 GET \
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}