Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Updates an existing flow output.
Synopsis
- data UpdateFlowOutput = UpdateFlowOutput' {
- cidrAllowList :: Maybe [Text]
- description :: Maybe Text
- destination :: Maybe Text
- encryption :: Maybe UpdateEncryption
- maxLatency :: Maybe Int
- mediaStreamOutputConfigurations :: Maybe [MediaStreamOutputConfigurationRequest]
- minLatency :: Maybe Int
- port :: Maybe Int
- protocol :: Maybe Protocol
- remoteId :: Maybe Text
- senderControlPort :: Maybe Int
- senderIpAddress :: Maybe Text
- smoothingLatency :: Maybe Int
- streamId :: Maybe Text
- vpcInterfaceAttachment :: Maybe VpcInterfaceAttachment
- flowArn :: Text
- outputArn :: Text
- newUpdateFlowOutput :: Text -> Text -> UpdateFlowOutput
- updateFlowOutput_cidrAllowList :: Lens' UpdateFlowOutput (Maybe [Text])
- updateFlowOutput_description :: Lens' UpdateFlowOutput (Maybe Text)
- updateFlowOutput_destination :: Lens' UpdateFlowOutput (Maybe Text)
- updateFlowOutput_encryption :: Lens' UpdateFlowOutput (Maybe UpdateEncryption)
- updateFlowOutput_maxLatency :: Lens' UpdateFlowOutput (Maybe Int)
- updateFlowOutput_mediaStreamOutputConfigurations :: Lens' UpdateFlowOutput (Maybe [MediaStreamOutputConfigurationRequest])
- updateFlowOutput_minLatency :: Lens' UpdateFlowOutput (Maybe Int)
- updateFlowOutput_port :: Lens' UpdateFlowOutput (Maybe Int)
- updateFlowOutput_protocol :: Lens' UpdateFlowOutput (Maybe Protocol)
- updateFlowOutput_remoteId :: Lens' UpdateFlowOutput (Maybe Text)
- updateFlowOutput_senderControlPort :: Lens' UpdateFlowOutput (Maybe Int)
- updateFlowOutput_senderIpAddress :: Lens' UpdateFlowOutput (Maybe Text)
- updateFlowOutput_smoothingLatency :: Lens' UpdateFlowOutput (Maybe Int)
- updateFlowOutput_streamId :: Lens' UpdateFlowOutput (Maybe Text)
- updateFlowOutput_vpcInterfaceAttachment :: Lens' UpdateFlowOutput (Maybe VpcInterfaceAttachment)
- updateFlowOutput_flowArn :: Lens' UpdateFlowOutput Text
- updateFlowOutput_outputArn :: Lens' UpdateFlowOutput Text
- data UpdateFlowOutputResponse = UpdateFlowOutputResponse' {}
- newUpdateFlowOutputResponse :: Int -> UpdateFlowOutputResponse
- updateFlowOutputResponse_flowArn :: Lens' UpdateFlowOutputResponse (Maybe Text)
- updateFlowOutputResponse_output :: Lens' UpdateFlowOutputResponse (Maybe Output)
- updateFlowOutputResponse_httpStatus :: Lens' UpdateFlowOutputResponse Int
Creating a Request
data UpdateFlowOutput Source #
The fields that you want to update in the output.
See: newUpdateFlowOutput
smart constructor.
UpdateFlowOutput' | |
|
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:
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.
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.
UpdateFlowOutput
, updateFlowOutput_destination
- The IP address where you want to send the output.
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).
UpdateFlowOutput
, updateFlowOutput_maxLatency
- The maximum latency in milliseconds. This parameter applies only to
RIST-based, Zixi-based, and Fujitsu-based streams.
UpdateFlowOutput
, updateFlowOutput_mediaStreamOutputConfigurations
- The media streams that are associated with the output, and the
parameters for those associations.
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.
UpdateFlowOutput
, updateFlowOutput_port
- The port to use when content is distributed to this output.
UpdateFlowOutput
, updateFlowOutput_protocol
- The protocol to use for the output.
UpdateFlowOutput
, updateFlowOutput_remoteId
- The remote ID for the Zixi-pull stream.
UpdateFlowOutput
, updateFlowOutput_senderControlPort
- The port that the flow uses to send outbound requests to initiate
connection with the sender.
UpdateFlowOutput
, updateFlowOutput_senderIpAddress
- The IP address that the flow communicates with to initiate connection
with the sender.
UpdateFlowOutput
, updateFlowOutput_smoothingLatency
- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC
streams.
UpdateFlowOutput
, updateFlowOutput_streamId
- The stream ID that you want to use for this transport. This parameter
applies only to Zixi-based streams.
UpdateFlowOutput
, updateFlowOutput_vpcInterfaceAttachment
- The name of the VPC interface attachment to use for this output.
UpdateFlowOutput
, updateFlowOutput_flowArn
- The flow that is associated with the output that you want to update.
UpdateFlowOutput
, updateFlowOutput_outputArn
- The ARN of the output that you want to update.
Request Lenses
updateFlowOutput_cidrAllowList :: Lens' UpdateFlowOutput (Maybe [Text]) Source #
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.
updateFlowOutput_description :: Lens' UpdateFlowOutput (Maybe Text) Source #
A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
updateFlowOutput_destination :: Lens' UpdateFlowOutput (Maybe Text) Source #
The IP address where you want to send the output.
updateFlowOutput_encryption :: Lens' UpdateFlowOutput (Maybe UpdateEncryption) Source #
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
updateFlowOutput_maxLatency :: Lens' UpdateFlowOutput (Maybe Int) Source #
The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
updateFlowOutput_mediaStreamOutputConfigurations :: Lens' UpdateFlowOutput (Maybe [MediaStreamOutputConfigurationRequest]) Source #
The media streams that are associated with the output, and the parameters for those associations.
updateFlowOutput_minLatency :: Lens' UpdateFlowOutput (Maybe Int) Source #
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.
updateFlowOutput_port :: Lens' UpdateFlowOutput (Maybe Int) Source #
The port to use when content is distributed to this output.
updateFlowOutput_protocol :: Lens' UpdateFlowOutput (Maybe Protocol) Source #
The protocol to use for the output.
updateFlowOutput_remoteId :: Lens' UpdateFlowOutput (Maybe Text) Source #
The remote ID for the Zixi-pull stream.
updateFlowOutput_senderControlPort :: Lens' UpdateFlowOutput (Maybe Int) Source #
The port that the flow uses to send outbound requests to initiate connection with the sender.
updateFlowOutput_senderIpAddress :: Lens' UpdateFlowOutput (Maybe Text) Source #
The IP address that the flow communicates with to initiate connection with the sender.
updateFlowOutput_smoothingLatency :: Lens' UpdateFlowOutput (Maybe Int) Source #
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
updateFlowOutput_streamId :: Lens' UpdateFlowOutput (Maybe Text) Source #
The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
updateFlowOutput_vpcInterfaceAttachment :: Lens' UpdateFlowOutput (Maybe VpcInterfaceAttachment) Source #
The name of the VPC interface attachment to use for this output.
updateFlowOutput_flowArn :: Lens' UpdateFlowOutput Text Source #
The flow that is associated with the output that you want to update.
updateFlowOutput_outputArn :: Lens' UpdateFlowOutput Text Source #
The ARN of the output that you want to update.
Destructuring the Response
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:
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.
Response Lenses
updateFlowOutputResponse_flowArn :: Lens' UpdateFlowOutputResponse (Maybe Text) Source #
The ARN of the flow that is associated with the updated output.
updateFlowOutputResponse_output :: Lens' UpdateFlowOutputResponse (Maybe Output) Source #
The new settings of the output that you updated.
updateFlowOutputResponse_httpStatus :: Lens' UpdateFlowOutputResponse Int Source #
The response's http status code.