| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.KinesisVideo.Types
Contents
- Service Configuration
- Errors
- APIName
- ChannelProtocol
- ChannelRole
- ChannelType
- ComparisonOperator
- ConfigurationStatus
- Format
- FormatConfigKey
- ImageSelectorType
- MediaStorageConfigurationStatus
- MediaUriType
- StrategyOnFullSize
- StreamStatus
- SyncStatus
- UpdateDataRetentionOperation
- ChannelInfo
- ChannelNameCondition
- DeletionConfig
- EdgeConfig
- ImageGenerationConfiguration
- ImageGenerationDestinationConfig
- LocalSizeConfig
- MappedResourceConfigurationListItem
- MediaSourceConfig
- MediaStorageConfiguration
- NotificationConfiguration
- NotificationDestinationConfig
- RecorderConfig
- ResourceEndpointListItem
- ScheduleConfig
- SingleMasterChannelEndpointConfiguration
- SingleMasterConfiguration
- StreamInfo
- StreamNameCondition
- Tag
- UploaderConfig
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _AccountChannelLimitExceededException :: AsError a => Fold a ServiceError
- _AccountStreamLimitExceededException :: AsError a => Fold a ServiceError
- _ClientLimitExceededException :: AsError a => Fold a ServiceError
- _DeviceStreamLimitExceededException :: AsError a => Fold a ServiceError
- _InvalidArgumentException :: AsError a => Fold a ServiceError
- _InvalidDeviceException :: AsError a => Fold a ServiceError
- _InvalidResourceFormatException :: AsError a => Fold a ServiceError
- _NoDataRetentionException :: AsError a => Fold a ServiceError
- _NotAuthorizedException :: AsError a => Fold a ServiceError
- _ResourceInUseException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _StreamEdgeConfigurationNotFoundException :: AsError a => Fold a ServiceError
- _TagsPerResourceExceededLimitException :: AsError a => Fold a ServiceError
- _VersionMismatchException :: AsError a => Fold a ServiceError
- newtype APIName where
- APIName' {
- fromAPIName :: Text
- pattern APIName_GET_CLIP :: APIName
- pattern APIName_GET_DASH_STREAMING_SESSION_URL :: APIName
- pattern APIName_GET_HLS_STREAMING_SESSION_URL :: APIName
- pattern APIName_GET_IMAGES :: APIName
- pattern APIName_GET_MEDIA :: APIName
- pattern APIName_GET_MEDIA_FOR_FRAGMENT_LIST :: APIName
- pattern APIName_LIST_FRAGMENTS :: APIName
- pattern APIName_PUT_MEDIA :: APIName
- APIName' {
- newtype ChannelProtocol where
- ChannelProtocol' { }
- pattern ChannelProtocol_HTTPS :: ChannelProtocol
- pattern ChannelProtocol_WEBRTC :: ChannelProtocol
- pattern ChannelProtocol_WSS :: ChannelProtocol
- newtype ChannelRole where
- ChannelRole' { }
- pattern ChannelRole_MASTER :: ChannelRole
- pattern ChannelRole_VIEWER :: ChannelRole
- newtype ChannelType where
- ChannelType' { }
- pattern ChannelType_FULL_MESH :: ChannelType
- pattern ChannelType_SINGLE_MASTER :: ChannelType
- newtype ComparisonOperator where
- newtype ConfigurationStatus where
- newtype Format where
- Format' {
- fromFormat :: Text
- pattern Format_JPEG :: Format
- pattern Format_PNG :: Format
- Format' {
- newtype FormatConfigKey where
- FormatConfigKey' { }
- pattern FormatConfigKey_JPEGQuality :: FormatConfigKey
- newtype ImageSelectorType where
- newtype MediaStorageConfigurationStatus where
- newtype MediaUriType where
- MediaUriType' { }
- pattern MediaUriType_FILE_URI :: MediaUriType
- pattern MediaUriType_RTSP_URI :: MediaUriType
- newtype StrategyOnFullSize where
- newtype StreamStatus where
- StreamStatus' { }
- pattern StreamStatus_ACTIVE :: StreamStatus
- pattern StreamStatus_CREATING :: StreamStatus
- pattern StreamStatus_DELETING :: StreamStatus
- pattern StreamStatus_UPDATING :: StreamStatus
- newtype SyncStatus where
- SyncStatus' { }
- pattern SyncStatus_ACKNOWLEDGED :: SyncStatus
- pattern SyncStatus_DELETE_FAILED :: SyncStatus
- pattern SyncStatus_DELETING :: SyncStatus
- pattern SyncStatus_IN_SYNC :: SyncStatus
- pattern SyncStatus_SYNCING :: SyncStatus
- pattern SyncStatus_SYNC_FAILED :: SyncStatus
- newtype UpdateDataRetentionOperation where
- data ChannelInfo = ChannelInfo' {}
- newChannelInfo :: ChannelInfo
- channelInfo_channelARN :: Lens' ChannelInfo (Maybe Text)
- channelInfo_channelName :: Lens' ChannelInfo (Maybe Text)
- channelInfo_channelStatus :: Lens' ChannelInfo (Maybe StreamStatus)
- channelInfo_channelType :: Lens' ChannelInfo (Maybe ChannelType)
- channelInfo_creationTime :: Lens' ChannelInfo (Maybe UTCTime)
- channelInfo_singleMasterConfiguration :: Lens' ChannelInfo (Maybe SingleMasterConfiguration)
- channelInfo_version :: Lens' ChannelInfo (Maybe Text)
- data ChannelNameCondition = ChannelNameCondition' {}
- newChannelNameCondition :: ChannelNameCondition
- channelNameCondition_comparisonOperator :: Lens' ChannelNameCondition (Maybe ComparisonOperator)
- channelNameCondition_comparisonValue :: Lens' ChannelNameCondition (Maybe Text)
- data DeletionConfig = DeletionConfig' {}
- newDeletionConfig :: DeletionConfig
- deletionConfig_deleteAfterUpload :: Lens' DeletionConfig (Maybe Bool)
- deletionConfig_edgeRetentionInHours :: Lens' DeletionConfig (Maybe Natural)
- deletionConfig_localSizeConfig :: Lens' DeletionConfig (Maybe LocalSizeConfig)
- data EdgeConfig = EdgeConfig' {}
- newEdgeConfig :: Text -> RecorderConfig -> EdgeConfig
- edgeConfig_deletionConfig :: Lens' EdgeConfig (Maybe DeletionConfig)
- edgeConfig_uploaderConfig :: Lens' EdgeConfig (Maybe UploaderConfig)
- edgeConfig_hubDeviceArn :: Lens' EdgeConfig Text
- edgeConfig_recorderConfig :: Lens' EdgeConfig RecorderConfig
- data ImageGenerationConfiguration = ImageGenerationConfiguration' {}
- newImageGenerationConfiguration :: ConfigurationStatus -> ImageSelectorType -> ImageGenerationDestinationConfig -> Natural -> Format -> ImageGenerationConfiguration
- imageGenerationConfiguration_formatConfig :: Lens' ImageGenerationConfiguration (Maybe (HashMap FormatConfigKey Text))
- imageGenerationConfiguration_heightPixels :: Lens' ImageGenerationConfiguration (Maybe Natural)
- imageGenerationConfiguration_widthPixels :: Lens' ImageGenerationConfiguration (Maybe Natural)
- imageGenerationConfiguration_status :: Lens' ImageGenerationConfiguration ConfigurationStatus
- imageGenerationConfiguration_imageSelectorType :: Lens' ImageGenerationConfiguration ImageSelectorType
- imageGenerationConfiguration_destinationConfig :: Lens' ImageGenerationConfiguration ImageGenerationDestinationConfig
- imageGenerationConfiguration_samplingInterval :: Lens' ImageGenerationConfiguration Natural
- imageGenerationConfiguration_format :: Lens' ImageGenerationConfiguration Format
- data ImageGenerationDestinationConfig = ImageGenerationDestinationConfig' {
- uri :: Text
- destinationRegion :: Text
- newImageGenerationDestinationConfig :: Text -> Text -> ImageGenerationDestinationConfig
- imageGenerationDestinationConfig_uri :: Lens' ImageGenerationDestinationConfig Text
- imageGenerationDestinationConfig_destinationRegion :: Lens' ImageGenerationDestinationConfig Text
- data LocalSizeConfig = LocalSizeConfig' {}
- newLocalSizeConfig :: LocalSizeConfig
- localSizeConfig_maxLocalMediaSizeInMB :: Lens' LocalSizeConfig (Maybe Natural)
- localSizeConfig_strategyOnFullSize :: Lens' LocalSizeConfig (Maybe StrategyOnFullSize)
- data MappedResourceConfigurationListItem = MappedResourceConfigurationListItem' {}
- newMappedResourceConfigurationListItem :: MappedResourceConfigurationListItem
- mappedResourceConfigurationListItem_arn :: Lens' MappedResourceConfigurationListItem (Maybe Text)
- mappedResourceConfigurationListItem_type :: Lens' MappedResourceConfigurationListItem (Maybe Text)
- data MediaSourceConfig = MediaSourceConfig' {}
- newMediaSourceConfig :: Text -> MediaUriType -> MediaSourceConfig
- mediaSourceConfig_mediaUriSecretArn :: Lens' MediaSourceConfig Text
- mediaSourceConfig_mediaUriType :: Lens' MediaSourceConfig MediaUriType
- data MediaStorageConfiguration = MediaStorageConfiguration' {}
- newMediaStorageConfiguration :: MediaStorageConfigurationStatus -> MediaStorageConfiguration
- mediaStorageConfiguration_streamARN :: Lens' MediaStorageConfiguration (Maybe Text)
- mediaStorageConfiguration_status :: Lens' MediaStorageConfiguration MediaStorageConfigurationStatus
- data NotificationConfiguration = NotificationConfiguration' {}
- newNotificationConfiguration :: ConfigurationStatus -> NotificationDestinationConfig -> NotificationConfiguration
- notificationConfiguration_status :: Lens' NotificationConfiguration ConfigurationStatus
- notificationConfiguration_destinationConfig :: Lens' NotificationConfiguration NotificationDestinationConfig
- data NotificationDestinationConfig = NotificationDestinationConfig' {}
- newNotificationDestinationConfig :: Text -> NotificationDestinationConfig
- notificationDestinationConfig_uri :: Lens' NotificationDestinationConfig Text
- data RecorderConfig = RecorderConfig' {}
- newRecorderConfig :: MediaSourceConfig -> RecorderConfig
- recorderConfig_scheduleConfig :: Lens' RecorderConfig (Maybe ScheduleConfig)
- recorderConfig_mediaSourceConfig :: Lens' RecorderConfig MediaSourceConfig
- data ResourceEndpointListItem = ResourceEndpointListItem' {}
- newResourceEndpointListItem :: ResourceEndpointListItem
- resourceEndpointListItem_protocol :: Lens' ResourceEndpointListItem (Maybe ChannelProtocol)
- resourceEndpointListItem_resourceEndpoint :: Lens' ResourceEndpointListItem (Maybe Text)
- data ScheduleConfig = ScheduleConfig' {}
- newScheduleConfig :: Text -> Natural -> ScheduleConfig
- scheduleConfig_scheduleExpression :: Lens' ScheduleConfig Text
- scheduleConfig_durationInSeconds :: Lens' ScheduleConfig Natural
- data SingleMasterChannelEndpointConfiguration = SingleMasterChannelEndpointConfiguration' {}
- newSingleMasterChannelEndpointConfiguration :: SingleMasterChannelEndpointConfiguration
- singleMasterChannelEndpointConfiguration_protocols :: Lens' SingleMasterChannelEndpointConfiguration (Maybe (NonEmpty ChannelProtocol))
- singleMasterChannelEndpointConfiguration_role :: Lens' SingleMasterChannelEndpointConfiguration (Maybe ChannelRole)
- data SingleMasterConfiguration = SingleMasterConfiguration' {}
- newSingleMasterConfiguration :: SingleMasterConfiguration
- singleMasterConfiguration_messageTtlSeconds :: Lens' SingleMasterConfiguration (Maybe Natural)
- data StreamInfo = StreamInfo' {}
- newStreamInfo :: StreamInfo
- streamInfo_creationTime :: Lens' StreamInfo (Maybe UTCTime)
- streamInfo_dataRetentionInHours :: Lens' StreamInfo (Maybe Natural)
- streamInfo_deviceName :: Lens' StreamInfo (Maybe Text)
- streamInfo_kmsKeyId :: Lens' StreamInfo (Maybe Text)
- streamInfo_mediaType :: Lens' StreamInfo (Maybe Text)
- streamInfo_status :: Lens' StreamInfo (Maybe StreamStatus)
- streamInfo_streamARN :: Lens' StreamInfo (Maybe Text)
- streamInfo_streamName :: Lens' StreamInfo (Maybe Text)
- streamInfo_version :: Lens' StreamInfo (Maybe Text)
- data StreamNameCondition = StreamNameCondition' {}
- newStreamNameCondition :: StreamNameCondition
- streamNameCondition_comparisonOperator :: Lens' StreamNameCondition (Maybe ComparisonOperator)
- streamNameCondition_comparisonValue :: Lens' StreamNameCondition (Maybe Text)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data UploaderConfig = UploaderConfig' {}
- newUploaderConfig :: ScheduleConfig -> UploaderConfig
- uploaderConfig_scheduleConfig :: Lens' UploaderConfig ScheduleConfig
Service Configuration
defaultService :: Service Source #
API version 2017-09-30 of the Amazon Kinesis Video Streams SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have required permissions to perform this operation.
_AccountChannelLimitExceededException :: AsError a => Fold a ServiceError Source #
You have reached the maximum limit of active signaling channels for this Amazon Web Services account in this region.
_AccountStreamLimitExceededException :: AsError a => Fold a ServiceError Source #
The number of streams created for the account is too high.
_ClientLimitExceededException :: AsError a => Fold a ServiceError Source #
Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
_DeviceStreamLimitExceededException :: AsError a => Fold a ServiceError Source #
Not implemented.
_InvalidArgumentException :: AsError a => Fold a ServiceError Source #
The value for this input parameter is invalid.
_InvalidDeviceException :: AsError a => Fold a ServiceError Source #
Not implemented.
_InvalidResourceFormatException :: AsError a => Fold a ServiceError Source #
The format of the StreamARN is invalid.
_NoDataRetentionException :: AsError a => Fold a ServiceError Source #
The Stream data retention in hours is equal to zero.
_NotAuthorizedException :: AsError a => Fold a ServiceError Source #
The caller is not authorized to perform this operation.
_ResourceInUseException :: AsError a => Fold a ServiceError Source #
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 :
- The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. - The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. - The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Amazon Kinesis Video Streams can't find the stream that you specified.
_StreamEdgeConfigurationNotFoundException :: AsError a => Fold a ServiceError Source #
The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's edge configuration that you specified.
_TagsPerResourceExceededLimitException :: AsError a => Fold a ServiceError Source #
You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags.
_VersionMismatchException :: AsError a => Fold a ServiceError Source #
The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.
APIName
Constructors
| APIName' | |
Fields
| |
Bundled Patterns
| pattern APIName_GET_CLIP :: APIName | |
| pattern APIName_GET_DASH_STREAMING_SESSION_URL :: APIName | |
| pattern APIName_GET_HLS_STREAMING_SESSION_URL :: APIName | |
| pattern APIName_GET_IMAGES :: APIName | |
| pattern APIName_GET_MEDIA :: APIName | |
| pattern APIName_GET_MEDIA_FOR_FRAGMENT_LIST :: APIName | |
| pattern APIName_LIST_FRAGMENTS :: APIName | |
| pattern APIName_PUT_MEDIA :: APIName |
Instances
ChannelProtocol
newtype ChannelProtocol Source #
Constructors
| ChannelProtocol' | |
Fields | |
Bundled Patterns
| pattern ChannelProtocol_HTTPS :: ChannelProtocol | |
| pattern ChannelProtocol_WEBRTC :: ChannelProtocol | |
| pattern ChannelProtocol_WSS :: ChannelProtocol |
Instances
ChannelRole
newtype ChannelRole Source #
Constructors
| ChannelRole' | |
Fields | |
Bundled Patterns
| pattern ChannelRole_MASTER :: ChannelRole | |
| pattern ChannelRole_VIEWER :: ChannelRole |
Instances
ChannelType
newtype ChannelType Source #
Constructors
| ChannelType' | |
Fields | |
Bundled Patterns
| pattern ChannelType_FULL_MESH :: ChannelType | |
| pattern ChannelType_SINGLE_MASTER :: ChannelType |
Instances
ComparisonOperator
newtype ComparisonOperator Source #
Constructors
| ComparisonOperator' | |
Fields | |
Bundled Patterns
| pattern ComparisonOperator_BEGINS_WITH :: ComparisonOperator |
Instances
ConfigurationStatus
newtype ConfigurationStatus Source #
Constructors
| ConfigurationStatus' | |
Fields | |
Bundled Patterns
| pattern ConfigurationStatus_DISABLED :: ConfigurationStatus | |
| pattern ConfigurationStatus_ENABLED :: ConfigurationStatus |
Instances
Format
Constructors
| Format' | |
Fields
| |
Bundled Patterns
| pattern Format_JPEG :: Format | |
| pattern Format_PNG :: Format |
Instances
FormatConfigKey
newtype FormatConfigKey Source #
Constructors
| FormatConfigKey' | |
Fields | |
Bundled Patterns
| pattern FormatConfigKey_JPEGQuality :: FormatConfigKey |
Instances
ImageSelectorType
newtype ImageSelectorType Source #
Constructors
| ImageSelectorType' | |
Fields | |
Bundled Patterns
| pattern ImageSelectorType_PRODUCER_TIMESTAMP :: ImageSelectorType | |
| pattern ImageSelectorType_SERVER_TIMESTAMP :: ImageSelectorType |
Instances
MediaStorageConfigurationStatus
newtype MediaStorageConfigurationStatus Source #
Constructors
| MediaStorageConfigurationStatus' | |
Fields | |
Bundled Patterns
| pattern MediaStorageConfigurationStatus_DISABLED :: MediaStorageConfigurationStatus | |
| pattern MediaStorageConfigurationStatus_ENABLED :: MediaStorageConfigurationStatus |
Instances
MediaUriType
newtype MediaUriType Source #
Constructors
| MediaUriType' | |
Fields | |
Bundled Patterns
| pattern MediaUriType_FILE_URI :: MediaUriType | |
| pattern MediaUriType_RTSP_URI :: MediaUriType |
Instances
StrategyOnFullSize
newtype StrategyOnFullSize Source #
Constructors
| StrategyOnFullSize' | |
Fields | |
Bundled Patterns
| pattern StrategyOnFullSize_DELETE_OLDEST_MEDIA :: StrategyOnFullSize | |
| pattern StrategyOnFullSize_DENY_NEW_MEDIA :: StrategyOnFullSize |
Instances
StreamStatus
newtype StreamStatus Source #
Constructors
| StreamStatus' | |
Fields | |
Bundled Patterns
| pattern StreamStatus_ACTIVE :: StreamStatus | |
| pattern StreamStatus_CREATING :: StreamStatus | |
| pattern StreamStatus_DELETING :: StreamStatus | |
| pattern StreamStatus_UPDATING :: StreamStatus |
Instances
SyncStatus
newtype SyncStatus Source #
Constructors
| SyncStatus' | |
Fields | |
Bundled Patterns
| pattern SyncStatus_ACKNOWLEDGED :: SyncStatus | |
| pattern SyncStatus_DELETE_FAILED :: SyncStatus | |
| pattern SyncStatus_DELETING :: SyncStatus | |
| pattern SyncStatus_IN_SYNC :: SyncStatus | |
| pattern SyncStatus_SYNCING :: SyncStatus | |
| pattern SyncStatus_SYNC_FAILED :: SyncStatus |
Instances
UpdateDataRetentionOperation
newtype UpdateDataRetentionOperation Source #
Constructors
| UpdateDataRetentionOperation' | |
Fields | |
Bundled Patterns
| pattern UpdateDataRetentionOperation_DECREASE_DATA_RETENTION :: UpdateDataRetentionOperation | |
| pattern UpdateDataRetentionOperation_INCREASE_DATA_RETENTION :: UpdateDataRetentionOperation |
Instances
ChannelInfo
data ChannelInfo Source #
A structure that encapsulates a signaling channel's metadata and properties.
See: newChannelInfo smart constructor.
Constructors
| ChannelInfo' | |
Fields
| |
Instances
newChannelInfo :: ChannelInfo Source #
Create a value of ChannelInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelARN:ChannelInfo', channelInfo_channelARN - The Amazon Resource Name (ARN) of the signaling channel.
$sel:channelName:ChannelInfo', channelInfo_channelName - The name of the signaling channel.
$sel:channelStatus:ChannelInfo', channelInfo_channelStatus - Current status of the signaling channel.
$sel:channelType:ChannelInfo', channelInfo_channelType - The type of the signaling channel.
$sel:creationTime:ChannelInfo', channelInfo_creationTime - The time at which the signaling channel was created.
$sel:singleMasterConfiguration:ChannelInfo', channelInfo_singleMasterConfiguration - A structure that contains the configuration for the SINGLE_MASTER
channel type.
$sel:version:ChannelInfo', channelInfo_version - The current version of the signaling channel.
channelInfo_channelARN :: Lens' ChannelInfo (Maybe Text) Source #
The Amazon Resource Name (ARN) of the signaling channel.
channelInfo_channelName :: Lens' ChannelInfo (Maybe Text) Source #
The name of the signaling channel.
channelInfo_channelStatus :: Lens' ChannelInfo (Maybe StreamStatus) Source #
Current status of the signaling channel.
channelInfo_channelType :: Lens' ChannelInfo (Maybe ChannelType) Source #
The type of the signaling channel.
channelInfo_creationTime :: Lens' ChannelInfo (Maybe UTCTime) Source #
The time at which the signaling channel was created.
channelInfo_singleMasterConfiguration :: Lens' ChannelInfo (Maybe SingleMasterConfiguration) Source #
A structure that contains the configuration for the SINGLE_MASTER
channel type.
channelInfo_version :: Lens' ChannelInfo (Maybe Text) Source #
The current version of the signaling channel.
ChannelNameCondition
data ChannelNameCondition Source #
An optional input parameter for the ListSignalingChannels API. When
this parameter is specified while invoking ListSignalingChannels, the
API returns only the channels that satisfy a condition specified in
ChannelNameCondition.
See: newChannelNameCondition smart constructor.
Constructors
| ChannelNameCondition' | |
Fields
| |
Instances
newChannelNameCondition :: ChannelNameCondition Source #
Create a value of ChannelNameCondition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:comparisonOperator:ChannelNameCondition', channelNameCondition_comparisonOperator - A comparison operator. Currently, you can only specify the BEGINS_WITH
operator, which finds signaling channels whose names begin with a given
prefix.
$sel:comparisonValue:ChannelNameCondition', channelNameCondition_comparisonValue - A value to compare.
channelNameCondition_comparisonOperator :: Lens' ChannelNameCondition (Maybe ComparisonOperator) Source #
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) Source #
A value to compare.
DeletionConfig
data DeletionConfig Source #
The configuration details required to delete the connection of the stream from the Edge Agent.
See: newDeletionConfig smart constructor.
Constructors
| DeletionConfig' | |
Fields
| |
Instances
newDeletionConfig :: DeletionConfig Source #
Create a value of DeletionConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deleteAfterUpload:DeletionConfig', deletionConfig_deleteAfterUpload - 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.
$sel:edgeRetentionInHours:DeletionConfig', deletionConfig_edgeRetentionInHours - 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.
$sel:localSizeConfig:DeletionConfig', deletionConfig_localSizeConfig - The value of the local size required in order to delete the edge
configuration.
deletionConfig_deleteAfterUpload :: Lens' DeletionConfig (Maybe Bool) Source #
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) Source #
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) Source #
The value of the local size required in order to delete the edge configuration.
EdgeConfig
data EdgeConfig Source #
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.
See: newEdgeConfig smart constructor.
Constructors
| EdgeConfig' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> RecorderConfig | |
| -> EdgeConfig |
Create a value of EdgeConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deletionConfig:EdgeConfig', edgeConfig_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.
$sel:uploaderConfig:EdgeConfig', edgeConfig_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.
$sel:hubDeviceArn:EdgeConfig', edgeConfig_hubDeviceArn - The "Internet of Things (IoT) Thing" Arn of the stream.
$sel:recorderConfig:EdgeConfig', 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.
edgeConfig_deletionConfig :: Lens' EdgeConfig (Maybe DeletionConfig) Source #
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) Source #
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 Source #
The "Internet of Things (IoT) Thing" Arn of the stream.
edgeConfig_recorderConfig :: Lens' EdgeConfig RecorderConfig Source #
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
data ImageGenerationConfiguration Source #
The structure that contains the information required for the KVS images delivery. If null, the configuration will be deleted from the stream.
See: newImageGenerationConfiguration smart constructor.
Constructors
| ImageGenerationConfiguration' | |
Fields
| |
Instances
newImageGenerationConfiguration Source #
Arguments
| :: ConfigurationStatus | |
| -> ImageSelectorType | |
| -> ImageGenerationDestinationConfig | |
| -> Natural | |
| -> Format | |
| -> ImageGenerationConfiguration |
Create a value of ImageGenerationConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:formatConfig:ImageGenerationConfiguration', imageGenerationConfiguration_formatConfig - 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.
$sel:heightPixels:ImageGenerationConfiguration', imageGenerationConfiguration_heightPixels - 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.
$sel:widthPixels:ImageGenerationConfiguration', imageGenerationConfiguration_widthPixels - 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.
$sel:status:ImageGenerationConfiguration', imageGenerationConfiguration_status - Indicates whether the ContinuousImageGenerationConfigurations API is
enabled or disabled.
$sel:imageSelectorType:ImageGenerationConfiguration', imageGenerationConfiguration_imageSelectorType - The origin of the Server or Producer timestamps to use to generate the
images.
$sel:destinationConfig:ImageGenerationConfiguration', imageGenerationConfiguration_destinationConfig - The structure that contains the information required to deliver images
to a customer.
$sel:samplingInterval:ImageGenerationConfiguration', imageGenerationConfiguration_samplingInterval - 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.
$sel:format:ImageGenerationConfiguration', imageGenerationConfiguration_format - The accepted image format.
imageGenerationConfiguration_formatConfig :: Lens' ImageGenerationConfiguration (Maybe (HashMap FormatConfigKey Text)) Source #
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) Source #
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) Source #
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 Source #
Indicates whether the ContinuousImageGenerationConfigurations API is
enabled or disabled.
imageGenerationConfiguration_imageSelectorType :: Lens' ImageGenerationConfiguration ImageSelectorType Source #
The origin of the Server or Producer timestamps to use to generate the images.
imageGenerationConfiguration_destinationConfig :: Lens' ImageGenerationConfiguration ImageGenerationDestinationConfig Source #
The structure that contains the information required to deliver images to a customer.
imageGenerationConfiguration_samplingInterval :: Lens' ImageGenerationConfiguration Natural Source #
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 Source #
The accepted image format.
ImageGenerationDestinationConfig
data ImageGenerationDestinationConfig Source #
The structure that contains the information required to deliver images to a customer.
See: newImageGenerationDestinationConfig smart constructor.
Constructors
| ImageGenerationDestinationConfig' | |
Fields
| |
Instances
newImageGenerationDestinationConfig Source #
Arguments
| :: Text | |
| -> Text | |
| -> ImageGenerationDestinationConfig |
Create a value of ImageGenerationDestinationConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:uri:ImageGenerationDestinationConfig', imageGenerationDestinationConfig_uri - The Uniform Resource Identifier (URI) that identifies where the images
will be delivered.
$sel:destinationRegion:ImageGenerationDestinationConfig', imageGenerationDestinationConfig_destinationRegion - The AWS Region of the S3 bucket where images will be delivered. This
DestinationRegion must match the Region where the stream is located.
imageGenerationDestinationConfig_uri :: Lens' ImageGenerationDestinationConfig Text Source #
The Uniform Resource Identifier (URI) that identifies where the images will be delivered.
imageGenerationDestinationConfig_destinationRegion :: Lens' ImageGenerationDestinationConfig Text Source #
The AWS Region of the S3 bucket where images will be delivered. This
DestinationRegion must match the Region where the stream is located.
LocalSizeConfig
data LocalSizeConfig Source #
The configuration details that include the maximum size of the media
(MaxLocalMediaSizeInMB) that you want to store for a stream on the
Edge Agent, as well as the strategy that should be used
(StrategyOnFullSize) when a stream's maximum size has been reached.
See: newLocalSizeConfig smart constructor.
Constructors
| LocalSizeConfig' | |
Fields
| |
Instances
newLocalSizeConfig :: LocalSizeConfig Source #
Create a value of LocalSizeConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxLocalMediaSizeInMB:LocalSizeConfig', localSizeConfig_maxLocalMediaSizeInMB - The overall maximum size of the media that you want to store for a
stream on the Edge Agent.
$sel:strategyOnFullSize:LocalSizeConfig', localSizeConfig_strategyOnFullSize - The strategy to perform when a stream’s MaxLocalMediaSizeInMB limit is
reached.
localSizeConfig_maxLocalMediaSizeInMB :: Lens' LocalSizeConfig (Maybe Natural) Source #
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) Source #
The strategy to perform when a stream’s MaxLocalMediaSizeInMB limit is
reached.
MappedResourceConfigurationListItem
data MappedResourceConfigurationListItem Source #
A structure that encapsulates, or contains, the media storage configuration properties.
See: newMappedResourceConfigurationListItem smart constructor.
Constructors
| MappedResourceConfigurationListItem' | |
Instances
newMappedResourceConfigurationListItem :: MappedResourceConfigurationListItem Source #
Create a value of MappedResourceConfigurationListItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:MappedResourceConfigurationListItem', mappedResourceConfigurationListItem_arn - The Amazon Resource Name (ARN) of the Kinesis Video Stream resource,
associated with the stream.
$sel:type':MappedResourceConfigurationListItem', mappedResourceConfigurationListItem_type - The type of the associated resource for the kinesis video stream.
mappedResourceConfigurationListItem_arn :: Lens' MappedResourceConfigurationListItem (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Kinesis Video Stream resource, associated with the stream.
mappedResourceConfigurationListItem_type :: Lens' MappedResourceConfigurationListItem (Maybe Text) Source #
The type of the associated resource for the kinesis video stream.
MediaSourceConfig
data MediaSourceConfig Source #
The configuration details that consist of the credentials required
(MediaUriSecretArn and MediaUriType) to access the media files that
are streamed to the camera.
See: newMediaSourceConfig smart constructor.
Constructors
| MediaSourceConfig' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> MediaUriType | |
| -> MediaSourceConfig |
Create a value of MediaSourceConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mediaUriSecretArn:MediaSourceConfig', mediaSourceConfig_mediaUriSecretArn - The AWS Secrets Manager ARN for the username and password of the camera,
or a local media file location.
$sel:mediaUriType:MediaSourceConfig', 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 .
mediaSourceConfig_mediaUriSecretArn :: Lens' MediaSourceConfig Text Source #
The AWS Secrets Manager ARN for the username and password of the camera, or a local media file location.
mediaSourceConfig_mediaUriType :: Lens' MediaSourceConfig MediaUriType Source #
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
data MediaStorageConfiguration Source #
A structure that encapsulates, or contains, the media storage configuration properties.
See: newMediaStorageConfiguration smart constructor.
Constructors
| MediaStorageConfiguration' | |
Fields
| |
Instances
newMediaStorageConfiguration Source #
Arguments
| :: MediaStorageConfigurationStatus | |
| -> MediaStorageConfiguration |
Create a value of MediaStorageConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:streamARN:MediaStorageConfiguration', mediaStorageConfiguration_streamARN - The Amazon Resource Name (ARN) of the stream
$sel:status:MediaStorageConfiguration', mediaStorageConfiguration_status - The status of the media storage configuration.
mediaStorageConfiguration_streamARN :: Lens' MediaStorageConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) of the stream
mediaStorageConfiguration_status :: Lens' MediaStorageConfiguration MediaStorageConfigurationStatus Source #
The status of the media storage configuration.
NotificationConfiguration
data NotificationConfiguration Source #
The structure that contains the notification information for the KVS images delivery. If this parameter is null, the configuration will be deleted from the stream.
See: newNotificationConfiguration smart constructor.
Constructors
| NotificationConfiguration' | |
Fields
| |
Instances
newNotificationConfiguration Source #
Create a value of NotificationConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:NotificationConfiguration', notificationConfiguration_status - Indicates if a notification configuration is enabled or disabled.
$sel:destinationConfig:NotificationConfiguration', notificationConfiguration_destinationConfig - The destination information required to deliver a notification to a
customer.
notificationConfiguration_status :: Lens' NotificationConfiguration ConfigurationStatus Source #
Indicates if a notification configuration is enabled or disabled.
notificationConfiguration_destinationConfig :: Lens' NotificationConfiguration NotificationDestinationConfig Source #
The destination information required to deliver a notification to a customer.
NotificationDestinationConfig
data NotificationDestinationConfig Source #
The structure that contains the information required to deliver a notification to a customer.
See: newNotificationDestinationConfig smart constructor.
Constructors
| NotificationDestinationConfig' | |
Instances
newNotificationDestinationConfig Source #
Create a value of NotificationDestinationConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:uri:NotificationDestinationConfig', notificationDestinationConfig_uri - The Uniform Resource Identifier (URI) that identifies where the images
will be delivered.
notificationDestinationConfig_uri :: Lens' NotificationDestinationConfig Text Source #
The Uniform Resource Identifier (URI) that identifies where the images will be delivered.
RecorderConfig
data RecorderConfig Source #
The recorder configuration consists of the local MediaSourceConfig
details that are used as credentials to accesss the local media files
streamed on the camera.
See: newRecorderConfig smart constructor.
Constructors
| RecorderConfig' | |
Fields
| |
Instances
Create a value of RecorderConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:scheduleConfig:RecorderConfig', recorderConfig_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.
$sel:mediaSourceConfig:RecorderConfig', recorderConfig_mediaSourceConfig - The configuration details that consist of the credentials required
(MediaUriSecretArn and MediaUriType) to access the media files
streamed to the camera.
recorderConfig_scheduleConfig :: Lens' RecorderConfig (Maybe ScheduleConfig) Source #
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 Source #
The configuration details that consist of the credentials required
(MediaUriSecretArn and MediaUriType) to access the media files
streamed to the camera.
ResourceEndpointListItem
data ResourceEndpointListItem Source #
An object that describes the endpoint of the signaling channel returned
by the GetSignalingChannelEndpoint API.
See: newResourceEndpointListItem smart constructor.
Constructors
| ResourceEndpointListItem' | |
Fields
| |
Instances
newResourceEndpointListItem :: ResourceEndpointListItem Source #
Create a value of ResourceEndpointListItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:protocol:ResourceEndpointListItem', resourceEndpointListItem_protocol - The protocol of the signaling channel returned by the
GetSignalingChannelEndpoint API.
$sel:resourceEndpoint:ResourceEndpointListItem', resourceEndpointListItem_resourceEndpoint - The endpoint of the signaling channel returned by the
GetSignalingChannelEndpoint API.
resourceEndpointListItem_protocol :: Lens' ResourceEndpointListItem (Maybe ChannelProtocol) Source #
The protocol of the signaling channel returned by the
GetSignalingChannelEndpoint API.
resourceEndpointListItem_resourceEndpoint :: Lens' ResourceEndpointListItem (Maybe Text) Source #
The endpoint of the signaling channel returned by the
GetSignalingChannelEndpoint API.
ScheduleConfig
data ScheduleConfig Source #
This API enables you to specify the duration that the camera, or local
media file, should record onto the Edge Agent. The ScheduleConfig
consists of the ScheduleExpression and the DurationInMinutes
attributes.
If the ScheduleExpression is not provided, then the Edge Agent will
always be set to recording mode.
See: newScheduleConfig smart constructor.
Constructors
| ScheduleConfig' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Natural | |
| -> ScheduleConfig |
Create a value of ScheduleConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:scheduleExpression:ScheduleConfig', scheduleConfig_scheduleExpression - 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.
$sel:durationInSeconds:ScheduleConfig', scheduleConfig_durationInSeconds - The total duration to record the media. If the ScheduleExpression
attribute is provided, then the DurationInSeconds attribute should
also be specified.
scheduleConfig_scheduleExpression :: Lens' ScheduleConfig Text Source #
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 Source #
The total duration to record the media. If the ScheduleExpression
attribute is provided, then the DurationInSeconds attribute should
also be specified.
SingleMasterChannelEndpointConfiguration
data SingleMasterChannelEndpointConfiguration Source #
An object that contains the endpoint configuration for the
SINGLE_MASTER channel type.
See: newSingleMasterChannelEndpointConfiguration smart constructor.
Constructors
| SingleMasterChannelEndpointConfiguration' | |
Fields
| |
Instances
newSingleMasterChannelEndpointConfiguration :: SingleMasterChannelEndpointConfiguration Source #
Create a value of SingleMasterChannelEndpointConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:protocols:SingleMasterChannelEndpointConfiguration', singleMasterChannelEndpointConfiguration_protocols - 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.
$sel:role':SingleMasterChannelEndpointConfiguration', singleMasterChannelEndpointConfiguration_role - 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.
singleMasterChannelEndpointConfiguration_protocols :: Lens' SingleMasterChannelEndpointConfiguration (Maybe (NonEmpty ChannelProtocol)) Source #
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) Source #
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
data SingleMasterConfiguration Source #
A structure that contains the configuration for the SINGLE_MASTER
channel type.
See: newSingleMasterConfiguration smart constructor.
Constructors
| SingleMasterConfiguration' | |
Fields
| |
Instances
newSingleMasterConfiguration :: SingleMasterConfiguration Source #
Create a value of SingleMasterConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:messageTtlSeconds:SingleMasterConfiguration', singleMasterConfiguration_messageTtlSeconds - The period of time a signaling channel retains undelivered messages
before they are discarded.
singleMasterConfiguration_messageTtlSeconds :: Lens' SingleMasterConfiguration (Maybe Natural) Source #
The period of time a signaling channel retains undelivered messages before they are discarded.
StreamInfo
data StreamInfo Source #
An object describing a Kinesis video stream.
See: newStreamInfo smart constructor.
Constructors
| StreamInfo' | |
Fields
| |
Instances
newStreamInfo :: StreamInfo Source #
Create a value of StreamInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:StreamInfo', streamInfo_creationTime - A time stamp that indicates when the stream was created.
$sel:dataRetentionInHours:StreamInfo', streamInfo_dataRetentionInHours - How long the stream retains data, in hours.
$sel:deviceName:StreamInfo', streamInfo_deviceName - The name of the device that is associated with the stream.
$sel:kmsKeyId:StreamInfo', streamInfo_kmsKeyId - The ID of the Key Management Service (KMS) key that Kinesis Video
Streams uses to encrypt data on the stream.
$sel:mediaType:StreamInfo', streamInfo_mediaType - The MediaType of the stream.
$sel:status:StreamInfo', streamInfo_status - The status of the stream.
$sel:streamARN:StreamInfo', streamInfo_streamARN - The Amazon Resource Name (ARN) of the stream.
$sel:streamName:StreamInfo', streamInfo_streamName - The name of the stream.
$sel:version:StreamInfo', streamInfo_version - The version of the stream.
streamInfo_creationTime :: Lens' StreamInfo (Maybe UTCTime) Source #
A time stamp that indicates when the stream was created.
streamInfo_dataRetentionInHours :: Lens' StreamInfo (Maybe Natural) Source #
How long the stream retains data, in hours.
streamInfo_deviceName :: Lens' StreamInfo (Maybe Text) Source #
The name of the device that is associated with the stream.
streamInfo_kmsKeyId :: Lens' StreamInfo (Maybe Text) Source #
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) Source #
The MediaType of the stream.
streamInfo_status :: Lens' StreamInfo (Maybe StreamStatus) Source #
The status of the stream.
streamInfo_streamARN :: Lens' StreamInfo (Maybe Text) Source #
The Amazon Resource Name (ARN) of the stream.
streamInfo_streamName :: Lens' StreamInfo (Maybe Text) Source #
The name of the stream.
streamInfo_version :: Lens' StreamInfo (Maybe Text) Source #
The version of the stream.
StreamNameCondition
data StreamNameCondition Source #
Specifies the condition that streams must satisfy to be returned when
you list streams (see the ListStreams API). A condition has a
comparison operation and a value. Currently, you can specify only the
BEGINS_WITH operator, which finds streams whose names start with a
given prefix.
See: newStreamNameCondition smart constructor.
Constructors
| StreamNameCondition' | |
Fields
| |
Instances
newStreamNameCondition :: StreamNameCondition Source #
Create a value of StreamNameCondition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:comparisonOperator:StreamNameCondition', streamNameCondition_comparisonOperator - A comparison operator. Currently, you can specify only the BEGINS_WITH
operator, which finds streams whose names start with a given prefix.
$sel:comparisonValue:StreamNameCondition', streamNameCondition_comparisonValue - A value to compare.
streamNameCondition_comparisonOperator :: Lens' StreamNameCondition (Maybe ComparisonOperator) Source #
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) Source #
A value to compare.
Tag
A key and value pair that is associated with the specified signaling channel.
See: newTag smart constructor.
Constructors
| Tag' | |
Instances
| ToJSON Tag Source # | |
Defined in Amazonka.KinesisVideo.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.KinesisVideo.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.KinesisVideo.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.KinesisVideo.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.KinesisVideo.Types.Tag" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The key of the tag that is associated with the specified signaling
channel.
$sel:value:Tag', tag_value - The value of the tag that is associated with the specified signaling
channel.
tag_key :: Lens' Tag Text Source #
The key of the tag that is associated with the specified signaling channel.
tag_value :: Lens' Tag Text Source #
The value of the tag that is associated with the specified signaling channel.
UploaderConfig
data UploaderConfig Source #
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 upload mode.
See: newUploaderConfig smart constructor.
Constructors
| UploaderConfig' | |
Fields
| |
Instances
Create a value of UploaderConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:scheduleConfig:UploaderConfig', 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.
uploaderConfig_scheduleConfig :: Lens' UploaderConfig ScheduleConfig Source #
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.