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

# 動作
<a name="API_Operations"></a>

Amazon Kinesis Video Streams 支援下列動作：
+  [CreateSignalingChannel](API_CreateSignalingChannel.md) 
+  [CreateStream](API_CreateStream.md) 
+  [DeleteEdgeConfiguration](API_DeleteEdgeConfiguration.md) 
+  [DeleteSignalingChannel](API_DeleteSignalingChannel.md) 
+  [DeleteStream](API_DeleteStream.md) 
+  [DescribeEdgeConfiguration](API_DescribeEdgeConfiguration.md) 
+  [DescribeImageGenerationConfiguration](API_DescribeImageGenerationConfiguration.md) 
+  [DescribeMappedResourceConfiguration](API_DescribeMappedResourceConfiguration.md) 
+  [DescribeMediaStorageConfiguration](API_DescribeMediaStorageConfiguration.md) 
+  [DescribeNotificationConfiguration](API_DescribeNotificationConfiguration.md) 
+  [DescribeSignalingChannel](API_DescribeSignalingChannel.md) 
+  [DescribeStream](API_DescribeStream.md) 
+  [DescribeStreamStorageConfiguration](API_DescribeStreamStorageConfiguration.md) 
+  [GetDataEndpoint](API_GetDataEndpoint.md) 
+  [GetSignalingChannelEndpoint](API_GetSignalingChannelEndpoint.md) 
+  [ListEdgeAgentConfigurations](API_ListEdgeAgentConfigurations.md) 
+  [ListSignalingChannels](API_ListSignalingChannels.md) 
+  [ListStreams](API_ListStreams.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListTagsForStream](API_ListTagsForStream.md) 
+  [StartEdgeConfigurationUpdate](API_StartEdgeConfigurationUpdate.md) 
+  [TagResource](API_TagResource.md) 
+  [TagStream](API_TagStream.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UntagStream](API_UntagStream.md) 
+  [UpdateDataRetention](API_UpdateDataRetention.md) 
+  [UpdateImageGenerationConfiguration](API_UpdateImageGenerationConfiguration.md) 
+  [UpdateMediaStorageConfiguration](API_UpdateMediaStorageConfiguration.md) 
+  [UpdateNotificationConfiguration](API_UpdateNotificationConfiguration.md) 
+  [UpdateSignalingChannel](API_UpdateSignalingChannel.md) 
+  [UpdateStream](API_UpdateStream.md) 
+  [UpdateStreamStorageConfiguration](API_UpdateStreamStorageConfiguration.md) 

Amazon Kinesis Video Streams Media 支援下列動作：
+  [GetMedia](API_dataplane_GetMedia.md) 
+  [PutMedia](API_dataplane_PutMedia.md) 

Amazon Kinesis Video Streams Archived Media 支援下列動作：
+  [GetClip](API_reader_GetClip.md) 
+  [GetDASHStreamingSessionURL](API_reader_GetDASHStreamingSessionURL.md) 
+  [GetHLSStreamingSessionURL](API_reader_GetHLSStreamingSessionURL.md) 
+  [GetImages](API_reader_GetImages.md) 
+  [GetMediaForFragmentList](API_reader_GetMediaForFragmentList.md) 
+  [ListFragments](API_reader_ListFragments.md) 

Amazon Kinesis Video Signaling Channels 支援下列動作：
+  [GetIceServerConfig](API_signaling_GetIceServerConfig.md) 
+  [SendAlexaOfferToMaster](API_signaling_SendAlexaOfferToMaster.md) 

Amazon Kinesis Video WebRTC Storage 支援下列動作：
+  [JoinStorageSession](API_webrtc_JoinStorageSession.md) 
+  [JoinStorageSessionAsViewer](API_webrtc_JoinStorageSessionAsViewer.md) 

# Amazon Kinesis Video Streams
<a name="API_Operations_Amazon_Kinesis_Video_Streams"></a>

Amazon Kinesis Video Streams 支援下列動作：
+  [CreateSignalingChannel](API_CreateSignalingChannel.md) 
+  [CreateStream](API_CreateStream.md) 
+  [DeleteEdgeConfiguration](API_DeleteEdgeConfiguration.md) 
+  [DeleteSignalingChannel](API_DeleteSignalingChannel.md) 
+  [DeleteStream](API_DeleteStream.md) 
+  [DescribeEdgeConfiguration](API_DescribeEdgeConfiguration.md) 
+  [DescribeImageGenerationConfiguration](API_DescribeImageGenerationConfiguration.md) 
+  [DescribeMappedResourceConfiguration](API_DescribeMappedResourceConfiguration.md) 
+  [DescribeMediaStorageConfiguration](API_DescribeMediaStorageConfiguration.md) 
+  [DescribeNotificationConfiguration](API_DescribeNotificationConfiguration.md) 
+  [DescribeSignalingChannel](API_DescribeSignalingChannel.md) 
+  [DescribeStream](API_DescribeStream.md) 
+  [DescribeStreamStorageConfiguration](API_DescribeStreamStorageConfiguration.md) 
+  [GetDataEndpoint](API_GetDataEndpoint.md) 
+  [GetSignalingChannelEndpoint](API_GetSignalingChannelEndpoint.md) 
+  [ListEdgeAgentConfigurations](API_ListEdgeAgentConfigurations.md) 
+  [ListSignalingChannels](API_ListSignalingChannels.md) 
+  [ListStreams](API_ListStreams.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListTagsForStream](API_ListTagsForStream.md) 
+  [StartEdgeConfigurationUpdate](API_StartEdgeConfigurationUpdate.md) 
+  [TagResource](API_TagResource.md) 
+  [TagStream](API_TagStream.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UntagStream](API_UntagStream.md) 
+  [UpdateDataRetention](API_UpdateDataRetention.md) 
+  [UpdateImageGenerationConfiguration](API_UpdateImageGenerationConfiguration.md) 
+  [UpdateMediaStorageConfiguration](API_UpdateMediaStorageConfiguration.md) 
+  [UpdateNotificationConfiguration](API_UpdateNotificationConfiguration.md) 
+  [UpdateSignalingChannel](API_UpdateSignalingChannel.md) 
+  [UpdateStream](API_UpdateStream.md) 
+  [UpdateStreamStorageConfiguration](API_UpdateStreamStorageConfiguration.md) 

# CreateSignalingChannel
<a name="API_CreateSignalingChannel"></a>

建立訊號頻道。

 `CreateSignalingChannel` 是一種非同步操作。

## 請求語法
<a name="API_CreateSignalingChannel_RequestSyntax"></a>

```
POST /createSignalingChannel HTTP/1.1
Content-type: application/json

{
   "ChannelName": "string",
   "ChannelType": "string",
   "SingleMasterConfiguration": { 
      "MessageTtlSeconds": number
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## URI 請求參數
<a name="API_CreateSignalingChannel_RequestParameters"></a>

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

## 請求主體
<a name="API_CreateSignalingChannel_RequestBody"></a>

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

 ** [ChannelName](#API_CreateSignalingChannel_RequestSyntax) **   <a name="KinesisVideo-CreateSignalingChannel-request-ChannelName"></a>
您正在建立的訊號通道的名稱。每個 AWS 帳戶 和 都必須是唯一的 AWS 區域。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：是

 ** [ChannelType](#API_CreateSignalingChannel_RequestSyntax) **   <a name="KinesisVideo-CreateSignalingChannel-request-ChannelType"></a>
您正在建立的訊號通道的類型。目前唯一支援的通道類型為 `SINGLE_MASTER`。  
類型：字串  
有效值:`SINGLE_MASTER | FULL_MESH`   
必要：否

 ** [SingleMasterConfiguration](#API_CreateSignalingChannel_RequestSyntax) **   <a name="KinesisVideo-CreateSignalingChannel-request-SingleMasterConfiguration"></a>
包含`SINGLE_MASTER`頻道類型組態的結構。頻道訊息存留時間的預設組態為 60 秒 (1 分鐘）。  
類型：[SingleMasterConfiguration](API_SingleMasterConfiguration.md) 物件  
必要：否

 ** [Tags](#API_CreateSignalingChannel_RequestSyntax) **   <a name="KinesisVideo-CreateSignalingChannel-request-Tags"></a>
您要與此頻道建立關聯的一組標籤 （鍵/值對）。  
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 50。  
必要：否

## 回應語法
<a name="API_CreateSignalingChannel_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelARN": "string"
}
```

## 回應元素
<a name="API_CreateSignalingChannel_ResponseElements"></a>

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

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

 ** [ChannelARN](#API_CreateSignalingChannel_ResponseSyntax) **   <a name="KinesisVideo-CreateSignalingChannel-response-ChannelARN"></a>
已建立頻道的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`

## 錯誤
<a name="API_CreateSignalingChannel_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** AccountChannelLimitExceededException **   
您已達到此區域中作用中 AWS 帳戶 訊號頻道的上限。  
HTTP 狀態碼：400

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後再嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

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

1. 用於判斷串流指定頻道所對應的 `DescribeMediaStorageConfiguration` API。

1. 用於判斷指定串流所對應的頻道的 `DescribeMappedResourceConfiguration` API。

1. 用於判斷資源狀態的 `DescribeStream`或 `DescribeSignalingChannel` API。
HTTP 狀態碼：400

 ** TagsPerResourceExceededLimitException **   
您已超過可與資源建立關聯的標籤限制。Kinesis 影片串流最多可支援 50 個標籤。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateSignalingChannel_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/CreateSignalingChannel) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/CreateSignalingChannel) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/CreateSignalingChannel) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/CreateSignalingChannel) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/CreateSignalingChannel) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/CreateSignalingChannel) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/CreateSignalingChannel) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/CreateSignalingChannel) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/CreateSignalingChannel) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/CreateSignalingChannel) 

# CreateStream
<a name="API_CreateStream"></a>

建立新的 Kinesis 影片串流。

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

 `CreateStream` 是一種非同步操作。

如需有關服務運作方式的資訊，請參閱[運作方式](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/how-it-works.html)。

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

## 請求語法
<a name="API_CreateStream_RequestSyntax"></a>

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

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

## URI 請求參數
<a name="API_CreateStream_RequestParameters"></a>

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

## 請求主體
<a name="API_CreateStream_RequestBody"></a>

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

 ** [DataRetentionInHours](#API_CreateStream_RequestSyntax) **   <a name="KinesisVideo-CreateStream-request-DataRetentionInHours"></a>
您想要在串流中保留資料的時數。Kinesis Video Streams 會將資料保留在與串流相關聯的資料存放區中。  
預設值為 0，表示串流不會保留資料。最短為 1 小時。  
當`DataRetentionInHours`值為 0 時，消費者仍然可以使用保留在服務主機緩衝區中的片段，其保留時間限制為 5 分鐘，保留記憶體限制為 200 MB。達到任一限制時，片段會從緩衝區中移除。  
類型：整數  
有效範圍：最小值為 0。  
必要：否

 ** [DeviceName](#API_CreateStream_RequestSyntax) **   <a name="KinesisVideo-CreateStream-request-DeviceName"></a>
正在寫入串流的裝置名稱。  
在目前的實作中，Kinesis Video Streams 不會使用此名稱。
類型：字串  
長度限制：長度下限為 1。長度上限為 128。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

 ** [KmsKeyId](#API_CreateStream_RequestSyntax) **   <a name="KinesisVideo-CreateStream-request-KmsKeyId"></a>
您希望 Kinesis Video Streams 用來加密串流資料的 AWS Key Management Service (AWS KMS) 金鑰 ID。  
如果未指定金鑰 ID，則會使用預設的 Kinesis Video 受管金鑰 (`aws/kinesisvideo`)。  
 如需詳細資訊，請參閱 [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 2048。  
模式：`.+`  
必要：否

 ** [MediaType](#API_CreateStream_RequestSyntax) **   <a name="KinesisVideo-CreateStream-request-MediaType"></a>
串流的媒體類型。串流的消費者可以在處理串流時使用此資訊。如需媒體類型的詳細資訊，請參閱[媒體類型](http://www.iana.org/assignments/media-types/media-types.xhtml)。如果您選擇指定 `MediaType`，請參閱準則的[命名要求](https://tools.ietf.org/html/rfc6838#section-4.2)。  
有效值範例包括 "video/h264" 和 "video/h264，audio/aac"。  
此參數為選用；預設值為 `null`（或在 JSON 中為空）。  
類型：字串  
長度限制：長度下限為 1。長度上限為 128。  
模式：`[\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*`  
必要：否

 ** [StreamName](#API_CreateStream_RequestSyntax) **   <a name="KinesisVideo-CreateStream-request-StreamName"></a>
您要建立之串流的名稱。  
串流名稱是串流的識別符，而且每個帳戶和區域都必須是唯一的。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：是

 ** [StreamStorageConfiguration](#API_CreateStream_RequestSyntax) **   <a name="KinesisVideo-CreateStream-request-StreamStorageConfiguration"></a>
串流儲存的組態，包括串流資料的預設儲存層。此組態會決定串流資料的儲存和存取方式，而不同層提供不同層級的效能和成本最佳化。  
如果未指定，串流將使用具有 HOT 層的預設儲存組態，以獲得最佳效能。  
類型：[StreamStorageConfiguration](API_StreamStorageConfiguration.md) 物件  
必要：否

 ** [Tags](#API_CreateStream_RequestSyntax) **   <a name="KinesisVideo-CreateStream-request-Tags"></a>
要與指定串流建立關聯的標籤清單。每個標籤都是鍵/值對 （值為選用）。  
類型：字串到字串映射  
映射項目：最多 50 個項目。  
索引鍵長度限制：長度下限為 1。長度上限為 128。  
金鑰模式：`^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
值長度限制：長度下限為 0。長度上限為 256。  
值模式：`[\p{L}\p{Z}\p{N}_.:/=+\-@]*`  
必要：否

## 回應語法
<a name="API_CreateStream_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "StreamARN": "string"
}
```

## 回應元素
<a name="API_CreateStream_ResponseElements"></a>

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

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

 ** [StreamARN](#API_CreateStream_ResponseSyntax) **   <a name="KinesisVideo-CreateStream-response-StreamARN"></a>
串流的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`

## 錯誤
<a name="API_CreateStream_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** 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。

1. 用於判斷指定串流所對應的頻道的 `DescribeMappedResourceConfiguration` API。

1. 用於判斷資源狀態的 `DescribeStream`或 `DescribeSignalingChannel` API。
HTTP 狀態碼：400

 ** TagsPerResourceExceededLimitException **   
您已超過可與資源建立關聯的標籤限制。Kinesis 影片串流最多可支援 50 個標籤。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateStream_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/CreateStream) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/CreateStream) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/CreateStream) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/CreateStream) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/CreateStream) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/CreateStream) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/CreateStream) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/CreateStream) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/CreateStream) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/CreateStream) 

# DeleteEdgeConfiguration
<a name="API_DeleteEdgeConfiguration"></a>

非同步 API，可刪除串流的現有邊緣組態，以及 Edge Agent 中對應的媒體。

當您叫用此 API 時，同步狀態會設為 `DELETING`。刪除程序會開始，其中作用中的邊緣任務會停止，且所有媒體都會從邊緣裝置刪除。刪除的時間會有所不同，取決於儲存媒體的總數量。如果刪除程序失敗，同步狀態會變更為 `DELETE_FAILED`。您將需要重試刪除。

當刪除程序成功完成時，就無法再存取邊緣組態。

**注意**  
此 API 不適用於 AWS 非洲 （開普敦） 區域 af-south-1。

## 請求語法
<a name="API_DeleteEdgeConfiguration_RequestSyntax"></a>

```
POST /deleteEdgeConfiguration HTTP/1.1
Content-type: application/json

{
   "StreamARN": "string",
   "StreamName": "string"
}
```

## URI 請求參數
<a name="API_DeleteEdgeConfiguration_RequestParameters"></a>

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

## 請求主體
<a name="API_DeleteEdgeConfiguration_RequestBody"></a>

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

 ** [StreamARN](#API_DeleteEdgeConfiguration_RequestSyntax) **   <a name="KinesisVideo-DeleteEdgeConfiguration-request-StreamARN"></a>
串流的 Amazon Resource Name (ARN)。指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_DeleteEdgeConfiguration_RequestSyntax) **   <a name="KinesisVideo-DeleteEdgeConfiguration-request-StreamName"></a>
要從中刪除邊緣組態的串流名稱。指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_DeleteEdgeConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_DeleteEdgeConfiguration_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_DeleteEdgeConfiguration_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

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

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

 ** StreamEdgeConfigurationNotFoundException **   
當 Amazon Kinesis Video Stream 找不到您指定的串流邊緣組態時所產生的例外狀況。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DeleteEdgeConfiguration_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) 

# DeleteSignalingChannel
<a name="API_DeleteSignalingChannel"></a>

刪除指定的訊號頻道。 `DeleteSignalingChannel` 是一種非同步操作。如果您未指定頻道的目前版本，則會刪除最新版本。

## 請求語法
<a name="API_DeleteSignalingChannel_RequestSyntax"></a>

```
POST /deleteSignalingChannel HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "string",
   "CurrentVersion": "string"
}
```

## URI 請求參數
<a name="API_DeleteSignalingChannel_RequestParameters"></a>

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

## 請求主體
<a name="API_DeleteSignalingChannel_RequestBody"></a>

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

 ** [ChannelARN](#API_DeleteSignalingChannel_RequestSyntax) **   <a name="KinesisVideo-DeleteSignalingChannel-request-ChannelARN"></a>
您要刪除之訊號頻道的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：是

 ** [CurrentVersion](#API_DeleteSignalingChannel_RequestSyntax) **   <a name="KinesisVideo-DeleteSignalingChannel-request-CurrentVersion"></a>
您要刪除之訊號頻道的目前版本。您可以透過叫用 `DescribeSignalingChannel`或 `ListSignalingChannels` API 操作來取得目前版本。  
類型：字串  
長度限制：長度下限為 1。長度上限為 64。  
模式：`[a-zA-Z0-9]+`  
必要：否

## 回應語法
<a name="API_DeleteSignalingChannel_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_DeleteSignalingChannel_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_DeleteSignalingChannel_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

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

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

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

1. 用於判斷串流指定頻道所對應的 `DescribeMediaStorageConfiguration` API。

1. 用於判斷指定串流所對應的頻道的 `DescribeMappedResourceConfiguration` API。

1. 用於判斷資源狀態的 `DescribeStream`或 `DescribeSignalingChannel` API。
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

 ** VersionMismatchException **   
您指定的串流版本不是最新版本。若要取得最新版本，請使用 [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html) API。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteSignalingChannel_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DeleteSignalingChannel) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DeleteSignalingChannel) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DeleteSignalingChannel) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DeleteSignalingChannel) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DeleteSignalingChannel) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DeleteSignalingChannel) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DeleteSignalingChannel) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DeleteSignalingChannel) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DeleteSignalingChannel) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DeleteSignalingChannel) 

# DeleteStream
<a name="API_DeleteStream"></a>

刪除 Kinesis 影片串流和串流中包含的資料。

此方法會將串流標記為刪除，並使串流中的資料無法立即存取。

 

 若要確保在刪除之前擁有最新版本的串流，您可以指定串流版本。Kinesis Video Streams 會為每個串流指派版本。當您更新串流時，Kinesis Video Streams 會指派新的版本編號。若要取得最新的串流版本，請使用 `DescribeStream` API。

這項操作需要 `KinesisVideo:DeleteStream` 動作的許可。

## 請求語法
<a name="API_DeleteStream_RequestSyntax"></a>

```
POST /deleteStream HTTP/1.1
Content-type: application/json

{
   "CurrentVersion": "string",
   "StreamARN": "string"
}
```

## URI 請求參數
<a name="API_DeleteStream_RequestParameters"></a>

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

## 請求主體
<a name="API_DeleteStream_RequestBody"></a>

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

 ** [CurrentVersion](#API_DeleteStream_RequestSyntax) **   <a name="KinesisVideo-DeleteStream-request-CurrentVersion"></a>
選用：您要刪除的串流版本。  
指定 版本做為保護，以確保您的 刪除的是正確的串流。若要取得串流版本，請使用 `DescribeStream` API。  
如果未指定，`CreationTime`則在刪除串流之前只會檢查 。  
類型：字串  
長度限制：長度下限為 1。長度上限為 64。  
模式：`[a-zA-Z0-9]+`  
必要：否

 ** [StreamARN](#API_DeleteStream_RequestSyntax) **   <a name="KinesisVideo-DeleteStream-request-StreamARN"></a>
您要刪除之串流的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：是

## 回應語法
<a name="API_DeleteStream_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_DeleteStream_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_DeleteStream_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

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

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
發起人無權執行此操作。  
HTTP 狀態碼：401

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

1. 用於判斷串流指定頻道所對應的 `DescribeMediaStorageConfiguration` API。

1. 用於判斷指定串流所對應的頻道的 `DescribeMappedResourceConfiguration` API。

1. 用於判斷資源狀態的 `DescribeStream`或 `DescribeSignalingChannel` API。
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

 ** VersionMismatchException **   
您指定的串流版本不是最新版本。若要取得最新版本，請使用 [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html) API。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteStream_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DeleteStream) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DeleteStream) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DeleteStream) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DeleteStream) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DeleteStream) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DeleteStream) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DeleteStream) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DeleteStream) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DeleteStream) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DeleteStream) 

# DescribeEdgeConfiguration
<a name="API_DescribeEdgeConfiguration"></a>

描述使用 `StartEdgeConfigurationUpdate` API 設定的串流邊緣組態，以及邊緣代理程式記錄器和上傳器任務的最新狀態。使用此 API 取得組態的狀態，以判斷組態是否與 Edge Agent 同步。使用此 API 來評估 Edge Agent 的運作狀態。

**注意**  
此 API 不適用於 AWS 非洲 （開普敦） 區域 af-south-1。

## 請求語法
<a name="API_DescribeEdgeConfiguration_RequestSyntax"></a>

```
POST /describeEdgeConfiguration HTTP/1.1
Content-type: application/json

{
   "StreamARN": "string",
   "StreamName": "string"
}
```

## URI 請求參數
<a name="API_DescribeEdgeConfiguration_RequestParameters"></a>

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

## 請求主體
<a name="API_DescribeEdgeConfiguration_RequestBody"></a>

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

 ** [StreamARN](#API_DescribeEdgeConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-request-StreamARN"></a>
串流的 Amazon Resource Name (ARN)。指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_DescribeEdgeConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-request-StreamName"></a>
您要更新其邊緣組態的串流名稱。指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_DescribeEdgeConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "EdgeAgentStatus": { 
      "LastRecorderStatus": { 
         "JobStatusDetails": "string",
         "LastCollectedTime": number,
         "LastUpdatedTime": number,
         "RecorderStatus": "string"
      },
      "LastUploaderStatus": { 
         "JobStatusDetails": "string",
         "LastCollectedTime": number,
         "LastUpdatedTime": number,
         "UploaderStatus": "string"
      }
   },
   "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"
}
```

## 回應元素
<a name="API_DescribeEdgeConfiguration_ResponseElements"></a>

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

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

 ** [CreationTime](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-CreationTime"></a>
第一次建立串流邊緣組態的時間戳記。  
類型：Timestamp

 ** [EdgeAgentStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-EdgeAgentStatus"></a>
包含邊緣代理程式記錄器和上傳器任務最新狀態詳細資訊的物件。使用此資訊來判斷邊緣代理程式目前的運作狀態。  
類型：[EdgeAgentStatus](API_EdgeAgentStatus.md) 物件

 ** [EdgeConfig](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-EdgeConfig"></a>
串流邊緣組態的描述，將用於與 Edge Agent IoT Greengrass 元件同步。Edge Agent 元件會在您現場部署的 IoT Hub 裝置設定上執行。  
類型：[EdgeConfig](API_EdgeConfig.md) 物件

 ** [FailedStatusDetails](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-FailedStatusDetails"></a>
所產生失敗狀態的描述。  
類型：字串

 ** [LastUpdatedTime](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-LastUpdatedTime"></a>
上次更新串流邊緣組態的時間戳記。  
類型：Timestamp

 ** [StreamARN](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-StreamARN"></a>
串流的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`

 ** [StreamName](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-StreamName"></a>
邊緣組態更新來源的串流名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`

 ** [SyncStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeEdgeConfiguration-response-SyncStatus"></a>
邊緣組態更新的最新狀態。  
類型：字串  
有效值:`SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED` 

## 錯誤
<a name="API_DescribeEdgeConfiguration_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後再嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

 ** StreamEdgeConfigurationNotFoundException **   
當 Amazon Kinesis Video Stream 找不到您指定的串流邊緣組態時所產生的例外狀況。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeEdgeConfiguration_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) 

# DescribeImageGenerationConfiguration
<a name="API_DescribeImageGenerationConfiguration"></a>

取得指定 Kinesis 影片串流`ImageGenerationConfiguration`的 。

## 請求語法
<a name="API_DescribeImageGenerationConfiguration_RequestSyntax"></a>

```
POST /describeImageGenerationConfiguration HTTP/1.1
Content-type: application/json

{
   "StreamARN": "string",
   "StreamName": "string"
}
```

## URI 請求參數
<a name="API_DescribeImageGenerationConfiguration_RequestParameters"></a>

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

## 請求主體
<a name="API_DescribeImageGenerationConfiguration_RequestBody"></a>

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

 ** [StreamARN](#API_DescribeImageGenerationConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeImageGenerationConfiguration-request-StreamARN"></a>
要從中擷取映像產生組態之 Kinesis 視訊串流的 Amazon Resource Name (ARN)。您必須指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_DescribeImageGenerationConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeImageGenerationConfiguration-request-StreamName"></a>
要從中擷取映像產生組態的串流名稱。您必須指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_DescribeImageGenerationConfiguration_ResponseSyntax"></a>

```
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
   }
}
```

## 回應元素
<a name="API_DescribeImageGenerationConfiguration_ResponseElements"></a>

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

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

 ** [ImageGenerationConfiguration](#API_DescribeImageGenerationConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeImageGenerationConfiguration-response-ImageGenerationConfiguration"></a>
包含 Kinesis 影片串流 (KVS) 影像交付所需資訊的結構。如果此結構為 null，則會從串流中刪除組態。  
類型：[ImageGenerationConfiguration](API_ImageGenerationConfiguration.md) 物件

## 錯誤
<a name="API_DescribeImageGenerationConfiguration_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeImageGenerationConfiguration_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) 

# DescribeMappedResourceConfiguration
<a name="API_DescribeMappedResourceConfiguration"></a>

傳回有關串流的最新資訊。輸入中`streamARN`應該提供 `streamName`或 。

## 請求語法
<a name="API_DescribeMappedResourceConfiguration_RequestSyntax"></a>

```
POST /describeMappedResourceConfiguration HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string",
   "StreamARN": "string",
   "StreamName": "string"
}
```

## URI 請求參數
<a name="API_DescribeMappedResourceConfiguration_RequestParameters"></a>

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

## 請求主體
<a name="API_DescribeMappedResourceConfiguration_RequestBody"></a>

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

 ** [MaxResults](#API_DescribeMappedResourceConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeMappedResourceConfiguration-request-MaxResults"></a>
在回應中傳回的結果數目上限。  
類型：整數  
有效範圍：固定值為 1。  
必要：否

 ** [NextToken](#API_DescribeMappedResourceConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeMappedResourceConfiguration-request-NextToken"></a>
在您的下一個請求中提供的字符，以取得另一批結果。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1024。  
模式：`[a-zA-Z0-9+/=]*`  
必要：否

 ** [StreamARN](#API_DescribeMappedResourceConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeMappedResourceConfiguration-request-StreamARN"></a>
串流的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_DescribeMappedResourceConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeMappedResourceConfiguration-request-StreamName"></a>
 串流的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_DescribeMappedResourceConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "MappedResourceConfigurationList": [ 
      { 
         "ARN": "string",
         "Type": "string"
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_DescribeMappedResourceConfiguration_ResponseElements"></a>

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

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

 ** [MappedResourceConfigurationList](#API_DescribeMappedResourceConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeMappedResourceConfiguration-response-MappedResourceConfigurationList"></a>
封裝或包含媒體儲存組態屬性的結構。  
類型：[MappedResourceConfigurationListItem](API_MappedResourceConfigurationListItem.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 1。

 ** [NextToken](#API_DescribeMappedResourceConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeMappedResourceConfiguration-response-NextToken"></a>
`NextToken`請求中用來擷取下一組結果的字符。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1024。  
模式：`[a-zA-Z0-9+/=]*`

## 錯誤
<a name="API_DescribeMappedResourceConfiguration_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeMappedResourceConfiguration_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) 

# DescribeMediaStorageConfiguration
<a name="API_DescribeMediaStorageConfiguration"></a>

傳回頻道的最新資訊。在輸入`ChannelARN`中指定 `ChannelName`或 。

## 請求語法
<a name="API_DescribeMediaStorageConfiguration_RequestSyntax"></a>

```
POST /describeMediaStorageConfiguration HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "string",
   "ChannelName": "string"
}
```

## URI 請求參數
<a name="API_DescribeMediaStorageConfiguration_RequestParameters"></a>

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

## 請求主體
<a name="API_DescribeMediaStorageConfiguration_RequestBody"></a>

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

 ** [ChannelARN](#API_DescribeMediaStorageConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeMediaStorageConfiguration-request-ChannelARN"></a>
頻道的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [ChannelName](#API_DescribeMediaStorageConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeMediaStorageConfiguration-request-ChannelName"></a>
頻道名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_DescribeMediaStorageConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "MediaStorageConfiguration": { 
      "Status": "string",
      "StreamARN": "string"
   }
}
```

## 回應元素
<a name="API_DescribeMediaStorageConfiguration_ResponseElements"></a>

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

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

 ** [MediaStorageConfiguration](#API_DescribeMediaStorageConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeMediaStorageConfiguration-response-MediaStorageConfiguration"></a>
封裝或包含媒體儲存組態屬性的結構。  
類型：[MediaStorageConfiguration](API_MediaStorageConfiguration.md) 物件

## 錯誤
<a name="API_DescribeMediaStorageConfiguration_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeMediaStorageConfiguration_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) 

# DescribeNotificationConfiguration
<a name="API_DescribeNotificationConfiguration"></a>

取得指定 Kinesis 影片串流`NotificationConfiguration`的 。

## 請求語法
<a name="API_DescribeNotificationConfiguration_RequestSyntax"></a>

```
POST /describeNotificationConfiguration HTTP/1.1
Content-type: application/json

{
   "StreamARN": "string",
   "StreamName": "string"
}
```

## URI 請求參數
<a name="API_DescribeNotificationConfiguration_RequestParameters"></a>

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

## 請求主體
<a name="API_DescribeNotificationConfiguration_RequestBody"></a>

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

 ** [StreamARN](#API_DescribeNotificationConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeNotificationConfiguration-request-StreamARN"></a>
您要從中擷取通知組態之 Kinesis 視訊串流的 Amazon Resource Name (ARN)。您必須指定 `StreamName`或 StreamARN。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_DescribeNotificationConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeNotificationConfiguration-request-StreamName"></a>
要從中擷取通知組態的串流名稱。您必須指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_DescribeNotificationConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NotificationConfiguration": { 
      "DestinationConfig": { 
         "Uri": "string"
      },
      "Status": "string"
   }
}
```

## 回應元素
<a name="API_DescribeNotificationConfiguration_ResponseElements"></a>

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

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

 ** [NotificationConfiguration](#API_DescribeNotificationConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeNotificationConfiguration-response-NotificationConfiguration"></a>
包含通知所需資訊的結構。如果結構為 null，則會從串流中刪除組態。  
類型：[NotificationConfiguration](API_NotificationConfiguration.md) 物件

## 錯誤
<a name="API_DescribeNotificationConfiguration_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

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

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeNotificationConfiguration_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) 

# DescribeSignalingChannel
<a name="API_DescribeSignalingChannel"></a>

傳回有關訊號頻道的最新資訊。您必須指定要描述之頻道的名稱或 Amazon Resource Name (ARN)。

## 請求語法
<a name="API_DescribeSignalingChannel_RequestSyntax"></a>

```
POST /describeSignalingChannel HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "string",
   "ChannelName": "string"
}
```

## URI 請求參數
<a name="API_DescribeSignalingChannel_RequestParameters"></a>

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

## 請求主體
<a name="API_DescribeSignalingChannel_RequestBody"></a>

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

 ** [ChannelARN](#API_DescribeSignalingChannel_RequestSyntax) **   <a name="KinesisVideo-DescribeSignalingChannel-request-ChannelARN"></a>
您要描述之訊號頻道的 ARN。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [ChannelName](#API_DescribeSignalingChannel_RequestSyntax) **   <a name="KinesisVideo-DescribeSignalingChannel-request-ChannelName"></a>
您要描述的訊號頻道名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_DescribeSignalingChannel_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelInfo": { 
      "ChannelARN": "string",
      "ChannelName": "string",
      "ChannelStatus": "string",
      "ChannelType": "string",
      "CreationTime": number,
      "SingleMasterConfiguration": { 
         "MessageTtlSeconds": number
      },
      "Version": "string"
   }
}
```

## 回應元素
<a name="API_DescribeSignalingChannel_ResponseElements"></a>

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

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

 ** [ChannelInfo](#API_DescribeSignalingChannel_ResponseSyntax) **   <a name="KinesisVideo-DescribeSignalingChannel-response-ChannelInfo"></a>
封裝指定訊號頻道中繼資料和屬性的結構。  
類型：[ChannelInfo](API_ChannelInfo.md) 物件

## 錯誤
<a name="API_DescribeSignalingChannel_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeSignalingChannel_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeSignalingChannel) 

# DescribeStream
<a name="API_DescribeStream"></a>

傳回指定串流的最新資訊。您必須指定 `StreamName`或 `StreamARN`。

## 請求語法
<a name="API_DescribeStream_RequestSyntax"></a>

```
POST /describeStream HTTP/1.1
Content-type: application/json

{
   "StreamARN": "string",
   "StreamName": "string"
}
```

## URI 請求參數
<a name="API_DescribeStream_RequestParameters"></a>

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

## 請求主體
<a name="API_DescribeStream_RequestBody"></a>

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

 ** [StreamARN](#API_DescribeStream_RequestSyntax) **   <a name="KinesisVideo-DescribeStream-request-StreamARN"></a>
串流的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_DescribeStream_RequestSyntax) **   <a name="KinesisVideo-DescribeStream-request-StreamName"></a>
 串流的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_DescribeStream_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "StreamInfo": { 
      "CreationTime": number,
      "DataRetentionInHours": number,
      "DeviceName": "string",
      "KmsKeyId": "string",
      "MediaType": "string",
      "Status": "string",
      "StreamARN": "string",
      "StreamName": "string",
      "Version": "string"
   }
}
```

## 回應元素
<a name="API_DescribeStream_ResponseElements"></a>

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

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

 ** [StreamInfo](#API_DescribeStream_ResponseSyntax) **   <a name="KinesisVideo-DescribeStream-response-StreamInfo"></a>
描述串流的物件。  
類型：[StreamInfo](API_StreamInfo.md) 物件

## 錯誤
<a name="API_DescribeStream_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
發起人無權執行此操作。  
HTTP 狀態碼：401

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeStream_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeStream) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeStream) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeStream) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeStream) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeStream) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeStream) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeStream) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeStream) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeStream) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeStream) 

# DescribeStreamStorageConfiguration
<a name="API_DescribeStreamStorageConfiguration"></a>

擷取指定 Kinesis 影片串流的目前儲存組態。

在請求中，您必須指定 `StreamName`或 `StreamARN`。

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

## 請求語法
<a name="API_DescribeStreamStorageConfiguration_RequestSyntax"></a>

```
POST /describeStreamStorageConfiguration HTTP/1.1
Content-type: application/json

{
   "StreamARN": "string",
   "StreamName": "string"
}
```

## URI 請求參數
<a name="API_DescribeStreamStorageConfiguration_RequestParameters"></a>

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

## 請求主體
<a name="API_DescribeStreamStorageConfiguration_RequestBody"></a>

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

 ** [StreamARN](#API_DescribeStreamStorageConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeStreamStorageConfiguration-request-StreamARN"></a>
您要擷取儲存組態之串流的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_DescribeStreamStorageConfiguration_RequestSyntax) **   <a name="KinesisVideo-DescribeStreamStorageConfiguration-request-StreamName"></a>
您要為其擷取儲存組態的串流名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_DescribeStreamStorageConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "StreamARN": "string",
   "StreamName": "string",
   "StreamStorageConfiguration": { 
      "DefaultStorageTier": "string"
   }
}
```

## 回應元素
<a name="API_DescribeStreamStorageConfiguration_ResponseElements"></a>

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

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

 ** [StreamARN](#API_DescribeStreamStorageConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeStreamStorageConfiguration-response-StreamARN"></a>
串流的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`

 ** [StreamName](#API_DescribeStreamStorageConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeStreamStorageConfiguration-response-StreamName"></a>
 串流的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`

 ** [StreamStorageConfiguration](#API_DescribeStreamStorageConfiguration_ResponseSyntax) **   <a name="KinesisVideo-DescribeStreamStorageConfiguration-response-StreamStorageConfiguration"></a>
串流目前的儲存組態，包括預設儲存層和其他儲存相關設定。  
類型：[StreamStorageConfiguration](API_StreamStorageConfiguration.md) 物件

## 錯誤
<a name="API_DescribeStreamStorageConfiguration_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後再嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeStreamStorageConfiguration_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) 

# GetDataEndpoint
<a name="API_GetDataEndpoint"></a>

取得指定串流的端點，以進行讀取或寫入。在應用程式中使用此端點從指定的串流讀取 （使用 `GetMedia`或 `GetMediaForFragmentList`操作） 或寫入 （使用 `PutMedia`操作）。

**注意**  
傳回的端點未附加 API 名稱。用戶端需要將 API 名稱新增至傳回的端點。

在請求中，透過 `StreamName`或 指定串流`StreamARN`。

## 請求語法
<a name="API_GetDataEndpoint_RequestSyntax"></a>

```
POST /getDataEndpoint HTTP/1.1
Content-type: application/json

{
   "APIName": "string",
   "StreamARN": "string",
   "StreamName": "string"
}
```

## URI 請求參數
<a name="API_GetDataEndpoint_RequestParameters"></a>

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

## 請求主體
<a name="API_GetDataEndpoint_RequestBody"></a>

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

 ** [APIName](#API_GetDataEndpoint_RequestSyntax) **   <a name="KinesisVideo-GetDataEndpoint-request-APIName"></a>
要取得端點的 API 動作名稱。  
類型：字串  
有效值:`PUT_MEDIA | GET_MEDIA | LIST_FRAGMENTS | GET_MEDIA_FOR_FRAGMENT_LIST | GET_HLS_STREAMING_SESSION_URL | GET_DASH_STREAMING_SESSION_URL | GET_CLIP | GET_IMAGES`   
必要：是

 ** [StreamARN](#API_GetDataEndpoint_RequestSyntax) **   <a name="KinesisVideo-GetDataEndpoint-request-StreamARN"></a>
您要取得端點之串流的 Amazon Resource Name (ARN)。您必須在請求`StreamName`中指定此參數或 。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_GetDataEndpoint_RequestSyntax) **   <a name="KinesisVideo-GetDataEndpoint-request-StreamName"></a>
您要取得端點的串流名稱。您必須在請求`StreamARN`中指定此參數或 。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_GetDataEndpoint_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DataEndpoint": "string"
}
```

## 回應元素
<a name="API_GetDataEndpoint_ResponseElements"></a>

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

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

 ** [DataEndpoint](#API_GetDataEndpoint_ResponseSyntax) **   <a name="KinesisVideo-GetDataEndpoint-response-DataEndpoint"></a>
端點值。若要從串流讀取資料或將資料寫入其中，請在應用程式中指定此端點。  
類型：字串

## 錯誤
<a name="API_GetDataEndpoint_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後再嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
發起人無權執行此操作。  
HTTP 狀態碼：401

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_GetDataEndpoint_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/GetDataEndpoint) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/GetDataEndpoint) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/GetDataEndpoint) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/GetDataEndpoint) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/GetDataEndpoint) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/GetDataEndpoint) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/GetDataEndpoint) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/GetDataEndpoint) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/GetDataEndpoint) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/GetDataEndpoint) 

# GetSignalingChannelEndpoint
<a name="API_GetSignalingChannelEndpoint"></a>

為指定的訊號頻道提供端點，以傳送和接收訊息。此 API 使用`SingleMasterChannelEndpointConfiguration`輸入參數，其中包含 `Protocols`和 `Role` 屬性。

 `Protocols` 用於判斷通訊機制。例如，如果您指定 `WSS`做為通訊協定，此 API 會產生安全的 Websocket 端點。如果您指定 `HTTPS`做為通訊協定，此 API 會產生 HTTPS 端點。如果您將 指定`WEBRTC`為通訊協定，但訊號頻道未設定為擷取，則會收到錯誤 `InvalidArgumentException`。

 `Role` 會決定訊息許可。`MASTER` 角色會導致此 API 產生端點，用戶端可用來與頻道上的任何檢視器通訊。`VIEWER` 角色會導致此 API 產生端點，用戶端只能用來與 通訊`MASTER`。

## 請求語法
<a name="API_GetSignalingChannelEndpoint_RequestSyntax"></a>

```
POST /getSignalingChannelEndpoint HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "string",
   "SingleMasterChannelEndpointConfiguration": { 
      "Protocols": [ "string" ],
      "Role": "string"
   }
}
```

## URI 請求參數
<a name="API_GetSignalingChannelEndpoint_RequestParameters"></a>

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

## 請求主體
<a name="API_GetSignalingChannelEndpoint_RequestBody"></a>

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

 ** [ChannelARN](#API_GetSignalingChannelEndpoint_RequestSyntax) **   <a name="KinesisVideo-GetSignalingChannelEndpoint-request-ChannelARN"></a>
您要取得端點之訊號管道的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：是

 ** [SingleMasterChannelEndpointConfiguration](#API_GetSignalingChannelEndpoint_RequestSyntax) **   <a name="KinesisVideo-GetSignalingChannelEndpoint-request-SingleMasterChannelEndpointConfiguration"></a>
包含`SINGLE_MASTER`頻道類型端點組態的結構。  
類型：[SingleMasterChannelEndpointConfiguration](API_SingleMasterChannelEndpointConfiguration.md) 物件  
必要：否

## 回應語法
<a name="API_GetSignalingChannelEndpoint_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ResourceEndpointList": [ 
      { 
         "Protocol": "string",
         "ResourceEndpoint": "string"
      }
   ]
}
```

## 回應元素
<a name="API_GetSignalingChannelEndpoint_ResponseElements"></a>

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

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

 ** [ResourceEndpointList](#API_GetSignalingChannelEndpoint_ResponseSyntax) **   <a name="KinesisVideo-GetSignalingChannelEndpoint-response-ResourceEndpointList"></a>
指定訊號頻道的端點清單。  
類型：[ResourceEndpointListItem](API_ResourceEndpointListItem.md) 物件陣列

## 錯誤
<a name="API_GetSignalingChannelEndpoint_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

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

1. 用於判斷串流指定頻道所對應的 `DescribeMediaStorageConfiguration` API。

1. 用於判斷指定串流所對應的頻道的 `DescribeMappedResourceConfiguration` API。

1. 用於判斷資源狀態的 `DescribeStream`或 `DescribeSignalingChannel` API。
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_GetSignalingChannelEndpoint_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 

# ListEdgeAgentConfigurations
<a name="API_ListEdgeAgentConfigurations"></a>

傳回與指定 Edge Agent 相關聯的邊緣組態陣列。

在請求中，您必須指定 Edge Agent `HubDeviceArn`。

**注意**  
此 API 不適用於 AWS 非洲 （開普敦） 區域 af-south-1。

## 請求語法
<a name="API_ListEdgeAgentConfigurations_RequestSyntax"></a>

```
POST /listEdgeAgentConfigurations HTTP/1.1
Content-type: application/json

{
   "HubDeviceArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## URI 請求參數
<a name="API_ListEdgeAgentConfigurations_RequestParameters"></a>

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

## 請求主體
<a name="API_ListEdgeAgentConfigurations_RequestBody"></a>

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

 ** [HubDeviceArn](#API_ListEdgeAgentConfigurations_RequestSyntax) **   <a name="KinesisVideo-ListEdgeAgentConfigurations-request-HubDeviceArn"></a>
「物聯網 (IoT) 物件」邊緣代理程式的 Arn。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:iot:[a-z0-9-]+:[0-9]+:thing/[a-zA-Z0-9_.-]+`  
必要：是

 ** [MaxResults](#API_ListEdgeAgentConfigurations_RequestSyntax) **   <a name="KinesisVideo-ListEdgeAgentConfigurations-request-MaxResults"></a>
回應中傳回的邊緣組態數目上限。預設值為 5。  
類型：整數  
有效範圍：最小值為 1。最大值為 10。  
必要：否

 ** [NextToken](#API_ListEdgeAgentConfigurations_RequestSyntax) **   <a name="KinesisVideo-ListEdgeAgentConfigurations-request-NextToken"></a>
如果您指定此參數，則在截斷`ListEdgeAgentConfigurations`操作的結果時，呼叫會在回應`NextToken`中傳回 。若要取得另一批邊緣組態，請在下一個請求中提供此字符。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1024。  
模式：`[a-zA-Z0-9+/=]*`  
必要：否

## 回應語法
<a name="API_ListEdgeAgentConfigurations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EdgeConfigs": [ 
      { 
         "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"
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListEdgeAgentConfigurations_ResponseElements"></a>

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

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

 ** [EdgeConfigs](#API_ListEdgeAgentConfigurations_ResponseSyntax) **   <a name="KinesisVideo-ListEdgeAgentConfigurations-response-EdgeConfigs"></a>
單一串流邊緣組態的描述。  
類型：[ListEdgeAgentConfigurationsEdgeConfig](API_ListEdgeAgentConfigurationsEdgeConfig.md) 物件陣列

 ** [NextToken](#API_ListEdgeAgentConfigurations_ResponseSyntax) **   <a name="KinesisVideo-ListEdgeAgentConfigurations-response-NextToken"></a>
如果回應被截斷，呼叫會傳回具有指定字符的此元素。若要取得下一批邊緣組態，請在下一個請求中使用此字符。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1024。  
模式：`[a-zA-Z0-9+/=]*`

## 錯誤
<a name="API_ListEdgeAgentConfigurations_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

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

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
發起人無權執行此操作。  
HTTP 狀態碼：401

## 另請參閱
<a name="API_ListEdgeAgentConfigurations_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) 

# ListSignalingChannels
<a name="API_ListSignalingChannels"></a>

傳回 `ChannelInfo` 物件陣列。每個物件都會描述訊號頻道。若要僅擷取滿足特定條件的頻道，您可以指定 `ChannelNameCondition`。

## 請求語法
<a name="API_ListSignalingChannels_RequestSyntax"></a>

```
POST /listSignalingChannels HTTP/1.1
Content-type: application/json

{
   "ChannelNameCondition": { 
      "ComparisonOperator": "string",
      "ComparisonValue": "string"
   },
   "MaxResults": number,
   "NextToken": "string"
}
```

## URI 請求參數
<a name="API_ListSignalingChannels_RequestParameters"></a>

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

## 請求主體
<a name="API_ListSignalingChannels_RequestBody"></a>

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

 ** [ChannelNameCondition](#API_ListSignalingChannels_RequestSyntax) **   <a name="KinesisVideo-ListSignalingChannels-request-ChannelNameCondition"></a>
選用：僅傳回滿足特定條件的頻道。  
類型：[ChannelNameCondition](API_ChannelNameCondition.md) 物件  
必要：否

 ** [MaxResults](#API_ListSignalingChannels_RequestSyntax) **   <a name="KinesisVideo-ListSignalingChannels-request-MaxResults"></a>
回應中傳回的頻道數目上限。預設值為 500。  
類型：整數  
有效範圍：最小值為 1。最大值為 10000。  
必要：否

 ** [NextToken](#API_ListSignalingChannels_RequestSyntax) **   <a name="KinesisVideo-ListSignalingChannels-request-NextToken"></a>
如果您指定此參數，則在截斷`ListSignalingChannels`操作的結果時，呼叫會在回應`NextToken`中傳回 。若要取得另一批頻道，請在下一個請求中提供此字符。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1024。  
模式：`[a-zA-Z0-9+/=]*`  
必要：否

## 回應語法
<a name="API_ListSignalingChannels_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelInfoList": [ 
      { 
         "ChannelARN": "string",
         "ChannelName": "string",
         "ChannelStatus": "string",
         "ChannelType": "string",
         "CreationTime": number,
         "SingleMasterConfiguration": { 
            "MessageTtlSeconds": number
         },
         "Version": "string"
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListSignalingChannels_ResponseElements"></a>

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

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

 ** [ChannelInfoList](#API_ListSignalingChannels_ResponseSyntax) **   <a name="KinesisVideo-ListSignalingChannels-response-ChannelInfoList"></a>
`ChannelInfo` 物件的陣列。  
類型：[ChannelInfo](API_ChannelInfo.md) 物件陣列

 ** [NextToken](#API_ListSignalingChannels_ResponseSyntax) **   <a name="KinesisVideo-ListSignalingChannels-response-NextToken"></a>
如果回應被截斷，呼叫會傳回此元素與字符。若要取得下一批串流，請在下一個請求中使用此字符。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1024。  
模式：`[a-zA-Z0-9+/=]*`

## 錯誤
<a name="API_ListSignalingChannels_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後再嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListSignalingChannels_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/ListSignalingChannels) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/ListSignalingChannels) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/ListSignalingChannels) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/ListSignalingChannels) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/ListSignalingChannels) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/ListSignalingChannels) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/ListSignalingChannels) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/ListSignalingChannels) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/ListSignalingChannels) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/ListSignalingChannels) 

# ListStreams
<a name="API_ListStreams"></a>

傳回 `StreamInfo` 物件陣列。每個物件都會描述串流。若要僅擷取滿足特定條件的串流，您可以指定 `StreamNameCondition`。

## 請求語法
<a name="API_ListStreams_RequestSyntax"></a>

```
POST /listStreams HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string",
   "StreamNameCondition": { 
      "ComparisonOperator": "string",
      "ComparisonValue": "string"
   }
}
```

## URI 請求參數
<a name="API_ListStreams_RequestParameters"></a>

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

## 請求主體
<a name="API_ListStreams_RequestBody"></a>

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

 ** [MaxResults](#API_ListStreams_RequestSyntax) **   <a name="KinesisVideo-ListStreams-request-MaxResults"></a>
回應中傳回的串流數目上限。預設值為 10,000。  
類型：整數  
有效範圍：最小值為 1。最大值為 10000。  
必要：否

 ** [NextToken](#API_ListStreams_RequestSyntax) **   <a name="KinesisVideo-ListStreams-request-NextToken"></a>
如果您指定此參數，則在截斷`ListStreams`操作的結果時，呼叫會在回應`NextToken`中傳回 。若要取得另一批串流，請在下一個請求中提供此字符。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1024。  
模式：`[a-zA-Z0-9+/=]*`  
必要：否

 ** [StreamNameCondition](#API_ListStreams_RequestSyntax) **   <a name="KinesisVideo-ListStreams-request-StreamNameCondition"></a>
選用：僅傳回滿足特定條件的串流。目前，您只能指定串流名稱的字首做為條件。  
類型：[StreamNameCondition](API_StreamNameCondition.md) 物件  
必要：否

## 回應語法
<a name="API_ListStreams_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "StreamInfoList": [ 
      { 
         "CreationTime": number,
         "DataRetentionInHours": number,
         "DeviceName": "string",
         "KmsKeyId": "string",
         "MediaType": "string",
         "Status": "string",
         "StreamARN": "string",
         "StreamName": "string",
         "Version": "string"
      }
   ]
}
```

## 回應元素
<a name="API_ListStreams_ResponseElements"></a>

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

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

 ** [NextToken](#API_ListStreams_ResponseSyntax) **   <a name="KinesisVideo-ListStreams-response-NextToken"></a>
如果回應被截斷，呼叫會傳回此元素與字符。若要取得下一批串流，請在下一個請求中使用此字符。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1024。  
模式：`[a-zA-Z0-9+/=]*`

 ** [StreamInfoList](#API_ListStreams_ResponseSyntax) **   <a name="KinesisVideo-ListStreams-response-StreamInfoList"></a>
`StreamInfo` 物件的陣列。  
類型：[StreamInfo](API_StreamInfo.md) 物件陣列

## 錯誤
<a name="API_ListStreams_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後再嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListStreams_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/ListStreams) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/ListStreams) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/ListStreams) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/ListStreams) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/ListStreams) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/ListStreams) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/ListStreams) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/ListStreams) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/ListStreams) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/ListStreams) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

傳回與指定訊號頻道相關聯的標籤清單。

## 請求語法
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
POST /ListTagsForResource HTTP/1.1
Content-type: application/json

{
   "NextToken": "string",
   "ResourceARN": "string"
}
```

## URI 請求參數
<a name="API_ListTagsForResource_RequestParameters"></a>

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

## 請求主體
<a name="API_ListTagsForResource_RequestBody"></a>

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

 ** [NextToken](#API_ListTagsForResource_RequestSyntax) **   <a name="KinesisVideo-ListTagsForResource-request-NextToken"></a>
如果您指定此參數，且`ListTagsForResource`呼叫的結果被截斷，回應會包含一個字符，您可以在下一個請求中使用它來擷取下一批標籤。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1024。  
模式：`[a-zA-Z0-9+/=]*`  
必要：否

 ** [ResourceARN](#API_ListTagsForResource_RequestSyntax) **   <a name="KinesisVideo-ListTagsForResource-request-ResourceARN"></a>
您要列出標籤之訊號通道的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：是

## 回應語法
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## 回應元素
<a name="API_ListTagsForResource_ResponseElements"></a>

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

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

 ** [NextToken](#API_ListTagsForResource_ResponseSyntax) **   <a name="KinesisVideo-ListTagsForResource-response-NextToken"></a>
如果您指定此參數，且`ListTagsForResource`呼叫的結果被截斷，則回應會包含權杖，您可以在下一個請求中使用它來擷取下一組標籤。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1024。  
模式：`[a-zA-Z0-9+/=]*`

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="KinesisVideo-ListTagsForResource-response-Tags"></a>
與指定訊號通道相關聯的標籤索引鍵和值映射。  
類型：字串到字串映射  
映射項目：最多 50 個項目。  
索引鍵長度限制：長度下限為 1。長度上限為 128。  
金鑰模式：`^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
值長度限制：長度下限為 0。長度上限為 256。  
值模式：`[\p{L}\p{Z}\p{N}_.:/=+\-@]*`

## 錯誤
<a name="API_ListTagsForResource_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_ListTagsForResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/ListTagsForResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/ListTagsForResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/ListTagsForResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/ListTagsForResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/ListTagsForResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/ListTagsForResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/ListTagsForResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/ListTagsForResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/ListTagsForResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/ListTagsForResource) 

# ListTagsForStream
<a name="API_ListTagsForStream"></a>

傳回與指定串流相關聯的標籤清單。

在請求中，您必須指定 `StreamName`或 `StreamARN`。

## 請求語法
<a name="API_ListTagsForStream_RequestSyntax"></a>

```
POST /listTagsForStream HTTP/1.1
Content-type: application/json

{
   "NextToken": "string",
   "StreamARN": "string",
   "StreamName": "string"
}
```

## URI 請求參數
<a name="API_ListTagsForStream_RequestParameters"></a>

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

## 請求主體
<a name="API_ListTagsForStream_RequestBody"></a>

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

 ** [NextToken](#API_ListTagsForStream_RequestSyntax) **   <a name="KinesisVideo-ListTagsForStream-request-NextToken"></a>
如果您指定此參數，且`ListTagsForStream`呼叫的結果被截斷，回應會包含一個字符，您可以在下一個請求中使用它來擷取下一批標籤。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1024。  
模式：`[a-zA-Z0-9+/=]*`  
必要：否

 ** [StreamARN](#API_ListTagsForStream_RequestSyntax) **   <a name="KinesisVideo-ListTagsForStream-request-StreamARN"></a>
您要列出標籤之串流的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_ListTagsForStream_RequestSyntax) **   <a name="KinesisVideo-ListTagsForStream-request-StreamName"></a>
您要列出標籤的串流名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_ListTagsForStream_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## 回應元素
<a name="API_ListTagsForStream_ResponseElements"></a>

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

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

 ** [NextToken](#API_ListTagsForStream_ResponseSyntax) **   <a name="KinesisVideo-ListTagsForStream-response-NextToken"></a>
如果您指定此參數，且`ListTags`呼叫的結果被截斷，回應會包含一個字符，您可以在下一個請求中使用它來擷取下一組標籤。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1024。  
模式：`[a-zA-Z0-9+/=]*`

 ** [Tags](#API_ListTagsForStream_ResponseSyntax) **   <a name="KinesisVideo-ListTagsForStream-response-Tags"></a>
與指定串流相關聯的標籤索引鍵和值映射。  
類型：字串到字串映射  
映射項目：最多 50 個項目。  
索引鍵長度限制：長度下限為 1。長度上限為 128。  
金鑰模式：`^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
值長度限制：長度下限為 0。長度上限為 256。  
值模式：`[\p{L}\p{Z}\p{N}_.:/=+\-@]*`

## 錯誤
<a name="API_ListTagsForStream_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

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

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** InvalidResourceFormatException **   
的格式`StreamARN`無效。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
發起人無權執行此操作。  
HTTP 狀態碼：401

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_ListTagsForStream_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/ListTagsForStream) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/ListTagsForStream) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/ListTagsForStream) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/ListTagsForStream) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/ListTagsForStream) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/ListTagsForStream) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/ListTagsForStream) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/ListTagsForStream) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/ListTagsForStream) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/ListTagsForStream) 

# StartEdgeConfigurationUpdate
<a name="API_StartEdgeConfigurationUpdate"></a>

非同步 API，可更新串流的現有邊緣組態。Kinesis Video Stream 會將串流的邊緣組態與在 IoT Hub 裝置上執行的 Edge Agent IoT Greengrass 元件同步，該元件會在您現場部署中設定。同步的時間可能會有所不同，取決於 Hub 裝置的連線能力。`SyncStatus` 會在確認邊緣組態時更新，並與 Edge Agent 同步。

如果第一次叫用此 API，則會為串流建立新的邊緣組態，並將同步狀態設定為 `SYNCING`。您必須等待同步狀態達到終端狀態，例如： `IN_SYNC`或 `SYNC_FAILED`，才能再次使用此 API。如果您在同步程序期間叫用此 API，`ResourceInUseException`則會擲回 。串流邊緣組態和 Edge Agent 的連線將會重試 15 分鐘。15 分鐘後，狀態會轉換為 `SYNC_FAILED` 狀態。

若要將邊緣組態從一個裝置移至另一個裝置，請使用 [DeleteEdgeConfiguration](API_DeleteEdgeConfiguration.md)刪除目前的邊緣組態。然後，您可以使用更新的 Hub 裝置 ARN 叫用 StartEdgeConfigurationUpdate。

**注意**  
此 API 不適用於 AWS 非洲 （開普敦） 區域 af-south-1。

## 請求語法
<a name="API_StartEdgeConfigurationUpdate_RequestSyntax"></a>

```
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 請求參數
<a name="API_StartEdgeConfigurationUpdate_RequestParameters"></a>

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

## 請求主體
<a name="API_StartEdgeConfigurationUpdate_RequestBody"></a>

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

 ** [EdgeConfig](#API_StartEdgeConfigurationUpdate_RequestSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-request-EdgeConfig"></a>
叫用更新程序所需的邊緣組態詳細資訊。  
類型：[EdgeConfig](API_EdgeConfig.md) 物件  
必要：是

 ** [StreamARN](#API_StartEdgeConfigurationUpdate_RequestSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-request-StreamARN"></a>
 串流的 Amazon Resource Name (ARN)。指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_StartEdgeConfigurationUpdate_RequestSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-request-StreamName"></a>
您要更新其邊緣組態的串流名稱。指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_StartEdgeConfigurationUpdate_ResponseSyntax"></a>

```
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"
}
```

## 回應元素
<a name="API_StartEdgeConfigurationUpdate_ResponseElements"></a>

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

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

 ** [CreationTime](#API_StartEdgeConfigurationUpdate_ResponseSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-response-CreationTime"></a>
第一次建立串流邊緣組態的時間戳記。  
類型：Timestamp

 ** [EdgeConfig](#API_StartEdgeConfigurationUpdate_ResponseSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-response-EdgeConfig"></a>
串流邊緣組態的描述，將用於與 Edge Agent IoT Greengrass 元件同步。Edge Agent 元件會在您現場部署的 IoT Hub 裝置設定上執行。  
類型：[EdgeConfig](API_EdgeConfig.md) 物件

 ** [FailedStatusDetails](#API_StartEdgeConfigurationUpdate_ResponseSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-response-FailedStatusDetails"></a>
所產生失敗狀態的描述。  
類型：字串

 ** [LastUpdatedTime](#API_StartEdgeConfigurationUpdate_ResponseSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-response-LastUpdatedTime"></a>
上次更新串流邊緣組態的時間戳記。  
類型：Timestamp

 ** [StreamARN](#API_StartEdgeConfigurationUpdate_ResponseSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-response-StreamARN"></a>
串流的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`

 ** [StreamName](#API_StartEdgeConfigurationUpdate_ResponseSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-response-StreamName"></a>
邊緣組態更新來源的串流名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`

 ** [SyncStatus](#API_StartEdgeConfigurationUpdate_ResponseSyntax) **   <a name="KinesisVideo-StartEdgeConfigurationUpdate-response-SyncStatus"></a>
 串流邊緣組態的目前同步狀態。當您叫用此 API 時，同步狀態會設為 `SYNCING` 狀態。使用 `DescribeEdgeConfiguration` API 取得邊緣組態的最新狀態。  
類型：字串  
有效值:`SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED` 

## 錯誤
<a name="API_StartEdgeConfigurationUpdate_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** NoDataRetentionException **   
串流資料保留小時數等於零。  
HTTP 狀態碼：400

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

1. 用於判斷串流指定頻道所對應的 `DescribeMediaStorageConfiguration` API。

1. 用於判斷指定串流所對應的頻道的 `DescribeMappedResourceConfiguration` API。

1. 用於判斷資源狀態的 `DescribeStream`或 `DescribeSignalingChannel` API。
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_StartEdgeConfigurationUpdate_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) 

# TagResource
<a name="API_TagResource"></a>

**僅**將一或多個標籤新增至訊號頻道。**注意：**若要標記串流，請改用 TagStream API。*標籤*是您可以定義和指派給 AWS 資源的鍵/值對 （值為選用）。如果您指定已存在的標籤，您在請求中指定的值會取代標籤值。如需詳細資訊，請參閱《 * AWS 帳單與成本管理 和成本管理使用者指南》中的*[使用成本分配標籤](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)。

## 請求語法
<a name="API_TagResource_RequestSyntax"></a>

```
POST /TagResource HTTP/1.1
Content-type: application/json

{
   "ResourceARN": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## URI 請求參數
<a name="API_TagResource_RequestParameters"></a>

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

## 請求主體
<a name="API_TagResource_RequestBody"></a>

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

 ** [ResourceARN](#API_TagResource_RequestSyntax) **   <a name="KinesisVideo-TagResource-request-ResourceARN"></a>
您要新增標籤之訊號通道的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：是

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="KinesisVideo-TagResource-request-Tags"></a>
要與指定訊號頻道建立關聯的標籤清單。每個標籤都是金鑰值對。  
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 1。項目數上限為 50。  
必要：是

## 回應語法
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_TagResource_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_TagResource_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後再嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

 ** TagsPerResourceExceededLimitException **   
您已超過可與資源建立關聯的標籤限制。Kinesis 影片串流最多可支援 50 個標籤。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_TagResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/TagResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/TagResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/TagResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/TagResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/TagResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/TagResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/TagResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/TagResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/TagResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/TagResource) 

# TagStream
<a name="API_TagStream"></a>

將一或多個標籤新增至串流。*標籤*是您可以定義和指派給 AWS 資源的鍵/值對 （此值為選用）。如果您指定已存在的標籤，您在請求中指定的值會取代標籤值。如需詳細資訊，請參閱《 * AWS 帳單與成本管理 和* [成本管理使用者指南》中的使用成本分配標籤](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)。

您必須提供 `StreamName`或 `StreamARN`。

這項操作需要 `KinesisVideo:TagStream` 動作的許可。

Kinesis 影片串流最多可支援 50 個標籤。

## 請求語法
<a name="API_TagStream_RequestSyntax"></a>

```
POST /tagStream HTTP/1.1
Content-type: application/json

{
   "StreamARN": "string",
   "StreamName": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI 請求參數
<a name="API_TagStream_RequestParameters"></a>

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

## 請求主體
<a name="API_TagStream_RequestBody"></a>

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

 ** [StreamARN](#API_TagStream_RequestSyntax) **   <a name="KinesisVideo-TagStream-request-StreamARN"></a>
您要新增標籤或標籤之資源的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_TagStream_RequestSyntax) **   <a name="KinesisVideo-TagStream-request-StreamName"></a>
您要新增標籤或標籤的串流名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

 ** [Tags](#API_TagStream_RequestSyntax) **   <a name="KinesisVideo-TagStream-request-Tags"></a>
要與指定串流建立關聯的標籤清單。每個標籤都是鍵/值對 （值為選用）。  
類型：字串到字串映射  
映射項目：最多 50 個項目。  
索引鍵長度限制：長度下限為 1。長度上限為 128。  
金鑰模式：`^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
值長度限制：長度下限為 0。長度上限為 256。  
值模式：`[\p{L}\p{Z}\p{N}_.:/=+\-@]*`  
必要：是

## 回應語法
<a name="API_TagStream_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_TagStream_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_TagStream_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

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

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** InvalidResourceFormatException **   
的格式`StreamARN`無效。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
發起人無權執行此操作。  
HTTP 狀態碼：401

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

 ** TagsPerResourceExceededLimitException **   
您已超過可與資源建立關聯的標籤限制。Kinesis 影片串流最多可支援 50 個標籤。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_TagStream_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/TagStream) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/TagStream) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/TagStream) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/TagStream) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/TagStream) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/TagStream) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/TagStream) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/TagStream) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/TagStream) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/TagStream) 

# UntagResource
<a name="API_UntagResource"></a>

**僅**從訊號頻道移除一或多個標籤。**注意：**若要從串流中移除標籤，請改用 UntagStream API。在請求中，僅指定標籤索引鍵或索引鍵；不要指定值。如果您指定不存在的標籤金鑰，則會予以忽略。

## 請求語法
<a name="API_UntagResource_RequestSyntax"></a>

```
POST /UntagResource HTTP/1.1
Content-type: application/json

{
   "ResourceARN": "string",
   "TagKeyList": [ "string" ]
}
```

## URI 請求參數
<a name="API_UntagResource_RequestParameters"></a>

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

## 請求主體
<a name="API_UntagResource_RequestBody"></a>

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

 ** [ResourceARN](#API_UntagResource_RequestSyntax) **   <a name="KinesisVideo-UntagResource-request-ResourceARN"></a>
您要從中移除標籤之訊號通道的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：是

 ** [TagKeyList](#API_UntagResource_RequestSyntax) **   <a name="KinesisVideo-UntagResource-request-TagKeyList"></a>
您要移除之標籤的索引鍵清單。  
類型：字串陣列  
陣列成員：項目數下限為 1。項目數上限為 50。  
長度限制：長度下限為 1。長度上限為 128。  
模式：`^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
必要：是

## 回應語法
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_UntagResource_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_UntagResource_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_UntagResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UntagResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UntagResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UntagResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UntagResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UntagResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UntagResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UntagResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UntagResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UntagResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UntagResource) 

# UntagStream
<a name="API_UntagStream"></a>

從串流移除一或多個標籤。在請求中，僅指定標籤索引鍵或索引鍵；不要指定值。如果您指定不存在的標籤金鑰，則會予以忽略。

在請求中，您必須提供 `StreamName`或 `StreamARN`。

## 請求語法
<a name="API_UntagStream_RequestSyntax"></a>

```
POST /untagStream HTTP/1.1
Content-type: application/json

{
   "StreamARN": "string",
   "StreamName": "string",
   "TagKeyList": [ "string" ]
}
```

## URI 請求參數
<a name="API_UntagStream_RequestParameters"></a>

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

## 請求主體
<a name="API_UntagStream_RequestBody"></a>

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

 ** [StreamARN](#API_UntagStream_RequestSyntax) **   <a name="KinesisVideo-UntagStream-request-StreamARN"></a>
您要從中移除標籤之串流的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_UntagStream_RequestSyntax) **   <a name="KinesisVideo-UntagStream-request-StreamName"></a>
您要從中移除標籤的串流名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

 ** [TagKeyList](#API_UntagStream_RequestSyntax) **   <a name="KinesisVideo-UntagStream-request-TagKeyList"></a>
您要移除之標籤的索引鍵清單。  
類型：字串陣列  
陣列成員：項目數下限為 1。項目數上限為 50。  
長度限制：長度下限為 1。長度上限為 128。  
模式：`^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
必要：是

## 回應語法
<a name="API_UntagStream_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_UntagStream_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_UntagStream_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

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

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** InvalidResourceFormatException **   
的格式`StreamARN`無效。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
發起人無權執行此操作。  
HTTP 狀態碼：401

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_UntagStream_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UntagStream) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UntagStream) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UntagStream) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UntagStream) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UntagStream) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UntagStream) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UntagStream) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UntagStream) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UntagStream) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UntagStream) 

# UpdateDataRetention
<a name="API_UpdateDataRetention"></a>

依您指定的值增加或減少串流的資料保留期間。若要指出是否要增加或減少資料保留期間，請在請求內文中指定 `Operation` 參數。在請求中，您必須指定 `StreamName`或 `StreamARN`。

這項操作需要 `KinesisVideo:UpdateDataRetention` 動作的許可。

變更資料保留期間會影響串流中的資料，如下所示：
+ 如果資料保留期間增加，現有資料會保留新的保留期間。例如，如果資料保留期間從 1 小時增加到 7 小時，則所有現有的資料都會保留 7 小時。
+ 如果資料保留期間減少，則會在新的保留期間保留現有資料。例如，如果資料保留期間從 7 小時縮短為 1 小時，所有現有的資料都會保留 1 小時，而且任何超過 1 小時的資料都會立即刪除。

## 請求語法
<a name="API_UpdateDataRetention_RequestSyntax"></a>

```
POST /updateDataRetention HTTP/1.1
Content-type: application/json

{
   "CurrentVersion": "string",
   "DataRetentionChangeInHours": number,
   "Operation": "string",
   "StreamARN": "string",
   "StreamName": "string"
}
```

## URI 請求參數
<a name="API_UpdateDataRetention_RequestParameters"></a>

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

## 請求主體
<a name="API_UpdateDataRetention_RequestBody"></a>

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

 ** [CurrentVersion](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-CurrentVersion"></a>
您想要變更其保留期間之串流的版本。若要取得 版本，請呼叫 `DescribeStream`或 `ListStreams` API。  
類型：字串  
長度限制：長度下限為 1。長度上限為 64。  
模式：`[a-zA-Z0-9]+`  
必要：是

 ** [DataRetentionChangeInHours](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-DataRetentionChangeInHours"></a>
調整目前保留的時數。您指定的值會根據 新增至目前值或從中減去`operation`。  
資料保留的最小值為 0，最大值為 87600 （十年）。  
類型：整數  
有效範圍：最小值為 1。  
必要：是

 ** [Operation](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-Operation"></a>
指出您是否要增加或減少保留期間。  
類型：字串  
有效值:`INCREASE_DATA_RETENTION | DECREASE_DATA_RETENTION`   
必要：是

 ** [StreamARN](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-StreamARN"></a>
您要變更其保留期間之串流的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-StreamName"></a>
您要變更其保留期間之串流的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_UpdateDataRetention_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_UpdateDataRetention_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_UpdateDataRetention_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
發起人無權執行此操作。  
HTTP 狀態碼：401

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

1. 用於判斷串流指定頻道所對應的 `DescribeMediaStorageConfiguration` API。

1. 用於判斷指定串流所對應的頻道的 `DescribeMappedResourceConfiguration` API。

1. 用於判斷資源狀態的 `DescribeStream`或 `DescribeSignalingChannel` API。
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

 ** VersionMismatchException **   
您指定的串流版本不是最新版本。若要取得最新版本，請使用 [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html) API。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_UpdateDataRetention_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateDataRetention) 

# UpdateImageGenerationConfiguration
<a name="API_UpdateImageGenerationConfiguration"></a>

更新 `StreamInfo`和 `ImageProcessingConfiguration` 欄位。

## 請求語法
<a name="API_UpdateImageGenerationConfiguration_RequestSyntax"></a>

```
POST /updateImageGenerationConfiguration HTTP/1.1
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
   },
   "StreamARN": "string",
   "StreamName": "string"
}
```

## URI 請求參數
<a name="API_UpdateImageGenerationConfiguration_RequestParameters"></a>

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

## 請求主體
<a name="API_UpdateImageGenerationConfiguration_RequestBody"></a>

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

 ** [ImageGenerationConfiguration](#API_UpdateImageGenerationConfiguration_RequestSyntax) **   <a name="KinesisVideo-UpdateImageGenerationConfiguration-request-ImageGenerationConfiguration"></a>
包含 KVS 影像交付所需資訊的結構。如果結構為 null，則會從串流中刪除組態。  
類型：[ImageGenerationConfiguration](API_ImageGenerationConfiguration.md) 物件  
必要：否

 ** [StreamARN](#API_UpdateImageGenerationConfiguration_RequestSyntax) **   <a name="KinesisVideo-UpdateImageGenerationConfiguration-request-StreamARN"></a>
您要更新映像產生組態之 Kinesis 視訊串流的 Amazon Resource Name (ARN)。您必須指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_UpdateImageGenerationConfiguration_RequestSyntax) **   <a name="KinesisVideo-UpdateImageGenerationConfiguration-request-StreamName"></a>
要從中更新映像產生組態的串流名稱。您必須指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_UpdateImageGenerationConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_UpdateImageGenerationConfiguration_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_UpdateImageGenerationConfiguration_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

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

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** NoDataRetentionException **   
串流資料保留小時數等於零。  
HTTP 狀態碼：400

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

1. 用於判斷串流指定頻道所對應的 `DescribeMediaStorageConfiguration` API。

1. 用於判斷指定串流所對應的頻道的 `DescribeMappedResourceConfiguration` API。

1. 用於判斷資源狀態的 `DescribeStream`或 `DescribeSignalingChannel` API。
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_UpdateImageGenerationConfiguration_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) 

# UpdateMediaStorageConfiguration
<a name="API_UpdateMediaStorageConfiguration"></a>

將 `SignalingChannel`與串流建立關聯以存放媒體。您可以指定兩種訊號模式：
+ 如果`StorageStatus`啟用 ，資料將存放在`StreamARN`提供的 中。若要讓 WebRTC 擷取正常運作，串流必須啟用資料保留。
+ 如果 `StorageStatus` 已停用，則不會儲存任何資料，而且不需要 `StreamARN` 參數。

**重要**  
如果`StorageStatus`啟用 ，則不會再發生對peer-to-peer（主要檢視者） 連線。對等直接連線至儲存工作階段。您必須呼叫 `JoinStorageSession` API 來觸發 SDP 優惠傳送，並在對等和儲存工作階段之間建立連線。

## 請求語法
<a name="API_UpdateMediaStorageConfiguration_RequestSyntax"></a>

```
POST /updateMediaStorageConfiguration HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "string",
   "MediaStorageConfiguration": { 
      "Status": "string",
      "StreamARN": "string"
   }
}
```

## URI 請求參數
<a name="API_UpdateMediaStorageConfiguration_RequestParameters"></a>

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

## 請求主體
<a name="API_UpdateMediaStorageConfiguration_RequestBody"></a>

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

 ** [ChannelARN](#API_UpdateMediaStorageConfiguration_RequestSyntax) **   <a name="KinesisVideo-UpdateMediaStorageConfiguration-request-ChannelARN"></a>
頻道的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：是

 ** [MediaStorageConfiguration](#API_UpdateMediaStorageConfiguration_RequestSyntax) **   <a name="KinesisVideo-UpdateMediaStorageConfiguration-request-MediaStorageConfiguration"></a>
封裝或包含媒體儲存組態屬性的結構。  
類型：[MediaStorageConfiguration](API_MediaStorageConfiguration.md) 物件  
必要：是

## 回應語法
<a name="API_UpdateMediaStorageConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_UpdateMediaStorageConfiguration_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_UpdateMediaStorageConfiguration_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** NoDataRetentionException **   
串流資料保留小時數等於零。  
HTTP 狀態碼：400

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

1. 用於判斷串流指定頻道所對應的 `DescribeMediaStorageConfiguration` API。

1. 用於判斷指定串流所對應的頻道的 `DescribeMappedResourceConfiguration` API。

1. 用於判斷資源狀態的 `DescribeStream`或 `DescribeSignalingChannel` API。
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_UpdateMediaStorageConfiguration_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) 

# UpdateNotificationConfiguration
<a name="API_UpdateNotificationConfiguration"></a>

更新串流的通知資訊。

## 請求語法
<a name="API_UpdateNotificationConfiguration_RequestSyntax"></a>

```
POST /updateNotificationConfiguration HTTP/1.1
Content-type: application/json

{
   "NotificationConfiguration": { 
      "DestinationConfig": { 
         "Uri": "string"
      },
      "Status": "string"
   },
   "StreamARN": "string",
   "StreamName": "string"
}
```

## URI 請求參數
<a name="API_UpdateNotificationConfiguration_RequestParameters"></a>

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

## 請求主體
<a name="API_UpdateNotificationConfiguration_RequestBody"></a>

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

 ** [NotificationConfiguration](#API_UpdateNotificationConfiguration_RequestSyntax) **   <a name="KinesisVideo-UpdateNotificationConfiguration-request-NotificationConfiguration"></a>
包含通知所需資訊的結構。如果結構為 null，則會從串流中刪除組態。  
類型：[NotificationConfiguration](API_NotificationConfiguration.md) 物件  
必要：否

 ** [StreamARN](#API_UpdateNotificationConfiguration_RequestSyntax) **   <a name="KinesisVideo-UpdateNotificationConfiguration-request-StreamARN"></a>
您要更新通知組態之 Kinesis 影片串流的 Amazon Resource Name (ARN)。您必須指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_UpdateNotificationConfiguration_RequestSyntax) **   <a name="KinesisVideo-UpdateNotificationConfiguration-request-StreamName"></a>
要從中更新通知組態的串流名稱。您必須指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_UpdateNotificationConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_UpdateNotificationConfiguration_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_UpdateNotificationConfiguration_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後再嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** NoDataRetentionException **   
串流資料保留小時數等於零。  
HTTP 狀態碼：400

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

1. 用於判斷串流指定頻道所對應的 `DescribeMediaStorageConfiguration` API。

1. 用於判斷指定串流所對應的頻道的 `DescribeMappedResourceConfiguration` API。

1. 用於判斷資源狀態的 `DescribeStream`或 `DescribeSignalingChannel` API。
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_UpdateNotificationConfiguration_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) 

# UpdateSignalingChannel
<a name="API_UpdateSignalingChannel"></a>

更新現有的訊號頻道。這是非同步操作，需要一些時間才能完成。

如果`MessageTtlSeconds`值已更新 （增加或減少），則僅適用於更新後透過此頻道傳送的新訊息。現有訊息仍會根據先前的`MessageTtlSeconds`值過期。

## 請求語法
<a name="API_UpdateSignalingChannel_RequestSyntax"></a>

```
POST /updateSignalingChannel HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "string",
   "CurrentVersion": "string",
   "SingleMasterConfiguration": { 
      "MessageTtlSeconds": number
   }
}
```

## URI 請求參數
<a name="API_UpdateSignalingChannel_RequestParameters"></a>

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

## 請求主體
<a name="API_UpdateSignalingChannel_RequestBody"></a>

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

 ** [ChannelARN](#API_UpdateSignalingChannel_RequestSyntax) **   <a name="KinesisVideo-UpdateSignalingChannel-request-ChannelARN"></a>
您要更新的訊號頻道的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：是

 ** [CurrentVersion](#API_UpdateSignalingChannel_RequestSyntax) **   <a name="KinesisVideo-UpdateSignalingChannel-request-CurrentVersion"></a>
您要更新的訊號頻道目前版本。  
類型：字串  
長度限制：長度下限為 1。長度上限為 64。  
模式：`[a-zA-Z0-9]+`  
必要：是

 ** [SingleMasterConfiguration](#API_UpdateSignalingChannel_RequestSyntax) **   <a name="KinesisVideo-UpdateSignalingChannel-request-SingleMasterConfiguration"></a>
包含您要更新之訊號頻道`SINGLE_MASTER`類型的組態的結構。具有頻道類型的頻道需要此參數和`SINGLE_MASTER`頻道訊息的time-to-live。  
類型：[SingleMasterConfiguration](API_SingleMasterConfiguration.md) 物件  
必要：否

## 回應語法
<a name="API_UpdateSignalingChannel_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_UpdateSignalingChannel_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_UpdateSignalingChannel_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

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

1. 用於判斷串流指定頻道所對應的 `DescribeMediaStorageConfiguration` API。

1. 用於判斷指定串流所對應的頻道的 `DescribeMappedResourceConfiguration` API。

1. 用於判斷資源狀態的 `DescribeStream`或 `DescribeSignalingChannel` API。
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

 ** VersionMismatchException **   
您指定的串流版本不是最新版本。若要取得最新版本，請使用 [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html) API。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_UpdateSignalingChannel_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateSignalingChannel) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateSignalingChannel) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateSignalingChannel) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateSignalingChannel) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateSignalingChannel) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateSignalingChannel) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateSignalingChannel) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateSignalingChannel) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateSignalingChannel) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateSignalingChannel) 

# UpdateStream
<a name="API_UpdateStream"></a>

更新串流中繼資料，例如裝置名稱和媒體類型。

您必須提供串流名稱或串流的 Amazon Resource Name (ARN)。

若要確保在更新之前擁有最新版本的串流，您可以指定串流版本。Kinesis Video Streams 會為每個串流指派版本。當您更新串流時，Kinesis Video Streams 會指派新的版本編號。若要取得最新的串流版本，請使用 `DescribeStream` API。

 `UpdateStream` 是一種非同步操作，需要一些時間才能完成。

## 請求語法
<a name="API_UpdateStream_RequestSyntax"></a>

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

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

## URI 請求參數
<a name="API_UpdateStream_RequestParameters"></a>

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

## 請求主體
<a name="API_UpdateStream_RequestBody"></a>

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

 ** [CurrentVersion](#API_UpdateStream_RequestSyntax) **   <a name="KinesisVideo-UpdateStream-request-CurrentVersion"></a>
您要更新其中繼資料的串流版本。  
類型：字串  
長度限制：長度下限為 1。長度上限為 64。  
模式：`[a-zA-Z0-9]+`  
必要：是

 ** [DeviceName](#API_UpdateStream_RequestSyntax) **   <a name="KinesisVideo-UpdateStream-request-DeviceName"></a>
正在寫入串流的裝置名稱。  
 在目前的實作中，Kinesis Video Streams 不會使用此名稱。
類型：字串  
長度限制：長度下限為 1。長度上限為 128。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

 ** [MediaType](#API_UpdateStream_RequestSyntax) **   <a name="KinesisVideo-UpdateStream-request-MediaType"></a>
串流的媒體類型。使用 `MediaType`指定串流包含的內容類型給串流的取用者。如需媒體類型的詳細資訊，請參閱[媒體類型](http://www.iana.org/assignments/media-types/media-types.xhtml)。如果您選擇指定 `MediaType`，請參閱[命名需求](https://tools.ietf.org/html/rfc6838#section-4.2)。  
若要在主控台上播放影片，您必須指定正確的影片類型。例如，如果串流中的視訊是 H.264，請將 指定`video/h264`為 `MediaType`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 128。  
模式：`[\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*`  
必要：否

 ** [StreamARN](#API_UpdateStream_RequestSyntax) **   <a name="KinesisVideo-UpdateStream-request-StreamARN"></a>
您要更新其中繼資料之串流的 ARN。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_UpdateStream_RequestSyntax) **   <a name="KinesisVideo-UpdateStream-request-StreamName"></a>
您要更新其中繼資料的串流名稱。  
串流名稱是串流的識別符，而且每個帳戶和區域都必須是唯一的。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_UpdateStream_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_UpdateStream_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_UpdateStream_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
發起人無權執行此操作。  
HTTP 狀態碼：401

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

1. 用於判斷串流指定頻道所對應的 `DescribeMediaStorageConfiguration` API。

1. 用於判斷指定串流所對應的頻道的 `DescribeMappedResourceConfiguration` API。

1. 用於判斷資源狀態的 `DescribeStream`或 `DescribeSignalingChannel` API。
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

 ** VersionMismatchException **   
您指定的串流版本不是最新版本。若要取得最新版本，請使用 [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html) API。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_UpdateStream_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateStream) 

# UpdateStreamStorageConfiguration
<a name="API_UpdateStreamStorageConfiguration"></a>

更新現有 Kinesis 影片串流的儲存組態。

此操作可讓您修改串流的儲存層設定，讓您根據存取模式最佳化儲存成本和效能。

 `UpdateStreamStorageConfiguration` 是一種非同步操作。

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

## 請求語法
<a name="API_UpdateStreamStorageConfiguration_RequestSyntax"></a>

```
POST /updateStreamStorageConfiguration HTTP/1.1
Content-type: application/json

{
   "CurrentVersion": "string",
   "StreamARN": "string",
   "StreamName": "string",
   "StreamStorageConfiguration": { 
      "DefaultStorageTier": "string"
   }
}
```

## URI 請求參數
<a name="API_UpdateStreamStorageConfiguration_RequestParameters"></a>

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

## 請求主體
<a name="API_UpdateStreamStorageConfiguration_RequestBody"></a>

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

 ** [CurrentVersion](#API_UpdateStreamStorageConfiguration_RequestSyntax) **   <a name="KinesisVideo-UpdateStreamStorageConfiguration-request-CurrentVersion"></a>
您要變更其儲存組態的串流版本。若要取得 版本，請呼叫 `DescribeStream`或 `ListStreams` API。  
類型：字串  
長度限制：長度下限為 1。長度上限為 64。  
模式：`[a-zA-Z0-9]+`  
必要：是

 ** [StreamARN](#API_UpdateStreamStorageConfiguration_RequestSyntax) **   <a name="KinesisVideo-UpdateStreamStorageConfiguration-request-StreamARN"></a>
您要更新儲存體組態之串流的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_UpdateStreamStorageConfiguration_RequestSyntax) **   <a name="KinesisVideo-UpdateStreamStorageConfiguration-request-StreamName"></a>
您要更新儲存體組態的串流名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

 ** [StreamStorageConfiguration](#API_UpdateStreamStorageConfiguration_RequestSyntax) **   <a name="KinesisVideo-UpdateStreamStorageConfiguration-request-StreamStorageConfiguration"></a>
串流的新儲存組態。這包括預設儲存層，可決定串流資料的儲存和存取方式。  
不同的儲存層提供不同層級的效能和成本最佳化，以符合您的特定使用案例需求。  
類型：[StreamStorageConfiguration](API_StreamStorageConfiguration.md) 物件  
必要：是

## 回應語法
<a name="API_UpdateStreamStorageConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_UpdateStreamStorageConfiguration_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_UpdateStreamStorageConfiguration_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

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

1. 用於判斷串流指定頻道所對應的 `DescribeMediaStorageConfiguration` API。

1. 用於判斷指定串流所對應的頻道的 `DescribeMappedResourceConfiguration` API。

1. 用於判斷資源狀態的 `DescribeStream`或 `DescribeSignalingChannel` API。
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

 ** VersionMismatchException **   
您指定的串流版本不是最新版本。若要取得最新版本，請使用 [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html) API。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_UpdateStreamStorageConfiguration_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) 

# Amazon Kinesis Video Streams 媒體
<a name="API_Operations_Amazon_Kinesis_Video_Streams_Media"></a>

Amazon Kinesis Video Streams Media 支援下列動作：
+  [GetMedia](API_dataplane_GetMedia.md) 
+  [PutMedia](API_dataplane_PutMedia.md) 

# GetMedia
<a name="API_dataplane_GetMedia"></a>

 使用此 API 從 Kinesis 影片串流擷取媒體內容。在請求中，您可以識別串流名稱或串流 Amazon Resource Name (ARN) 和起始區塊。然後，Kinesis Video Streams 會依片段編號依序傳回區塊串流。

**注意**  
您必須先呼叫 `GetDataEndpoint` API 才能取得端點。然後使用 [--endpoint-url 參數](https://docs.aws.amazon.com/cli/latest/reference/)將`GetMedia`請求傳送至此端點。

當您將媒體資料 （片段） 放在串流上時，Kinesis Video Streams 會將每個傳入片段和相關中繼資料儲存在稱為「區塊」的內容中。如需詳細資訊，請參閱 [PutMedia](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html)。`GetMedia` API 會從您在請求中指定的區塊開始傳回這些區塊的串流。

`GetMedia` API 旨在透過長時間執行的連線做為串流 API 運作。它不適用於以傳統 RESTful 方式使用，其中會為每個片段建立新的 HTTP 連線並關閉。當您叫用 `GetMedia` API 時，Kinesis Video Streams 會使用 HTTP 區塊傳輸編碼，透過持久性長時間執行的連線持續交付片段。

使用 `GetMedia` API 時適用下列限制：
+ 用戶端每秒可以呼叫每個串流`GetMedia`最多五次。
+ Kinesis Video Streams 會在`GetMedia`工作階段期間以每秒高達 25 MB （或每秒 200 MB) 的速率傳送媒體資料。
**注意**  
使用 `GetMedia`做為串流長時間執行的連線，擷取單一持久性連線中的多個片段。請勿在建立和關閉每個片段的新 HTTP 連線時，以傳統 RESTful 方式使用 `GetMedia` API。如果您嘗試三個以上的並行`GetMedia`連線，Kinesis Video Streams 會使用`ConnectionLimitExceededException`錯誤調節最新的連線。

**注意**  
`GetMedia` HTTP 回應狀態碼會立即傳回，但如果沒有可供播放的擷取片段，則讀取 HTTP 回應承載會在 3 秒後逾時。

**注意**  
如果在叫用 Kinesis Video Streams 媒體 API 後擲出錯誤，除了 HTTP 狀態碼和回應內文之外，還包含下列資訊：  
 `x-amz-ErrorType` HTTP 標頭 – 除了 HTTP 狀態碼提供的內容之外，還包含更具體的錯誤類型。
 `x-amz-RequestId` HTTP 標頭 – 如果您想要向 回報問題 AWS，支援團隊可以在指定請求 ID 時更好地診斷問題。
HTTP 狀態碼和 ErrorType 標頭都可以用來對錯誤是否可重試以及在何種條件下進行程式設計決策，並提供用戶端程式設計人員可能需要採取的動作的相關資訊，以便成功重試。  
如需詳細資訊，請參閱本主題底部的**錯誤**區段，以及[常見錯誤](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html)。

## 請求語法
<a name="API_dataplane_GetMedia_RequestSyntax"></a>

```
POST /getMedia HTTP/1.1
Content-type: application/json

{
   "StartSelector": { 
      "AfterFragmentNumber": "string",
      "ContinuationToken": "string",
      "StartSelectorType": "string",
      "StartTimestamp": number
   },
   "StreamARN": "string",
   "StreamName": "string"
}
```

## URI 請求參數
<a name="API_dataplane_GetMedia_RequestParameters"></a>

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

## 請求主體
<a name="API_dataplane_GetMedia_RequestBody"></a>

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

 ** [StartSelector](#API_dataplane_GetMedia_RequestSyntax) **   <a name="KinesisVideo-dataplane_GetMedia-request-StartSelector"></a>
識別要從指定串流取得的起始區塊。  
類型：[StartSelector](API_dataplane_StartSelector.md) 物件  
必要：是

 ** [StreamARN](#API_dataplane_GetMedia_RequestSyntax) **   <a name="KinesisVideo-dataplane_GetMedia-request-StreamARN"></a>
您想要從中取得媒體內容的串流 ARN。如果您未指定 `streamARN`，則必須指定 `streamName`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_dataplane_GetMedia_RequestSyntax) **   <a name="KinesisVideo-dataplane_GetMedia-request-StreamName"></a>
您要從中取得媒體內容的 Kinesis 影片串流名稱。如果您未指定 `streamName`，則必須指定 `streamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_dataplane_GetMedia_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-Type: ContentType

Payload
```

## 回應元素
<a name="API_dataplane_GetMedia_ResponseElements"></a>

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

回應會傳回下列 HTTP 標頭。

 ** [ContentType](#API_dataplane_GetMedia_ResponseSyntax) **   <a name="KinesisVideo-dataplane_GetMedia-response-ContentType"></a>
所請求媒體的內容類型。  
長度限制：長度下限為 1。長度上限為 128。  
模式：`^[a-zA-Z0-9_\.\-]+$`

回應傳回以下內容作為 HTTP 主體。

 ** [Payload](#API_dataplane_GetMedia_ResponseSyntax) **   <a name="KinesisVideo-dataplane_GetMedia-response-Payload"></a>
 承載 Kinesis Video Streams 傳回是來自指定串流的一系列區塊。如需區塊的詳細資訊，請參閱 [PutMedia](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html)。Kinesis Video Streams 在`GetMedia`呼叫中傳回的區塊也包含下列額外的 Matroska (MKV) 標籤：  
+ AWS\$1KINESISVIDEO\$1CONTINUATION\$1TOKEN (UTF-8 字串） - 如果您的`GetMedia`呼叫終止，您可以在下一個請求中使用此接續字符，以取得最後一個請求終止的下一個區塊。
+ AWS\$1KINESISVIDEO\$1MILLIS\$1BEHIND\$1NOW (UTF-8 字串） - 用戶端應用程式可以使用此標籤值來判斷回應中傳回的區塊落後於串流上最新區塊的程度。
+ AWS\$1KINESISVIDEO\$1FRAGMENT\$1NUMBER - 區塊中傳回的片段編號。
+ AWS\$1KINESISVIDEO\$1SERVER\$1TIMESTAMP - 片段的伺服器時間戳記。
+ AWS\$1KINESISVIDEO\$1PRODUCER\$1TIMESTAMP - 片段的生產者時間戳記。
如果發生錯誤，將出現下列標籤：  
+ AWS\$1KINESISVIDEO\$1ERROR\$1CODE - 導致 GetMedia 停止之錯誤的字串描述。
+ AWS\$1KINESISVIDEO\$1ERROR\$1ID：錯誤整數代碼。
錯誤代碼如下所示：  
+ 3002 - 寫入串流時發生錯誤
+ 4000 - 找不到請求的片段
+ 4500 - 拒絕存取串流的 KMS 金鑰
+ 4501 - 串流的 KMS 金鑰已停用
+ 4502 - 串流 KMS 金鑰上的驗證錯誤
+ 4503 - 串流中指定的 KMS 金鑰無法使用
+ 4504 - 串流中指定的 KMS 金鑰使用無效
+ 4505 - 串流中指定的 KMS 金鑰狀態無效
+ 4506 - 找不到串流中指定的 KMS 金鑰
+ 5000 - 內部錯誤

## 錯誤
<a name="API_dataplane_GetMedia_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** ConnectionLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端連線限制。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** InvalidEndpointException **   
來電者使用錯誤的端點將資料寫入串流。收到這類例外狀況時，使用者必須呼叫 `GetDataEndpoint`，並將 `APIName`設定為 `PUT_MEDIA` ，並使用 回應中的端點來叫用下一個`PutMedia`呼叫。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
發起人無權對指定的串流執行 操作，或權杖已過期。  
HTTP 狀態碼：401

 ** ResourceNotFoundException **   
狀態碼：404，具有指定名稱的串流不存在。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_dataplane_GetMedia_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-data-2017-09-30/GetMedia) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-data-2017-09-30/GetMedia) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-data-2017-09-30/GetMedia) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-data-2017-09-30/GetMedia) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-data-2017-09-30/GetMedia) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-data-2017-09-30/GetMedia) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-data-2017-09-30/GetMedia) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-data-2017-09-30/GetMedia) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesis-video-data-2017-09-30/GetMedia) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-data-2017-09-30/GetMedia) 

# PutMedia
<a name="API_dataplane_PutMedia"></a>

 使用此 API 將媒體資料傳送至 Kinesis 影片串流。

**注意**  
您必須先呼叫 `GetDataEndpoint` API 才能取得端點。然後使用 [--endpoint-url 參數](https://docs.aws.amazon.com/cli/latest/reference/)將`PutMedia`請求傳送至此端點。

在請求中，您可以使用 HTTP 標頭來提供參數資訊，例如串流名稱、時間戳記，以及時間戳記值是絕對值還是相對於生產者開始記錄的時間。您可以使用請求內文來傳送媒體資料。Kinesis Video Streams 僅支援使用此 API 傳送媒體資料的 Matroska (MKV) 容器格式。

您可以透過下列選項使用此 API 傳送資料：
+ 即時傳送媒體資料：例如，安全攝影機可以在產生影格時即時傳送影格。此方法可將視訊錄製與線路上傳送的資料之間的延遲降至最低。這稱為連續生產者。在這種情況下，消費者應用程式可以即時或在需要時讀取串流。
+ 離線傳送媒體資料 （分批傳送）：例如，主體攝影機可能會錄製影片數小時，並將其存放在裝置上。稍後，當您將攝影機連接到停駐連接埠時，攝影機可以啟動`PutMedia`工作階段，將資料傳送至 Kinesis 影片串流。在此案例中，延遲不是問題。

使用此 API 時，請注意下列考量事項：
+ 您必須指定 `streamName` 或 `streamARN`，但不能同時指定兩者。
+ 若要能夠在主控台或透過 HLS 播放媒體，每個片段的音軌 1 應該包含 h.264 編碼的視訊、片段中繼資料中的 CodecID 應該是「V\$1MPEG/ISO/AVC」，而片段中繼資料應該包含 AVCC 格式的 h.264 轉碼器私有資料。或者，每個片段的軌道 2 應該包含 AAC 編碼音訊，片段中繼資料中的 CodecID 應該是 "A\$1AAC"，而片段中繼資料應該包含 AAC 轉碼器私有資料。
+ `PutMedia` API 旨在透過長時間執行的連線做為串流 API 運作。它不適用於以傳統 RESTful 方式使用，其中會為每個片段建立新的 HTTP 連線並關閉。使用 `PutMedia` API 時，請使用 HTTP 區塊傳輸編碼，透過持久性連線持續傳送片段。
+ 對於`PutMedia`工作階段中接收的每個片段，Kinesis Video Streams 會傳送一或多個認可。潛在的用戶端網路考量可能會導致您無法在產生所有這些確認時取得這些確認。
**注意**  
使用 `PutMedia`做為串流長時間執行的連線，在單一持久性連線中傳送多個片段。如果您嘗試多個並行`PutMedia`連線，Kinesis Video Streams 會調節`ConnectionLimitExceededException`發生錯誤的最新連線。

使用 `PutMedia` API 時適用下列限制：
+ 用戶端每秒可以呼叫每個串流`PutMedia`最多五次。
+ 用戶端每秒每個串流最多可傳送五個片段。
+ Kinesis Video Streams 會在`PutMedia`工作階段期間以高達 12.5 MB/秒或 100 Mbps 的速率讀取媒體資料。

請注意下列限制條件。在這些情況下，Kinesis Video Streams 會在回應中傳送錯誤確認。
+ 不允許時間代碼範圍超過允許上限且包含超過 50 MB 資料的片段。
+ 不允許包含超過三個軌跡的片段。每個片段中的每個影格都必須具有與片段標頭中定義的其中一個軌跡相同的軌跡編號。此外，每個片段在片段標頭中定義的每個軌道必須至少包含一個影格。
+ 對於片段中繼資料中定義的每個軌跡，每個片段必須至少包含一個影格。
+ 片段中最早的影格時間戳記必須在前一個片段中的最新影格時間戳記之後。
+ 包含多個 MKV 區段或包含不允許 MKV 元素 （例如 `track*`) 的 MKV 串流也會導致錯誤確認。

Kinesis Video Streams 會將每個傳入片段和相關中繼資料存放在稱為「區塊」的 中。片段中繼資料包括下列項目：
+ `PutMedia` 請求開始時提供的 MKV 標頭
+ 片段的下列 Kinesis Video Streams 特定中繼資料：
  +  `server_timestamp` - Kinesis Video Streams 開始接收片段時的時間戳記。
  +  `producer_timestamp` - 生產者開始記錄片段時的時間戳記。Kinesis Video Streams 使用請求中接收的三個資訊來計算此值。
    + 請求內文中接收的片段時間碼值以及片段。
    + 兩個請求標頭： `producerStartTimestamp` （生產者開始記錄時） 和 `fragmentTimeCodeType`（承載中的片段時間碼是絕對還是相對）。

    Kinesis Video Streams 接著會運算片段`producer_timestamp`的 ，如下所示：

     如果 `fragmentTimeCodeType` 是相對的，則 

     `producer_timestamp` = `producerStartTimeStamp` \$1 片段時間碼 

    如果 `fragmentTimeCodeType` 是絕對值，則 

     `producer_timestamp` = 片段時間碼 （轉換為毫秒）
  + Kinesis Video Streams 指派的唯一片段編號。

  

**注意**  
 當您提出`GetMedia`請求時，Kinesis Video Streams 會傳回這些區塊的串流。用戶端可以視需要處理中繼資料。

**注意**  
此操作僅適用於適用於 Java 的 AWS 開發套件。其他語言不支援 AWS SDKs。

**注意**  
Kinesis Video Streams 不會在透過 PutMedia API 擷取和封存期間剖析和驗證轉碼器私有資料。KVS 透過 HLS APIs 使用串流時，會從 MPEG-TS 和 MP4 片段封裝的編解碼器私有資料擷取並驗證必要資訊。

**注意**  
如果叫用 Kinesis Video Streams 媒體 API 後擲出錯誤，除了 HTTP 狀態碼和回應內文之外，還包含下列資訊：  
 `x-amz-ErrorType` HTTP 標頭 – 除了 HTTP 狀態碼提供的內容之外，還包含更具體的錯誤類型。
 `x-amz-RequestId` HTTP 標頭 – 如果您想要向 回報問題 AWS，支援團隊可以在指定請求 ID 時更好地診斷問題。
HTTP 狀態碼和 ErrorType 標頭都可以用來對錯誤是否可以重試和在何種條件下進行程式設計決策，並提供用戶端程式設計人員可能需要採取的動作的相關資訊，以便成功重試。  
如需詳細資訊，請參閱本主題底部的**錯誤**區段，以及[常見錯誤](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html)。

## 請求語法
<a name="API_dataplane_PutMedia_RequestSyntax"></a>

```
POST /putMedia HTTP/1.1
x-amzn-stream-name: StreamName
x-amzn-stream-arn: StreamARN
x-amzn-fragment-timecode-type: FragmentTimecodeType
x-amzn-producer-start-timestamp: ProducerStartTimestamp

Payload
```

## URI 請求參數
<a name="API_dataplane_PutMedia_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [FragmentTimecodeType](#API_dataplane_PutMedia_RequestSyntax) **   <a name="KinesisVideo-dataplane_PutMedia-request-FragmentTimecodeType"></a>
您可以將此值傳遞為 `x-amzn-fragment-timecode-type` HTTP 標頭。  
指出片段中的時間碼 （承載、HTTP 請求內文） 是絕對還是相對於 `producerStartTimestamp`。Kinesis Video Streams 會使用此資訊來計算請求中接收`producer_timestamp`之片段的 ，如 API 概觀中所述。  
有效值:`ABSOLUTE | RELATIVE`   
必要：是

 ** [ProducerStartTimestamp](#API_dataplane_PutMedia_RequestSyntax) **   <a name="KinesisVideo-dataplane_PutMedia-request-ProducerStartTimestamp"></a>
您會將此值傳遞為 `x-amzn-producer-start-timestamp` HTTP 標頭。  
這是生產者開始記錄媒體的生產者時間戳記 （而非請求中特定片段的時間戳記）。

 ** [StreamARN](#API_dataplane_PutMedia_RequestSyntax) **   <a name="KinesisVideo-dataplane_PutMedia-request-StreamARN"></a>
您可以將此值傳遞為 `x-amzn-stream-arn` HTTP 標頭。  
您要寫入媒體內容之 Kinesis 影片串流的 Amazon Resource Name (ARN)。如果您未指定 `streamARN`，則必須指定 `streamName`。  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`

 ** [StreamName](#API_dataplane_PutMedia_RequestSyntax) **   <a name="KinesisVideo-dataplane_PutMedia-request-StreamName"></a>
您可以將此值傳遞為 `x-amzn-stream-name` HTTP 標頭。  
您要寫入媒體內容的 Kinesis 影片串流名稱。如果您未指定 `streamName`，則必須指定 `streamARN`。  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`

## 請求主體
<a name="API_dataplane_PutMedia_RequestBody"></a>

請求接受下列二進位資料。

 ** [Payload](#API_dataplane_PutMedia_RequestSyntax) **   <a name="KinesisVideo-dataplane_PutMedia-request-Payload"></a>
 要寫入 Kinesis 影片串流的媒體內容。在目前的實作中，Kinesis Video Streams 僅支援具有單一 MKV 區段的 Matroska (MKV) 容器格式。區段可以包含一或多個叢集。  
每個 MKV 叢集都會映射至 Kinesis 影片串流片段。無論您選擇哪個叢集持續時間，都會成為片段持續時間。

## 回應語法
<a name="API_dataplane_PutMedia_ResponseSyntax"></a>

```
HTTP/1.1 200

Payload
```

## 回應元素
<a name="API_dataplane_PutMedia_ResponseElements"></a>

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

回應傳回以下內容作為 HTTP 主體。

 ** [Payload](#API_dataplane_PutMedia_ResponseSyntax) **   <a name="KinesisVideo-dataplane_PutMedia-response-Payload"></a>
 Kinesis Video Streams 成功收到`PutMedia`請求後，服務會驗證請求標頭。然後，服務會開始讀取承載，並先傳送 HTTP 200 回應。  
然後，服務會傳回串流，其中包含一系列以換行分隔的 JSON 物件 (`Acknowledgement` 物件）。在傳送媒體資料的相同連線上收到確認。`PutMedia` 請求可以有許多確認。每個 都`Acknowledgement`包含下列鍵/值對：  
+  `AckEventType` - 確認所代表的事件類型。
  +  **緩衝：**Kinesis Video Streams 已開始接收片段。Kinesis Video Streams 會在收到第一個片段資料位元組時傳送第一個緩衝認可。
  +  **已接收：**Kinesis Video Streams 收到整個片段。如果您未將串流設定為保留資料，生產者可以在收到此確認後停止緩衝片段。
  +  **持久性：**Kinesis Video Streams 已保留片段 （例如 Amazon S3)。如果您將串流設定為保留資料，則會收到此確認。收到此確認後，生產者可以停止緩衝片段。
  +  **錯誤：**Kinesis Video Streams 在處理片段時發生錯誤。您可以檢閱錯誤代碼，並判斷下一個動作。
  +  **閒置：**`PutMedia`工作階段正在進行中。不過，Kinesis Video Streams 目前未接收資料。Kinesis Video Streams 會在最後一次接收資料後最多 30 秒內定期傳送此認可。如果在 30 秒內未收到任何資料，Kinesis Video Streams 會關閉請求。
**注意**  
 此認可可協助生產者判斷`PutMedia`連線是否有效，即使它未傳送任何資料也一樣。
+  `FragmentTimecode` - 傳送確認的片段時間碼。

  如果 `AckEventType`為**閒置**，則元素可能會遺失。
+  `FragmentNumber` - 傳送確認的 Kinesis Video Streams 產生的片段編號。
+  `ErrorId` 和 `ErrorCode` - 如果 `AckEventType`是 `Error`，則此欄位會提供對應的錯誤代碼。以下是錯誤 IDs及其對應的錯誤代碼和錯誤訊息清單：
  + 4000 - STREAM\$1READ\$1ERROR - 讀取資料串流時發生錯誤。
  + 4001 - MAX\$1FRAGMENT\$1SIZE\$1REACHED - 片段大小大於上限，允許 50 MB。
  + 4002 - MAX\$1FRAGMENT\$1DURATION\$1REACHED - 片段持續時間大於允許的上限。
  + 4003 - MAX\$1CONNECTION\$1DURATION\$1REACHED - 連線持續時間大於允許的閾值上限。
  + 4004 - FRAGMENT\$1TIMECODE\$1LESSER\$1THAN\$1PREVIOUS - 片段時間碼小於先前時間碼的時間碼 （在`PutMedia`通話中，您無法依序傳送片段）。
  + 4005 - more\$1THAN\$1ALLOWED\$1TRACKS\$1FOUND - 在 MKV 中找到多個軌道。（已棄用）
  + 4006 - INVALID\$1MKV\$1DATA - 無法將輸入串流剖析為有效的 MKV 格式。
  + 4007 - INVALID\$1PRODUCER\$1TIMESTAMP - 無效的生產者時間戳記。
  + 4008 - STREAM\$1NOT\$1ACTIVE - 串流不再存在 （已刪除）。
  + 4009 - FRAGMENT\$1METADATA\$1LIMIT\$1REACHED - 已達到片段中繼資料限制。請參閱 開發人員指南的限制[https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html)一節。
  + 4010 - TRACK\$1NUMBER\$1MISMATCH - MKV 影格中的軌跡編號與 MKV 標頭中的軌跡不相符。
  + 4011 - FRAMES\$1MISSING\$1FOR\$1TRACK - 片段不包含 MKV 標頭中至少一個軌道的任何影格。
  + 4012 - INVALID\$1FRAGMENT\$1METADATA - 片段中繼資料名稱不能以字串 開頭` AWS_`。
  + 4500 - KMS\$1KEY\$1ACCESS\$1DENIED - 拒絕存取串流指定的 KMS 金鑰。
  + 4501 - KMS\$1KEY\$1DISABLED - 串流指定的 KMS 金鑰已停用。
  + 4502 - KMS\$1KEY\$1VALIDATION\$1ERROR - 串流指定的 KMS 金鑰驗證失敗。
  + 4503 - KMS\$1KEY\$1UNAVAILABLE - 串流指定的 KMS 金鑰無法使用。
  + 4504 - KMS\$1KEY\$1INVALID\$1USAGE - 串流指定 KMS 金鑰的使用無效。
  + 4505 - KMS\$1KEY\$1INVALID\$1STATE - 串流指定的 KMS 金鑰處於無效狀態。
  + 4506 - KMS\$1KEY\$1NOT\$1FOUND - 找不到串流指定的 KMS 金鑰。
  + 5000 - INTERNAL\$1ERROR - 內部服務錯誤。
  + 5001 - ARCHIVAL\$1ERROR - Kinesis Video Streams 無法將片段保留到資料存放區。
生產者在傳送長時間執行`PutMedia`請求的承載時，應讀取回應以進行確認。由於在中繼代理伺服器上緩衝，生產者可能會同時收到確認區塊。想要接收及時確認的生產者可以在每個`PutMedia`請求中傳送較少的片段。

## 錯誤
<a name="API_dataplane_PutMedia_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** ConnectionLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端連線限制。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** InvalidEndpointException **   
來電者使用錯誤的端點將資料寫入串流。收到這類例外狀況時，使用者必須呼叫 `GetDataEndpoint`，並將 `APIName`設定為 `PUT_MEDIA` ，並使用 回應中的端點來叫用下一個`PutMedia`呼叫。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
發起人無權對指定的串流執行 操作，或權杖已過期。  
HTTP 狀態碼：401

 ** ResourceNotFoundException **   
狀態碼：404，具有指定名稱的串流不存在。  
HTTP 狀態碼：404

## 範例
<a name="API_dataplane_PutMedia_Examples"></a>

### 確認格式
<a name="API_dataplane_PutMedia_Example_1"></a>

確認的格式如下：

```
{
       Acknowledgement : {
          "EventType": enum
          "FragmentTimecode": Long,
          "FragmentNumber": Long,
          "ErrorId" : String       
      }
}
```

## 另請參閱
<a name="API_dataplane_PutMedia_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-data-2017-09-30/PutMedia) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-data-2017-09-30/PutMedia) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-data-2017-09-30/PutMedia) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-data-2017-09-30/PutMedia) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-data-2017-09-30/PutMedia) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-data-2017-09-30/PutMedia) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-data-2017-09-30/PutMedia) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-data-2017-09-30/PutMedia) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesis-video-data-2017-09-30/PutMedia) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-data-2017-09-30/PutMedia) 

# Amazon Kinesis Video Streams 封存媒體
<a name="API_Operations_Amazon_Kinesis_Video_Streams_Archived_Media"></a>

Amazon Kinesis Video Streams Archived Media 支援下列動作：
+  [GetClip](API_reader_GetClip.md) 
+  [GetDASHStreamingSessionURL](API_reader_GetDASHStreamingSessionURL.md) 
+  [GetHLSStreamingSessionURL](API_reader_GetHLSStreamingSessionURL.md) 
+  [GetImages](API_reader_GetImages.md) 
+  [GetMediaForFragmentList](API_reader_GetMediaForFragmentList.md) 
+  [ListFragments](API_reader_ListFragments.md) 

# GetClip
<a name="API_reader_GetClip"></a>

在指定的時間範圍內，從指定的影片串流下載包含封存隨需媒體的 MP4 檔案 (clip)。

StreamName 和 StreamARN 參數都是選用的，但您必須在叫用此 API 操作時指定 StreamName 或 StreamARN。

**注意**  
您必須先呼叫 `GetDataEndpoint` API 才能取得端點。然後使用 [--endpoint-url 參數](https://docs.aws.amazon.com/cli/latest/reference/)將`GetClip`請求傳送至此端點。

Amazon Kinesis 影片串流對於透過 MP4 提供資料有下列需求：
+  [影片播放軌跡需求](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html)。
+ 資料保留必須大於 0。
+ 每個片段的影片軌道必須針對視訊媒體的 H.264 格式的進階視訊編碼 (AVC)，以及針對 H.265 格式的 HEVC 中包含轉碼器私有資料。如需詳細資訊，請參閱 [MPEG-4 specification ISO/IEC 14496-15](https://www.iso.org/standard/55980.html)。如需將串流資料轉換為特定格式的相關資訊，請參閱 [NAL Adaptation Flags](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html)。
+ 每個片段的音訊軌道 (如果有) 必須包含 AAC 格式的編碼器私有資料 ([AAC 規格 ISO/IEC 13818-7](https://www.iso.org/standard/43345.html)) 或 [MS Wave 格式](https://www.mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html)。

您可以透過監控 Amazon CloudWatch `GetClip.OutgoingBytes` 指標來監控傳出資料的數量。如需有關使用 CloudWatch 監控 Kinesis Video Streams 的資訊，請參閱[監控 Kinesis Video Streams](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html)。如需定價資訊，請參閱 [Amazon Kinesis Video Streams 定價](https://aws.amazon.com/kinesis/video-streams/pricing/)和[AWS 定價](https://aws.amazon.com/pricing/)。需支付傳出 AWS 資料的費用。

**重要**  
每個片段中包含的轉碼器私有資料 (CPD) 包含轉碼器特定的初始化資訊，例如影格速率、解析度和編碼描述檔，這些是正確解碼片段的必要資訊。結果剪輯的目標片段之間不支援 CPD 變更。CPD 必須透過查詢的媒體保持一致，否則將會傳回錯誤。

**重要**  
不支援追蹤變更。追蹤在整個查詢媒體中必須保持一致。如果串流中的片段從只有視訊變更為同時擁有音訊和視訊，或 AAC 音軌變更為 A-Law 音軌，則會傳回錯誤。

## 請求語法
<a name="API_reader_GetClip_RequestSyntax"></a>

```
POST /getClip HTTP/1.1
Content-type: application/json

{
   "ClipFragmentSelector": { 
      "FragmentSelectorType": "string",
      "TimestampRange": { 
         "EndTimestamp": number,
         "StartTimestamp": number
      }
   },
   "StreamARN": "string",
   "StreamName": "string"
}
```

## URI 請求參數
<a name="API_reader_GetClip_RequestParameters"></a>

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

## 請求主體
<a name="API_reader_GetClip_RequestBody"></a>

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

 ** [ClipFragmentSelector](#API_reader_GetClip_RequestSyntax) **   <a name="KinesisVideo-reader_GetClip-request-ClipFragmentSelector"></a>
所請求剪輯的時間範圍和時間戳記的來源。  
類型：[ClipFragmentSelector](API_reader_ClipFragmentSelector.md) 物件  
必要：是

 ** [StreamARN](#API_reader_GetClip_RequestSyntax) **   <a name="KinesisVideo-reader_GetClip-request-StreamARN"></a>
要擷取媒體剪輯之串流的 Amazon Resource Name (ARN)。  
您必須指定 StreamName 或 StreamARN。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_reader_GetClip_RequestSyntax) **   <a name="KinesisVideo-reader_GetClip-request-StreamName"></a>
要擷取媒體剪輯的串流名稱。  
您必須指定 StreamName 或 StreamARN。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_reader_GetClip_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-Type: ContentType

Payload
```

## 回應元素
<a name="API_reader_GetClip_ResponseElements"></a>

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

回應會傳回下列 HTTP 標頭。

 ** [ContentType](#API_reader_GetClip_ResponseSyntax) **   <a name="KinesisVideo-reader_GetClip-response-ContentType"></a>
所請求剪輯中媒體的內容類型。  
長度限制：長度下限為 1。長度上限為 128。  
模式：`^[a-zA-Z0-9_\.\-]+$`

回應傳回以下內容作為 HTTP 主體。

 ** [Payload](#API_reader_GetClip_ResponseSyntax) **   <a name="KinesisVideo-reader_GetClip-response-Payload"></a>
傳統 MP4 檔案，其中包含來自指定影片串流的媒體剪輯。輸出將包含來自指定開始時間戳記的前 100 MB 或前 200 個片段。如需詳細資訊，請參閱 [Kinesis Video Streams 配額](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html)。

## 錯誤
<a name="API_reader_GetClip_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過限制。稍後嘗試撥打電話。如需限制的相關資訊，請參閱 [Kinesis Video Streams 配額](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html)。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
指定的參數超過其限制、不支援或無法使用。  
HTTP 狀態碼：400

 ** InvalidCodecPrivateDataException **   
影片串流中至少一個軌跡中的轉碼器私有資料對此操作無效。  
HTTP 狀態碼：400

 ** InvalidMediaFrameException **   
無法根據指定的轉碼器剖析所請求剪輯中的一或多個影格。  
HTTP 狀態碼：400

 ** MissingCodecPrivateDataException **   
在影片串流的至少一個軌跡中找不到轉碼器私有資料。  
HTTP 狀態碼：400

 ** NoDataRetentionException **   
 `GetImages` 請求的串流不會保留資料 （也就是 `DataRetentionInHours`的 為 0)。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
狀態碼：403，呼叫者未獲授權在指定的串流上執行 操作，或權杖已過期。  
HTTP 狀態碼：401

 ** ResourceNotFoundException **   
 `GetImages` 當 Kinesis Video Streams 找不到您指定的串流時， 會擲回此錯誤。  
 `GetHLSStreamingSessionURL` 如果`LIVE_REPLAY`請求具有 `ON_DEMAND`或 `PlaybackMode`的工作階段的串流在請求的時間範圍內沒有片段，或者請求具有 `PlaybackMode` 的工作階段的串流在過去 30 秒內沒有片段，`LIVE`則`GetDASHStreamingSessionURL`擲回此錯誤。  
HTTP 狀態碼：404

 ** UnsupportedStreamMediaTypeException **   
媒體類型 （例如 h.264 或 h.265 視訊或 AAC 或 G.711 音訊） 無法從播放工作階段第一個片段中軌道的編解碼器 IDs 決定。軌道 1 的轉碼器 ID 應該是 ，`V_MPEG/ISO/AVC`並且可選地，軌道 2 的轉碼器 ID 應該是 `A_AAC`。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_reader_GetClip_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-reader-data-2017-09-30/GetClip) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/GetClip) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/GetClip) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/GetClip) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/GetClip) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetClip) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/GetClip) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/GetClip) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/GetClip) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/GetClip) 

# GetDASHStreamingSessionURL
<a name="API_reader_GetDASHStreamingSessionURL"></a>

擷取串流的 MPEG 動態自適應串流透過 HTTP (DASH) URL。然後，您可以在媒體播放器中開啟 URL 以檢視串流內容。

`StreamName` 和 `StreamARN` 參數都是選用的，但您必須在叫用此 API 操作`StreamARN`時指定 `StreamName`或 。

Amazon Kinesis 影片串流對於透過 MPEG-DASH 提供資料有下列需求：
+  [影片播放軌跡需求](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html)。
+ 資料保留必須大於 0。
+ 每個片段的影片軌道必須針對視訊媒體的 H.264 格式的進階視訊編碼 (AVC)，以及針對 H.265 格式的 HEVC 中包含轉碼器私有資料。如需詳細資訊，請參閱 [MPEG-4 specification ISO/IEC 14496-15](https://www.iso.org/standard/55980.html)。如需將串流資料轉換為特定格式的相關資訊，請參閱 [NAL Adaptation Flags](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html)。
+ 每個片段的音訊軌道 (如果有) 必須包含 AAC 格式的編碼器私有資料 ([AAC 規格 ISO/IEC 13818-7](https://www.iso.org/standard/43345.html)) 或 [MS Wave 格式](https://www.mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html)。

下列程序說明如何搭配 Kinesis Video Streams 使用 MPEG-DASH：

1. 呼叫 `GetDataEndpoint` API 以取得端點。然後使用 [--endpoint-url 參數](https://docs.aws.amazon.com/cli/latest/reference/)將`GetDASHStreamingSessionURL`請求傳送至此端點。

1. 使用 擷取 MPEG-DASH URL`GetDASHStreamingSessionURL`。Kinesis Video Streams 會建立 MPEG-DASH 串流工作階段，用於使用 MPEG-DASH 通訊協定存取串流中的內容。 `GetDASHStreamingSessionURL`會傳回工作階段 MPEG-DASH *資訊清單* （使用 MPEG-DASH 串流所需的根資源） 的已驗證 URL （包括加密工作階段字符）。
**注意**  
不要在未經授權的實體可以存取它的地方共用或存放此字符。權杖可讓您存取串流的內容。使用與 AWS 登入資料搭配使用的相同量值來保護字符。

   透過資訊清單提供的媒體僅包含請求的串流、時間範圍和格式。不提供其他媒體資料 （例如請求視窗外的影格或替代位元速率）。

1. 將 MPEG-DASH 資訊清單的 URL （包含加密的工作階段字符） 提供給支援 MPEG-DASH 通訊協定的媒體播放器。Kinesis Video Streams 透過資訊清單 URL 提供初始化片段和媒體片段。初始化片段包含串流的轉碼器私有資料，以及設定視訊或音訊解碼器和轉譯器所需的其他資料。媒體片段包含編碼的影片影格或編碼的音訊範例。

1. 媒體播放器會正常接收已驗證的 URL 並請求串流中繼資料和媒體資料。當媒體播放器請求資料時，它會呼叫下列動作：
   +  **GetDASHManifest：**擷取 MPEG DASH 資訊清單，其中包含您要播放之媒體的中繼資料。
   +  **GetMP4InitFragment：**擷取 MP4 初始化片段。媒體播放器通常會先載入初始化片段，再載入任何媒體片段。此片段包含「`fytp`」和「`moov`」MP4 原子，以及初始化媒體播放器解碼器所需的子原子。

     初始化片段不會對應至 Kinesis 影片串流中的片段。它只包含串流和個別軌道的轉碼器私有資料，媒體播放器需要這些資料來解碼媒體影格。
   +  **GetMP4MediaFragment：**擷取 MP4 媒體片段。這些片段包含「`moof`」和「`mdat`」MP4 原子及其子原子，其中包含編碼片段的媒體影格及其時間戳記。
**重要**  
每個片段中包含的轉碼器私有資料 (CPD) 包含轉碼器特定的初始化資訊，例如影格速率、解析度和編碼描述檔，這些是正確解碼片段的必要資訊。串流工作階段期間不支援 CPD 變更。CPD 必須透過查詢的媒體保持一致。
**重要**  
不支援追蹤變更。追蹤在整個查詢媒體中必須保持一致。如果串流中的片段從只有視訊變更為同時擁有音訊和視訊，或者 AAC 音軌變更為 A-Law 音軌，則串流將會失敗。

     使用此動作擷取的資料可計費。如需詳細資訊，請參閱 [定價](https://aws.amazon.com/kinesis/video-streams/pricing/)。

**注意**  
如需適用於 MPEG-DASH 工作階段的限制，請參閱 [Kinesis Video Streams 配額](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html)。

您可以透過監控 `GetMP4MediaFragment.OutgoingBytes`Amazon CloudWatch 指標來監控媒體播放器使用的資料量。如需有關使用 CloudWatch 監控 Kinesis Video Streams 的資訊，請參閱[監控 Kinesis Video Streams](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html)。如需定價資訊，請參閱 [Amazon Kinesis Video Streams 定價](https://aws.amazon.com/kinesis/video-streams/pricing/)和[AWS 定價](https://aws.amazon.com/pricing/)。同時收取 HLS 工作階段和傳出 AWS 資料的費用。

如需 HLS 的詳細資訊，請參閱 [Apple 開發人員](https://developer.apple.com)網站上的 [HTTP 即時串流](https://developer.apple.com/streaming/)。

**重要**  
如果在叫用 Kinesis Video Streams 封存媒體 API 後擲出錯誤，除了 HTTP 狀態碼和回應內文之外，還包含下列資訊：  
 `x-amz-ErrorType` HTTP 標頭 – 除了 HTTP 狀態碼提供的內容之外，還包含更具體的錯誤類型。
 `x-amz-RequestId` HTTP 標頭 – 如果您想要向支援團隊報告問題 AWS ，如果指定請求 ID，則更能診斷問題。
HTTP 狀態碼和 ErrorType 標頭都可以用來對錯誤是否可以重試和在何種條件下進行程式設計決策，並提供用戶端程式設計人員可能需要採取的動作的相關資訊，以便成功重試。  
如需詳細資訊，請參閱本主題底部的**錯誤**區段，以及[常見錯誤](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html)。

## 請求語法
<a name="API_reader_GetDASHStreamingSessionURL_RequestSyntax"></a>

```
POST /getDASHStreamingSessionURL HTTP/1.1
Content-type: application/json

{
   "DASHFragmentSelector": { 
      "FragmentSelectorType": "string",
      "TimestampRange": { 
         "EndTimestamp": number,
         "StartTimestamp": number
      }
   },
   "DisplayFragmentNumber": "string",
   "DisplayFragmentTimestamp": "string",
   "Expires": number,
   "MaxManifestFragmentResults": number,
   "PlaybackMode": "string",
   "StreamARN": "string",
   "StreamName": "string"
}
```

## URI 請求參數
<a name="API_reader_GetDASHStreamingSessionURL_RequestParameters"></a>

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

## 請求主體
<a name="API_reader_GetDASHStreamingSessionURL_RequestBody"></a>

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

 ** [DASHFragmentSelector](#API_reader_GetDASHStreamingSessionURL_RequestSyntax) **   <a name="KinesisVideo-reader_GetDASHStreamingSessionURL-request-DASHFragmentSelector"></a>
所請求片段的時間範圍和時間戳記的來源。  
如果 `PlaybackMode`是 `ON_DEMAND`或 ，則需要此參數`LIVE_REPLAY`。如果 PlaybackMode 為`` ，則此參數為選用`LIVE`。如果 `PlaybackMode`是 `LIVE`，`FragmentSelectorType`則可以設定 ，但`TimestampRange`不應設定 。如果 `PlaybackMode`是 `ON_DEMAND`或 `LIVE_REPLAY`，`TimestampRange`則必須同時設定 `FragmentSelectorType`和 。  
類型：[DASHFragmentSelector](API_reader_DASHFragmentSelector.md) 物件  
必要：否

 ** [DisplayFragmentNumber](#API_reader_GetDASHStreamingSessionURL_RequestSyntax) **   <a name="KinesisVideo-reader_GetDASHStreamingSessionURL-request-DisplayFragmentNumber"></a>
根據片段在工作階段中的序號，在資訊清單檔案中識別片段。如果 DisplayFragmentNumber 設定為 `ALWAYS`，Kinesis Video Streams 片段編號會新增至資訊清單檔案中具有屬性名稱 “kvs：fn” 的每個 S 元素。這些片段編號可用於記錄或與其他 APIs（例如 `GetMedia`和 `GetMediaForFragmentList`) 搭配使用。需要自訂 MPEG-DASH 媒體播放器，才能利用這些自訂屬性。  
預設值為 `NEVER`。  
類型：字串  
有效值:`ALWAYS | NEVER`   
必要：否

 ** [DisplayFragmentTimestamp](#API_reader_GetDASHStreamingSessionURL_RequestSyntax) **   <a name="KinesisVideo-reader_GetDASHStreamingSessionURL-request-DisplayFragmentTimestamp"></a>
根據 MPEG-DASH 規格，可以使用資訊清單本身中的屬性衍生資訊清單檔案中片段的時鐘時間。不過，MPEG-DASH 相容媒體播放器通常無法正確處理媒體時間軸中的差距。Kinesis Video Streams 會調整資訊清單檔案中的媒體時間軸，以啟用播放具有不連續性的媒體。因此，從資訊清單檔案衍生的時鐘時間可能不準確。如果 DisplayFragmentTimestamp 設定為 `ALWAYS`，則準確的片段時間戳記會新增至資訊清單檔案中具有屬性名稱 “kvs：ts” 的每個 S 元素。自訂 MPEG-DASH 媒體播放器是利用此自訂屬性的必要項目。  
預設值為 `NEVER`。當 [DASHFragmentSelector](API_reader_DASHFragmentSelector.md)為 時`SERVER_TIMESTAMP`，時間戳記將是伺服器啟動時間戳記。同樣地，當 [DASHFragmentSelector](API_reader_DASHFragmentSelector.md)為 時`PRODUCER_TIMESTAMP`，時間戳記將是生產者起始時間戳記。  
類型：字串  
有效值:`ALWAYS | NEVER`   
必要：否

 ** [Expires](#API_reader_GetDASHStreamingSessionURL_RequestSyntax) **   <a name="KinesisVideo-reader_GetDASHStreamingSessionURL-request-Expires"></a>
請求的工作階段過期前的秒數。此值可以介於 300 (5 分鐘） 和 43200 (12 小時） 之間。  
當工作階段過期時，就`GetMP4MediaFragment`無法對該工作階段進行新的 `GetDashManifest`、 `GetMP4InitFragment`或 呼叫。  
預設值為 300 (5 分鐘)。  
類型：整數  
有效範圍：最小值為 300。最大值為 43200。  
必要：否

 ** [MaxManifestFragmentResults](#API_reader_GetDASHStreamingSessionURL_RequestSyntax) **   <a name="KinesisVideo-reader_GetDASHStreamingSessionURL-request-MaxManifestFragmentResults"></a>
MPEG-DASH 資訊清單中傳回的片段數量上限。  
當 `PlaybackMode`為 時`LIVE`，最新的片段會傳回至此值。當 `PlaybackMode`為 時`ON_DEMAND`，會傳回最舊的片段，最多達到此最大數量。  
當即時 MPEG-DASH 資訊清單中有更多可用的片段時，影片播放器通常會在開始播放之前緩衝內容。增加緩衝區大小會增加播放延遲，但可減少播放期間重新緩衝的可能性。我們建議即時 MPEG-DASH 資訊清單至少有 3 個片段，最多有 10 個片段。  
如果 `PlaybackMode`是 `LIVE`或 ，則預設為 5 個片段`LIVE_REPLAY`，如果 `PlaybackMode`是 ，則預設為 1，000 個片段`ON_DEMAND`。  
1，000 個片段的最大值對應於具有 1 秒片段之串流上的影片超過 16 分鐘，以及具有 10 秒片段之串流上的影片超過 2 1/2 小時。  
類型：Long  
有效範圍：最小值為 1。最大值為 5000。  
必要：否

 ** [PlaybackMode](#API_reader_GetDASHStreamingSessionURL_RequestSyntax) **   <a name="KinesisVideo-reader_GetDASHStreamingSessionURL-request-PlaybackMode"></a>
要擷取即時、即時重播或封存的隨需資料。  
三種工作階段類型的功能包括下列項目：  
+  ** `LIVE` **：對於此類型的工作階段，MPEG-DASH 資訊清單會持續更新為可用的最新片段。我們建議媒體播放器每隔一秒擷取新的資訊清單。在媒體播放器中播放此類型的工作階段時，使用者介面通常會顯示「即時」通知，沒有用於選擇要顯示之播放視窗中的位置的清理程式控制。
**注意**  
在 `LIVE`模式中，最新的可用片段會包含在 MPEG-DASH 資訊清單中，即使片段之間有間隙 （亦即，如果片段遺失）。這種差距可能會導致媒體播放器停止或導致播放跳躍。在此模式中，如果片段比播放清單中的最新片段舊，則不會將片段新增至 MPEG-DASH 資訊清單。如果遺失的片段在後續片段新增至資訊清單後變成可用，則不會新增較舊的片段，也不會填滿間隙。
+  ** `LIVE_REPLAY` **：對於此類型的工作階段，MPEG-DASH 資訊清單的更新方式與`LIVE`模式的更新方式類似，只是從包含指定開始時間的片段開始。片段會新增為下一個片段的持續時間，而不是在擷取片段時新增的片段。例如，如果工作階段中的片段長度為兩秒，則每兩秒會將新的片段新增至資訊清單。此模式有助於在偵測到事件時開始播放，並繼續在工作階段建立時尚未擷取的即時串流媒體。此模式也適用於串流先前封存的媒體，而不會受限於 `ON_DEMAND` 模式中的 1，000 個片段限制。
+  ** `ON_DEMAND` **：對於此類型的工作階段，MPEG-DASH 資訊清單包含工作階段的所有片段，最高可達 中指定的數字`MaxManifestFragmentResults`。每個工作階段只能擷取一次資訊清單。在媒體播放器中播放此類型的工作階段時，使用者介面通常會顯示清除器控制項，以選擇要在播放視窗中顯示的位置。
在所有播放模式中，如果 `FragmentSelectorType`是 `PRODUCER_TIMESTAMP`，且如果有多個片段具有相同的啟動時間戳記，則具有較大片段編號 （即較新的片段） 的片段會包含在 MPEG-DASH 資訊清單中。不包含其他片段。具有不同時間戳記但持續時間重疊的片段仍會包含在 MPEG-DASH 資訊清單中。這可能會導致媒體播放器發生非預期的行為。  
預設值為 `LIVE`。  
類型：字串  
有效值:`LIVE | LIVE_REPLAY | ON_DEMAND`   
必要：否

 ** [StreamARN](#API_reader_GetDASHStreamingSessionURL_RequestSyntax) **   <a name="KinesisVideo-reader_GetDASHStreamingSessionURL-request-StreamARN"></a>
要擷取 MPEG-DASH 資訊清單 URL 之串流的 Amazon Resource Name (ARN)。  
您必須指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_reader_GetDASHStreamingSessionURL_RequestSyntax) **   <a name="KinesisVideo-reader_GetDASHStreamingSessionURL-request-StreamName"></a>
要擷取 MPEG-DASH 資訊清單 URL 的串流名稱。  
您必須指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_reader_GetDASHStreamingSessionURL_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DASHStreamingSessionURL": "string"
}
```

## 回應元素
<a name="API_reader_GetDASHStreamingSessionURL_ResponseElements"></a>

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

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

 ** [DASHStreamingSessionURL](#API_reader_GetDASHStreamingSessionURL_ResponseSyntax) **   <a name="KinesisVideo-reader_GetDASHStreamingSessionURL-response-DASHStreamingSessionURL"></a>
媒體播放器可用來擷取 MPEG-DASH 資訊清單的 URL （包含工作階段字符）。  
類型：字串

## 錯誤
<a name="API_reader_GetDASHStreamingSessionURL_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過限制。稍後再嘗試進行呼叫。如需限制的相關資訊，請參閱 [Kinesis Video Streams 配額](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html)。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
指定的參數超過其限制、不支援或無法使用。  
HTTP 狀態碼：400

 ** InvalidCodecPrivateDataException **   
至少其中一個視訊串流軌道中的轉碼器私有資料不適用於此操作。  
HTTP 狀態碼：400

 ** MissingCodecPrivateDataException **   
在影片串流的至少一個軌跡中找不到轉碼器私有資料。  
HTTP 狀態碼：400

 ** NoDataRetentionException **   
 `GetImages` 請求的串流不會保留資料 （也就是 `DataRetentionInHours`的 為 0)。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
狀態碼：403，發起人無權在指定的串流上執行 操作，或權杖已過期。  
HTTP 狀態碼：401

 ** ResourceNotFoundException **   
 `GetImages` 當 Kinesis Video Streams 找不到您指定的串流時， 會擲回此錯誤。  
 `GetHLSStreamingSessionURL` 如果`LIVE_REPLAY`請求具有 `ON_DEMAND`或 `PlaybackMode`的工作階段的串流在請求的時間範圍內沒有片段，或者請求具有 `PlaybackMode`的工作階段的串流在過去 30 秒內沒有片段，`LIVE`則`GetDASHStreamingSessionURL`擲回此錯誤。  
HTTP 狀態碼：404

 ** UnsupportedStreamMediaTypeException **   
媒體的類型 （例如，h.264 或 h.265 視訊或 AAC 或 G.711 音訊） 無法從播放工作階段第一個片段中軌道的編解碼器 IDs 決定。軌道 1 的轉碼器 ID 應該是 ，`V_MPEG/ISO/AVC`並且可選地，軌道 2 的轉碼器 ID 應該是 `A_AAC`。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_reader_GetDASHStreamingSessionURL_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL) 

# GetHLSStreamingSessionURL
<a name="API_reader_GetHLSStreamingSessionURL"></a>

擷取串流的 HTTP 即時串流 (HLS) URL。然後，您可以在瀏覽器或媒體播放器中開啟 URL，以檢視串流內容。

`StreamName` 和 `StreamARN` 參數都是選用的，但您必須在叫用此 API 操作`StreamARN`時指定 `StreamName`或 。

Amazon Kinesis 影片串流對於透過 HLS 提供資料有下列需求：
+  [影片播放軌跡需求](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html)。
+ 資料保留必須大於 0。
+ 每個片段的視訊軌必須包含 H.264 格式的編解碼器私有資料 (AVC) 或 H.265 格式的 HEVC ([MPEG-4 規格 ISO/IEC 14496-15](https://www.iso.org/standard/55980.html))。如需將串流資料轉換為特定格式的相關資訊，請參閱 [NAL Adaptation Flags](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html)。
+ 每個片段的音軌 （如果有） 必須包含 AAC 格式的轉碼器私有資料 ([AAC 規格 ISO/IEC 13818-7](https://www.iso.org/standard/43345.html))。

Kinesis Video Streams HLS 工作階段包含分段 MPEG-4 格式 （也稱為 fMP4 或 CMAF) 或 MPEG-2 格式 （也稱為 HLS 規格也支援的 TS 區塊） 的片段。如需 HLS 片段類型的詳細資訊，請參閱 [HLS 規格](https://tools.ietf.org/html/draft-pantos-http-live-streaming-23)。

下列程序說明如何搭配 Kinesis Video Streams 使用 HLS：

1. 呼叫 `GetDataEndpoint` API 以取得端點。然後使用 [--endpoint-url 參數](https://docs.aws.amazon.com/cli/latest/reference/)將`GetHLSStreamingSessionURL`請求傳送至此端點。

1. 使用 擷取 HLS URL`GetHLSStreamingSessionURL`。Kinesis Video Streams 會建立 HLS 串流工作階段，用於使用 HLS 通訊協定存取串流中的內容。 `GetHLSStreamingSessionURL`會傳回工作階段 HLS *主播放清單* （使用 HLS 串流所需的根資源） 的已驗證 URL （包括加密工作階段字符）。
**注意**  
不要在未經授權的實體可以存取它的地方共用或存放此字符。權杖可讓您存取串流的內容。使用與 AWS 登入資料相同的量值來保護字符。

   透過播放清單提供的媒體僅包含請求的串流、時間範圍和格式。不提供其他媒體資料 （例如請求視窗外的影格或替代位元速率）。

1. 將 HLS 主播放清單的 URL （包含加密工作階段字符） 提供給支援 HLS 通訊協定的媒體播放器。Kinesis Video Streams 透過主播放清單 URL 提供 HLS 媒體播放清單、初始化片段和媒體片段。初始化片段包含串流的轉碼器私有資料，以及設定視訊或音訊解碼器和轉譯器所需的其他資料。媒體片段包含 H.264 編碼的影片影格或 AAC 編碼的音訊範例。

1. 媒體播放器會正常接收已驗證的 URL 並請求串流中繼資料和媒體資料。當媒體播放器請求資料時，它會呼叫下列動作：
   +  **GetHLSMasterPlaylist：**擷取 HLS 主播放清單，其中包含每個軌跡`GetHLSMediaPlaylist`的動作 URL，以及媒體播放器的其他中繼資料，包括估計位元速率和解析度。
   +  **GetHLSMediaPlaylist：**擷取 HLS 媒體播放清單，其中包含使用 `GetMP4InitFragment`動作存取 MP4 初始化片段的 URL，以及使用 `GetMP4MediaFragment`動作存取 MP4 媒體片段的 URLs。HLS 媒體播放清單也包含播放器播放所需的串流中繼資料，例如 `PlaybackMode`是 `LIVE`還是 `ON_DEMAND`。對於具有 `PlaybackType`的工作階段，HLS 媒體播放清單通常是靜態的`ON_DEMAND`。HLS 媒體播放清單會持續更新為具有 `PlaybackType`之工作階段的新片段`LIVE`。視訊音軌和音訊音軌 （如果適用） 有不同的 HLS 媒體播放清單，其中包含特定音軌的 MP4 媒體 URLs。
   +  **GetMP4InitFragment：**擷取 MP4 初始化片段。媒體播放器通常會先載入初始化片段，再載入任何媒體片段。此片段包含「`fytp`」和「`moov`」MP4 原子，以及初始化媒體播放器解碼器所需的子原子。

     初始化片段不會對應至 Kinesis 影片串流中的片段。它只包含串流和個別軌道的轉碼器私有資料，媒體播放器需要這些資料來解碼媒體影格。
   +  **GetMP4MediaFragment：**擷取 MP4 媒體片段。這些片段包含「`moof`」和「`mdat`」MP4 原子及其子原子，其中包含編碼片段的媒體影格及其時間戳記。
**注意**  
每個片段中包含的轉碼器私有資料 (CPD) 包含轉碼器特定的初始化資訊，例如影格速率、解析度和編碼描述檔，這些是正確解碼片段所需的資訊。對於 TS 和 MP4，串流工作階段期間支援 CPD 變更。因此，工作階段中的片段在 CPD 中可以有不同的資訊，而不會中斷播放。對於每個串流工作階段，僅允許 500 個 CPD 變更。
**重要**  
不支援追蹤變更。追蹤在整個查詢媒體中必須保持一致。如果串流中的片段從只有視訊變更為同時擁有音訊和視訊，或者 AAC 音軌變更為 A-Law 音軌，則串流將會失敗。

     使用此動作擷取的資料可計費。如需相關資訊，請參閱 [ 定價](https://aws.amazon.com/kinesis/video-streams/pricing/)。
   +  **GetTSFragment：**擷取 MPEG TS 片段，其中包含串流中所有軌道的初始化和媒體資料。
**注意**  
如果 `ContainerFormat`是 `MPEG_TS`，則會使用此 API 而非 `GetMP4InitFragment`和 `GetMP4MediaFragment`來擷取串流媒體。

     使用此動作擷取的資料可計費。如需詳細資訊，請參閱 [Kinesis Video Streams 定價](https://aws.amazon.com/kinesis/video-streams/pricing/)。

不得在玩家之間共用串流工作階段 URL。如果多個媒體播放器共用工作階段，服務可能會調節工作階段。如需連線限制，請參閱 [Kinesis Video Streams 配額](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html)。

您可以透過監控 `GetMP4MediaFragment.OutgoingBytes`Amazon CloudWatch 指標來監控媒體播放器使用的資料量。如需使用 CloudWatch 監控 Kinesis Video Streams 的資訊，請參閱[監控 Kinesis Video Streams](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html)。如需定價資訊，請參閱 [Amazon Kinesis Video Streams 定價](https://aws.amazon.com/kinesis/video-streams/pricing/)和[AWS 定價](https://aws.amazon.com/pricing/)。同時收取 HLS 工作階段和傳出 AWS 資料的費用。

請參閱 文件指南中的影片播放範例： [使用 AWS CLI 擷取 HLS 串流工作階段 URL](hls-playback.md#retrieve-hls-url)和 [範例：在 HTML 和 JavaScript 中使用 HLS](hls-playback.md#how-hls-ex1)。

如需 HLS 的詳細資訊，請參閱 [Apple 開發人員](https://developer.apple.com)網站上的 [HTTP 即時串流](https://developer.apple.com/streaming/)。

**重要**  
如果在叫用 Kinesis Video Streams 封存媒體 API 後擲出錯誤，除了 HTTP 狀態碼和回應內文之外，還包含下列資訊：  
 `x-amz-ErrorType` HTTP 標頭 – 除了 HTTP 狀態碼提供的內容之外，還包含更具體的錯誤類型。
 `x-amz-RequestId` HTTP 標頭 – 如果您想要向 報告問題 AWS，支援團隊可以根據請求 ID 更好地診斷問題。
HTTP 狀態碼和 ErrorType 標頭都可以用來對錯誤是否可以重試和在何種條件下進行程式設計決策，並提供用戶端程式設計人員可能需要採取的動作的相關資訊，以便成功重試。  
如需詳細資訊，請參閱本主題底部的**錯誤**區段，以及[常見錯誤](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html)。

## 請求語法
<a name="API_reader_GetHLSStreamingSessionURL_RequestSyntax"></a>

```
POST /getHLSStreamingSessionURL HTTP/1.1
Content-type: application/json

{
   "ContainerFormat": "string",
   "DiscontinuityMode": "string",
   "DisplayFragmentTimestamp": "string",
   "Expires": number,
   "HLSFragmentSelector": { 
      "FragmentSelectorType": "string",
      "TimestampRange": { 
         "EndTimestamp": number,
         "StartTimestamp": number
      }
   },
   "MaxMediaPlaylistFragmentResults": number,
   "PlaybackMode": "string",
   "StreamARN": "string",
   "StreamName": "string"
}
```

## URI 請求參數
<a name="API_reader_GetHLSStreamingSessionURL_RequestParameters"></a>

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

## 請求主體
<a name="API_reader_GetHLSStreamingSessionURL_RequestBody"></a>

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

 ** [ContainerFormat](#API_reader_GetHLSStreamingSessionURL_RequestSyntax) **   <a name="KinesisVideo-reader_GetHLSStreamingSessionURL-request-ContainerFormat"></a>
指定應該用於封裝媒體的格式。指定`FRAGMENTED_MP4`容器格式會將媒體封裝為 MP4 片段 (fMP4 或 CMAF)。這是建議的封裝，因為封裝負荷最少。另一個容器格式選項是 `MPEG_TS`。HLS 自發行以來已支援 MPEG TS 區塊，有時是較舊的 HLS 播放器上唯一支援的封裝。MPEG TS 通常有 5-25% 的封裝額外負荷。這表示 MPEG TS 通常需要比 fMP4 多 5-25% 的頻寬和成本。  
預設值為 `FRAGMENTED_MP4`。  
類型：字串  
有效值:`FRAGMENTED_MP4 | MPEG_TS`   
必要：否

 ** [DiscontinuityMode](#API_reader_GetHLSStreamingSessionURL_RequestSyntax) **   <a name="KinesisVideo-reader_GetHLSStreamingSessionURL-request-DiscontinuityMode"></a>
指定何時標記標記片段之間的不連續性新增到媒體播放清單。  
媒體播放器通常會根據每個片段的時間戳記，建置要播放的媒體內容時間軸。這表示如果片段之間有任何重疊或間隙 （如 [HLSFragmentSelector](API_reader_HLSFragmentSelector.md)設為 的典型情況`SERVER_TIMESTAMP`)，媒體播放器時間軸在某些位置也會有片段之間的小間隙，在其他位置會覆寫影格。媒體播放器時間軸中的間隙可能會導致播放停滯，重疊可能會導致播放抖動。當片段之間存在不連續旗標時，媒體播放器預期會重設時間軸，導致下一個片段在前一個片段之後立即播放。  
支援下列模式：  
+  `ALWAYS`：不連續標記會放置在 HLS 媒體播放清單中的每個片段之間。`ALWAYS` 如果片段時間戳記不正確，建議使用 的值。
+  `NEVER`：不會將不連續標記放在任何位置。建議使用 值`NEVER`，以確保媒體播放器時間軸最準確地對應到生產者時間戳記。
+  `ON_DISCONTINUITY`：不連續標記會放置在間隙或重疊超過 50 毫秒的片段之間。對於大多數播放案例，建議使用 值，`ON_DISCONTINUITY`以便媒體播放器時間軸只有在媒體時間軸 （例如缺少片段） 發生重大問題時才會重設。
預設值為`ALWAYS`[HLSFragmentSelector](API_reader_HLSFragmentSelector.md)當 設為 時`SERVER_TIMESTAMP`，以及當 設為 `NEVER`時`PRODUCER_TIMESTAMP`。  
類型：字串  
有效值:`ALWAYS | NEVER | ON_DISCONTINUITY`   
必要：否

 ** [DisplayFragmentTimestamp](#API_reader_GetHLSStreamingSessionURL_RequestSyntax) **   <a name="KinesisVideo-reader_GetHLSStreamingSessionURL-request-DisplayFragmentTimestamp"></a>
指定何時應將片段開始時間戳記包含在 HLS 媒體播放清單中。一般而言，媒體播放器會將播放頭位置報告為相對於播放工作階段中第一個片段開始的時間。不過，當 HLS 媒體播放清單中包含啟動時間戳記時，有些媒體播放器可能會根據片段時間戳記，將目前的播放頭報告為絕對時間。這有助於建立播放體驗，向觀眾顯示媒體的時鐘時間。  
預設值為 `NEVER`。當 [HLSFragmentSelector](API_reader_HLSFragmentSelector.md)為 時`SERVER_TIMESTAMP`，時間戳記將是伺服器啟動時間戳記。同樣地，當 [HLSFragmentSelector](API_reader_HLSFragmentSelector.md)為 時`PRODUCER_TIMESTAMP`，時間戳記將是生產者起始時間戳記。  
類型：字串  
有效值:`ALWAYS | NEVER`   
必要：否

 ** [Expires](#API_reader_GetHLSStreamingSessionURL_RequestSyntax) **   <a name="KinesisVideo-reader_GetHLSStreamingSessionURL-request-Expires"></a>
請求的工作階段過期前的秒數。此值可以介於 300 (5 分鐘） 和 43200 (12 小時） 之間。  
當工作階段過期時，`GetTSFragment`無法對該工作階段進行對 `GetHLSMasterPlaylist`、`GetMP4MediaFragment`、、 或 `GetHLSMediaPlaylist` `GetMP4InitFragment`的新呼叫。  
預設值為 300 (5 分鐘)。  
類型：整數  
有效範圍：最小值為 300。最大值為 43200。  
必要：否

 ** [HLSFragmentSelector](#API_reader_GetHLSStreamingSessionURL_RequestSyntax) **   <a name="KinesisVideo-reader_GetHLSStreamingSessionURL-request-HLSFragmentSelector"></a>
所請求片段的時間範圍和時間戳記的來源。  
如果 `PlaybackMode`是 `ON_DEMAND`或 ，則需要此參數`LIVE_REPLAY`。如果 PlaybackMode 為`` ，則此參數為選用`LIVE`。如果 `PlaybackMode`是 `LIVE`，`FragmentSelectorType`則可以設定 ，但`TimestampRange`不應設定 。如果 `PlaybackMode`是 `ON_DEMAND`或 `LIVE_REPLAY`，`TimestampRange`則必須同時設定 `FragmentSelectorType`和 。  
類型：[HLSFragmentSelector](API_reader_HLSFragmentSelector.md) 物件  
必要：否

 ** [MaxMediaPlaylistFragmentResults](#API_reader_GetHLSStreamingSessionURL_RequestSyntax) **   <a name="KinesisVideo-reader_GetHLSStreamingSessionURL-request-MaxMediaPlaylistFragmentResults"></a>
HLS 媒體播放清單中傳回的片段數量上限。  
當 `PlaybackMode`為 時`LIVE`，最新的片段會傳回至此值。當 `PlaybackMode`為 時`ON_DEMAND`，會傳回最舊的片段，最多達到此最大數量。  
當即時 HLS 媒體播放清單中有更多可用的片段時，影片播放器通常會在開始播放之前緩衝內容。增加緩衝區大小會增加播放延遲，但可減少播放期間重新緩衝的可能性。我們建議即時 HLS 媒體播放清單至少包含 3 個片段，最多 10 個片段。  
如果 `PlaybackMode`是 `LIVE`或 ，則預設為 5 個片段`LIVE_REPLAY`，如果 `PlaybackMode`是 ，則預設為 1，000 個片段`ON_DEMAND`。  
5，000 個片段的最大值對應於具有 1 秒片段之串流上的影片超過 80 分鐘，以及具有 10 秒片段之串流上的影片超過 13 小時。  
類型：Long  
有效範圍：最小值為 1。最大值為 5000。  
必要：否

 ** [PlaybackMode](#API_reader_GetHLSStreamingSessionURL_RequestSyntax) **   <a name="KinesisVideo-reader_GetHLSStreamingSessionURL-request-PlaybackMode"></a>
要擷取即時、即時重播或封存的隨需資料。  
三種工作階段類型的功能包括下列項目：  
+  ** `LIVE` **：對於此類型的工作階段，HLS 媒體播放清單會持續更新為可用的最新片段。我們建議媒體播放器每隔一秒擷取新的播放清單。在媒體播放器中播放此類型的工作階段時，使用者介面通常會顯示「即時」通知，沒有用於選擇要顯示之播放視窗中的位置的清理程式控制。
**注意**  
在 `LIVE`模式中，最新的可用片段會包含在 HLS 媒體播放清單中，即使片段之間有間隙 （亦即，如果片段遺失）。這種差距可能會導致媒體播放器停止或導致播放跳躍。在此模式中，如果片段比播放清單中的最新片段舊，則不會將片段新增至 HLS 媒體播放清單。如果遺失的片段在後續片段新增至播放清單後變成可用，則不會新增較舊的片段，也不會填滿間隙。
+  ** `LIVE_REPLAY` **：對於此類型的工作階段，HLS 媒體播放清單的更新方式與`LIVE`模式的更新方式類似，只是從包含指定開始時間的片段開始。片段會新增為下一個片段的持續時間，而不是在擷取片段時新增的片段。例如，如果工作階段中的片段長度為兩秒，則每兩秒會將新的片段新增至媒體播放清單。此模式有助於在偵測到事件時開始播放，並繼續在工作階段建立時尚未擷取的即時串流媒體。此模式也適用於串流先前封存的媒體，而不會受限於 `ON_DEMAND` 模式中的 1，000 個片段限制。
+  ** `ON_DEMAND` **：對於此類型的工作階段，HLS 媒體播放清單包含工作階段的所有片段，最高可達 中指定的數字`MaxMediaPlaylistFragmentResults`。每個工作階段只能擷取播放清單一次。在媒體播放器中播放此類型的工作階段時，使用者介面通常會顯示清除器控制項，以選擇要在播放視窗中顯示的位置。
在所有播放模式中，如果 `FragmentSelectorType`是 `PRODUCER_TIMESTAMP`，且如果有多個片段具有相同的啟動時間戳記，則具有最大片段編號 （即最新片段） 的片段會包含在 HLS 媒體播放清單中。不包含其他片段。具有不同時間戳記但持續時間重疊的片段仍會包含在 HLS 媒體播放清單中。這可能會導致媒體播放器發生非預期的行為。  
預設值為 `LIVE`。  
類型：字串  
有效值:`LIVE | LIVE_REPLAY | ON_DEMAND`   
必要：否

 ** [StreamARN](#API_reader_GetHLSStreamingSessionURL_RequestSyntax) **   <a name="KinesisVideo-reader_GetHLSStreamingSessionURL-request-StreamARN"></a>
要擷取 HLS 主播放清單 URL 之串流的 Amazon Resource Name (ARN)。  
您必須指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_reader_GetHLSStreamingSessionURL_RequestSyntax) **   <a name="KinesisVideo-reader_GetHLSStreamingSessionURL-request-StreamName"></a>
要擷取 HLS 主播放清單 URL 的串流名稱。  
您必須指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_reader_GetHLSStreamingSessionURL_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "HLSStreamingSessionURL": "string"
}
```

## 回應元素
<a name="API_reader_GetHLSStreamingSessionURL_ResponseElements"></a>

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

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

 ** [HLSStreamingSessionURL](#API_reader_GetHLSStreamingSessionURL_ResponseSyntax) **   <a name="KinesisVideo-reader_GetHLSStreamingSessionURL-response-HLSStreamingSessionURL"></a>
媒體播放器可用來擷取 HLS 主播放清單的 URL （包含工作階段字符）。  
類型：字串

## 錯誤
<a name="API_reader_GetHLSStreamingSessionURL_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過限制。稍後再嘗試進行呼叫。如需限制的相關資訊，請參閱 [Kinesis Video Streams 配額](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html)。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
指定的參數超過其限制、不支援或無法使用。  
HTTP 狀態碼：400

 ** InvalidCodecPrivateDataException **   
至少其中一個視訊串流軌道中的轉碼器私有資料不適用於此操作。  
HTTP 狀態碼：400

 ** MissingCodecPrivateDataException **   
在影片串流的至少一個軌跡中找不到轉碼器私有資料。  
HTTP 狀態碼：400

 ** NoDataRetentionException **   
 `GetImages` 請求的串流不會保留資料 （也就是 `DataRetentionInHours`的 為 0)。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
狀態碼：403，發起人無權在指定的串流上執行 操作，或權杖已過期。  
HTTP 狀態碼：401

 ** ResourceNotFoundException **   
 `GetImages` 當 Kinesis Video Streams 找不到您指定的串流時， 會擲回此錯誤。  
 `GetHLSStreamingSessionURL` 如果`LIVE_REPLAY`請求具有 `ON_DEMAND`或 `PlaybackMode`的工作階段的串流在請求的時間範圍內沒有片段，或者請求具有 `PlaybackMode`的工作階段的串流在過去 30 秒內沒有片段，`LIVE`則`GetDASHStreamingSessionURL`擲回此錯誤。  
HTTP 狀態碼：404

 ** UnsupportedStreamMediaTypeException **   
媒體的類型 （例如，h.264 或 h.265 視訊或 AAC 或 G.711 音訊） 無法從播放工作階段第一個片段中軌道的編解碼器 IDs 決定。軌道 1 的轉碼器 ID 應該是 ，`V_MPEG/ISO/AVC`並且可選地，軌道 2 的轉碼器 ID 應該是 `A_AAC`。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_reader_GetHLSStreamingSessionURL_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL) 

# GetImages
<a name="API_reader_GetImages"></a>

影像的受管支援提供一種完全受管的方式，從 Kinesis Video Streams 中串流和存放的影片資料取得影像。您可以使用映像來執行機器學習 (ML) 工作負載，例如人員、寵物或車輛偵測。影像也可以用來新增要播放的互動式元素，例如動作事件的影像預覽和影片剪輯的清除。

GetImages 也會擷取與指定時間範圍、取樣間隔和影像格式組態的每個時間戳記對應的影像清單。

**注意**  
您必須先呼叫 `GetDataEndpoint` API 才能取得端點。然後使用 [--endpoint-url 參數](https://docs.aws.amazon.com/cli/latest/reference/)將`GetImages`請求傳送至此端點。

 [影片播放軌跡需求](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html)。

## 請求語法
<a name="API_reader_GetImages_RequestSyntax"></a>

```
POST /getImages HTTP/1.1
Content-type: application/json

{
   "EndTimestamp": number,
   "Format": "string",
   "FormatConfig": { 
      "string" : "string" 
   },
   "HeightPixels": number,
   "ImageSelectorType": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SamplingInterval": number,
   "StartTimestamp": number,
   "StreamARN": "string",
   "StreamName": "string",
   "WidthPixels": number
}
```

## URI 請求參數
<a name="API_reader_GetImages_RequestParameters"></a>

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

## 請求主體
<a name="API_reader_GetImages_RequestBody"></a>

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

 ** [EndTimestamp](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-EndTimestamp"></a>
要產生之影像範圍的結束時間戳記。如果 `StartTimestamp`和 `EndTimestamp` 之間的時間範圍超過 300 秒`StartTimestamp`，您將會收到 `IllegalArgumentException`。  
類型：Timestamp  
必要：是

 ** [Format](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-Format"></a>
用來編碼影像的格式。  
類型：字串  
有效值:`JPEG | PNG`   
必要：是

 ** [FormatConfig](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-FormatConfig"></a>
金鑰值對結構的清單，其中包含可在產生映像時套用的額外參數。`FormatConfig` 金鑰是 `JPEGQuality`，表示要用來產生映像的 JPEG 品質金鑰。此`FormatConfig`值接受從 1 到 100 的整數。如果值為 1，則會以較低的品質和最佳的壓縮產生影像。如果值為 100，則會產生具有最佳品質且壓縮較少的影像。如果未提供任何值，`JPEGQuality`則金鑰的預設值會設為 80。  
類型：字串到字串映射  
映射項目：最多 1 個項目。  
有效金鑰：`JPEGQuality`  
值長度限制：長度下限為 0。長度上限為 256。  
值模式：`^[a-zA-Z_0-9]+`  
必要：否

 ** [HeightPixels](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-HeightPixels"></a>
與 `WidthPixels` 參數搭配使用的輸出映像高度。同時提供 `HeightPixels`和 `WidthPixels` 參數時，影像會延伸以符合指定的長寬比。如果只提供 `HeightPixels` 參數，則會使用其原始長寬比來計算`WidthPixels`比率。如果未提供參數，則會傳回原始影像大小。  
類型：整數  
有效範圍：最小值為 1。最大值為 2160。  
必要：否

 ** [ImageSelectorType](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-ImageSelectorType"></a>
用於產生映像的伺服器或生產者時間戳記來源。  
類型：字串  
有效值:`PRODUCER_TIMESTAMP | SERVER_TIMESTAMP`   
必要：是

 ** [MaxResults](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-MaxResults"></a>
API 要傳回的影像數量上限。  
預設限制為每個 API 回應 25 個映像。提供`MaxResults`大於此值會導致頁面大小為 25。任何其他結果都會進行分頁。
類型：Long  
有效範圍：最小值為 1。最大值為 100。  
必要：否

 ** [NextToken](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-NextToken"></a>
指定在何處開始分頁下一組影像的權杖。這是先前截斷的回應`GetImages:NextToken`中的 。  
類型：字串  
長度限制：長度下限為 1。長度上限為 4096。  
模式：`[a-zA-Z0-9+/]+={0,2}`  
必要：否

 ** [SamplingInterval](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-SamplingInterval"></a>
需要從串流產生影像的時間間隔，以毫秒 (ms) 為單位。可以提供的最小值為 200 毫秒 （每秒 5 張影像）。如果時間戳記範圍小於取樣間隔，`startTimestamp`則會在可用時傳回來自 的映像。  
類型：整數  
必要：否

 ** [StartTimestamp](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-StartTimestamp"></a>
應產生影像的起點。這`StartTimestamp`必須在要傳回影像的時間戳記包含範圍內。  
類型：Timestamp  
必要：是

 ** [StreamARN](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-StreamARN"></a>
要從中擷取映像之串流的 Amazon Resource Name (ARN)。您必須指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-StreamName"></a>
要從中擷取影像的串流名稱。您必須指定 `StreamName`或 `StreamARN`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

 ** [WidthPixels](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-WidthPixels"></a>
與 `HeightPixels` 參數搭配使用的輸出映像寬度。同時提供 `WidthPixels`和 `HeightPixels` 參數時，影像會延伸以符合指定的長寬比。如果只提供 `WidthPixels` 參數，或只`HeightPixels`提供 ，`ValidationException`則會擲出 。如果未提供參數，則會傳回串流的原始影像大小。  
類型：整數  
有效範圍：最小值為 1。最大值為 3840。  
必要：否

## 回應語法
<a name="API_reader_GetImages_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Images": [ 
      { 
         "Error": "string",
         "ImageContent": "string",
         "TimeStamp": number
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_reader_GetImages_ResponseElements"></a>

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

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

 ** [Images](#API_reader_GetImages_ResponseSyntax) **   <a name="KinesisVideo-reader_GetImages-response-Images"></a>
從視訊串流產生的映像清單。如果指定的時間戳記沒有可用的媒體，則會在輸出中列出`NO_MEDIA`錯誤。如果在產生映像時發生錯誤， `MEDIA_ERROR` 會在輸出中列出為遺失映像的原因。  
類型：[Image](API_reader_Image.md) 物件陣列

 ** [NextToken](#API_reader_GetImages_ResponseSyntax) **   <a name="KinesisVideo-reader_GetImages-response-NextToken"></a>
請求中用於取得更多映像的加密字符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 4096。  
模式：`[a-zA-Z0-9+/]+={0,2}`

## 錯誤
<a name="API_reader_GetImages_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過限制。稍後嘗試進行呼叫。如需限制的相關資訊，請參閱 [Kinesis Video Streams 配額](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html)。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
指定的參數超過其限制、不支援或無法使用。  
HTTP 狀態碼：400

 ** NoDataRetentionException **   
 `GetImages` 請求的串流不會保留資料 （也就是 的 `DataRetentionInHours`為 0)。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
狀態碼：403，呼叫者無權在指定的串流上執行 操作，或權杖已過期。  
HTTP 狀態碼：401

 ** ResourceNotFoundException **   
 `GetImages` 當 Kinesis Video Streams 找不到您指定的串流時， 會擲回此錯誤。  
 `GetHLSStreamingSessionURL` 如果`LIVE_REPLAY`請求具有 `ON_DEMAND`或 `PlaybackMode`的工作階段的串流在請求的時間範圍內沒有片段，或者請求具有 `PlaybackMode` 的工作階段的串流在過去 30 秒內沒有片段，`LIVE`則`GetDASHStreamingSessionURL`擲回此錯誤。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_reader_GetImages_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/GetImages) 

# GetMediaForFragmentList
<a name="API_reader_GetMediaForFragmentList"></a>

從 Amazon Kinesis 影片串流中的封存資料取得片段清單 （由片段編號指定） 的媒體。

**注意**  
您必須先呼叫 `GetDataEndpoint` API 才能取得端點。然後使用 [--endpoint-url 參數](https://docs.aws.amazon.com/cli/latest/reference/)將`GetMediaForFragmentList`請求傳送至此端點。

如需限制，請參閱 [Kinesis Video Streams 配額](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html)。

**重要**  
如果在叫用 Kinesis Video Streams 封存媒體 API 後擲出錯誤，除了 HTTP 狀態碼和回應內文之外，還包含下列資訊：  
 `x-amz-ErrorType` HTTP 標頭 – 除了 HTTP 狀態碼提供的內容之外，還包含更具體的錯誤類型。
 `x-amz-RequestId` HTTP 標頭 – 如果您想要向 報告問題 AWS，支援團隊可以根據請求 ID 更好地診斷問題。
HTTP 狀態碼和 ErrorType 標頭都可以用來對錯誤是否可以重試和在何種條件下進行程式設計決策，並提供用戶端程式設計人員可能需要採取的動作的相關資訊，以便成功重試。  
如需詳細資訊，請參閱本主題底部的**錯誤**區段，以及[常見錯誤](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html)。

## 請求語法
<a name="API_reader_GetMediaForFragmentList_RequestSyntax"></a>

```
POST /getMediaForFragmentList HTTP/1.1
Content-type: application/json

{
   "Fragments": [ "string" ],
   "StreamARN": "string",
   "StreamName": "string"
}
```

## URI 請求參數
<a name="API_reader_GetMediaForFragmentList_RequestParameters"></a>

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

## 請求主體
<a name="API_reader_GetMediaForFragmentList_RequestBody"></a>

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

 ** [Fragments](#API_reader_GetMediaForFragmentList_RequestSyntax) **   <a name="KinesisVideo-reader_GetMediaForFragmentList-request-Fragments"></a>
要擷取媒體的片段數量清單。您可以使用 擷取這些值[ListFragments](API_reader_ListFragments.md)。  
類型：字串陣列  
陣列成員：項目數下限為 1。項目數上限為 1000。  
長度限制：長度下限為 1。長度上限為 128。  
模式：`^[0-9]+$`  
必要：是

 ** [StreamARN](#API_reader_GetMediaForFragmentList_RequestSyntax) **   <a name="KinesisVideo-reader_GetMediaForFragmentList-request-StreamARN"></a>
要從中擷取片段媒體之串流的 Amazon Resource Name (ARN)。指定此參數或 `StreamName` 參數。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_reader_GetMediaForFragmentList_RequestSyntax) **   <a name="KinesisVideo-reader_GetMediaForFragmentList-request-StreamName"></a>
要從中擷取片段媒體的串流名稱。指定此參數或 `StreamARN` 參數。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_reader_GetMediaForFragmentList_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-Type: ContentType

Payload
```

## 回應元素
<a name="API_reader_GetMediaForFragmentList_ResponseElements"></a>

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

回應會傳回下列 HTTP 標頭。

 ** [ContentType](#API_reader_GetMediaForFragmentList_ResponseSyntax) **   <a name="KinesisVideo-reader_GetMediaForFragmentList-response-ContentType"></a>
所請求媒體的內容類型。  
長度限制：長度下限為 1。長度上限為 128。  
模式：`^[a-zA-Z0-9_\.\-]+$`

回應傳回以下內容作為 HTTP 主體。

 ** [Payload](#API_reader_GetMediaForFragmentList_ResponseSyntax) **   <a name="KinesisVideo-reader_GetMediaForFragmentList-response-Payload"></a>
Kinesis Video Streams 傳回的承載是來自指定串流的一系列區塊。如需區塊的相關資訊，請參閱 [PutMedia](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html)。Kinesis Video Streams 在`GetMediaForFragmentList`呼叫中傳回的區塊也包含下列額外的 Matroska (MKV) 標籤：  
+ AWS\$1KINESISVIDEO\$1FRAGMENT\$1NUMBER - 區塊中傳回的片段編號。
+ AWS\$1KINESISVIDEO\$1SERVER\$1SIDE\$1TIMESTAMP - 片段的伺服器端時間戳記。
+ AWS\$1KINESISVIDEO\$1PRODUCER\$1SIDE\$1TIMESTAMP - 片段的生產者端時間戳記。
如果發生例外狀況，將包含下列標籤：  
+ AWS\$1KINESISVIDEO\$1FRAGMENT\$1NUMBER - 捨棄例外狀況的片段數量。
+ AWS\$1KINESISVIDEO\$1EXCEPTION\$1ERROR\$1CODE - 錯誤的整數代碼。
+ AWS\$1KINESISVIDEO\$1EXCEPTION\$1MESSAGE - 例外狀況的文字描述。

## 錯誤
<a name="API_reader_GetMediaForFragmentList_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過限制。稍後再嘗試進行呼叫。如需限制的相關資訊，請參閱 [Kinesis Video Streams 配額](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html)。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
指定的參數超過其限制、不支援或無法使用。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
狀態碼：403，發起人無權在指定的串流上執行 操作，或權杖已過期。  
HTTP 狀態碼：401

 ** ResourceNotFoundException **   
 `GetImages` 當 Kinesis Video Streams 找不到您指定的串流時， 會擲回此錯誤。  
 `GetHLSStreamingSessionURL` 如果`LIVE_REPLAY`請求具有 `ON_DEMAND`或 `PlaybackMode`的工作階段的串流在請求的時間範圍內沒有片段，或者請求具有 `PlaybackMode`的工作階段的串流在過去 30 秒內沒有片段，`LIVE`則`GetDASHStreamingSessionURL`擲回此錯誤。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_reader_GetMediaForFragmentList_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList) 

# ListFragments
<a name="API_reader_ListFragments"></a>

傳回封存資料中指定串流和時間戳記範圍的[Fragment](API_reader_Fragment.md)物件清單。

列出片段最終是一致的。這表示即使生產者收到片段持續存在的確認，可能不會立即將結果從請求傳回給 `ListFragments`。不過，結果通常可在一秒內取得。

**注意**  
您必須先呼叫 `GetDataEndpoint` API 才能取得端點。然後使用 [--endpoint-url 參數](https://docs.aws.amazon.com/cli/latest/reference/)將`ListFragments`請求傳送至此端點。

**重要**  
如果在叫用 Kinesis Video Streams 封存媒體 API 後擲出錯誤，除了 HTTP 狀態碼和回應內文之外，還包含下列資訊：  
 `x-amz-ErrorType` HTTP 標頭 – 除了 HTTP 狀態碼提供的內容之外，還包含更具體的錯誤類型。
 `x-amz-RequestId` HTTP 標頭 – 如果您想要向 回報問題 AWS，支援團隊可以在指定請求 ID 時更好地診斷問題。
HTTP 狀態碼和 ErrorType 標頭都可以用來對錯誤是否可以重試和在何種條件下進行程式設計決策，並提供用戶端程式設計人員可能需要採取的動作的相關資訊，以便成功重試。  
如需詳細資訊，請參閱本主題底部的**錯誤**區段，以及[常見錯誤](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html)。

## 請求語法
<a name="API_reader_ListFragments_RequestSyntax"></a>

```
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 請求參數
<a name="API_reader_ListFragments_RequestParameters"></a>

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

## 請求主體
<a name="API_reader_ListFragments_RequestBody"></a>

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

 ** [FragmentSelector](#API_reader_ListFragments_RequestSyntax) **   <a name="KinesisVideo-reader_ListFragments-request-FragmentSelector"></a>
描述要傳回之片段範圍的時間戳記範圍和時間戳記原始伺服器。  
只有在 `NextToken` API 中未傳遞 時，才需要這樣做。
類型：[FragmentSelector](API_reader_FragmentSelector.md) 物件  
必要：否

 ** [MaxResults](#API_reader_ListFragments_RequestSyntax) **   <a name="KinesisVideo-reader_ListFragments-request-MaxResults"></a>
要傳回的片段總數。如果可用的片段總數超過 中指定的值`max-results`，則會在輸出中提供 [ListFragments：NextToken](#KinesisVideo-reader_ListFragments-response-NextToken)，供您用來恢復分頁。  
預設值為 100.  
類型：Long  
有效範圍：最小值為 1。最大值為 1000。  
必要：否

 ** [NextToken](#API_reader_ListFragments_RequestSyntax) **   <a name="KinesisVideo-reader_ListFragments-request-NextToken"></a>
用以指定分頁開始位置的字符。這是先前截斷的回應中的 [ListFragments：NextToken](#KinesisVideo-reader_ListFragments-response-NextToken)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 4096。  
模式：`[a-zA-Z0-9+/]+={0,2}`  
必要：否

 ** [StreamARN](#API_reader_ListFragments_RequestSyntax) **   <a name="KinesisVideo-reader_ListFragments-request-StreamARN"></a>
要從中擷取片段清單之串流的 Amazon Resource Name (ARN)。指定此參數或 `StreamName` 參數。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_reader_ListFragments_RequestSyntax) **   <a name="KinesisVideo-reader_ListFragments-request-StreamName"></a>
要從中擷取片段清單的串流名稱。指定此參數或 `StreamARN` 參數。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_reader_ListFragments_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

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

## 回應元素
<a name="API_reader_ListFragments_ResponseElements"></a>

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

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

 ** [Fragments](#API_reader_ListFragments_ResponseSyntax) **   <a name="KinesisVideo-reader_ListFragments-response-Fragments"></a>
來自串流且符合選取器條件的封存[Fragment](API_reader_Fragment.md)物件清單。即使跨頁面，結果也不會有特定順序。  
如果串流中沒有符合選取器條件的片段，則會傳回空清單。  
類型：[Fragment](API_reader_Fragment.md) 物件陣列

 ** [NextToken](#API_reader_ListFragments_ResponseSyntax) **   <a name="KinesisVideo-reader_ListFragments-response-NextToken"></a>
如果傳回的清單遭到截斷，操作會傳回此字符，以用於擷取下一頁的結果。此值`null`表示沒有更多結果可傳回。  
類型：字串  
長度限制：長度下限為 1。長度上限為 4096。  
模式：`[a-zA-Z0-9+/]+={0,2}`

## 錯誤
<a name="API_reader_ListFragments_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過限制。稍後嘗試撥打電話。如需限制的相關資訊，請參閱 [Kinesis Video Streams 配額](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html)。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
指定的參數超過其限制、不支援或無法使用。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
狀態碼：403，呼叫者未獲授權在指定的串流上執行 操作，或權杖已過期。  
HTTP 狀態碼：401

 ** ResourceNotFoundException **   
 `GetImages` 當 Kinesis Video Streams 找不到您指定的串流時， 會擲回此錯誤。  
 `GetHLSStreamingSessionURL` 如果`LIVE_REPLAY`請求具有 `ON_DEMAND`或 `PlaybackMode`的工作階段的串流在請求的時間範圍內沒有片段，或者請求具有 `PlaybackMode` 的工作階段的串流在過去 30 秒內沒有片段，`LIVE`則`GetDASHStreamingSessionURL`擲回此錯誤。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_reader_ListFragments_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-reader-data-2017-09-30/ListFragments) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/ListFragments) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/ListFragments) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/ListFragments) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/ListFragments) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/ListFragments) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/ListFragments) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/ListFragments) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/ListFragments) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/ListFragments) 

# Amazon Kinesis Video Signaling 頻道
<a name="API_Operations_Amazon_Kinesis_Video_Signaling_Channels"></a>

Amazon Kinesis Video Signaling Channels 支援下列動作：
+  [GetIceServerConfig](API_signaling_GetIceServerConfig.md) 
+  [SendAlexaOfferToMaster](API_signaling_SendAlexaOfferToMaster.md) 

# GetIceServerConfig
<a name="API_signaling_GetIceServerConfig"></a>

 **注意：**使用此 API 之前，您必須呼叫 `GetSignalingChannelEndpoint` API 來請求 HTTPS 端點。然後，您可以在 `GetIceServerConfig` API 請求中指定端點和區域。

取得互動式連線建立 (ICE) 伺服器組態資訊，包括 URI URIs 、使用者名稱和密碼，可用於設定 WebRTC 連線。ICE 元件使用此組態資訊來設定 WebRTC 連線，包括使用圍繞 NAT 的轉送 (TURN) 轉送伺服器進行周遊驗證。

TURN 是一種通訊協定，用於改善peer-to-peer應用程式的連線能力。透過提供雲端型轉送服務，TURN 可確保即使一或多個對等連線無法直接peer-to-peer連線。如需詳細資訊，請參閱 [REST API for Access To TURN Services](https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00)。

 您可以叫用此 API 來建立備用機制，以防任一對等連線無法透過訊號管道建立直接peer-to-peer連線。您必須指定訊號頻道的 Amazon Resource Name (ARN)，才能叫用此 API。

## 請求語法
<a name="API_signaling_GetIceServerConfig_RequestSyntax"></a>

```
POST /v1/get-ice-server-config HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "string",
   "ClientId": "string",
   "Service": "string",
   "Username": "string"
}
```

## URI 請求參數
<a name="API_signaling_GetIceServerConfig_RequestParameters"></a>

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

## 請求主體
<a name="API_signaling_GetIceServerConfig_RequestBody"></a>

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

 ** [ChannelARN](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-ChannelARN"></a>
訊號頻道的 ARN，用於設定peer-to-peer連線。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：是

 ** [ClientId](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-ClientId"></a>
檢視器的唯一識別符。在訊號頻道中必須是唯一的。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

 ** [Service](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-Service"></a>
指定所需的服務。目前， `TURN` 是唯一的有效值。  
類型：字串  
有效值:`TURN`   
必要：否

 ** [Username](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-Username"></a>
要與登入資料建立關聯的選用使用者 ID。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_signaling_GetIceServerConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "IceServerList": [ 
      { 
         "Password": "string",
         "Ttl": number,
         "Uris": [ "string" ],
         "Username": "string"
      }
   ]
}
```

## 回應元素
<a name="API_signaling_GetIceServerConfig_ResponseElements"></a>

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

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

 ** [IceServerList](#API_signaling_GetIceServerConfig_ResponseSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-response-IceServerList"></a>
ICE 伺服器資訊物件的清單。  
類型：[IceServer](API_signaling_IceServer.md) 物件陣列

## 錯誤
<a name="API_signaling_GetIceServerConfig_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ClientLimitExceededException **   
您的請求已受到調節，因為您已超過允許的用戶端呼叫限制。稍後嘗試撥打電話。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** InvalidClientException **   
指定的用戶端無效。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
發起人無權執行此操作。  
HTTP 狀態碼：401

 ** ResourceNotFoundException **   
找不到指定的資源。  
HTTP 狀態碼：404

 ** SessionExpiredException **   
如果用戶端工作階段已過期。用戶端連線後，工作階段的有效期為 45 分鐘。用戶端應重新連線至頻道，以繼續傳送/接收訊息。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_signaling_GetIceServerConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 

# SendAlexaOfferToMaster
<a name="API_signaling_SendAlexaOfferToMaster"></a>

**注意**  
使用此 API 之前，您必須呼叫 `GetSignalingChannelEndpoint` API 以取得端點。然後，您可以在 `SendAlexaOfferToMaster` API 請求中指定端點和區域。

此 API 可讓您將啟用 WebRTC 的裝置與 Alexa 顯示裝置連線。調用時，它會將 Alexa 工作階段描述協定 (SDP) 優惠傳送給主對等。一旦主伺服器連線到指定的訊號頻道，就會立即交付優惠。此 API 會從連線的主伺服器傳回 SDP 答案。如果主伺服器未連線至訊號頻道，則會重新傳送請求，直到訊息過期為止。

## 請求語法
<a name="API_signaling_SendAlexaOfferToMaster_RequestSyntax"></a>

```
POST /v1/send-alexa-offer-to-master HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "string",
   "MessagePayload": "string",
   "SenderClientId": "string"
}
```

## URI 請求參數
<a name="API_signaling_SendAlexaOfferToMaster_RequestParameters"></a>

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

## 請求主體
<a name="API_signaling_SendAlexaOfferToMaster_RequestBody"></a>

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

 ** [ChannelARN](#API_signaling_SendAlexaOfferToMaster_RequestSyntax) **   <a name="KinesisVideo-signaling_SendAlexaOfferToMaster-request-ChannelARN"></a>
Alexa 和主要對等通訊的訊號管道的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：是

 ** [MessagePayload](#API_signaling_SendAlexaOfferToMaster_RequestSyntax) **   <a name="KinesisVideo-signaling_SendAlexaOfferToMaster-request-MessagePayload"></a>
base64 編碼的 SDP 提供內容。  
類型：字串  
長度限制：長度下限為 1。長度上限為 10000。  
模式：`[a-zA-Z0-9+/=]+`  
必要：是

 ** [SenderClientId](#API_signaling_SendAlexaOfferToMaster_RequestSyntax) **   <a name="KinesisVideo-signaling_SendAlexaOfferToMaster-request-SenderClientId"></a>
寄件者用戶端的唯一識別符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：是

## 回應語法
<a name="API_signaling_SendAlexaOfferToMaster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Answer": "string"
}
```

## 回應元素
<a name="API_signaling_SendAlexaOfferToMaster_ResponseElements"></a>

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

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

 ** [Answer](#API_signaling_SendAlexaOfferToMaster_ResponseSyntax) **   <a name="KinesisVideo-signaling_SendAlexaOfferToMaster-response-Answer"></a>
base64 編碼的 SDP 回答內容。  
類型：字串  
長度限制：長度下限為 1。長度上限為 10000。

## 錯誤
<a name="API_signaling_SendAlexaOfferToMaster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ClientLimitExceededException **   
您的請求已受到調節，因為您已超過允許的用戶端呼叫限制。稍後再嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
發起人無權執行此操作。  
HTTP 狀態碼：401

 ** ResourceNotFoundException **   
找不到指定的資源。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_signaling_SendAlexaOfferToMaster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) 

# Amazon Kinesis Video WebRTC 儲存體
<a name="API_Operations_Amazon_Kinesis_Video_WebRTC_Storage"></a>

Amazon Kinesis Video WebRTC Storage 支援下列動作：
+  [JoinStorageSession](API_webrtc_JoinStorageSession.md) 
+  [JoinStorageSessionAsViewer](API_webrtc_JoinStorageSessionAsViewer.md) 

# JoinStorageSession
<a name="API_webrtc_JoinStorageSession"></a>

**注意**  
使用此 API 之前，您必須呼叫 `GetSignalingChannelEndpoint` API 來請求 WEBRTC 端點。然後，您可以在 `JoinStorageSession` API 請求中指定端點和區域。

加入正在進行的單向視訊和/或多向音訊 WebRTC 工作階段，做為輸入頻道的視訊產生裝置。如果頻道沒有現有的工作階段，請建立新的串流工作階段，並提供訊號頻道的 Amazon Resource Name (ARN)。

目前，對於 `SINGLE_MASTER`類型，產生視訊的裝置能夠同時將音訊和視訊媒體擷取到串流中。只有產生影片的裝置可以加入工作階段並記錄媒體。

**重要**  
WebRTC 擷取目前需要音訊和視訊音軌。  
目前需求：  
視訊軌：H.264
音軌：Ops
影片：  
解析度上限為 SQFHD (1920x1920)
KVS WebRTC 擷取目前支援一組特定的 H264 設定檔：  
限制基準
基準
主要
high
受限 - 高
漸進高

Kinesis 影片串流中產生的擷取影片將具有下列參數：H.264 影片和 AAC 音訊。

一旦主要參與者透過 WebRTC 協商連線，擷取的媒體工作階段將存放在 Kinesis 影片串流中。然後，多個檢視器可以透過我們的播放 APIs 播放即時媒體。

您也可以搭配擷取的 WebRTC 媒體，使用現有的 Kinesis Video Streams 功能，例如 `HLS`或`DASH`播放、透過 [GetImages](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/gs-getImages.html) 產生影像等等。

**注意**  
目前不支援 S3 映像交付和通知。

**注意**  
假設只有一個產生視訊的裝置用戶端可以與頻道的工作階段建立關聯。如果多個用戶端將特定頻道的工作階段聯結為視訊產生裝置，則以最新的用戶端請求為優先。

 **其他資訊** 
+  **等冪性** - 此 API 不是等冪性。
+  **重試行為** - 這計為新的 API 呼叫。
+  **並行呼叫** - 允許並行呼叫。每次呼叫會傳送一次提議。

## 請求語法
<a name="API_webrtc_JoinStorageSession_RequestSyntax"></a>

```
POST /joinStorageSession HTTP/1.1
Content-type: application/json

{
   "channelArn": "string"
}
```

## URI 請求參數
<a name="API_webrtc_JoinStorageSession_RequestParameters"></a>

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

## 請求主體
<a name="API_webrtc_JoinStorageSession_RequestBody"></a>

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

 ** [channelArn](#API_webrtc_JoinStorageSession_RequestSyntax) **   <a name="KinesisVideo-webrtc_JoinStorageSession-request-channelArn"></a>
 訊號通道的 Amazon Resource Name (ARN)。  
請注意此輸入參數的大寫。
類型：字串  
模式：`arn:(aws[a-zA-Z-]*):kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：是

## 回應語法
<a name="API_webrtc_JoinStorageSession_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_webrtc_JoinStorageSession_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_webrtc_JoinStorageSession_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：403

 ** ClientLimitExceededException **   
 Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
找不到指定的資源。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_webrtc_JoinStorageSession_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) 

# JoinStorageSessionAsViewer
<a name="API_webrtc_JoinStorageSessionAsViewer"></a>

**注意**  
使用此 API 之前，您必須呼叫 `GetSignalingChannelEndpoint` API 來請求 WEBRTC 端點。然後，您可以在 `JoinStorageSessionAsViewer` API 請求中指定端點和區域。

 `JoinStorageSessionAsViewer` 可讓檢視器加入進行中的雲端錄製 WebRTC 串流工作階段。此 API 會透過在檢視器和錄製代理程式之間傳送 SDP 優惠和 ICE 候選項目來啟動 WebRTC 連線，讓檢視器透過錄製代理程式接收來自主伺服器的即時視訊，並透過錄製代理程式參與雙向音訊通訊。連線後，如果提供，檢視器的音訊會轉送至所有其他連線的對等，包括主要參與者，並併入要儲存到 Kinesis Video 串流的 WebRTC 串流。

**重要**  
觀眾目前無法傳送任何視訊軌。觀眾可以傳送選用的音軌，或完全不傳送任何音軌。  
目前的瀏覽者參與者傳送需求：  
視訊軌：不支援
音軌 （選用）：Ops

如果主要參與者目前連接到視訊產生裝置，則 Kinesis 視訊串流中產生的擷取視訊將具有下列參數：H.264 視訊和 AAC 音訊。

**注意**  
檢視器參與者直接連接到儲存工作階段，而不是直接連接到主要參與者。儲存工作階段負責混合、複製和路由媒體到適當的目的地。

**注意**  
如果主要參與者不存在，檢視器將無法互相聆聽。

檢視器參與者透過 WebRTC 協商連線後，只要主要參與者也連線至儲存工作階段，擷取的音訊工作階段就會存放在 Kinesis 視訊串流中。

您也可以搭配擷取的 WebRTC 媒體，使用現有的 Kinesis Video Streams 功能，例如 `HLS`或`DASH`播放、透過 [GetImages](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/gs-getImages.html) 產生影像等等。

**注意**  
目前不支援 S3 映像交付和通知。

**注意**  
假設只有一個產生視訊的裝置用戶端可以與頻道的工作階段建立關聯。如果多個用戶端將特定頻道的工作階段聯結為視訊產生裝置，則以最新的用戶端請求為優先。

 **限制** 

目前限制已就緒：
+  **檢視器數量上限：**3
+  **檢視器參與者保持連線至儲存工作階段的時間上限，但沒有主要參與者：**3 分鐘

**重要**  
如果檢視器與儲存工作階段中斷連線 （關閉對等連線），其配額 （檢視器限制） 會維持 1 分鐘。在此 1 分鐘期間，檢視器可以使用相同的用戶端 ID 叫用此 API，以重新加入工作階段，而不需要額外的檢視器配額。1 分鐘後，會釋出檢視器配額，供其他檢視器加入。

 **其他資訊** 
+  **等冪 **- 此 API 不是等冪。
+  **重試行為** - 這計為新的 API 呼叫。
+  **並行呼叫** - 允許並行呼叫。每次呼叫會傳送一次提議。

## 請求語法
<a name="API_webrtc_JoinStorageSessionAsViewer_RequestSyntax"></a>

```
POST /joinStorageSessionAsViewer HTTP/1.1
Content-type: application/json

{
   "channelArn": "string",
   "clientId": "string"
}
```

## URI 請求參數
<a name="API_webrtc_JoinStorageSessionAsViewer_RequestParameters"></a>

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

## 請求主體
<a name="API_webrtc_JoinStorageSessionAsViewer_RequestBody"></a>

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

 ** [channelArn](#API_webrtc_JoinStorageSessionAsViewer_RequestSyntax) **   <a name="KinesisVideo-webrtc_JoinStorageSessionAsViewer-request-channelArn"></a>
訊號通道的 Amazon Resource Name (ARN)。  
請注意此輸入參數的大寫。
類型：字串  
模式：`arn:(aws[a-zA-Z-]*):kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：是

 ** [clientId](#API_webrtc_JoinStorageSessionAsViewer_RequestSyntax) **   <a name="KinesisVideo-webrtc_JoinStorageSessionAsViewer-request-clientId"></a>
 寄件者用戶端的唯一識別符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：是

## 回應語法
<a name="API_webrtc_JoinStorageSessionAsViewer_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_webrtc_JoinStorageSessionAsViewer_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_webrtc_JoinStorageSessionAsViewer_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：403

 ** ClientLimitExceededException **   
 Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
找不到指定的資源。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_webrtc_JoinStorageSessionAsViewer_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer)