翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # GetImages イメージのマネージドサポートは、Kinesis Video Streams にストリーミングおよび保存されたビデオデータからイメージを取得するためのフルマネージド型の方法を提供します。イメージを使用して、人、ペット、車両検出などの機械学習 (ML) ワークロードを実行できます。イメージを使用して、モーションイベントのイメージプレビューやビデオクリップのスクラブなど、インタラクティブな要素を再生に追加することもできます。 GetImages は、特定の時間範囲、サンプリング間隔、およびイメージ形式設定の各タイムスタンプに対応するイメージのリストも取得します。 **注記** エンドポイントを取得するには、最初に `GetDataEndpoint` API を呼び出す必要があります。次に、[--endpoint-url parameter](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`。 タイプ: タイムスタンプ 必須: はい ** [Format](#API_reader_GetImages_RequestSyntax) ** イメージのエンコードに使用される形式。 型: 文字列 有効な値：`JPEG | PNG` 必須: はい ** [FormatConfig](#API_reader_GetImages_RequestSyntax) ** イメージの生成時に適用できる追加のパラメータを含むキーと値のペア構造のリスト。`FormatConfig` キーは で`JPEGQuality`、画像の生成に使用される JPEG 品質キーを示します。`FormatConfig` 値は 1～100 の Ints を受け入れます。値が 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 です。最大長は 4,096 です。 パターン: `[a-zA-Z0-9+/]+={0,2}` 必須: いいえ ** [SamplingInterval](#API_reader_GetImages_RequestSyntax) ** ストリームからイメージを生成する必要がある時間間隔 (ミリ秒）。指定できる最小値は 200 ミリ秒 (1 秒あたり 5 イメージ) です。タイムスタンプ範囲がサンプリング間隔より小さい場合、使用可能な場合は からのイメージが返され`startTimestamp`ます。 タイプ: 整数 必須: いいえ ** [StartTimestamp](#API_reader_GetImages_RequestSyntax) ** イメージを生成する開始点。これは、イメージを返すタイムスタンプの包括的な範囲内`StartTimestamp`である必要があります。 タイプ: タイムスタンプ 必須: はい ** [StreamARN](#API_reader_GetImages_RequestSyntax) ** イメージを取得するストリームの Amazon リソースネーム (ARN)。`StreamName` または `StreamARN` のパラメータを指定する必要があります。 タイプ: 文字列 長さの制限: 最小長は 1 です。最大長は 1,024 です。 パターン: `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 です。最大長は 4,096 です。 パターン: `[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` リクエストされた時間範囲内にフラグメントがないストリームに対して `ON_DEMAND`または `PlaybackMode`のセッション`LIVE_REPLAY`がリクエストされた場合、または過去 30 秒以内にフラグメントがないストリームに対して `PlaybackMode`のセッション`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 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 for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK for 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 for 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)