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

# GetImages
<a name="API_reader_GetImages"></a>

Dukungan terkelola untuk gambar menyediakan cara yang dikelola sepenuhnya untuk mendapatkan gambar dari data video yang dialirkan dan disimpan di Kinesis Video Streams. Anda dapat menggunakan gambar untuk menjalankan beban kerja machine learning (ML) seperti deteksi orang, hewan peliharaan, atau kendaraan. Gambar juga dapat digunakan untuk menambahkan elemen interaktif ke pemutaran, seperti pratinjau gambar untuk acara gerak dan menggosok untuk klip video. 

GetImages juga mengambil daftar gambar yang sesuai dengan setiap stempel waktu untuk rentang waktu tertentu, interval pengambilan sampel, dan konfigurasi format gambar.

**catatan**  
Anda harus terlebih dahulu memanggil `GetDataEndpoint` API untuk mendapatkan titik akhir. Kemudian kirim `GetImages` permintaan ke titik akhir ini menggunakan parameter [--endpoint-url](https://docs.aws.amazon.com/cli/latest/reference/). 

 [Persyaratan trek pemutaran video](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html).

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

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

{
   "EndTimestamp": number,
   "Format": "string",
   "FormatConfig": { 
      "string" : "string" 
   },
   "HeightPixels": number,
   "ImageSelectorType": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SamplingInterval": number,
   "StartTimestamp": number,
   "StreamARN": "string",
   "StreamName": "string",
   "WidthPixels": number
}
```

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

Permintaan tidak menggunakan parameter URI apa pun.

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

Permintaan menerima data berikut dalam format JSON.

 ** [EndTimestamp](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-EndTimestamp"></a>
Stempel waktu akhir untuk rentang gambar yang akan dihasilkan. Jika rentang waktu antara `StartTimestamp` dan `EndTimestamp` lebih dari 300 detik di atas`StartTimestamp`, Anda akan menerima`IllegalArgumentException`.  
Tipe: Timestamp  
Wajib: Ya

 ** [Format](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-Format"></a>
Format yang akan digunakan untuk menyandikan gambar.  
Tipe: String  
Nilai yang Valid: `JPEG | PNG`   
Wajib: Ya

 ** [FormatConfig](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-FormatConfig"></a>
Daftar struktur pasangan kunci-nilai yang berisi parameter tambahan yang dapat diterapkan saat gambar dihasilkan. `FormatConfig`Kuncinya adalah`JPEGQuality`, yang menunjukkan kunci kualitas JPEG yang akan digunakan untuk menghasilkan gambar. `FormatConfig`Nilai menerima int dari 1 hingga 100. Jika nilainya 1, gambar akan dihasilkan dengan kualitas kurang dan kompresi terbaik. Jika nilainya 100, gambar akan dihasilkan dengan kualitas terbaik dan kompresi yang lebih sedikit. Jika tidak ada nilai yang diberikan, nilai default `JPEGQuality` kunci akan diatur ke 80.  
Tipe: Peta string ke string  
Entri Peta: Jumlah maksimum 1 item.  
Kunci yang valid: `JPEGQuality`   
Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.  
Pola nilai: `^[a-zA-Z_0-9]+`   
Wajib: Tidak

 ** [HeightPixels](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-HeightPixels"></a>
Ketinggian gambar output yang digunakan bersamaan dengan `WidthPixels` parameter. Ketika keduanya `HeightPixels` dan `WidthPixels` parameter disediakan, gambar akan diregangkan agar sesuai dengan rasio aspek yang ditentukan. Jika hanya `HeightPixels` parameter yang disediakan, rasio aspek aslinya akan digunakan untuk menghitung `WidthPixels` rasio. Jika tidak ada parameter yang disediakan, ukuran gambar asli akan dikembalikan.  
Tipe: Bilangan Bulat  
Rentang yang Valid: Nilai minimum 1. Nilai maksimum 2160.  
Wajib: Tidak

 ** [ImageSelectorType](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-ImageSelectorType"></a>
Asal usul stempel waktu Server atau Produser yang digunakan untuk menghasilkan gambar.  
Tipe: String  
Nilai yang Valid: `PRODUCER_TIMESTAMP | SERVER_TIMESTAMP`   
Wajib: Ya

 ** [MaxResults](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-MaxResults"></a>
Jumlah maksimum gambar yang akan dikembalikan oleh API.   
Batas defaultnya adalah 25 gambar per respons API. Memberikan nilai yang `MaxResults` lebih besar dari nilai ini akan menghasilkan ukuran halaman 25. Setiap hasil tambahan akan diberi paginasi. 
Tipe: Long  
Rentang yang Valid: Nilai minimum 1. Nilai maksimum 100.  
Wajib: Tidak

 ** [NextToken](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-NextToken"></a>
Token yang menentukan di mana harus memulai paginasi set Gambar berikutnya. Ini adalah `GetImages:NextToken` dari respons yang sebelumnya terpotong.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 4096.  
Pola: `[a-zA-Z0-9+/]+={0,2}`   
Wajib: Tidak

 ** [SamplingInterval](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-SamplingInterval"></a>
Interval waktu dalam milidetik (ms) di mana gambar perlu dihasilkan dari aliran. Nilai minimum yang dapat diberikan adalah 200 ms (5 gambar per detik). Jika rentang stempel waktu kurang dari interval pengambilan sampel, gambar dari `startTimestamp` akan dikembalikan jika tersedia.   
Tipe: Integer  
Wajib: Tidak

 ** [StartTimestamp](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-StartTimestamp"></a>
Titik awal dari mana gambar harus dihasilkan. Ini `StartTimestamp` harus berada dalam rentang waktu yang inklusif agar gambar dikembalikan.  
Tipe: Timestamp  
Wajib: Ya

 ** [StreamARN](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-StreamARN"></a>
Nama Sumber Daya Amazon (ARN) dari aliran untuk mengambil gambar. Anda harus menentukan 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_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-StreamName"></a>
Nama aliran dari mana untuk mengambil gambar. Anda harus menentukan salah satu `StreamName` atau`StreamARN`.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Pola: `[a-zA-Z0-9_.-]+`   
Wajib: Tidak

 ** [WidthPixels](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-WidthPixels"></a>
Lebar gambar output yang digunakan bersamaan dengan `HeightPixels` parameter. Ketika keduanya `WidthPixels` dan `HeightPixels` parameter disediakan, gambar akan diregangkan agar sesuai dengan rasio aspek yang ditentukan. Jika hanya `WidthPixels` parameter yang disediakan atau jika hanya `HeightPixels` disediakan, a `ValidationException` akan dilemparkan. Jika tidak ada parameter yang disediakan, ukuran gambar asli dari aliran akan dikembalikan.  
Tipe: Bilangan Bulat  
Rentang yang Valid: Nilai minimum 1. Nilai maksimum 3840.  
Wajib: Tidak

## Sintaksis Respons
<a name="API_reader_GetImages_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Images": [ 
      { 
         "Error": "string",
         "ImageContent": "string",
         "TimeStamp": number
      }
   ],
   "NextToken": "string"
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [Images](#API_reader_GetImages_ResponseSyntax) **   <a name="KinesisVideo-reader_GetImages-response-Images"></a>
Daftar gambar yang dihasilkan dari aliran video. Jika tidak ada media yang tersedia untuk stempel waktu yang diberikan, `NO_MEDIA` kesalahan akan tercantum dalam output. Jika terjadi kesalahan saat gambar sedang dihasilkan, `MEDIA_ERROR` akan tercantum dalam output sebagai penyebab gambar yang hilang.   
Tipe: Array objek [Image](API_reader_Image.md)

 ** [NextToken](#API_reader_GetImages_ResponseSyntax) **   <a name="KinesisVideo-reader_GetImages-response-NextToken"></a>
Token terenkripsi yang digunakan dalam permintaan untuk mendapatkan lebih banyak gambar.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 4096.  
Pola: `[a-zA-Z0-9+/]+={0,2}` 

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

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

 ** ClientLimitExceededException **   
Kinesis Video Streams telah membatasi permintaan karena Anda telah melampaui batas. Coba buat panggilan nanti. Untuk informasi tentang batasan, lihat Kuota [Kinesis Video Streams](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).  
Kode Status HTTP: 400

 ** InvalidArgumentException **   
Parameter yang ditentukan melebihi batasannya, tidak didukung, atau tidak dapat digunakan.  
Kode Status HTTP: 400

 ** NoDataRetentionException **   
 `GetImages`diminta untuk aliran yang tidak menyimpan data (yaitu, memiliki `DataRetentionInHours` 0).   
Kode Status HTTP: 400

 ** NotAuthorizedException **   
Kode Status: 403, Penelepon tidak berwenang untuk melakukan operasi pada aliran yang diberikan, atau token telah kedaluwarsa.  
Kode Status HTTP: 401

 ** ResourceNotFoundException **   
 `GetImages`akan memunculkan kesalahan ini ketika Kinesis Video Streams tidak dapat menemukan aliran yang Anda tentukan.  
 `GetHLSStreamingSessionURL`dan `GetDASHStreamingSessionURL` membuang kesalahan ini jika sesi dengan `PlaybackMode` dari `ON_DEMAND` atau `LIVE_REPLAY` diminta untuk aliran yang tidak memiliki fragmen dalam rentang waktu yang diminta, atau jika sesi dengan `PlaybackMode` of `LIVE` diminta untuk aliran yang tidak memiliki fragmen dalam 30 detik terakhir.  
Kode Status HTTP: 404

## Lihat Juga
<a name="API_reader_GetImages_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/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/GetImages)