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

DescribeImageGenerationConfiguration

Mendapat ImageGenerationConfiguration aliran video Kinesis tertentu.

Minta Sintaks

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

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

Parameter Permintaan URI

Permintaan tidak menggunakan parameter URI apa pun.

Isi Permintaan

Permintaan menerima data berikut dalam format JSON.

StreamARN

Nama Sumber Daya Amazon (ARN) dari aliran video Kinesis untuk mengambil konfigurasi pembuatan gambar. Anda harus menentukan salah satu StreamName atauStreamARN.

Jenis: 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

Nama aliran dari mana untuk mengambil konfigurasi pembuatan gambar. Anda harus menentukan salah satu StreamName atauStreamARN.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.

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

Diperlukan: Tidak

Sintaksis Respons

HTTP/1.1 200
Content-type: application/json

{
   "ImageGenerationConfiguration": { 
      "DestinationConfig": { 
         "DestinationRegion": "string",
         "Uri": "string"
      },
      "Format": "string",
      "FormatConfig": { 
         "string" : "string" 
      },
      "HeightPixels": number,
      "ImageSelectorType": "string",
      "SamplingInterval": number,
      "Status": "string",
      "WidthPixels": number
   }
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

ImageGenerationConfiguration

Struktur yang berisi informasi yang diperlukan untuk pengiriman gambar Kinesis video stream (KVS). Jika struktur ini nol, konfigurasi akan dihapus dari aliran.

Tipe: Objek ImageGenerationConfiguration

Kesalahan

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

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

Lihat Juga

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