本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # GetImages 影像的受管支援提供一種完全受管的方式，從 Kinesis Video Streams 中串流和存放的影片資料取得影像。您可以使用映像來執行機器學習 (ML) 工作負載，例如人員、寵物或車輛偵測。影像也可以用來新增要播放的互動式元素，例如動作事件的影像預覽和影片剪輯的清除。 GetImages 也會擷取與指定時間範圍、取樣間隔和影像格式組態的每個時間戳記對應的影像清單。 **注意** 您必須先呼叫 `GetDataEndpoint` API 才能取得端點。然後使用 [--endpoint-url 參數](https://docs.aws.amazon.com/cli/latest/reference/)將`GetImages`請求傳送至此端點。 [影片播放軌跡需求](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html)。 ## 請求語法 ``` 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}} } ``` ## URI 請求參數請求不會使用任何 URI 參數。 ## 請求主體請求接受採用 JSON 格式的下列資料。 ** [EndTimestamp](#API_reader_GetImages_RequestSyntax) ** 要產生之影像範圍的結束時間戳記。如果 `StartTimestamp`和 `EndTimestamp` 之間的時間範圍超過 300 秒`StartTimestamp`，您將會收到 `IllegalArgumentException`。類型：Timestamp 必要：是 ** [Format](#API_reader_GetImages_RequestSyntax) ** 用來編碼影像的格式。類型：字串有效值:`JPEG | PNG` 必要：是 ** [FormatConfig](#API_reader_GetImages_RequestSyntax) ** 金鑰值對結構的清單，其中包含可在產生映像時套用的額外參數。`FormatConfig` 金鑰是 `JPEGQuality`，表示要用來產生映像的 JPEG 品質金鑰。此`FormatConfig`值接受從 1 到 100 的整數。如果值為 1，則會以較低的品質和最佳的壓縮產生影像。如果值為 100，則會產生具有最佳品質且壓縮較少的影像。如果未提供任何值，`JPEGQuality`則金鑰的預設值會設為 80。類型：字串到字串映射映射項目：最多 1 個項目。有效金鑰：`JPEGQuality` 值長度限制：長度下限為 0。長度上限為 256。值模式：`^[a-zA-Z_0-9]+` 必要：否 ** [HeightPixels](#API_reader_GetImages_RequestSyntax) ** 與 `WidthPixels` 參數搭配使用的輸出映像高度。同時提供 `HeightPixels`和 `WidthPixels` 參數時，影像會延伸以符合指定的長寬比。如果只提供 `HeightPixels` 參數，則會使用其原始長寬比來計算`WidthPixels`比率。如果未提供參數，則會傳回原始影像大小。類型：整數有效範圍：最小值為 1。最大值為 2160。必要：否 ** [ImageSelectorType](#API_reader_GetImages_RequestSyntax) ** 用於產生映像的伺服器或生產者時間戳記來源。類型：字串有效值:`PRODUCER_TIMESTAMP | SERVER_TIMESTAMP` 必要：是 ** [MaxResults](#API_reader_GetImages_RequestSyntax) ** API 要傳回的影像數量上限。預設限制為每個 API 回應 25 個映像。提供`MaxResults`大於此值會導致頁面大小為 25。任何其他結果都會進行分頁。類型：Long 有效範圍：最小值為 1。最大值為 100。必要：否 ** [NextToken](#API_reader_GetImages_RequestSyntax) ** 指定在何處開始分頁下一組影像的權杖。這是先前截斷的回應`GetImages:NextToken`中的。類型：字串長度限制：長度下限為 1。長度上限為 4096。模式：`[a-zA-Z0-9+/]+={0,2}` 必要：否 ** [SamplingInterval](#API_reader_GetImages_RequestSyntax) ** 需要從串流產生影像的時間間隔，以毫秒 (ms) 為單位。可以提供的最小值為 200 毫秒（每秒 5 張影像）。如果時間戳記範圍小於取樣間隔，`startTimestamp`則會在可用時傳回來自的映像。類型：整數必要：否 ** [StartTimestamp](#API_reader_GetImages_RequestSyntax) ** 應產生影像的起點。這`StartTimestamp`必須在要傳回影像的時間戳記包含範圍內。類型：Timestamp 必要：是 ** [StreamARN](#API_reader_GetImages_RequestSyntax) ** 要從中擷取映像之串流的 Amazon Resource Name (ARN)。您必須指定 `StreamName`或 `StreamARN`。類型：字串長度限制：長度下限為 1。長度上限為 1024。模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` 必要：否 ** [StreamName](#API_reader_GetImages_RequestSyntax) ** 要從中擷取影像的串流名稱。您必須指定 `StreamName`或 `StreamARN`。類型：字串長度限制：長度下限為 1。長度上限為 256。模式：`[a-zA-Z0-9_.-]+` 必要：否 ** [WidthPixels](#API_reader_GetImages_RequestSyntax) ** 與 `HeightPixels` 參數搭配使用的輸出映像寬度。同時提供 `WidthPixels`和 `HeightPixels` 參數時，影像會延伸以符合指定的長寬比。如果只提供 `WidthPixels` 參數，或只`HeightPixels`提供，`ValidationException`則會擲出。如果未提供參數，則會傳回串流的原始影像大小。類型：整數有效範圍：最小值為 1。最大值為 3840。必要：否 ## 回應語法 ``` HTTP/1.1 200 Content-type: application/json { "Images": [ { "Error": "string", "ImageContent": "string", "TimeStamp": number } ], "NextToken": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [Images](#API_reader_GetImages_ResponseSyntax) ** 從視訊串流產生的映像清單。如果指定的時間戳記沒有可用的媒體，則會在輸出中列出`NO_MEDIA`錯誤。如果在產生映像時發生錯誤， `MEDIA_ERROR` 會在輸出中列出為遺失映像的原因。類型：[Image](API_reader_Image.md) 物件陣列 ** [NextToken](#API_reader_GetImages_ResponseSyntax) ** 請求中用於取得更多映像的加密字符。類型：字串長度限制：長度下限為 1。長度上限為 4096。模式：`[a-zA-Z0-9+/]+={0,2}` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。 ** ClientLimitExceededException ** Kinesis Video Streams 已調節請求，因為您已超過限制。稍後嘗試進行呼叫。如需限制的相關資訊，請參閱 [Kinesis Video Streams 配額](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html)。 HTTP 狀態碼：400 ** InvalidArgumentException ** 指定的參數超過其限制、不支援或無法使用。 HTTP 狀態碼：400 ** NoDataRetentionException ** `GetImages` 請求的串流不會保留資料（也就是的 `DataRetentionInHours`為 0)。 HTTP 狀態碼：400 ** NotAuthorizedException ** 狀態碼：403，呼叫者無權在指定的串流上執行操作，或權杖已過期。 HTTP 狀態碼：401 ** ResourceNotFoundException ** `GetImages` 當 Kinesis Video Streams 找不到您指定的串流時，會擲回此錯誤。 `GetHLSStreamingSessionURL` 如果`LIVE_REPLAY`請求具有 `ON_DEMAND`或 `PlaybackMode`的工作階段的串流在請求的時間範圍內沒有片段，或者請求具有 `PlaybackMode` 的工作階段的串流在過去 30 秒內沒有片段，`LIVE`則`GetDASHStreamingSessionURL`擲回此錯誤。 HTTP 狀態碼：404 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS 適用於 C\+\+ 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/GetImages)