UpdateFlowOutput, RemoveFlowOutput

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	MediaConnect is updating the output.
400	ResponseError	The request that you submitted is not valid.
403	ResponseError	You don't have the required permissions to perform this operation.
404	ResponseError	MediaConnect did not find the resource that you specified in the request.
429	ResponseError	You have exceeded the service request rate limit for your MediaConnect account.
500	ResponseError	MediaConnect can't fulfill your request because it encountered an unexpected condition.
503	ResponseError	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	MediaConnect is removing the output.
400	ResponseError	The request that you submitted is not valid.
403	ResponseError	You don't have the required permissions to perform this operation.
404	ResponseError	MediaConnect did not find the resource that you specified in the request.
429	ResponseError	You have exceeded the service request rate limit for your MediaConnect account.
500	ResponseError	MediaConnect can't fulfill your request because it encountered an unexpected condition.
503	ResponseError	MediaConnect is currently unavailable. Try again later.

Schemas

Request Bodies

Example PUT

{
  "streamId": "string",
  "minLatency": integer,
  "destination": "string",
  "maxLatency": integer,
  "description": "string",
  "smoothingLatency": integer,
  "vpcInterfaceAttachment": {
    "vpcInterfaceName": "string"
  },
  "remoteId": "string",
  "protocol": enum,
  "encryption": {
    "resourceId": "string",
    "roleArn": "string",
    "secretArn": "string",
    "constantInitializationVector": "string",
    "keyType": enum,
    "region": "string",
    "deviceId": "string",
    "url": "string",
    "algorithm": enum
  },
  "port": integer,
  "cidrAllowList": [
    "string"
  ]
}

Response Bodies

Example UpdateFlowOutputResponse

{
  "output": {
    "listenerAddress": "string",
    "destination": "string",
    "description": "string",
    "entitlementArn": "string",
    "transport": {
      "protocol": enum,
      "streamId": "string",
      "minLatency": integer,
      "maxLatency": integer,
      "maxBitrate": integer,
      "smoothingLatency": integer,
      "cidrAllowList": [
        "string"
      ],
      "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
  },
  "flowArn": "string"
}

Example RemoveFlowOutputResponse

{
  "outputArn": "string",
  "flowArn": "string"
}

Example ResponseError

{
  "message": "string"
}

Properties

Encryption

Information about the encryption of the flow.

Property	Type	Required	Description
resourceId	string	False	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.
roleArn	string	True	The Amazon Resource Name (ARN) of the role that you created during setup (when you set up MediaConnect as a trusted entity).
secretArn	string	False	The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
constantInitializationVector	string	False	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.
keyType	string Values: speke | static-key | srt-password	False	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).
region	string	False	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.
deviceId	string	False	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.
url	string	False	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.
algorithm	string Values: aes128 | aes192 | aes256	False	The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

Output

The settings for an output.

Property	Type	Required	Description
listenerAddress	string	False	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 SRT listener or Zixi pull.
destination	string	False	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.
description	string	False	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.
entitlementArn	string	False	The ARN of the entitlement on the originator's flow. This value is relevant only on entitled flows.
transport	Transport	False	Attributes that are related to the transport stream.
vpcInterfaceAttachment	VpcInterfaceAttachment	False	The VPC interface that you want to send your output to.
outputArn	string	True	The ARN of the output.
encryption	Encryption	False	The encryption credentials that you want to use for the output.
port	integer	False	The port to use when content is distributed to the output.
name	string	True	The name of the output. This value must be unique within the current flow.
dataTransferSubscriberFeePercent	integer	False	The percentage of the entitlement data transfer fee that the subscriber is responsible for.

RemoveFlowOutputResponse

The result of a successful RemoveFlowOutput request including the flow ARN and the output ARN that was removed.

Property	Type	Required	Description
outputArn	string	True	The ARN of the output that you removed.
flowArn	string	True	The ARN of the flow that is associated with the output you removed.

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.

Property	Type	Required	Description
message	string	True	The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.

Transport

Attributes that are related to the transport stream.

Property	Type	Required	Description
protocol	string Values: zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener	True	The protocol that is used by the source or output.
streamId	string	False	The stream ID that you want to use for the transport. This parameter applies only to Zixi-based streams.
minLatency	integer Format: int64	False	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.
maxLatency	integer Format: int64	False	The maximum latency in milliseconds for a RIST source, a Zixi-based source, or a Zixi-based output.
maxBitrate	integer Format: int64	False	The maximum bitrate for RIST, RTP, and RTP-FEC streams.
smoothingLatency	integer Format: int64	False	The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
cidrAllowList	Array of type string	False	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.
remoteId	string	False	The identifier that is assigned to the Zixi receiver. This parameter applies only to outputs that use Zixi pull.

UpdateEncryption

Information about the encryption of the flow.

Property	Type	Required	Description
resourceId	string	False	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.
roleArn	string	False	The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).
secretArn	string	False	The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
constantInitializationVector	string	False	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.
keyType	string Values: speke | static-key | srt-password	False	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).
region	string	False	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.
deviceId	string	False	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.
url	string	False	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.
algorithm	string Values: aes128 | aes192 | aes256	False	The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

UpdateFlowOutputRequest

The updates that you want to make to an existing output of an existing flow.

Property	Type	Required	Description
streamId	string	False	The stream ID that you want to use for the transport. This parameter applies only to Zixi-based streams.
minLatency	integer Format: int64	False	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.
destination	string	False	The IP address where you want to send the output.
maxLatency	integer Format: int64	False	The maximum latency in milliseconds for Zixi-based streams.
description	string	False	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.
smoothingLatency	integer Format: int64	False	The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
vpcInterfaceAttachment	VpcInterfaceAttachment	False	The VPC interface that you want to send your output to.
remoteId	string	False	The identifier that is assigned to the Zixi receiver. This parameter applies only to outputs that use Zixi pull.
protocol	string Values: zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener	False	The protocol to use for the output.
encryption	UpdateEncryption	False	The encryption credentials that you want to use for the output.
port	integer	False	The port to use when MediaConnect distributes content to the output.
cidrAllowList	Array of type string	False	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.

UpdateFlowOutputResponse

The result of a successful UpdateFlowOutput request including the flow ARN and the updated output.

Property	Type	Required	Description
output	Output	True	The new settings of the output that you updated.
flowArn	string	True	The ARN of the flow that is associated with the updated output.

VpcInterfaceAttachment

The VPC interface that you want to send your output to.

Property	Type	Required	Description
vpcInterfaceName	string	False	The name of the VPC interface that you want to send your output to.

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