UpdateStream - Amazon Kinesis Video Streams
リクエストの構文URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラーその他の参照資料

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

UpdateStream

デバイス名やメディアタイプなどのストリームメタデータを更新します。

ストリーム名またはストリームの Amazon リソースネーム (ARN) を指定する必要があります。

ストリームを更新する前に最新バージョンであることを確保するために、ストリームのバージョンを指定できます。Kinesis Video Streams が各ストリームにバージョンを割り当てます。ストリームを更新すると、Kinesis Video Streams が新しいバージョン番号を割り当てます。最新のストリームバージョンを取得するには、DescribeStream APIを使用します

UpdateStream は非同期の操作で、完了するまでに時間がかかります。

リクエストの構文

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

{
   "CurrentVersion": "string",
   "DeviceName": "string",
   "MediaType": "string",
   "StreamARN": "string",
   "StreamName": "string"
}

URI リクエストパラメータ

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

リクエストボディ

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

CurrentVersion

メタデータを更新するストリームのバージョン。

型: 文字列

長さの制限：最小長は 1 です。最大長は 64 文字です。

パターン: [a-zA-Z0-9]+

必須：はい

DeviceName

ストリームに書き込んでいるデバイスの名前。

注記

現在の実装では、Kinesis Video Streams はこの名前を使用しません。

型: 文字列

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

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

必須: いいえ

MediaType

ストリームのメディアタイプ。MediaType を使用して、ストリームに含まれるコンテンツのタイプをストリームのコンシューマーに指定します。メディアタイプの詳細については、「メディアタイプ」を参照してください。MediaType を指定する場合は、「命名要件」を参照してください。

コンソールで動画を再生するには、正しい動画タイプを指定してください。例えば、ストリーム内のビデオが H.264 の場合は、MediaType として「video/h264」を指定します。

型: 文字列

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

Pattern: [\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*

必須: いいえ

StreamARN

メタデータを更新するストリームの ARN。

型: 文字列

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

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

必須: いいえ

StreamName

メタデータを更新するストリームの名前。

ストリーム名はストリームの識別子であり、アカウントやリージョンごとに一意である必要があります。

型: 文字列

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

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

必須: いいえ

レスポンスの構文

HTTP/1.1 200

レスポンス要素

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

エラー

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

ClientLimitExceededException

Kinesis Video Streams は、許可されたクライアントコールの制限を超えているため、リクエストをスロットリングしました。後で呼び出しを試みてください。

HTTP ステータスコード：400

InvalidArgumentException

この入力パラメータの値は無効です。

HTTP ステータスコード：400

NotAuthorizedException

呼び出し元には、この操作を実行するための権限がありません。

HTTP ステータスコード: 401

ResourceInUseException

StreamARNChannelARNCLOUD_STORAGE_MODE入力または入力が既に別の Kinesis Video Stream リソースにマッピングされている場合、StreamARNChannelARNまたは提供された入力がアクティブステータスでない場合は、次のいずれかを試してください。

  1. DescribeMediaStorageConfigurationAPI は、特定のチャンネルがどのストリームにマップされているかを判断します。

  2. 特定のストリームがマップされているチャンネルを決定するための DescribeMappedResourceConfiguration API。

  3. DescribeStreamまたは DescribeSignalingChannel API を使用してリソースのステータスを判断します。

HTTP ステータスコード：400

ResourceNotFoundException

Amazon Kinesis Video Streams は、指定したストリームを見つけることができません。

HTTP ステータスコード: 404

VersionMismatchException

指定したストリームバージョンは最新バージョンではありません。最新バージョンを入手するには DescribeStreamAPI を使用してください。

HTTP ステータスコード：400

その他の参照資料

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