ListEdgeAgentConfigurations - Amazon Kinesis Video Streams
Minta SintaksParameter Permintaan URIIsi PermintaanSintaksis ResponsElemen ResponsKesalahanLihat Juga

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

ListEdgeAgentConfigurations

Mengembalikan array konfigurasi tepi terkait dengan Edge Agent tertentu.

Dalam permintaan, Anda harus menentukan Agen EdgeHubDeviceArn.

catatan

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

Minta Sintaks

POST /listEdgeAgentConfigurations HTTP/1.1
Content-type: application/json

{
   "HubDeviceArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}

Parameter Permintaan URI

Permintaan tidak menggunakan parameter URI apa pun.

Isi Permintaan

Permintaan menerima data berikut dalam format JSON.

HubDeviceArn

“Internet of Things (IoT) Thing” Arn dari agen tepi.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 1024.

Pola: arn:[a-z\d-]+:iot:[a-z0-9-]+:[0-9]+:thing/[a-zA-Z0-9_.-]+

Wajib: Ya

MaxResults

Jumlah maksimum konfigurasi tepi untuk kembali dalam respons. Default-nya adalah 5.

Jenis: Integer

Rentang yang Valid: Nilai minimum 1. Nilai maksimum 10.

Wajib: Tidak

NextToken

Jika Anda menentukan parameter ini, ketika hasil ListEdgeAgentConfigurations operasi terpotong, panggilan mengembalikan respon. NextToken Untuk mendapatkan kumpulan konfigurasi edge lainnya, berikan token ini di permintaan Anda berikutnya.

Jenis: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 512.

Pola: [a-zA-Z0-9+/=]*

Diperlukan: Tidak

Sintaksis Respons

HTTP/1.1 200
Content-type: application/json

{
   "EdgeConfigs": [ 
      { 
         "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"
      }
   ],
   "NextToken": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

EdgeConfigs

Deskripsi konfigurasi tepi aliran tunggal.

Tipe: Array objek ListEdgeAgentConfigurationsEdgeConfig

NextToken

Jika respon terpotong, panggilan mengembalikan elemen ini dengan token yang diberikan. Untuk mendapatkan kumpulan konfigurasi edge berikutnya, gunakan token ini dalam permintaan Anda berikutnya.

Jenis: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 512.

Pola: [a-zA-Z0-9+/=]*

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

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

NotAuthorizedException

Penelepon tidak berwenang untuk melakukan operasi ini.

Kode Status HTTP: 401

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: