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 |
- Service Configuration
- Errors
- Waiters
- Operations
- RemoveFlowVpcInterface
- RemoveFlowMediaStream
- UpdateFlowOutput
- AddFlowOutputs
- StartFlow
- ListTagsForResource
- AddFlowSources
- DescribeReservation
- AddFlowMediaStreams
- RemoveFlowOutput
- RevokeFlowEntitlement
- CreateFlow
- RemoveFlowSource
- DescribeFlow
- UpdateFlowEntitlement
- StopFlow
- DescribeOffering
- AddFlowVpcInterfaces
- ListEntitlements (Paginated)
- TagResource
- ListFlows (Paginated)
- PurchaseOffering
- UpdateFlowMediaStream
- UntagResource
- UpdateFlow
- DeleteFlow
- UpdateFlowSource
- GrantFlowEntitlements
- ListReservations (Paginated)
- ListOfferings (Paginated)
- Types
- Algorithm
- Colorimetry
- DurationUnits
- EncoderProfile
- EncodingName
- EntitlementStatus
- FailoverMode
- KeyType
- MediaStreamType
- NetworkInterfaceType
- PriceUnits
- Protocol
- Range
- ReservationState
- ResourceType
- ScanMode
- SourceType
- State
- Status
- Tcs
- AddMediaStreamRequest
- AddOutputRequest
- DestinationConfiguration
- DestinationConfigurationRequest
- EncodingParameters
- EncodingParametersRequest
- Encryption
- Entitlement
- FailoverConfig
- Flow
- Fmtp
- FmtpRequest
- GrantEntitlementRequest
- InputConfiguration
- InputConfigurationRequest
- Interface
- InterfaceRequest
- ListedEntitlement
- ListedFlow
- MediaStream
- MediaStreamAttributes
- MediaStreamAttributesRequest
- MediaStreamOutputConfiguration
- MediaStreamOutputConfigurationRequest
- MediaStreamSourceConfiguration
- MediaStreamSourceConfigurationRequest
- Messages
- Offering
- Output
- Reservation
- ResourceSpecification
- SetSourceRequest
- Source
- SourcePriority
- Transport
- UpdateEncryption
- UpdateFailoverConfig
- VpcInterface
- VpcInterfaceAttachment
- VpcInterfaceRequest
Derived from API version 2018-11-14
of the AWS service descriptions, licensed under Apache 2.0.
API for AWS Elemental MediaConnect
Synopsis
- defaultService :: Service
- _GrantFlowEntitlements420Exception :: AsError a => Getting (First ServiceError) a ServiceError
- _ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _CreateFlow420Exception :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _AddFlowOutputs420Exception :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- newFlowStandby :: Wait DescribeFlow
- newFlowActive :: Wait DescribeFlow
- newFlowDeleted :: Wait DescribeFlow
- data RemoveFlowVpcInterface = RemoveFlowVpcInterface' Text Text
- newRemoveFlowVpcInterface :: Text -> Text -> RemoveFlowVpcInterface
- data RemoveFlowVpcInterfaceResponse = RemoveFlowVpcInterfaceResponse' (Maybe Text) (Maybe [Text]) (Maybe Text) Int
- newRemoveFlowVpcInterfaceResponse :: Int -> RemoveFlowVpcInterfaceResponse
- data RemoveFlowMediaStream = RemoveFlowMediaStream' Text Text
- newRemoveFlowMediaStream :: Text -> Text -> RemoveFlowMediaStream
- data RemoveFlowMediaStreamResponse = RemoveFlowMediaStreamResponse' (Maybe Text) (Maybe Text) Int
- newRemoveFlowMediaStreamResponse :: Int -> RemoveFlowMediaStreamResponse
- data UpdateFlowOutput = UpdateFlowOutput' (Maybe Text) (Maybe Int) (Maybe [MediaStreamOutputConfigurationRequest]) (Maybe Protocol) (Maybe UpdateEncryption) (Maybe [Text]) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe VpcInterfaceAttachment) Text Text
- newUpdateFlowOutput :: Text -> Text -> UpdateFlowOutput
- data UpdateFlowOutputResponse = UpdateFlowOutputResponse' (Maybe Text) (Maybe Output) Int
- newUpdateFlowOutputResponse :: Int -> UpdateFlowOutputResponse
- data AddFlowOutputs = AddFlowOutputs' Text [AddOutputRequest]
- newAddFlowOutputs :: Text -> AddFlowOutputs
- data AddFlowOutputsResponse = AddFlowOutputsResponse' (Maybe Text) (Maybe [Output]) Int
- newAddFlowOutputsResponse :: Int -> AddFlowOutputsResponse
- data StartFlow = StartFlow' Text
- newStartFlow :: Text -> StartFlow
- data StartFlowResponse = StartFlowResponse' (Maybe Status) (Maybe Text) Int
- newStartFlowResponse :: Int -> StartFlowResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data AddFlowSources = AddFlowSources' Text [SetSourceRequest]
- newAddFlowSources :: Text -> AddFlowSources
- data AddFlowSourcesResponse = AddFlowSourcesResponse' (Maybe Text) (Maybe [Source]) Int
- newAddFlowSourcesResponse :: Int -> AddFlowSourcesResponse
- data DescribeReservation = DescribeReservation' Text
- newDescribeReservation :: Text -> DescribeReservation
- data DescribeReservationResponse = DescribeReservationResponse' (Maybe Reservation) Int
- newDescribeReservationResponse :: Int -> DescribeReservationResponse
- data AddFlowMediaStreams = AddFlowMediaStreams' Text [AddMediaStreamRequest]
- newAddFlowMediaStreams :: Text -> AddFlowMediaStreams
- data AddFlowMediaStreamsResponse = AddFlowMediaStreamsResponse' (Maybe Text) (Maybe [MediaStream]) Int
- newAddFlowMediaStreamsResponse :: Int -> AddFlowMediaStreamsResponse
- data RemoveFlowOutput = RemoveFlowOutput' Text Text
- newRemoveFlowOutput :: Text -> Text -> RemoveFlowOutput
- data RemoveFlowOutputResponse = RemoveFlowOutputResponse' (Maybe Text) (Maybe Text) Int
- newRemoveFlowOutputResponse :: Int -> RemoveFlowOutputResponse
- data RevokeFlowEntitlement = RevokeFlowEntitlement' Text Text
- newRevokeFlowEntitlement :: Text -> Text -> RevokeFlowEntitlement
- data RevokeFlowEntitlementResponse = RevokeFlowEntitlementResponse' (Maybe Text) (Maybe Text) Int
- newRevokeFlowEntitlementResponse :: Int -> RevokeFlowEntitlementResponse
- data CreateFlow = CreateFlow' (Maybe [AddMediaStreamRequest]) (Maybe FailoverConfig) (Maybe [VpcInterfaceRequest]) (Maybe [SetSourceRequest]) (Maybe [AddOutputRequest]) (Maybe Text) (Maybe [GrantEntitlementRequest]) (Maybe SetSourceRequest) Text
- newCreateFlow :: Text -> CreateFlow
- data CreateFlowResponse = CreateFlowResponse' (Maybe Flow) Int
- newCreateFlowResponse :: Int -> CreateFlowResponse
- data RemoveFlowSource = RemoveFlowSource' Text Text
- newRemoveFlowSource :: Text -> Text -> RemoveFlowSource
- data RemoveFlowSourceResponse = RemoveFlowSourceResponse' (Maybe Text) (Maybe Text) Int
- newRemoveFlowSourceResponse :: Int -> RemoveFlowSourceResponse
- data DescribeFlow = DescribeFlow' Text
- newDescribeFlow :: Text -> DescribeFlow
- data DescribeFlowResponse = DescribeFlowResponse' (Maybe Flow) (Maybe Messages) Int
- newDescribeFlowResponse :: Int -> DescribeFlowResponse
- data UpdateFlowEntitlement = UpdateFlowEntitlement' (Maybe UpdateEncryption) (Maybe EntitlementStatus) (Maybe Text) (Maybe [Text]) Text Text
- newUpdateFlowEntitlement :: Text -> Text -> UpdateFlowEntitlement
- data UpdateFlowEntitlementResponse = UpdateFlowEntitlementResponse' (Maybe Text) (Maybe Entitlement) Int
- newUpdateFlowEntitlementResponse :: Int -> UpdateFlowEntitlementResponse
- data StopFlow = StopFlow' Text
- newStopFlow :: Text -> StopFlow
- data StopFlowResponse = StopFlowResponse' (Maybe Status) (Maybe Text) Int
- newStopFlowResponse :: Int -> StopFlowResponse
- data DescribeOffering = DescribeOffering' Text
- newDescribeOffering :: Text -> DescribeOffering
- data DescribeOfferingResponse = DescribeOfferingResponse' (Maybe Offering) Int
- newDescribeOfferingResponse :: Int -> DescribeOfferingResponse
- data AddFlowVpcInterfaces = AddFlowVpcInterfaces' Text [VpcInterfaceRequest]
- newAddFlowVpcInterfaces :: Text -> AddFlowVpcInterfaces
- data AddFlowVpcInterfacesResponse = AddFlowVpcInterfacesResponse' (Maybe Text) (Maybe [VpcInterface]) Int
- newAddFlowVpcInterfacesResponse :: Int -> AddFlowVpcInterfacesResponse
- data ListEntitlements = ListEntitlements' (Maybe Text) (Maybe Natural)
- newListEntitlements :: ListEntitlements
- data ListEntitlementsResponse = ListEntitlementsResponse' (Maybe Text) (Maybe [ListedEntitlement]) Int
- newListEntitlementsResponse :: Int -> ListEntitlementsResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data ListFlows = ListFlows' (Maybe Text) (Maybe Natural)
- newListFlows :: ListFlows
- data ListFlowsResponse = ListFlowsResponse' (Maybe Text) (Maybe [ListedFlow]) Int
- newListFlowsResponse :: Int -> ListFlowsResponse
- data PurchaseOffering = PurchaseOffering' Text Text Text
- newPurchaseOffering :: Text -> Text -> Text -> PurchaseOffering
- data PurchaseOfferingResponse = PurchaseOfferingResponse' (Maybe Reservation) Int
- newPurchaseOfferingResponse :: Int -> PurchaseOfferingResponse
- data UpdateFlowMediaStream = UpdateFlowMediaStream' (Maybe Text) (Maybe MediaStreamType) (Maybe MediaStreamAttributesRequest) (Maybe Int) (Maybe Text) Text Text
- newUpdateFlowMediaStream :: Text -> Text -> UpdateFlowMediaStream
- data UpdateFlowMediaStreamResponse = UpdateFlowMediaStreamResponse' (Maybe Text) (Maybe MediaStream) Int
- newUpdateFlowMediaStreamResponse :: Int -> UpdateFlowMediaStreamResponse
- data UntagResource = UntagResource' [Text] Text
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data UpdateFlow = UpdateFlow' (Maybe UpdateFailoverConfig) Text
- newUpdateFlow :: Text -> UpdateFlow
- data UpdateFlowResponse = UpdateFlowResponse' (Maybe Flow) Int
- newUpdateFlowResponse :: Int -> UpdateFlowResponse
- data DeleteFlow = DeleteFlow' Text
- newDeleteFlow :: Text -> DeleteFlow
- data DeleteFlowResponse = DeleteFlowResponse' (Maybe Status) (Maybe Text) Int
- newDeleteFlowResponse :: Int -> DeleteFlowResponse
- data UpdateFlowSource = UpdateFlowSource' (Maybe Text) (Maybe Int) (Maybe Text) (Maybe UpdateEncryption) (Maybe Int) (Maybe Protocol) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe [MediaStreamSourceConfigurationRequest]) (Maybe Text) (Maybe Int) (Maybe Text) Text Text
- newUpdateFlowSource :: Text -> Text -> UpdateFlowSource
- data UpdateFlowSourceResponse = UpdateFlowSourceResponse' (Maybe Text) (Maybe Source) Int
- newUpdateFlowSourceResponse :: Int -> UpdateFlowSourceResponse
- data GrantFlowEntitlements = GrantFlowEntitlements' Text [GrantEntitlementRequest]
- newGrantFlowEntitlements :: Text -> GrantFlowEntitlements
- data GrantFlowEntitlementsResponse = GrantFlowEntitlementsResponse' (Maybe Text) (Maybe [Entitlement]) Int
- newGrantFlowEntitlementsResponse :: Int -> GrantFlowEntitlementsResponse
- data ListReservations = ListReservations' (Maybe Text) (Maybe Natural)
- newListReservations :: ListReservations
- data ListReservationsResponse = ListReservationsResponse' (Maybe Text) (Maybe [Reservation]) Int
- newListReservationsResponse :: Int -> ListReservationsResponse
- data ListOfferings = ListOfferings' (Maybe Text) (Maybe Natural)
- newListOfferings :: ListOfferings
- data ListOfferingsResponse = ListOfferingsResponse' (Maybe Text) (Maybe [Offering]) Int
- newListOfferingsResponse :: Int -> ListOfferingsResponse
- newtype Algorithm where
- Algorithm' { }
- pattern Algorithm_Aes128 :: Algorithm
- pattern Algorithm_Aes192 :: Algorithm
- pattern Algorithm_Aes256 :: Algorithm
- newtype Colorimetry where
- Colorimetry' { }
- pattern Colorimetry_BT2020 :: Colorimetry
- pattern Colorimetry_BT2100 :: Colorimetry
- pattern Colorimetry_BT601 :: Colorimetry
- pattern Colorimetry_BT709 :: Colorimetry
- pattern Colorimetry_ST2065_1 :: Colorimetry
- pattern Colorimetry_ST2065_3 :: Colorimetry
- pattern Colorimetry_XYZ :: Colorimetry
- newtype DurationUnits where
- DurationUnits' { }
- pattern DurationUnits_MONTHS :: DurationUnits
- newtype EncoderProfile where
- EncoderProfile' { }
- pattern EncoderProfile_High :: EncoderProfile
- pattern EncoderProfile_Main :: EncoderProfile
- newtype EncodingName where
- EncodingName' { }
- pattern EncodingName_Jxsv :: EncodingName
- pattern EncodingName_Pcm :: EncodingName
- pattern EncodingName_Raw :: EncodingName
- pattern EncodingName_Smpte291 :: EncodingName
- newtype EntitlementStatus where
- EntitlementStatus' { }
- pattern EntitlementStatus_DISABLED :: EntitlementStatus
- pattern EntitlementStatus_ENABLED :: EntitlementStatus
- newtype FailoverMode where
- FailoverMode' { }
- pattern FailoverMode_FAILOVER :: FailoverMode
- pattern FailoverMode_MERGE :: FailoverMode
- newtype KeyType where
- KeyType' {
- fromKeyType :: Text
- pattern KeyType_Speke :: KeyType
- pattern KeyType_Srt_password :: KeyType
- pattern KeyType_Static_key :: KeyType
- KeyType' {
- newtype MediaStreamType where
- MediaStreamType' { }
- pattern MediaStreamType_Ancillary_data :: MediaStreamType
- pattern MediaStreamType_Audio :: MediaStreamType
- pattern MediaStreamType_Video :: MediaStreamType
- newtype NetworkInterfaceType where
- newtype PriceUnits where
- PriceUnits' { }
- pattern PriceUnits_HOURLY :: PriceUnits
- newtype Protocol where
- Protocol' {
- fromProtocol :: Text
- pattern Protocol_Cdi :: Protocol
- pattern Protocol_Rist :: Protocol
- pattern Protocol_Rtp :: Protocol
- pattern Protocol_Rtp_fec :: Protocol
- pattern Protocol_Srt_listener :: Protocol
- pattern Protocol_St2110_jpegxs :: Protocol
- pattern Protocol_Zixi_pull :: Protocol
- pattern Protocol_Zixi_push :: Protocol
- Protocol' {
- newtype Range where
- Range' { }
- pattern Range_FULL :: Range
- pattern Range_FULLPROTECT :: Range
- pattern Range_NARROW :: Range
- newtype ReservationState where
- ReservationState' { }
- pattern ReservationState_ACTIVE :: ReservationState
- pattern ReservationState_CANCELED :: ReservationState
- pattern ReservationState_EXPIRED :: ReservationState
- pattern ReservationState_PROCESSING :: ReservationState
- newtype ResourceType where
- ResourceType' { }
- pattern ResourceType_Mbps_Outbound_Bandwidth :: ResourceType
- newtype ScanMode where
- ScanMode' {
- fromScanMode :: Text
- pattern ScanMode_Interlace :: ScanMode
- pattern ScanMode_Progressive :: ScanMode
- pattern ScanMode_Progressive_segmented_frame :: ScanMode
- ScanMode' {
- newtype SourceType where
- SourceType' { }
- pattern SourceType_ENTITLED :: SourceType
- pattern SourceType_OWNED :: SourceType
- newtype State where
- State' { }
- pattern State_DISABLED :: State
- pattern State_ENABLED :: State
- newtype Status where
- Status' {
- fromStatus :: Text
- pattern Status_ACTIVE :: Status
- pattern Status_DELETING :: Status
- pattern Status_ERROR :: Status
- pattern Status_STANDBY :: Status
- pattern Status_STARTING :: Status
- pattern Status_STOPPING :: Status
- pattern Status_UPDATING :: Status
- Status' {
- newtype Tcs where
- Tcs' { }
- pattern Tcs_BT2100LINHLG :: Tcs
- pattern Tcs_BT2100LINPQ :: Tcs
- pattern Tcs_DENSITY :: Tcs
- pattern Tcs_HLG :: Tcs
- pattern Tcs_LINEAR :: Tcs
- pattern Tcs_PQ :: Tcs
- pattern Tcs_SDR :: Tcs
- pattern Tcs_ST2065_1 :: Tcs
- pattern Tcs_ST428_1 :: Tcs
- data AddMediaStreamRequest = AddMediaStreamRequest' (Maybe Text) (Maybe MediaStreamAttributesRequest) (Maybe Int) (Maybe Text) MediaStreamType Int Text
- newAddMediaStreamRequest :: MediaStreamType -> Int -> Text -> AddMediaStreamRequest
- data AddOutputRequest = AddOutputRequest' (Maybe Text) (Maybe Int) (Maybe [MediaStreamOutputConfigurationRequest]) (Maybe Encryption) (Maybe Text) (Maybe [Text]) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe VpcInterfaceAttachment) Protocol
- newAddOutputRequest :: Protocol -> AddOutputRequest
- data DestinationConfiguration = DestinationConfiguration' Text Int Interface Text
- newDestinationConfiguration :: Text -> Int -> Interface -> Text -> DestinationConfiguration
- data DestinationConfigurationRequest = DestinationConfigurationRequest' Text Int InterfaceRequest
- newDestinationConfigurationRequest :: Text -> Int -> InterfaceRequest -> DestinationConfigurationRequest
- data EncodingParameters = EncodingParameters' EncoderProfile Double
- newEncodingParameters :: EncoderProfile -> Double -> EncodingParameters
- data EncodingParametersRequest = EncodingParametersRequest' EncoderProfile Double
- newEncodingParametersRequest :: EncoderProfile -> Double -> EncodingParametersRequest
- data Encryption = Encryption' (Maybe KeyType) (Maybe Text) (Maybe Text) (Maybe Algorithm) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newEncryption :: Text -> Encryption
- data Entitlement = Entitlement' (Maybe Int) (Maybe Encryption) (Maybe EntitlementStatus) (Maybe Text) Text [Text] Text
- newEntitlement :: Text -> Text -> Entitlement
- data FailoverConfig = FailoverConfig' (Maybe State) (Maybe Int) (Maybe SourcePriority) (Maybe FailoverMode)
- newFailoverConfig :: FailoverConfig
- data Flow = Flow' (Maybe [MediaStream]) (Maybe FailoverConfig) (Maybe [VpcInterface]) (Maybe [Source]) (Maybe Text) (Maybe Text) Status [Entitlement] [Output] Text Text Source Text
- newFlow :: Status -> Text -> Text -> Source -> Text -> Flow
- data Fmtp = Fmtp' (Maybe Tcs) (Maybe Text) (Maybe Text) (Maybe ScanMode) (Maybe Range) (Maybe Text) (Maybe Colorimetry)
- newFmtp :: Fmtp
- data FmtpRequest = FmtpRequest' (Maybe Tcs) (Maybe Text) (Maybe Text) (Maybe ScanMode) (Maybe Range) (Maybe Text) (Maybe Colorimetry)
- newFmtpRequest :: FmtpRequest
- data GrantEntitlementRequest = GrantEntitlementRequest' (Maybe Int) (Maybe Encryption) (Maybe Text) (Maybe EntitlementStatus) (Maybe Text) [Text]
- newGrantEntitlementRequest :: GrantEntitlementRequest
- data InputConfiguration = InputConfiguration' Int Text Interface
- newInputConfiguration :: Int -> Text -> Interface -> InputConfiguration
- data InputConfigurationRequest = InputConfigurationRequest' Int InterfaceRequest
- newInputConfigurationRequest :: Int -> InterfaceRequest -> InputConfigurationRequest
- data Interface = Interface' Text
- newInterface :: Text -> Interface
- data InterfaceRequest = InterfaceRequest' Text
- newInterfaceRequest :: Text -> InterfaceRequest
- data ListedEntitlement = ListedEntitlement' (Maybe Int) Text Text
- newListedEntitlement :: Text -> Text -> ListedEntitlement
- data ListedFlow = ListedFlow' Status Text SourceType Text Text Text
- newListedFlow :: Status -> Text -> SourceType -> Text -> Text -> Text -> ListedFlow
- data MediaStream = MediaStream' (Maybe Text) (Maybe MediaStreamAttributes) (Maybe Int) (Maybe Text) MediaStreamType Int Text Int
- newMediaStream :: MediaStreamType -> Int -> Text -> Int -> MediaStream
- data MediaStreamAttributes = MediaStreamAttributes' (Maybe Text) Fmtp
- newMediaStreamAttributes :: Fmtp -> MediaStreamAttributes
- data MediaStreamAttributesRequest = MediaStreamAttributesRequest' (Maybe Text) (Maybe FmtpRequest)
- newMediaStreamAttributesRequest :: MediaStreamAttributesRequest
- data MediaStreamOutputConfiguration = MediaStreamOutputConfiguration' (Maybe [DestinationConfiguration]) (Maybe EncodingParameters) Text EncodingName
- newMediaStreamOutputConfiguration :: Text -> EncodingName -> MediaStreamOutputConfiguration
- data MediaStreamOutputConfigurationRequest = MediaStreamOutputConfigurationRequest' (Maybe [DestinationConfigurationRequest]) (Maybe EncodingParametersRequest) Text EncodingName
- newMediaStreamOutputConfigurationRequest :: Text -> EncodingName -> MediaStreamOutputConfigurationRequest
- data MediaStreamSourceConfiguration = MediaStreamSourceConfiguration' (Maybe [InputConfiguration]) Text EncodingName
- newMediaStreamSourceConfiguration :: Text -> EncodingName -> MediaStreamSourceConfiguration
- data MediaStreamSourceConfigurationRequest = MediaStreamSourceConfigurationRequest' (Maybe [InputConfigurationRequest]) Text EncodingName
- newMediaStreamSourceConfigurationRequest :: Text -> EncodingName -> MediaStreamSourceConfigurationRequest
- data Messages = Messages' [Text]
- newMessages :: Messages
- data Offering = Offering' Text Text Text DurationUnits Int Text ResourceSpecification PriceUnits
- newOffering :: Text -> Text -> Text -> DurationUnits -> Int -> Text -> ResourceSpecification -> PriceUnits -> Offering
- data Output = Output' (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [MediaStreamOutputConfiguration]) (Maybe Text) (Maybe Encryption) (Maybe Text) (Maybe Transport) (Maybe Text) (Maybe Int) (Maybe VpcInterfaceAttachment) Text Text
- newOutput :: Text -> Text -> Output
- data Reservation = Reservation' Text ReservationState Text Text Text Text Text Text Int DurationUnits Text ResourceSpecification PriceUnits
- newReservation :: Text -> ReservationState -> Text -> Text -> Text -> Text -> Text -> Text -> Int -> DurationUnits -> Text -> ResourceSpecification -> PriceUnits -> Reservation
- data ResourceSpecification = ResourceSpecification' (Maybe Int) ResourceType
- newResourceSpecification :: ResourceType -> ResourceSpecification
- data SetSourceRequest = SetSourceRequest' (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Encryption) (Maybe Int) (Maybe Protocol) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe [MediaStreamSourceConfigurationRequest]) (Maybe Text) (Maybe Int) (Maybe Text)
- newSetSourceRequest :: SetSourceRequest
- data Source = Source' (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Encryption) (Maybe Text) (Maybe Int) (Maybe Transport) (Maybe Text) (Maybe [MediaStreamSourceConfiguration]) (Maybe Text) Text Text
- newSource :: Text -> Text -> Source
- data SourcePriority = SourcePriority' (Maybe Text)
- newSourcePriority :: SourcePriority
- data Transport = Transport' (Maybe Int) (Maybe Int) (Maybe [Text]) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) Protocol
- newTransport :: Protocol -> Transport
- data UpdateEncryption = UpdateEncryption' (Maybe KeyType) (Maybe Text) (Maybe Text) (Maybe Algorithm) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newUpdateEncryption :: UpdateEncryption
- data UpdateFailoverConfig = UpdateFailoverConfig' (Maybe State) (Maybe Int) (Maybe SourcePriority) (Maybe FailoverMode)
- newUpdateFailoverConfig :: UpdateFailoverConfig
- data VpcInterface = VpcInterface' NetworkInterfaceType [Text] Text [Text] Text Text
- newVpcInterface :: NetworkInterfaceType -> Text -> Text -> Text -> VpcInterface
- data VpcInterfaceAttachment = VpcInterfaceAttachment' (Maybe Text)
- newVpcInterfaceAttachment :: VpcInterfaceAttachment
- data VpcInterfaceRequest = VpcInterfaceRequest' (Maybe NetworkInterfaceType) Text [Text] Text Text
- newVpcInterfaceRequest :: Text -> Text -> Text -> VpcInterfaceRequest
Service Configuration
defaultService :: Service Source #
API version 2018-11-14
of the Amazon MediaConnect 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 MediaConnect
.
GrantFlowEntitlements420Exception
_GrantFlowEntitlements420Exception :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
ForbiddenException
_ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
NotFoundException
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
CreateFlow420Exception
_CreateFlow420Exception :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
InternalServerErrorException
_InternalServerErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
AddFlowOutputs420Exception
_AddFlowOutputs420Exception :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
BadRequestException
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
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.
FlowStandby
newFlowStandby :: Wait DescribeFlow Source #
Polls DescribeFlow
every 3 seconds until a successful state is reached. An error is returned after 40 failed checks.
FlowActive
newFlowActive :: Wait DescribeFlow Source #
Polls DescribeFlow
every 3 seconds until a successful state is reached. An error is returned after 40 failed checks.
FlowDeleted
newFlowDeleted :: Wait DescribeFlow Source #
Polls DescribeFlow
every 3 seconds until a successful state is reached. An error is returned after 40 failed checks.
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.
RemoveFlowVpcInterface
data RemoveFlowVpcInterface Source #
See: newRemoveFlowVpcInterface
smart constructor.
Instances
newRemoveFlowVpcInterface Source #
:: Text | |
-> Text | |
-> RemoveFlowVpcInterface |
Create a value of RemoveFlowVpcInterface
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:flowArn:RemoveFlowVpcInterface'
, removeFlowVpcInterface_flowArn
- The flow that you want to remove a VPC interface from.
$sel:vpcInterfaceName:RemoveFlowVpcInterface'
, removeFlowVpcInterface_vpcInterfaceName
- The name of the VPC interface that you want to remove.
data RemoveFlowVpcInterfaceResponse Source #
See: newRemoveFlowVpcInterfaceResponse
smart constructor.
Instances
newRemoveFlowVpcInterfaceResponse Source #
Create a value of RemoveFlowVpcInterfaceResponse
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:flowArn:RemoveFlowVpcInterface'
, removeFlowVpcInterfaceResponse_flowArn
- The ARN of the flow that is associated with the VPC interface you
removed.
$sel:nonDeletedNetworkInterfaceIds:RemoveFlowVpcInterfaceResponse'
, removeFlowVpcInterfaceResponse_nonDeletedNetworkInterfaceIds
- IDs of network interfaces associated with the removed VPC interface that
Media Connect was unable to remove.
$sel:vpcInterfaceName:RemoveFlowVpcInterface'
, removeFlowVpcInterfaceResponse_vpcInterfaceName
- The name of the VPC interface that was removed.
$sel:httpStatus:RemoveFlowVpcInterfaceResponse'
, removeFlowVpcInterfaceResponse_httpStatus
- The response's http status code.
RemoveFlowMediaStream
data RemoveFlowMediaStream Source #
See: newRemoveFlowMediaStream
smart constructor.
Instances
newRemoveFlowMediaStream Source #
:: Text | |
-> Text | |
-> RemoveFlowMediaStream |
Create a value of RemoveFlowMediaStream
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:flowArn:RemoveFlowMediaStream'
, removeFlowMediaStream_flowArn
- The Amazon Resource Name (ARN) of the flow.
$sel:mediaStreamName:RemoveFlowMediaStream'
, removeFlowMediaStream_mediaStreamName
- The name of the media stream that you want to remove.
data RemoveFlowMediaStreamResponse Source #
See: newRemoveFlowMediaStreamResponse
smart constructor.
Instances
newRemoveFlowMediaStreamResponse Source #
Create a value of RemoveFlowMediaStreamResponse
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:mediaStreamName:RemoveFlowMediaStream'
, removeFlowMediaStreamResponse_mediaStreamName
- The name of the media stream that was removed.
$sel:flowArn:RemoveFlowMediaStream'
, removeFlowMediaStreamResponse_flowArn
- The Amazon Resource Name (ARN) of the flow.
$sel:httpStatus:RemoveFlowMediaStreamResponse'
, removeFlowMediaStreamResponse_httpStatus
- The response's http status code.
UpdateFlowOutput
data UpdateFlowOutput Source #
The fields that you want to update in the output.
See: newUpdateFlowOutput
smart constructor.
UpdateFlowOutput' (Maybe Text) (Maybe Int) (Maybe [MediaStreamOutputConfigurationRequest]) (Maybe Protocol) (Maybe UpdateEncryption) (Maybe [Text]) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe VpcInterfaceAttachment) Text Text |
Instances
Create a value of UpdateFlowOutput
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:destination:UpdateFlowOutput'
, updateFlowOutput_destination
- The IP address where you want to send the output.
$sel:maxLatency:UpdateFlowOutput'
, updateFlowOutput_maxLatency
- The maximum latency in milliseconds for Zixi-based streams.
$sel:mediaStreamOutputConfigurations:UpdateFlowOutput'
, updateFlowOutput_mediaStreamOutputConfigurations
- The media streams that are associated with the output, and the
parameters for those associations.
$sel:protocol:UpdateFlowOutput'
, updateFlowOutput_protocol
- The protocol to use for the output.
$sel:encryption:UpdateFlowOutput'
, updateFlowOutput_encryption
- The type of key used for the encryption. If no keyType is provided, the
service will use the default setting (static-key).
$sel:cidrAllowList:UpdateFlowOutput'
, updateFlowOutput_cidrAllowList
- The range of IP addresses that should be allowed to initiate output
requests to this flow. These IP addresses should be in the form of a
Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
$sel:smoothingLatency:UpdateFlowOutput'
, updateFlowOutput_smoothingLatency
- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC
streams.
$sel:minLatency:UpdateFlowOutput'
, updateFlowOutput_minLatency
- The minimum latency in milliseconds for SRT-based streams. In streams
that use the SRT protocol, this value that you set on your MediaConnect
source or output represents the minimal potential latency of that
connection. The latency of the stream is set to the highest number
between the sender’s minimum latency and the receiver’s minimum latency.
$sel:description:UpdateFlowOutput'
, updateFlowOutput_description
- A description of the output. This description appears only on the AWS
Elemental MediaConnect console and will not be seen by the end user.
$sel:port:UpdateFlowOutput'
, updateFlowOutput_port
- The port to use when content is distributed to this output.
$sel:streamId:UpdateFlowOutput'
, updateFlowOutput_streamId
- The stream ID that you want to use for this transport. This parameter
applies only to Zixi-based streams.
$sel:remoteId:UpdateFlowOutput'
, updateFlowOutput_remoteId
- The remote ID for the Zixi-pull stream.
$sel:vpcInterfaceAttachment:UpdateFlowOutput'
, updateFlowOutput_vpcInterfaceAttachment
- The name of the VPC interface attachment to use for this output.
$sel:flowArn:UpdateFlowOutput'
, updateFlowOutput_flowArn
- The flow that is associated with the output that you want to update.
$sel:outputArn:UpdateFlowOutput'
, updateFlowOutput_outputArn
- The ARN of the output that you want to update.
data UpdateFlowOutputResponse Source #
See: newUpdateFlowOutputResponse
smart constructor.
Instances
newUpdateFlowOutputResponse Source #
Create a value of UpdateFlowOutputResponse
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:flowArn:UpdateFlowOutput'
, updateFlowOutputResponse_flowArn
- The ARN of the flow that is associated with the updated output.
$sel:output:UpdateFlowOutputResponse'
, updateFlowOutputResponse_output
- The new settings of the output that you updated.
$sel:httpStatus:UpdateFlowOutputResponse'
, updateFlowOutputResponse_httpStatus
- The response's http status code.
AddFlowOutputs
data AddFlowOutputs Source #
A request to add outputs to the specified flow.
See: newAddFlowOutputs
smart constructor.
Instances
Create a value of AddFlowOutputs
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:flowArn:AddFlowOutputs'
, addFlowOutputs_flowArn
- The flow that you want to add outputs to.
$sel:outputs:AddFlowOutputs'
, addFlowOutputs_outputs
- A list of outputs that you want to add.
data AddFlowOutputsResponse Source #
See: newAddFlowOutputsResponse
smart constructor.
Instances
newAddFlowOutputsResponse Source #
Create a value of AddFlowOutputsResponse
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:flowArn:AddFlowOutputs'
, addFlowOutputsResponse_flowArn
- The ARN of the flow that these outputs were added to.
$sel:outputs:AddFlowOutputs'
, addFlowOutputsResponse_outputs
- The details of the newly added outputs.
$sel:httpStatus:AddFlowOutputsResponse'
, addFlowOutputsResponse_httpStatus
- The response's http status code.
StartFlow
See: newStartFlow
smart constructor.
Instances
Create a value of StartFlow
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:flowArn:StartFlow'
, startFlow_flowArn
- The ARN of the flow that you want to start.
data StartFlowResponse Source #
See: newStartFlowResponse
smart constructor.
Instances
Create a value of StartFlowResponse
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:StartFlowResponse'
, startFlowResponse_status
- The status of the flow when the StartFlow process begins.
$sel:flowArn:StartFlow'
, startFlowResponse_flowArn
- The ARN of the flow that you started.
$sel:httpStatus:StartFlowResponse'
, startFlowResponse_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:
$sel:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The Amazon Resource Name (ARN) that identifies the AWS Elemental
MediaConnect resource for which to list the 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:
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- A map from tag keys to values. Tag keys can have a maximum character
length of 128 characters, and tag values can have a maximum length of
256 characters.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
AddFlowSources
data AddFlowSources Source #
A request to add sources to the flow.
See: newAddFlowSources
smart constructor.
Instances
Create a value of AddFlowSources
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:flowArn:AddFlowSources'
, addFlowSources_flowArn
- The flow that you want to mutate.
$sel:sources:AddFlowSources'
, addFlowSources_sources
- A list of sources that you want to add.
data AddFlowSourcesResponse Source #
See: newAddFlowSourcesResponse
smart constructor.
Instances
newAddFlowSourcesResponse Source #
Create a value of AddFlowSourcesResponse
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:flowArn:AddFlowSources'
, addFlowSourcesResponse_flowArn
- The ARN of the flow that these sources were added to.
$sel:sources:AddFlowSources'
, addFlowSourcesResponse_sources
- The details of the newly added sources.
$sel:httpStatus:AddFlowSourcesResponse'
, addFlowSourcesResponse_httpStatus
- The response's http status code.
DescribeReservation
data DescribeReservation Source #
See: newDescribeReservation
smart constructor.
Instances
newDescribeReservation Source #
Create a value of DescribeReservation
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:reservationArn:DescribeReservation'
, describeReservation_reservationArn
- The Amazon Resource Name (ARN) of the reservation.
data DescribeReservationResponse Source #
See: newDescribeReservationResponse
smart constructor.
Instances
newDescribeReservationResponse Source #
Create a value of DescribeReservationResponse
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:reservation:DescribeReservationResponse'
, describeReservationResponse_reservation
- Undocumented member.
$sel:httpStatus:DescribeReservationResponse'
, describeReservationResponse_httpStatus
- The response's http status code.
AddFlowMediaStreams
data AddFlowMediaStreams Source #
A request to add media streams to the flow.
See: newAddFlowMediaStreams
smart constructor.
Instances
newAddFlowMediaStreams Source #
Create a value of AddFlowMediaStreams
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:flowArn:AddFlowMediaStreams'
, addFlowMediaStreams_flowArn
- The Amazon Resource Name (ARN) of the flow.
$sel:mediaStreams:AddFlowMediaStreams'
, addFlowMediaStreams_mediaStreams
- The media streams that you want to add to the flow.
data AddFlowMediaStreamsResponse Source #
See: newAddFlowMediaStreamsResponse
smart constructor.
Instances
newAddFlowMediaStreamsResponse Source #
Create a value of AddFlowMediaStreamsResponse
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:flowArn:AddFlowMediaStreams'
, addFlowMediaStreamsResponse_flowArn
- The ARN of the flow that you added media streams to.
$sel:mediaStreams:AddFlowMediaStreams'
, addFlowMediaStreamsResponse_mediaStreams
- The media streams that you added to the flow.
$sel:httpStatus:AddFlowMediaStreamsResponse'
, addFlowMediaStreamsResponse_httpStatus
- The response's http status code.
RemoveFlowOutput
data RemoveFlowOutput Source #
See: newRemoveFlowOutput
smart constructor.
Instances
Create a value of RemoveFlowOutput
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:flowArn:RemoveFlowOutput'
, removeFlowOutput_flowArn
- The flow that you want to remove an output from.
$sel:outputArn:RemoveFlowOutput'
, removeFlowOutput_outputArn
- The ARN of the output that you want to remove.
data RemoveFlowOutputResponse Source #
See: newRemoveFlowOutputResponse
smart constructor.
Instances
newRemoveFlowOutputResponse Source #
Create a value of RemoveFlowOutputResponse
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:flowArn:RemoveFlowOutput'
, removeFlowOutputResponse_flowArn
- The ARN of the flow that is associated with the output you removed.
$sel:outputArn:RemoveFlowOutput'
, removeFlowOutputResponse_outputArn
- The ARN of the output that was removed.
$sel:httpStatus:RemoveFlowOutputResponse'
, removeFlowOutputResponse_httpStatus
- The response's http status code.
RevokeFlowEntitlement
data RevokeFlowEntitlement Source #
See: newRevokeFlowEntitlement
smart constructor.
Instances
newRevokeFlowEntitlement Source #
:: Text | |
-> Text | |
-> RevokeFlowEntitlement |
Create a value of RevokeFlowEntitlement
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:flowArn:RevokeFlowEntitlement'
, revokeFlowEntitlement_flowArn
- The flow that you want to revoke an entitlement from.
$sel:entitlementArn:RevokeFlowEntitlement'
, revokeFlowEntitlement_entitlementArn
- The ARN of the entitlement that you want to revoke.
data RevokeFlowEntitlementResponse Source #
See: newRevokeFlowEntitlementResponse
smart constructor.
Instances
newRevokeFlowEntitlementResponse Source #
Create a value of RevokeFlowEntitlementResponse
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:entitlementArn:RevokeFlowEntitlement'
, revokeFlowEntitlementResponse_entitlementArn
- The ARN of the entitlement that was revoked.
$sel:flowArn:RevokeFlowEntitlement'
, revokeFlowEntitlementResponse_flowArn
- The ARN of the flow that the entitlement was revoked from.
$sel:httpStatus:RevokeFlowEntitlementResponse'
, revokeFlowEntitlementResponse_httpStatus
- The response's http status code.
CreateFlow
data CreateFlow Source #
Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).
See: newCreateFlow
smart constructor.
Instances
Create a value of CreateFlow
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:mediaStreams:CreateFlow'
, createFlow_mediaStreams
- The media streams that you want to add to the flow. You can associate
these media streams with sources and outputs on the flow.
$sel:sourceFailoverConfig:CreateFlow'
, createFlow_sourceFailoverConfig
- Undocumented member.
$sel:vpcInterfaces:CreateFlow'
, createFlow_vpcInterfaces
- The VPC interfaces you want on the flow.
$sel:sources:CreateFlow'
, createFlow_sources
- Undocumented member.
$sel:outputs:CreateFlow'
, createFlow_outputs
- The outputs that you want to add to this flow.
$sel:availabilityZone:CreateFlow'
, createFlow_availabilityZone
- The Availability Zone that you want to create the flow in. These options
are limited to the Availability Zones within the current AWS Region.
$sel:entitlements:CreateFlow'
, createFlow_entitlements
- The entitlements that you want to grant on a flow.
$sel:source:CreateFlow'
, createFlow_source
- Undocumented member.
$sel:name:CreateFlow'
, createFlow_name
- The name of the flow.
data CreateFlowResponse Source #
See: newCreateFlowResponse
smart constructor.
Instances
newCreateFlowResponse Source #
Create a value of CreateFlowResponse
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:flow:CreateFlowResponse'
, createFlowResponse_flow
- Undocumented member.
$sel:httpStatus:CreateFlowResponse'
, createFlowResponse_httpStatus
- The response's http status code.
RemoveFlowSource
data RemoveFlowSource Source #
See: newRemoveFlowSource
smart constructor.
Instances
Create a value of RemoveFlowSource
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:flowArn:RemoveFlowSource'
, removeFlowSource_flowArn
- The flow that you want to remove a source from.
$sel:sourceArn:RemoveFlowSource'
, removeFlowSource_sourceArn
- The ARN of the source that you want to remove.
data RemoveFlowSourceResponse Source #
See: newRemoveFlowSourceResponse
smart constructor.
Instances
newRemoveFlowSourceResponse Source #
Create a value of RemoveFlowSourceResponse
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:flowArn:RemoveFlowSource'
, removeFlowSourceResponse_flowArn
- The ARN of the flow that is associated with the source you removed.
$sel:sourceArn:RemoveFlowSource'
, removeFlowSourceResponse_sourceArn
- The ARN of the source that was removed.
$sel:httpStatus:RemoveFlowSourceResponse'
, removeFlowSourceResponse_httpStatus
- The response's http status code.
DescribeFlow
data DescribeFlow Source #
See: newDescribeFlow
smart constructor.
Instances
Create a value of DescribeFlow
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:flowArn:DescribeFlow'
, describeFlow_flowArn
- The ARN of the flow that you want to describe.
data DescribeFlowResponse Source #
See: newDescribeFlowResponse
smart constructor.
Instances
newDescribeFlowResponse Source #
Create a value of DescribeFlowResponse
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:flow:DescribeFlowResponse'
, describeFlowResponse_flow
- Undocumented member.
$sel:messages:DescribeFlowResponse'
, describeFlowResponse_messages
- Undocumented member.
$sel:httpStatus:DescribeFlowResponse'
, describeFlowResponse_httpStatus
- The response's http status code.
UpdateFlowEntitlement
data UpdateFlowEntitlement Source #
The entitlement fields that you want to update.
See: newUpdateFlowEntitlement
smart constructor.
UpdateFlowEntitlement' (Maybe UpdateEncryption) (Maybe EntitlementStatus) (Maybe Text) (Maybe [Text]) Text Text |
Instances
newUpdateFlowEntitlement Source #
:: Text | |
-> Text | |
-> UpdateFlowEntitlement |
Create a value of UpdateFlowEntitlement
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:encryption:UpdateFlowEntitlement'
, updateFlowEntitlement_encryption
- The type of encryption that will be used on the output associated with
this entitlement.
$sel:entitlementStatus:UpdateFlowEntitlement'
, updateFlowEntitlement_entitlementStatus
- An indication of whether you want to enable the entitlement to allow
access, or disable it to stop streaming content to the subscriber’s flow
temporarily. If you don’t specify the entitlementStatus field in your
request, MediaConnect leaves the value unchanged.
$sel:description:UpdateFlowEntitlement'
, updateFlowEntitlement_description
- A description of the entitlement. This description appears only on the
AWS Elemental MediaConnect console and will not be seen by the
subscriber or end user.
$sel:subscribers:UpdateFlowEntitlement'
, updateFlowEntitlement_subscribers
- The AWS account IDs that you want to share your content with. The
receiving accounts (subscribers) will be allowed to create their own
flow using your content as the source.
$sel:flowArn:UpdateFlowEntitlement'
, updateFlowEntitlement_flowArn
- The flow that is associated with the entitlement that you want to
update.
$sel:entitlementArn:UpdateFlowEntitlement'
, updateFlowEntitlement_entitlementArn
- The ARN of the entitlement that you want to update.
data UpdateFlowEntitlementResponse Source #
See: newUpdateFlowEntitlementResponse
smart constructor.
Instances
newUpdateFlowEntitlementResponse Source #
Create a value of UpdateFlowEntitlementResponse
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:flowArn:UpdateFlowEntitlement'
, updateFlowEntitlementResponse_flowArn
- The ARN of the flow that this entitlement was granted on.
$sel:entitlement:UpdateFlowEntitlementResponse'
, updateFlowEntitlementResponse_entitlement
- The new configuration of the entitlement that you updated.
$sel:httpStatus:UpdateFlowEntitlementResponse'
, updateFlowEntitlementResponse_httpStatus
- The response's http status code.
StopFlow
See: newStopFlow
smart constructor.
Instances
Create a value of StopFlow
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:flowArn:StopFlow'
, stopFlow_flowArn
- The ARN of the flow that you want to stop.
data StopFlowResponse Source #
See: newStopFlowResponse
smart constructor.
Instances
Create a value of StopFlowResponse
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:StopFlowResponse'
, stopFlowResponse_status
- The status of the flow when the StopFlow process begins.
$sel:flowArn:StopFlow'
, stopFlowResponse_flowArn
- The ARN of the flow that you stopped.
$sel:httpStatus:StopFlowResponse'
, stopFlowResponse_httpStatus
- The response's http status code.
DescribeOffering
data DescribeOffering Source #
See: newDescribeOffering
smart constructor.
Instances
Create a value of DescribeOffering
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:offeringArn:DescribeOffering'
, describeOffering_offeringArn
- The Amazon Resource Name (ARN) of the offering.
data DescribeOfferingResponse Source #
See: newDescribeOfferingResponse
smart constructor.
Instances
newDescribeOfferingResponse Source #
Create a value of DescribeOfferingResponse
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:offering:DescribeOfferingResponse'
, describeOfferingResponse_offering
- Undocumented member.
$sel:httpStatus:DescribeOfferingResponse'
, describeOfferingResponse_httpStatus
- The response's http status code.
AddFlowVpcInterfaces
data AddFlowVpcInterfaces Source #
A request to add VPC interfaces to the flow.
See: newAddFlowVpcInterfaces
smart constructor.
Instances
newAddFlowVpcInterfaces Source #
Create a value of AddFlowVpcInterfaces
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:flowArn:AddFlowVpcInterfaces'
, addFlowVpcInterfaces_flowArn
- The flow that you want to mutate.
$sel:vpcInterfaces:AddFlowVpcInterfaces'
, addFlowVpcInterfaces_vpcInterfaces
- A list of VPC interfaces that you want to add.
data AddFlowVpcInterfacesResponse Source #
See: newAddFlowVpcInterfacesResponse
smart constructor.
Instances
newAddFlowVpcInterfacesResponse Source #
Create a value of AddFlowVpcInterfacesResponse
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:flowArn:AddFlowVpcInterfaces'
, addFlowVpcInterfacesResponse_flowArn
- The ARN of the flow that these VPC interfaces were added to.
$sel:vpcInterfaces:AddFlowVpcInterfaces'
, addFlowVpcInterfacesResponse_vpcInterfaces
- The details of the newly added VPC interfaces.
$sel:httpStatus:AddFlowVpcInterfacesResponse'
, addFlowVpcInterfacesResponse_httpStatus
- The response's http status code.
ListEntitlements (Paginated)
data ListEntitlements Source #
See: newListEntitlements
smart constructor.
Instances
newListEntitlements :: ListEntitlements Source #
Create a value of ListEntitlements
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:nextToken:ListEntitlements'
, listEntitlements_nextToken
- The token that identifies which batch of results that you want to see.
For example, you submit a ListEntitlements request with MaxResults set
at 5. The service returns the first batch of results (up to 5) and a
NextToken value. To see the next batch of results, you can submit the
ListEntitlements request a second time and specify the NextToken value.
$sel:maxResults:ListEntitlements'
, listEntitlements_maxResults
- The maximum number of results to return per API request. For example,
you submit a ListEntitlements request with MaxResults set at 5. Although
20 items match your request, the service returns no more than the first
5 items. (The service also returns a NextToken value that you can use to
fetch the next batch of results.) The service might return fewer results
than the MaxResults value. If MaxResults is not included in the request,
the service defaults to pagination with a maximum of 20 results per
page.
data ListEntitlementsResponse Source #
See: newListEntitlementsResponse
smart constructor.
Instances
newListEntitlementsResponse Source #
Create a value of ListEntitlementsResponse
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:nextToken:ListEntitlements'
, listEntitlementsResponse_nextToken
- The token that identifies which batch of results that you want to see.
For example, you submit a ListEntitlements request with MaxResults set
at 5. The service returns the first batch of results (up to 5) and a
NextToken value. To see the next batch of results, you can submit the
ListEntitlements request a second time and specify the NextToken value.
$sel:entitlements:ListEntitlementsResponse'
, listEntitlementsResponse_entitlements
- A list of entitlements that have been granted to you from other AWS
accounts.
$sel:httpStatus:ListEntitlementsResponse'
, listEntitlementsResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
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) that identifies the AWS Elemental
MediaConnect resource to which to add tags.
$sel:tags:TagResource'
, tagResource_tags
- A map from tag keys to values. Tag keys can have a maximum character
length of 128 characters, and tag values can have a maximum length of
256 characters.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
Eq TagResourceResponse Source # | |
Defined in Amazonka.MediaConnect.TagResource (==) :: TagResourceResponse -> TagResourceResponse -> Bool # (/=) :: TagResourceResponse -> TagResourceResponse -> Bool # | |
Read TagResourceResponse Source # | |
Show TagResourceResponse Source # | |
Defined in Amazonka.MediaConnect.TagResource showsPrec :: Int -> TagResourceResponse -> ShowS # show :: TagResourceResponse -> String # showList :: [TagResourceResponse] -> ShowS # | |
Generic TagResourceResponse Source # | |
Defined in Amazonka.MediaConnect.TagResource type Rep TagResourceResponse :: Type -> Type # from :: TagResourceResponse -> Rep TagResourceResponse x # to :: Rep TagResourceResponse x -> TagResourceResponse # | |
NFData TagResourceResponse Source # | |
Defined in Amazonka.MediaConnect.TagResource rnf :: TagResourceResponse -> () # | |
type Rep TagResourceResponse Source # | |
newTagResourceResponse :: TagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListFlows (Paginated)
See: newListFlows
smart constructor.
ListFlows' (Maybe Text) (Maybe Natural) |
Instances
newListFlows :: ListFlows Source #
Create a value of ListFlows
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:nextToken:ListFlows'
, listFlows_nextToken
- The token that identifies which batch of results that you want to see.
For example, you submit a ListFlows request with MaxResults set at 5.
The service returns the first batch of results (up to 5) and a NextToken
value. To see the next batch of results, you can submit the ListFlows
request a second time and specify the NextToken value.
$sel:maxResults:ListFlows'
, listFlows_maxResults
- The maximum number of results to return per API request. For example,
you submit a ListFlows request with MaxResults set at 5. Although 20
items match your request, the service returns no more than the first 5
items. (The service also returns a NextToken value that you can use to
fetch the next batch of results.) The service might return fewer results
than the MaxResults value. If MaxResults is not included in the request,
the service defaults to pagination with a maximum of 10 results per
page.
data ListFlowsResponse Source #
See: newListFlowsResponse
smart constructor.
Instances
Create a value of ListFlowsResponse
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:nextToken:ListFlows'
, listFlowsResponse_nextToken
- The token that identifies which batch of results that you want to see.
For example, you submit a ListFlows request with MaxResults set at 5.
The service returns the first batch of results (up to 5) and a NextToken
value. To see the next batch of results, you can submit the ListFlows
request a second time and specify the NextToken value.
$sel:flows:ListFlowsResponse'
, listFlowsResponse_flows
- A list of flow summaries.
$sel:httpStatus:ListFlowsResponse'
, listFlowsResponse_httpStatus
- The response's http status code.
PurchaseOffering
data PurchaseOffering Source #
A request to purchase a offering.
See: newPurchaseOffering
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> PurchaseOffering |
Create a value of PurchaseOffering
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:offeringArn:PurchaseOffering'
, purchaseOffering_offeringArn
- The Amazon Resource Name (ARN) of the offering.
$sel:start:PurchaseOffering'
, purchaseOffering_start
- The date and time that you want the reservation to begin, in Coordinated
Universal Time (UTC). You can specify any date and time between 12:00am
on the first day of the current month to the current time on today's
date, inclusive. Specify the start in a 24-hour notation. Use the
following format: YYYY-MM-DDTHH:mm:SSZ, where T and Z are literal
characters. For example, to specify 11:30pm on March 5, 2020, enter
2020-03-05T23:30:00Z.
$sel:reservationName:PurchaseOffering'
, purchaseOffering_reservationName
- The name that you want to use for the reservation.
data PurchaseOfferingResponse Source #
See: newPurchaseOfferingResponse
smart constructor.
Instances
newPurchaseOfferingResponse Source #
Create a value of PurchaseOfferingResponse
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:reservation:PurchaseOfferingResponse'
, purchaseOfferingResponse_reservation
- Undocumented member.
$sel:httpStatus:PurchaseOfferingResponse'
, purchaseOfferingResponse_httpStatus
- The response's http status code.
UpdateFlowMediaStream
data UpdateFlowMediaStream Source #
The fields that you want to update in the media stream.
See: newUpdateFlowMediaStream
smart constructor.
UpdateFlowMediaStream' (Maybe Text) (Maybe MediaStreamType) (Maybe MediaStreamAttributesRequest) (Maybe Int) (Maybe Text) Text Text |
Instances
newUpdateFlowMediaStream Source #
:: Text | |
-> Text | |
-> UpdateFlowMediaStream |
Create a value of UpdateFlowMediaStream
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:videoFormat:UpdateFlowMediaStream'
, updateFlowMediaStream_videoFormat
- The resolution of the video.
$sel:mediaStreamType:UpdateFlowMediaStream'
, updateFlowMediaStream_mediaStreamType
- The type of media stream.
$sel:attributes:UpdateFlowMediaStream'
, updateFlowMediaStream_attributes
- The attributes that you want to assign to the media stream.
$sel:clockRate:UpdateFlowMediaStream'
, updateFlowMediaStream_clockRate
- The sample rate (in Hz) for the stream. If the media stream type is
video or ancillary data, set this value to 90000. If the media stream
type is audio, set this value to either 48000 or 96000.
$sel:description:UpdateFlowMediaStream'
, updateFlowMediaStream_description
- Description
$sel:flowArn:UpdateFlowMediaStream'
, updateFlowMediaStream_flowArn
- The Amazon Resource Name (ARN) of the flow.
$sel:mediaStreamName:UpdateFlowMediaStream'
, updateFlowMediaStream_mediaStreamName
- The name of the media stream that you want to update.
data UpdateFlowMediaStreamResponse Source #
See: newUpdateFlowMediaStreamResponse
smart constructor.
Instances
newUpdateFlowMediaStreamResponse Source #
Create a value of UpdateFlowMediaStreamResponse
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:flowArn:UpdateFlowMediaStream'
, updateFlowMediaStreamResponse_flowArn
- The ARN of the flow that is associated with the media stream that you
updated.
$sel:mediaStream:UpdateFlowMediaStreamResponse'
, updateFlowMediaStreamResponse_mediaStream
- The media stream that you updated.
$sel:httpStatus:UpdateFlowMediaStreamResponse'
, updateFlowMediaStreamResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
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:tagKeys:UntagResource'
, untagResource_tagKeys
- The keys of the tags to be removed.
$sel:resourceArn:UntagResource'
, untagResource_resourceArn
- The Amazon Resource Name (ARN) that identifies the AWS Elemental
MediaConnect resource from which to delete tags.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
Eq UntagResourceResponse Source # | |
Defined in Amazonka.MediaConnect.UntagResource (==) :: UntagResourceResponse -> UntagResourceResponse -> Bool # (/=) :: UntagResourceResponse -> UntagResourceResponse -> Bool # | |
Read UntagResourceResponse Source # | |
Show UntagResourceResponse Source # | |
Defined in Amazonka.MediaConnect.UntagResource showsPrec :: Int -> UntagResourceResponse -> ShowS # show :: UntagResourceResponse -> String # showList :: [UntagResourceResponse] -> ShowS # | |
Generic UntagResourceResponse Source # | |
Defined in Amazonka.MediaConnect.UntagResource type Rep UntagResourceResponse :: Type -> Type # | |
NFData UntagResourceResponse Source # | |
Defined in Amazonka.MediaConnect.UntagResource rnf :: UntagResourceResponse -> () # | |
type Rep UntagResourceResponse Source # | |
Defined in Amazonka.MediaConnect.UntagResource |
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateFlow
data UpdateFlow Source #
A request to update flow.
See: newUpdateFlow
smart constructor.
Instances
Create a value of UpdateFlow
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:sourceFailoverConfig:UpdateFlow'
, updateFlow_sourceFailoverConfig
- Undocumented member.
$sel:flowArn:UpdateFlow'
, updateFlow_flowArn
- The flow that you want to update.
data UpdateFlowResponse Source #
See: newUpdateFlowResponse
smart constructor.
Instances
newUpdateFlowResponse Source #
Create a value of UpdateFlowResponse
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:flow:UpdateFlowResponse'
, updateFlowResponse_flow
- Undocumented member.
$sel:httpStatus:UpdateFlowResponse'
, updateFlowResponse_httpStatus
- The response's http status code.
DeleteFlow
data DeleteFlow Source #
See: newDeleteFlow
smart constructor.
Instances
Create a value of DeleteFlow
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:flowArn:DeleteFlow'
, deleteFlow_flowArn
- The ARN of the flow that you want to delete.
data DeleteFlowResponse Source #
See: newDeleteFlowResponse
smart constructor.
Instances
newDeleteFlowResponse Source #
Create a value of DeleteFlowResponse
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:DeleteFlowResponse'
, deleteFlowResponse_status
- The status of the flow when the DeleteFlow process begins.
$sel:flowArn:DeleteFlow'
, deleteFlowResponse_flowArn
- The ARN of the flow that was deleted.
$sel:httpStatus:DeleteFlowResponse'
, deleteFlowResponse_httpStatus
- The response's http status code.
UpdateFlowSource
data UpdateFlowSource Source #
A request to update the source of a flow.
See: newUpdateFlowSource
smart constructor.
UpdateFlowSource' (Maybe Text) (Maybe Int) (Maybe Text) (Maybe UpdateEncryption) (Maybe Int) (Maybe Protocol) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe [MediaStreamSourceConfigurationRequest]) (Maybe Text) (Maybe Int) (Maybe Text) Text Text |
Instances
Create a value of UpdateFlowSource
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:entitlementArn:UpdateFlowSource'
, updateFlowSource_entitlementArn
- The ARN of the entitlement that allows you to subscribe to this flow.
The entitlement is set by the flow originator, and the ARN is generated
as part of the originator's flow.
$sel:maxLatency:UpdateFlowSource'
, updateFlowSource_maxLatency
- The maximum latency in milliseconds. This parameter applies only to
RIST-based and Zixi-based streams.
$sel:vpcInterfaceName:UpdateFlowSource'
, updateFlowSource_vpcInterfaceName
- The name of the VPC interface to use for this source.
$sel:decryption:UpdateFlowSource'
, updateFlowSource_decryption
- The type of encryption used on the content ingested from this source.
$sel:maxSyncBuffer:UpdateFlowSource'
, updateFlowSource_maxSyncBuffer
- The size of the buffer (in milliseconds) to use to sync incoming source
data.
$sel:protocol:UpdateFlowSource'
, updateFlowSource_protocol
- The protocol that is used by the source.
$sel:minLatency:UpdateFlowSource'
, updateFlowSource_minLatency
- The minimum latency in milliseconds for SRT-based streams. In streams
that use the SRT protocol, this value that you set on your MediaConnect
source or output represents the minimal potential latency of that
connection. The latency of the stream is set to the highest number
between the sender’s minimum latency and the receiver’s minimum latency.
$sel:ingestPort:UpdateFlowSource'
, updateFlowSource_ingestPort
- The port that the flow will be listening on for incoming content.
$sel:description:UpdateFlowSource'
, updateFlowSource_description
- A description for the source. This value is not used or seen outside of
the current AWS Elemental MediaConnect account.
$sel:mediaStreamSourceConfigurations:UpdateFlowSource'
, updateFlowSource_mediaStreamSourceConfigurations
- The media streams that are associated with the source, and the
parameters for those associations.
$sel:whitelistCidr:UpdateFlowSource'
, updateFlowSource_whitelistCidr
- The range of IP addresses that should be allowed to contribute content
to your source. These IP addresses should be in the form of a Classless
Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
$sel:maxBitrate:UpdateFlowSource'
, updateFlowSource_maxBitrate
- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
$sel:streamId:UpdateFlowSource'
, updateFlowSource_streamId
- The stream ID that you want to use for this transport. This parameter
applies only to Zixi-based streams.
$sel:flowArn:UpdateFlowSource'
, updateFlowSource_flowArn
- The flow that is associated with the source that you want to update.
$sel:sourceArn:UpdateFlowSource'
, updateFlowSource_sourceArn
- The ARN of the source that you want to update.
data UpdateFlowSourceResponse Source #
See: newUpdateFlowSourceResponse
smart constructor.
Instances
newUpdateFlowSourceResponse Source #
Create a value of UpdateFlowSourceResponse
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:flowArn:UpdateFlowSource'
, updateFlowSourceResponse_flowArn
- The ARN of the flow that you want to update.
$sel:source:UpdateFlowSourceResponse'
, updateFlowSourceResponse_source
- The settings for the source of the flow.
$sel:httpStatus:UpdateFlowSourceResponse'
, updateFlowSourceResponse_httpStatus
- The response's http status code.
GrantFlowEntitlements
data GrantFlowEntitlements Source #
A request to grant entitlements on a flow.
See: newGrantFlowEntitlements
smart constructor.
Instances
newGrantFlowEntitlements Source #
Create a value of GrantFlowEntitlements
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:flowArn:GrantFlowEntitlements'
, grantFlowEntitlements_flowArn
- The flow that you want to grant entitlements on.
$sel:entitlements:GrantFlowEntitlements'
, grantFlowEntitlements_entitlements
- The list of entitlements that you want to grant.
data GrantFlowEntitlementsResponse Source #
See: newGrantFlowEntitlementsResponse
smart constructor.
Instances
newGrantFlowEntitlementsResponse Source #
Create a value of GrantFlowEntitlementsResponse
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:flowArn:GrantFlowEntitlements'
, grantFlowEntitlementsResponse_flowArn
- The ARN of the flow that these entitlements were granted to.
$sel:entitlements:GrantFlowEntitlements'
, grantFlowEntitlementsResponse_entitlements
- The entitlements that were just granted.
$sel:httpStatus:GrantFlowEntitlementsResponse'
, grantFlowEntitlementsResponse_httpStatus
- The response's http status code.
ListReservations (Paginated)
data ListReservations Source #
See: newListReservations
smart constructor.
Instances
newListReservations :: ListReservations Source #
Create a value of ListReservations
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:nextToken:ListReservations'
, listReservations_nextToken
- The token that identifies which batch of results that you want to see.
For example, you submit a ListReservations request with MaxResults set
at 5. The service returns the first batch of results (up to 5) and a
NextToken value. To see the next batch of results, you can submit the
ListOfferings request a second time and specify the NextToken value.
$sel:maxResults:ListReservations'
, listReservations_maxResults
- The maximum number of results to return per API request. For example,
you submit a ListReservations request with MaxResults set at 5. Although
20 items match your request, the service returns no more than the first
5 items. (The service also returns a NextToken value that you can use to
fetch the next batch of results.) The service might return fewer results
than the MaxResults value. If MaxResults is not included in the request,
the service defaults to pagination with a maximum of 10 results per
page.
data ListReservationsResponse Source #
See: newListReservationsResponse
smart constructor.
Instances
newListReservationsResponse Source #
Create a value of ListReservationsResponse
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:nextToken:ListReservations'
, listReservationsResponse_nextToken
- The token that identifies which batch of results that you want to see.
For example, you submit a ListReservations request with MaxResults set
at 5. The service returns the first batch of results (up to 5) and a
NextToken value. To see the next batch of results, you can submit the
ListReservations request a second time and specify the NextToken value.
$sel:reservations:ListReservationsResponse'
, listReservationsResponse_reservations
- A list of all reservations that have been purchased by this account in
the current AWS Region.
$sel:httpStatus:ListReservationsResponse'
, listReservationsResponse_httpStatus
- The response's http status code.
ListOfferings (Paginated)
data ListOfferings Source #
See: newListOfferings
smart constructor.
Instances
newListOfferings :: ListOfferings Source #
Create a value of ListOfferings
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:nextToken:ListOfferings'
, listOfferings_nextToken
- The token that identifies which batch of results that you want to see.
For example, you submit a ListOfferings request with MaxResults set at
5. The service returns the first batch of results (up to 5) and a
NextToken value. To see the next batch of results, you can submit the
ListOfferings request a second time and specify the NextToken value.
$sel:maxResults:ListOfferings'
, listOfferings_maxResults
- The maximum number of results to return per API request. For example,
you submit a ListOfferings request with MaxResults set at 5. Although 20
items match your request, the service returns no more than the first 5
items. (The service also returns a NextToken value that you can use to
fetch the next batch of results.) The service might return fewer results
than the MaxResults value. If MaxResults is not included in the request,
the service defaults to pagination with a maximum of 10 results per
page.
data ListOfferingsResponse Source #
See: newListOfferingsResponse
smart constructor.
Instances
newListOfferingsResponse Source #
Create a value of ListOfferingsResponse
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:nextToken:ListOfferings'
, listOfferingsResponse_nextToken
- The token that identifies which batch of results that you want to see.
For example, you submit a ListOfferings request with MaxResults set at
5. The service returns the first batch of results (up to 5) and a
NextToken value. To see the next batch of results, you can submit the
ListOfferings request a second time and specify the NextToken value.
$sel:offerings:ListOfferingsResponse'
, listOfferingsResponse_offerings
- A list of offerings that are available to this account in the current
AWS Region.
$sel:httpStatus:ListOfferingsResponse'
, listOfferingsResponse_httpStatus
- The response's http status code.
Types
Algorithm
pattern Algorithm_Aes128 :: Algorithm | |
pattern Algorithm_Aes192 :: Algorithm | |
pattern Algorithm_Aes256 :: Algorithm |
Instances
Colorimetry
newtype Colorimetry Source #
pattern Colorimetry_BT2020 :: Colorimetry | |
pattern Colorimetry_BT2100 :: Colorimetry | |
pattern Colorimetry_BT601 :: Colorimetry | |
pattern Colorimetry_BT709 :: Colorimetry | |
pattern Colorimetry_ST2065_1 :: Colorimetry | |
pattern Colorimetry_ST2065_3 :: Colorimetry | |
pattern Colorimetry_XYZ :: Colorimetry |
Instances
DurationUnits
newtype DurationUnits Source #
pattern DurationUnits_MONTHS :: DurationUnits |
Instances
EncoderProfile
newtype EncoderProfile Source #
pattern EncoderProfile_High :: EncoderProfile | |
pattern EncoderProfile_Main :: EncoderProfile |
Instances
EncodingName
newtype EncodingName Source #
pattern EncodingName_Jxsv :: EncodingName | |
pattern EncodingName_Pcm :: EncodingName | |
pattern EncodingName_Raw :: EncodingName | |
pattern EncodingName_Smpte291 :: EncodingName |
Instances
EntitlementStatus
newtype EntitlementStatus Source #
pattern EntitlementStatus_DISABLED :: EntitlementStatus | |
pattern EntitlementStatus_ENABLED :: EntitlementStatus |
Instances
FailoverMode
newtype FailoverMode Source #
pattern FailoverMode_FAILOVER :: FailoverMode | |
pattern FailoverMode_MERGE :: FailoverMode |
Instances
KeyType
pattern KeyType_Speke :: KeyType | |
pattern KeyType_Srt_password :: KeyType | |
pattern KeyType_Static_key :: KeyType |
Instances
MediaStreamType
newtype MediaStreamType Source #
pattern MediaStreamType_Ancillary_data :: MediaStreamType | |
pattern MediaStreamType_Audio :: MediaStreamType | |
pattern MediaStreamType_Video :: MediaStreamType |
Instances
NetworkInterfaceType
newtype NetworkInterfaceType Source #
pattern NetworkInterfaceType_Efa :: NetworkInterfaceType | |
pattern NetworkInterfaceType_Ena :: NetworkInterfaceType |
Instances
PriceUnits
newtype PriceUnits Source #
pattern PriceUnits_HOURLY :: PriceUnits |
Instances
Protocol
pattern Protocol_Cdi :: Protocol | |
pattern Protocol_Rist :: Protocol | |
pattern Protocol_Rtp :: Protocol | |
pattern Protocol_Rtp_fec :: Protocol | |
pattern Protocol_Srt_listener :: Protocol | |
pattern Protocol_St2110_jpegxs :: Protocol | |
pattern Protocol_Zixi_pull :: Protocol | |
pattern Protocol_Zixi_push :: Protocol |
Instances
Range
pattern Range_FULL :: Range | |
pattern Range_FULLPROTECT :: Range | |
pattern Range_NARROW :: Range |
Instances
ReservationState
newtype ReservationState Source #
pattern ReservationState_ACTIVE :: ReservationState | |
pattern ReservationState_CANCELED :: ReservationState | |
pattern ReservationState_EXPIRED :: ReservationState | |
pattern ReservationState_PROCESSING :: ReservationState |
Instances
ResourceType
newtype ResourceType Source #
pattern ResourceType_Mbps_Outbound_Bandwidth :: ResourceType |
Instances
ScanMode
pattern ScanMode_Interlace :: ScanMode | |
pattern ScanMode_Progressive :: ScanMode | |
pattern ScanMode_Progressive_segmented_frame :: ScanMode |
Instances
SourceType
newtype SourceType Source #
pattern SourceType_ENTITLED :: SourceType | |
pattern SourceType_OWNED :: SourceType |
Instances
State
pattern State_DISABLED :: State | |
pattern State_ENABLED :: State |
Instances
Status
pattern Status_ACTIVE :: Status | |
pattern Status_DELETING :: Status | |
pattern Status_ERROR :: Status | |
pattern Status_STANDBY :: Status | |
pattern Status_STARTING :: Status | |
pattern Status_STOPPING :: Status | |
pattern Status_UPDATING :: Status |
Instances
Tcs
pattern Tcs_BT2100LINHLG :: Tcs | |
pattern Tcs_BT2100LINPQ :: Tcs | |
pattern Tcs_DENSITY :: Tcs | |
pattern Tcs_HLG :: Tcs | |
pattern Tcs_LINEAR :: Tcs | |
pattern Tcs_PQ :: Tcs | |
pattern Tcs_SDR :: Tcs | |
pattern Tcs_ST2065_1 :: Tcs | |
pattern Tcs_ST428_1 :: Tcs |
Instances
AddMediaStreamRequest
data AddMediaStreamRequest Source #
The media stream that you want to add to the flow.
See: newAddMediaStreamRequest
smart constructor.
AddMediaStreamRequest' (Maybe Text) (Maybe MediaStreamAttributesRequest) (Maybe Int) (Maybe Text) MediaStreamType Int Text |
Instances
newAddMediaStreamRequest Source #
:: MediaStreamType | |
-> Int | |
-> Text | |
-> AddMediaStreamRequest |
Create a value of AddMediaStreamRequest
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:videoFormat:AddMediaStreamRequest'
, addMediaStreamRequest_videoFormat
- The resolution of the video.
$sel:attributes:AddMediaStreamRequest'
, addMediaStreamRequest_attributes
- The attributes that you want to assign to the new media stream.
$sel:clockRate:AddMediaStreamRequest'
, addMediaStreamRequest_clockRate
- The sample rate (in Hz) for the stream. If the media stream type is
video or ancillary data, set this value to 90000. If the media stream
type is audio, set this value to either 48000 or 96000.
$sel:description:AddMediaStreamRequest'
, addMediaStreamRequest_description
- A description that can help you quickly identify what your media stream
is used for.
$sel:mediaStreamType:AddMediaStreamRequest'
, addMediaStreamRequest_mediaStreamType
- The type of media stream.
$sel:mediaStreamId:AddMediaStreamRequest'
, addMediaStreamRequest_mediaStreamId
- A unique identifier for the media stream.
$sel:mediaStreamName:AddMediaStreamRequest'
, addMediaStreamRequest_mediaStreamName
- A name that helps you distinguish one media stream from another.
AddOutputRequest
data AddOutputRequest Source #
The output that you want to add to this flow.
See: newAddOutputRequest
smart constructor.
AddOutputRequest' (Maybe Text) (Maybe Int) (Maybe [MediaStreamOutputConfigurationRequest]) (Maybe Encryption) (Maybe Text) (Maybe [Text]) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe VpcInterfaceAttachment) Protocol |
Instances
Create a value of AddOutputRequest
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:destination:AddOutputRequest'
, addOutputRequest_destination
- The IP address from which video will be sent to output destinations.
$sel:maxLatency:AddOutputRequest'
, addOutputRequest_maxLatency
- The maximum latency in milliseconds for Zixi-based streams.
$sel:mediaStreamOutputConfigurations:AddOutputRequest'
, addOutputRequest_mediaStreamOutputConfigurations
- The media streams that are associated with the output, and the
parameters for those associations.
$sel:encryption:AddOutputRequest'
, addOutputRequest_encryption
- The type of key used for the encryption. If no keyType is provided, the
service will use the default setting (static-key).
$sel:name:AddOutputRequest'
, addOutputRequest_name
- The name of the output. This value must be unique within the current
flow.
$sel:cidrAllowList:AddOutputRequest'
, addOutputRequest_cidrAllowList
- The range of IP addresses that should be allowed to initiate output
requests to this flow. These IP addresses should be in the form of a
Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
$sel:smoothingLatency:AddOutputRequest'
, addOutputRequest_smoothingLatency
- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC
streams.
$sel:minLatency:AddOutputRequest'
, addOutputRequest_minLatency
- The minimum latency in milliseconds for SRT-based streams. In streams
that use the SRT protocol, this value that you set on your MediaConnect
source or output represents the minimal potential latency of that
connection. The latency of the stream is set to the highest number
between the sender’s minimum latency and the receiver’s minimum latency.
$sel:description:AddOutputRequest'
, addOutputRequest_description
- A description of the output. This description appears only on the AWS
Elemental MediaConnect console and will not be seen by the end user.
$sel:port:AddOutputRequest'
, addOutputRequest_port
- The port to use when content is distributed to this output.
$sel:streamId:AddOutputRequest'
, addOutputRequest_streamId
- The stream ID that you want to use for this transport. This parameter
applies only to Zixi-based streams.
$sel:remoteId:AddOutputRequest'
, addOutputRequest_remoteId
- The remote ID for the Zixi-pull output stream.
$sel:vpcInterfaceAttachment:AddOutputRequest'
, addOutputRequest_vpcInterfaceAttachment
- The name of the VPC interface attachment to use for this output.
$sel:protocol:AddOutputRequest'
, addOutputRequest_protocol
- The protocol to use for the output.
DestinationConfiguration
data DestinationConfiguration Source #
The transport parameters that are associated with an outbound media stream.
See: newDestinationConfiguration
smart constructor.
Instances
newDestinationConfiguration Source #
:: Text | |
-> Int | |
-> Interface | |
-> Text | |
-> DestinationConfiguration |
Create a value of DestinationConfiguration
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:destinationIp:DestinationConfiguration'
, destinationConfiguration_destinationIp
- The IP address where contents of the media stream will be sent.
$sel:destinationPort:DestinationConfiguration'
, destinationConfiguration_destinationPort
- The port to use when the content of the media stream is distributed to
the output.
$sel:interface:DestinationConfiguration'
, destinationConfiguration_interface
- The VPC interface that is used for the media stream associated with the
output.
$sel:outboundIp:DestinationConfiguration'
, destinationConfiguration_outboundIp
- The IP address that the receiver requires in order to establish a
connection with the flow. This value is represented by the elastic
network interface IP address of the VPC. This field applies only to
outputs that use the CDI or ST 2110 JPEG XS protocol.
DestinationConfigurationRequest
data DestinationConfigurationRequest Source #
The transport parameters that you want to associate with an outbound media stream.
See: newDestinationConfigurationRequest
smart constructor.
Instances
newDestinationConfigurationRequest Source #
Create a value of DestinationConfigurationRequest
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:destinationIp:DestinationConfigurationRequest'
, destinationConfigurationRequest_destinationIp
- The IP address where you want MediaConnect to send contents of the media
stream.
$sel:destinationPort:DestinationConfigurationRequest'
, destinationConfigurationRequest_destinationPort
- The port that you want MediaConnect to use when it distributes the media
stream to the output.
$sel:interface:DestinationConfigurationRequest'
, destinationConfigurationRequest_interface
- The VPC interface that you want to use for the media stream associated
with the output.
EncodingParameters
data EncodingParameters Source #
A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.
See: newEncodingParameters
smart constructor.
Instances
newEncodingParameters Source #
Create a value of EncodingParameters
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:encoderProfile:EncodingParameters'
, encodingParameters_encoderProfile
- A setting on the encoder that drives compression settings. This property
only applies to video media streams associated with outputs that use the
ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.
$sel:compressionFactor:EncodingParameters'
, encodingParameters_compressionFactor
- A value that is used to calculate compression for an output. The bitrate
of the output is calculated as follows: Output bitrate = (1 /
compressionFactor) * (source bitrate) This property only applies to
outputs that use the ST 2110 JPEG XS protocol, with a flow source that
uses the CDI protocol. Valid values are floating point numbers in the
range of 3.0 to 10.0, inclusive.
EncodingParametersRequest
data EncodingParametersRequest Source #
A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.
See: newEncodingParametersRequest
smart constructor.
Instances
newEncodingParametersRequest Source #
Create a value of EncodingParametersRequest
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:encoderProfile:EncodingParametersRequest'
, encodingParametersRequest_encoderProfile
- A setting on the encoder that drives compression settings. This property
only applies to video media streams associated with outputs that use the
ST 2110 JPEG XS protocol, if at least one source on the flow uses the
CDI protocol.
$sel:compressionFactor:EncodingParametersRequest'
, encodingParametersRequest_compressionFactor
- A value that is used to calculate compression for an output. The bitrate
of the output is calculated as follows: Output bitrate = (1 /
compressionFactor) * (source bitrate) This property only applies to
outputs that use the ST 2110 JPEG XS protocol, with a flow source that
uses the CDI protocol. Valid values are floating point numbers in the
range of 3.0 to 10.0, inclusive.
Encryption
data Encryption Source #
Information about the encryption of the flow.
See: newEncryption
smart constructor.
Encryption' (Maybe KeyType) (Maybe Text) (Maybe Text) (Maybe Algorithm) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
Create a value of Encryption
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:keyType:Encryption'
, encryption_keyType
- The type of key that is used for the encryption. If no keyType is
provided, the service will use the default setting (static-key).
$sel:resourceId:Encryption'
, encryption_resourceId
- An identifier for the content. The service sends this value to the key
server to identify the current endpoint. The resource ID is also known
as the content ID. This parameter is required for SPEKE encryption and
is not valid for static key encryption.
$sel:url:Encryption'
, encryption_url
- The URL from the API Gateway proxy that you set up to talk to your key
server. This parameter is required for SPEKE encryption and is not valid
for static key encryption.
$sel:algorithm:Encryption'
, encryption_algorithm
- The type of algorithm that is used for the encryption (such as aes128,
aes192, or aes256).
$sel:constantInitializationVector:Encryption'
, encryption_constantInitializationVector
- A 128-bit, 16-byte hex value represented by a 32-character string, to be
used with the key for encrypting content. This parameter is not valid
for static key encryption.
$sel:deviceId:Encryption'
, encryption_deviceId
- The value of one of the devices that you configured with your digital
rights management (DRM) platform key provider. This parameter is
required for SPEKE encryption and is not valid for static key
encryption.
$sel:region:Encryption'
, encryption_region
- The AWS Region that the API Gateway proxy endpoint was created in. This
parameter is required for SPEKE encryption and is not valid for static
key encryption.
$sel:secretArn:Encryption'
, encryption_secretArn
- The ARN of the secret that you created in AWS Secrets Manager to store
the encryption key. This parameter is required for static key encryption
and is not valid for SPEKE encryption.
$sel:roleArn:Encryption'
, encryption_roleArn
- The ARN of the role that you created during setup (when you set up AWS
Elemental MediaConnect as a trusted entity).
Entitlement
data Entitlement Source #
The settings for a flow entitlement.
See: newEntitlement
smart constructor.
Entitlement' (Maybe Int) (Maybe Encryption) (Maybe EntitlementStatus) (Maybe Text) Text [Text] Text |
Instances
Create a value of Entitlement
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:dataTransferSubscriberFeePercent:Entitlement'
, entitlement_dataTransferSubscriberFeePercent
- Percentage from 0-100 of the data transfer cost to be billed to the
subscriber.
$sel:encryption:Entitlement'
, entitlement_encryption
- The type of encryption that will be used on the output that is
associated with this entitlement.
$sel:entitlementStatus:Entitlement'
, entitlement_entitlementStatus
- An indication of whether the entitlement is enabled.
$sel:description:Entitlement'
, entitlement_description
- A description of the entitlement.
$sel:entitlementArn:Entitlement'
, entitlement_entitlementArn
- The ARN of the entitlement.
$sel:subscribers:Entitlement'
, entitlement_subscribers
- The AWS account IDs that you want to share your content with. The
receiving accounts (subscribers) will be allowed to create their own
flow using your content as the source.
$sel:name:Entitlement'
, entitlement_name
- The name of the entitlement.
FailoverConfig
data FailoverConfig Source #
The settings for source failover
See: newFailoverConfig
smart constructor.
Instances
newFailoverConfig :: FailoverConfig Source #
Create a value of FailoverConfig
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:state:FailoverConfig'
, failoverConfig_state
- Undocumented member.
$sel:recoveryWindow:FailoverConfig'
, failoverConfig_recoveryWindow
- Search window time to look for dash-7 packets
$sel:sourcePriority:FailoverConfig'
, failoverConfig_sourcePriority
- The priority you want to assign to a source. You can have a primary
stream and a backup stream or two equally prioritized streams.
$sel:failoverMode:FailoverConfig'
, failoverConfig_failoverMode
- The type of failover you choose for this flow. MERGE combines the source
streams into a single stream, allowing graceful recovery from any
single-source loss. FAILOVER allows switching between different streams.
Flow
The settings for a flow, including its source, outputs, and entitlements.
See: newFlow
smart constructor.
Flow' (Maybe [MediaStream]) (Maybe FailoverConfig) (Maybe [VpcInterface]) (Maybe [Source]) (Maybe Text) (Maybe Text) Status [Entitlement] [Output] Text Text Source Text |
Instances
Create a value of Flow
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:mediaStreams:Flow'
, flow_mediaStreams
- The media streams that are associated with the flow. After you associate
a media stream with a source, you can also associate it with outputs on
the flow.
$sel:sourceFailoverConfig:Flow'
, flow_sourceFailoverConfig
- Undocumented member.
$sel:vpcInterfaces:Flow'
, flow_vpcInterfaces
- The VPC Interfaces for this flow.
$sel:sources:Flow'
, flow_sources
- Undocumented member.
$sel:egressIp:Flow'
, flow_egressIp
- The IP address from which video will be sent to output destinations.
$sel:description:Flow'
, flow_description
- A description of the flow. This value is not used or seen outside of the
current AWS Elemental MediaConnect account.
$sel:status:Flow'
, flow_status
- The current status of the flow.
$sel:entitlements:Flow'
, flow_entitlements
- The entitlements in this flow.
$sel:outputs:Flow'
, flow_outputs
- The outputs in this flow.
$sel:availabilityZone:Flow'
, flow_availabilityZone
- The Availability Zone that you want to create the flow in. These options
are limited to the Availability Zones within the current AWS.
$sel:flowArn:Flow'
, flow_flowArn
- The Amazon Resource Name (ARN), a unique identifier for any AWS
resource, of the flow.
$sel:source:Flow'
, flow_source
- Undocumented member.
$sel:name:Flow'
, flow_name
- The name of the flow.
Fmtp
FMTP
See: newFmtp
smart constructor.
Fmtp' (Maybe Tcs) (Maybe Text) (Maybe Text) (Maybe ScanMode) (Maybe Range) (Maybe Text) (Maybe Colorimetry) |
Instances
Create a value of Fmtp
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:tcs:Fmtp'
, fmtp_tcs
- The transfer characteristic system (TCS) that is used in the video.
$sel:exactFramerate:Fmtp'
, fmtp_exactFramerate
- The frame rate for the video stream, in frames/second. For example:
60000/1001. If you specify a whole number, MediaConnect uses a ratio of
N/1. For example, if you specify 60, MediaConnect uses 60/1 as the
exactFramerate.
$sel:par:Fmtp'
, fmtp_par
- The pixel aspect ratio (PAR) of the video.
$sel:scanMode:Fmtp'
, fmtp_scanMode
- The type of compression that was used to smooth the video’s appearance
$sel:range:Fmtp'
, fmtp_range
- The encoding range of the video.
$sel:channelOrder:Fmtp'
, fmtp_channelOrder
- The format of the audio channel.
$sel:colorimetry:Fmtp'
, fmtp_colorimetry
- The format that is used for the representation of color.
FmtpRequest
data FmtpRequest Source #
The settings that you want to use to define the media stream.
See: newFmtpRequest
smart constructor.
FmtpRequest' (Maybe Tcs) (Maybe Text) (Maybe Text) (Maybe ScanMode) (Maybe Range) (Maybe Text) (Maybe Colorimetry) |
Instances
newFmtpRequest :: FmtpRequest Source #
Create a value of FmtpRequest
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:tcs:FmtpRequest'
, fmtpRequest_tcs
- The transfer characteristic system (TCS) that is used in the video.
$sel:exactFramerate:FmtpRequest'
, fmtpRequest_exactFramerate
- The frame rate for the video stream, in frames/second. For example:
60000/1001. If you specify a whole number, MediaConnect uses a ratio of
N/1. For example, if you specify 60, MediaConnect uses 60/1 as the
exactFramerate.
$sel:par:FmtpRequest'
, fmtpRequest_par
- The pixel aspect ratio (PAR) of the video.
$sel:scanMode:FmtpRequest'
, fmtpRequest_scanMode
- The type of compression that was used to smooth the video’s appearance.
$sel:range:FmtpRequest'
, fmtpRequest_range
- The encoding range of the video.
$sel:channelOrder:FmtpRequest'
, fmtpRequest_channelOrder
- The format of the audio channel.
$sel:colorimetry:FmtpRequest'
, fmtpRequest_colorimetry
- The format that is used for the representation of color.
GrantEntitlementRequest
data GrantEntitlementRequest Source #
The entitlements that you want to grant on a flow.
See: newGrantEntitlementRequest
smart constructor.
GrantEntitlementRequest' (Maybe Int) (Maybe Encryption) (Maybe Text) (Maybe EntitlementStatus) (Maybe Text) [Text] |
Instances
newGrantEntitlementRequest :: GrantEntitlementRequest Source #
Create a value of GrantEntitlementRequest
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:dataTransferSubscriberFeePercent:GrantEntitlementRequest'
, grantEntitlementRequest_dataTransferSubscriberFeePercent
- Percentage from 0-100 of the data transfer cost to be billed to the
subscriber.
$sel:encryption:GrantEntitlementRequest'
, grantEntitlementRequest_encryption
- The type of encryption that will be used on the output that is
associated with this entitlement.
$sel:name:GrantEntitlementRequest'
, grantEntitlementRequest_name
- The name of the entitlement. This value must be unique within the
current flow.
$sel:entitlementStatus:GrantEntitlementRequest'
, grantEntitlementRequest_entitlementStatus
- An indication of whether the new entitlement should be enabled or
disabled as soon as it is created. If you don’t specify the
entitlementStatus field in your request, MediaConnect sets it to
ENABLED.
$sel:description:GrantEntitlementRequest'
, grantEntitlementRequest_description
- A description of the entitlement. This description appears only on the
AWS Elemental MediaConnect console and will not be seen by the
subscriber or end user.
$sel:subscribers:GrantEntitlementRequest'
, grantEntitlementRequest_subscribers
- The AWS account IDs that you want to share your content with. The
receiving accounts (subscribers) will be allowed to create their own
flows using your content as the source.
InputConfiguration
data InputConfiguration Source #
The transport parameters that are associated with an incoming media stream.
See: newInputConfiguration
smart constructor.
Instances
newInputConfiguration Source #
:: Int | |
-> Text | |
-> Interface | |
-> InputConfiguration |
Create a value of InputConfiguration
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:inputPort:InputConfiguration'
, inputConfiguration_inputPort
- The port that the flow listens on for an incoming media stream.
$sel:inputIp:InputConfiguration'
, inputConfiguration_inputIp
- The IP address that the flow listens on for incoming content for a media
stream.
$sel:interface:InputConfiguration'
, inputConfiguration_interface
- The VPC interface where the media stream comes in from.
InputConfigurationRequest
data InputConfigurationRequest Source #
The transport parameters that you want to associate with an incoming media stream.
See: newInputConfigurationRequest
smart constructor.
Instances
newInputConfigurationRequest Source #
Create a value of InputConfigurationRequest
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:inputPort:InputConfigurationRequest'
, inputConfigurationRequest_inputPort
- The port that you want the flow to listen on for an incoming media
stream.
$sel:interface:InputConfigurationRequest'
, inputConfigurationRequest_interface
- The VPC interface that you want to use for the incoming media stream.
Interface
The VPC interface that is used for the media stream associated with the source or output.
See: newInterface
smart constructor.
Instances
Eq Interface Source # | |
Read Interface Source # | |
Show Interface Source # | |
Generic Interface Source # | |
NFData Interface Source # | |
Defined in Amazonka.MediaConnect.Types.Interface | |
Hashable Interface Source # | |
Defined in Amazonka.MediaConnect.Types.Interface | |
FromJSON Interface Source # | |
type Rep Interface Source # | |
Defined in Amazonka.MediaConnect.Types.Interface type Rep Interface = D1 ('MetaData "Interface" "Amazonka.MediaConnect.Types.Interface" "libZSservicesZSamazonka-mediaconnectZSamazonka-mediaconnect" 'False) (C1 ('MetaCons "Interface'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Interface
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:name:Interface'
, interface_name
- The name of the VPC interface.
InterfaceRequest
data InterfaceRequest Source #
The VPC interface that you want to designate where the media stream is coming from or going to.
See: newInterfaceRequest
smart constructor.
Instances
Create a value of InterfaceRequest
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:name:InterfaceRequest'
, interfaceRequest_name
- The name of the VPC interface.
ListedEntitlement
data ListedEntitlement Source #
An entitlement that has been granted to you from other AWS accounts.
See: newListedEntitlement
smart constructor.
Instances
:: Text | |
-> Text | |
-> ListedEntitlement |
Create a value of ListedEntitlement
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:dataTransferSubscriberFeePercent:ListedEntitlement'
, listedEntitlement_dataTransferSubscriberFeePercent
- Percentage from 0-100 of the data transfer cost to be billed to the
subscriber.
$sel:entitlementArn:ListedEntitlement'
, listedEntitlement_entitlementArn
- The ARN of the entitlement.
$sel:entitlementName:ListedEntitlement'
, listedEntitlement_entitlementName
- The name of the entitlement.
ListedFlow
data ListedFlow Source #
Provides a summary of a flow, including its ARN, Availability Zone, and source type.
See: newListedFlow
smart constructor.
Instances
:: Status | |
-> Text | |
-> SourceType | |
-> Text | |
-> Text | |
-> Text | |
-> ListedFlow |
Create a value of ListedFlow
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:ListedFlow'
, listedFlow_status
- The current status of the flow.
$sel:description:ListedFlow'
, listedFlow_description
- A description of the flow.
$sel:sourceType:ListedFlow'
, listedFlow_sourceType
- The type of source. This value is either owned (originated somewhere
other than an AWS Elemental MediaConnect flow owned by another AWS
account) or entitled (originated at an AWS Elemental MediaConnect flow
owned by another AWS account).
$sel:availabilityZone:ListedFlow'
, listedFlow_availabilityZone
- The Availability Zone that the flow was created in.
$sel:flowArn:ListedFlow'
, listedFlow_flowArn
- The ARN of the flow.
$sel:name:ListedFlow'
, listedFlow_name
- The name of the flow.
MediaStream
data MediaStream Source #
A single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams.
See: newMediaStream
smart constructor.
MediaStream' (Maybe Text) (Maybe MediaStreamAttributes) (Maybe Int) (Maybe Text) MediaStreamType Int Text Int |
Instances
:: MediaStreamType | |
-> Int | |
-> Text | |
-> Int | |
-> MediaStream |
Create a value of MediaStream
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:videoFormat:MediaStream'
, mediaStream_videoFormat
- The resolution of the video.
$sel:attributes:MediaStream'
, mediaStream_attributes
- Attributes that are related to the media stream.
$sel:clockRate:MediaStream'
, mediaStream_clockRate
- The sample rate for the stream. This value is measured in Hz.
$sel:description:MediaStream'
, mediaStream_description
- A description that can help you quickly identify what your media stream
is used for.
$sel:mediaStreamType:MediaStream'
, mediaStream_mediaStreamType
- The type of media stream.
$sel:mediaStreamId:MediaStream'
, mediaStream_mediaStreamId
- A unique identifier for the media stream.
$sel:mediaStreamName:MediaStream'
, mediaStream_mediaStreamName
- A name that helps you distinguish one media stream from another.
$sel:fmt:MediaStream'
, mediaStream_fmt
- The format type number (sometimes referred to as RTP payload type) of
the media stream. MediaConnect assigns this value to the media stream.
For ST 2110 JPEG XS outputs, you need to provide this value to the
receiver.
MediaStreamAttributes
data MediaStreamAttributes Source #
Attributes that are related to the media stream.
See: newMediaStreamAttributes
smart constructor.
Instances
newMediaStreamAttributes Source #
Create a value of MediaStreamAttributes
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:lang:MediaStreamAttributes'
, mediaStreamAttributes_lang
- The audio language, in a format that is recognized by the receiver.
$sel:fmtp:MediaStreamAttributes'
, mediaStreamAttributes_fmtp
- A set of parameters that define the media stream.
MediaStreamAttributesRequest
data MediaStreamAttributesRequest Source #
Attributes that are related to the media stream.
See: newMediaStreamAttributesRequest
smart constructor.
Instances
newMediaStreamAttributesRequest :: MediaStreamAttributesRequest Source #
Create a value of MediaStreamAttributesRequest
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:lang:MediaStreamAttributesRequest'
, mediaStreamAttributesRequest_lang
- The audio language, in a format that is recognized by the receiver.
$sel:fmtp:MediaStreamAttributesRequest'
, mediaStreamAttributesRequest_fmtp
- The settings that you want to use to define the media stream.
MediaStreamOutputConfiguration
data MediaStreamOutputConfiguration Source #
The media stream that is associated with the output, and the parameters for that association.
See: newMediaStreamOutputConfiguration
smart constructor.
MediaStreamOutputConfiguration' (Maybe [DestinationConfiguration]) (Maybe EncodingParameters) Text EncodingName |
Instances
newMediaStreamOutputConfiguration Source #
Create a value of MediaStreamOutputConfiguration
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:destinationConfigurations:MediaStreamOutputConfiguration'
, mediaStreamOutputConfiguration_destinationConfigurations
- The transport parameters that are associated with each outbound media
stream.
$sel:encodingParameters:MediaStreamOutputConfiguration'
, mediaStreamOutputConfiguration_encodingParameters
- Encoding parameters
$sel:mediaStreamName:MediaStreamOutputConfiguration'
, mediaStreamOutputConfiguration_mediaStreamName
- The name of the media stream.
$sel:encodingName:MediaStreamOutputConfiguration'
, mediaStreamOutputConfiguration_encodingName
- The format that was used to encode the data. For ancillary data streams,
set the encoding name to smpte291. For audio streams, set the encoding
name to pcm. For video, 2110 streams, set the encoding name to raw. For
video, JPEG XS streams, set the encoding name to jxsv.
MediaStreamOutputConfigurationRequest
data MediaStreamOutputConfigurationRequest Source #
The media stream that you want to associate with the output, and the parameters for that association.
See: newMediaStreamOutputConfigurationRequest
smart constructor.
MediaStreamOutputConfigurationRequest' (Maybe [DestinationConfigurationRequest]) (Maybe EncodingParametersRequest) Text EncodingName |
Instances
newMediaStreamOutputConfigurationRequest Source #
Create a value of MediaStreamOutputConfigurationRequest
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:destinationConfigurations:MediaStreamOutputConfigurationRequest'
, mediaStreamOutputConfigurationRequest_destinationConfigurations
- The transport parameters that you want to associate with the media
stream.
$sel:encodingParameters:MediaStreamOutputConfigurationRequest'
, mediaStreamOutputConfigurationRequest_encodingParameters
- A collection of parameters that determine how MediaConnect will convert
the content. These fields only apply to outputs on flows that have a CDI
source.
$sel:mediaStreamName:MediaStreamOutputConfigurationRequest'
, mediaStreamOutputConfigurationRequest_mediaStreamName
- The name of the media stream that is associated with the output.
$sel:encodingName:MediaStreamOutputConfigurationRequest'
, mediaStreamOutputConfigurationRequest_encodingName
- The format that will be used to encode the data. For ancillary data
streams, set the encoding name to smpte291. For audio streams, set the
encoding name to pcm. For video, 2110 streams, set the encoding name to
raw. For video, JPEG XS streams, set the encoding name to jxsv.
MediaStreamSourceConfiguration
data MediaStreamSourceConfiguration Source #
The media stream that is associated with the source, and the parameters for that association.
See: newMediaStreamSourceConfiguration
smart constructor.
Instances
newMediaStreamSourceConfiguration Source #
Create a value of MediaStreamSourceConfiguration
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:inputConfigurations:MediaStreamSourceConfiguration'
, mediaStreamSourceConfiguration_inputConfigurations
- The transport parameters that are associated with an incoming media
stream.
$sel:mediaStreamName:MediaStreamSourceConfiguration'
, mediaStreamSourceConfiguration_mediaStreamName
- The name of the media stream.
$sel:encodingName:MediaStreamSourceConfiguration'
, mediaStreamSourceConfiguration_encodingName
- The format that was used to encode the data. For ancillary data streams,
set the encoding name to smpte291. For audio streams, set the encoding
name to pcm. For video, 2110 streams, set the encoding name to raw. For
video, JPEG XS streams, set the encoding name to jxsv.
MediaStreamSourceConfigurationRequest
data MediaStreamSourceConfigurationRequest Source #
The definition of a media stream that you want to associate with the source.
See: newMediaStreamSourceConfigurationRequest
smart constructor.
Instances
newMediaStreamSourceConfigurationRequest Source #
Create a value of MediaStreamSourceConfigurationRequest
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:inputConfigurations:MediaStreamSourceConfigurationRequest'
, mediaStreamSourceConfigurationRequest_inputConfigurations
- The transport parameters that you want to associate with the media
stream.
$sel:mediaStreamName:MediaStreamSourceConfigurationRequest'
, mediaStreamSourceConfigurationRequest_mediaStreamName
- The name of the media stream.
$sel:encodingName:MediaStreamSourceConfigurationRequest'
, mediaStreamSourceConfigurationRequest_encodingName
- The format you want to use to encode the data. For ancillary data
streams, set the encoding name to smpte291. For audio streams, set the
encoding name to pcm. For video, 2110 streams, set the encoding name to
raw. For video, JPEG XS streams, set the encoding name to jxsv.
Messages
Messages that provide the state of the flow.
See: newMessages
smart constructor.
Instances
Eq Messages Source # | |
Read Messages Source # | |
Show Messages Source # | |
Generic Messages Source # | |
NFData Messages Source # | |
Defined in Amazonka.MediaConnect.Types.Messages | |
Hashable Messages Source # | |
Defined in Amazonka.MediaConnect.Types.Messages | |
FromJSON Messages Source # | |
type Rep Messages Source # | |
Defined in Amazonka.MediaConnect.Types.Messages type Rep Messages = D1 ('MetaData "Messages" "Amazonka.MediaConnect.Types.Messages" "libZSservicesZSamazonka-mediaconnectZSamazonka-mediaconnect" 'False) (C1 ('MetaCons "Messages'" 'PrefixI 'True) (S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))) |
newMessages :: Messages Source #
Create a value of Messages
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:errors:Messages'
, messages_errors
- A list of errors that might have been generated from processes on this
flow.
Offering
A savings plan that reserves a certain amount of outbound bandwidth usage at a discounted rate each month over a period of time.
See: newOffering
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> DurationUnits | |
-> Int | |
-> Text | |
-> ResourceSpecification | |
-> PriceUnits | |
-> Offering |
Create a value of Offering
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:currencyCode:Offering'
, offering_currencyCode
- The type of currency that is used for billing. The currencyCode used for
all reservations is US dollars.
$sel:offeringArn:Offering'
, offering_offeringArn
- The Amazon Resource Name (ARN) that MediaConnect assigns to the
offering.
$sel:offeringDescription:Offering'
, offering_offeringDescription
- A description of the offering.
$sel:durationUnits:Offering'
, offering_durationUnits
- The unit of measurement for the duration of the offering.
$sel:duration:Offering'
, offering_duration
- The length of time that your reservation would be active.
$sel:pricePerUnit:Offering'
, offering_pricePerUnit
- The cost of a single unit. This value, in combination with priceUnits,
makes up the rate.
$sel:resourceSpecification:Offering'
, offering_resourceSpecification
- A definition of the amount of outbound bandwidth that you would be
reserving if you purchase the offering.
$sel:priceUnits:Offering'
, offering_priceUnits
- The unit of measurement that is used for billing. This value, in
combination with pricePerUnit, makes up the rate.
Output
The settings for an output.
See: newOutput
smart constructor.
Output' (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [MediaStreamOutputConfiguration]) (Maybe Text) (Maybe Encryption) (Maybe Text) (Maybe Transport) (Maybe Text) (Maybe Int) (Maybe VpcInterfaceAttachment) Text Text |
Instances
Create a value of Output
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:entitlementArn:Output'
, output_entitlementArn
- The ARN of the entitlement on the originator''s flow. This value is
relevant only on entitled flows.
$sel:dataTransferSubscriberFeePercent:Output'
, output_dataTransferSubscriberFeePercent
- Percentage from 0-100 of the data transfer cost to be billed to the
subscriber.
$sel:destination:Output'
, output_destination
- The address where you want to send the output.
$sel:mediaStreamOutputConfigurations:Output'
, output_mediaStreamOutputConfigurations
- The configuration for each media stream that is associated with the
output.
$sel:mediaLiveInputArn:Output'
, output_mediaLiveInputArn
- The input ARN of the AWS Elemental MediaLive channel. This parameter is
relevant only for outputs that were added by creating a MediaLive input.
$sel:encryption:Output'
, output_encryption
- The type of key used for the encryption. If no keyType is provided, the
service will use the default setting (static-key).
$sel:listenerAddress:Output'
, output_listenerAddress
- The IP address that the receiver requires in order to establish a
connection with the flow. For public networking, the ListenerAddress is
represented by the elastic IP address of the flow. For private
networking, the ListenerAddress is represented by the elastic network
interface IP address of the VPC. This field applies only to outputs that
use the Zixi pull or SRT listener protocol.
$sel:transport:Output'
, output_transport
- Attributes related to the transport stream that are used in the output.
$sel:description:Output'
, output_description
- A description of the output.
$sel:port:Output'
, output_port
- The port to use when content is distributed to this output.
$sel:vpcInterfaceAttachment:Output'
, output_vpcInterfaceAttachment
- The name of the VPC interface attachment to use for this output.
$sel:outputArn:Output'
, output_outputArn
- The ARN of the output.
$sel:name:Output'
, output_name
- The name of the output. This value must be unique within the current
flow.
Reservation
data Reservation Source #
A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.
See: newReservation
smart constructor.
Reservation' Text ReservationState Text Text Text Text Text Text Int DurationUnits Text ResourceSpecification PriceUnits |
Instances
:: Text | |
-> ReservationState | |
-> Text | |
-> Text | |
-> Text | |
-> Text | |
-> Text | |
-> Text | |
-> Int | |
-> DurationUnits | |
-> Text | |
-> ResourceSpecification | |
-> PriceUnits | |
-> Reservation |
Create a value of Reservation
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:currencyCode:Reservation'
, reservation_currencyCode
- The type of currency that is used for billing. The currencyCode used for
your reservation is US dollars.
$sel:reservationState:Reservation'
, reservation_reservationState
- The status of your reservation.
$sel:offeringArn:Reservation'
, reservation_offeringArn
- The Amazon Resource Name (ARN) that MediaConnect assigns to the
offering.
$sel:reservationArn:Reservation'
, reservation_reservationArn
- The Amazon Resource Name (ARN) that MediaConnect assigns to the
reservation when you purchase an offering.
$sel:start:Reservation'
, reservation_start
- The day and time that the reservation becomes active. You set this value
when you purchase the offering.
$sel:offeringDescription:Reservation'
, reservation_offeringDescription
- A description of the offering. MediaConnect defines this value in the
offering.
$sel:reservationName:Reservation'
, reservation_reservationName
- The name that you assigned to the reservation when you purchased the
offering.
$sel:end:Reservation'
, reservation_end
- The day and time that this reservation expires. This value is calculated
based on the start date and time that you set and the offering's
duration.
$sel:duration:Reservation'
, reservation_duration
- The length of time that this reservation is active. MediaConnect defines
this value in the offering.
$sel:durationUnits:Reservation'
, reservation_durationUnits
- The unit of measurement for the duration of the reservation.
MediaConnect defines this value in the offering.
$sel:pricePerUnit:Reservation'
, reservation_pricePerUnit
- The cost of a single unit. This value, in combination with priceUnits,
makes up the rate. MediaConnect defines this value in the offering.
$sel:resourceSpecification:Reservation'
, reservation_resourceSpecification
- A definition of the amount of outbound bandwidth that you would be
reserving if you purchase the offering. MediaConnect defines the values
that make up the resourceSpecification in the offering.
$sel:priceUnits:Reservation'
, reservation_priceUnits
- The unit of measurement that is used for billing. This value, in
combination with pricePerUnit, makes up the rate. MediaConnect defines
this value in the offering.
ResourceSpecification
data ResourceSpecification Source #
A definition of what is being billed for, including the type and amount.
See: newResourceSpecification
smart constructor.
Instances
newResourceSpecification Source #
Create a value of ResourceSpecification
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:reservedBitrate:ResourceSpecification'
, resourceSpecification_reservedBitrate
- The amount of outbound bandwidth that is discounted in the offering.
$sel:resourceType:ResourceSpecification'
, resourceSpecification_resourceType
- The type of resource and the unit that is being billed for.
SetSourceRequest
data SetSourceRequest Source #
The settings for the source of the flow.
See: newSetSourceRequest
smart constructor.
SetSourceRequest' (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Encryption) (Maybe Int) (Maybe Protocol) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe [MediaStreamSourceConfigurationRequest]) (Maybe Text) (Maybe Int) (Maybe Text) |
Instances
newSetSourceRequest :: SetSourceRequest Source #
Create a value of SetSourceRequest
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:entitlementArn:SetSourceRequest'
, setSourceRequest_entitlementArn
- The ARN of the entitlement that allows you to subscribe to this flow.
The entitlement is set by the flow originator, and the ARN is generated
as part of the originator's flow.
$sel:maxLatency:SetSourceRequest'
, setSourceRequest_maxLatency
- The maximum latency in milliseconds. This parameter applies only to
RIST-based and Zixi-based streams.
$sel:vpcInterfaceName:SetSourceRequest'
, setSourceRequest_vpcInterfaceName
- The name of the VPC interface to use for this source.
$sel:decryption:SetSourceRequest'
, setSourceRequest_decryption
- The type of encryption that is used on the content ingested from this
source.
$sel:maxSyncBuffer:SetSourceRequest'
, setSourceRequest_maxSyncBuffer
- The size of the buffer (in milliseconds) to use to sync incoming source
data.
$sel:protocol:SetSourceRequest'
, setSourceRequest_protocol
- The protocol that is used by the source.
$sel:name:SetSourceRequest'
, setSourceRequest_name
- The name of the source.
$sel:minLatency:SetSourceRequest'
, setSourceRequest_minLatency
- The minimum latency in milliseconds for SRT-based streams. In streams
that use the SRT protocol, this value that you set on your MediaConnect
source or output represents the minimal potential latency of that
connection. The latency of the stream is set to the highest number
between the sender’s minimum latency and the receiver’s minimum latency.
$sel:ingestPort:SetSourceRequest'
, setSourceRequest_ingestPort
- The port that the flow will be listening on for incoming content.
$sel:description:SetSourceRequest'
, setSourceRequest_description
- A description for the source. This value is not used or seen outside of
the current AWS Elemental MediaConnect account.
$sel:mediaStreamSourceConfigurations:SetSourceRequest'
, setSourceRequest_mediaStreamSourceConfigurations
- The media streams that are associated with the source, and the
parameters for those associations.
$sel:whitelistCidr:SetSourceRequest'
, setSourceRequest_whitelistCidr
- The range of IP addresses that should be allowed to contribute content
to your source. These IP addresses should be in the form of a Classless
Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
$sel:maxBitrate:SetSourceRequest'
, setSourceRequest_maxBitrate
- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
$sel:streamId:SetSourceRequest'
, setSourceRequest_streamId
- The stream ID that you want to use for this transport. This parameter
applies only to Zixi-based streams.
Source
The settings for the source of the flow.
See: newSource
smart constructor.
Source' (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Encryption) (Maybe Text) (Maybe Int) (Maybe Transport) (Maybe Text) (Maybe [MediaStreamSourceConfiguration]) (Maybe Text) Text Text |
Instances
Create a value of Source
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:entitlementArn:Source'
, source_entitlementArn
- The ARN of the entitlement that allows you to subscribe to content that
comes from another AWS account. The entitlement is set by the content
originator and the ARN is generated as part of the originator's flow.
$sel:dataTransferSubscriberFeePercent:Source'
, source_dataTransferSubscriberFeePercent
- Percentage from 0-100 of the data transfer cost to be billed to the
subscriber.
$sel:vpcInterfaceName:Source'
, source_vpcInterfaceName
- The name of the VPC interface that is used for this source.
$sel:decryption:Source'
, source_decryption
- The type of encryption that is used on the content ingested from this
source.
$sel:ingestIp:Source'
, source_ingestIp
- The IP address that the flow will be listening on for incoming content.
$sel:ingestPort:Source'
, source_ingestPort
- The port that the flow will be listening on for incoming content.
$sel:transport:Source'
, source_transport
- Attributes related to the transport stream that are used in the source.
$sel:description:Source'
, source_description
- A description for the source. This value is not used or seen outside of
the current AWS Elemental MediaConnect account.
$sel:mediaStreamSourceConfigurations:Source'
, source_mediaStreamSourceConfigurations
- The media streams that are associated with the source, and the
parameters for those associations.
$sel:whitelistCidr:Source'
, source_whitelistCidr
- The range of IP addresses that should be allowed to contribute content
to your source. These IP addresses should be in the form of a Classless
Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
$sel:sourceArn:Source'
, source_sourceArn
- The ARN of the source.
$sel:name:Source'
, source_name
- The name of the source.
SourcePriority
data SourcePriority Source #
The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
See: newSourcePriority
smart constructor.
Instances
newSourcePriority :: SourcePriority Source #
Create a value of SourcePriority
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:primarySource:SourcePriority'
, sourcePriority_primarySource
- The name of the source you choose as the primary source for this flow.
Transport
Attributes related to the transport stream that are used in a source or output.
See: newTransport
smart constructor.
Transport' (Maybe Int) (Maybe Int) (Maybe [Text]) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) Protocol |
Instances
Create a value of Transport
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:maxLatency:Transport'
, transport_maxLatency
- The maximum latency in milliseconds. This parameter applies only to
RIST-based and Zixi-based streams.
$sel:maxSyncBuffer:Transport'
, transport_maxSyncBuffer
- The size of the buffer (in milliseconds) to use to sync incoming source
data.
$sel:cidrAllowList:Transport'
, transport_cidrAllowList
- The range of IP addresses that should be allowed to initiate output
requests to this flow. These IP addresses should be in the form of a
Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
$sel:smoothingLatency:Transport'
, transport_smoothingLatency
- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC
streams.
$sel:minLatency:Transport'
, transport_minLatency
- The minimum latency in milliseconds for SRT-based streams. In streams
that use the SRT protocol, this value that you set on your MediaConnect
source or output represents the minimal potential latency of that
connection. The latency of the stream is set to the highest number
between the sender’s minimum latency and the receiver’s minimum latency.
$sel:maxBitrate:Transport'
, transport_maxBitrate
- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
$sel:streamId:Transport'
, transport_streamId
- The stream ID that you want to use for this transport. This parameter
applies only to Zixi-based streams.
$sel:remoteId:Transport'
, transport_remoteId
- The remote ID for the Zixi-pull stream.
$sel:protocol:Transport'
, transport_protocol
- The protocol that is used by the source or output.
UpdateEncryption
data UpdateEncryption Source #
Information about the encryption of the flow.
See: newUpdateEncryption
smart constructor.
UpdateEncryption' (Maybe KeyType) (Maybe Text) (Maybe Text) (Maybe Algorithm) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newUpdateEncryption :: UpdateEncryption Source #
Create a value of UpdateEncryption
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:keyType:UpdateEncryption'
, updateEncryption_keyType
- The type of key that is used for the encryption. If no keyType is
provided, the service will use the default setting (static-key).
$sel:resourceId:UpdateEncryption'
, updateEncryption_resourceId
- An identifier for the content. The service sends this value to the key
server to identify the current endpoint. The resource ID is also known
as the content ID. This parameter is required for SPEKE encryption and
is not valid for static key encryption.
$sel:url:UpdateEncryption'
, updateEncryption_url
- The URL from the API Gateway proxy that you set up to talk to your key
server. This parameter is required for SPEKE encryption and is not valid
for static key encryption.
$sel:algorithm:UpdateEncryption'
, updateEncryption_algorithm
- The type of algorithm that is used for the encryption (such as aes128,
aes192, or aes256).
$sel:constantInitializationVector:UpdateEncryption'
, updateEncryption_constantInitializationVector
- A 128-bit, 16-byte hex value represented by a 32-character string, to be
used with the key for encrypting content. This parameter is not valid
for static key encryption.
$sel:deviceId:UpdateEncryption'
, updateEncryption_deviceId
- The value of one of the devices that you configured with your digital
rights management (DRM) platform key provider. This parameter is
required for SPEKE encryption and is not valid for static key
encryption.
$sel:region:UpdateEncryption'
, updateEncryption_region
- The AWS Region that the API Gateway proxy endpoint was created in. This
parameter is required for SPEKE encryption and is not valid for static
key encryption.
$sel:secretArn:UpdateEncryption'
, updateEncryption_secretArn
- The ARN of the secret that you created in AWS Secrets Manager to store
the encryption key. This parameter is required for static key encryption
and is not valid for SPEKE encryption.
$sel:roleArn:UpdateEncryption'
, updateEncryption_roleArn
- The ARN of the role that you created during setup (when you set up AWS
Elemental MediaConnect as a trusted entity).
UpdateFailoverConfig
data UpdateFailoverConfig Source #
The settings for source failover
See: newUpdateFailoverConfig
smart constructor.
Instances
newUpdateFailoverConfig :: UpdateFailoverConfig Source #
Create a value of UpdateFailoverConfig
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:state:UpdateFailoverConfig'
, updateFailoverConfig_state
- Undocumented member.
$sel:recoveryWindow:UpdateFailoverConfig'
, updateFailoverConfig_recoveryWindow
- Recovery window time to look for dash-7 packets
$sel:sourcePriority:UpdateFailoverConfig'
, updateFailoverConfig_sourcePriority
- The priority you want to assign to a source. You can have a primary
stream and a backup stream or two equally prioritized streams.
$sel:failoverMode:UpdateFailoverConfig'
, updateFailoverConfig_failoverMode
- The type of failover you choose for this flow. MERGE combines the source
streams into a single stream, allowing graceful recovery from any
single-source loss. FAILOVER allows switching between different streams.
VpcInterface
data VpcInterface Source #
The settings for a VPC Source.
See: newVpcInterface
smart constructor.
Instances
:: NetworkInterfaceType | |
-> Text | |
-> Text | |
-> Text | |
-> VpcInterface |
Create a value of VpcInterface
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:networkInterfaceType:VpcInterface'
, vpcInterface_networkInterfaceType
- The type of network interface.
$sel:networkInterfaceIds:VpcInterface'
, vpcInterface_networkInterfaceIds
- IDs of the network interfaces created in customer's account by
MediaConnect.
$sel:subnetId:VpcInterface'
, vpcInterface_subnetId
- Subnet must be in the AZ of the Flow
$sel:securityGroupIds:VpcInterface'
, vpcInterface_securityGroupIds
- Security Group IDs to be used on ENI.
$sel:roleArn:VpcInterface'
, vpcInterface_roleArn
- Role Arn MediaConnect can assumes to create ENIs in customer's account
$sel:name:VpcInterface'
, vpcInterface_name
- Immutable and has to be a unique against other VpcInterfaces in this
Flow
VpcInterfaceAttachment
data VpcInterfaceAttachment Source #
The settings for attaching a VPC interface to an output.
See: newVpcInterfaceAttachment
smart constructor.
Instances
newVpcInterfaceAttachment :: VpcInterfaceAttachment Source #
Create a value of VpcInterfaceAttachment
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:vpcInterfaceName:VpcInterfaceAttachment'
, vpcInterfaceAttachment_vpcInterfaceName
- The name of the VPC interface to use for this output.
VpcInterfaceRequest
data VpcInterfaceRequest Source #
Desired VPC Interface for a Flow
See: newVpcInterfaceRequest
smart constructor.
Instances
newVpcInterfaceRequest Source #
:: Text | |
-> Text | |
-> Text | |
-> VpcInterfaceRequest |
Create a value of VpcInterfaceRequest
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:networkInterfaceType:VpcInterfaceRequest'
, vpcInterfaceRequest_networkInterfaceType
- The type of network interface. If this value is not included in the
request, MediaConnect uses ENA as the networkInterfaceType.
$sel:subnetId:VpcInterfaceRequest'
, vpcInterfaceRequest_subnetId
- Subnet must be in the AZ of the Flow
$sel:securityGroupIds:VpcInterfaceRequest'
, vpcInterfaceRequest_securityGroupIds
- Security Group IDs to be used on ENI.
$sel:roleArn:VpcInterfaceRequest'
, vpcInterfaceRequest_roleArn
- Role Arn MediaConnect can assumes to create ENIs in customer's account
$sel:name:VpcInterfaceRequest'
, vpcInterfaceRequest_name
- The name of the VPC Interface. This value must be unique within the
current flow.