Source: update, remove - AWS Elemental MediaConnect

Source: update, remove

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

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

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: RemoveFlowSource

Removes a source from a flow. Because a flow must have at least one source at all times, you can remove a source only from a flow that has two sources.

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 RemoveFlowSourceResponse

MediaConnect is deleting the flow.

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

{ "streamId": "string", "minLatency": integer, "vpcInterfaceName": "string", "maxLatency": integer, "description": "string", "maxBitrate": integer, "entitlementArn": "string", "mediaStreamSourceConfigurations": [ { "mediaStreamName": "string", "encodingName": enum, "inputConfigurations": [ { "inputPort": integer, "interface": { "name": "string" } } ] } ], "whitelistCidr": "string", "protocol": enum, "decryption": { "resourceId": "string", "roleArn": "string", "secretArn": "string", "constantInitializationVector": "string", "keyType": enum, "region": "string", "deviceId": "string", "url": "string", "algorithm": enum }, "ingestPort": integer, "maxSyncBuffer": integer }

Response bodies

{ "flowArn": "string", "source": { "sourceArn": "string", "vpcInterfaceName": "string", "name": "string", "description": "string", "dataTransferSubscriberFeePercent": integer, "entitlementArn": "string", "ingestIp": "string", "transport": { "protocol": enum, "streamId": "string", "minLatency": integer, "maxLatency": integer, "maxBitrate": integer, "smoothingLatency": integer, "cidrAllowList": [ "string" ], "maxSyncBuffer": integer, "remoteId": "string" }, "decryption": { "resourceId": "string", "roleArn": "string", "secretArn": "string", "constantInitializationVector": "string", "keyType": enum, "region": "string", "deviceId": "string", "url": "string", "algorithm": enum }, "ingestPort": integer, "mediaStreamSourceConfigurations": [ { "mediaStreamName": "string", "encodingName": enum, "inputConfigurations": [ { "inputIp": "string", "inputPort": integer, "interface": { "name": "string" } } ] } ], "whitelistCidr": "string" } }
{ "sourceArn": "string", "flowArn": "string" }
{ "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).

InputConfiguration

The transport parameters associated with an incoming media stream.

Property Type Required Description
inputIp

string

True

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

inputPort

integer

Format: int32

True

The port that the flow listens on for an incoming media stream.

interface

Interface

True

The VPC interface where the media stream comes in from.

InputConfigurationRequest

The transport parameters that you want to associate with an incoming media stream.

Property Type Required Description
inputPort

integer

Format: int32

True

The port that you want the flow to listen on for an incoming media stream.

interface

InterfaceRequest

True

The VPC interface that you want to use for the incoming media stream.

Interface

The VPC interface that you want to use for the media stream associated with the output.

Property Type Required Description
name

string

True

The name of the VPC interface that you want to use for the media stream associated with the output.

InterfaceRequest

The VPC interface that you want to designate where the media stream is coming from or going to.

Property Type Required Description
name

string

True

The name of the VPC interface.

MediaStreamSourceConfiguration

The media stream that is associated with the source, and the parameters for that association.

Property Type Required Description
mediaStreamName

string

True

A name that helps you distinguish one media stream from another.

encodingName

string

Values: jxsv | raw | smpte291 | pcm

True

The format that was 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.

inputConfigurations

Array of type InputConfiguration

False

The media streams that you want to associate with the source.

MediaStreamSourceConfigurationRequest

The media stream that you want to associate with the source, and the parameters for that association.

Property Type Required Description
mediaStreamName

string

True

The name of the media stream.

encodingName

string

Values: jxsv | raw | smpte291 | pcm

True

The format that was 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.

inputConfigurations

Array of type InputConfigurationRequest

False

The media streams that you want to associate with the source.

RemoveFlowSourceResponse

The result of a successful RemoveFlowSource request including the ARN of the flow, as well as the ARN of the source that was removed.

Property Type Required Description
sourceArn

string

True

The ARN of the source that you removed.

flowArn

string

True

The ARN of the flow that you removed the source from.

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.

Source

The details of the sources of the flow.

Property Type Required Description
sourceArn

string

True

The ARN of the source.

vpcInterfaceName

string

False

The name of the VPC interface that the source content comes from.

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.

dataTransferSubscriberFeePercent

integer

False

The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.

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.

mediaStreamSourceConfigurations

Array of type MediaStreamSourceConfiguration

False

The media stream that is associated with the source, and the parameters for that association.

whitelistCidr

string

False

The range of IP addresses that are allowed to contribute content to your source. Format the IP addresses as 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 | 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.

maxSyncBuffer

integer

Format: int32

False

The size of the buffer (in milliseconds) to use to sync incoming source data.

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

UpdateFlowSourceRequest

The settings for the updated source of the 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.

vpcInterfaceName

string

False

The name of the VPC interface that you want to send your output to.

maxLatency

integer

Format: int64

False

The maximum latency in milliseconds for RIST and 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 maximum bitrate for RIST, 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.

mediaStreamSourceConfigurations

Array of type MediaStreamSourceConfigurationRequest

False

The media stream that is associated with the source, and the parameters for that association.

whitelistCidr

string

False

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

protocol

string

Values: zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener

False

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

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.

maxSyncBuffer

integer

Format: int32

False

The size of the buffer (in milliseconds) to use to sync incoming source data.

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 details of the sources that are assigned to 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

RemoveFlowSource