UpdateFlowSource
Updates the source of a flow.
Request Syntax
PUT /v1/flows/flowArn
/source/sourceArn
HTTP/1.1
Content-type: application/json
{
"decryption": {
"algorithm": "string
",
"constantInitializationVector": "string
",
"deviceId": "string
",
"keyType": "string
",
"region": "string
",
"resourceId": "string
",
"roleArn": "string
",
"secretArn": "string
",
"url": "string
"
},
"description": "string
",
"entitlementArn": "string
",
"gatewayBridgeSource": {
"bridgeArn": "string
",
"vpcInterfaceAttachment": {
"vpcInterfaceName": "string
"
}
},
"ingestPort": number
,
"maxBitrate": number
,
"maxLatency": number
,
"maxSyncBuffer": number
,
"mediaStreamSourceConfigurations": [
{
"encodingName": "string
",
"inputConfigurations": [
{
"inputPort": number
,
"interface": {
"name": "string
"
}
}
],
"mediaStreamName": "string
"
}
],
"minLatency": number
,
"protocol": "string
",
"senderControlPort": number
,
"senderIpAddress": "string
",
"sourceListenerAddress": "string
",
"sourceListenerPort": number
,
"streamId": "string
",
"vpcInterfaceName": "string
",
"whitelistCidr": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
Request Body
The request accepts the following data in JSON format.
- decryption
-
The type of encryption that is used on the content ingested from the source.
Type: UpdateEncryption object
Required: No
- description
-
A description of the source. This description is not visible outside of the current AWS account.
Type: String
Required: No
- entitlementArn
-
The Amazon Resource Name (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.
Type: String
Pattern:
arn:.+:mediaconnect.+:entitlement:.+
Required: No
- gatewayBridgeSource
-
The source configuration for cloud flows receiving a stream from a bridge.
Type: UpdateGatewayBridgeSourceRequest object
Required: No
- ingestPort
-
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.
Type: Integer
Required: No
- maxBitrate
-
The maximum bitrate for RIST, RTP, and RTP-FEC streams.
Type: Long
Required: No
- maxLatency
-
The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
Type: Long
Required: No
- maxSyncBuffer
-
The size of the buffer (in milliseconds) to use to sync incoming source data.
Type: Integer
Required: No
- mediaStreamSourceConfigurations
-
The media stream that is associated with the source, and the parameters for that association.
Type: Array of MediaStreamSourceConfigurationRequest objects
Required: No
- 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: Long
Required: No
- protocol
-
The protocol that the source uses to deliver the content to MediaConnect.
Note
AWS Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
Type: String
Valid Values:
zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener | srt-caller | fujitsu-qos | udp | ndi-speed-hq
Required: No
- senderControlPort
-
The port that the flow uses to send outbound requests to initiate connection with the sender.
Type: Integer
Required: No
- senderIpAddress
-
The IP address that the flow communicates with to initiate connection with the sender.
Type: String
Required: No
- sourceListenerAddress
-
The source IP or domain name for SRT-caller protocol.
Type: String
Required: No
- sourceListenerPort
-
Source port for SRT-caller protocol.
Type: Integer
Required: No
- streamId
-
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
Type: String
Required: No
- vpcInterfaceName
-
The name of the VPC interface that you want to send your output to.
Type: String
Required: No
- whitelistCidr
-
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.
Type: String
Required: No
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"flowArn": "string",
"source": {
"dataTransferSubscriberFeePercent": number,
"decryption": {
"algorithm": "string",
"constantInitializationVector": "string",
"deviceId": "string",
"keyType": "string",
"region": "string",
"resourceId": "string",
"roleArn": "string",
"secretArn": "string",
"url": "string"
},
"description": "string",
"entitlementArn": "string",
"gatewayBridgeSource": {
"bridgeArn": "string",
"vpcInterfaceAttachment": {
"vpcInterfaceName": "string"
}
},
"ingestIp": "string",
"ingestPort": number,
"mediaStreamSourceConfigurations": [
{
"encodingName": "string",
"inputConfigurations": [
{
"inputIp": "string",
"inputPort": number,
"interface": {
"name": "string"
}
}
],
"mediaStreamName": "string"
}
],
"name": "string",
"senderControlPort": number,
"senderIpAddress": "string",
"sourceArn": "string",
"transport": {
"cidrAllowList": [ "string" ],
"maxBitrate": number,
"maxLatency": number,
"maxSyncBuffer": number,
"minLatency": number,
"ndiProgramName": "string",
"ndiSpeedHqQuality": number,
"protocol": "string",
"remoteId": "string",
"senderControlPort": number,
"senderIpAddress": "string",
"smoothingLatency": number,
"sourceListenerAddress": "string",
"sourceListenerPort": number,
"streamId": "string"
},
"vpcInterfaceName": "string",
"whitelistCidr": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
HTTP Status Code: 400
- ForbiddenException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerErrorException
-
The server encountered an internal error and is unable to complete the request.
HTTP Status Code: 500
- NotFoundException
-
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404
- ServiceUnavailableException
-
The service is currently unavailable or busy.
HTTP Status Code: 503
- TooManyRequestsException
-
The request was denied due to request throttling.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: