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 |
- Service Configuration
- Errors
- AccessDeniedException
- AccountChannelLimitExceededException
- AccountStreamLimitExceededException
- ClientLimitExceededException
- DeviceStreamLimitExceededException
- InvalidArgumentException
- InvalidDeviceException
- InvalidResourceFormatException
- NoDataRetentionException
- NotAuthorizedException
- ResourceInUseException
- ResourceNotFoundException
- StreamEdgeConfigurationNotFoundException
- TagsPerResourceExceededLimitException
- VersionMismatchException
- Waiters
- Operations
- CreateSignalingChannel
- CreateStream
- DeleteSignalingChannel
- DeleteStream
- DescribeEdgeConfiguration
- DescribeImageGenerationConfiguration
- DescribeMappedResourceConfiguration (Paginated)
- DescribeMediaStorageConfiguration
- DescribeNotificationConfiguration
- DescribeSignalingChannel
- DescribeStream
- GetDataEndpoint
- GetSignalingChannelEndpoint
- ListSignalingChannels (Paginated)
- ListStreams (Paginated)
- ListTagsForResource
- ListTagsForStream
- StartEdgeConfigurationUpdate
- TagResource
- TagStream
- UntagResource
- UntagStream
- UpdateDataRetention
- UpdateImageGenerationConfiguration
- UpdateMediaStorageConfiguration
- UpdateNotificationConfiguration
- UpdateSignalingChannel
- UpdateStream
- Types
- 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
Derived from API version 2017-09-30
of the AWS service descriptions, licensed under Apache 2.0.
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
- data CreateSignalingChannel = CreateSignalingChannel' (Maybe ChannelType) (Maybe SingleMasterConfiguration) (Maybe [Tag]) Text
- newCreateSignalingChannel :: Text -> CreateSignalingChannel
- data CreateSignalingChannelResponse = CreateSignalingChannelResponse' (Maybe Text) Int
- newCreateSignalingChannelResponse :: Int -> CreateSignalingChannelResponse
- data CreateStream = CreateStream' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text
- newCreateStream :: Text -> CreateStream
- data CreateStreamResponse = CreateStreamResponse' (Maybe Text) Int
- newCreateStreamResponse :: Int -> CreateStreamResponse
- data DeleteSignalingChannel = DeleteSignalingChannel' (Maybe Text) Text
- newDeleteSignalingChannel :: Text -> DeleteSignalingChannel
- data DeleteSignalingChannelResponse = DeleteSignalingChannelResponse' Int
- newDeleteSignalingChannelResponse :: Int -> DeleteSignalingChannelResponse
- data DeleteStream = DeleteStream' (Maybe Text) Text
- newDeleteStream :: Text -> DeleteStream
- data DeleteStreamResponse = DeleteStreamResponse' Int
- newDeleteStreamResponse :: Int -> DeleteStreamResponse
- data DescribeEdgeConfiguration = DescribeEdgeConfiguration' (Maybe Text) (Maybe Text)
- newDescribeEdgeConfiguration :: DescribeEdgeConfiguration
- data DescribeEdgeConfigurationResponse = DescribeEdgeConfigurationResponse' (Maybe POSIX) (Maybe EdgeConfig) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe SyncStatus) Int
- newDescribeEdgeConfigurationResponse :: Int -> DescribeEdgeConfigurationResponse
- data DescribeImageGenerationConfiguration = DescribeImageGenerationConfiguration' (Maybe Text) (Maybe Text)
- newDescribeImageGenerationConfiguration :: DescribeImageGenerationConfiguration
- data DescribeImageGenerationConfigurationResponse = DescribeImageGenerationConfigurationResponse' (Maybe ImageGenerationConfiguration) Int
- newDescribeImageGenerationConfigurationResponse :: Int -> DescribeImageGenerationConfigurationResponse
- data DescribeMappedResourceConfiguration = DescribeMappedResourceConfiguration' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text)
- newDescribeMappedResourceConfiguration :: DescribeMappedResourceConfiguration
- data DescribeMappedResourceConfigurationResponse = DescribeMappedResourceConfigurationResponse' (Maybe [MappedResourceConfigurationListItem]) (Maybe Text) Int
- newDescribeMappedResourceConfigurationResponse :: Int -> DescribeMappedResourceConfigurationResponse
- data DescribeMediaStorageConfiguration = DescribeMediaStorageConfiguration' (Maybe Text) (Maybe Text)
- newDescribeMediaStorageConfiguration :: DescribeMediaStorageConfiguration
- data DescribeMediaStorageConfigurationResponse = DescribeMediaStorageConfigurationResponse' (Maybe MediaStorageConfiguration) Int
- newDescribeMediaStorageConfigurationResponse :: Int -> DescribeMediaStorageConfigurationResponse
- data DescribeNotificationConfiguration = DescribeNotificationConfiguration' (Maybe Text) (Maybe Text)
- newDescribeNotificationConfiguration :: DescribeNotificationConfiguration
- data DescribeNotificationConfigurationResponse = DescribeNotificationConfigurationResponse' (Maybe NotificationConfiguration) Int
- newDescribeNotificationConfigurationResponse :: Int -> DescribeNotificationConfigurationResponse
- data DescribeSignalingChannel = DescribeSignalingChannel' (Maybe Text) (Maybe Text)
- newDescribeSignalingChannel :: DescribeSignalingChannel
- data DescribeSignalingChannelResponse = DescribeSignalingChannelResponse' (Maybe ChannelInfo) Int
- newDescribeSignalingChannelResponse :: Int -> DescribeSignalingChannelResponse
- data DescribeStream = DescribeStream' (Maybe Text) (Maybe Text)
- newDescribeStream :: DescribeStream
- data DescribeStreamResponse = DescribeStreamResponse' (Maybe StreamInfo) Int
- newDescribeStreamResponse :: Int -> DescribeStreamResponse
- data GetDataEndpoint = GetDataEndpoint' (Maybe Text) (Maybe Text) APIName
- newGetDataEndpoint :: APIName -> GetDataEndpoint
- data GetDataEndpointResponse = GetDataEndpointResponse' (Maybe Text) Int
- newGetDataEndpointResponse :: Int -> GetDataEndpointResponse
- data GetSignalingChannelEndpoint = GetSignalingChannelEndpoint' (Maybe SingleMasterChannelEndpointConfiguration) Text
- newGetSignalingChannelEndpoint :: Text -> GetSignalingChannelEndpoint
- data GetSignalingChannelEndpointResponse = GetSignalingChannelEndpointResponse' (Maybe [ResourceEndpointListItem]) Int
- newGetSignalingChannelEndpointResponse :: Int -> GetSignalingChannelEndpointResponse
- data ListSignalingChannels = ListSignalingChannels' (Maybe ChannelNameCondition) (Maybe Natural) (Maybe Text)
- newListSignalingChannels :: ListSignalingChannels
- data ListSignalingChannelsResponse = ListSignalingChannelsResponse' (Maybe [ChannelInfo]) (Maybe Text) Int
- newListSignalingChannelsResponse :: Int -> ListSignalingChannelsResponse
- data ListStreams = ListStreams' (Maybe Natural) (Maybe Text) (Maybe StreamNameCondition)
- newListStreams :: ListStreams
- data ListStreamsResponse = ListStreamsResponse' (Maybe Text) (Maybe [StreamInfo]) Int
- newListStreamsResponse :: Int -> ListStreamsResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Text) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListTagsForStream = ListTagsForStream' (Maybe Text) (Maybe Text) (Maybe Text)
- newListTagsForStream :: ListTagsForStream
- data ListTagsForStreamResponse = ListTagsForStreamResponse' (Maybe Text) (Maybe (HashMap Text Text)) Int
- newListTagsForStreamResponse :: Int -> ListTagsForStreamResponse
- data StartEdgeConfigurationUpdate = StartEdgeConfigurationUpdate' (Maybe Text) (Maybe Text) EdgeConfig
- newStartEdgeConfigurationUpdate :: EdgeConfig -> StartEdgeConfigurationUpdate
- data StartEdgeConfigurationUpdateResponse = StartEdgeConfigurationUpdateResponse' (Maybe POSIX) (Maybe EdgeConfig) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe SyncStatus) Int
- newStartEdgeConfigurationUpdateResponse :: Int -> StartEdgeConfigurationUpdateResponse
- data TagResource = TagResource' Text (NonEmpty Tag)
- newTagResource :: Text -> NonEmpty Tag -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data TagStream = TagStream' (Maybe Text) (Maybe Text) (HashMap Text Text)
- newTagStream :: TagStream
- data TagStreamResponse = TagStreamResponse' Int
- newTagStreamResponse :: Int -> TagStreamResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UntagStream = UntagStream' (Maybe Text) (Maybe Text) (NonEmpty Text)
- newUntagStream :: NonEmpty Text -> UntagStream
- data UntagStreamResponse = UntagStreamResponse' Int
- newUntagStreamResponse :: Int -> UntagStreamResponse
- data UpdateDataRetention = UpdateDataRetention' (Maybe Text) (Maybe Text) Text UpdateDataRetentionOperation Natural
- newUpdateDataRetention :: Text -> UpdateDataRetentionOperation -> Natural -> UpdateDataRetention
- data UpdateDataRetentionResponse = UpdateDataRetentionResponse' Int
- newUpdateDataRetentionResponse :: Int -> UpdateDataRetentionResponse
- data UpdateImageGenerationConfiguration = UpdateImageGenerationConfiguration' (Maybe ImageGenerationConfiguration) (Maybe Text) (Maybe Text)
- newUpdateImageGenerationConfiguration :: UpdateImageGenerationConfiguration
- data UpdateImageGenerationConfigurationResponse = UpdateImageGenerationConfigurationResponse' Int
- newUpdateImageGenerationConfigurationResponse :: Int -> UpdateImageGenerationConfigurationResponse
- data UpdateMediaStorageConfiguration = UpdateMediaStorageConfiguration' Text MediaStorageConfiguration
- newUpdateMediaStorageConfiguration :: Text -> MediaStorageConfiguration -> UpdateMediaStorageConfiguration
- data UpdateMediaStorageConfigurationResponse = UpdateMediaStorageConfigurationResponse' Int
- newUpdateMediaStorageConfigurationResponse :: Int -> UpdateMediaStorageConfigurationResponse
- data UpdateNotificationConfiguration = UpdateNotificationConfiguration' (Maybe NotificationConfiguration) (Maybe Text) (Maybe Text)
- newUpdateNotificationConfiguration :: UpdateNotificationConfiguration
- data UpdateNotificationConfigurationResponse = UpdateNotificationConfigurationResponse' Int
- newUpdateNotificationConfigurationResponse :: Int -> UpdateNotificationConfigurationResponse
- data UpdateSignalingChannel = UpdateSignalingChannel' (Maybe SingleMasterConfiguration) Text Text
- newUpdateSignalingChannel :: Text -> Text -> UpdateSignalingChannel
- data UpdateSignalingChannelResponse = UpdateSignalingChannelResponse' Int
- newUpdateSignalingChannelResponse :: Int -> UpdateSignalingChannelResponse
- data UpdateStream = UpdateStream' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newUpdateStream :: Text -> UpdateStream
- data UpdateStreamResponse = UpdateStreamResponse' Int
- newUpdateStreamResponse :: Int -> UpdateStreamResponse
- 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' (Maybe Text) (Maybe Text) (Maybe StreamStatus) (Maybe ChannelType) (Maybe POSIX) (Maybe SingleMasterConfiguration) (Maybe Text)
- newChannelInfo :: ChannelInfo
- data ChannelNameCondition = ChannelNameCondition' (Maybe ComparisonOperator) (Maybe Text)
- newChannelNameCondition :: ChannelNameCondition
- data DeletionConfig = DeletionConfig' (Maybe Bool) (Maybe Natural) (Maybe LocalSizeConfig)
- newDeletionConfig :: DeletionConfig
- data EdgeConfig = EdgeConfig' (Maybe DeletionConfig) (Maybe UploaderConfig) Text RecorderConfig
- newEdgeConfig :: Text -> RecorderConfig -> EdgeConfig
- data ImageGenerationConfiguration = ImageGenerationConfiguration' (Maybe (HashMap FormatConfigKey Text)) (Maybe Natural) (Maybe Natural) ConfigurationStatus ImageSelectorType ImageGenerationDestinationConfig Natural Format
- newImageGenerationConfiguration :: ConfigurationStatus -> ImageSelectorType -> ImageGenerationDestinationConfig -> Natural -> Format -> ImageGenerationConfiguration
- data ImageGenerationDestinationConfig = ImageGenerationDestinationConfig' Text Text
- newImageGenerationDestinationConfig :: Text -> Text -> ImageGenerationDestinationConfig
- data LocalSizeConfig = LocalSizeConfig' (Maybe Natural) (Maybe StrategyOnFullSize)
- newLocalSizeConfig :: LocalSizeConfig
- data MappedResourceConfigurationListItem = MappedResourceConfigurationListItem' (Maybe Text) (Maybe Text)
- newMappedResourceConfigurationListItem :: MappedResourceConfigurationListItem
- data MediaSourceConfig = MediaSourceConfig' (Sensitive Text) MediaUriType
- newMediaSourceConfig :: Text -> MediaUriType -> MediaSourceConfig
- data MediaStorageConfiguration = MediaStorageConfiguration' (Maybe Text) MediaStorageConfigurationStatus
- newMediaStorageConfiguration :: MediaStorageConfigurationStatus -> MediaStorageConfiguration
- data NotificationConfiguration = NotificationConfiguration' ConfigurationStatus NotificationDestinationConfig
- newNotificationConfiguration :: ConfigurationStatus -> NotificationDestinationConfig -> NotificationConfiguration
- data NotificationDestinationConfig = NotificationDestinationConfig' Text
- newNotificationDestinationConfig :: Text -> NotificationDestinationConfig
- data RecorderConfig = RecorderConfig' (Maybe ScheduleConfig) MediaSourceConfig
- newRecorderConfig :: MediaSourceConfig -> RecorderConfig
- data ResourceEndpointListItem = ResourceEndpointListItem' (Maybe ChannelProtocol) (Maybe Text)
- newResourceEndpointListItem :: ResourceEndpointListItem
- data ScheduleConfig = ScheduleConfig' Text Natural
- newScheduleConfig :: Text -> Natural -> ScheduleConfig
- data SingleMasterChannelEndpointConfiguration = SingleMasterChannelEndpointConfiguration' (Maybe (NonEmpty ChannelProtocol)) (Maybe ChannelRole)
- newSingleMasterChannelEndpointConfiguration :: SingleMasterChannelEndpointConfiguration
- data SingleMasterConfiguration = SingleMasterConfiguration' (Maybe Natural)
- newSingleMasterConfiguration :: SingleMasterConfiguration
- data StreamInfo = StreamInfo' (Maybe POSIX) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe StreamStatus) (Maybe Text) (Maybe Text) (Maybe Text)
- newStreamInfo :: StreamInfo
- data StreamNameCondition = StreamNameCondition' (Maybe ComparisonOperator) (Maybe Text)
- newStreamNameCondition :: StreamNameCondition
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data UploaderConfig = UploaderConfig' ScheduleConfig
- newUploaderConfig :: ScheduleConfig -> UploaderConfig
Service Configuration
defaultService :: Service Source #
API version 2017-09-30
of the Amazon Kinesis Video Streams SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by KinesisVideo
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have required permissions to perform this operation.
AccountChannelLimitExceededException
_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
_AccountStreamLimitExceededException :: AsError a => Fold a ServiceError Source #
The number of streams created for the account is too high.
ClientLimitExceededException
_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
_DeviceStreamLimitExceededException :: AsError a => Fold a ServiceError Source #
Not implemented.
InvalidArgumentException
_InvalidArgumentException :: AsError a => Fold a ServiceError Source #
The value for this input parameter is invalid.
InvalidDeviceException
_InvalidDeviceException :: AsError a => Fold a ServiceError Source #
Not implemented.
InvalidResourceFormatException
_InvalidResourceFormatException :: AsError a => Fold a ServiceError Source #
The format of the StreamARN
is invalid.
NoDataRetentionException
_NoDataRetentionException :: AsError a => Fold a ServiceError Source #
The Stream data retention in hours is equal to zero.
NotAuthorizedException
_NotAuthorizedException :: AsError a => Fold a ServiceError Source #
The caller is not authorized to perform this operation.
ResourceInUseException
_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
DescribeMediaStorageConfiguration
API to determine what the stream given channel is mapped to. - The
DescribeMappedResourceConfiguration
API to determine the channel that the given stream is mapped to. - The
DescribeStream
orDescribeSignalingChannel
API to determine the status of the resource.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Amazon Kinesis Video Streams can't find the stream that you specified.
StreamEdgeConfigurationNotFoundException
_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
_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
_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.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateSignalingChannel
data CreateSignalingChannel Source #
See: newCreateSignalingChannel
smart constructor.
Instances
newCreateSignalingChannel Source #
Create a value of CreateSignalingChannel
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:
CreateSignalingChannel
, createSignalingChannel_channelType
- A type of the signaling channel that you are creating. Currently,
SINGLE_MASTER
is the only supported channel type.
CreateSignalingChannel
, createSignalingChannel_singleMasterConfiguration
- A structure containing the configuration for the SINGLE_MASTER
channel
type.
$sel:tags:CreateSignalingChannel'
, createSignalingChannel_tags
- A set of tags (key-value pairs) that you want to associate with this
channel.
CreateSignalingChannel
, createSignalingChannel_channelName
- 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.
data CreateSignalingChannelResponse Source #
See: newCreateSignalingChannelResponse
smart constructor.
Instances
Generic CreateSignalingChannelResponse Source # | |
Read CreateSignalingChannelResponse Source # | |
Show CreateSignalingChannelResponse Source # | |
Defined in Amazonka.KinesisVideo.CreateSignalingChannel | |
NFData CreateSignalingChannelResponse Source # | |
Defined in Amazonka.KinesisVideo.CreateSignalingChannel rnf :: CreateSignalingChannelResponse -> () # | |
Eq CreateSignalingChannelResponse Source # | |
type Rep CreateSignalingChannelResponse Source # | |
Defined in Amazonka.KinesisVideo.CreateSignalingChannel type Rep CreateSignalingChannelResponse = D1 ('MetaData "CreateSignalingChannelResponse" "Amazonka.KinesisVideo.CreateSignalingChannel" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "CreateSignalingChannelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreateSignalingChannelResponse Source #
Create a value of CreateSignalingChannelResponse
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:
CreateSignalingChannelResponse
, createSignalingChannelResponse_channelARN
- The Amazon Resource Name (ARN) of the created channel.
$sel:httpStatus:CreateSignalingChannelResponse'
, createSignalingChannelResponse_httpStatus
- The response's http status code.
CreateStream
data CreateStream Source #
See: newCreateStream
smart constructor.
CreateStream' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text |
Instances
Create a value of CreateStream
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:
CreateStream
, createStream_dataRetentionInHours
- 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
, createStream_deviceName
- The name of the device that is writing to the stream.
In the current implementation, Kinesis Video Streams does not use this name.
CreateStream
, createStream_kmsKeyId
- 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
, createStream_mediaType
- 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).
$sel:tags:CreateStream'
, createStream_tags
- A list of tags to associate with the specified stream. Each tag is a
key-value pair (the value is optional).
CreateStream
, createStream_streamName
- 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.
data CreateStreamResponse Source #
See: newCreateStreamResponse
smart constructor.
Instances
newCreateStreamResponse Source #
Create a value of CreateStreamResponse
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:
CreateStreamResponse
, createStreamResponse_streamARN
- The Amazon Resource Name (ARN) of the stream.
$sel:httpStatus:CreateStreamResponse'
, createStreamResponse_httpStatus
- The response's http status code.
DeleteSignalingChannel
data DeleteSignalingChannel Source #
See: newDeleteSignalingChannel
smart constructor.
Instances
newDeleteSignalingChannel Source #
Create a value of DeleteSignalingChannel
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:currentVersion:DeleteSignalingChannel'
, deleteSignalingChannel_currentVersion
- 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
, deleteSignalingChannel_channelARN
- The Amazon Resource Name (ARN) of the signaling channel that you want to
delete.
data DeleteSignalingChannelResponse Source #
See: newDeleteSignalingChannelResponse
smart constructor.
Instances
Generic DeleteSignalingChannelResponse Source # | |
Read DeleteSignalingChannelResponse Source # | |
Show DeleteSignalingChannelResponse Source # | |
Defined in Amazonka.KinesisVideo.DeleteSignalingChannel | |
NFData DeleteSignalingChannelResponse Source # | |
Defined in Amazonka.KinesisVideo.DeleteSignalingChannel rnf :: DeleteSignalingChannelResponse -> () # | |
Eq DeleteSignalingChannelResponse Source # | |
type Rep DeleteSignalingChannelResponse Source # | |
Defined in Amazonka.KinesisVideo.DeleteSignalingChannel type Rep DeleteSignalingChannelResponse = D1 ('MetaData "DeleteSignalingChannelResponse" "Amazonka.KinesisVideo.DeleteSignalingChannel" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "DeleteSignalingChannelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteSignalingChannelResponse Source #
Create a value of DeleteSignalingChannelResponse
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:httpStatus:DeleteSignalingChannelResponse'
, deleteSignalingChannelResponse_httpStatus
- The response's http status code.
DeleteStream
data DeleteStream Source #
See: newDeleteStream
smart constructor.
Instances
Create a value of DeleteStream
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:currentVersion:DeleteStream'
, deleteStream_currentVersion
- 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
, deleteStream_streamARN
- The Amazon Resource Name (ARN) of the stream that you want to delete.
data DeleteStreamResponse Source #
See: newDeleteStreamResponse
smart constructor.
Instances
newDeleteStreamResponse Source #
Create a value of DeleteStreamResponse
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:httpStatus:DeleteStreamResponse'
, deleteStreamResponse_httpStatus
- The response's http status code.
DescribeEdgeConfiguration
data DescribeEdgeConfiguration Source #
See: newDescribeEdgeConfiguration
smart constructor.
Instances
newDescribeEdgeConfiguration :: DescribeEdgeConfiguration Source #
Create a value of DescribeEdgeConfiguration
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:
DescribeEdgeConfiguration
, describeEdgeConfiguration_streamARN
- The Amazon Resource Name (ARN) of the stream. Specify either the
StreamName
or the StreamARN
.
DescribeEdgeConfiguration
, describeEdgeConfiguration_streamName
- The name of the stream whose edge configuration you want to update.
Specify either the StreamName
or the StreamARN
.
data DescribeEdgeConfigurationResponse Source #
See: newDescribeEdgeConfigurationResponse
smart constructor.
DescribeEdgeConfigurationResponse' (Maybe POSIX) (Maybe EdgeConfig) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe SyncStatus) Int |
Instances
newDescribeEdgeConfigurationResponse Source #
Create a value of DescribeEdgeConfigurationResponse
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:
DescribeEdgeConfigurationResponse
, describeEdgeConfigurationResponse_creationTime
- The timestamp at which a stream’s edge configuration was first created.
$sel:edgeConfig:DescribeEdgeConfigurationResponse'
, describeEdgeConfigurationResponse_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.
$sel:failedStatusDetails:DescribeEdgeConfigurationResponse'
, describeEdgeConfigurationResponse_failedStatusDetails
- A description of the generated failure status.
$sel:lastUpdatedTime:DescribeEdgeConfigurationResponse'
, describeEdgeConfigurationResponse_lastUpdatedTime
- The timestamp at which a stream’s edge configuration was last updated.
DescribeEdgeConfiguration
, describeEdgeConfigurationResponse_streamARN
- The Amazon Resource Name (ARN) of the stream.
DescribeEdgeConfiguration
, describeEdgeConfigurationResponse_streamName
- The name of the stream from which the edge configuration was updated.
$sel:syncStatus:DescribeEdgeConfigurationResponse'
, describeEdgeConfigurationResponse_syncStatus
- The latest status of the edge configuration update.
$sel:httpStatus:DescribeEdgeConfigurationResponse'
, describeEdgeConfigurationResponse_httpStatus
- The response's http status code.
DescribeImageGenerationConfiguration
data DescribeImageGenerationConfiguration Source #
See: newDescribeImageGenerationConfiguration
smart constructor.
Instances
newDescribeImageGenerationConfiguration :: DescribeImageGenerationConfiguration Source #
Create a value of DescribeImageGenerationConfiguration
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:
DescribeImageGenerationConfiguration
, describeImageGenerationConfiguration_streamARN
- 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
, describeImageGenerationConfiguration_streamName
- The name of the stream from which to retrieve the image generation
configuration. You must specify either the StreamName
or the
StreamARN
.
data DescribeImageGenerationConfigurationResponse Source #
See: newDescribeImageGenerationConfigurationResponse
smart constructor.
Instances
newDescribeImageGenerationConfigurationResponse Source #
:: Int |
|
-> DescribeImageGenerationConfigurationResponse |
Create a value of DescribeImageGenerationConfigurationResponse
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:imageGenerationConfiguration:DescribeImageGenerationConfigurationResponse'
, describeImageGenerationConfigurationResponse_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.
$sel:httpStatus:DescribeImageGenerationConfigurationResponse'
, describeImageGenerationConfigurationResponse_httpStatus
- The response's http status code.
DescribeMappedResourceConfiguration (Paginated)
data DescribeMappedResourceConfiguration Source #
See: newDescribeMappedResourceConfiguration
smart constructor.
Instances
newDescribeMappedResourceConfiguration :: DescribeMappedResourceConfiguration Source #
Create a value of DescribeMappedResourceConfiguration
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:maxResults:DescribeMappedResourceConfiguration'
, describeMappedResourceConfiguration_maxResults
- The maximum number of results to return in the response.
DescribeMappedResourceConfiguration
, describeMappedResourceConfiguration_nextToken
- The token to provide in your next request, to get another batch of
results.
DescribeMappedResourceConfiguration
, describeMappedResourceConfiguration_streamARN
- The Amazon Resource Name (ARN) of the stream.
DescribeMappedResourceConfiguration
, describeMappedResourceConfiguration_streamName
- The name of the stream.
data DescribeMappedResourceConfigurationResponse Source #
See: newDescribeMappedResourceConfigurationResponse
smart constructor.
DescribeMappedResourceConfigurationResponse' (Maybe [MappedResourceConfigurationListItem]) (Maybe Text) Int |
Instances
newDescribeMappedResourceConfigurationResponse Source #
:: Int |
|
-> DescribeMappedResourceConfigurationResponse |
Create a value of DescribeMappedResourceConfigurationResponse
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:mappedResourceConfigurationList:DescribeMappedResourceConfigurationResponse'
, describeMappedResourceConfigurationResponse_mappedResourceConfigurationList
- A structure that encapsulates, or contains, the media storage
configuration properties.
DescribeMappedResourceConfiguration
, describeMappedResourceConfigurationResponse_nextToken
- The token that was used in the NextToken
request to fetch the next set
of results.
$sel:httpStatus:DescribeMappedResourceConfigurationResponse'
, describeMappedResourceConfigurationResponse_httpStatus
- The response's http status code.
DescribeMediaStorageConfiguration
data DescribeMediaStorageConfiguration Source #
See: newDescribeMediaStorageConfiguration
smart constructor.
Instances
newDescribeMediaStorageConfiguration :: DescribeMediaStorageConfiguration Source #
Create a value of DescribeMediaStorageConfiguration
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:
DescribeMediaStorageConfiguration
, describeMediaStorageConfiguration_channelARN
- The Amazon Resource Name (ARN) of the channel.
DescribeMediaStorageConfiguration
, describeMediaStorageConfiguration_channelName
- The name of the channel.
data DescribeMediaStorageConfigurationResponse Source #
See: newDescribeMediaStorageConfigurationResponse
smart constructor.
Instances
newDescribeMediaStorageConfigurationResponse Source #
Create a value of DescribeMediaStorageConfigurationResponse
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:mediaStorageConfiguration:DescribeMediaStorageConfigurationResponse'
, describeMediaStorageConfigurationResponse_mediaStorageConfiguration
- A structure that encapsulates, or contains, the media storage
configuration properties.
$sel:httpStatus:DescribeMediaStorageConfigurationResponse'
, describeMediaStorageConfigurationResponse_httpStatus
- The response's http status code.
DescribeNotificationConfiguration
data DescribeNotificationConfiguration Source #
See: newDescribeNotificationConfiguration
smart constructor.
Instances
newDescribeNotificationConfiguration :: DescribeNotificationConfiguration Source #
Create a value of DescribeNotificationConfiguration
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:
DescribeNotificationConfiguration
, describeNotificationConfiguration_streamARN
- 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
, describeNotificationConfiguration_streamName
- The name of the stream from which to retrieve the notification
configuration. You must specify either the StreamName
or the
StreamARN
.
data DescribeNotificationConfigurationResponse Source #
See: newDescribeNotificationConfigurationResponse
smart constructor.
Instances
newDescribeNotificationConfigurationResponse Source #
Create a value of DescribeNotificationConfigurationResponse
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:notificationConfiguration:DescribeNotificationConfigurationResponse'
, describeNotificationConfigurationResponse_notificationConfiguration
- The structure that contains the information required for notifications.
If the structure is null, the configuration will be deleted from the
stream.
$sel:httpStatus:DescribeNotificationConfigurationResponse'
, describeNotificationConfigurationResponse_httpStatus
- The response's http status code.
DescribeSignalingChannel
data DescribeSignalingChannel Source #
See: newDescribeSignalingChannel
smart constructor.
Instances
newDescribeSignalingChannel :: DescribeSignalingChannel Source #
Create a value of DescribeSignalingChannel
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:
DescribeSignalingChannel
, describeSignalingChannel_channelARN
- The ARN of the signaling channel that you want to describe.
DescribeSignalingChannel
, describeSignalingChannel_channelName
- The name of the signaling channel that you want to describe.
data DescribeSignalingChannelResponse Source #
See: newDescribeSignalingChannelResponse
smart constructor.
Instances
Generic DescribeSignalingChannelResponse Source # | |
Read DescribeSignalingChannelResponse Source # | |
Show DescribeSignalingChannelResponse Source # | |
NFData DescribeSignalingChannelResponse Source # | |
Defined in Amazonka.KinesisVideo.DescribeSignalingChannel rnf :: DescribeSignalingChannelResponse -> () # | |
Eq DescribeSignalingChannelResponse Source # | |
type Rep DescribeSignalingChannelResponse Source # | |
Defined in Amazonka.KinesisVideo.DescribeSignalingChannel type Rep DescribeSignalingChannelResponse = D1 ('MetaData "DescribeSignalingChannelResponse" "Amazonka.KinesisVideo.DescribeSignalingChannel" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "DescribeSignalingChannelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelInfo)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDescribeSignalingChannelResponse Source #
Create a value of DescribeSignalingChannelResponse
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:channelInfo:DescribeSignalingChannelResponse'
, describeSignalingChannelResponse_channelInfo
- A structure that encapsulates the specified signaling channel's
metadata and properties.
$sel:httpStatus:DescribeSignalingChannelResponse'
, describeSignalingChannelResponse_httpStatus
- The response's http status code.
DescribeStream
data DescribeStream Source #
See: newDescribeStream
smart constructor.
Instances
newDescribeStream :: DescribeStream Source #
Create a value of DescribeStream
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:
DescribeStream
, describeStream_streamARN
- The Amazon Resource Name (ARN) of the stream.
DescribeStream
, describeStream_streamName
- The name of the stream.
data DescribeStreamResponse Source #
See: newDescribeStreamResponse
smart constructor.
Instances
newDescribeStreamResponse Source #
Create a value of DescribeStreamResponse
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:streamInfo:DescribeStreamResponse'
, describeStreamResponse_streamInfo
- An object that describes the stream.
$sel:httpStatus:DescribeStreamResponse'
, describeStreamResponse_httpStatus
- The response's http status code.
GetDataEndpoint
data GetDataEndpoint Source #
See: newGetDataEndpoint
smart constructor.
Instances
Create a value of GetDataEndpoint
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:
GetDataEndpoint
, getDataEndpoint_streamARN
- 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
, getDataEndpoint_streamName
- 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.
$sel:aPIName:GetDataEndpoint'
, getDataEndpoint_aPIName
- The name of the API action for which to get an endpoint.
data GetDataEndpointResponse Source #
See: newGetDataEndpointResponse
smart constructor.
Instances
newGetDataEndpointResponse Source #
Create a value of GetDataEndpointResponse
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:dataEndpoint:GetDataEndpointResponse'
, getDataEndpointResponse_dataEndpoint
- The endpoint value. To read data from the stream or to write data to it,
specify this endpoint in your application.
$sel:httpStatus:GetDataEndpointResponse'
, getDataEndpointResponse_httpStatus
- The response's http status code.
GetSignalingChannelEndpoint
data GetSignalingChannelEndpoint Source #
See: newGetSignalingChannelEndpoint
smart constructor.
Instances
newGetSignalingChannelEndpoint Source #
Create a value of GetSignalingChannelEndpoint
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:singleMasterChannelEndpointConfiguration:GetSignalingChannelEndpoint'
, getSignalingChannelEndpoint_singleMasterChannelEndpointConfiguration
- A structure containing the endpoint configuration for the
SINGLE_MASTER
channel type.
GetSignalingChannelEndpoint
, getSignalingChannelEndpoint_channelARN
- The Amazon Resource Name (ARN) of the signalling channel for which you
want to get an endpoint.
data GetSignalingChannelEndpointResponse Source #
See: newGetSignalingChannelEndpointResponse
smart constructor.
Instances
newGetSignalingChannelEndpointResponse Source #
Create a value of GetSignalingChannelEndpointResponse
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:resourceEndpointList:GetSignalingChannelEndpointResponse'
, getSignalingChannelEndpointResponse_resourceEndpointList
- A list of endpoints for the specified signaling channel.
$sel:httpStatus:GetSignalingChannelEndpointResponse'
, getSignalingChannelEndpointResponse_httpStatus
- The response's http status code.
ListSignalingChannels (Paginated)
data ListSignalingChannels Source #
See: newListSignalingChannels
smart constructor.
Instances
newListSignalingChannels :: ListSignalingChannels Source #
Create a value of ListSignalingChannels
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:channelNameCondition:ListSignalingChannels'
, listSignalingChannels_channelNameCondition
- Optional: Returns only the channels that satisfy a specific condition.
$sel:maxResults:ListSignalingChannels'
, listSignalingChannels_maxResults
- The maximum number of channels to return in the response. The default is
500.
ListSignalingChannels
, listSignalingChannels_nextToken
- 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.
data ListSignalingChannelsResponse Source #
See: newListSignalingChannelsResponse
smart constructor.
Instances
newListSignalingChannelsResponse Source #
Create a value of ListSignalingChannelsResponse
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:channelInfoList:ListSignalingChannelsResponse'
, listSignalingChannelsResponse_channelInfoList
- An array of ChannelInfo
objects.
ListSignalingChannels
, listSignalingChannelsResponse_nextToken
- 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.
$sel:httpStatus:ListSignalingChannelsResponse'
, listSignalingChannelsResponse_httpStatus
- The response's http status code.
ListStreams (Paginated)
data ListStreams Source #
See: newListStreams
smart constructor.
Instances
newListStreams :: ListStreams Source #
Create a value of ListStreams
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:maxResults:ListStreams'
, listStreams_maxResults
- The maximum number of streams to return in the response. The default is
10,000.
ListStreams
, listStreams_nextToken
- 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.
$sel:streamNameCondition:ListStreams'
, listStreams_streamNameCondition
- Optional: Returns only streams that satisfy a specific condition.
Currently, you can specify only the prefix of a stream name as a
condition.
data ListStreamsResponse Source #
See: newListStreamsResponse
smart constructor.
Instances
newListStreamsResponse Source #
Create a value of ListStreamsResponse
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:
ListStreams
, listStreamsResponse_nextToken
- 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.
$sel:streamInfoList:ListStreamsResponse'
, listStreamsResponse_streamInfoList
- An array of StreamInfo
objects.
$sel:httpStatus:ListStreamsResponse'
, listStreamsResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:
ListTagsForResource
, listTagsForResource_nextToken
- 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.
$sel:resourceARN:ListTagsForResource'
, listTagsForResource_resourceARN
- The Amazon Resource Name (ARN) of the signaling channel for which you
want to list tags.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:
ListTagsForResource
, listTagsForResourceResponse_nextToken
- 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.
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- A map of tag keys and values associated with the specified signaling
channel.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListTagsForStream
data ListTagsForStream Source #
See: newListTagsForStream
smart constructor.
Instances
newListTagsForStream :: ListTagsForStream Source #
Create a value of ListTagsForStream
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:
ListTagsForStream
, listTagsForStream_nextToken
- 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
, listTagsForStream_streamARN
- The Amazon Resource Name (ARN) of the stream that you want to list tags
for.
ListTagsForStream
, listTagsForStream_streamName
- The name of the stream that you want to list tags for.
data ListTagsForStreamResponse Source #
See: newListTagsForStreamResponse
smart constructor.
Instances
newListTagsForStreamResponse Source #
Create a value of ListTagsForStreamResponse
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:
ListTagsForStream
, listTagsForStreamResponse_nextToken
- 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.
$sel:tags:ListTagsForStreamResponse'
, listTagsForStreamResponse_tags
- A map of tag keys and values associated with the specified stream.
$sel:httpStatus:ListTagsForStreamResponse'
, listTagsForStreamResponse_httpStatus
- The response's http status code.
StartEdgeConfigurationUpdate
data StartEdgeConfigurationUpdate Source #
See: newStartEdgeConfigurationUpdate
smart constructor.
Instances
newStartEdgeConfigurationUpdate Source #
Create a value of StartEdgeConfigurationUpdate
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:
StartEdgeConfigurationUpdate
, startEdgeConfigurationUpdate_streamARN
- The Amazon Resource Name (ARN) of the stream. Specify either the
StreamName
or the StreamARN
.
StartEdgeConfigurationUpdate
, startEdgeConfigurationUpdate_streamName
- The name of the stream whose edge configuration you want to update.
Specify either the StreamName
or the StreamARN
.
StartEdgeConfigurationUpdate
, startEdgeConfigurationUpdate_edgeConfig
- The edge configuration details required to invoke the update process.
data StartEdgeConfigurationUpdateResponse Source #
See: newStartEdgeConfigurationUpdateResponse
smart constructor.
StartEdgeConfigurationUpdateResponse' (Maybe POSIX) (Maybe EdgeConfig) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe SyncStatus) Int |
Instances
newStartEdgeConfigurationUpdateResponse Source #
Create a value of StartEdgeConfigurationUpdateResponse
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:
StartEdgeConfigurationUpdateResponse
, startEdgeConfigurationUpdateResponse_creationTime
- The timestamp at which a stream’s edge configuration was first created.
StartEdgeConfigurationUpdate
, startEdgeConfigurationUpdateResponse_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.
$sel:failedStatusDetails:StartEdgeConfigurationUpdateResponse'
, startEdgeConfigurationUpdateResponse_failedStatusDetails
- A description of the generated failure status.
$sel:lastUpdatedTime:StartEdgeConfigurationUpdateResponse'
, startEdgeConfigurationUpdateResponse_lastUpdatedTime
- The timestamp at which a stream’s edge configuration was last updated.
StartEdgeConfigurationUpdate
, startEdgeConfigurationUpdateResponse_streamARN
- The Amazon Resource Name (ARN) of the stream.
StartEdgeConfigurationUpdate
, startEdgeConfigurationUpdateResponse_streamName
- The name of the stream from which the edge configuration was updated.
$sel:syncStatus:StartEdgeConfigurationUpdateResponse'
, startEdgeConfigurationUpdateResponse_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.
$sel:httpStatus:StartEdgeConfigurationUpdateResponse'
, startEdgeConfigurationUpdateResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceARN:TagResource'
, tagResource_resourceARN
- The Amazon Resource Name (ARN) of the signaling channel to which you
want to add tags.
$sel:tags:TagResource'
, tagResource_tags
- A list of tags to associate with the specified signaling channel. Each
tag is a key-value pair.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
TagStream
See: newTagStream
smart constructor.
Instances
newTagStream :: TagStream Source #
Create a value of TagStream
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:
TagStream
, tagStream_streamARN
- The Amazon Resource Name (ARN) of the resource that you want to add the
tag or tags to.
TagStream
, tagStream_streamName
- The name of the stream that you want to add the tag or tags to.
$sel:tags:TagStream'
, tagStream_tags
- A list of tags to associate with the specified stream. Each tag is a
key-value pair (the value is optional).
data TagStreamResponse Source #
See: newTagStreamResponse
smart constructor.
Instances
Create a value of TagStreamResponse
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:httpStatus:TagStreamResponse'
, tagStreamResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
:: Text | |
-> NonEmpty Text | |
-> UntagResource |
Create a value of UntagResource
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:resourceARN:UntagResource'
, untagResource_resourceARN
- The Amazon Resource Name (ARN) of the signaling channel from which you
want to remove tags.
$sel:tagKeyList:UntagResource'
, untagResource_tagKeyList
- A list of the keys of the tags that you want to remove.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
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:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UntagStream
data UntagStream Source #
See: newUntagStream
smart constructor.
Instances
Create a value of UntagStream
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:
UntagStream
, untagStream_streamARN
- The Amazon Resource Name (ARN) of the stream that you want to remove
tags from.
UntagStream
, untagStream_streamName
- The name of the stream that you want to remove tags from.
$sel:tagKeyList:UntagStream'
, untagStream_tagKeyList
- A list of the keys of the tags that you want to remove.
data UntagStreamResponse Source #
See: newUntagStreamResponse
smart constructor.
Instances
newUntagStreamResponse Source #
Create a value of UntagStreamResponse
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:httpStatus:UntagStreamResponse'
, untagStreamResponse_httpStatus
- The response's http status code.
UpdateDataRetention
data UpdateDataRetention Source #
See: newUpdateDataRetention
smart constructor.
Instances
newUpdateDataRetention Source #
Create a value of UpdateDataRetention
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:
UpdateDataRetention
, updateDataRetention_streamARN
- The Amazon Resource Name (ARN) of the stream whose retention period you
want to change.
UpdateDataRetention
, updateDataRetention_streamName
- The name of the stream whose retention period you want to change.
$sel:currentVersion:UpdateDataRetention'
, updateDataRetention_currentVersion
- The version of the stream whose retention period you want to change. To
get the version, call either the DescribeStream
or the ListStreams
API.
$sel:operation:UpdateDataRetention'
, updateDataRetention_operation
- Indicates whether you want to increase or decrease the retention period.
$sel:dataRetentionChangeInHours:UpdateDataRetention'
, updateDataRetention_dataRetentionChangeInHours
- The retention period, in hours. The value you specify replaces the
current value. The maximum value for this parameter is 87600 (ten
years).
data UpdateDataRetentionResponse Source #
See: newUpdateDataRetentionResponse
smart constructor.
Instances
newUpdateDataRetentionResponse Source #
Create a value of UpdateDataRetentionResponse
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:httpStatus:UpdateDataRetentionResponse'
, updateDataRetentionResponse_httpStatus
- The response's http status code.
UpdateImageGenerationConfiguration
data UpdateImageGenerationConfiguration Source #
See: newUpdateImageGenerationConfiguration
smart constructor.
Instances
newUpdateImageGenerationConfiguration :: UpdateImageGenerationConfiguration Source #
Create a value of UpdateImageGenerationConfiguration
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:imageGenerationConfiguration:UpdateImageGenerationConfiguration'
, updateImageGenerationConfiguration_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
, updateImageGenerationConfiguration_streamARN
- 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
, updateImageGenerationConfiguration_streamName
- The name of the stream from which to update the image generation
configuration. You must specify either the StreamName
or the
StreamARN
.
data UpdateImageGenerationConfigurationResponse Source #
See: newUpdateImageGenerationConfigurationResponse
smart constructor.
Instances
Generic UpdateImageGenerationConfigurationResponse Source # | |
Read UpdateImageGenerationConfigurationResponse Source # | |
Show UpdateImageGenerationConfigurationResponse Source # | |
NFData UpdateImageGenerationConfigurationResponse Source # | |
Eq UpdateImageGenerationConfigurationResponse Source # | |
type Rep UpdateImageGenerationConfigurationResponse Source # | |
Defined in Amazonka.KinesisVideo.UpdateImageGenerationConfiguration type Rep UpdateImageGenerationConfigurationResponse = D1 ('MetaData "UpdateImageGenerationConfigurationResponse" "Amazonka.KinesisVideo.UpdateImageGenerationConfiguration" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "UpdateImageGenerationConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdateImageGenerationConfigurationResponse Source #
Create a value of UpdateImageGenerationConfigurationResponse
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:httpStatus:UpdateImageGenerationConfigurationResponse'
, updateImageGenerationConfigurationResponse_httpStatus
- The response's http status code.
UpdateMediaStorageConfiguration
data UpdateMediaStorageConfiguration Source #
See: newUpdateMediaStorageConfiguration
smart constructor.
Instances
newUpdateMediaStorageConfiguration Source #
:: Text | |
-> MediaStorageConfiguration |
|
-> UpdateMediaStorageConfiguration |
Create a value of UpdateMediaStorageConfiguration
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:
UpdateMediaStorageConfiguration
, updateMediaStorageConfiguration_channelARN
- The Amazon Resource Name (ARN) of the channel.
$sel:mediaStorageConfiguration:UpdateMediaStorageConfiguration'
, updateMediaStorageConfiguration_mediaStorageConfiguration
- A structure that encapsulates, or contains, the media storage
configuration properties.
data UpdateMediaStorageConfigurationResponse Source #
See: newUpdateMediaStorageConfigurationResponse
smart constructor.
Instances
Generic UpdateMediaStorageConfigurationResponse Source # | |
Defined in Amazonka.KinesisVideo.UpdateMediaStorageConfiguration type Rep UpdateMediaStorageConfigurationResponse :: Type -> Type # | |
Read UpdateMediaStorageConfigurationResponse Source # | |
Show UpdateMediaStorageConfigurationResponse Source # | |
NFData UpdateMediaStorageConfigurationResponse Source # | |
Eq UpdateMediaStorageConfigurationResponse Source # | |
type Rep UpdateMediaStorageConfigurationResponse Source # | |
Defined in Amazonka.KinesisVideo.UpdateMediaStorageConfiguration type Rep UpdateMediaStorageConfigurationResponse = D1 ('MetaData "UpdateMediaStorageConfigurationResponse" "Amazonka.KinesisVideo.UpdateMediaStorageConfiguration" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "UpdateMediaStorageConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdateMediaStorageConfigurationResponse Source #
Create a value of UpdateMediaStorageConfigurationResponse
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:httpStatus:UpdateMediaStorageConfigurationResponse'
, updateMediaStorageConfigurationResponse_httpStatus
- The response's http status code.
UpdateNotificationConfiguration
data UpdateNotificationConfiguration Source #
See: newUpdateNotificationConfiguration
smart constructor.
Instances
newUpdateNotificationConfiguration :: UpdateNotificationConfiguration Source #
Create a value of UpdateNotificationConfiguration
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:notificationConfiguration:UpdateNotificationConfiguration'
, updateNotificationConfiguration_notificationConfiguration
- The structure containing the information required for notifications. If
the structure is null, the configuration will be deleted from the
stream.
UpdateNotificationConfiguration
, updateNotificationConfiguration_streamARN
- 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
, updateNotificationConfiguration_streamName
- The name of the stream from which to update the notification
configuration. You must specify either the StreamName
or the
StreamARN
.
data UpdateNotificationConfigurationResponse Source #
See: newUpdateNotificationConfigurationResponse
smart constructor.
Instances
Generic UpdateNotificationConfigurationResponse Source # | |
Defined in Amazonka.KinesisVideo.UpdateNotificationConfiguration type Rep UpdateNotificationConfigurationResponse :: Type -> Type # | |
Read UpdateNotificationConfigurationResponse Source # | |
Show UpdateNotificationConfigurationResponse Source # | |
NFData UpdateNotificationConfigurationResponse Source # | |
Eq UpdateNotificationConfigurationResponse Source # | |
type Rep UpdateNotificationConfigurationResponse Source # | |
Defined in Amazonka.KinesisVideo.UpdateNotificationConfiguration type Rep UpdateNotificationConfigurationResponse = D1 ('MetaData "UpdateNotificationConfigurationResponse" "Amazonka.KinesisVideo.UpdateNotificationConfiguration" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "UpdateNotificationConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdateNotificationConfigurationResponse Source #
Create a value of UpdateNotificationConfigurationResponse
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:httpStatus:UpdateNotificationConfigurationResponse'
, updateNotificationConfigurationResponse_httpStatus
- The response's http status code.
UpdateSignalingChannel
data UpdateSignalingChannel Source #
See: newUpdateSignalingChannel
smart constructor.
Instances
newUpdateSignalingChannel Source #
:: Text | |
-> Text | |
-> UpdateSignalingChannel |
Create a value of UpdateSignalingChannel
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:
UpdateSignalingChannel
, updateSignalingChannel_singleMasterConfiguration
- The structure containing the configuration for the SINGLE_MASTER
type
of the signaling channel that you want to update.
UpdateSignalingChannel
, updateSignalingChannel_channelARN
- The Amazon Resource Name (ARN) of the signaling channel that you want to
update.
$sel:currentVersion:UpdateSignalingChannel'
, updateSignalingChannel_currentVersion
- The current version of the signaling channel that you want to update.
data UpdateSignalingChannelResponse Source #
See: newUpdateSignalingChannelResponse
smart constructor.
Instances
Generic UpdateSignalingChannelResponse Source # | |
Read UpdateSignalingChannelResponse Source # | |
Show UpdateSignalingChannelResponse Source # | |
Defined in Amazonka.KinesisVideo.UpdateSignalingChannel | |
NFData UpdateSignalingChannelResponse Source # | |
Defined in Amazonka.KinesisVideo.UpdateSignalingChannel rnf :: UpdateSignalingChannelResponse -> () # | |
Eq UpdateSignalingChannelResponse Source # | |
type Rep UpdateSignalingChannelResponse Source # | |
Defined in Amazonka.KinesisVideo.UpdateSignalingChannel type Rep UpdateSignalingChannelResponse = D1 ('MetaData "UpdateSignalingChannelResponse" "Amazonka.KinesisVideo.UpdateSignalingChannel" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "UpdateSignalingChannelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdateSignalingChannelResponse Source #
Create a value of UpdateSignalingChannelResponse
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:httpStatus:UpdateSignalingChannelResponse'
, updateSignalingChannelResponse_httpStatus
- The response's http status code.
UpdateStream
data UpdateStream Source #
See: newUpdateStream
smart constructor.
Instances
Create a value of UpdateStream
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:
UpdateStream
, updateStream_deviceName
- The name of the device that is writing to the stream.
In the current implementation, Kinesis Video Streams does not use this name.
UpdateStream
, updateStream_mediaType
- 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
, updateStream_streamARN
- The ARN of the stream whose metadata you want to update.
UpdateStream
, updateStream_streamName
- 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.
$sel:currentVersion:UpdateStream'
, updateStream_currentVersion
- The version of the stream whose metadata you want to update.
data UpdateStreamResponse Source #
See: newUpdateStreamResponse
smart constructor.
Instances
newUpdateStreamResponse Source #
Create a value of UpdateStreamResponse
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:httpStatus:UpdateStreamResponse'
, updateStreamResponse_httpStatus
- The response's http status code.
Types
APIName
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 #
pattern ChannelProtocol_HTTPS :: ChannelProtocol | |
pattern ChannelProtocol_WEBRTC :: ChannelProtocol | |
pattern ChannelProtocol_WSS :: ChannelProtocol |
Instances
ChannelRole
newtype ChannelRole Source #
pattern ChannelRole_MASTER :: ChannelRole | |
pattern ChannelRole_VIEWER :: ChannelRole |
Instances
ChannelType
newtype ChannelType Source #
pattern ChannelType_FULL_MESH :: ChannelType | |
pattern ChannelType_SINGLE_MASTER :: ChannelType |
Instances
ComparisonOperator
newtype ComparisonOperator Source #
pattern ComparisonOperator_BEGINS_WITH :: ComparisonOperator |
Instances
ConfigurationStatus
newtype ConfigurationStatus Source #
pattern ConfigurationStatus_DISABLED :: ConfigurationStatus | |
pattern ConfigurationStatus_ENABLED :: ConfigurationStatus |
Instances
Format
pattern Format_JPEG :: Format | |
pattern Format_PNG :: Format |
Instances
FormatConfigKey
newtype FormatConfigKey Source #
pattern FormatConfigKey_JPEGQuality :: FormatConfigKey |
Instances
ImageSelectorType
newtype ImageSelectorType Source #
pattern ImageSelectorType_PRODUCER_TIMESTAMP :: ImageSelectorType | |
pattern ImageSelectorType_SERVER_TIMESTAMP :: ImageSelectorType |
Instances
MediaStorageConfigurationStatus
newtype MediaStorageConfigurationStatus Source #
pattern MediaStorageConfigurationStatus_DISABLED :: MediaStorageConfigurationStatus | |
pattern MediaStorageConfigurationStatus_ENABLED :: MediaStorageConfigurationStatus |
Instances
MediaUriType
newtype MediaUriType Source #
pattern MediaUriType_FILE_URI :: MediaUriType | |
pattern MediaUriType_RTSP_URI :: MediaUriType |
Instances
StrategyOnFullSize
newtype StrategyOnFullSize Source #
pattern StrategyOnFullSize_DELETE_OLDEST_MEDIA :: StrategyOnFullSize | |
pattern StrategyOnFullSize_DENY_NEW_MEDIA :: StrategyOnFullSize |
Instances
StreamStatus
newtype StreamStatus Source #
pattern StreamStatus_ACTIVE :: StreamStatus | |
pattern StreamStatus_CREATING :: StreamStatus | |
pattern StreamStatus_DELETING :: StreamStatus | |
pattern StreamStatus_UPDATING :: StreamStatus |
Instances
SyncStatus
newtype SyncStatus Source #
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 #
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.
ChannelInfo' (Maybe Text) (Maybe Text) (Maybe StreamStatus) (Maybe ChannelType) (Maybe POSIX) (Maybe SingleMasterConfiguration) (Maybe Text) |
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.
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.
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.
DeletionConfig
data DeletionConfig Source #
The configuration details required to delete the connection of the stream from the Edge Agent.
See: newDeletionConfig
smart constructor.
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.
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.
Instances
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.
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.
ImageGenerationConfiguration' (Maybe (HashMap FormatConfigKey Text)) (Maybe Natural) (Maybe Natural) ConfigurationStatus ImageSelectorType ImageGenerationDestinationConfig Natural Format |
Instances
newImageGenerationConfiguration Source #
:: 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.
ImageGenerationDestinationConfig
data ImageGenerationDestinationConfig Source #
The structure that contains the information required to deliver images to a customer.
See: newImageGenerationDestinationConfig
smart constructor.
Instances
newImageGenerationDestinationConfig Source #
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.
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.
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.
MappedResourceConfigurationListItem
data MappedResourceConfigurationListItem Source #
A structure that encapsulates, or contains, the media storage configuration properties.
See: newMappedResourceConfigurationListItem
smart constructor.
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.
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.
Instances
:: 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 .
MediaStorageConfiguration
data MediaStorageConfiguration Source #
A structure that encapsulates, or contains, the media storage configuration properties.
See: newMediaStorageConfiguration
smart constructor.
Instances
newMediaStorageConfiguration Source #
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.
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.
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.
NotificationDestinationConfig
data NotificationDestinationConfig Source #
The structure that contains the information required to deliver a notification to a customer.
See: newNotificationDestinationConfig
smart constructor.
Instances
FromJSON NotificationDestinationConfig Source # | |
ToJSON NotificationDestinationConfig Source # | |
Generic NotificationDestinationConfig Source # | |
Read NotificationDestinationConfig Source # | |
Show NotificationDestinationConfig Source # | |
NFData NotificationDestinationConfig Source # | |
Defined in Amazonka.KinesisVideo.Types.NotificationDestinationConfig rnf :: NotificationDestinationConfig -> () # | |
Eq NotificationDestinationConfig Source # | |
Hashable NotificationDestinationConfig Source # | |
type Rep NotificationDestinationConfig Source # | |
Defined in Amazonka.KinesisVideo.Types.NotificationDestinationConfig type Rep NotificationDestinationConfig = D1 ('MetaData "NotificationDestinationConfig" "Amazonka.KinesisVideo.Types.NotificationDestinationConfig" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "NotificationDestinationConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
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.
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.
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.
ResourceEndpointListItem
data ResourceEndpointListItem Source #
An object that describes the endpoint of the signaling channel returned
by the GetSignalingChannelEndpoint
API.
See: newResourceEndpointListItem
smart constructor.
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.
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.
Instances
:: 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.
SingleMasterChannelEndpointConfiguration
data SingleMasterChannelEndpointConfiguration Source #
An object that contains the endpoint configuration for the
SINGLE_MASTER
channel type.
See: newSingleMasterChannelEndpointConfiguration
smart constructor.
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.
SingleMasterConfiguration
data SingleMasterConfiguration Source #
A structure that contains the configuration for the SINGLE_MASTER
channel type.
See: newSingleMasterConfiguration
smart constructor.
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.
StreamInfo
data StreamInfo Source #
An object describing a Kinesis video stream.
See: newStreamInfo
smart constructor.
StreamInfo' (Maybe POSIX) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe StreamStatus) (Maybe Text) (Maybe Text) (Maybe Text) |
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.
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.
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.
Tag
A key and value pair that is associated with the specified signaling channel.
See: newTag
smart constructor.
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.
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.
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
DurationInMinutes
details 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.