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

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

Descrive la configurazione edge di uno stream impostata utilizzando l'`StartEdgeConfigurationUpdate`API e lo stato più recente dei processi di registrazione e upload dell'agente edge. Utilizza questa API per ottenere lo stato della configurazione e determinare se la configurazione è sincronizzata con Edge Agent. Utilizza questa API per valutare lo stato di salute dell'Edge Agent.

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

## Sintassi della richiesta
<a name="API_DescribeEdgeConfiguration_RequestSyntax"></a>

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

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

## Parametri della richiesta URI:
<a name="API_DescribeEdgeConfiguration_RequestParameters"></a>

La richiesta non utilizza parametri URI.

## Corpo della richiesta
<a name="API_DescribeEdgeConfiguration_RequestBody"></a>

La richiesta accetta i seguenti dati in formato JSON.

 ** [StreamARN](#API_DescribeEdgeConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-request-StreamARN"></a>
Il nome della risorsa Amazon (ARN) del flusso. Specificare il o il. `StreamName` `StreamARN`  
Tipo: String  
Limitazioni di lunghezza: lunghezza minima pari a 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]+`   
Obbligatorio: no

 ** [StreamName](#API_DescribeEdgeConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-request-StreamName"></a>
Il nome dello stream di cui si desidera aggiornare la configurazione edge. Specificate il `StreamName` o il`StreamARN`.   
Tipo: String  
Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 256 caratteri.  
Modello: `[a-zA-Z0-9_.-]+`   
Obbligatorio: no

## Sintassi della risposta
<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"
}
```

## Elementi di risposta
<a name="API_DescribeEdgeConfiguration_ResponseElements"></a>

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

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

 ** [CreationTime](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-CreationTime"></a>
Il timestamp in cui è stata creata per la prima volta la configurazione edge di uno stream.  
Tipo: Timestamp

 ** [EdgeAgentStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-EdgeAgentStatus"></a>
Un oggetto che contiene i dettagli più recenti sullo stato dei lavori di registrazione e caricamento di un agente edge. Utilizza queste informazioni per determinare lo stato attuale di un agente edge.  
Tipo: oggetto [EdgeAgentStatus](API_EdgeAgentStatus.md)

 ** [EdgeConfig](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-EdgeConfig"></a>
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: oggetto [EdgeConfig](API_EdgeConfig.md)

 ** [FailedStatusDetails](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-FailedStatusDetails"></a>
Una descrizione dello stato di errore generato.  
Tipo: String

 ** [LastUpdatedTime](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-LastUpdatedTime"></a>
Il timestamp in cui la configurazione edge di uno stream è stata aggiornata l'ultima volta.  
Tipo: Timestamp

 ** [StreamARN](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-StreamARN"></a>
Il nome della risorsa Amazon (ARN) del flusso.  
Tipo: String  
Limitazioni di lunghezza: lunghezza minima pari a 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](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-StreamName"></a>
Il nome dello stream da cui è stata aggiornata la configurazione edge.  
Tipo: String  
Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 256 caratteri.  
Modello: `[a-zA-Z0-9_.-]+` 

 ** [SyncStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-SyncStatus"></a>
Lo stato più recente dell'aggiornamento della configurazione edge.  
Tipo: String  
Valori validi: `SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED` 

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Tipi di errore comuni](CommonErrors.md).

 ** 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

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams non riesce a trovare lo stream specificato.  
Codice di stato HTTP: 404

 ** StreamEdgeConfigurationNotFoundException **   
L'eccezione viene renderizzata quando Amazon Kinesis Video Stream non riesce a trovare la configurazione edge dello stream specificata.   
Codice di stato HTTP: 404

## Vedi anche
<a name="API_DescribeEdgeConfiguration_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche, consulta quanto segue AWS SDKs:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK per C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration)