Amazonka.KinesisVideo.Lens

Operations

CreateSignalingChannel

createSignalingChannel_channelType :: Lens' CreateSignalingChannel (Maybe ChannelType)

A type of the signaling channel that you are creating. Currently, SINGLE_MASTER is the only supported channel type.

createSignalingChannel_singleMasterConfiguration :: Lens' CreateSignalingChannel (Maybe SingleMasterConfiguration)

A structure containing the configuration for the SINGLE_MASTER channel type.

createSignalingChannel_tags :: Lens' CreateSignalingChannel (Maybe [Tag])

A set of tags (key-value pairs) that you want to associate with this channel.

createSignalingChannel_channelName :: Lens' CreateSignalingChannel Text

A name for the signaling channel that you are creating. It must be unique for each Amazon Web Services account and Amazon Web Services Region.

createSignalingChannelResponse_channelARN :: Lens' CreateSignalingChannelResponse (Maybe Text)

The Amazon Resource Name (ARN) of the created channel.

createSignalingChannelResponse_httpStatus :: Lens' CreateSignalingChannelResponse Int

The response's http status code.

CreateStream

createStream_dataRetentionInHours :: Lens' CreateStream (Maybe Natural)

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.

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.

createStream_deviceName :: Lens' CreateStream (Maybe Text)

The name of the device that is writing to the stream.

In the current implementation, Kinesis Video Streams does not use this name.

createStream_kmsKeyId :: Lens' CreateStream (Maybe Text)

The ID of the Key Management Service (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.

createStream_mediaType :: Lens' CreateStream (Maybe Text)

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. If you choose to specify the MediaType, see Naming Requirements 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).

createStream_tags :: Lens' CreateStream (Maybe (HashMap Text Text))

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

createStream_streamName :: Lens' CreateStream Text

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.

createStreamResponse_streamARN :: Lens' CreateStreamResponse (Maybe Text)

The Amazon Resource Name (ARN) of the stream.

createStreamResponse_httpStatus :: Lens' CreateStreamResponse Int

The response's http status code.

DeleteSignalingChannel

deleteSignalingChannel_currentVersion :: Lens' DeleteSignalingChannel (Maybe Text)

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.

deleteSignalingChannel_channelARN :: Lens' DeleteSignalingChannel Text

The Amazon Resource Name (ARN) of the signaling channel that you want to delete.

deleteSignalingChannelResponse_httpStatus :: Lens' DeleteSignalingChannelResponse Int

The response's http status code.

DeleteStream

deleteStream_currentVersion :: Lens' DeleteStream (Maybe Text)

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.

deleteStream_streamARN :: Lens' DeleteStream Text

The Amazon Resource Name (ARN) of the stream that you want to delete.

deleteStreamResponse_httpStatus :: Lens' DeleteStreamResponse Int

The response's http status code.

DescribeEdgeConfiguration

describeEdgeConfiguration_streamARN :: Lens' DescribeEdgeConfiguration (Maybe Text)

The Amazon Resource Name (ARN) of the stream. Specify either the StreamNameor the StreamARN.

describeEdgeConfiguration_streamName :: Lens' DescribeEdgeConfiguration (Maybe Text)

The name of the stream whose edge configuration you want to update. Specify either the StreamName or the StreamARN.

describeEdgeConfigurationResponse_creationTime :: Lens' DescribeEdgeConfigurationResponse (Maybe UTCTime)

The timestamp at which a stream’s edge configuration was first created.

describeEdgeConfigurationResponse_edgeConfig :: Lens' DescribeEdgeConfigurationResponse (Maybe EdgeConfig)

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.

describeEdgeConfigurationResponse_failedStatusDetails :: Lens' DescribeEdgeConfigurationResponse (Maybe Text)

A description of the generated failure status.

describeEdgeConfigurationResponse_lastUpdatedTime :: Lens' DescribeEdgeConfigurationResponse (Maybe UTCTime)

The timestamp at which a stream’s edge configuration was last updated.

describeEdgeConfigurationResponse_streamARN :: Lens' DescribeEdgeConfigurationResponse (Maybe Text)

The Amazon Resource Name (ARN) of the stream.

describeEdgeConfigurationResponse_streamName :: Lens' DescribeEdgeConfigurationResponse (Maybe Text)

The name of the stream from which the edge configuration was updated.

describeEdgeConfigurationResponse_syncStatus :: Lens' DescribeEdgeConfigurationResponse (Maybe SyncStatus)

The latest status of the edge configuration update.

describeEdgeConfigurationResponse_httpStatus :: Lens' DescribeEdgeConfigurationResponse Int

The response's http status code.

DescribeImageGenerationConfiguration

describeImageGenerationConfiguration_streamARN :: Lens' DescribeImageGenerationConfiguration (Maybe Text)

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.

describeImageGenerationConfiguration_streamName :: Lens' DescribeImageGenerationConfiguration (Maybe Text)

The name of the stream from which to retrieve the image generation configuration. You must specify either the StreamName or the StreamARN.

describeImageGenerationConfigurationResponse_imageGenerationConfiguration :: Lens' DescribeImageGenerationConfigurationResponse (Maybe ImageGenerationConfiguration)

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.

describeImageGenerationConfigurationResponse_httpStatus :: Lens' DescribeImageGenerationConfigurationResponse Int

The response's http status code.

DescribeMappedResourceConfiguration

describeMappedResourceConfiguration_maxResults :: Lens' DescribeMappedResourceConfiguration (Maybe Natural)

The maximum number of results to return in the response.

describeMappedResourceConfiguration_nextToken :: Lens' DescribeMappedResourceConfiguration (Maybe Text)

The token to provide in your next request, to get another batch of results.

describeMappedResourceConfiguration_streamARN :: Lens' DescribeMappedResourceConfiguration (Maybe Text)

The Amazon Resource Name (ARN) of the stream.

describeMappedResourceConfiguration_streamName :: Lens' DescribeMappedResourceConfiguration (Maybe Text)

The name of the stream.

describeMappedResourceConfigurationResponse_mappedResourceConfigurationList :: Lens' DescribeMappedResourceConfigurationResponse (Maybe [MappedResourceConfigurationListItem])

A structure that encapsulates, or contains, the media storage configuration properties.

describeMappedResourceConfigurationResponse_nextToken :: Lens' DescribeMappedResourceConfigurationResponse (Maybe Text)

The token that was used in the NextTokenrequest to fetch the next set of results.

describeMappedResourceConfigurationResponse_httpStatus :: Lens' DescribeMappedResourceConfigurationResponse Int

The response's http status code.

DescribeMediaStorageConfiguration

describeMediaStorageConfiguration_channelARN :: Lens' DescribeMediaStorageConfiguration (Maybe Text)

The Amazon Resource Name (ARN) of the channel.

describeMediaStorageConfiguration_channelName :: Lens' DescribeMediaStorageConfiguration (Maybe Text)

The name of the channel.

describeMediaStorageConfigurationResponse_mediaStorageConfiguration :: Lens' DescribeMediaStorageConfigurationResponse (Maybe MediaStorageConfiguration)

A structure that encapsulates, or contains, the media storage configuration properties.

describeMediaStorageConfigurationResponse_httpStatus :: Lens' DescribeMediaStorageConfigurationResponse Int

The response's http status code.

DescribeNotificationConfiguration

describeNotificationConfiguration_streamARN :: Lens' DescribeNotificationConfiguration (Maybe Text)

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.

describeNotificationConfiguration_streamName :: Lens' DescribeNotificationConfiguration (Maybe Text)

The name of the stream from which to retrieve the notification configuration. You must specify either the StreamName or the StreamARN.

describeNotificationConfigurationResponse_notificationConfiguration :: Lens' DescribeNotificationConfigurationResponse (Maybe NotificationConfiguration)

The structure that contains the information required for notifications. If the structure is null, the configuration will be deleted from the stream.

describeNotificationConfigurationResponse_httpStatus :: Lens' DescribeNotificationConfigurationResponse Int

The response's http status code.

DescribeSignalingChannel

describeSignalingChannel_channelARN :: Lens' DescribeSignalingChannel (Maybe Text)

The ARN of the signaling channel that you want to describe.

describeSignalingChannel_channelName :: Lens' DescribeSignalingChannel (Maybe Text)

The name of the signaling channel that you want to describe.

describeSignalingChannelResponse_channelInfo :: Lens' DescribeSignalingChannelResponse (Maybe ChannelInfo)

A structure that encapsulates the specified signaling channel's metadata and properties.

describeSignalingChannelResponse_httpStatus :: Lens' DescribeSignalingChannelResponse Int

The response's http status code.

DescribeStream

describeStream_streamARN :: Lens' DescribeStream (Maybe Text)

The Amazon Resource Name (ARN) of the stream.

describeStream_streamName :: Lens' DescribeStream (Maybe Text)

The name of the stream.

describeStreamResponse_streamInfo :: Lens' DescribeStreamResponse (Maybe StreamInfo)

An object that describes the stream.

describeStreamResponse_httpStatus :: Lens' DescribeStreamResponse Int

The response's http status code.

GetDataEndpoint

getDataEndpoint_streamARN :: Lens' GetDataEndpoint (Maybe Text)

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.

getDataEndpoint_streamName :: Lens' GetDataEndpoint (Maybe Text)

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.

getDataEndpoint_aPIName :: Lens' GetDataEndpoint APIName

The name of the API action for which to get an endpoint.

getDataEndpointResponse_dataEndpoint :: Lens' GetDataEndpointResponse (Maybe Text)

The endpoint value. To read data from the stream or to write data to it, specify this endpoint in your application.

getDataEndpointResponse_httpStatus :: Lens' GetDataEndpointResponse Int

The response's http status code.

GetSignalingChannelEndpoint

getSignalingChannelEndpoint_singleMasterChannelEndpointConfiguration :: Lens' GetSignalingChannelEndpoint (Maybe SingleMasterChannelEndpointConfiguration)

A structure containing the endpoint configuration for the SINGLE_MASTER channel type.

getSignalingChannelEndpoint_channelARN :: Lens' GetSignalingChannelEndpoint Text

The Amazon Resource Name (ARN) of the signalling channel for which you want to get an endpoint.

getSignalingChannelEndpointResponse_resourceEndpointList :: Lens' GetSignalingChannelEndpointResponse (Maybe [ResourceEndpointListItem])

A list of endpoints for the specified signaling channel.

getSignalingChannelEndpointResponse_httpStatus :: Lens' GetSignalingChannelEndpointResponse Int

The response's http status code.

ListSignalingChannels

listSignalingChannels_channelNameCondition :: Lens' ListSignalingChannels (Maybe ChannelNameCondition)

Optional: Returns only the channels that satisfy a specific condition.

listSignalingChannels_maxResults :: Lens' ListSignalingChannels (Maybe Natural)

The maximum number of channels to return in the response. The default is 500.

listSignalingChannels_nextToken :: Lens' ListSignalingChannels (Maybe Text)

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.

listSignalingChannelsResponse_channelInfoList :: Lens' ListSignalingChannelsResponse (Maybe [ChannelInfo])

An array of ChannelInfo objects.

listSignalingChannelsResponse_nextToken :: Lens' ListSignalingChannelsResponse (Maybe Text)

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.

listSignalingChannelsResponse_httpStatus :: Lens' ListSignalingChannelsResponse Int

The response's http status code.

ListStreams

listStreams_maxResults :: Lens' ListStreams (Maybe Natural)

The maximum number of streams to return in the response. The default is 10,000.

listStreams_nextToken :: Lens' ListStreams (Maybe Text)

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.

listStreams_streamNameCondition :: Lens' ListStreams (Maybe StreamNameCondition)

Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

listStreamsResponse_nextToken :: Lens' ListStreamsResponse (Maybe Text)

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.

listStreamsResponse_streamInfoList :: Lens' ListStreamsResponse (Maybe [StreamInfo])

An array of StreamInfo objects.

listStreamsResponse_httpStatus :: Lens' ListStreamsResponse Int

The response's http status code.

ListTagsForResource

listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text)

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.

listTagsForResource_resourceARN :: Lens' ListTagsForResource Text

The Amazon Resource Name (ARN) of the signaling channel for which you want to list tags.

listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text)

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.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))

A map of tag keys and values associated with the specified signaling channel.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int

The response's http status code.

ListTagsForStream

listTagsForStream_nextToken :: Lens' ListTagsForStream (Maybe Text)

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.

listTagsForStream_streamARN :: Lens' ListTagsForStream (Maybe Text)

The Amazon Resource Name (ARN) of the stream that you want to list tags for.

listTagsForStream_streamName :: Lens' ListTagsForStream (Maybe Text)

The name of the stream that you want to list tags for.

listTagsForStreamResponse_nextToken :: Lens' ListTagsForStreamResponse (Maybe Text)

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.

listTagsForStreamResponse_tags :: Lens' ListTagsForStreamResponse (Maybe (HashMap Text Text))

A map of tag keys and values associated with the specified stream.

listTagsForStreamResponse_httpStatus :: Lens' ListTagsForStreamResponse Int

The response's http status code.

StartEdgeConfigurationUpdate

startEdgeConfigurationUpdate_streamARN :: Lens' StartEdgeConfigurationUpdate (Maybe Text)

The Amazon Resource Name (ARN) of the stream. Specify either the StreamName or the StreamARN.

startEdgeConfigurationUpdate_streamName :: Lens' StartEdgeConfigurationUpdate (Maybe Text)

The name of the stream whose edge configuration you want to update. Specify either the StreamName or the StreamARN.

startEdgeConfigurationUpdate_edgeConfig :: Lens' StartEdgeConfigurationUpdate EdgeConfig

The edge configuration details required to invoke the update process.

startEdgeConfigurationUpdateResponse_creationTime :: Lens' StartEdgeConfigurationUpdateResponse (Maybe UTCTime)

The timestamp at which a stream’s edge configuration was first created.

startEdgeConfigurationUpdateResponse_edgeConfig :: Lens' StartEdgeConfigurationUpdateResponse (Maybe EdgeConfig)

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.

startEdgeConfigurationUpdateResponse_failedStatusDetails :: Lens' StartEdgeConfigurationUpdateResponse (Maybe Text)

A description of the generated failure status.

startEdgeConfigurationUpdateResponse_lastUpdatedTime :: Lens' StartEdgeConfigurationUpdateResponse (Maybe UTCTime)

The timestamp at which a stream’s edge configuration was last updated.

startEdgeConfigurationUpdateResponse_streamARN :: Lens' StartEdgeConfigurationUpdateResponse (Maybe Text)

The Amazon Resource Name (ARN) of the stream.

startEdgeConfigurationUpdateResponse_streamName :: Lens' StartEdgeConfigurationUpdateResponse (Maybe Text)

The name of the stream from which the edge configuration was updated.

startEdgeConfigurationUpdateResponse_syncStatus :: Lens' StartEdgeConfigurationUpdateResponse (Maybe SyncStatus)

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.

startEdgeConfigurationUpdateResponse_httpStatus :: Lens' StartEdgeConfigurationUpdateResponse Int

The response's http status code.

TagResource

tagResource_resourceARN :: Lens' TagResource Text

The Amazon Resource Name (ARN) of the signaling channel to which you want to add tags.

tagResource_tags :: Lens' TagResource (NonEmpty Tag)

A list of tags to associate with the specified signaling channel. Each tag is a key-value pair.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int

The response's http status code.

TagStream

tagStream_streamARN :: Lens' TagStream (Maybe Text)

The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.

tagStream_streamName :: Lens' TagStream (Maybe Text)

The name of the stream that you want to add the tag or tags to.

tagStream_tags :: Lens' TagStream (HashMap Text Text)

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

tagStreamResponse_httpStatus :: Lens' TagStreamResponse Int

The response's http status code.

UntagResource

untagResource_resourceARN :: Lens' UntagResource Text

The Amazon Resource Name (ARN) of the signaling channel from which you want to remove tags.

untagResource_tagKeyList :: Lens' UntagResource (NonEmpty Text)

A list of the keys of the tags that you want to remove.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int

The response's http status code.

UntagStream

untagStream_streamARN :: Lens' UntagStream (Maybe Text)

The Amazon Resource Name (ARN) of the stream that you want to remove tags from.

untagStream_streamName :: Lens' UntagStream (Maybe Text)

The name of the stream that you want to remove tags from.

untagStream_tagKeyList :: Lens' UntagStream (NonEmpty Text)

A list of the keys of the tags that you want to remove.

untagStreamResponse_httpStatus :: Lens' UntagStreamResponse Int

The response's http status code.

UpdateDataRetention

updateDataRetention_streamARN :: Lens' UpdateDataRetention (Maybe Text)

The Amazon Resource Name (ARN) of the stream whose retention period you want to change.

updateDataRetention_streamName :: Lens' UpdateDataRetention (Maybe Text)

The name of the stream whose retention period you want to change.

updateDataRetention_currentVersion :: Lens' UpdateDataRetention Text

The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.

updateDataRetention_operation :: Lens' UpdateDataRetention UpdateDataRetentionOperation

Indicates whether you want to increase or decrease the retention period.

updateDataRetention_dataRetentionChangeInHours :: Lens' UpdateDataRetention Natural

The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years).

updateDataRetentionResponse_httpStatus :: Lens' UpdateDataRetentionResponse Int

The response's http status code.

UpdateImageGenerationConfiguration

updateImageGenerationConfiguration_imageGenerationConfiguration :: Lens' UpdateImageGenerationConfiguration (Maybe ImageGenerationConfiguration)

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.

updateImageGenerationConfiguration_streamARN :: Lens' UpdateImageGenerationConfiguration (Maybe Text)

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.

updateImageGenerationConfiguration_streamName :: Lens' UpdateImageGenerationConfiguration (Maybe Text)

The name of the stream from which to update the image generation configuration. You must specify either the StreamName or the StreamARN.

updateImageGenerationConfigurationResponse_httpStatus :: Lens' UpdateImageGenerationConfigurationResponse Int

The response's http status code.

UpdateMediaStorageConfiguration

updateMediaStorageConfiguration_channelARN :: Lens' UpdateMediaStorageConfiguration Text

The Amazon Resource Name (ARN) of the channel.

updateMediaStorageConfiguration_mediaStorageConfiguration :: Lens' UpdateMediaStorageConfiguration MediaStorageConfiguration

A structure that encapsulates, or contains, the media storage configuration properties.

updateMediaStorageConfigurationResponse_httpStatus :: Lens' UpdateMediaStorageConfigurationResponse Int

The response's http status code.

UpdateNotificationConfiguration

updateNotificationConfiguration_notificationConfiguration :: Lens' UpdateNotificationConfiguration (Maybe NotificationConfiguration)

The structure containing the information required for notifications. If the structure is null, the configuration will be deleted from the stream.

updateNotificationConfiguration_streamARN :: Lens' UpdateNotificationConfiguration (Maybe Text)

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.

updateNotificationConfiguration_streamName :: Lens' UpdateNotificationConfiguration (Maybe Text)

The name of the stream from which to update the notification configuration. You must specify either the StreamName or the StreamARN.

updateNotificationConfigurationResponse_httpStatus :: Lens' UpdateNotificationConfigurationResponse Int

The response's http status code.

UpdateSignalingChannel

updateSignalingChannel_singleMasterConfiguration :: Lens' UpdateSignalingChannel (Maybe SingleMasterConfiguration)

The structure containing the configuration for the SINGLE_MASTER type of the signaling channel that you want to update.

updateSignalingChannel_channelARN :: Lens' UpdateSignalingChannel Text

The Amazon Resource Name (ARN) of the signaling channel that you want to update.

updateSignalingChannel_currentVersion :: Lens' UpdateSignalingChannel Text

The current version of the signaling channel that you want to update.

updateSignalingChannelResponse_httpStatus :: Lens' UpdateSignalingChannelResponse Int

The response's http status code.

UpdateStream

updateStream_deviceName :: Lens' UpdateStream (Maybe Text)

The name of the device that is writing to the stream.

In the current implementation, Kinesis Video Streams does not use this name.

updateStream_mediaType :: Lens' UpdateStream (Maybe Text)

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. If you choose to specify the MediaType, see Naming Requirements.

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.

updateStream_streamARN :: Lens' UpdateStream (Maybe Text)

The ARN of the stream whose metadata you want to update.

updateStream_streamName :: Lens' UpdateStream (Maybe Text)

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.

updateStream_currentVersion :: Lens' UpdateStream Text

The version of the stream whose metadata you want to update.

updateStreamResponse_httpStatus :: Lens' UpdateStreamResponse Int

The response's http status code.

Types

ChannelInfo

channelInfo_channelARN :: Lens' ChannelInfo (Maybe Text)

The Amazon Resource Name (ARN) of the signaling channel.

channelInfo_channelName :: Lens' ChannelInfo (Maybe Text)

The name of the signaling channel.

channelInfo_channelStatus :: Lens' ChannelInfo (Maybe StreamStatus)

Current status of the signaling channel.

channelInfo_channelType :: Lens' ChannelInfo (Maybe ChannelType)

The type of the signaling channel.

channelInfo_creationTime :: Lens' ChannelInfo (Maybe UTCTime)

The time at which the signaling channel was created.

channelInfo_singleMasterConfiguration :: Lens' ChannelInfo (Maybe SingleMasterConfiguration)

A structure that contains the configuration for the SINGLE_MASTER channel type.

channelInfo_version :: Lens' ChannelInfo (Maybe Text)

The current version of the signaling channel.

ChannelNameCondition

channelNameCondition_comparisonOperator :: Lens' ChannelNameCondition (Maybe ComparisonOperator)

A comparison operator. Currently, you can only specify the BEGINS_WITH operator, which finds signaling channels whose names begin with a given prefix.

channelNameCondition_comparisonValue :: Lens' ChannelNameCondition (Maybe Text)

A value to compare.

DeletionConfig

deletionConfig_deleteAfterUpload :: Lens' DeletionConfig (Maybe Bool)

The boolean value used to indicate whether or not you want to mark the media for deletion, once it has been uploaded to the Kinesis Video Stream cloud. The media files can be deleted if any of the deletion configuration values are set to true, such as when the limit for the EdgeRetentionInHours, or the MaxLocalMediaSizeInMB, has been reached.

Since the default value is set to true, configure the uploader schedule such that the media files are not being deleted before they are initially uploaded to AWS cloud.

deletionConfig_edgeRetentionInHours :: Lens' DeletionConfig (Maybe Natural)

The number of hours that you want to retain the data in the stream on the Edge Agent. The default value of the retention time is 720 hours, which translates to 30 days.

deletionConfig_localSizeConfig :: Lens' DeletionConfig (Maybe LocalSizeConfig)

The value of the local size required in order to delete the edge configuration.

EdgeConfig

edgeConfig_deletionConfig :: Lens' EdgeConfig (Maybe DeletionConfig)

The deletion configuration is made up of the retention time (EdgeRetentionInHours) and local size configuration (LocalSizeConfig) details that are used to make the deletion.

edgeConfig_uploaderConfig :: Lens' EdgeConfig (Maybe UploaderConfig)

The uploader configuration contains the ScheduleExpression details that are used to schedule upload jobs for the recorded media files from the Edge Agent to a Kinesis Video Stream.

edgeConfig_hubDeviceArn :: Lens' EdgeConfig Text

The "Internet of Things (IoT) Thing" Arn of the stream.

edgeConfig_recorderConfig :: Lens' EdgeConfig RecorderConfig

The recorder configuration consists of the local MediaSourceConfig details, that are used as credentials to access the local media files streamed on the camera.

ImageGenerationConfiguration

imageGenerationConfiguration_formatConfig :: Lens' ImageGenerationConfiguration (Maybe (HashMap FormatConfigKey Text))

The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

imageGenerationConfiguration_heightPixels :: Lens' ImageGenerationConfiguration (Maybe Natural)

The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

imageGenerationConfiguration_widthPixels :: Lens' ImageGenerationConfiguration (Maybe Natural)

The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.

imageGenerationConfiguration_status :: Lens' ImageGenerationConfiguration ConfigurationStatus

Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

imageGenerationConfiguration_imageSelectorType :: Lens' ImageGenerationConfiguration ImageSelectorType

The origin of the Server or Producer timestamps to use to generate the images.

imageGenerationConfiguration_destinationConfig :: Lens' ImageGenerationConfiguration ImageGenerationDestinationConfig

The structure that contains the information required to deliver images to a customer.

imageGenerationConfiguration_samplingInterval :: Lens' ImageGenerationConfiguration Natural

The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 33 ms, because a camera that generates content at 30 FPS would create a frame every 33.3 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

imageGenerationConfiguration_format :: Lens' ImageGenerationConfiguration Format

The accepted image format.

ImageGenerationDestinationConfig

imageGenerationDestinationConfig_uri :: Lens' ImageGenerationDestinationConfig Text

The Uniform Resource Identifier (URI) that identifies where the images will be delivered.

imageGenerationDestinationConfig_destinationRegion :: Lens' ImageGenerationDestinationConfig Text

The AWS Region of the S3 bucket where images will be delivered. This DestinationRegion must match the Region where the stream is located.

LocalSizeConfig

localSizeConfig_maxLocalMediaSizeInMB :: Lens' LocalSizeConfig (Maybe Natural)

The overall maximum size of the media that you want to store for a stream on the Edge Agent.

localSizeConfig_strategyOnFullSize :: Lens' LocalSizeConfig (Maybe StrategyOnFullSize)

The strategy to perform when a stream’s MaxLocalMediaSizeInMB limit is reached.

MappedResourceConfigurationListItem

mappedResourceConfigurationListItem_arn :: Lens' MappedResourceConfigurationListItem (Maybe Text)

The Amazon Resource Name (ARN) of the Kinesis Video Stream resource, associated with the stream.

mappedResourceConfigurationListItem_type :: Lens' MappedResourceConfigurationListItem (Maybe Text)

The type of the associated resource for the kinesis video stream.

MediaSourceConfig

mediaSourceConfig_mediaUriSecretArn :: Lens' MediaSourceConfig Text

The AWS Secrets Manager ARN for the username and password of the camera, or a local media file location.

mediaSourceConfig_mediaUriType :: Lens' MediaSourceConfig MediaUriType

The Uniform Resource Identifier (URI) type. The FILE_URI value can be used to stream local media files.

Preview only supports the RTSP_URI media source URI format .

MediaStorageConfiguration

mediaStorageConfiguration_streamARN :: Lens' MediaStorageConfiguration (Maybe Text)

The Amazon Resource Name (ARN) of the stream

mediaStorageConfiguration_status :: Lens' MediaStorageConfiguration MediaStorageConfigurationStatus

The status of the media storage configuration.

NotificationConfiguration

notificationConfiguration_status :: Lens' NotificationConfiguration ConfigurationStatus

Indicates if a notification configuration is enabled or disabled.

notificationConfiguration_destinationConfig :: Lens' NotificationConfiguration NotificationDestinationConfig

The destination information required to deliver a notification to a customer.

NotificationDestinationConfig

notificationDestinationConfig_uri :: Lens' NotificationDestinationConfig Text

The Uniform Resource Identifier (URI) that identifies where the images will be delivered.

RecorderConfig

recorderConfig_scheduleConfig :: Lens' RecorderConfig (Maybe ScheduleConfig)

The configuration that consists of the ScheduleExpression and the DurationInMinutes details that specify the scheduling to record from a camera, or local media file, onto the Edge Agent. If the ScheduleExpression attribute is not provided, then the Edge Agent will always be set to recording mode.

recorderConfig_mediaSourceConfig :: Lens' RecorderConfig MediaSourceConfig

The configuration details that consist of the credentials required (MediaUriSecretArn and MediaUriType) to access the media files streamed to the camera.

ResourceEndpointListItem

resourceEndpointListItem_protocol :: Lens' ResourceEndpointListItem (Maybe ChannelProtocol)

The protocol of the signaling channel returned by the GetSignalingChannelEndpoint API.

resourceEndpointListItem_resourceEndpoint :: Lens' ResourceEndpointListItem (Maybe Text)

The endpoint of the signaling channel returned by the GetSignalingChannelEndpoint API.

ScheduleConfig

scheduleConfig_scheduleExpression :: Lens' ScheduleConfig Text

The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig, then the Edge Agent will always be set to recording mode.

For more information about Quartz, refer to the Cron Trigger Tutorial page to understand the valid expressions and its use.

scheduleConfig_durationInSeconds :: Lens' ScheduleConfig Natural

The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.

SingleMasterChannelEndpointConfiguration

singleMasterChannelEndpointConfiguration_protocols :: Lens' SingleMasterChannelEndpointConfiguration (Maybe (NonEmpty ChannelProtocol))

This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel. If WSS is specified, this API returns a websocket endpoint. If HTTPS is specified, this API returns an HTTPS endpoint.

singleMasterChannelEndpointConfiguration_role :: Lens' SingleMasterChannelEndpointConfiguration (Maybe ChannelRole)

This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel. If MASTER is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. If VIEWER is specified, this API returns an endpoint that a client can use only to send offers to another MASTER client on this signaling channel.

SingleMasterConfiguration

singleMasterConfiguration_messageTtlSeconds :: Lens' SingleMasterConfiguration (Maybe Natural)

The period of time a signaling channel retains undelivered messages before they are discarded.

StreamInfo

streamInfo_creationTime :: Lens' StreamInfo (Maybe UTCTime)

A time stamp that indicates when the stream was created.

streamInfo_dataRetentionInHours :: Lens' StreamInfo (Maybe Natural)

How long the stream retains data, in hours.

streamInfo_deviceName :: Lens' StreamInfo (Maybe Text)

The name of the device that is associated with the stream.

streamInfo_kmsKeyId :: Lens' StreamInfo (Maybe Text)

The ID of the Key Management Service (KMS) key that Kinesis Video Streams uses to encrypt data on the stream.

streamInfo_mediaType :: Lens' StreamInfo (Maybe Text)

The MediaType of the stream.

streamInfo_status :: Lens' StreamInfo (Maybe StreamStatus)

The status of the stream.

streamInfo_streamARN :: Lens' StreamInfo (Maybe Text)

The Amazon Resource Name (ARN) of the stream.

streamInfo_streamName :: Lens' StreamInfo (Maybe Text)

The name of the stream.

streamInfo_version :: Lens' StreamInfo (Maybe Text)

The version of the stream.

StreamNameCondition

streamNameCondition_comparisonOperator :: Lens' StreamNameCondition (Maybe ComparisonOperator)

A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix.

streamNameCondition_comparisonValue :: Lens' StreamNameCondition (Maybe Text)

A value to compare.

Tag

tag_key :: Lens' Tag Text

The key of the tag that is associated with the specified signaling channel.

tag_value :: Lens' Tag Text

The value of the tag that is associated with the specified signaling channel.

UploaderConfig

uploaderConfig_scheduleConfig :: Lens' UploaderConfig ScheduleConfig

The configuration that consists of the ScheduleExpression and the DurationInMinutesdetails that specify the scheduling to record from a camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided, then the Edge Agent will always be in recording mode.