AWS Elemental MediaConnect
API Reference

UpdateFlowSource

URI

/v1/flows/flowArn/source/sourceArn

HTTP Methods

PUT

Operation ID: UpdateFlowSource

Updates the source of a flow.

Path Parameters

Name Type Required Description
flowArn String True

The Amazon Resource Name (ARN) of the flow.

sourceArn String True

The ARN of the source that you want to update.

Responses

Status Code Response Model Description
202 UpdateFlowSourceResponse

AWS Elemental MediaConnect is updating the source.

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, "streamId": "string", "maxLatency": integer, "description": "string", "maxBitrate": integer, "entitlementArn": "string", "decryption": { "roleArn": "string", "secretArn": "string", "keyType": enum, "algorithm": enum }, "ingestPort": integer, "whitelistCidr": "string" }

Response Bodies

Example UpdateFlowSourceResponse

{ "flowArn": "string", "source": { "sourceArn": "string", "name": "string", "description": "string", "entitlementArn": "string", "ingestIp": "string", "transport": { "protocol": enum, "streamId": "string", "maxLatency": integer, "maxBitrate": integer, "smoothingLatency": integer }, "decryption": { "roleArn": "string", "secretArn": "string", "keyType": enum, "algorithm": enum }, "ingestPort": integer, "whitelistCidr": "string" } }

Example ResponseError

{ "message": "string" }

Properties

Encryption

Information about the encryption of the flow.

Property Type Required Description
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

True

The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.

keyType

string

Values: 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).

algorithm

string

Values: aes128 | aes192 | aes256

True

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

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.

Source

The settings for the source of the flow.

Property Type Required Description
sourceArn

string

True

The ARN of the source.

name

string

True

The name of the source.

description

string

False

A description of the source. This description is not visible outside of the current AWS account.

entitlementArn

string

False

The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator’s flow.

ingestIp

string

False

The IP address that the flow listens on for incoming content.

transport

Transport

False

Attributes that are related to the transport stream.

decryption

Encryption

False

The type of encryption that is used on the content ingested from the source.

ingestPort

integer

False

The port that the flow listens on for incoming content. If the protocol of the source is Zixi, the port must be set to 2088.

whitelistCidr

string

False

The range of IP addresses that are allowed to contribute content to your source. Use the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

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

keyType

string

Values: 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).

algorithm

string

Values: aes128 | aes192 | aes256

False

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

UpdateFlowSourceRequest

The settings for the updated source of the flow.

Property Type Required Description
protocol

string

Values: zixi-push | rtp-fec | rtp

False

The protocol that the source uses to deliver the content to AWS Elemental MediaConnect.

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.

description

string

False

A description of the source. This description is not visible outside of the current AWS account.

maxBitrate

integer

Format: int64

False

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

entitlementArn

string

False

The ARN of the entitlement that allows you to subscribe to the flow. The entitlement is set by the content originator, and the ARN is generated as part of the originator's flow.

decryption

UpdateEncryption

False

The type of encryption that is used on the content ingested from the source.

ingestPort

integer

False

The port that the flow listens on for incoming content. If the protocol of the source is Zixi, the port must be set to 2088.

whitelistCidr

string

False

The range of IP addresses that are allowed to contribute content to your source. Use the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

UpdateFlowSourceResponse

The result of a successful UpdateFlowSource request. The response includes the ARN of the flow that was updated and the updated source configuration.

Property Type Required Description
flowArn

string

True

The ARN of the flow that you want to update.

source

Source

True

The settings for the source of the flow.

See Also

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

UpdateFlowSource