翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
StartEdgeConfigurationUpdate
ストリームの既存のエッジ設定を更新する非同期 API。Kinesis ビデオストリームは、ストリームのエッジ構成を、オンプレミスで設定された IoT Hub デバイス上で動作する Edge Agent IoT Greengrass コンポーネントと同期します。同期にかかる時間は、ハブデバイスの接続状況によって異なる場合があります。SyncStatus
エッジ構成が確認され、Edge Agent と同期されると更新されます。
この API を初めて呼び出すと、ストリーム用に新しいエッジ設定が作成され、同期ステータスはに設定されます。SYNCING
この API を再度使用する前に、同期ステータスが:IN_SYNC
SYNC_FAILED
、またはなどの端末状態になるまで待つ必要があります。同期処理中にこの API を呼び出すと、ResourceInUseException
がスローされます。ストリームのエッジ設定と Edge Agent の接続は 15 分間再試行されます。15 分後、SYNC_FAILED
ステータスはその状態に移行します。
エッジ構成をあるデバイスから別のデバイスに移動するには、DeleteEdgeConfigurationを使用して現在のエッジ構成を削除します。その後、更新されたハブデバイス ARN StartEdgeConfigurationUpdate で呼び出すことができます。
注記
この API AWS はアフリカ (ケープタウン) リージョン af-south-1 ではご利用いただけません。
リクエストの構文
POST /startEdgeConfigurationUpdate HTTP/1.1
Content-type: application/json
{
"EdgeConfig": {
"DeletionConfig": {
"DeleteAfterUpload": boolean
,
"EdgeRetentionInHours": number
,
"LocalSizeConfig": {
"MaxLocalMediaSizeInMB": number
,
"StrategyOnFullSize": "string
"
}
},
"HubDeviceArn": "string
",
"RecorderConfig": {
"MediaSourceConfig": {
"MediaUriSecretArn": "string
",
"MediaUriType": "string
"
},
"ScheduleConfig": {
"DurationInSeconds": number
,
"ScheduleExpression": "string
"
}
},
"UploaderConfig": {
"ScheduleConfig": {
"DurationInSeconds": number
,
"ScheduleExpression": "string
"
}
}
},
"StreamARN": "string
",
"StreamName": "string
"
}
URI リクエストパラメータ
リクエストでは URI パラメータを使用しません。
リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
- EdgeConfig
-
更新プロセスを呼び出すために必要なエッジ設定の詳細。
型: EdgeConfig オブジェクト
必須: はい
- 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 です。
パターン:
[a-zA-Z0-9_.-]+
必須: いいえ
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"EdgeConfig": {
"DeletionConfig": {
"DeleteAfterUpload": boolean,
"EdgeRetentionInHours": number,
"LocalSizeConfig": {
"MaxLocalMediaSizeInMB": number,
"StrategyOnFullSize": "string"
}
},
"HubDeviceArn": "string",
"RecorderConfig": {
"MediaSourceConfig": {
"MediaUriSecretArn": "string",
"MediaUriType": "string"
},
"ScheduleConfig": {
"DurationInSeconds": number,
"ScheduleExpression": "string"
}
},
"UploaderConfig": {
"ScheduleConfig": {
"DurationInSeconds": number,
"ScheduleExpression": "string"
}
}
},
"FailedStatusDetails": "string",
"LastUpdatedTime": number,
"StreamARN": "string",
"StreamName": "string",
"SyncStatus": "string"
}
レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- CreationTime
-
ストリームのエッジ構成が最初に作成されたタイムスタンプ。
型: タイムスタンプ
- EdgeConfig
-
Edge Agent IoT Greengrass コンポーネントとの同期に使用されるストリームのエッジ構成の説明。Edge Agent コンポーネントは、オンプレミスの IoT Hub デバイスセットアップで実行されます。
タイプ:EdgeConfig オブジェクト
- FailedStatusDetails
-
生成された障害ステータスの説明。
型: 文字列
- LastUpdatedTime
-
ストリームのエッジ構成が最後に更新されたタイムスタンプ。
型: タイムスタンプ
- StreamARN
-
ストリームの Amazon リソースネーム (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_.-]+
- SyncStatus
-
ストリームのエッジ構成の現在の同期ステータス。この API を呼び出すと、
SYNCING
同期ステータスはその状態に設定されます。DescribeEdgeConfiguration
API を使用してエッジ構成の最新のステータスを取得します。型: 文字列
有効な値:
SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- AccessDeniedException
-
この操作を実行するために必要なアクセス許可がありません。
HTTP ステータスコード: 401
- ClientLimitExceededException
-
Kinesis Video Streams は、許可されたクライアントコールの制限を超えているため、リクエストをスロットリングしました。後で呼び出しを試みてください。
HTTP ステータスコード:400
- InvalidArgumentException
-
この入力パラメータの値は無効です。
HTTP ステータスコード:400
- NoDataRetentionException
-
Stream データの保持時間 (時間単位) はゼロです。
HTTP ステータスコード:400
- ResourceInUseException
-
StreamARN
ChannelARN
CLOUD_STORAGE_MODE
入力または入力が既に別の Kinesis Video Stream リソースにマッピングされている場合、StreamARN
ChannelARN
または提供された入力がアクティブステータスでない場合は、次のいずれかを試してください。-
DescribeMediaStorageConfiguration
API は、特定のチャンネルがどのストリームにマップされているかを判断します。 -
特定のストリームがマップされているチャンネルを決定するための
DescribeMappedResourceConfiguration
API。 -
DescribeStream
またはDescribeSignalingChannel
API を使用してリソースのステータスを判断します。
HTTP ステータスコード:400
-
- ResourceNotFoundException
-
Amazon Kinesis Video Streams は、指定したストリームを見つけることができません。
HTTP ステータスコード: 404
その他の参照資料
この API を言語固有の AWS SDK で使用する方法について詳しくは、以下を参照してください。