AWS Elemental MediaConnect
API Reference

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

AWS Elemental 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

AWS Elemental MediaConnect did not find the resource that you specified in the request.

429 ResponseError

You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

500 ResponseError

AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

503 ResponseError

AWS Elemental 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

AWS Elemental 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

AWS Elemental MediaConnect did not find the resource that you specified in the request.

429 ResponseError

You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

500 ResponseError

AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

503 ResponseError

AWS Elemental MediaConnect is currently unavailable. Try again later.

Schemas

Request Bodies

Example PUT

{ "protocol": enum, "encryption": { "resourceId": "string", "roleArn": "string", "secretArn": "string", "constantInitializationVector": "string", "keyType": enum, "region": "string", "deviceId": "string", "url": "string", "algorithm": enum }, "streamId": "string", "port": integer, "destination": "string", "maxLatency": integer, "description": "string", "smoothingLatency": integer }

Response Bodies

Example UpdateFlowOutputResponse

{ "output": { "outputArn": "string", "encryption": { "resourceId": "string", "roleArn": "string", "secretArn": "string", "constantInitializationVector": "string", "keyType": enum, "region": "string", "deviceId": "string", "url": "string", "algorithm": enum }, "port": integer, "destination": "string", "name": "string", "description": "string", "entitlementArn": "string", "transport": { "protocol": enum, "streamId": "string", "maxLatency": integer, "maxBitrate": integer, "smoothingLatency": integer }, "mediaLiveInputArn": "string" }, "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 AWS Elemental 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. This parameter is required for static key encryption and is not valid for SPEKE encryption.

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

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. The API Gateway proxy must reside in the same AWS Region as AWS Elemental MediaConnect. This parameter is required for SPEKE encryption and is not valid for static key encryption.

algorithm

string

Values: aes128 | aes192 | aes256

True

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
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.

destination

string

False

The address where you want to send the output.

name

string

True

The name of the output. This value must be unique within the current flow.

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.

mediaLiveInputArn

string

False

The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that AWS Elemental MediaConnect added to send content to a MediaLive input.

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 AWS Elemental 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 AWS Elemental 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

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.

maxLatency

integer

Format: int64

False

The maximum latency in milliseconds for Zixi-based streams.

maxBitrate

integer

Format: int64

False

The smoothing max bitrate for RTP and RTP-FEC streams.

smoothingLatency

integer

Format: int64

False

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

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 AWS Elemental 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. This parameter is required for static key encryption and is not valid for SPEKE encryption.

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

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. The API Gateway proxy must reside in the same AWS Region as AWS Elemental MediaConnect. 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
protocol

string

Values: zixi-push | rtp-fec | rtp

False

The protocol to use for the output.

encryption

UpdateEncryption

False

The encryption credentials that you want to use for the output.

streamId

string

False

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

port

integer

False

The port to use when AWS Elemental MediaConnect distributes content to the output.

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 RTP and RTP-FEC streams.

UpdateFlowOutputResponse

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

Property Type Required Description
output

Output

True
flowArn

string

True

The ARN of the flow that is associated with the updated output.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

UpdateFlowOutput

RemoveFlowOutput