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.

# DescribeEdgeConfiguration
<a name="API_DescribeEdgeConfiguration"></a>

Décrit la configuration périphérique d'un flux définie à l'aide de l'`StartEdgeConfigurationUpdate`API et le dernier état des tâches d'enregistrement et de téléchargement de l'agent Edge. Utilisez cette API pour obtenir l'état de la configuration afin de déterminer si celle-ci est synchronisée avec l'agent Edge. Utilisez cette API pour évaluer l'état de santé de l'agent Edge.

**Note**  
Cette API n'est pas disponible dans la région AWS Afrique (Le Cap), af-south-1.

## Syntaxe de la demande
<a name="API_DescribeEdgeConfiguration_RequestSyntax"></a>

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

{
   "StreamARN": "{{string}}",
   "StreamName": "{{string}}"
}
```

## Paramètres de demande URI
<a name="API_DescribeEdgeConfiguration_RequestParameters"></a>

La demande n’utilise pas de paramètres URI.

## Corps de la demande
<a name="API_DescribeEdgeConfiguration_RequestBody"></a>

Cette demande accepte les données suivantes au format JSON.

 ** [StreamARN](#API_DescribeEdgeConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-request-StreamARN"></a>
L'Amazon Resource Name (ARN) du flux. Spécifiez le `StreamName` ou le`StreamARN`.  
Type : Chaîne  
Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 1024.  
Modèle : `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`   
Obligatoire : non

 ** [StreamName](#API_DescribeEdgeConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-request-StreamName"></a>
Nom du flux dont vous souhaitez mettre à jour la configuration périphérique. Spécifiez le `StreamName` ou le`StreamARN`.   
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.  
Modèle : `[a-zA-Z0-9_.-]+`   
Obligatoire : non

## Syntaxe de la réponse
<a name="API_DescribeEdgeConfiguration_ResponseSyntax"></a>

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

## Eléments de réponse
<a name="API_DescribeEdgeConfiguration_ResponseElements"></a>

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.

 ** [CreationTime](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-CreationTime"></a>
Horodatage auquel la configuration périphérique d'un flux a été créée pour la première fois.  
Type : Timestamp

 ** [EdgeAgentStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-EdgeAgentStatus"></a>
Objet contenant les derniers détails d'état relatifs aux tâches d'enregistrement et de téléchargement d'un agent Edge. Utilisez ces informations pour déterminer l'état actuel d'un agent de périphérie.  
Type : objet [EdgeAgentStatus](API_EdgeAgentStatus.md)

 ** [EdgeConfig](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-EdgeConfig"></a>
Description de la configuration périphérique du flux qui sera utilisée pour la synchronisation avec le composant Edge Agent IoT Greengrass. Le composant Edge Agent s'exécutera sur un appareil IoT Hub configuré dans vos locaux.  
Type : objet [EdgeConfig](API_EdgeConfig.md)

 ** [FailedStatusDetails](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-FailedStatusDetails"></a>
Description de l'état de défaillance généré.  
Type : Chaîne

 ** [LastUpdatedTime](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-LastUpdatedTime"></a>
Horodatage auquel la configuration périphérique d'un flux a été mise à jour pour la dernière fois.  
Type : Timestamp

 ** [StreamARN](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-StreamARN"></a>
L'Amazon Resource Name (ARN) du flux.  
Type : Chaîne  
Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 1024.  
Modèle : `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` 

 ** [StreamName](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-StreamName"></a>
Nom du flux à partir duquel la configuration Edge a été mise à jour.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.  
Modèle : `[a-zA-Z0-9_.-]+` 

 ** [SyncStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-SyncStatus"></a>
État le plus récent de la mise à jour de la configuration Edge.  
Type : Chaîne  
Valeurs valides : `SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED` 

## Erreurs
<a name="API_DescribeEdgeConfiguration_Errors"></a>

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Types d'erreurs courants](CommonErrors.md).

 ** AccessDeniedException **   
Vous ne disposez pas des autorisations requises pour effectuer cette opération.  
Code d'état HTTP : 401

 ** ClientLimitExceededException **   
Kinesis Video Streams a limité le nombre de demandes 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

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams ne trouve pas le flux que vous avez spécifié.  
Code d’état HTTP :404

 ** StreamEdgeConfigurationNotFoundException **   
L'exception s'est produite lorsque le flux vidéo Amazon Kinesis ne trouve pas la configuration périphérique d'un flux que vous avez spécifiée.   
Code d’état HTTP :404

## Voir aussi
<a name="API_DescribeEdgeConfiguration_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK pour C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration)