StartEdgeConfigurationUpdate - Flusso di video Amazon Kinesis
Sintassi della richiestaParametri della richiesta URI:Corpo della richiestaSintassi della rispostaElementi di rispostaErroriVedi anche

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à.

StartEdgeConfigurationUpdate

Un'API asincrona che aggiorna la configurazione edge esistente di uno stream. Kinesis Video Stream sincronizzerà la configurazione edge dello stream con il componente Edge Agent IoT Greengrass che funziona su un dispositivo Hub IoT, configurato presso la tua sede. Il tempo di sincronizzazione può variare e dipende dalla connettività del dispositivo Hub. SyncStatusVerrà aggiornato non appena la configurazione edge verrà riconosciuta e sincronizzata con Edge Agent.

Se questa API viene richiamata per la prima volta, verrà creata una nuova configurazione edge per lo stream e lo stato di sincronizzazione verrà impostato su. SYNCING Dovrai attendere che lo stato di sincronizzazione raggiunga uno stato terminale come:IN_SYNC, oppureSYNC_FAILED, prima di utilizzare nuovamente questa API. Se richiami questa API durante il processo di sincronizzazione, ResourceInUseException verrà generato un. La connettività della configurazione edge dello stream e dell'Edge Agent verrà ritentata per 15 minuti. Dopo 15 minuti, lo stato passerà allo SYNC_FAILED stato.

Per spostare una configurazione di bordo da un dispositivo a un altro, utilizzare DeleteEdgeConfiguration per eliminare la configurazione di bordo corrente. È quindi possibile richiamare StartEdgeConfigurationUpdate con un ARN del dispositivo Hub aggiornato.

Nota

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

Sintassi della richiesta

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

Parametri della richiesta URI:

La richiesta non utilizza parametri URI.

Corpo della richiesta

La richiesta accetta i seguenti dati in formato JSON.

EdgeConfig

I dettagli di configurazione dell'edge necessari per richiamare il processo di aggiornamento.

Tipo: EdgeConfig oggetto

Campo obbligatorio: sì

StreamARN

Il nome della risorsa Amazon (ARN) del flusso. Specificare il StreamName o il. StreamARN

Tipo: String

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

Modello: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

Campo obbligatorio: no

StreamName

Il nome dello stream di cui si desidera aggiornare la configurazione edge. Specificate il StreamName o ilStreamARN.

Tipo: String

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

Modello: [a-zA-Z0-9_.-]+

Campo obbligatorio: no

Sintassi della risposta

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

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.

CreationTime

Il timestamp in cui è stata creata per la prima volta la configurazione edge di uno stream.

Tipo: Timestamp

EdgeConfig

Una descrizione della configurazione edge dello stream che verrà utilizzata per la sincronizzazione con il componente Edge Agent IoT Greengrass. Il componente Edge Agent verrà eseguito su un dispositivo Hub IoT configurato presso la tua sede.

Tipo: EdgeConfig oggetto

FailedStatusDetails

Una descrizione dello stato di errore generato.

Tipo: String

LastUpdatedTime

Il timestamp in cui la configurazione edge di uno stream è stata aggiornata l'ultima volta.

Tipo: Timestamp

StreamARN

Il nome della risorsa Amazon (ARN) del flusso.

Tipo: String

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

Modello: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

StreamName

Il nome dello stream da cui è stata aggiornata la configurazione edge.

Tipo: String

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

Modello: [a-zA-Z0-9_.-]+

SyncStatus

Lo stato di sincronizzazione corrente della configurazione edge dello stream. Quando richiami questa API, lo stato di sincronizzazione verrà impostato sullo SYNCING stato. Utilizza l'DescribeEdgeConfigurationAPI per ottenere lo stato più recente della configurazione edge.

Tipo: String

Valori validi: SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED

Errori

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

AccessDeniedException

Non hai le autorizzazioni necessarie per eseguire questa operazione.

Codice di stato HTTP: 401

ClientLimitExceededException

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

Codice di stato HTTP: 400

InvalidArgumentException

Il valore di questo parametro di input non è valido.

Codice di stato HTTP: 400

NoDataRetentionException

La conservazione dei dati Stream in ore è pari a zero.

Codice di stato HTTP: 400

ResourceInUseException

Quando l'ingresso StreamARN o ChannelARN l'ingresso CLOUD_STORAGE_MODE sono già mappati su un'altra risorsa Kinesis Video Stream, o se l'StreamARNingresso fornito ChannelARN o non è nello stato Attivo, prova una delle seguenti soluzioni:

  1. L'DescribeMediaStorageConfigurationAPI per determinare a cosa è mappato lo stream di un determinato canale.

  2. L'DescribeMappedResourceConfigurationAPI per determinare il canale su cui è mappato lo stream specificato.

  3. L'DescribeStreamo l'DescribeSignalingChannelAPI per determinare lo stato della risorsa.

Codice di stato HTTP: 400

ResourceNotFoundException

Amazon Kinesis Video Streams non riesce a trovare lo stream specificato.

Codice di stato HTTP: 404

Vedi anche

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