本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
DescribeImageGenerationConfiguration
取得指ImageGenerationConfiguration
定 Kinesis 視訊串流的。
請求語法
POST /describeImageGenerationConfiguration HTTP/1.1
Content-type: application/json
{
"StreamARN": "string
",
"StreamName": "string
"
}
URI 請求參數
請求不會使用任何 URI 參數。
請求主體
請求接受採用 JSON 格式的下列資料。
- StreamARN
-
Kinesis 影片串流的 Amazon 資源名稱 (ARN),可從中擷取映像產生組態。您必須指定
StreamName
或StreamARN
。類型:字串
長度限制:長度下限為 1。長度上限為 1024。
模式:
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
{
"ImageGenerationConfiguration": {
"DestinationConfig": {
"DestinationRegion": "string",
"Uri": "string"
},
"Format": "string",
"FormatConfig": {
"string" : "string"
},
"HeightPixels": number,
"ImageSelectorType": "string",
"SamplingInterval": number,
"Status": "string",
"WidthPixels": number
}
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- ImageGenerationConfiguration
-
包含 Kinesis 視訊串流 (KVS) 影像傳送所需資訊的結構。如果此結構為 null,則配置將從流中刪除。
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- AccessDeniedException
-
您沒有執行此作業所需的權限。
狀態碼:4
- ClientLimitExceededException
-
Kinesis Video Streams 已限制要求,因為您已經超過允許的用戶端呼叫限制。稍後再嘗試撥打電話。
HTTP 狀態碼:400
- InvalidArgumentException
-
此輸入參數的值無效。
HTTP 狀態碼:400
- ResourceNotFoundException
-
Amazon Kinesis Video Streams 找不到您指定的串流。
HTTP 狀態碼:404
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: