CreateStream - Amazon Kinesis Video Streams
請求語法URI 請求參數請求主體回應語法回應元素錯誤另請參閱

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

CreateStream

建立新的 Kinesis 影片串流。

當您建立新串流時，Kinesis Video Streams 會為其指派版本編號。當您變更串流的中繼資料時，Kinesis Video Streams 會更新版本。

CreateStream 是一種非同步操作。

如需有關服務運作方式的資訊，請參閱運作方式。

您必須具備 KinesisVideo:CreateStream 動作的許可。

請求語法

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

{
   "DataRetentionInHours": number,
   "DeviceName": "string",
   "KmsKeyId": "string",
   "MediaType": "string",
   "StreamName": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI 請求參數

請求不會使用任何URI參數。

請求主體

請求接受下列JSON格式的資料。

DataRetentionInHours

您想要在串流中保留資料的時數。Kinesis Video Streams 會將資料保留在與串流相關聯的資料存放區中。

預設值為 0，表示串流不會保留資料。最短為 1 小時。

當DataRetentionInHours值為 0 時，取用者仍然可以取用留在服務主機緩衝區中的片段，其保留時間限制為 5 分鐘，保留記憶體限制為 200 MB。達到任一限制時，片段會從緩衝區中移除。

類型：整數

有效範圍：最小值為 0。

必要：否

DeviceName

正在寫入串流的裝置名稱。

注意

在目前的實作中，Kinesis Video Streams 不會使用此名稱。

類型：字串

長度限制：長度下限為 1。長度上限為 128。

模式：[a-zA-Z0-9_.-]+

必要：否

KmsKeyId

您希望 Kinesis Video Streams 用來加密串流資料的 AWS Key Management Service （AWS KMS） 金鑰 ID。

如果未指定金鑰 ID，則會使用預設的 Kinesis Video 受管金鑰 （ AWS/kinesisvideo）。

如需詳細資訊，請參閱 DescribeKey。

類型：字串

長度限制：長度下限為 1。長度上限為 2048。

模式：.+

必要：否

MediaType

串流的媒體類型。串流的取用者可以在處理串流時使用此資訊。如需媒體類型的詳細資訊，請參閱媒體類型 。如果您選擇指定 MediaType，請參閱 準則的命名要求。

有效值範例包括 "video/h264" and "video/h264,audio/aac"。

此參數為選用；預設值為 null（或在 中為空JSON）。

類型：字串

長度限制：長度下限為 1。長度上限為 128。

模式：[\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*

必要：否

StreamName

您要建立之串流的名稱。

串流名稱是串流的識別符，而且每個帳戶和區域都必須是唯一的。

類型：字串

長度限制：長度下限為 1。長度上限為 256。

模式：[a-zA-Z0-9_.-]+

必要：是

Tags

要與指定串流建立關聯的標籤清單。每個標籤都是索引鍵值對 （該值為選用）。

類型：字串到字串映射

映射項目：最多 50 個項目。

索引鍵長度限制：長度下限為 1。長度上限為 128。

金鑰模式：^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

值長度限制：最小長度為 0。長度上限為 256。

值模式：[\p{L}\p{Z}\p{N}_.:/=+\-@]*

必要：否

回應語法

HTTP/1.1 200
Content-type: application/json

{
   "StreamARN": "string"
}

回應元素

如果動作成功，服務會傳回 200 HTTP 個回應。

服務會以 JSON 格式傳回下列資料。

StreamARN

串流的 Amazon Resource Name （ARN）。

類型：字串

長度限制：長度下限為 1。長度上限為 1024。

模式：arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

錯誤

如需所有動作常見錯誤的資訊，請參閱常見錯誤。

AccountStreamLimitExceededException

為帳戶建立的串流數目太高。

HTTP 狀態碼：400

ClientLimitExceededException

Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試撥打電話。

HTTP 狀態碼：400

DeviceStreamLimitExceededException

不實作。

HTTP 狀態碼：400

InvalidArgumentException

此輸入參數的值無效。

HTTP 狀態碼：400

InvalidDeviceException

不實作。

HTTP 狀態碼：400

ResourceInUseException

當輸入 StreamARN 或 ChannelARN 中的 CLOUD_STORAGE_MODE 已映射至不同的 Kinesis Video Stream 資源，或提供的輸入StreamARN或 ChannelARN 未處於作用中狀態時，請嘗試下列其中一個 ：

  1. DescribeMediaStorageConfiguration API 決定串流指定頻道所對應的項目。

  2. DescribeMappedResourceConfiguration API 決定指定串流對應的頻道。

  3. DescribeStream 或 DescribeSignalingChannel API 來判斷資源的狀態。

HTTP 狀態碼：400

TagsPerResourceExceededLimitException

您已超過可與資源建立關聯的標籤限制。Kinesis 影片串流最多可支援 50 個標籤。

HTTP 狀態碼：400

另請參閱

如需在其中一種語言特定 API中使用此功能的詳細資訊 AWS SDKs，請參閱下列內容：