

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.

# StartEdgeConfigurationUpdate
<a name="API_StartEdgeConfigurationUpdate"></a>

API asynchrone qui met à jour la configuration périphérique existante d'un flux. Le Kinesis Video Stream synchronisera la configuration périphérique du flux avec le composant Edge Agent IoT Greengrass qui s'exécute sur un appareil IoT Hub, configuré dans vos locaux. Le temps de synchronisation peut varier et dépend de la connectivité du périphérique Hub. Il `SyncStatus` sera mis à jour au fur et à mesure que la configuration Edge sera reconnue et synchronisée avec l'agent Edge. 

Si cette API est invoquée pour la première fois, une nouvelle configuration périphérique sera créée pour le flux et le statut de synchronisation sera défini sur`SYNCING`. Vous devrez attendre que l'état de synchronisation atteigne un état de terminal tel que : ou `IN_SYNC``SYNC_FAILED`, avant de réutiliser cette API. Si vous invoquez cette API pendant le processus de synchronisation, une `ResourceInUseException` sera émise. La connectivité entre la configuration périphérique du flux et l'agent Edge sera réessayée pendant 15 minutes. Après 15 minutes, le statut passera à l'`SYNC_FAILED`état actuel.

Pour déplacer une configuration Edge d'un appareil à un autre, utilisez cette [DeleteEdgeConfiguration](API_DeleteEdgeConfiguration.md) option pour supprimer la configuration Edge actuelle. Vous pouvez ensuite appeler StartEdgeConfigurationUpdate avec un ARN du périphérique Hub mis à jour.

**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_StartEdgeConfigurationUpdate_RequestSyntax"></a>

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

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

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

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

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

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

 ** [EdgeConfig](#API_StartEdgeConfigurationUpdate_RequestSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-request-EdgeConfig"></a>
Les détails de configuration Edge requis pour appeler le processus de mise à jour.  
Type : objet [EdgeConfig](API_EdgeConfig.md)  
Obligatoire : oui

 ** [StreamARN](#API_StartEdgeConfigurationUpdate_RequestSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-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_StartEdgeConfigurationUpdate_RequestSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-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_StartEdgeConfigurationUpdate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

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

## Eléments de réponse
<a name="API_StartEdgeConfigurationUpdate_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_StartEdgeConfigurationUpdate_ResponseSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-response-CreationTime"></a>
Horodatage auquel la configuration périphérique d'un flux a été créée pour la première fois.  
Type : Timestamp

 ** [EdgeConfig](#API_StartEdgeConfigurationUpdate_ResponseSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-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_StartEdgeConfigurationUpdate_ResponseSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-response-FailedStatusDetails"></a>
Description de l'état de défaillance généré.  
Type : Chaîne

 ** [LastUpdatedTime](#API_StartEdgeConfigurationUpdate_ResponseSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-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_StartEdgeConfigurationUpdate_ResponseSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-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_StartEdgeConfigurationUpdate_ResponseSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-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_StartEdgeConfigurationUpdate_ResponseSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-response-SyncStatus"></a>
 État de synchronisation actuel de la configuration périphérique du flux. Lorsque vous appelez cette API, le statut de synchronisation est défini sur l'`SYNCING`état. Utilisez l'`DescribeEdgeConfiguration`API pour obtenir le dernier état de la configuration Edge.  
Type : Chaîne  
Valeurs valides : `SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED` 

## Erreurs
<a name="API_StartEdgeConfigurationUpdate_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é 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

 ** NoDataRetentionException **   
La durée de conservation des données Stream en heures est égale à zéro.  
Code d’état HTTP : 400

 ** ResourceInUseException **   
Lorsque l'entrée `StreamARN` ou `ChannelARN` l'entrée `CLOUD_STORAGE_MODE` est déjà mappée à une autre ressource Kinesis Video Stream, ou si l'`StreamARN`entrée `ChannelARN` fournie n'est pas active, essayez l'une des solutions suivantes :   

1. L'`DescribeMediaStorageConfiguration`API permettant de déterminer à quoi le canal donné est mappé. 

1. L'`DescribeMappedResourceConfiguration`API permettant de déterminer le canal auquel le flux donné est mappé. 

1. L'`DescribeSignalingChannel`API `DescribeStream` or pour déterminer le statut de la ressource. 
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

## Voir aussi
<a name="API_StartEdgeConfigurationUpdate_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/StartEdgeConfigurationUpdate) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 