Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

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

Menjelaskan konfigurasi tepi aliran yang disetel menggunakan `StartEdgeConfigurationUpdate` API dan status terbaru dari pekerjaan perekam dan pengunggah agen edge. Gunakan API ini untuk mendapatkan status konfigurasi untuk menentukan apakah konfigurasi sinkron dengan Edge Agent. Gunakan API ini untuk mengevaluasi kesehatan Agen Edge.

**catatan**  
API ini tidak tersedia di wilayah AWS Afrika (Cape Town), af-south-1.

## Minta Sintaks
<a name="API_DescribeEdgeConfiguration_RequestSyntax"></a>

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

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

## Parameter Permintaan URI
<a name="API_DescribeEdgeConfiguration_RequestParameters"></a>

Permintaan tidak menggunakan parameter URI apa pun.

## Isi Permintaan
<a name="API_DescribeEdgeConfiguration_RequestBody"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [StreamARN](#API_DescribeEdgeConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-request-StreamARN"></a>
Nama Sumber Daya Amazon (ARN) dari aliran. Tentukan salah satu `StreamName` atau`StreamARN`.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 1024.  
Pola: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`   
Wajib: Tidak

 ** [StreamName](#API_DescribeEdgeConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-request-StreamName"></a>
Nama aliran yang konfigurasi tepinya ingin Anda perbarui. Tentukan salah satu `StreamName` atau`StreamARN`.   
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Pola: `[a-zA-Z0-9_.-]+`   
Diperlukan: Tidak

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

## Elemen Respons
<a name="API_DescribeEdgeConfiguration_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [CreationTime](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-CreationTime"></a>
Stempel waktu di mana konfigurasi tepi aliran pertama kali dibuat.  
Tipe: Timestamp

 ** [EdgeAgentStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-EdgeAgentStatus"></a>
Objek yang berisi detail status terbaru untuk perekam dan pekerjaan pengunggah agen edge. Gunakan informasi ini untuk menentukan kesehatan agen edge saat ini.  
Tipe: Objek [EdgeAgentStatus](API_EdgeAgentStatus.md)

 ** [EdgeConfig](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-EdgeConfig"></a>
Deskripsi konfigurasi tepi aliran yang akan digunakan untuk menyinkronkan dengan komponen Edge Agent IoT Greengrass. Komponen Edge Agent akan berjalan pada pengaturan Perangkat IoT Hub di premis Anda.  
Tipe: Objek [EdgeConfig](API_EdgeConfig.md)

 ** [FailedStatusDetails](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-FailedStatusDetails"></a>
Deskripsi status kegagalan yang dihasilkan.  
Tipe: String

 ** [LastUpdatedTime](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-LastUpdatedTime"></a>
Stempel waktu di mana konfigurasi tepi aliran terakhir diperbarui.  
Tipe: Timestamp

 ** [StreamARN](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-StreamARN"></a>
Nama Sumber Daya Amazon (ARN) dari aliran.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 1024.  
Pola: `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>
Nama aliran dari mana konfigurasi tepi diperbarui.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Pola: `[a-zA-Z0-9_.-]+` 

 ** [SyncStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-SyncStatus"></a>
Status terbaru dari pembaruan konfigurasi tepi.  
Tipe: String  
Nilai yang Valid: `SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED` 

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

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Jenis Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Anda tidak memiliki izin yang diperlukan untuk melakukan operasi ini.  
Kode Status HTTP: 401

 ** ClientLimitExceededException **   
Kinesis Video Streams telah membatasi permintaan karena Anda telah melampaui batas panggilan klien yang diizinkan. Coba buat panggilan nanti.  
Kode Status HTTP: 400

 ** InvalidArgumentException **   
Nilai untuk parameter input ini tidak valid.  
Kode Status HTTP: 400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams tidak dapat menemukan aliran yang Anda tentukan.  
Kode Status HTTP: 404

 ** StreamEdgeConfigurationNotFoundException **   
Pengecualian yang dirender saat Amazon Kinesis Video Stream tidak dapat menemukan konfigurasi tepi aliran yang Anda tentukan.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_DescribeEdgeConfiguration_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah 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 untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS SDK para 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 untuk 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)