ListFragments

アーカイブデータ内の指定したストリームとタイムスタンプ範囲から Fragment オブジェクトのリストを返します。

フラグメントのリストは、結果整合性があります。これは、フラグメントが保持されているという確認応答をプロデューサーが受信した場合でも、ListFragments へのリクエストから結果がすぐに返されない場合があることを意味します。ただし、結果は通常、1 秒未満で入手できます。

注記

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

重要

Kinesis Video Streams アーカイブメディア API を呼び出した後にエラーがスローされた場合、HTTP ステータスコードとレスポンス本文に加えて、次の情報が含まれます。

• x-amz-ErrorType HTTP ヘッダー — HTTP ステータスコードで提供されるものに加えて、より具体的なエラータイプが含まれます。

• x-amz-RequestIdHTTP ヘッダー — に問題を報告したい場合AWS、リクエスト ID を指定すると、サポートチームが問題をより正確に診断できます。

HTTP ErrorType ステータスコードとヘッダーはどちらも、エラーが再試行可能かどうか、どのような条件で再試行できるかをプログラムで判断できるほか、クライアントプログラマーが再試行を正常に実行するために実行する必要のあるアクションに関する情報も得られます。

詳細については、このトピックの下部にある[Errors] (エラー) セクションおよび「Common Errors」を参照してください。

リクエストの構文

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

{
   "FragmentSelector": { 
      "FragmentSelectorType": "string",
      "TimestampRange": { 
         "EndTimestamp": number,
         "StartTimestamp": number
      }
   },
   "MaxResults": number,
   "NextToken": "string",
   "StreamARN": "string",
   "StreamName": "string"
}

URI リクエストパラメータ

リクエストでは URI パラメータを使用しません。

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

FragmentSelector

返すフラグメントの範囲のタイムスタンプ範囲とタイムスタンプオリジンを記述します。

注記

これが必要なのは、が API NextToken に渡されない場合だけです。

タイプ：FragmentSelector オブジェクト

必須: いいえ

MaxResults

返すフラグメントの総数。使用可能なフラグメントの総数がmax-results、で指定された値よりも多い場合は、ページネーションを再開するために使用できる出力にListFragments:NextTokenが表示されます。

デフォルト値は 100 です。

型: 長整数

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

必須: いいえ

NextToken

ページ分割を始める場所を指定するトークン。これは、NextToken以前に切り捨てられたレスポンスのListFragments:です。

型: 文字列

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

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

必須: いいえ

StreamARN

フラグメントリストを取得するストリームの Amazon リソースネーム (ARN)。このパラメータ、または StreamName パラメータのいずれかを指定してください。

型: 文字列

長さの制限: 最小長は 1 です。最大長は 1,024 です。

パターン: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

必須: いいえ

StreamName

フラグメントリストを取得するストリームの名前。このパラメータ、または StreamARN パラメータのいずれかを指定してください。

型: 文字列

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

パターン：[a-zA-Z0-9_.-]+

必須: いいえ

レスポンスの構文

HTTP/1.1 200
Content-type: application/json

{
   "Fragments": [ 
      { 
         "FragmentLengthInMilliseconds": number,
         "FragmentNumber": "string",
         "FragmentSizeInBytes": number,
         "ProducerTimestamp": number,
         "ServerTimestamp": number
      }
   ],
   "NextToken": "string"
}

レスポンス要素

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

サービスから以下のデータが JSON 形式で返されます。

Fragments

セレクター基準を満たすストリームからのアーカイブされた Fragment オブジェクトのリスト。結果は、ページ間でも特定の順序ではありません。

セレクター条件を満たすフラグメントがストリームにない場合は、空のリストが返されます。

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

NextToken

返されたリストが切り捨てられた場合、操作はこのトークンを返します。これは次のページの結果を取得する上で使用します。返す結果がそれ以上存在しない場合、この値は null になります。

型: 文字列

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

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

エラー

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

ClientLimitExceededException

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

HTTP ステータスコード：400

InvalidArgumentException

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

HTTP ステータスコード：400

NotAuthorizedException

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

HTTP ステータスコード: 401

ResourceNotFoundException

GetImagesKinesis ビデオストリームが指定したストリームを見つけられない場合、このエラーが発生します。

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

HTTP ステータスコード: 404

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

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

• 「AWS コマンドラインインターフェイス」

• 「AWS SDK for .NET」

• 「AWS SDK for C++」

• AWS SDK for Go

• 「AWS SDK for Java V2」

• AWSV3 用 SDK JavaScript

• 「AWS SDK for PHP V3」

• 「AWS SDK for Python」

• 「AWS SDK for Ruby V3」