ListStreams - Amazon Kinesis Video Streams
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á.

ListStreams

Retorna uma matriz de StreamInfo objetos. Cada objeto descreve um fluxo. Para recuperar somente fluxos que satisfaçam uma condição específica, você pode especificar a. StreamNameCondition

Sintaxe da Solicitação

POST /listStreams HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string",
   "StreamNameCondition": { 
      "ComparisonOperator": "string",
      "ComparisonValue": "string"
   }
}

Parâmetros da solicitação de URI

A solicitação não usa nenhum parâmetro de URI.

Corpo da Solicitação

A solicitação aceita os dados a seguir no formato JSON.

MaxResults

O número máximo de fluxos a serem retornados na resposta. O padrão é 10.000.

Tipo: inteiro

Intervalo válido: valor mínimo de 1. Valor máximo de 10000.

Obrigatório: não

NextToken

Se você especificar esse parâmetro, quando o resultado de uma ListStreams operação for truncado, a chamada retornará o NextToken na resposta. Para obter outro lote de streams, forneça esse token em sua próxima solicitação.

Tipo: string

Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 512.

Padrão: [a-zA-Z0-9+/=]*

Obrigatório: não

StreamNameCondition

Opcional: retorna somente fluxos que satisfazem uma condição específica. Atualmente, você pode especificar somente o prefixo do nome de um stream como condição.

Tipo: objeto StreamNameCondition

Obrigatório: Não

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "StreamInfoList": [ 
      { 
         "CreationTime": number,
         "DataRetentionInHours": number,
         "DeviceName": "string",
         "KmsKeyId": "string",
         "MediaType": "string",
         "Status": "string",
         "StreamARN": "string",
         "StreamName": "string",
         "Version": "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 a resposta for truncada, a chamada retornará esse elemento com um token. Para obter o próximo lote de streams, use esse token em sua próxima solicitação.

Tipo: string

Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 512.

Padrão: [a-zA-Z0-9+/=]*

StreamInfoList

Uma matriz de objetos StreamInfo.

Tipo: matriz de objetos StreamInfo

Erros

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

ClientLimitExceededException

O Kinesis Video Streams limitou a solicitação porque você excedeu o limite permitido de chamadas de clientes. Tente fazer a ligação mais tarde.

Código de Status HTTP: 400

InvalidArgumentException

O valor desse parâmetro de entrada é inválido.

Código de Status HTTP: 400

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: