リクエストの構文 URI リクエストパラメータリクエスト本文レスポンスの構文レスポンス要素エラー以下の資料も参照してください。

GetImages

イメージのマネージドサポートは、Kinesis Video Streams にストリーミングおよび保存されているビデオデータからイメージを取得するためのフルマネージド型の方法を提供します。イメージを使用して、人、ペット、車両検出などの機械学習 (ML) ワークロードを実行できます。イメージは、モーションイベントのイメージプレビューやビデオクリップのスクラブなど、再生にインタラクティブな要素を追加するためにも使用できます。

GetImages は、特定の時間範囲、サンプリング間隔、およびイメージ形式設定の各タイムスタンプに対応するイメージのリストも取得します。

注記

エンドポイントを取得するには、まず GetDataEndpointAPIを呼び出す必要があります。次に、--endpoint-url parameter を使用して GetImages リクエストをこのエンドポイントに送信します。

動画再生トラックの要件。

リクエストの構文


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

生成される画像の範囲の終了タイムスタンプ。からまでの時間範囲EndTimestampがの 300 秒を超えるStartTimestampとStartTimestamp、を受け取りますIllegalArgumentException。

型: タイムスタンプ

必須：はい

Format

イメージのエンコードに使用される形式。

型: 文字列

有効な値: JPEG | PNG

必須：はい

FormatConfig

イメージの生成時に適用できる追加のパラメータを含むキーと値のペア構造のリスト。FormatConfig キーはでJPEGQuality、イメージの生成に使用されるJPEG品質キーを示します。FormatConfig 値は 1 から 100 までの Ints を受け入れます。値が 1 の場合、イメージは品質が低く、最適な圧縮で生成されます。値が 100 の場合、イメージは最高品質の圧縮率で生成されます。値を指定しない場合、JPEGQualityキーのデフォルト値は 80 に設定されます。

型: 文字列間のマッピング

マップエントリ: アイテムの最大数は 1 です。

有効なキー: JPEGQuality

値の長さの制限: 最小長は 0 です。最大長は 256 です。

値のパターン: ^[a-zA-Z_0-9]+

必須：いいえ

HeightPixels

WidthPixels パラメータと組み合わせて使用される出力イメージの高さ。パラメータHeightPixelsと WidthPixelsパラメータの両方を指定すると、指定したアスペクト比に合わせて画像が引き伸ばされます。HeightPixels パラメータのみを指定すると、元のアスペクト比を使用してWidthPixels比率が計算されます。どちらのパラメータも指定しない場合、元のイメージサイズが返されます。

型: 整数

有効範囲: 最小値は 1 です。最大値は 2160 です。

必須：いいえ

ImageSelectorType

イメージの生成に使用するサーバーまたはプロデューサーのタイムスタンプのオリジン。

型: 文字列

有効な値: PRODUCER_TIMESTAMP | SERVER_TIMESTAMP

必須：はい

MaxResults

によって返されるイメージの最大数API。

注記

デフォルトの制限は、APIレスポンスあたり 25 個のイメージです。この値MaxResultsより大きい値を指定すると、ページサイズは 25 になります。追加の結果はページ分割されます。

型: 長整数

有効範囲: 最小値は 1 です。最大値は 100 です。

必須：いいえ

NextToken

次の画像セットのページ分割を開始する場所を指定するトークン。これは、以前に切り捨てられたレスポンスGetImages:NextTokenからのです。

型: 文字列

長さの制限：最小長は 1 です。最大長は 4,096 です。

パターン: [a-zA-Z0-9+/]+={0,2}

必須: いいえ

SamplingInterval

ストリームからイメージを生成する必要があるミリ秒 (ms) 単位の時間間隔。指定できる最小値は 200 ミリ秒 (1 秒あたり 5 イメージ) です。タイムスタンプの範囲がサンプリング間隔より小さい場合、使用可能な場合はからのイメージが返されstartTimestampます。

型: 整数

必須：はい

StartTimestamp

イメージを生成する開始点。イメージを返すStartTimestampには、これはタイムスタンプの包括的な範囲内である必要があります。

型: タイムスタンプ

必須：はい

StreamARN

イメージを取得するストリームの 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

イメージを取得するストリームの名前。StreamName または StreamARN のパラメータを指定する必要があります。

型: 文字列

長さの制限：最小長は 1 です。最大長は 256 です。

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

必須: いいえ

WidthPixels

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"
}

レスポンス要素

アクションが成功すると、サービスは 200 HTTP レスポンスを返します。

次のデータは、サービスによって JSON 形式で返されます。

Images

ビデオストリームから生成されたイメージのリスト。指定されたタイムスタンプに使用できるメディアがない場合、NO_MEDIAエラーが出力に表示されます。イメージの生成中にエラーが発生すると、 MEDIA_ERROR は欠落したイメージの原因として出力に表示されます。

型: Image オブジェクトの配列

NextToken

より多くのイメージを取得するためにリクエストで使用された暗号化されたトークン。

型: 文字列

長さの制限：最小長は 1 です。最大長は 4,096 です。

パターン: [a-zA-Z0-9+/]+={0,2}

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

ClientLimitExceededException

制限を超えたため、Kinesis Video Streams がリクエストをスロットリングしました。後で呼び出しを試みてください。制限の詳細については、「Kinesis Video Streams のクォータ」を参照してください。

HTTP ステータスコード: 400

InvalidArgumentException

指定されたパラメータが制限を超えているか、サポートされていない、または使用できません。

HTTP ステータスコード: 400

NotAuthorizedException

ステータスコード: 403 呼び出し元が指定されたストリームで操作を実行する権限がないか、トークンの有効期限が切れています。

HTTP ステータスコード: 401

ResourceNotFoundException

GetImages は、指定したストリームが Kinesis Video Streams で見つからない場合に、このエラーをスローします。

GetHLSStreamingSessionURL リクエストされた時間範囲内にフラグメントがないストリームに対して ON_DEMANDまたは PlaybackModeのセッションLIVE_REPLAYがリクエストされた場合、または過去 30 秒以内にフラグメントがないストリームに対して PlaybackModeのセッションLIVEがリクエストされた場合、とはこのエラーをGetDASHStreamingSessionURLスローします。

HTTP ステータスコード: 404

以下の資料も参照してください。

言語固有ののいずれかAPIでこれを使用する方法の詳細については AWS SDKs、以下を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

GetHLSStreamingSessionURL

GetMediaForFragmentList