ListJournalKinesisStreamsForLedger - Banco de dados Amazon Quantum Ledger (AmazonQLDB)
Sintaxe da SolicitaçãoParâmetros da Solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte também

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

ListJournalKinesisStreamsForLedger

Retorna todos os streams de diário para um determinado ledger do Amazon QLDB.

Essa ação não retorna nenhum stream de diário expirado. Para obter mais informações, consulte Expiração para fluxos terminais no Guia do desenvolvedor do Amazon QLDB.

Essa ação retorna um máximo de itens MaxResults. Ele é paginado para que você possa recuperar todos os itens chamando ListJournalKinesisStreamsForLedger várias vezes.

Sintaxe da Solicitação

GET /ledgers/name/journal-kinesis-streams?max_results=MaxResults&next_token=NextToken HTTP/1.1

Parâmetros da Solicitação de URI

A solicitação usa os seguintes parâmetros de URI:

name

O nome do ledger.

Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 32.

Padrão: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

Exigido: Sim

MaxResults

O número máximo de resultados a serem retornados em uma única solicitação ListJournalKinesisStreamsForLedger. (O número real de resultados retornados pode ser menor.)

Faixa válida: valor mínimo de 1. Valor máximo de 100.

NextToken

Um token de paginação, indicando que você deseja recuperar a próxima página de resultados. Se você recebeu um valor para NextToken na resposta de uma chamada ListJournalKinesisStreamsForLedger anterior, use esse valor como entrada aqui.

Restrições de tamanho: tamanho mínimo de 4. Tamanho máximo de 1.024.

Padrão: ^[A-Za-z-0-9+/=]+$

Corpo da Solicitação

Essa solicitação não tem corpo.

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Streams": [ 
      { 
         "Arn": "string",
         "CreationTime": number,
         "ErrorCause": "string",
         "ExclusiveEndTime": number,
         "InclusiveStartTime": number,
         "KinesisConfiguration": { 
            "AggregationEnabled": boolean,
            "StreamArn": "string"
         },
         "LedgerName": "string",
         "RoleArn": "string",
         "Status": "string",
         "StreamId": "string",
         "StreamName": "string"
      }
   ]
}

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

NextToken

  • Se NextToken estiver vazio, a última página de resultados foi processada e não há mais resultados a serem recuperados.

  • Se NextToken não estiver vazio, há mais resultados disponíveis. Para recuperar a próxima página de resultados, use o valor de NextToken em uma chamada ListJournalKinesisStreamsForLedger subsequente.

Tipo: sequência

Restrições de tamanho: tamanho mínimo de 4. Tamanho máximo de 1.024.

Padrão: ^[A-Za-z-0-9+/=]+$

Streams

Os fluxos de diário do QLDB que estão atualmente associados ao ledger fornecido.

Tipo: matriz de objetos JournalKinesisStreamDescription

Erros

Para obter informações sobre os erros comuns que são comuns a todas as ações, consulte Erros comuns.

InvalidParameterException

Um ou mais parâmetros na solicitação não são válidos.

Código de Status HTTP: 400

ResourceNotFoundException

O recurso especificado não existe.

Código de Status HTTP: 404

ResourcePreconditionNotMetException

A operação falhou porque uma condição não foi satisfeita com antecedência.

Código de status HTTP: 412

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte: