| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.KinesisVideo.Types
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _TagsPerResourceExceededLimitException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClientLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccountChannelLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDeviceException :: AsError a => Getting (First ServiceError) a ServiceError
- _VersionMismatchException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccountStreamLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidResourceFormatException :: AsError a => Getting (First ServiceError) a ServiceError
- _DeviceStreamLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype APIName where
- APIName' {
- fromAPIName :: Text
- pattern APIName_GET_CLIP :: APIName
- pattern APIName_GET_DASH_STREAMING_SESSION_URL :: APIName
- pattern APIName_GET_HLS_STREAMING_SESSION_URL :: APIName
- pattern APIName_GET_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_WSS :: ChannelProtocol
- newtype ChannelRole where
- ChannelRole' { }
- pattern ChannelRole_MASTER :: ChannelRole
- pattern ChannelRole_VIEWER :: ChannelRole
- newtype ChannelType where
- ChannelType' { }
- pattern ChannelType_SINGLE_MASTER :: ChannelType
- newtype ComparisonOperator where
- newtype StreamStatus where
- StreamStatus' { }
- pattern StreamStatus_ACTIVE :: StreamStatus
- pattern StreamStatus_CREATING :: StreamStatus
- pattern StreamStatus_DELETING :: StreamStatus
- pattern StreamStatus_UPDATING :: StreamStatus
- newtype UpdateDataRetentionOperation where
- data ChannelInfo = ChannelInfo' {}
- newChannelInfo :: ChannelInfo
- channelInfo_creationTime :: Lens' ChannelInfo (Maybe UTCTime)
- channelInfo_channelStatus :: Lens' ChannelInfo (Maybe StreamStatus)
- channelInfo_channelARN :: Lens' ChannelInfo (Maybe Text)
- channelInfo_singleMasterConfiguration :: Lens' ChannelInfo (Maybe SingleMasterConfiguration)
- channelInfo_channelName :: Lens' ChannelInfo (Maybe Text)
- channelInfo_version :: Lens' ChannelInfo (Maybe Text)
- channelInfo_channelType :: Lens' ChannelInfo (Maybe ChannelType)
- data ChannelNameCondition = ChannelNameCondition' {}
- newChannelNameCondition :: ChannelNameCondition
- channelNameCondition_comparisonOperator :: Lens' ChannelNameCondition (Maybe ComparisonOperator)
- channelNameCondition_comparisonValue :: Lens' ChannelNameCondition (Maybe Text)
- data ResourceEndpointListItem = ResourceEndpointListItem' {}
- newResourceEndpointListItem :: ResourceEndpointListItem
- resourceEndpointListItem_protocol :: Lens' ResourceEndpointListItem (Maybe ChannelProtocol)
- resourceEndpointListItem_resourceEndpoint :: Lens' ResourceEndpointListItem (Maybe Text)
- data SingleMasterChannelEndpointConfiguration = SingleMasterChannelEndpointConfiguration' {}
- newSingleMasterChannelEndpointConfiguration :: SingleMasterChannelEndpointConfiguration
- singleMasterChannelEndpointConfiguration_protocols :: Lens' SingleMasterChannelEndpointConfiguration (Maybe (NonEmpty ChannelProtocol))
- singleMasterChannelEndpointConfiguration_role :: Lens' SingleMasterChannelEndpointConfiguration (Maybe ChannelRole)
- data SingleMasterConfiguration = SingleMasterConfiguration' {}
- newSingleMasterConfiguration :: SingleMasterConfiguration
- singleMasterConfiguration_messageTtlSeconds :: Lens' SingleMasterConfiguration (Maybe Natural)
- data StreamInfo = StreamInfo' {}
- newStreamInfo :: StreamInfo
- streamInfo_creationTime :: Lens' StreamInfo (Maybe UTCTime)
- streamInfo_status :: Lens' StreamInfo (Maybe StreamStatus)
- streamInfo_mediaType :: Lens' StreamInfo (Maybe Text)
- streamInfo_dataRetentionInHours :: Lens' StreamInfo (Maybe Natural)
- streamInfo_streamARN :: Lens' StreamInfo (Maybe Text)
- streamInfo_kmsKeyId :: Lens' StreamInfo (Maybe Text)
- streamInfo_deviceName :: Lens' StreamInfo (Maybe Text)
- streamInfo_version :: Lens' StreamInfo (Maybe Text)
- streamInfo_streamName :: Lens' StreamInfo (Maybe Text)
- data StreamNameCondition = StreamNameCondition' {}
- newStreamNameCondition :: StreamNameCondition
- streamNameCondition_comparisonOperator :: Lens' StreamNameCondition (Maybe ComparisonOperator)
- streamNameCondition_comparisonValue :: Lens' StreamNameCondition (Maybe Text)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
Service Configuration
defaultService :: Service Source #
API version 2017-09-30 of the Amazon Kinesis Video Streams SDK configuration.
Errors
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You do not have required permissions to perform this operation.
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The value for this input parameter is invalid.
_TagsPerResourceExceededLimitException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have exceeded the limit of tags that you can associate with the resource. Kinesis video streams support up to 50 tags.
_NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The caller is not authorized to perform this operation.
_ClientLimitExceededException :: AsError a => Getting (First ServiceError) 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.
_AccountChannelLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have reached the maximum limit of active signaling channels for this AWS account in this region.
_InvalidDeviceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Not implemented.
_VersionMismatchException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.
_AccountStreamLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of streams created for the account is too high.
_InvalidResourceFormatException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The format of the StreamARN is invalid.
_DeviceStreamLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Not implemented.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Kinesis Video Streams can't find the stream that you specified.
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The signaling channel is currently not available for this operation.
APIName
Constructors
| APIName' | |
Fields
| |
Bundled Patterns
| pattern APIName_GET_CLIP :: APIName | |
| pattern APIName_GET_DASH_STREAMING_SESSION_URL :: APIName | |
| pattern APIName_GET_HLS_STREAMING_SESSION_URL :: APIName | |
| pattern APIName_GET_MEDIA :: APIName | |
| pattern APIName_GET_MEDIA_FOR_FRAGMENT_LIST :: APIName | |
| pattern APIName_LIST_FRAGMENTS :: APIName | |
| pattern APIName_PUT_MEDIA :: APIName |
Instances
ChannelProtocol
newtype ChannelProtocol Source #
Constructors
| ChannelProtocol' | |
Fields | |
Bundled Patterns
| pattern ChannelProtocol_HTTPS :: ChannelProtocol | |
| pattern ChannelProtocol_WSS :: ChannelProtocol |
Instances
ChannelRole
newtype ChannelRole Source #
Constructors
| ChannelRole' | |
Fields | |
Bundled Patterns
| pattern ChannelRole_MASTER :: ChannelRole | |
| pattern ChannelRole_VIEWER :: ChannelRole |
Instances
ChannelType
newtype ChannelType Source #
Constructors
| ChannelType' | |
Fields | |
Bundled Patterns
| pattern ChannelType_SINGLE_MASTER :: ChannelType |
Instances
ComparisonOperator
newtype ComparisonOperator Source #
Constructors
| ComparisonOperator' | |
Fields | |
Bundled Patterns
| pattern ComparisonOperator_BEGINS_WITH :: ComparisonOperator |
Instances
StreamStatus
newtype StreamStatus Source #
Constructors
| StreamStatus' | |
Fields | |
Bundled Patterns
| pattern StreamStatus_ACTIVE :: StreamStatus | |
| pattern StreamStatus_CREATING :: StreamStatus | |
| pattern StreamStatus_DELETING :: StreamStatus | |
| pattern StreamStatus_UPDATING :: StreamStatus |
Instances
UpdateDataRetentionOperation
newtype UpdateDataRetentionOperation Source #
Constructors
| UpdateDataRetentionOperation' | |
Fields | |
Bundled Patterns
| pattern UpdateDataRetentionOperation_DECREASE_DATA_RETENTION :: UpdateDataRetentionOperation | |
| pattern UpdateDataRetentionOperation_INCREASE_DATA_RETENTION :: UpdateDataRetentionOperation |
Instances
ChannelInfo
data ChannelInfo Source #
A structure that encapsulates a signaling channel's metadata and properties.
See: newChannelInfo smart constructor.
Constructors
| ChannelInfo' | |
Fields
| |
Instances
newChannelInfo :: ChannelInfo Source #
Create a value of ChannelInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:ChannelInfo', channelInfo_creationTime - The time at which the signaling channel was created.
$sel:channelStatus:ChannelInfo', channelInfo_channelStatus - Current status of the signaling channel.
$sel:channelARN:ChannelInfo', channelInfo_channelARN - The Amazon Resource Name (ARN) of the signaling channel.
$sel:singleMasterConfiguration:ChannelInfo', channelInfo_singleMasterConfiguration - A structure that contains the configuration for the SINGLE_MASTER
channel type.
$sel:channelName:ChannelInfo', channelInfo_channelName - The name of the signaling channel.
$sel:version:ChannelInfo', channelInfo_version - The current version of the signaling channel.
$sel:channelType:ChannelInfo', channelInfo_channelType - The type of the signaling channel.
channelInfo_creationTime :: Lens' ChannelInfo (Maybe UTCTime) Source #
The time at which the signaling channel was created.
channelInfo_channelStatus :: Lens' ChannelInfo (Maybe StreamStatus) Source #
Current status of the signaling channel.
channelInfo_channelARN :: Lens' ChannelInfo (Maybe Text) Source #
The Amazon Resource Name (ARN) of the signaling channel.
channelInfo_singleMasterConfiguration :: Lens' ChannelInfo (Maybe SingleMasterConfiguration) Source #
A structure that contains the configuration for the SINGLE_MASTER
channel type.
channelInfo_channelName :: Lens' ChannelInfo (Maybe Text) Source #
The name of the signaling channel.
channelInfo_version :: Lens' ChannelInfo (Maybe Text) Source #
The current version of the signaling channel.
channelInfo_channelType :: Lens' ChannelInfo (Maybe ChannelType) Source #
The type of the signaling channel.
ChannelNameCondition
data ChannelNameCondition Source #
An optional input parameter for the ListSignalingChannels API. When
this parameter is specified while invoking ListSignalingChannels, the
API returns only the channels that satisfy a condition specified in
ChannelNameCondition.
See: newChannelNameCondition smart constructor.
Constructors
| ChannelNameCondition' | |
Fields
| |
Instances
newChannelNameCondition :: ChannelNameCondition Source #
Create a value of ChannelNameCondition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:comparisonOperator:ChannelNameCondition', channelNameCondition_comparisonOperator - A comparison operator. Currently, you can only specify the BEGINS_WITH
operator, which finds signaling channels whose names begin with a given
prefix.
$sel:comparisonValue:ChannelNameCondition', channelNameCondition_comparisonValue - A value to compare.
channelNameCondition_comparisonOperator :: Lens' ChannelNameCondition (Maybe ComparisonOperator) Source #
A comparison operator. Currently, you can only specify the BEGINS_WITH
operator, which finds signaling channels whose names begin with a given
prefix.
channelNameCondition_comparisonValue :: Lens' ChannelNameCondition (Maybe Text) Source #
A value to compare.
ResourceEndpointListItem
data ResourceEndpointListItem Source #
An object that describes the endpoint of the signaling channel returned
by the GetSignalingChannelEndpoint API.
See: newResourceEndpointListItem smart constructor.
Constructors
| ResourceEndpointListItem' | |
Fields
| |
Instances
newResourceEndpointListItem :: ResourceEndpointListItem Source #
Create a value of ResourceEndpointListItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:protocol:ResourceEndpointListItem', resourceEndpointListItem_protocol - The protocol of the signaling channel returned by the
GetSignalingChannelEndpoint API.
$sel:resourceEndpoint:ResourceEndpointListItem', resourceEndpointListItem_resourceEndpoint - The endpoint of the signaling channel returned by the
GetSignalingChannelEndpoint API.
resourceEndpointListItem_protocol :: Lens' ResourceEndpointListItem (Maybe ChannelProtocol) Source #
The protocol of the signaling channel returned by the
GetSignalingChannelEndpoint API.
resourceEndpointListItem_resourceEndpoint :: Lens' ResourceEndpointListItem (Maybe Text) Source #
The endpoint of the signaling channel returned by the
GetSignalingChannelEndpoint API.
SingleMasterChannelEndpointConfiguration
data SingleMasterChannelEndpointConfiguration Source #
An object that contains the endpoint configuration for the
SINGLE_MASTER channel type.
See: newSingleMasterChannelEndpointConfiguration smart constructor.
Constructors
| SingleMasterChannelEndpointConfiguration' | |
Fields
| |
Instances
newSingleMasterChannelEndpointConfiguration :: SingleMasterChannelEndpointConfiguration Source #
Create a value of SingleMasterChannelEndpointConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:protocols:SingleMasterChannelEndpointConfiguration', singleMasterChannelEndpointConfiguration_protocols - This property is used to determine the nature of communication over this
SINGLE_MASTER signaling channel. If WSS is specified, this API
returns a websocket endpoint. If HTTPS is specified, this API returns
an HTTPS endpoint.
$sel:role':SingleMasterChannelEndpointConfiguration', singleMasterChannelEndpointConfiguration_role - This property is used to determine messaging permissions in this
SINGLE_MASTER signaling channel. If MASTER is specified, this API
returns an endpoint that a client can use to receive offers from and
send answers to any of the viewers on this signaling channel. If
VIEWER is specified, this API returns an endpoint that a client can
use only to send offers to another MASTER client on this signaling
channel.
singleMasterChannelEndpointConfiguration_protocols :: Lens' SingleMasterChannelEndpointConfiguration (Maybe (NonEmpty ChannelProtocol)) Source #
This property is used to determine the nature of communication over this
SINGLE_MASTER signaling channel. If WSS is specified, this API
returns a websocket endpoint. If HTTPS is specified, this API returns
an HTTPS endpoint.
singleMasterChannelEndpointConfiguration_role :: Lens' SingleMasterChannelEndpointConfiguration (Maybe ChannelRole) Source #
This property is used to determine messaging permissions in this
SINGLE_MASTER signaling channel. If MASTER is specified, this API
returns an endpoint that a client can use to receive offers from and
send answers to any of the viewers on this signaling channel. If
VIEWER is specified, this API returns an endpoint that a client can
use only to send offers to another MASTER client on this signaling
channel.
SingleMasterConfiguration
data SingleMasterConfiguration Source #
A structure that contains the configuration for the SINGLE_MASTER
channel type.
See: newSingleMasterConfiguration smart constructor.
Constructors
| SingleMasterConfiguration' | |
Fields
| |
Instances
newSingleMasterConfiguration :: SingleMasterConfiguration Source #
Create a value of SingleMasterConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:messageTtlSeconds:SingleMasterConfiguration', singleMasterConfiguration_messageTtlSeconds - The period of time a signaling channel retains underlivered messages
before they are discarded.
singleMasterConfiguration_messageTtlSeconds :: Lens' SingleMasterConfiguration (Maybe Natural) Source #
The period of time a signaling channel retains underlivered messages before they are discarded.
StreamInfo
data StreamInfo Source #
An object describing a Kinesis video stream.
See: newStreamInfo smart constructor.
Constructors
| StreamInfo' | |
Fields
| |
Instances
newStreamInfo :: StreamInfo Source #
Create a value of StreamInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:StreamInfo', streamInfo_creationTime - A time stamp that indicates when the stream was created.
$sel:status:StreamInfo', streamInfo_status - The status of the stream.
$sel:mediaType:StreamInfo', streamInfo_mediaType - The MediaType of the stream.
$sel:dataRetentionInHours:StreamInfo', streamInfo_dataRetentionInHours - How long the stream retains data, in hours.
$sel:streamARN:StreamInfo', streamInfo_streamARN - The Amazon Resource Name (ARN) of the stream.
$sel:kmsKeyId:StreamInfo', streamInfo_kmsKeyId - The ID of the AWS Key Management Service (AWS KMS) key that Kinesis
Video Streams uses to encrypt data on the stream.
$sel:deviceName:StreamInfo', streamInfo_deviceName - The name of the device that is associated with the stream.
$sel:version:StreamInfo', streamInfo_version - The version of the stream.
$sel:streamName:StreamInfo', streamInfo_streamName - The name of the stream.
streamInfo_creationTime :: Lens' StreamInfo (Maybe UTCTime) Source #
A time stamp that indicates when the stream was created.
streamInfo_status :: Lens' StreamInfo (Maybe StreamStatus) Source #
The status of the stream.
streamInfo_mediaType :: Lens' StreamInfo (Maybe Text) Source #
The MediaType of the stream.
streamInfo_dataRetentionInHours :: Lens' StreamInfo (Maybe Natural) Source #
How long the stream retains data, in hours.
streamInfo_streamARN :: Lens' StreamInfo (Maybe Text) Source #
The Amazon Resource Name (ARN) of the stream.
streamInfo_kmsKeyId :: Lens' StreamInfo (Maybe Text) Source #
The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video Streams uses to encrypt data on the stream.
streamInfo_deviceName :: Lens' StreamInfo (Maybe Text) Source #
The name of the device that is associated with the stream.
streamInfo_version :: Lens' StreamInfo (Maybe Text) Source #
The version of the stream.
streamInfo_streamName :: Lens' StreamInfo (Maybe Text) Source #
The name of the stream.
StreamNameCondition
data StreamNameCondition Source #
Specifies the condition that streams must satisfy to be returned when
you list streams (see the ListStreams API). A condition has a
comparison operation and a value. Currently, you can specify only the
BEGINS_WITH operator, which finds streams whose names start with a
given prefix.
See: newStreamNameCondition smart constructor.
Constructors
| StreamNameCondition' | |
Fields
| |
Instances
newStreamNameCondition :: StreamNameCondition Source #
Create a value of StreamNameCondition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:comparisonOperator:StreamNameCondition', streamNameCondition_comparisonOperator - A comparison operator. Currently, you can specify only the BEGINS_WITH
operator, which finds streams whose names start with a given prefix.
$sel:comparisonValue:StreamNameCondition', streamNameCondition_comparisonValue - A value to compare.
streamNameCondition_comparisonOperator :: Lens' StreamNameCondition (Maybe ComparisonOperator) Source #
A comparison operator. Currently, you can specify only the BEGINS_WITH
operator, which finds streams whose names start with a given prefix.
streamNameCondition_comparisonValue :: Lens' StreamNameCondition (Maybe Text) Source #
A value to compare.
Tag
A key and value pair that is associated with the specified signaling channel.
See: newTag smart constructor.
Constructors
| Tag' | |
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.KinesisVideo.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.KinesisVideo.Types.Tag | |
| ToJSON 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" "libZSservicesZSamazonka-kinesis-videoZSamazonka-kinesis-video" '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.