Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
ListEdgeAgentConfigurations
Renvoie un tableau de configurations Edge associées à l'agent Edge spécifié.
Dans la demande, vous devez spécifier l'agent EdgeHubDeviceArn.
Note
Cette API n'est pas disponible dans la région AWS Afrique (Le Cap), af-south-1.
Syntaxe de la demande
POST /listEdgeAgentConfigurations HTTP/1.1
Content-type: application/json
{
"HubDeviceArn": "string",
"MaxResults": number,
"NextToken": "string"
}Paramètres de demande URI
La demande n’utilise pas de paramètres URI.
Corps de la demande
Cette demande accepte les données suivantes au format JSON.
- HubDeviceArn
-
L' « Internet des objets (IoT) », Arn de l'agent périphérique.
Type : chaîne
Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 1024.
Modèle :
arn:[a-z\d-]+:iot:[a-z0-9-]+:[0-9]+:thing/[a-zA-Z0-9_.-]+Obligatoire : oui
- MaxResults
-
Le nombre maximal de configurations de bord à renvoyer dans la réponse. La valeur par défaut est 5.
Type : entier
Plage valide : Valeur minimum de 1. Valeur maximum de 10.
Obligatoire : non
- NextToken
-
Si vous spécifiez ce paramètre, lorsque le résultat d'une
ListEdgeAgentConfigurationsopération est tronqué, l'appel renvoie leNextTokendans la réponse. Pour obtenir un autre lot de configurations Edge, fournissez ce jeton dans votre prochaine demande.Type : chaîne
Contraintes de longueur : longueur minimum de 0. Longueur maximale de 512.
Modèle :
[a-zA-Z0-9+/=]*Obligatoire : non
Syntaxe de la réponse
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"
}Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
- EdgeConfigs
-
Description de la configuration périphérique d'un flux unique.
Type : tableau d’objets ListEdgeAgentConfigurationsEdgeConfig
- NextToken
-
Si la réponse est tronquée, l'appel renvoie cet élément avec un jeton donné. Pour obtenir le prochain lot de configurations Edge, utilisez ce jeton dans votre prochaine demande.
Type : chaîne
Contraintes de longueur : longueur minimum de 0. Longueur maximale de 512.
Modèle :
[a-zA-Z0-9+/=]*
Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.
- ClientLimitExceededException
-
Kinesis Video Streams a limité la demande car vous avez dépassé le nombre maximal d'appels clients autorisés. Essayez de passer l'appel plus tard.
Code d’état HTTP : 400
- InvalidArgumentException
-
La valeur de ce paramètre d'entrée n'est pas valide.
Code d’état HTTP : 400
- NotAuthorizedException
-
L'appelant n'est pas autorisé à effectuer cette opération.
Code d'état HTTP : 401
consultez aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :
