

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

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

Beschreibt die Edge-Konfiguration eines Streams, die mithilfe der `StartEdgeConfigurationUpdate` API festgelegt wurde, und den aktuellen Status der Recorder- und Uploader-Jobs des Edge-Agenten. Verwenden Sie diese API, um den Status der Konfiguration abzurufen und festzustellen, ob die Konfiguration mit dem Edge-Agent synchronisiert ist. Verwenden Sie diese API, um den Zustand des Edge-Agenten zu bewerten.

**Anmerkung**  
Diese API ist in der Region AWS Afrika (Kapstadt), af-south-1, nicht verfügbar.

## Anforderungssyntax
<a name="API_DescribeEdgeConfiguration_RequestSyntax"></a>

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

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

## URI-Anfrageparameter
<a name="API_DescribeEdgeConfiguration_RequestParameters"></a>

Die Anforderung verwendet keine URI-Parameter.

## Anforderungstext
<a name="API_DescribeEdgeConfiguration_RequestBody"></a>

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

 ** [StreamARN](#API_DescribeEdgeConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-request-StreamARN"></a>
Der Amazon-Ressourcenname (ARN) des -Stream. Geben Sie entweder den oder den an`StreamName`. `StreamARN`  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 1024 Zeichen.  
Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`   
Erforderlich: Nein

 ** [StreamName](#API_DescribeEdgeConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-request-StreamName"></a>
Der Name des Streams, dessen Edge-Konfiguration Sie aktualisieren möchten. Geben Sie entweder den `StreamName` oder den an`StreamARN`.   
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.  
Pattern: `[a-zA-Z0-9_.-]+`   
Erforderlich: Nein

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

## Antwortelemente
<a name="API_DescribeEdgeConfiguration_ResponseElements"></a>

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

 ** [CreationTime](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-CreationTime"></a>
Der Zeitstempel, zu dem die Edge-Konfiguration eines Streams zum ersten Mal erstellt wurde.  
Typ: Zeitstempel

 ** [EdgeAgentStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-EdgeAgentStatus"></a>
Ein Objekt, das die neuesten Statusdetails für die Recorder- und Uploader-Jobs eines Edge-Agenten enthält. Verwenden Sie diese Informationen, um den aktuellen Zustand eines Edge-Agents zu ermitteln.  
Typ: [EdgeAgentStatus](API_EdgeAgentStatus.md) Objekt

 ** [EdgeConfig](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-EdgeConfig"></a>
Eine Beschreibung der Edge-Konfiguration des Streams, die für die Synchronisierung mit der Edge Agent IoT Greengrass-Komponente verwendet wird. Die Edge Agent-Komponente wird auf einem IoT Hub-Gerät ausgeführt, das bei Ihnen vor Ort eingerichtet ist.  
Typ: [EdgeConfig](API_EdgeConfig.md) Objekt

 ** [FailedStatusDetails](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-FailedStatusDetails"></a>
Eine Beschreibung des generierten Fehlerstatus.  
Typ: Zeichenfolge

 ** [LastUpdatedTime](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-LastUpdatedTime"></a>
Der Zeitstempel, zu dem die Edge-Konfiguration eines Streams zuletzt aktualisiert wurde.  
Typ: Zeitstempel

 ** [StreamARN](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-StreamARN"></a>
Der Amazon-Ressourcenname (ARN) des -Stream.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 1024 Zeichen.  
Pattern: `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>
Der Name des Streams, von dem aus die Edge-Konfiguration aktualisiert wurde.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.  
Pattern: `[a-zA-Z0-9_.-]+` 

 ** [SyncStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-SyncStatus"></a>
Der neueste Status des Edge-Konfigurationsupdates.  
Typ: Zeichenfolge  
Zulässige Werte: `SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED` 

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

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).

 ** AccessDeniedException **   
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.  
HTTP-Statuscode: 401

 ** ClientLimitExceededException **   
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.  
HTTP-Statuscode: 400

 ** InvalidArgumentException **   
Der Wert für diesen Eingabeparameter ist ungültig.  
HTTP-Statuscode: 400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.  
HTTP-Statuscode: 404

 ** StreamEdgeConfigurationNotFoundException **   
Die Ausnahme wurde gerendert, wenn Amazon Kinesis Video Stream die von Ihnen angegebene Edge-Konfiguration eines Streams nicht finden kann.   
HTTP-Statuscode: 404

## Weitere Informationen finden Sie unter:
<a name="API_DescribeEdgeConfiguration_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+  [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 