amazonka-mediaconnect-2.0: Amazon MediaConnect SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MediaConnect.UpdateFlowOutput

Description

Updates an existing flow output.

Synopsis

Creating a Request

data UpdateFlowOutput Source #

The fields that you want to update in the output.

See: newUpdateFlowOutput smart constructor.

Constructors

UpdateFlowOutput' 

Fields

  • cidrAllowList :: Maybe [Text]

    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.

  • description :: Maybe Text

    A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.

  • destination :: Maybe Text

    The IP address where you want to send the output.

  • encryption :: Maybe UpdateEncryption

    The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

  • maxLatency :: Maybe Int

    The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.

  • mediaStreamOutputConfigurations :: Maybe [MediaStreamOutputConfigurationRequest]

    The media streams that are associated with the output, and the parameters for those associations.

  • minLatency :: Maybe Int

    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.

  • port :: Maybe Int

    The port to use when content is distributed to this output.

  • protocol :: Maybe Protocol

    The protocol to use for the output.

  • remoteId :: Maybe Text

    The remote ID for the Zixi-pull stream.

  • senderControlPort :: Maybe Int

    The port that the flow uses to send outbound requests to initiate connection with the sender.

  • senderIpAddress :: Maybe Text

    The IP address that the flow communicates with to initiate connection with the sender.

  • smoothingLatency :: Maybe Int

    The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.

  • streamId :: Maybe Text

    The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.

  • vpcInterfaceAttachment :: Maybe VpcInterfaceAttachment

    The name of the VPC interface attachment to use for this output.

  • flowArn :: Text

    The flow that is associated with the output that you want to update.

  • outputArn :: Text

    The ARN of the output that you want to update.

Instances

Instances details
ToJSON UpdateFlowOutput Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

ToHeaders UpdateFlowOutput Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

ToPath UpdateFlowOutput Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

ToQuery UpdateFlowOutput Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

AWSRequest UpdateFlowOutput Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

Associated Types

type AWSResponse UpdateFlowOutput #

Generic UpdateFlowOutput Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

Associated Types

type Rep UpdateFlowOutput :: Type -> Type #

Read UpdateFlowOutput Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

Show UpdateFlowOutput Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

NFData UpdateFlowOutput Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

Methods

rnf :: UpdateFlowOutput -> () #

Eq UpdateFlowOutput Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

Hashable UpdateFlowOutput Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

type AWSResponse UpdateFlowOutput Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

type Rep UpdateFlowOutput Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

type Rep UpdateFlowOutput = D1 ('MetaData "UpdateFlowOutput" "Amazonka.MediaConnect.UpdateFlowOutput" "amazonka-mediaconnect-2.0-KNF7B97aPsN1PZ2vBYFgux" 'False) (C1 ('MetaCons "UpdateFlowOutput'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "cidrAllowList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "encryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpdateEncryption)))) :*: ((S1 ('MetaSel ('Just "maxLatency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "mediaStreamOutputConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MediaStreamOutputConfigurationRequest]))) :*: (S1 ('MetaSel ('Just "minLatency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: (((S1 ('MetaSel ('Just "protocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Protocol)) :*: S1 ('MetaSel ('Just "remoteId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "senderControlPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "senderIpAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "smoothingLatency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "vpcInterfaceAttachment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcInterfaceAttachment)) :*: (S1 ('MetaSel ('Just "flowArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "outputArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newUpdateFlowOutput Source #

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.

Constructors

UpdateFlowOutputResponse' 

Fields

Instances

Instances details
Generic UpdateFlowOutputResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

Associated Types

type Rep UpdateFlowOutputResponse :: Type -> Type #

Read UpdateFlowOutputResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

Show UpdateFlowOutputResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

NFData UpdateFlowOutputResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

Eq UpdateFlowOutputResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

type Rep UpdateFlowOutputResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowOutput

type Rep UpdateFlowOutputResponse = D1 ('MetaData "UpdateFlowOutputResponse" "Amazonka.MediaConnect.UpdateFlowOutput" "amazonka-mediaconnect-2.0-KNF7B97aPsN1PZ2vBYFgux" 'False) (C1 ('MetaCons "UpdateFlowOutputResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "flowArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "output") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Output)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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.