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á.
ListEdgeAgentConfigurations
Retorna uma matriz de configurações de borda associadas ao Agente de Borda especificado.
Na solicitação, você deve especificar o Edge AgentHubDeviceArn.
nota
Essa API não está disponível na região AWS África (Cidade do Cabo), af-south-1.
Sintaxe da Solicitação
POST /listEdgeAgentConfigurations HTTP/1.1
Content-type: application/json
{
"HubDeviceArn": "string",
"MaxResults": number,
"NextToken": "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.
- HubDeviceArn
-
A “coisa da Internet das Coisas (IoT)” Arn of the edge agent.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.024.
Padrão:
arn:[a-z\d-]+:iot:[a-z0-9-]+:[0-9]+:thing/[a-zA-Z0-9_.-]+Exigido: Sim
- MaxResults
-
O número máximo de configurações de borda a serem retornadas na resposta. O padrão é 5.
Tipo: inteiro
Intervalo válido: valor mínimo de 1. Valor máximo de 10.
Obrigatório: não
- NextToken
-
Se você especificar esse parâmetro, quando o resultado de uma
ListEdgeAgentConfigurationsoperação for truncado, a chamada retornará oNextTokenna resposta. Para obter outro lote de configurações de borda, 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
Sintaxe da Resposta
HTTP/1.1 200
Content-type: application/json
{
"EdgeConfigs": [
{
"CreationTime": number,
"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"
}
],
"NextToken": "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.
- EdgeConfigs
-
Uma descrição da configuração de borda de um único fluxo.
Tipo: matriz de objetos ListEdgeAgentConfigurationsEdgeConfig
- NextToken
-
Se a resposta for truncada, a chamada retornará esse elemento com um determinado token. Para obter o próximo lote de configurações de borda, 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+/=]*
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
- NotAuthorizedException
-
O chamador não está autorizado a realizar essa operação.
Código de status HTTP: 401
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:
