# Amazon Kinesis Video Streams The following actions are supported by 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 Creates a signaling channel. `CreateSignalingChannel` is an asynchronous operation. ## Request Syntax ``` POST /createSignalingChannel HTTP/1.1 Content-type: application/json { "ChannelName": "string", "ChannelType": "string", "SingleMasterConfiguration": { "MessageTtlSeconds": number }, "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ChannelName](#API_CreateSignalingChannel_RequestSyntax) ** A name for the signaling channel that you are creating. It must be unique for each AWS account and AWS Region. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [ChannelType](#API_CreateSignalingChannel_RequestSyntax) ** A type of the signaling channel that you are creating. Currently, `SINGLE_MASTER` is the only supported channel type. Type: String Valid Values: `SINGLE_MASTER | FULL_MESH` Required: No ** [SingleMasterConfiguration](#API_CreateSignalingChannel_RequestSyntax) ** A structure containing the configuration for the `SINGLE_MASTER` channel type. The default configuration for the channel message's time to live is 60 seconds (1 minute). Type: [SingleMasterConfiguration](API_SingleMasterConfiguration.md) object Required: No ** [Tags](#API_CreateSignalingChannel_RequestSyntax) ** A set of tags (key-value pairs) that you want to associate with this channel. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ChannelARN": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ChannelARN](#API_CreateSignalingChannel_ResponseSyntax) ** The Amazon Resource Name (ARN) of the created channel. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** AccountChannelLimitExceededException ** You have reached the maximum limit of active signaling channels for this AWS account in this region. HTTP Status Code: 400 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** ResourceInUseException ** When the input `StreamARN` or `ChannelARN` in `CLOUD_STORAGE_MODE` is already mapped to a different Kinesis Video Stream resource, or if the provided input `StreamARN` or `ChannelARN` is not in Active status, try one of the following : 1. The `DescribeMediaStorageConfiguration` API to determine what the stream given channel is mapped to. 1. The `DescribeMappedResourceConfiguration` API to determine the channel that the given stream is mapped to. 1. The `DescribeStream` or `DescribeSignalingChannel` API to determine the status of the resource. HTTP Status Code: 400 ** TagsPerResourceExceededLimitException ** You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/CreateSignalingChannel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/CreateSignalingChannel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/CreateSignalingChannel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/CreateSignalingChannel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/CreateSignalingChannel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/CreateSignalingChannel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/CreateSignalingChannel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/CreateSignalingChannel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/CreateSignalingChannel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/CreateSignalingChannel) # CreateStream Creates a new Kinesis video stream. When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version. `CreateStream` is an asynchronous operation. For information about how the service works, see [How it Works](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/how-it-works.html). You must have permissions for the `KinesisVideo:CreateStream` action. ## Request Syntax ``` 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 Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [DataRetentionInHours](#API_CreateStream_RequestSyntax) ** The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream. The default value is 0, indicating that the stream does not persist data. The minimum is 1 hour. When the `DataRetentionInHours` value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached. Type: Integer Valid Range: Minimum value of 0. Required: No ** [DeviceName](#API_CreateStream_RequestSyntax) ** The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams doesn't use this name. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: No ** [KmsKeyId](#API_CreateStream_RequestSyntax) ** The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data. If no key ID is specified, the default, Kinesis Video-managed key (`aws/kinesisvideo`) is used. For more information, see [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters). Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `.+` Required: No ** [MediaType](#API_CreateStream_RequestSyntax) ** The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see [Media Types](http://www.iana.org/assignments/media-types/media-types.xhtml). If you choose to specify the `MediaType`, see [Naming Requirements](https://tools.ietf.org/html/rfc6838#section-4.2) for guidelines. Example valid values include "video/h264" and "video/h264,audio/aac". This parameter is optional; the default value is `null` (or empty in JSON). Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*` Required: No ** [StreamName](#API_CreateStream_RequestSyntax) ** A name for the stream that you are creating. The stream name is an identifier for the stream, and must be unique for each account and region. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [StreamStorageConfiguration](#API_CreateStream_RequestSyntax) ** The configuration for the stream's storage, including the default storage tier for stream data. This configuration determines how stream data is stored and accessed, with different tiers offering varying levels of performance and cost optimization. If not specified, the stream will use the default storage configuration with HOT tier for optimal performance. Type: [StreamStorageConfiguration](API_StreamStorageConfiguration.md) object Required: No ** [Tags](#API_CreateStream_RequestSyntax) ** A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional). Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "StreamARN": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [StreamARN](#API_CreateStream_ResponseSyntax) ** The Amazon Resource Name (ARN) of the stream. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccountStreamLimitExceededException ** The number of streams created for the account is too high. HTTP Status Code: 400 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** DeviceStreamLimitExceededException ** Not implemented. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** InvalidDeviceException ** Not implemented. HTTP Status Code: 400 ** ResourceInUseException ** When the input `StreamARN` or `ChannelARN` in `CLOUD_STORAGE_MODE` is already mapped to a different Kinesis Video Stream resource, or if the provided input `StreamARN` or `ChannelARN` is not in Active status, try one of the following : 1. The `DescribeMediaStorageConfiguration` API to determine what the stream given channel is mapped to. 1. The `DescribeMappedResourceConfiguration` API to determine the channel that the given stream is mapped to. 1. The `DescribeStream` or `DescribeSignalingChannel` API to determine the status of the resource. HTTP Status Code: 400 ** TagsPerResourceExceededLimitException ** You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/CreateStream) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/CreateStream) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/CreateStream) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/CreateStream) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/CreateStream) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/CreateStream) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/CreateStream) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/CreateStream) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/CreateStream) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/CreateStream) # DeleteEdgeConfiguration An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent. When you invoke this API, the sync status is set to `DELETING`. A deletion process starts, in which active edge jobs are stopped and all media is deleted from the edge device. The time to delete varies, depending on the total amount of stored media. If the deletion process fails, the sync status changes to `DELETE_FAILED`. You will need to re-try the deletion. When the deletion process has completed successfully, the edge configuration is no longer accessible. **Note** This API isn't available in the AWS Africa (Cape Town) region, af-south-1. ## Request Syntax ``` POST /deleteEdgeConfiguration HTTP/1.1 Content-type: application/json { "StreamARN": "string", "StreamName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [StreamARN](#API_DeleteEdgeConfiguration_RequestSyntax) ** The Amazon Resource Name (ARN) of the stream. Specify either the `StreamName` or the `StreamARN`. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [StreamName](#API_DeleteEdgeConfiguration_RequestSyntax) ** The name of the stream from which to delete the edge configuration. Specify either the `StreamName` or the `StreamARN`. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ** StreamEdgeConfigurationNotFoundException ** The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's edge configuration that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DeleteEdgeConfiguration) # DeleteSignalingChannel Deletes a specified signaling channel. `DeleteSignalingChannel` is an asynchronous operation. If you don't specify the channel's current version, the most recent version is deleted. ## Request Syntax ``` POST /deleteSignalingChannel HTTP/1.1 Content-type: application/json { "ChannelARN": "string", "CurrentVersion": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ChannelARN](#API_DeleteSignalingChannel_RequestSyntax) ** The Amazon Resource Name (ARN) of the signaling channel that you want to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: Yes ** [CurrentVersion](#API_DeleteSignalingChannel_RequestSyntax) ** The current version of the signaling channel that you want to delete. You can obtain the current version by invoking the `DescribeSignalingChannel` or `ListSignalingChannels` API operations. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: No ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** ResourceInUseException ** When the input `StreamARN` or `ChannelARN` in `CLOUD_STORAGE_MODE` is already mapped to a different Kinesis Video Stream resource, or if the provided input `StreamARN` or `ChannelARN` is not in Active status, try one of the following : 1. The `DescribeMediaStorageConfiguration` API to determine what the stream given channel is mapped to. 1. The `DescribeMappedResourceConfiguration` API to determine the channel that the given stream is mapped to. 1. The `DescribeStream` or `DescribeSignalingChannel` API to determine the status of the resource. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ** VersionMismatchException ** The stream version that you specified is not the latest version. To get the latest version, use the [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html) API. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DeleteSignalingChannel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DeleteSignalingChannel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DeleteSignalingChannel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DeleteSignalingChannel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DeleteSignalingChannel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DeleteSignalingChannel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DeleteSignalingChannel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DeleteSignalingChannel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DeleteSignalingChannel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DeleteSignalingChannel) # DeleteStream Deletes a Kinesis video stream and the data contained in the stream. This method marks the stream for deletion, and makes the data in the stream inaccessible immediately. To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the `DescribeStream` API. This operation requires permission for the `KinesisVideo:DeleteStream` action. ## Request Syntax ``` POST /deleteStream HTTP/1.1 Content-type: application/json { "CurrentVersion": "string", "StreamARN": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [CurrentVersion](#API_DeleteStream_RequestSyntax) ** Optional: The version of the stream that you want to delete. Specify the version as a safeguard to ensure that your are deleting the correct stream. To get the stream version, use the `DescribeStream` API. If not specified, only the `CreationTime` is checked before deleting the stream. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: No ** [StreamARN](#API_DeleteStream_RequestSyntax) ** The Amazon Resource Name (ARN) of the stream that you want to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** NotAuthorizedException ** The caller is not authorized to perform this operation. HTTP Status Code: 401 ** ResourceInUseException ** When the input `StreamARN` or `ChannelARN` in `CLOUD_STORAGE_MODE` is already mapped to a different Kinesis Video Stream resource, or if the provided input `StreamARN` or `ChannelARN` is not in Active status, try one of the following : 1. The `DescribeMediaStorageConfiguration` API to determine what the stream given channel is mapped to. 1. The `DescribeMappedResourceConfiguration` API to determine the channel that the given stream is mapped to. 1. The `DescribeStream` or `DescribeSignalingChannel` API to determine the status of the resource. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ** VersionMismatchException ** The stream version that you specified is not the latest version. To get the latest version, use the [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html) API. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DeleteStream) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DeleteStream) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DeleteStream) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DeleteStream) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DeleteStream) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DeleteStream) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DeleteStream) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DeleteStream) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DeleteStream) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DeleteStream) # DescribeEdgeConfiguration Describes a stream’s edge configuration that was set using the `StartEdgeConfigurationUpdate` API and the latest status of the edge agent's recorder and uploader jobs. Use this API to get the status of the configuration to determine if the configuration is in sync with the Edge Agent. Use this API to evaluate the health of the Edge Agent. **Note** This API isn't available in the AWS Africa (Cape Town) region, af-south-1. ## Request Syntax ``` POST /describeEdgeConfiguration HTTP/1.1 Content-type: application/json { "StreamARN": "string", "StreamName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [StreamARN](#API_DescribeEdgeConfiguration_RequestSyntax) ** The Amazon Resource Name (ARN) of the stream. Specify either the `StreamName`or the `StreamARN`. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [StreamName](#API_DescribeEdgeConfiguration_RequestSyntax) ** The name of the stream whose edge configuration you want to update. Specify either the `StreamName` or the `StreamARN`. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` 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" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeEdgeConfiguration_ResponseSyntax) ** The timestamp at which a stream’s edge configuration was first created. Type: Timestamp ** [EdgeAgentStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) ** An object that contains the latest status details for an edge agent's recorder and uploader jobs. Use this information to determine the current health of an edge agent. Type: [EdgeAgentStatus](API_EdgeAgentStatus.md) object ** [EdgeConfig](#API_DescribeEdgeConfiguration_ResponseSyntax) ** A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise. Type: [EdgeConfig](API_EdgeConfig.md) object ** [FailedStatusDetails](#API_DescribeEdgeConfiguration_ResponseSyntax) ** A description of the generated failure status. Type: String ** [LastUpdatedTime](#API_DescribeEdgeConfiguration_ResponseSyntax) ** The timestamp at which a stream’s edge configuration was last updated. Type: Timestamp ** [StreamARN](#API_DescribeEdgeConfiguration_ResponseSyntax) ** The Amazon Resource Name (ARN) of the stream. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` ** [StreamName](#API_DescribeEdgeConfiguration_ResponseSyntax) ** The name of the stream from which the edge configuration was updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` ** [SyncStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) ** The latest status of the edge configuration update. Type: String Valid Values: `SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ** StreamEdgeConfigurationNotFoundException ** The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's edge configuration that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration) # DescribeImageGenerationConfiguration Gets the `ImageGenerationConfiguration` for a given Kinesis video stream. ## Request Syntax ``` POST /describeImageGenerationConfiguration HTTP/1.1 Content-type: application/json { "StreamARN": "string", "StreamName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [StreamARN](#API_DescribeImageGenerationConfiguration_RequestSyntax) ** The Amazon Resource Name (ARN) of the Kinesis video stream from which to retrieve the image generation configuration. You must specify either the `StreamName` or the `StreamARN`. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [StreamName](#API_DescribeImageGenerationConfiguration_RequestSyntax) ** The name of the stream from which to retrieve the image generation configuration. You must specify either the `StreamName` or the `StreamARN`. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` 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 } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ImageGenerationConfiguration](#API_DescribeImageGenerationConfiguration_ResponseSyntax) ** The structure that contains the information required for the Kinesis video stream (KVS) images delivery. If this structure is null, the configuration will be deleted from the stream. Type: [ImageGenerationConfiguration](API_ImageGenerationConfiguration.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) # DescribeMappedResourceConfiguration Returns the most current information about the stream. The `streamName` or `streamARN` should be provided in the input. ## Request Syntax ``` POST /describeMappedResourceConfiguration HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string", "StreamARN": "string", "StreamName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [MaxResults](#API_DescribeMappedResourceConfiguration_RequestSyntax) ** The maximum number of results to return in the response. Type: Integer Valid Range: Fixed value of 1. Required: No ** [NextToken](#API_DescribeMappedResourceConfiguration_RequestSyntax) ** The token to provide in your next request, to get another batch of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[a-zA-Z0-9+/=]*` Required: No ** [StreamARN](#API_DescribeMappedResourceConfiguration_RequestSyntax) ** The Amazon Resource Name (ARN) of the stream. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [StreamName](#API_DescribeMappedResourceConfiguration_RequestSyntax) ** The name of the stream. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "MappedResourceConfigurationList": [ { "ARN": "string", "Type": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [MappedResourceConfigurationList](#API_DescribeMappedResourceConfiguration_ResponseSyntax) ** A structure that encapsulates, or contains, the media storage configuration properties. Type: Array of [MappedResourceConfigurationListItem](API_MappedResourceConfigurationListItem.md) objects Array Members: Minimum number of 0 items. Maximum number of 1 item. ** [NextToken](#API_DescribeMappedResourceConfiguration_ResponseSyntax) ** The token that was used in the `NextToken`request to fetch the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[a-zA-Z0-9+/=]*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration) # DescribeMediaStorageConfiguration Returns the most current information about the channel. Specify the `ChannelName` or `ChannelARN` in the input. ## Request Syntax ``` POST /describeMediaStorageConfiguration HTTP/1.1 Content-type: application/json { "ChannelARN": "string", "ChannelName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ChannelARN](#API_DescribeMediaStorageConfiguration_RequestSyntax) ** The Amazon Resource Name (ARN) of the channel. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [ChannelName](#API_DescribeMediaStorageConfiguration_RequestSyntax) ** The name of the channel. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "MediaStorageConfiguration": { "Status": "string", "StreamARN": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [MediaStorageConfiguration](#API_DescribeMediaStorageConfiguration_ResponseSyntax) ** A structure that encapsulates, or contains, the media storage configuration properties. Type: [MediaStorageConfiguration](API_MediaStorageConfiguration.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration) # DescribeNotificationConfiguration Gets the `NotificationConfiguration` for a given Kinesis video stream. ## Request Syntax ``` POST /describeNotificationConfiguration HTTP/1.1 Content-type: application/json { "StreamARN": "string", "StreamName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [StreamARN](#API_DescribeNotificationConfiguration_RequestSyntax) ** The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to retrieve the notification configuration. You must specify either the `StreamName` or the StreamARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [StreamName](#API_DescribeNotificationConfiguration_RequestSyntax) ** The name of the stream from which to retrieve the notification configuration. You must specify either the `StreamName` or the `StreamARN`. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NotificationConfiguration": { "DestinationConfig": { "Uri": "string" }, "Status": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NotificationConfiguration](#API_DescribeNotificationConfiguration_ResponseSyntax) ** The structure that contains the information required for notifications. If the structure is null, the configuration will be deleted from the stream. Type: [NotificationConfiguration](API_NotificationConfiguration.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeNotificationConfiguration) # DescribeSignalingChannel Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe. ## Request Syntax ``` POST /describeSignalingChannel HTTP/1.1 Content-type: application/json { "ChannelARN": "string", "ChannelName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ChannelARN](#API_DescribeSignalingChannel_RequestSyntax) ** The ARN of the signaling channel that you want to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [ChannelName](#API_DescribeSignalingChannel_RequestSyntax) ** The name of the signaling channel that you want to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ChannelInfo": { "ChannelARN": "string", "ChannelName": "string", "ChannelStatus": "string", "ChannelType": "string", "CreationTime": number, "SingleMasterConfiguration": { "MessageTtlSeconds": number }, "Version": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ChannelInfo](#API_DescribeSignalingChannel_ResponseSyntax) ** A structure that encapsulates the specified signaling channel's metadata and properties. Type: [ChannelInfo](API_ChannelInfo.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeSignalingChannel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeSignalingChannel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeSignalingChannel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeSignalingChannel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeSignalingChannel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeSignalingChannel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeSignalingChannel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeSignalingChannel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeSignalingChannel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeSignalingChannel) # DescribeStream Returns the most current information about the specified stream. You must specify either the `StreamName` or the `StreamARN`. ## Request Syntax ``` POST /describeStream HTTP/1.1 Content-type: application/json { "StreamARN": "string", "StreamName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [StreamARN](#API_DescribeStream_RequestSyntax) ** The Amazon Resource Name (ARN) of the stream. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [StreamName](#API_DescribeStream_RequestSyntax) ** The name of the stream. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` 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" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [StreamInfo](#API_DescribeStream_ResponseSyntax) ** An object that describes the stream. Type: [StreamInfo](API_StreamInfo.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** NotAuthorizedException ** The caller is not authorized to perform this operation. HTTP Status Code: 401 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeStream) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeStream) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeStream) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeStream) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeStream) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeStream) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeStream) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeStream) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeStream) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeStream) # DescribeStreamStorageConfiguration Retrieves the current storage configuration for the specified Kinesis video stream. In the request, you must specify either the `StreamName` or the `StreamARN`. You must have permissions for the `KinesisVideo:DescribeStreamStorageConfiguration` action. ## Request Syntax ``` POST /describeStreamStorageConfiguration HTTP/1.1 Content-type: application/json { "StreamARN": "string", "StreamName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [StreamARN](#API_DescribeStreamStorageConfiguration_RequestSyntax) ** The Amazon Resource Name (ARN) of the stream for which you want to retrieve the storage configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [StreamName](#API_DescribeStreamStorageConfiguration_RequestSyntax) ** The name of the stream for which you want to retrieve the storage configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "StreamARN": "string", "StreamName": "string", "StreamStorageConfiguration": { "DefaultStorageTier": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [StreamARN](#API_DescribeStreamStorageConfiguration_ResponseSyntax) ** The Amazon Resource Name (ARN) of the stream. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` ** [StreamName](#API_DescribeStreamStorageConfiguration_ResponseSyntax) ** The name of the stream. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` ** [StreamStorageConfiguration](#API_DescribeStreamStorageConfiguration_ResponseSyntax) ** The current storage configuration for the stream, including the default storage tier and other storage-related settings. Type: [StreamStorageConfiguration](API_StreamStorageConfiguration.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration) # GetDataEndpoint Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the `GetMedia` or `GetMediaForFragmentList` operations) or write to it (using the `PutMedia` operation). **Note** The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint. In the request, specify the stream either by `StreamName` or `StreamARN`. ## Request Syntax ``` POST /getDataEndpoint HTTP/1.1 Content-type: application/json { "APIName": "string", "StreamARN": "string", "StreamName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [APIName](#API_GetDataEndpoint_RequestSyntax) ** The name of the API action for which to get an endpoint. Type: String Valid Values: `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` Required: Yes ** [StreamARN](#API_GetDataEndpoint_RequestSyntax) ** The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a `StreamName` in the request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [StreamName](#API_GetDataEndpoint_RequestSyntax) ** The name of the stream that you want to get the endpoint for. You must specify either this parameter or a `StreamARN` in the request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DataEndpoint": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DataEndpoint](#API_GetDataEndpoint_ResponseSyntax) ** The endpoint value. To read data from the stream or to write data to it, specify this endpoint in your application. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** NotAuthorizedException ** The caller is not authorized to perform this operation. HTTP Status Code: 401 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/GetDataEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/GetDataEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/GetDataEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/GetDataEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/GetDataEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/GetDataEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/GetDataEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/GetDataEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/GetDataEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/GetDataEndpoint) # GetSignalingChannelEndpoint Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the `SingleMasterChannelEndpointConfiguration` input parameter, which consists of the `Protocols` and `Role` properties. `Protocols` is used to determine the communication mechanism. For example, if you specify `WSS` as the protocol, this API produces a secure websocket endpoint. If you specify `HTTPS` as the protocol, this API generates an HTTPS endpoint. If you specify `WEBRTC` as the protocol, but the signaling channel isn't configured for ingestion, you will receive the error `InvalidArgumentException`. `Role` determines the messaging permissions. A `MASTER` role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A `VIEWER` role results in this API generating an endpoint that a client can use to communicate only with a `MASTER`. ## Request Syntax ``` POST /getSignalingChannelEndpoint HTTP/1.1 Content-type: application/json { "ChannelARN": "string", "SingleMasterChannelEndpointConfiguration": { "Protocols": [ "string" ], "Role": "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ChannelARN](#API_GetSignalingChannelEndpoint_RequestSyntax) ** The Amazon Resource Name (ARN) of the signalling channel for which you want to get an endpoint. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: Yes ** [SingleMasterChannelEndpointConfiguration](#API_GetSignalingChannelEndpoint_RequestSyntax) ** A structure containing the endpoint configuration for the `SINGLE_MASTER` channel type. Type: [SingleMasterChannelEndpointConfiguration](API_SingleMasterChannelEndpointConfiguration.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ResourceEndpointList": [ { "Protocol": "string", "ResourceEndpoint": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ResourceEndpointList](#API_GetSignalingChannelEndpoint_ResponseSyntax) ** A list of endpoints for the specified signaling channel. Type: Array of [ResourceEndpointListItem](API_ResourceEndpointListItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** ResourceInUseException ** When the input `StreamARN` or `ChannelARN` in `CLOUD_STORAGE_MODE` is already mapped to a different Kinesis Video Stream resource, or if the provided input `StreamARN` or `ChannelARN` is not in Active status, try one of the following : 1. The `DescribeMediaStorageConfiguration` API to determine what the stream given channel is mapped to. 1. The `DescribeMappedResourceConfiguration` API to determine the channel that the given stream is mapped to. 1. The `DescribeStream` or `DescribeSignalingChannel` API to determine the status of the resource. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) # ListEdgeAgentConfigurations Returns an array of edge configurations associated with the specified Edge Agent. In the request, you must specify the Edge Agent `HubDeviceArn`. **Note** This API isn't available in the AWS Africa (Cape Town) region, af-south-1. ## Request Syntax ``` POST /listEdgeAgentConfigurations HTTP/1.1 Content-type: application/json { "HubDeviceArn": "string", "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [HubDeviceArn](#API_ListEdgeAgentConfigurations_RequestSyntax) ** The "Internet of Things (IoT) Thing" Arn of the edge agent. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:iot:[a-z0-9-]+:[0-9]+:thing/[a-zA-Z0-9_.-]+` Required: Yes ** [MaxResults](#API_ListEdgeAgentConfigurations_RequestSyntax) ** The maximum number of edge configurations to return in the response. The default is 5. Type: Integer Valid Range: Minimum value of 1. Maximum value of 10. Required: No ** [NextToken](#API_ListEdgeAgentConfigurations_RequestSyntax) ** If you specify this parameter, when the result of a `ListEdgeAgentConfigurations` operation is truncated, the call returns the `NextToken` in the response. To get another batch of edge configurations, provide this token in your next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[a-zA-Z0-9+/=]*` Required: No ## Response Syntax ``` 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" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [EdgeConfigs](#API_ListEdgeAgentConfigurations_ResponseSyntax) ** A description of a single stream's edge configuration. Type: Array of [ListEdgeAgentConfigurationsEdgeConfig](API_ListEdgeAgentConfigurationsEdgeConfig.md) objects ** [NextToken](#API_ListEdgeAgentConfigurations_ResponseSyntax) ** If the response is truncated, the call returns this element with a given token. To get the next batch of edge configurations, use this token in your next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[a-zA-Z0-9+/=]*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** NotAuthorizedException ** The caller is not authorized to perform this operation. HTTP Status Code: 401 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) # ListSignalingChannels Returns an array of `ChannelInfo` objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a `ChannelNameCondition`. ## Request Syntax ``` POST /listSignalingChannels HTTP/1.1 Content-type: application/json { "ChannelNameCondition": { "ComparisonOperator": "string", "ComparisonValue": "string" }, "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ChannelNameCondition](#API_ListSignalingChannels_RequestSyntax) ** Optional: Returns only the channels that satisfy a specific condition. Type: [ChannelNameCondition](API_ChannelNameCondition.md) object Required: No ** [MaxResults](#API_ListSignalingChannels_RequestSyntax) ** The maximum number of channels to return in the response. The default is 500. Type: Integer Valid Range: Minimum value of 1. Maximum value of 10000. Required: No ** [NextToken](#API_ListSignalingChannels_RequestSyntax) ** If you specify this parameter, when the result of a `ListSignalingChannels` operation is truncated, the call returns the `NextToken` in the response. To get another batch of channels, provide this token in your next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[a-zA-Z0-9+/=]*` Required: No ## Response Syntax ``` 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" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ChannelInfoList](#API_ListSignalingChannels_ResponseSyntax) ** An array of `ChannelInfo` objects. Type: Array of [ChannelInfo](API_ChannelInfo.md) objects ** [NextToken](#API_ListSignalingChannels_ResponseSyntax) ** If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[a-zA-Z0-9+/=]*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/ListSignalingChannels) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/ListSignalingChannels) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/ListSignalingChannels) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/ListSignalingChannels) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/ListSignalingChannels) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/ListSignalingChannels) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/ListSignalingChannels) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/ListSignalingChannels) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/ListSignalingChannels) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/ListSignalingChannels) # ListStreams Returns an array of `StreamInfo` objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a `StreamNameCondition`. ## Request Syntax ``` POST /listStreams HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string", "StreamNameCondition": { "ComparisonOperator": "string", "ComparisonValue": "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [MaxResults](#API_ListStreams_RequestSyntax) ** The maximum number of streams to return in the response. The default is 10,000. Type: Integer Valid Range: Minimum value of 1. Maximum value of 10000. Required: No ** [NextToken](#API_ListStreams_RequestSyntax) ** If you specify this parameter, when the result of a `ListStreams` operation is truncated, the call returns the `NextToken` in the response. To get another batch of streams, provide this token in your next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[a-zA-Z0-9+/=]*` Required: No ** [StreamNameCondition](#API_ListStreams_RequestSyntax) ** Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition. Type: [StreamNameCondition](API_StreamNameCondition.md) object Required: No ## Response Syntax ``` 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" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListStreams_ResponseSyntax) ** If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[a-zA-Z0-9+/=]*` ** [StreamInfoList](#API_ListStreams_ResponseSyntax) ** An array of `StreamInfo` objects. Type: Array of [StreamInfo](API_StreamInfo.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/ListStreams) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/ListStreams) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/ListStreams) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/ListStreams) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/ListStreams) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/ListStreams) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/ListStreams) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/ListStreams) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/ListStreams) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/ListStreams) # ListTagsForResource Returns a list of tags associated with the specified signaling channel. ## Request Syntax ``` POST /ListTagsForResource HTTP/1.1 Content-type: application/json { "NextToken": "string", "ResourceARN": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [NextToken](#API_ListTagsForResource_RequestSyntax) ** If you specify this parameter and the result of a `ListTagsForResource` call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[a-zA-Z0-9+/=]*` Required: No ** [ResourceARN](#API_ListTagsForResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the signaling channel for which you want to list tags. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListTagsForResource_ResponseSyntax) ** If you specify this parameter and the result of a `ListTagsForResource` call is truncated, the response includes a token that you can use in the next request to fetch the next set of tags. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[a-zA-Z0-9+/=]*` ** [Tags](#API_ListTagsForResource_ResponseSyntax) ** A map of tag keys and values associated with the specified signaling channel. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/ListTagsForResource) # ListTagsForStream Returns a list of tags associated with the specified stream. In the request, you must specify either the `StreamName` or the `StreamARN`. ## Request Syntax ``` POST /listTagsForStream HTTP/1.1 Content-type: application/json { "NextToken": "string", "StreamARN": "string", "StreamName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [NextToken](#API_ListTagsForStream_RequestSyntax) ** If you specify this parameter and the result of a `ListTagsForStream` call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[a-zA-Z0-9+/=]*` Required: No ** [StreamARN](#API_ListTagsForStream_RequestSyntax) ** The Amazon Resource Name (ARN) of the stream that you want to list tags for. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [StreamName](#API_ListTagsForStream_RequestSyntax) ** The name of the stream that you want to list tags for. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListTagsForStream_ResponseSyntax) ** If you specify this parameter and the result of a `ListTags` call is truncated, the response includes a token that you can use in the next request to fetch the next set of tags. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[a-zA-Z0-9+/=]*` ** [Tags](#API_ListTagsForStream_ResponseSyntax) ** A map of tag keys and values associated with the specified stream. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** InvalidResourceFormatException ** The format of the `StreamARN` is invalid. HTTP Status Code: 400 ** NotAuthorizedException ** The caller is not authorized to perform this operation. HTTP Status Code: 401 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/ListTagsForStream) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/ListTagsForStream) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/ListTagsForStream) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/ListTagsForStream) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/ListTagsForStream) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/ListTagsForStream) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/ListTagsForStream) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/ListTagsForStream) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/ListTagsForStream) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/ListTagsForStream) # StartEdgeConfigurationUpdate An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The `SyncStatus` will be updated as the edge configuration is acknowledged, and synced with the Edge Agent. If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to `SYNCING`. You will have to wait for the sync status to reach a terminal state such as: `IN_SYNC`, or `SYNC_FAILED`, before using this API again. If you invoke this API during the syncing process, a `ResourceInUseException` will be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into the `SYNC_FAILED` state. To move an edge configuration from one device to another, use [DeleteEdgeConfiguration](API_DeleteEdgeConfiguration.md) to delete the current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN. **Note** This API isn't available in the AWS Africa (Cape Town) region, af-south-1. ## Request Syntax ``` 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 Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [EdgeConfig](#API_StartEdgeConfigurationUpdate_RequestSyntax) ** The edge configuration details required to invoke the update process. Type: [EdgeConfig](API_EdgeConfig.md) object Required: Yes ** [StreamARN](#API_StartEdgeConfigurationUpdate_RequestSyntax) ** The Amazon Resource Name (ARN) of the stream. Specify either the `StreamName` or the `StreamARN`. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [StreamName](#API_StartEdgeConfigurationUpdate_RequestSyntax) ** The name of the stream whose edge configuration you want to update. Specify either the `StreamName` or the `StreamARN`. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` 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" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** The timestamp at which a stream’s edge configuration was first created. Type: Timestamp ** [EdgeConfig](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise. Type: [EdgeConfig](API_EdgeConfig.md) object ** [FailedStatusDetails](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** A description of the generated failure status. Type: String ** [LastUpdatedTime](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** The timestamp at which a stream’s edge configuration was last updated. Type: Timestamp ** [StreamARN](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** The Amazon Resource Name (ARN) of the stream. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` ** [StreamName](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** The name of the stream from which the edge configuration was updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` ** [SyncStatus](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** The current sync status of the stream's edge configuration. When you invoke this API, the sync status will be set to the `SYNCING` state. Use the `DescribeEdgeConfiguration` API to get the latest status of the edge configuration. Type: String Valid Values: `SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** NoDataRetentionException ** The Stream data retention in hours is equal to zero. HTTP Status Code: 400 ** ResourceInUseException ** When the input `StreamARN` or `ChannelARN` in `CLOUD_STORAGE_MODE` is already mapped to a different Kinesis Video Stream resource, or if the provided input `StreamARN` or `ChannelARN` is not in Active status, try one of the following : 1. The `DescribeMediaStorageConfiguration` API to determine what the stream given channel is mapped to. 1. The `DescribeMappedResourceConfiguration` API to determine the channel that the given stream is mapped to. 1. The `DescribeStream` or `DescribeSignalingChannel` API to determine the status of the resource. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) # TagResource Adds one or more tags to a signaling channel **only**. **Note :** To tag streams, use the TagStream API instead. A *tag* is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the * AWS Billing and Cost Management and Cost Management User Guide*. ## Request Syntax ``` POST /TagResource HTTP/1.1 Content-type: application/json { "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ResourceARN](#API_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the signaling channel to which you want to add tags. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: Yes ** [Tags](#API_TagResource_RequestSyntax) ** A list of tags to associate with the specified signaling channel. Each tag is a key-value pair. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ** TagsPerResourceExceededLimitException ** You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/TagResource) # TagStream Adds one or more tags to a stream. A *tag* is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the * AWS Billing and Cost Management and Cost Management User Guide*. You must provide either the `StreamName` or the `StreamARN`. This operation requires permission for the `KinesisVideo:TagStream` action. A Kinesis video stream can support up to 50 tags. ## Request Syntax ``` POST /tagStream HTTP/1.1 Content-type: application/json { "StreamARN": "string", "StreamName": "string", "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [StreamARN](#API_TagStream_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [StreamName](#API_TagStream_RequestSyntax) ** The name of the stream that you want to add the tag or tags to. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ** [Tags](#API_TagStream_RequestSyntax) ** A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional). Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** InvalidResourceFormatException ** The format of the `StreamARN` is invalid. HTTP Status Code: 400 ** NotAuthorizedException ** The caller is not authorized to perform this operation. HTTP Status Code: 401 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ** TagsPerResourceExceededLimitException ** You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/TagStream) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/TagStream) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/TagStream) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/TagStream) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/TagStream) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/TagStream) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/TagStream) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/TagStream) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/TagStream) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/TagStream) # UntagResource Removes one or more tags from a signaling channel **only**. **Note :** To remove tags from streams, use the UntagStream API instead. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored. ## Request Syntax ``` POST /UntagResource HTTP/1.1 Content-type: application/json { "ResourceARN": "string", "TagKeyList": [ "string" ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ResourceARN](#API_UntagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the signaling channel from which you want to remove tags. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: Yes ** [TagKeyList](#API_UntagResource_RequestSyntax) ** A list of the keys of the tags that you want to remove. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UntagResource) # UntagStream Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored. In the request, you must provide the `StreamName` or `StreamARN`. ## Request Syntax ``` POST /untagStream HTTP/1.1 Content-type: application/json { "StreamARN": "string", "StreamName": "string", "TagKeyList": [ "string" ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [StreamARN](#API_UntagStream_RequestSyntax) ** The Amazon Resource Name (ARN) of the stream that you want to remove tags from. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [StreamName](#API_UntagStream_RequestSyntax) ** The name of the stream that you want to remove tags from. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ** [TagKeyList](#API_UntagStream_RequestSyntax) ** A list of the keys of the tags that you want to remove. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** InvalidResourceFormatException ** The format of the `StreamARN` is invalid. HTTP Status Code: 400 ** NotAuthorizedException ** The caller is not authorized to perform this operation. HTTP Status Code: 401 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UntagStream) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UntagStream) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UntagStream) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UntagStream) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UntagStream) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UntagStream) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UntagStream) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UntagStream) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UntagStream) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UntagStream) # UpdateDataRetention Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the `Operation` parameter in the request body. In the request, you must specify either the `StreamName` or the `StreamARN`. This operation requires permission for the `KinesisVideo:UpdateDataRetention` action. Changing the data retention period affects the data in the stream as follows: + If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours. + If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately. ## Request Syntax ``` POST /updateDataRetention HTTP/1.1 Content-type: application/json { "CurrentVersion": "string", "DataRetentionChangeInHours": number, "Operation": "string", "StreamARN": "string", "StreamName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [CurrentVersion](#API_UpdateDataRetention_RequestSyntax) ** The version of the stream whose retention period you want to change. To get the version, call either the `DescribeStream` or the `ListStreams` API. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: Yes ** [DataRetentionChangeInHours](#API_UpdateDataRetention_RequestSyntax) ** The number of hours to adjust the current retention by. The value you specify is added to or subtracted from the current value, depending on the `operation`. The minimum value for data retention is 0 and the maximum value is 87600 (ten years). Type: Integer Valid Range: Minimum value of 1. Required: Yes ** [Operation](#API_UpdateDataRetention_RequestSyntax) ** Indicates whether you want to increase or decrease the retention period. Type: String Valid Values: `INCREASE_DATA_RETENTION | DECREASE_DATA_RETENTION` Required: Yes ** [StreamARN](#API_UpdateDataRetention_RequestSyntax) ** The Amazon Resource Name (ARN) of the stream whose retention period you want to change. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [StreamName](#API_UpdateDataRetention_RequestSyntax) ** The name of the stream whose retention period you want to change. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** NotAuthorizedException ** The caller is not authorized to perform this operation. HTTP Status Code: 401 ** ResourceInUseException ** When the input `StreamARN` or `ChannelARN` in `CLOUD_STORAGE_MODE` is already mapped to a different Kinesis Video Stream resource, or if the provided input `StreamARN` or `ChannelARN` is not in Active status, try one of the following : 1. The `DescribeMediaStorageConfiguration` API to determine what the stream given channel is mapped to. 1. The `DescribeMappedResourceConfiguration` API to determine the channel that the given stream is mapped to. 1. The `DescribeStream` or `DescribeSignalingChannel` API to determine the status of the resource. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ** VersionMismatchException ** The stream version that you specified is not the latest version. To get the latest version, use the [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html) API. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateDataRetention) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateDataRetention) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateDataRetention) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateDataRetention) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateDataRetention) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateDataRetention) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateDataRetention) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateDataRetention) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateDataRetention) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateDataRetention) # UpdateImageGenerationConfiguration Updates the `StreamInfo` and `ImageProcessingConfiguration` fields. ## Request Syntax ``` 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 Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ImageGenerationConfiguration](#API_UpdateImageGenerationConfiguration_RequestSyntax) ** The structure that contains the information required for the KVS images delivery. If the structure is null, the configuration will be deleted from the stream. Type: [ImageGenerationConfiguration](API_ImageGenerationConfiguration.md) object Required: No ** [StreamARN](#API_UpdateImageGenerationConfiguration_RequestSyntax) ** The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to update the image generation configuration. You must specify either the `StreamName` or the `StreamARN`. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [StreamName](#API_UpdateImageGenerationConfiguration_RequestSyntax) ** The name of the stream from which to update the image generation configuration. You must specify either the `StreamName` or the `StreamARN`. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** NoDataRetentionException ** The Stream data retention in hours is equal to zero. HTTP Status Code: 400 ** ResourceInUseException ** When the input `StreamARN` or `ChannelARN` in `CLOUD_STORAGE_MODE` is already mapped to a different Kinesis Video Stream resource, or if the provided input `StreamARN` or `ChannelARN` is not in Active status, try one of the following : 1. The `DescribeMediaStorageConfiguration` API to determine what the stream given channel is mapped to. 1. The `DescribeMappedResourceConfiguration` API to determine the channel that the given stream is mapped to. 1. The `DescribeStream` or `DescribeSignalingChannel` API to determine the status of the resource. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration) # UpdateMediaStorageConfiguration Associates a `SignalingChannel` to a stream to store the media. There are two signaling modes that you can specify : + If `StorageStatus` is enabled, the data will be stored in the `StreamARN` provided. In order for WebRTC Ingestion to work, the stream must have data retention enabled. + If `StorageStatus` is disabled, no data will be stored, and the `StreamARN` parameter will not be needed. **Important** If `StorageStatus` is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the `JoinStorageSession` API to trigger an SDP offer send and establish a connection between a peer and the storage session. ## Request Syntax ``` POST /updateMediaStorageConfiguration HTTP/1.1 Content-type: application/json { "ChannelARN": "string", "MediaStorageConfiguration": { "Status": "string", "StreamARN": "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ChannelARN](#API_UpdateMediaStorageConfiguration_RequestSyntax) ** The Amazon Resource Name (ARN) of the channel. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: Yes ** [MediaStorageConfiguration](#API_UpdateMediaStorageConfiguration_RequestSyntax) ** A structure that encapsulates, or contains, the media storage configuration properties. Type: [MediaStorageConfiguration](API_MediaStorageConfiguration.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** NoDataRetentionException ** The Stream data retention in hours is equal to zero. HTTP Status Code: 400 ** ResourceInUseException ** When the input `StreamARN` or `ChannelARN` in `CLOUD_STORAGE_MODE` is already mapped to a different Kinesis Video Stream resource, or if the provided input `StreamARN` or `ChannelARN` is not in Active status, try one of the following : 1. The `DescribeMediaStorageConfiguration` API to determine what the stream given channel is mapped to. 1. The `DescribeMappedResourceConfiguration` API to determine the channel that the given stream is mapped to. 1. The `DescribeStream` or `DescribeSignalingChannel` API to determine the status of the resource. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration) # UpdateNotificationConfiguration Updates the notification information for a stream. ## Request Syntax ``` POST /updateNotificationConfiguration HTTP/1.1 Content-type: application/json { "NotificationConfiguration": { "DestinationConfig": { "Uri": "string" }, "Status": "string" }, "StreamARN": "string", "StreamName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [NotificationConfiguration](#API_UpdateNotificationConfiguration_RequestSyntax) ** The structure containing the information required for notifications. If the structure is null, the configuration will be deleted from the stream. Type: [NotificationConfiguration](API_NotificationConfiguration.md) object Required: No ** [StreamARN](#API_UpdateNotificationConfiguration_RequestSyntax) ** The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to update the notification configuration. You must specify either the `StreamName` or the `StreamARN`. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [StreamName](#API_UpdateNotificationConfiguration_RequestSyntax) ** The name of the stream from which to update the notification configuration. You must specify either the `StreamName` or the `StreamARN`. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** NoDataRetentionException ** The Stream data retention in hours is equal to zero. HTTP Status Code: 400 ** ResourceInUseException ** When the input `StreamARN` or `ChannelARN` in `CLOUD_STORAGE_MODE` is already mapped to a different Kinesis Video Stream resource, or if the provided input `StreamARN` or `ChannelARN` is not in Active status, try one of the following : 1. The `DescribeMediaStorageConfiguration` API to determine what the stream given channel is mapped to. 1. The `DescribeMappedResourceConfiguration` API to determine the channel that the given stream is mapped to. 1. The `DescribeStream` or `DescribeSignalingChannel` API to determine the status of the resource. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateNotificationConfiguration) # UpdateSignalingChannel Updates the existing signaling channel. This is an asynchronous operation and takes time to complete. If the `MessageTtlSeconds` value is updated (either increased or reduced), it only applies to new messages sent via this channel after it's been updated. Existing messages are still expired as per the previous `MessageTtlSeconds` value. ## Request Syntax ``` POST /updateSignalingChannel HTTP/1.1 Content-type: application/json { "ChannelARN": "string", "CurrentVersion": "string", "SingleMasterConfiguration": { "MessageTtlSeconds": number } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ChannelARN](#API_UpdateSignalingChannel_RequestSyntax) ** The Amazon Resource Name (ARN) of the signaling channel that you want to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: Yes ** [CurrentVersion](#API_UpdateSignalingChannel_RequestSyntax) ** The current version of the signaling channel that you want to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: Yes ** [SingleMasterConfiguration](#API_UpdateSignalingChannel_RequestSyntax) ** The structure containing the configuration for the `SINGLE_MASTER` type of the signaling channel that you want to update. This parameter and the channel message's time-to-live are required for channels with the `SINGLE_MASTER` channel type. Type: [SingleMasterConfiguration](API_SingleMasterConfiguration.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** ResourceInUseException ** When the input `StreamARN` or `ChannelARN` in `CLOUD_STORAGE_MODE` is already mapped to a different Kinesis Video Stream resource, or if the provided input `StreamARN` or `ChannelARN` is not in Active status, try one of the following : 1. The `DescribeMediaStorageConfiguration` API to determine what the stream given channel is mapped to. 1. The `DescribeMappedResourceConfiguration` API to determine the channel that the given stream is mapped to. 1. The `DescribeStream` or `DescribeSignalingChannel` API to determine the status of the resource. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ** VersionMismatchException ** The stream version that you specified is not the latest version. To get the latest version, use the [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html) API. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateSignalingChannel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateSignalingChannel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateSignalingChannel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateSignalingChannel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateSignalingChannel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateSignalingChannel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateSignalingChannel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateSignalingChannel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateSignalingChannel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateSignalingChannel) # UpdateStream Updates stream metadata, such as the device name and media type. You must provide the stream name or the Amazon Resource Name (ARN) of the stream. To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the `DescribeStream` API. `UpdateStream` is an asynchronous operation, and takes time to complete. ## Request Syntax ``` POST /updateStream HTTP/1.1 Content-type: application/json { "CurrentVersion": "string", "DeviceName": "string", "MediaType": "string", "StreamARN": "string", "StreamName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [CurrentVersion](#API_UpdateStream_RequestSyntax) ** The version of the stream whose metadata you want to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: Yes ** [DeviceName](#API_UpdateStream_RequestSyntax) ** The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: No ** [MediaType](#API_UpdateStream_RequestSyntax) ** The stream's media type. Use `MediaType` to specify the type of content that the stream contains to the consumers of the stream. For more information about media types, see [Media Types](http://www.iana.org/assignments/media-types/media-types.xhtml). If you choose to specify the `MediaType`, see [Naming Requirements](https://tools.ietf.org/html/rfc6838#section-4.2). To play video on the console, you must specify the correct video type. For example, if the video in the stream is H.264, specify `video/h264` as the `MediaType`. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*` Required: No ** [StreamARN](#API_UpdateStream_RequestSyntax) ** The ARN of the stream whose metadata you want to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [StreamName](#API_UpdateStream_RequestSyntax) ** The name of the stream whose metadata you want to update. The stream name is an identifier for the stream, and must be unique for each account and region. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** NotAuthorizedException ** The caller is not authorized to perform this operation. HTTP Status Code: 401 ** ResourceInUseException ** When the input `StreamARN` or `ChannelARN` in `CLOUD_STORAGE_MODE` is already mapped to a different Kinesis Video Stream resource, or if the provided input `StreamARN` or `ChannelARN` is not in Active status, try one of the following : 1. The `DescribeMediaStorageConfiguration` API to determine what the stream given channel is mapped to. 1. The `DescribeMappedResourceConfiguration` API to determine the channel that the given stream is mapped to. 1. The `DescribeStream` or `DescribeSignalingChannel` API to determine the status of the resource. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ** VersionMismatchException ** The stream version that you specified is not the latest version. To get the latest version, use the [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html) API. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateStream) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateStream) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateStream) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateStream) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateStream) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateStream) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateStream) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateStream) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateStream) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateStream) # UpdateStreamStorageConfiguration Updates the storage configuration for an existing Kinesis video stream. This operation allows you to modify the storage tier settings for a stream, enabling you to optimize storage costs and performance based on your access patterns. `UpdateStreamStorageConfiguration` is an asynchronous operation. You must have permissions for the `KinesisVideo:UpdateStreamStorageConfiguration` action. ## Request Syntax ``` POST /updateStreamStorageConfiguration HTTP/1.1 Content-type: application/json { "CurrentVersion": "string", "StreamARN": "string", "StreamName": "string", "StreamStorageConfiguration": { "DefaultStorageTier": "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [CurrentVersion](#API_UpdateStreamStorageConfiguration_RequestSyntax) ** The version of the stream whose storage configuration you want to change. To get the version, call either the `DescribeStream` or the `ListStreams` API. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: Yes ** [StreamARN](#API_UpdateStreamStorageConfiguration_RequestSyntax) ** The Amazon Resource Name (ARN) of the stream for which you want to update the storage configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: No ** [StreamName](#API_UpdateStreamStorageConfiguration_RequestSyntax) ** The name of the stream for which you want to update the storage configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ** [StreamStorageConfiguration](#API_UpdateStreamStorageConfiguration_RequestSyntax) ** The new storage configuration for the stream. This includes the default storage tier that determines how stream data is stored and accessed. Different storage tiers offer varying levels of performance and cost optimization to match your specific use case requirements. Type: [StreamStorageConfiguration](API_StreamStorageConfiguration.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have required permissions to perform this operation. HTTP Status Code: 401 ** ClientLimitExceededException ** Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** ResourceInUseException ** When the input `StreamARN` or `ChannelARN` in `CLOUD_STORAGE_MODE` is already mapped to a different Kinesis Video Stream resource, or if the provided input `StreamARN` or `ChannelARN` is not in Active status, try one of the following : 1. The `DescribeMediaStorageConfiguration` API to determine what the stream given channel is mapped to. 1. The `DescribeMappedResourceConfiguration` API to determine the channel that the given stream is mapped to. 1. The `DescribeStream` or `DescribeSignalingChannel` API to determine the status of the resource. HTTP Status Code: 400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams can't find the stream that you specified. HTTP Status Code: 404 ** VersionMismatchException ** The stream version that you specified is not the latest version. To get the latest version, use the [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html) API. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration)