DescribeEdgeConfiguration - 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á.

DescribeEdgeConfiguration

Descreve a configuração de borda de um stream que foi definida usando a StartEdgeConfigurationUpdate API e o status mais recente das tarefas de gravador e carregador do agente de borda. Use essa API para obter o status da configuração e determinar se a configuração está sincronizada com o Edge Agent. Use essa API para avaliar a integridade do Edge Agent.

nota

Essa API não está disponível na região AWS África (Cidade do Cabo), af-south-1.

Sintaxe da Solicitação

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

{
   "StreamARN": "string",
   "StreamName": "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.

StreamARN

O Nome de recurso da Amazon (ARN) do fluxo do . Especifique o StreamName ou StreamARN o.

Tipo: string

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

Padrão: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

Obrigatório: não

StreamName

O nome do fluxo cuja configuração de borda você deseja atualizar. Especifique o StreamName ou StreamARN o.

Tipo: string

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

Padrão: [a-zA-Z0-9_.-]+

Obrigatório: Não

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "EdgeAgentStatus": { 
      "LastRecorderStatus": { 
         "JobStatusDetails": "string",
         "LastCollectedTime": number,
         "LastUpdatedTime": number,
         "RecorderStatus": "string"
      },
      "LastUploaderStatus": { 
         "JobStatusDetails": "string",
         "LastCollectedTime": number,
         "LastUpdatedTime": number,
         "UploaderStatus": "string"
      }
   },
   "EdgeConfig": { 
      "DeletionConfig": { 
         "DeleteAfterUpload": boolean,
         "EdgeRetentionInHours": number,
         "LocalSizeConfig": { 
            "MaxLocalMediaSizeInMB": number,
            "StrategyOnFullSize": "string"
         }
      },
      "HubDeviceArn": "string",
      "RecorderConfig": { 
         "MediaSourceConfig": { 
            "MediaUriSecretArn": "string",
            "MediaUriType": "string"
         },
         "ScheduleConfig": { 
            "DurationInSeconds": number,
            "ScheduleExpression": "string"
         }
      },
      "UploaderConfig": { 
         "ScheduleConfig": { 
            "DurationInSeconds": number,
            "ScheduleExpression": "string"
         }
      }
   },
   "FailedStatusDetails": "string",
   "LastUpdatedTime": number,
   "StreamARN": "string",
   "StreamName": "string",
   "SyncStatus": "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.

CreationTime

O carimbo de data/hora em que a configuração de borda de um riacho foi criada pela primeira vez.

Tipo: Timestamp

EdgeAgentStatus

Um objeto que contém os detalhes de status mais recentes das tarefas de gravador e carregador de um agente de ponta. Use essas informações para determinar a integridade atual de um agente de ponta.

Tipo: objeto EdgeAgentStatus

EdgeConfig

Uma descrição da configuração de borda do stream que será usada para sincronizar com o componente Edge Agent IoT Greengrass. O componente Edge Agent será executado em um dispositivo Hub IoT configurado em suas instalações.

Tipo: objeto EdgeConfig

FailedStatusDetails

Uma descrição do status de falha gerado.

Tipo: string

LastUpdatedTime

O carimbo de data/hora em que a configuração de borda de um stream foi atualizada pela última vez.

Tipo: Timestamp

StreamARN

O Nome de recurso da Amazon (ARN) do fluxo do .

Tipo: string

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

Padrão: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

StreamName

O nome do fluxo a partir do qual a configuração de borda foi atualizada.

Tipo: string

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

Padrão: [a-zA-Z0-9_.-]+

SyncStatus

O status mais recente da atualização da configuração de borda.

Tipo: strings

Valores Válidos: SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED

Erros

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

AccessDeniedException

Você não tem as permissões necessárias para realizar essa operação.

Código de status HTTP: 401

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

ResourceNotFoundException

O Amazon Kinesis Video Streams não consegue encontrar o stream que você especificou.

Código de Status HTTP: 404

StreamEdgeConfigurationNotFoundException

A exceção é renderizada quando o Amazon Kinesis Video Stream não consegue encontrar a configuração de borda do stream que você especificou.

Código de Status HTTP: 404

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: