URI
/v1/flows/flowArn/outputs/outputArn
HTTP methods
PUT
Operation ID: UpdateFlowOutput Updates an existing flow output.
Path parameters
Name Type Required Description
flowArn String True The Amazon Resource
Name (ARN) of the flow.
outputArn String True The ARN of the output
that you want to update.
Responses
Status code Response model Description
202 UpdateFlowOutputResponse (p. 138)MediaConnect is updating the output.
Status code Response model Description
400 ResponseError (p. 139) The request that you submitted is not valid.
403 ResponseError (p. 139) You don't have the required
permissions to perform this operation.
404 ResponseError (p. 139) MediaConnect did not find the
resource that you specified in the request.
429 ResponseError (p. 139) You have exceeded the service request rate limit for your MediaConnect account.
500 ResponseError (p. 139) MediaConnect can't fulfill your request because it encountered an unexpected condition.
503 ResponseError (p. 139) MediaConnect is currently
unavailable. Try again later.
DELETE
Operation ID: RemoveFlowOutput
Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output.
Path parameters
Name Type Required Description
flowArn String True The Amazon Resource
Name (ARN) of the flow.
outputArn String True The ARN of the output
that you want to update.
Responses
Status code Response model Description
202 RemoveFlowOutputResponse (p. 139)MediaConnect is removing the output.
400 ResponseError (p. 139) The request that you submitted is not valid.
403 ResponseError (p. 139) You don't have the required
permissions to perform this operation.
Status code Response model Description
404 ResponseError (p. 139) MediaConnect did not find the
resource that you specified in the request.
429 ResponseError (p. 139) You have exceeded the service request rate limit for your MediaConnect account.
500 ResponseError (p. 139) MediaConnect can't fulfill your request because it encountered an unexpected condition.
503 ResponseError (p. 139) MediaConnect is currently
unavailable. Try again later.
Schemas
Request bodies
PUT schema
{ "mediaStreamOutputConfigurations": [ {
"encodingParameters": { "encoderProfile": enum, "compressionFactor": number },
"mediaStreamName": "string", "encodingName": enum,
"destinationConfigurations": [ {
"streamId": "string", "minLatency": integer, "destination": "string", "maxLatency": integer, "description": "string", "smoothingLatency": integer, "vpcInterfaceAttachment": { "vpcInterfaceName": "string"
}, "remoteId": "string", "senderIpAddress": "string", "protocol": enum,
"encryption": {
"resourceId": "string", "roleArn": "string", "secretArn": "string",
"constantInitializationVector": "string",
"keyType": enum, "region": "string", "deviceId": "string", "url": "string", "algorithm": enum },
"port": integer,
"senderControlPort": integer, "cidrAllowList": [
"string"
"listenerAddress": "string",
"mediaStreamOutputConfigurations": [ {
"destination": "string", "description": "string", "entitlementArn": "string", "transport": {
"senderIpAddress": "string", "protocol": enum,
"streamId": "string", "minLatency": integer,
"senderControlPort": integer, "maxLatency": integer,
"maxBitrate": integer, "smoothingLatency": integer, "cidrAllowList": [
"string"
],
"maxSyncBuffer": integer, "remoteId": "string"
},
"vpcInterfaceAttachment": { "vpcInterfaceName": "string"
},
"outputArn": "string", "encryption": {
"resourceId": "string",
"roleArn": "string", "secretArn": "string",
"constantInitializationVector": "string", "keyType": enum,
"region": "string", "deviceId": "string", "url": "string", "algorithm": enum },
"port": integer, "name": "string",
"dataTransferSubscriberFeePercent": integer, "mediaLiveInputArn": "string"
},
"flowArn": "string"
}
RemoveFlowOutputResponse schema
{ "outputArn": "string", "flowArn": "string"
}
ResponseError schema
{
"message": "string"
}
Properties
DestinationConfiguration
The definition of a media stream that is associated with the output.
destinationIp
The IP address where contents of the media stream will be sent.
Type: string Required: True
destinationPort
The port to use when the content of the media stream is distributed to the output.
Type: integer Required: True Format: int32
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 or protocol.
Type: string Required: True
interface
The VPC interface that is used for the media stream associated with the output.
Type: Interface (p. 143) Required: True
DestinationConfigurationRequest
The definition of a media stream that you want to associate with the output.
destinationIp
The IP address where you want MediaConnect to send contents of the media stream.
Type: string Required: True
destinationPort
The port that you want MediaConnect to use when it distributes the media stream to the output.
Type: integer Required: True Format: int32
interface
The VPC interface that you want to use for the media stream associated with the output.
Type: InterfaceRequest (p. 143) Required: True
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.
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.
Type: string Required: True Values: main | high
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 in the range of 3.0 to 10.0, inclusive.
Type: number Required: True Format: float
EncodingParametersRequest
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.
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.
Type: string Required: True Values: main | high
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 in the range of 3.0 to 10.0, inclusive.
Type: number Required: True Format: float
Encryption
Information about the encryption of the flow.
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.
Type: string Required: False
roleArn
The Amazon Resource Name (ARN) of the role that you created during setup (when you set up MediaConnect as a trusted entity).
Type: string Required: True
secretArn
The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
Type: string Required: False
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.
Type: string Required: False
keyType
The type of key that is used for the encryption. If you don't specify a keyType value, the service uses the default setting (static-key).
Type: string Required: False
Values: speke | static-key | srt-password
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.
Type: string Required: False
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.
Type: string Required: False
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.
Type: string Required: False
algorithm
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
Type: string Required: False
Values: aes128 | aes192 | aes256
Interface
The VPC interface that you want to use for the media stream associated with the output.
name
The name of the VPC interface that you want to use for the media stream associated with the output.
Type: string Required: True
InterfaceRequest
The VPC interface that you want to designate where the media stream is coming from or going to.
name
The name of the VPC interface.
Type: string Required: True
MediaStreamOutputConfiguration
The media stream that is associated with the output, and the parameters for that association.
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.
Type: EncodingParameters (p. 140) Required: False
mediaStreamName
A name that helps you distinguish one media stream from another.
Type: string Required: True
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 streams on sources or outputs that use the CDI protocol, set the encoding name to raw.
For video streams on sources or outputs that use the ST 2110 JPEG XS protocol, set the encoding name to jxsv.
Type: string Required: True
Values: jxsv | raw | smpte291 | pcm
destinationConfigurations
The media streams that you want to associate with the output.
Type: Array of type DestinationConfiguration (p. 139) Required: False
MediaStreamOutputConfigurationRequest
The media stream that you want to associate with the output, and the parameters for that association.
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.
Type: EncodingParametersRequest (p. 141) Required: False
mediaStreamName
The name of the media stream that is associated with the output.
Type: string Required: True
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.
Type: string Required: True
Values: jxsv | raw | smpte291 | pcm
destinationConfigurations
The media streams that you want to associate with the output.
Type: Array of type DestinationConfigurationRequest (p. 140) Required: False
Output
The settings for an 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 a pull protocol, such as Zixi pull or SRT listener.
Type: string Required: False
mediaStreamOutputConfigurations
The configuration for each media stream that is associated with the output.
Type: Array of type MediaStreamOutputConfiguration (p. 143) Required: False
destination
The IP address where you want to send the output. This field applies only to outputs that use a push protocol, such as RIST or Zixi push.
Type: string Required: False
description
A description of the output. This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.
Type: string Required: False
entitlementArn
The ARN of the entitlement on the originator's flow. This value is relevant only on entitled flows.
Type: string Required: False
transport
Attributes that are related to the transport stream.
Type: Transport (p. 147) Required: False
vpcInterfaceAttachment
The VPC interface that you want to send your output to.
Type: VpcInterfaceAttachment (p. 153) Required: False
outputArn
The ARN of the output.
Type: string Required: True
encryption
The encryption credentials that you want to use for the output.
Type: Encryption (p. 141) Required: False
port
The port to use when content is distributed to the output.
Type: integer Required: False
name
The name of the output. This value must be unique within the current flow.
Type: string Required: True
dataTransferSubscriberFeePercent
The percentage of the entitlement data transfer fee that the subscriber is responsible for.
Type: integer Required: False
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.
Type: string Required: False
RemoveFlowOutputResponse
The result of a successful RemoveFlowOutput request including the flow ARN and the output ARN that was removed.
outputArn
The ARN of the output that you removed.
Type: string Required: True
flowArn
The ARN of the flow that is associated with the output you removed.
Type: string Required: True
ResponseError
An exception raised by MediaConnect when you submit a request that cannot be completed. For more information, see the error message and documentation for the operation.
message
The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.
Type: string Required: True
Transport
Attributes that are related to the transport stream.
senderIpAddress
The IP address that the flow communicates with to initiate connection with the sender.
Type: string Required: False
protocol
The protocol that is used by the source or output.
Type: string Required: True
Values: zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener | fujitsu-qos
streamId
The stream ID that you want to use for the transport. This parameter applies only to Zixi-based streams.
Type: string Required: False
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.
Type: integer Required: False Format: int64
senderControlPort
The port that the flow uses to send outbound requests to initiate connection with the sender.
Type: integer Required: False Format: int32
maxLatency
The maximum latency in milliseconds for a RIST source, a Zixi-based source, a Fujitsu-based source, or a Zixi-based output.
Type: integer Required: False Format: int64
maxBitrate
The maximum bitrate for RIST, RTP, and RTP-FEC streams.
Type: integer Required: False Format: int64
smoothingLatency
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
Type: integer Required: False Format: int64
cidrAllowList
The range of IP addresses that are allowed to initiate output requests to this flow. Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
Type: Array of type string Required: False
maxSyncBuffer
The size of the buffer (in milliseconds) to use to sync incoming source data.
Type: integer Required: False Format: int32
remoteId
The identifier that is assigned to the Zixi receiver. This parameter applies only to outputs that use Zixi pull.
Type: string Required: False
UpdateEncryption
Information about the encryption of the flow.
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.
Type: string Required: False
roleArn
The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).
Type: string Required: False
secretArn
The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
Type: string Required: False
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.
Type: string Required: False
keyType
The type of key that is used for the encryption. If you don't specify a keyType value, the service uses the default setting (static-key).
Type: string
Required: False
Values: speke | static-key | srt-password
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.
Type: string Required: False
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.
Type: string Required: False
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.
Type: string Required: False
algorithm
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
Type: string Required: False
Values: aes128 | aes192 | aes256
UpdateFlowOutputRequest
The updates that you want to make to an existing output of an existing flow.
mediaStreamOutputConfigurations
The configuration for each media stream that is associated with the output.
Type: Array of type MediaStreamOutputConfigurationRequest (p. 144) Required: False
streamId
The stream ID that you want to use for the transport. This parameter applies only to Zixi-based streams.
Type: string Required: False
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.
Type: integer Required: False Format: int64
destination
The IP address where you want to send the output.
Type: string Required: False
maxLatency
The maximum latency in milliseconds for Zixi-based streams.
Type: integer Required: False Format: int64
description
A description of the output. This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.
Type: string Required: False
smoothingLatency
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
Type: integer Required: False Format: int64
vpcInterfaceAttachment
The VPC interface that you want to send your output to.
Type: VpcInterfaceAttachment (p. 153) Required: False
remoteId
The identifier that is assigned to the Zixi receiver. This parameter applies only to outputs that use Zixi pull.
Type: string Required: False
senderIpAddress
The IP address that the flow communicates with to initiate connection with the sender.
Type: string Required: False
protocol
The protocol to use for the output.
Type: string Required: False
Values: zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener | fujitsu-qos
encryption
The encryption credentials that you want to use for the output.
Type: UpdateEncryption (p. 149) Required: False
port
The port to use when MediaConnect distributes content to the output.
Type: integer Required: False
senderControlPort
The port that the flow uses to send outbound requests to initiate connection with the sender.
Type: integer Required: False Format: int32
cidrAllowList
The range of IP addresses that are allowed to initiate output requests to this flow. Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
Type: Array of type string Required: False
UpdateFlowOutputResponse
The result of a successful UpdateFlowOutput request including the flow ARN and the updated output.
output
The new settings of the output that you updated.
Type: Output (p. 145) Required: True
flowArn
The ARN of the flow that is associated with the updated output.
Type: string Required: True
VpcInterfaceAttachment
The VPC interface that you want to send your output to.
vpcInterfaceName
The name of the VPC interface that you want to send your output to.
Type: string Required: False
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
UpdateFlowOutput
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
RemoveFlowOutput
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3