ListEdgeAgentConfigurations - Flusso di video Amazon Kinesis

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

ListEdgeAgentConfigurations

Restituisce una serie di configurazioni edge associate all'Edge Agent specificato.

Nella richiesta, è necessario specificare l'Edge AgentHubDeviceArn.

Nota

Questa API non è disponibile nella regione AWS Africa (Città del Capo), af-south-1.

Sintassi della richiesta

POST /listEdgeAgentConfigurations HTTP/1.1 Content-type: application/json { "HubDeviceArn": "string", "MaxResults": number, "NextToken": "string" }

Parametri della richiesta URI:

La richiesta non utilizza parametri URI.

Corpo della richiesta

La richiesta accetta i seguenti dati in formato JSON.

HubDeviceArn

La «cosa dell'Internet of Things (IoT)» Arn of the edge agent.

Tipo: String

Limitazioni di lunghezza: lunghezza minima di 1. La lunghezza massima è 1024 caratteri.

Pattern: arn:[a-z\d-]+:iot:[a-z0-9-]+:[0-9]+:thing/[a-zA-Z0-9_.-]+

Campo obbligatorio: sì

MaxResults

Il numero massimo di configurazioni edge da restituire nella risposta. Il predefinito è 5.

Tipo: integer

Intervallo valido: valore minimo di 1. valore massimo pari a 10.

Required: No

NextToken

Se si specifica questo parametro, quando il risultato di un'ListEdgeAgentConfigurationsoperazione viene troncato, la chiamata restituisce il valore NextToken nella risposta. Per ottenere un altro batch di configurazioni edge, fornisci questo token nella tua prossima richiesta.

Tipo: String

Limitazioni di lunghezza: lunghezza minima di 0. La lunghezza massima è 512 caratteri.

Modello: [a-zA-Z0-9+/=]*

Required: No

Sintassi della risposta

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" }

Elementi di risposta

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

EdgeConfigs

Una descrizione della configurazione perimetrale di un singolo stream.

Tipo: matrice di oggetti ListEdgeAgentConfigurationsEdgeConfig

NextToken

Se la risposta viene troncata, la chiamata restituisce questo elemento con un determinato token. Per ottenere il prossimo batch di configurazioni edge, usa questo token nella tua prossima richiesta.

Tipo: String

Limitazioni di lunghezza: lunghezza minima di 0. La lunghezza massima è 512 caratteri.

Pattern: [a-zA-Z0-9+/=]*

Errori

Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.

ClientLimitExceededException

Kinesis Video Streams ha limitato la richiesta perché hai superato il limite di chiamate client consentite. Prova a fare la chiamata più tardi.

Codice di stato HTTP: 400

InvalidArgumentException

Il valore per questo parametro di input non è valido.

Codice di stato HTTP: 400

NotAuthorizedException

Il chiamante non è autorizzato a eseguire questa operazione.

Codice di stato HTTP: 401

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in uno degli SDK AWS specifici della lingua, consulta quanto segue: