2023/04/13 - AWS MediaConnect - 20 new 7 updated api methods
Changes Gateway is a new feature of AWS Elemental MediaConnect. Gateway allows the deployment of on-premises resources for the purpose of transporting live video to and from the AWS Cloud.
Displays the details of a gateway. The response includes the gateway ARN, name, and CIDR blocks, as well as details about the networks.
See also: AWS API Documentation
Request Syntax
client.describe_gateway(
GatewayArn='string'
)
string
[REQUIRED] The Amazon Resource Name (ARN) of the gateway that you want to describe.
dict
Response Syntax
{
'Gateway': {
'EgressCidrBlocks': [
'string',
],
'GatewayArn': 'string',
'GatewayMessages': [
{
'Code': 'string',
'Message': 'string',
'ResourceName': 'string'
},
],
'GatewayState': 'CREATING'|'ACTIVE'|'UPDATING'|'ERROR'|'DELETING'|'DELETED',
'Name': 'string',
'Networks': [
{
'CidrBlock': 'string',
'Name': 'string'
},
]
}
}
Response Structure
(dict) -- AWS Elemental MediaConnect returned the gateway details successfully.
Gateway (dict) -- The settings for a gateway, including its networks.
EgressCidrBlocks (list) -- The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
GatewayArn (string) -- The Amazon Resource Name (ARN) of the gateway.
GatewayMessages (list) --
(dict) --
Code (string) -- The error code.
Message (string) -- The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.
ResourceName (string) -- The name of the resource.
GatewayState (string) -- The current status of the gateway.
Name (string) -- The name of the gateway. This name can not be modified after the gateway is created.
Networks (list) -- The list of networks in the gateway.
(dict) -- The network settings for a gateway.
CidrBlock (string) -- A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
Name (string) -- The name of the network. This name is used to reference the network and must be unique among networks in this gateway.
Updates an existing bridge output.
See also: AWS API Documentation
Request Syntax
client.update_bridge_output(
BridgeArn='string',
NetworkOutput={
'IpAddress': 'string',
'NetworkName': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'Ttl': 123
},
OutputName='string'
)
string
[REQUIRED] The ARN of the bridge that you want to update.
dict
Update an existing network output.
IpAddress (string) -- The network output IP Address.
NetworkName (string) -- The network output's gateway network name.
Port (integer) -- The network output port.
Protocol (string) -- The network output protocol.
Ttl (integer) -- The network output TTL.
string
[REQUIRED] The name of the bridge output that you want to update.
dict
Response Syntax
{
'BridgeArn': 'string',
'Output': {
'FlowOutput': {
'FlowArn': 'string',
'FlowSourceArn': 'string',
'Name': 'string'
},
'NetworkOutput': {
'IpAddress': 'string',
'Name': 'string',
'NetworkName': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'Ttl': 123
}
}
}
Response Structure
(dict) -- MediaConnect is updating the bridge output.
BridgeArn (string) -- The Amazon Resource Number (ARN) of the bridge.
Output (dict) -- The output that you updated.
FlowOutput (dict) -- The output of the bridge. A flow output is delivered to the AWS cloud.
FlowArn (string) -- The Amazon Resource Number (ARN) of the cloud flow.
FlowSourceArn (string) -- The Amazon Resource Number (ARN) of the flow source.
Name (string) -- The name of the bridge's output.
NetworkOutput (dict) -- The output of the bridge. A network output is delivered to your premises.
IpAddress (string) -- The network output IP Address.
Name (string) -- The network output name.
NetworkName (string) -- The network output's gateway network name.
Port (integer) -- The network output port.
Protocol (string) -- The network output protocol.
Ttl (integer) -- The network output TTL.
Removes an output from a bridge.
See also: AWS API Documentation
Request Syntax
client.remove_bridge_output(
BridgeArn='string',
OutputName='string'
)
string
[REQUIRED] The ARN of the bridge that you want to update.
string
[REQUIRED] The name of the bridge output that you want to remove.
dict
Response Syntax
{
'BridgeArn': 'string',
'OutputName': 'string'
}
Response Structure
(dict) -- The output was successfully removed from the bridge.
BridgeArn (string) --
OutputName (string) --
Updates an existing bridge source.
See also: AWS API Documentation
Request Syntax
client.update_bridge_source(
BridgeArn='string',
FlowSource={
'FlowArn': 'string',
'FlowVpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
NetworkSource={
'MulticastIp': 'string',
'NetworkName': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'
},
SourceName='string'
)
string
[REQUIRED] The ARN of the bridge that you want to update.
dict
Update the flow source of the bridge.
FlowArn (string) -- The ARN of the cloud flow to use as a source of this bridge.
FlowVpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
dict
Update the network source of the bridge.
MulticastIp (string) -- The network source multicast IP.
NetworkName (string) -- The network source's gateway network name.
Port (integer) -- The network source port.
Protocol (string) -- The network source protocol.
string
[REQUIRED] The name of the source that you want to update.
dict
Response Syntax
{
'BridgeArn': 'string',
'Source': {
'FlowSource': {
'FlowArn': 'string',
'FlowVpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'Name': 'string',
'OutputArn': 'string'
},
'NetworkSource': {
'MulticastIp': 'string',
'Name': 'string',
'NetworkName': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'
}
}
}
Response Structure
(dict) -- MediaConnect is updating the bridge source.
BridgeArn (string) -- The Amazon Resource Number (ARN) of the bridge.
Source (dict) -- The bridge's source.
FlowSource (dict) -- The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.
FlowArn (string) -- The ARN of the cloud flow used as a source of this bridge.
FlowVpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
Name (string) -- The name of the flow source.
OutputArn (string) -- The Amazon Resource Number (ARN) of the output.
NetworkSource (dict) -- The source of the bridge. A network source originates at your premises.
MulticastIp (string) -- The network source multicast IP.
Name (string) -- The name of the network source.
NetworkName (string) -- The network source's gateway network name.
Port (integer) -- The network source port.
Protocol (string) -- The network source protocol.
Deletes a gateway. Before you can delete a gateway, you must deregister its instances and delete its bridges.
See also: AWS API Documentation
Request Syntax
client.delete_gateway(
GatewayArn='string'
)
string
[REQUIRED] The ARN of the gateway that you want to delete.
dict
Response Syntax
{
'GatewayArn': 'string'
}
Response Structure
(dict) -- AWS Elemental MediaConnect deleted the gateway.
GatewayArn (string) -- The Amazon Resource Name (ARN) of the gateway that was deleted.
Displays the details of a bridge.
See also: AWS API Documentation
Request Syntax
client.describe_bridge(
BridgeArn='string'
)
string
[REQUIRED] The ARN of the bridge that you want to describe.
dict
Response Syntax
{
'Bridge': {
'BridgeArn': 'string',
'BridgeMessages': [
{
'Code': 'string',
'Message': 'string',
'ResourceName': 'string'
},
],
'BridgeState': 'CREATING'|'STANDBY'|'STARTING'|'DEPLOYING'|'ACTIVE'|'STOPPING'|'DELETING'|'DELETED'|'START_FAILED'|'START_PENDING'|'STOP_FAILED'|'UPDATING',
'EgressGatewayBridge': {
'InstanceId': 'string',
'MaxBitrate': 123
},
'IngressGatewayBridge': {
'InstanceId': 'string',
'MaxBitrate': 123,
'MaxOutputs': 123
},
'Name': 'string',
'Outputs': [
{
'FlowOutput': {
'FlowArn': 'string',
'FlowSourceArn': 'string',
'Name': 'string'
},
'NetworkOutput': {
'IpAddress': 'string',
'Name': 'string',
'NetworkName': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'Ttl': 123
}
},
],
'PlacementArn': 'string',
'SourceFailoverConfig': {
'FailoverMode': 'MERGE'|'FAILOVER',
'RecoveryWindow': 123,
'SourcePriority': {
'PrimarySource': 'string'
},
'State': 'ENABLED'|'DISABLED'
},
'Sources': [
{
'FlowSource': {
'FlowArn': 'string',
'FlowVpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'Name': 'string',
'OutputArn': 'string'
},
'NetworkSource': {
'MulticastIp': 'string',
'Name': 'string',
'NetworkName': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'
}
},
]
}
}
Response Structure
(dict) -- AWS Elemental MediaConnect returned the bridge details successfully.
Bridge (dict) -- A Bridge is the connection between your datacenter's Instances and the AWS cloud. A bridge can be used to send video from the AWS cloud to your datacenter or from your datacenter to the AWS cloud.
BridgeArn (string) -- The Amazon Resource Number (ARN) of the bridge.
BridgeMessages (list) --
(dict) --
Code (string) -- The error code.
Message (string) -- The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.
ResourceName (string) -- The name of the resource.
BridgeState (string) --
EgressGatewayBridge (dict) --
InstanceId (string) -- The ID of the instance running this bridge.
MaxBitrate (integer) -- The maximum expected bitrate (in bps) of the egress bridge.
IngressGatewayBridge (dict) --
InstanceId (string) -- The ID of the instance running this bridge.
MaxBitrate (integer) -- The maximum expected bitrate (in bps) of the ingress bridge.
MaxOutputs (integer) -- The maximum number of outputs on the ingress bridge.
Name (string) -- The name of the bridge.
Outputs (list) -- The outputs on this bridge.
(dict) -- The output of the bridge.
FlowOutput (dict) -- The output of the bridge. A flow output is delivered to the AWS cloud.
FlowArn (string) -- The Amazon Resource Number (ARN) of the cloud flow.
FlowSourceArn (string) -- The Amazon Resource Number (ARN) of the flow source.
Name (string) -- The name of the bridge's output.
NetworkOutput (dict) -- The output of the bridge. A network output is delivered to your premises.
IpAddress (string) -- The network output IP Address.
Name (string) -- The network output name.
NetworkName (string) -- The network output's gateway network name.
Port (integer) -- The network output port.
Protocol (string) -- The network output protocol.
Ttl (integer) -- The network output TTL.
PlacementArn (string) -- The placement Amazon Resource Number (ARN) of the bridge.
SourceFailoverConfig (dict) -- The settings for source failover.
FailoverMode (string) -- The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
RecoveryWindow (integer) -- Search window time to look for dash-7 packets
SourcePriority (dict) -- The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
PrimarySource (string) -- The name of the source you choose as the primary source for this flow.
State (string) --
Sources (list) -- The sources on this bridge.
(dict) -- The bridge's source.
FlowSource (dict) -- The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.
FlowArn (string) -- The ARN of the cloud flow used as a source of this bridge.
FlowVpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
Name (string) -- The name of the flow source.
OutputArn (string) -- The Amazon Resource Number (ARN) of the output.
NetworkSource (dict) -- The source of the bridge. A network source originates at your premises.
MulticastIp (string) -- The network source multicast IP.
Name (string) -- The name of the network source.
NetworkName (string) -- The network source's gateway network name.
Port (integer) -- The network source port.
Protocol (string) -- The network source protocol.
Deletes a bridge. Before you can delete a bridge, you must stop the bridge.
See also: AWS API Documentation
Request Syntax
client.delete_bridge(
BridgeArn='string'
)
string
[REQUIRED] The ARN of the bridge that you want to delete.
dict
Response Syntax
{
'BridgeArn': 'string'
}
Response Structure
(dict) -- AWS Elemental MediaConnect deleted the bridge.
BridgeArn (string) -- The Amazon Resource Number (ARN) of the deleted bridge.
Displays a list of instances associated with the AWS account. This request returns a paginated result. You can use the filterArn property to display only the instances associated with the selected Gateway Amazon Resource Name (ARN).
See also: AWS API Documentation
Request Syntax
client.list_gateway_instances(
FilterArn='string',
MaxResults=123,
NextToken='string'
)
string
Filter the list results to display only the instances associated with the selected Gateway Amazon Resource Name (ARN).
integer
The maximum number of results to return per API request. For example, you submit a ListInstances request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
string
The token that identifies which batch of results that you want to see. For example, you submit a ListInstances request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListInstances request a second time and specify the NextToken value.
dict
Response Syntax
{
'Instances': [
{
'GatewayArn': 'string',
'GatewayInstanceArn': 'string',
'InstanceId': 'string',
'InstanceState': 'REGISTERING'|'ACTIVE'|'DEREGISTERING'|'DEREGISTERED'|'REGISTRATION_ERROR'|'DEREGISTRATION_ERROR'
},
],
'NextToken': 'string'
}
Response Structure
(dict) -- AWS Elemental MediaConnect returned the list of instances in the gateway successfully.
Instances (list) -- A list of instance summaries.
(dict) -- Provides a summary of an instance.
GatewayArn (string) -- The Amazon Resource Name (ARN) of the gateway.
GatewayInstanceArn (string) -- The Amazon Resource Name (ARN) of the instance.
InstanceId (string) -- The managed instance ID generated by the SSM install. This will begin with "mi-".
InstanceState (string) -- The status of the instance.
NextToken (string) -- The token that identifies which batch of results that you want to see. For example, you submit a ListInstances request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListInstances request a second time and specify the NextToken value.
Removes a source from a bridge.
See also: AWS API Documentation
Request Syntax
client.remove_bridge_source(
BridgeArn='string',
SourceName='string'
)
string
[REQUIRED] The ARN of the bridge that you want to update.
string
[REQUIRED] The name of the bridge source that you want to remove.
dict
Response Syntax
{
'BridgeArn': 'string',
'SourceName': 'string'
}
Response Structure
(dict) -- The bridge source was successfully removed from the flow.
BridgeArn (string) --
SourceName (string) --
Updates the bridge
See also: AWS API Documentation
Request Syntax
client.update_bridge(
BridgeArn='string',
EgressGatewayBridge={
'MaxBitrate': 123
},
IngressGatewayBridge={
'MaxBitrate': 123,
'MaxOutputs': 123
},
SourceFailoverConfig={
'FailoverMode': 'MERGE'|'FAILOVER',
'RecoveryWindow': 123,
'SourcePriority': {
'PrimarySource': 'string'
},
'State': 'ENABLED'|'DISABLED'
}
)
string
[REQUIRED] The Amazon Resource Number (ARN) of the bridge that you want to update.
dict
MaxBitrate (integer) -- Update an existing egress-type bridge.
dict
MaxBitrate (integer) -- The maximum expected bitrate (in bps).
MaxOutputs (integer) -- The maximum number of expected outputs.
dict
The settings for source failover.
FailoverMode (string) -- The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
RecoveryWindow (integer) -- Recovery window time to look for dash-7 packets
SourcePriority (dict) -- The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
PrimarySource (string) -- The name of the source you choose as the primary source for this flow.
State (string) --
dict
Response Syntax
{
'Bridge': {
'BridgeArn': 'string',
'BridgeMessages': [
{
'Code': 'string',
'Message': 'string',
'ResourceName': 'string'
},
],
'BridgeState': 'CREATING'|'STANDBY'|'STARTING'|'DEPLOYING'|'ACTIVE'|'STOPPING'|'DELETING'|'DELETED'|'START_FAILED'|'START_PENDING'|'STOP_FAILED'|'UPDATING',
'EgressGatewayBridge': {
'InstanceId': 'string',
'MaxBitrate': 123
},
'IngressGatewayBridge': {
'InstanceId': 'string',
'MaxBitrate': 123,
'MaxOutputs': 123
},
'Name': 'string',
'Outputs': [
{
'FlowOutput': {
'FlowArn': 'string',
'FlowSourceArn': 'string',
'Name': 'string'
},
'NetworkOutput': {
'IpAddress': 'string',
'Name': 'string',
'NetworkName': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'Ttl': 123
}
},
],
'PlacementArn': 'string',
'SourceFailoverConfig': {
'FailoverMode': 'MERGE'|'FAILOVER',
'RecoveryWindow': 123,
'SourcePriority': {
'PrimarySource': 'string'
},
'State': 'ENABLED'|'DISABLED'
},
'Sources': [
{
'FlowSource': {
'FlowArn': 'string',
'FlowVpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'Name': 'string',
'OutputArn': 'string'
},
'NetworkSource': {
'MulticastIp': 'string',
'Name': 'string',
'NetworkName': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'
}
},
]
}
}
Response Structure
(dict) -- AWS Elemental MediaConnect updated the bridge successfully.
Bridge (dict) -- A Bridge is the connection between your datacenter's Instances and the AWS cloud. A bridge can be used to send video from the AWS cloud to your datacenter or from your datacenter to the AWS cloud.
BridgeArn (string) -- The Amazon Resource Number (ARN) of the bridge.
BridgeMessages (list) --
(dict) --
Code (string) -- The error code.
Message (string) -- The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.
ResourceName (string) -- The name of the resource.
BridgeState (string) --
EgressGatewayBridge (dict) --
InstanceId (string) -- The ID of the instance running this bridge.
MaxBitrate (integer) -- The maximum expected bitrate (in bps) of the egress bridge.
IngressGatewayBridge (dict) --
InstanceId (string) -- The ID of the instance running this bridge.
MaxBitrate (integer) -- The maximum expected bitrate (in bps) of the ingress bridge.
MaxOutputs (integer) -- The maximum number of outputs on the ingress bridge.
Name (string) -- The name of the bridge.
Outputs (list) -- The outputs on this bridge.
(dict) -- The output of the bridge.
FlowOutput (dict) -- The output of the bridge. A flow output is delivered to the AWS cloud.
FlowArn (string) -- The Amazon Resource Number (ARN) of the cloud flow.
FlowSourceArn (string) -- The Amazon Resource Number (ARN) of the flow source.
Name (string) -- The name of the bridge's output.
NetworkOutput (dict) -- The output of the bridge. A network output is delivered to your premises.
IpAddress (string) -- The network output IP Address.
Name (string) -- The network output name.
NetworkName (string) -- The network output's gateway network name.
Port (integer) -- The network output port.
Protocol (string) -- The network output protocol.
Ttl (integer) -- The network output TTL.
PlacementArn (string) -- The placement Amazon Resource Number (ARN) of the bridge.
SourceFailoverConfig (dict) -- The settings for source failover.
FailoverMode (string) -- The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
RecoveryWindow (integer) -- Search window time to look for dash-7 packets
SourcePriority (dict) -- The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
PrimarySource (string) -- The name of the source you choose as the primary source for this flow.
State (string) --
Sources (list) -- The sources on this bridge.
(dict) -- The bridge's source.
FlowSource (dict) -- The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.
FlowArn (string) -- The ARN of the cloud flow used as a source of this bridge.
FlowVpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
Name (string) -- The name of the flow source.
OutputArn (string) -- The Amazon Resource Number (ARN) of the output.
NetworkSource (dict) -- The source of the bridge. A network source originates at your premises.
MulticastIp (string) -- The network source multicast IP.
Name (string) -- The name of the network source.
NetworkName (string) -- The network source's gateway network name.
Port (integer) -- The network source port.
Protocol (string) -- The network source protocol.
Displays a list of gateways that are associated with this account. This request returns a paginated result.
See also: AWS API Documentation
Request Syntax
client.list_gateways(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of results to return per API request. For example, you submit a ListGateways request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
string
The token that identifies which batch of results that you want to see. For example, you submit a ListGateways request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListGateways request a second time and specify the NextToken value.
dict
Response Syntax
{
'Gateways': [
{
'GatewayArn': 'string',
'GatewayState': 'CREATING'|'ACTIVE'|'UPDATING'|'ERROR'|'DELETING'|'DELETED',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) -- AWS Elemental MediaConnect returned the list of gateways successfully.
Gateways (list) -- A list of gateway summaries.
(dict) -- Provides a summary of a gateway, including its name, ARN, and status.
GatewayArn (string) -- The Amazon Resource Name (ARN) of the gateway.
GatewayState (string) --
Name (string) -- The name of the gateway.
NextToken (string) -- The token that identifies which batch of results that you want to see. For example, you submit a ListGateways request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListGateways request a second time and specify the NextToken value.
Adds outputs to an existing bridge.
See also: AWS API Documentation
Request Syntax
client.add_bridge_outputs(
BridgeArn='string',
Outputs=[
{
'NetworkOutput': {
'IpAddress': 'string',
'Name': 'string',
'NetworkName': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'Ttl': 123
}
},
]
)
string
[REQUIRED] The ARN of the bridge that you want to update.
list
[REQUIRED] The outputs that you want to add to this bridge.
(dict) -- Add an output to a bridge.
NetworkOutput (dict) -- Add a network output to an existing bridge.
IpAddress (string) -- [REQUIRED] The network output IP Address.
Name (string) -- [REQUIRED] The network output name. This name is used to reference the output and must be unique among outputs in this bridge.
NetworkName (string) -- [REQUIRED] The network output's gateway network name.
Port (integer) -- [REQUIRED] The network output port.
Protocol (string) -- [REQUIRED] The network output protocol.
Ttl (integer) -- [REQUIRED] The network output TTL.
dict
Response Syntax
{
'BridgeArn': 'string',
'Outputs': [
{
'FlowOutput': {
'FlowArn': 'string',
'FlowSourceArn': 'string',
'Name': 'string'
},
'NetworkOutput': {
'IpAddress': 'string',
'Name': 'string',
'NetworkName': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'Ttl': 123
}
},
]
}
Response Structure
(dict) -- AWS Elemental MediaConnect added the bridge outputs successfully.
BridgeArn (string) -- The Amazon Resource Number (ARN) of the bridge.
Outputs (list) -- The outputs that you added to this bridge.
(dict) -- The output of the bridge.
FlowOutput (dict) -- The output of the bridge. A flow output is delivered to the AWS cloud.
FlowArn (string) -- The Amazon Resource Number (ARN) of the cloud flow.
FlowSourceArn (string) -- The Amazon Resource Number (ARN) of the flow source.
Name (string) -- The name of the bridge's output.
NetworkOutput (dict) -- The output of the bridge. A network output is delivered to your premises.
IpAddress (string) -- The network output IP Address.
Name (string) -- The network output name.
NetworkName (string) -- The network output's gateway network name.
Port (integer) -- The network output port.
Protocol (string) -- The network output protocol.
Ttl (integer) -- The network output TTL.
Updates the bridge state
See also: AWS API Documentation
Request Syntax
client.update_bridge_state(
BridgeArn='string',
DesiredState='ACTIVE'|'STANDBY'|'DELETED'
)
string
[REQUIRED] The ARN of the bridge that you want to update.
string
[REQUIRED]
dict
Response Syntax
{
'BridgeArn': 'string',
'DesiredState': 'ACTIVE'|'STANDBY'|'DELETED'
}
Response Structure
(dict) -- AWS Elemental MediaConnect updated the bridge successfully.
BridgeArn (string) -- The Amazon Resource Number (ARN) of the bridge.
DesiredState (string) -- The state of the bridge. ACTIVE or STANDBY.
Updates the configuration of an existing Gateway Instance.
See also: AWS API Documentation
Request Syntax
client.update_gateway_instance(
BridgePlacement='AVAILABLE'|'LOCKED',
GatewayInstanceArn='string'
)
string
The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be added to this instance.
string
[REQUIRED] The Amazon Resource Name (ARN) of the instance that you want to update.
dict
Response Syntax
{
'BridgePlacement': 'AVAILABLE'|'LOCKED',
'GatewayInstanceArn': 'string'
}
Response Structure
(dict) -- AWS Elemental MediaConnect is applying the instance state.
BridgePlacement (string) -- The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be added to this instance.
GatewayInstanceArn (string) -- The Amazon Resource Name (ARN) of the instance.
Adds sources to an existing bridge.
See also: AWS API Documentation
Request Syntax
client.add_bridge_sources(
BridgeArn='string',
Sources=[
{
'FlowSource': {
'FlowArn': 'string',
'FlowVpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'Name': 'string'
},
'NetworkSource': {
'MulticastIp': 'string',
'Name': 'string',
'NetworkName': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'
}
},
]
)
string
[REQUIRED] The ARN of the bridge that you want to update.
list
[REQUIRED] The sources that you want to add to this bridge.
(dict) -- Add a source to an existing bridge.
FlowSource (dict) -- Add a flow source to an existing bridge.
FlowArn (string) -- [REQUIRED] The Amazon Resource Number (ARN) of the cloud flow to use as a source of this bridge.
FlowVpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
Name (string) -- [REQUIRED] The name of the flow source. This name is used to reference the source and must be unique among sources in this bridge.
NetworkSource (dict) -- Add a network source to an existing bridge.
MulticastIp (string) -- [REQUIRED] The network source multicast IP.
Name (string) -- [REQUIRED] The name of the network source. This name is used to reference the source and must be unique among sources in this bridge.
NetworkName (string) -- [REQUIRED] The network source's gateway network name.
Port (integer) -- [REQUIRED] The network source port.
Protocol (string) -- [REQUIRED] The network source protocol.
dict
Response Syntax
{
'BridgeArn': 'string',
'Sources': [
{
'FlowSource': {
'FlowArn': 'string',
'FlowVpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'Name': 'string',
'OutputArn': 'string'
},
'NetworkSource': {
'MulticastIp': 'string',
'Name': 'string',
'NetworkName': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'
}
},
]
}
Response Structure
(dict) -- AWS Elemental MediaConnect added the bridge sources successfully.
BridgeArn (string) -- The Amazon Resource Number (ARN) of the bridge.
Sources (list) -- The sources that you added to this bridge.
(dict) -- The bridge's source.
FlowSource (dict) -- The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.
FlowArn (string) -- The ARN of the cloud flow used as a source of this bridge.
FlowVpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
Name (string) -- The name of the flow source.
OutputArn (string) -- The Amazon Resource Number (ARN) of the output.
NetworkSource (dict) -- The source of the bridge. A network source originates at your premises.
MulticastIp (string) -- The network source multicast IP.
Name (string) -- The name of the network source.
NetworkName (string) -- The network source's gateway network name.
Port (integer) -- The network source port.
Protocol (string) -- The network source protocol.
Displays a list of bridges that are associated with this account and an optionally specified Arn. This request returns a paginated result.
See also: AWS API Documentation
Request Syntax
client.list_bridges(
FilterArn='string',
MaxResults=123,
NextToken='string'
)
string
Filter the list results to display only the bridges associated with the selected Amazon Resource Name (ARN).
integer
The maximum number of results to return per API request. For example, you submit a ListBridges request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
string
The token that identifies which batch of results that you want to see. For example, you submit a ListBridges request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListBridges request a second time and specify the NextToken value.
dict
Response Syntax
{
'Bridges': [
{
'BridgeArn': 'string',
'BridgeState': 'CREATING'|'STANDBY'|'STARTING'|'DEPLOYING'|'ACTIVE'|'STOPPING'|'DELETING'|'DELETED'|'START_FAILED'|'START_PENDING'|'STOP_FAILED'|'UPDATING',
'BridgeType': 'string',
'Name': 'string',
'PlacementArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) -- AWS Elemental MediaConnect returned the list of bridges successfully.
Bridges (list) -- A list of bridge summaries.
(dict) -- Displays details of the selected bridge.
BridgeArn (string) -- The ARN of the bridge.
BridgeState (string) --
BridgeType (string) -- The type of the bridge.
Name (string) -- The name of the bridge.
PlacementArn (string) -- The ARN of the gateway associated with the bridge.
NextToken (string) -- The token that identifies which batch of results that you want to see. For example, you submit a ListBridges request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListBridges request a second time and specify the NextToken value.
Displays the details of an instance.
See also: AWS API Documentation
Request Syntax
client.describe_gateway_instance(
GatewayInstanceArn='string'
)
string
[REQUIRED] The Amazon Resource Name (ARN) of the gateway instance that you want to describe.
dict
Response Syntax
{
'GatewayInstance': {
'BridgePlacement': 'AVAILABLE'|'LOCKED',
'ConnectionStatus': 'CONNECTED'|'DISCONNECTED',
'GatewayArn': 'string',
'GatewayInstanceArn': 'string',
'InstanceId': 'string',
'InstanceMessages': [
{
'Code': 'string',
'Message': 'string',
'ResourceName': 'string'
},
],
'InstanceState': 'REGISTERING'|'ACTIVE'|'DEREGISTERING'|'DEREGISTERED'|'REGISTRATION_ERROR'|'DEREGISTRATION_ERROR',
'RunningBridgeCount': 123
}
}
Response Structure
(dict) -- AWS Elemental MediaConnect returned the instance details successfully.
GatewayInstance (dict) -- The settings for an instance in a gateway.
BridgePlacement (string) -- The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be added to this instance.
ConnectionStatus (string) -- The connection state of the instance.
GatewayArn (string) -- The Amazon Resource Name (ARN) of the instance.
GatewayInstanceArn (string) -- The Amazon Resource Name (ARN) of the gateway.
InstanceId (string) -- The managed instance ID generated by the SSM install. This will begin with "mi-".
InstanceMessages (list) --
(dict) --
Code (string) -- The error code.
Message (string) -- The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.
ResourceName (string) -- The name of the resource.
InstanceState (string) -- The status of the instance.
RunningBridgeCount (integer) -- The running bridge count.
Deregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option.
See also: AWS API Documentation
Request Syntax
client.deregister_gateway_instance(
Force=True|False,
GatewayInstanceArn='string'
)
boolean
Force the deregistration of an instance. Force will deregister an instance, even if there are bridges running on it.
string
[REQUIRED] The Amazon Resource Name (ARN) of the gateway that contains the instance that you want to deregister.
dict
Response Syntax
{
'GatewayInstanceArn': 'string',
'InstanceState': 'REGISTERING'|'ACTIVE'|'DEREGISTERING'|'DEREGISTERED'|'REGISTRATION_ERROR'|'DEREGISTRATION_ERROR'
}
Response Structure
(dict) -- AWS Elemental MediaConnect is deleting the instance.
GatewayInstanceArn (string) -- The Amazon Resource Name (ARN) of the instance.
InstanceState (string) -- The status of the instance.
Creates a new bridge. The request must include one source.
See also: AWS API Documentation
Request Syntax
client.create_bridge(
EgressGatewayBridge={
'MaxBitrate': 123
},
IngressGatewayBridge={
'MaxBitrate': 123,
'MaxOutputs': 123
},
Name='string',
Outputs=[
{
'NetworkOutput': {
'IpAddress': 'string',
'Name': 'string',
'NetworkName': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'Ttl': 123
}
},
],
PlacementArn='string',
SourceFailoverConfig={
'FailoverMode': 'MERGE'|'FAILOVER',
'RecoveryWindow': 123,
'SourcePriority': {
'PrimarySource': 'string'
},
'State': 'ENABLED'|'DISABLED'
},
Sources=[
{
'FlowSource': {
'FlowArn': 'string',
'FlowVpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'Name': 'string'
},
'NetworkSource': {
'MulticastIp': 'string',
'Name': 'string',
'NetworkName': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'
}
},
]
)
dict
Create a bridge with the egress bridge type. An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
MaxBitrate (integer) -- [REQUIRED] The maximum expected bitrate (in bps).
dict
Create a bridge with the ingress bridge type. An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
MaxBitrate (integer) -- [REQUIRED] The maximum expected bitrate (in bps).
MaxOutputs (integer) -- [REQUIRED] The maximum number of expected outputs.
string
[REQUIRED] The name of the bridge. This name can not be modified after the bridge is created.
list
The outputs that you want to add to this bridge.
(dict) -- Add an output to a bridge.
NetworkOutput (dict) -- Add a network output to an existing bridge.
IpAddress (string) -- [REQUIRED] The network output IP Address.
Name (string) -- [REQUIRED] The network output name. This name is used to reference the output and must be unique among outputs in this bridge.
NetworkName (string) -- [REQUIRED] The network output's gateway network name.
Port (integer) -- [REQUIRED] The network output port.
Protocol (string) -- [REQUIRED] The network output protocol.
Ttl (integer) -- [REQUIRED] The network output TTL.
string
[REQUIRED] The bridge placement Amazon Resource Number (ARN).
dict
The settings for source failover.
FailoverMode (string) -- The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
RecoveryWindow (integer) -- Search window time to look for dash-7 packets
SourcePriority (dict) -- The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
PrimarySource (string) -- The name of the source you choose as the primary source for this flow.
State (string) --
list
[REQUIRED] The sources that you want to add to this bridge.
(dict) -- Add a source to an existing bridge.
FlowSource (dict) -- Add a flow source to an existing bridge.
FlowArn (string) -- [REQUIRED] The Amazon Resource Number (ARN) of the cloud flow to use as a source of this bridge.
FlowVpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
Name (string) -- [REQUIRED] The name of the flow source. This name is used to reference the source and must be unique among sources in this bridge.
NetworkSource (dict) -- Add a network source to an existing bridge.
MulticastIp (string) -- [REQUIRED] The network source multicast IP.
Name (string) -- [REQUIRED] The name of the network source. This name is used to reference the source and must be unique among sources in this bridge.
NetworkName (string) -- [REQUIRED] The network source's gateway network name.
Port (integer) -- [REQUIRED] The network source port.
Protocol (string) -- [REQUIRED] The network source protocol.
dict
Response Syntax
{
'Bridge': {
'BridgeArn': 'string',
'BridgeMessages': [
{
'Code': 'string',
'Message': 'string',
'ResourceName': 'string'
},
],
'BridgeState': 'CREATING'|'STANDBY'|'STARTING'|'DEPLOYING'|'ACTIVE'|'STOPPING'|'DELETING'|'DELETED'|'START_FAILED'|'START_PENDING'|'STOP_FAILED'|'UPDATING',
'EgressGatewayBridge': {
'InstanceId': 'string',
'MaxBitrate': 123
},
'IngressGatewayBridge': {
'InstanceId': 'string',
'MaxBitrate': 123,
'MaxOutputs': 123
},
'Name': 'string',
'Outputs': [
{
'FlowOutput': {
'FlowArn': 'string',
'FlowSourceArn': 'string',
'Name': 'string'
},
'NetworkOutput': {
'IpAddress': 'string',
'Name': 'string',
'NetworkName': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'Ttl': 123
}
},
],
'PlacementArn': 'string',
'SourceFailoverConfig': {
'FailoverMode': 'MERGE'|'FAILOVER',
'RecoveryWindow': 123,
'SourcePriority': {
'PrimarySource': 'string'
},
'State': 'ENABLED'|'DISABLED'
},
'Sources': [
{
'FlowSource': {
'FlowArn': 'string',
'FlowVpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'Name': 'string',
'OutputArn': 'string'
},
'NetworkSource': {
'MulticastIp': 'string',
'Name': 'string',
'NetworkName': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'
}
},
]
}
}
Response Structure
(dict) -- AWS Elemental MediaConnect created the new bridge successfully.
Bridge (dict) -- A Bridge is the connection between your datacenter's Instances and the AWS cloud. A bridge can be used to send video from the AWS cloud to your datacenter or from your datacenter to the AWS cloud.
BridgeArn (string) -- The Amazon Resource Number (ARN) of the bridge.
BridgeMessages (list) --
(dict) --
Code (string) -- The error code.
Message (string) -- The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.
ResourceName (string) -- The name of the resource.
BridgeState (string) --
EgressGatewayBridge (dict) --
InstanceId (string) -- The ID of the instance running this bridge.
MaxBitrate (integer) -- The maximum expected bitrate (in bps) of the egress bridge.
IngressGatewayBridge (dict) --
InstanceId (string) -- The ID of the instance running this bridge.
MaxBitrate (integer) -- The maximum expected bitrate (in bps) of the ingress bridge.
MaxOutputs (integer) -- The maximum number of outputs on the ingress bridge.
Name (string) -- The name of the bridge.
Outputs (list) -- The outputs on this bridge.
(dict) -- The output of the bridge.
FlowOutput (dict) -- The output of the bridge. A flow output is delivered to the AWS cloud.
FlowArn (string) -- The Amazon Resource Number (ARN) of the cloud flow.
FlowSourceArn (string) -- The Amazon Resource Number (ARN) of the flow source.
Name (string) -- The name of the bridge's output.
NetworkOutput (dict) -- The output of the bridge. A network output is delivered to your premises.
IpAddress (string) -- The network output IP Address.
Name (string) -- The network output name.
NetworkName (string) -- The network output's gateway network name.
Port (integer) -- The network output port.
Protocol (string) -- The network output protocol.
Ttl (integer) -- The network output TTL.
PlacementArn (string) -- The placement Amazon Resource Number (ARN) of the bridge.
SourceFailoverConfig (dict) -- The settings for source failover.
FailoverMode (string) -- The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
RecoveryWindow (integer) -- Search window time to look for dash-7 packets
SourcePriority (dict) -- The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
PrimarySource (string) -- The name of the source you choose as the primary source for this flow.
State (string) --
Sources (list) -- The sources on this bridge.
(dict) -- The bridge's source.
FlowSource (dict) -- The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.
FlowArn (string) -- The ARN of the cloud flow used as a source of this bridge.
FlowVpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
Name (string) -- The name of the flow source.
OutputArn (string) -- The Amazon Resource Number (ARN) of the output.
NetworkSource (dict) -- The source of the bridge. A network source originates at your premises.
MulticastIp (string) -- The network source multicast IP.
Name (string) -- The name of the network source.
NetworkName (string) -- The network source's gateway network name.
Port (integer) -- The network source port.
Protocol (string) -- The network source protocol.
Creates a new gateway. The request must include at least one network (up to 4).
See also: AWS API Documentation
Request Syntax
client.create_gateway(
EgressCidrBlocks=[
'string',
],
Name='string',
Networks=[
{
'CidrBlock': 'string',
'Name': 'string'
},
]
)
list
[REQUIRED] The range of IP addresses that are allowed to contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
string
[REQUIRED] The name of the gateway. This name can not be modified after the gateway is created.
list
[REQUIRED] The list of networks that you want to add.
(dict) -- The network settings for a gateway.
CidrBlock (string) -- [REQUIRED] A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
Name (string) -- [REQUIRED] The name of the network. This name is used to reference the network and must be unique among networks in this gateway.
dict
Response Syntax
{
'Gateway': {
'EgressCidrBlocks': [
'string',
],
'GatewayArn': 'string',
'GatewayMessages': [
{
'Code': 'string',
'Message': 'string',
'ResourceName': 'string'
},
],
'GatewayState': 'CREATING'|'ACTIVE'|'UPDATING'|'ERROR'|'DELETING'|'DELETED',
'Name': 'string',
'Networks': [
{
'CidrBlock': 'string',
'Name': 'string'
},
]
}
}
Response Structure
(dict) -- AWS Elemental MediaConnect created the new gateway successfully.
Gateway (dict) -- The settings for a gateway, including its networks.
EgressCidrBlocks (list) -- The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
GatewayArn (string) -- The Amazon Resource Name (ARN) of the gateway.
GatewayMessages (list) --
(dict) --
Code (string) -- The error code.
Message (string) -- The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.
ResourceName (string) -- The name of the resource.
GatewayState (string) -- The current status of the gateway.
Name (string) -- The name of the gateway. This name can not be modified after the gateway is created.
Networks (list) -- The list of networks in the gateway.
(dict) -- The network settings for a gateway.
CidrBlock (string) -- A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
Name (string) -- The name of the network. This name is used to reference the network and must be unique among networks in this gateway.
{'Outputs': {'Protocol': {'udp'}}}
Response {'Outputs': {'BridgeArn': 'string',
'BridgePorts': ['integer'],
'Transport': {'Protocol': {'udp'}}}}
Adds outputs to an existing flow. You can create up to 50 outputs per flow.
See also: AWS API Documentation
Request Syntax
client.add_flow_outputs(
FlowArn='string',
Outputs=[
{
'CidrAllowList': [
'string',
],
'Description': 'string',
'Destination': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'MaxLatency': 123,
'MediaStreamOutputConfigurations': [
{
'DestinationConfigurations': [
{
'DestinationIp': 'string',
'DestinationPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'EncodingParameters': {
'CompressionFactor': 123.0,
'EncoderProfile': 'main'|'high'
},
'MediaStreamName': 'string'
},
],
'MinLatency': 123,
'Name': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'RemoteId': 'string',
'SenderControlPort': 123,
'SmoothingLatency': 123,
'StreamId': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
]
)
string
[REQUIRED] The flow that you want to add outputs to.
list
[REQUIRED] A list of outputs that you want to add.
(dict) -- The output that you want to add to this flow.
CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
Description (string) -- A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
Destination (string) -- The IP address from which video will be sent to output destinations.
Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Allowable encryption types: static-key.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MediaStreamOutputConfigurations (list) -- The media streams that are associated with the output, and the parameters for those associations.
(dict) -- The media stream that you want to associate with the output, and the parameters for that association.
DestinationConfigurations (list) -- The transport parameters that you want to associate with the media stream.
(dict) -- The transport parameters that you want to associate with an outbound media stream.
DestinationIp (string) -- [REQUIRED] The IP address where you want MediaConnect to send contents of the media stream.
DestinationPort (integer) -- [REQUIRED] The port that you want MediaConnect to use when it distributes the media stream to the output.
Interface (dict) -- [REQUIRED] The VPC interface that you want to use for the media stream associated with the output.
Name (string) -- [REQUIRED] The name of the VPC interface.
EncodingName (string) -- [REQUIRED] The format that will be 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.
EncodingParameters (dict) -- A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.
CompressionFactor (float) -- [REQUIRED] A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
EncoderProfile (string) -- [REQUIRED] A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, if at least one source on the flow uses the CDI protocol.
MediaStreamName (string) -- [REQUIRED] The name of the media stream that is associated with the output.
MinLatency (integer) -- 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.
Name (string) -- The name of the output. This value must be unique within the current flow.
Port (integer) -- The port to use when content is distributed to this output.
Protocol (string) -- [REQUIRED] The protocol to use for the output.
RemoteId (string) -- The remote ID for the Zixi-pull output stream.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this output.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
dict
Response Syntax
{
'FlowArn': 'string',
'Outputs': [
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Destination': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'ListenerAddress': 'string',
'MediaLiveInputArn': 'string',
'MediaStreamOutputConfigurations': [
{
'DestinationConfigurations': [
{
'DestinationIp': 'string',
'DestinationPort': 123,
'Interface': {
'Name': 'string'
},
'OutboundIp': 'string'
},
],
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'EncodingParameters': {
'CompressionFactor': 123.0,
'EncoderProfile': 'main'|'high'
},
'MediaStreamName': 'string'
},
],
'Name': 'string',
'OutputArn': 'string',
'Port': 123,
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'BridgeArn': 'string',
'BridgePorts': [
123,
]
},
]
}
Response Structure
(dict) -- AWS Elemental MediaConnect added the outputs successfully.
FlowArn (string) -- The ARN of the flow that these outputs were added to.
Outputs (list) -- The details of the newly added outputs.
(dict) -- The settings for an output.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) -- A description of the output.
Destination (string) -- The address where you want to send the output.
Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
EntitlementArn (string) -- The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
ListenerAddress (string) -- 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 the Zixi pull or SRT listener protocol.
MediaLiveInputArn (string) -- The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
MediaStreamOutputConfigurations (list) -- The configuration for each media stream that is associated with the output.
(dict) -- The media stream that is associated with the output, and the parameters for that association.
DestinationConfigurations (list) -- The transport parameters that are associated with each outbound media stream.
(dict) -- The transport parameters that are associated with an outbound media stream.
DestinationIp (string) -- The IP address where contents of the media stream will be sent.
DestinationPort (integer) -- The port to use when the content of the media stream is distributed to the output.
Interface (dict) -- The VPC interface that is used for the media stream associated with the output.
Name (string) -- The name of the VPC interface.
OutboundIp (string) -- The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol.
EncodingName (string) -- 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.
EncodingParameters (dict) -- Encoding parameters
CompressionFactor (float) -- A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
EncoderProfile (string) -- A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.
MediaStreamName (string) -- The name of the media stream.
Name (string) -- The name of the output. This value must be unique within the current flow.
OutputArn (string) -- The ARN of the output.
Port (integer) -- The port to use when content is distributed to this output.
Transport (dict) -- Attributes related to the transport stream that are used in the output.
CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
MinLatency (integer) -- 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.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) -- Source port for SRT-caller protocol.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this output.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
BridgeArn (string) -- The ARN of the bridge that added this output.
BridgePorts (list) -- The bridge output ports currently in use.
(integer) --
{'Sources': {'GatewayBridgeSource': {'BridgeArn': 'string',
'VpcInterfaceAttachment': {'VpcInterfaceName': 'string'}},
'Protocol': {'udp'}}}
Response {'Sources': {'GatewayBridgeSource': {'BridgeArn': 'string',
'VpcInterfaceAttachment': {'VpcInterfaceName': 'string'}},
'Transport': {'Protocol': {'udp'}}}}
Adds Sources to flow
See also: AWS API Documentation
Request Syntax
client.add_flow_sources(
FlowArn='string',
Sources=[
{
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestPort': 123,
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'MinLatency': 123,
'Name': 'string',
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
}
},
]
)
string
[REQUIRED] The flow that you want to mutate.
list
[REQUIRED] A list of sources that you want to add.
(dict) -- The settings for the source of the flow.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source. Allowable encryption types: static-key.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
MaxBitrate (integer) -- The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
(dict) -- The definition of a media stream that you want to associate with the source.
EncodingName (string) -- [REQUIRED] The format you want to use 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 (list) -- The transport parameters that you want to associate with the media stream.
(dict) -- The transport parameters that you want to associate with an incoming media stream.
InputPort (integer) -- [REQUIRED] The port that you want the flow to listen on for an incoming media stream.
Interface (dict) -- [REQUIRED] The VPC interface that you want to use for the incoming media stream.
Name (string) -- [REQUIRED] The name of the VPC interface.
MediaStreamName (string) -- [REQUIRED] The name of the media stream.
MinLatency (integer) -- 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.
Name (string) -- The name of the source.
Protocol (string) -- The protocol that is used by the source.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) -- Source port for SRT-caller protocol.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceName (string) -- The name of the VPC interface to use for this source.
WhitelistCidr (string) -- The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) -- The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) -- [REQUIRED] The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
dict
Response Syntax
{
'FlowArn': 'string',
'Sources': [
{
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputIp': 'string',
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'Name': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
}
},
]
}
Response Structure
(dict) -- AWS Elemental MediaConnect added sources to the flow successfully.
FlowArn (string) -- The ARN of the flow that these sources were added to.
Sources (list) -- The details of the newly added sources.
(dict) -- The settings for the source of the flow.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- 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) -- The IP address that the flow will be listening on for incoming content.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
(dict) -- The media stream that is associated with the source, and the parameters for that association.
EncodingName (string) -- 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 (list) -- The transport parameters that are associated with an incoming media stream.
(dict) -- The transport parameters that are associated with an incoming media stream.
InputIp (string) -- The IP address that the flow listens on for incoming content for a media stream.
InputPort (integer) -- The port that the flow listens on for an incoming media stream.
Interface (dict) -- The VPC interface where the media stream comes in from.
Name (string) -- The name of the VPC interface.
MediaStreamName (string) -- The name of the media stream.
Name (string) -- The name of the source.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SourceArn (string) -- The ARN of the source.
Transport (dict) -- Attributes related to the transport stream that are used in the source.
CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
MinLatency (integer) -- 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.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) -- Source port for SRT-caller protocol.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceName (string) -- The name of the VPC interface that is used for this source.
WhitelistCidr (string) -- The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) -- The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) -- The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
{'Outputs': {'Protocol': {'udp'}},
'Source': {'GatewayBridgeSource': {'BridgeArn': 'string',
'VpcInterfaceAttachment': {'VpcInterfaceName': 'string'}},
'Protocol': {'udp'}},
'Sources': {'GatewayBridgeSource': {'BridgeArn': 'string',
'VpcInterfaceAttachment': {'VpcInterfaceName': 'string'}},
'Protocol': {'udp'}}}
Response {'Flow': {'Outputs': {'BridgeArn': 'string',
'BridgePorts': ['integer'],
'Transport': {'Protocol': {'udp'}}},
'Source': {'GatewayBridgeSource': {'BridgeArn': 'string',
'VpcInterfaceAttachment': {'VpcInterfaceName': 'string'}},
'Transport': {'Protocol': {'udp'}}},
'Sources': {'GatewayBridgeSource': {'BridgeArn': 'string',
'VpcInterfaceAttachment': {'VpcInterfaceName': 'string'}},
'Transport': {'Protocol': {'udp'}}}}}
Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).
See also: AWS API Documentation
Request Syntax
client.create_flow(
AvailabilityZone='string',
Entitlements=[
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementStatus': 'ENABLED'|'DISABLED',
'Name': 'string',
'Subscribers': [
'string',
]
},
],
MediaStreams=[
{
'Attributes': {
'Fmtp': {
'ChannelOrder': 'string',
'Colorimetry': 'BT601'|'BT709'|'BT2020'|'BT2100'|'ST2065-1'|'ST2065-3'|'XYZ',
'ExactFramerate': 'string',
'Par': 'string',
'Range': 'NARROW'|'FULL'|'FULLPROTECT',
'ScanMode': 'progressive'|'interlace'|'progressive-segmented-frame',
'Tcs': 'SDR'|'PQ'|'HLG'|'LINEAR'|'BT2100LINPQ'|'BT2100LINHLG'|'ST2065-1'|'ST428-1'|'DENSITY'
},
'Lang': 'string'
},
'ClockRate': 123,
'Description': 'string',
'MediaStreamId': 123,
'MediaStreamName': 'string',
'MediaStreamType': 'video'|'audio'|'ancillary-data',
'VideoFormat': 'string'
},
],
Name='string',
Outputs=[
{
'CidrAllowList': [
'string',
],
'Description': 'string',
'Destination': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'MaxLatency': 123,
'MediaStreamOutputConfigurations': [
{
'DestinationConfigurations': [
{
'DestinationIp': 'string',
'DestinationPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'EncodingParameters': {
'CompressionFactor': 123.0,
'EncoderProfile': 'main'|'high'
},
'MediaStreamName': 'string'
},
],
'MinLatency': 123,
'Name': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'RemoteId': 'string',
'SenderControlPort': 123,
'SmoothingLatency': 123,
'StreamId': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
],
Source={
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestPort': 123,
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'MinLatency': 123,
'Name': 'string',
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
}
},
SourceFailoverConfig={
'FailoverMode': 'MERGE'|'FAILOVER',
'RecoveryWindow': 123,
'SourcePriority': {
'PrimarySource': 'string'
},
'State': 'ENABLED'|'DISABLED'
},
Sources=[
{
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestPort': 123,
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'MinLatency': 123,
'Name': 'string',
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
}
},
],
VpcInterfaces=[
{
'Name': 'string',
'NetworkInterfaceType': 'ena'|'efa',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
},
],
Maintenance={
'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
'MaintenanceStartHour': 'string'
}
)
string
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region.
list
The entitlements that you want to grant on a flow.
(dict) -- The entitlements that you want to grant on a flow.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) -- A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
Encryption (dict) -- The type of encryption that will be used on the output that is associated with this entitlement. Allowable encryption types: static-key, speke.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
EntitlementStatus (string) -- An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.
Name (string) -- The name of the entitlement. This value must be unique within the current flow.
Subscribers (list) -- [REQUIRED] The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source.
(string) --
list
The media streams that you want to add to the flow. You can associate these media streams with sources and outputs on the flow.
(dict) -- The media stream that you want to add to the flow.
Attributes (dict) -- The attributes that you want to assign to the new media stream.
Fmtp (dict) -- The settings that you want to use to define the media stream.
ChannelOrder (string) -- The format of the audio channel.
Colorimetry (string) -- The format that is used for the representation of color.
ExactFramerate (string) -- The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
Par (string) -- The pixel aspect ratio (PAR) of the video.
Range (string) -- The encoding range of the video.
ScanMode (string) -- The type of compression that was used to smooth the video’s appearance.
Tcs (string) -- The transfer characteristic system (TCS) that is used in the video.
Lang (string) -- The audio language, in a format that is recognized by the receiver.
ClockRate (integer) -- The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.
Description (string) -- A description that can help you quickly identify what your media stream is used for.
MediaStreamId (integer) -- [REQUIRED] A unique identifier for the media stream.
MediaStreamName (string) -- [REQUIRED] A name that helps you distinguish one media stream from another.
MediaStreamType (string) -- [REQUIRED] The type of media stream.
VideoFormat (string) -- The resolution of the video.
string
[REQUIRED] The name of the flow.
list
The outputs that you want to add to this flow.
(dict) -- The output that you want to add to this flow.
CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
Description (string) -- A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
Destination (string) -- The IP address from which video will be sent to output destinations.
Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Allowable encryption types: static-key.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MediaStreamOutputConfigurations (list) -- The media streams that are associated with the output, and the parameters for those associations.
(dict) -- The media stream that you want to associate with the output, and the parameters for that association.
DestinationConfigurations (list) -- The transport parameters that you want to associate with the media stream.
(dict) -- The transport parameters that you want to associate with an outbound media stream.
DestinationIp (string) -- [REQUIRED] The IP address where you want MediaConnect to send contents of the media stream.
DestinationPort (integer) -- [REQUIRED] The port that you want MediaConnect to use when it distributes the media stream to the output.
Interface (dict) -- [REQUIRED] The VPC interface that you want to use for the media stream associated with the output.
Name (string) -- [REQUIRED] The name of the VPC interface.
EncodingName (string) -- [REQUIRED] The format that will be 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.
EncodingParameters (dict) -- A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.
CompressionFactor (float) -- [REQUIRED] A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
EncoderProfile (string) -- [REQUIRED] A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, if at least one source on the flow uses the CDI protocol.
MediaStreamName (string) -- [REQUIRED] The name of the media stream that is associated with the output.
MinLatency (integer) -- 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.
Name (string) -- The name of the output. This value must be unique within the current flow.
Port (integer) -- The port to use when content is distributed to this output.
Protocol (string) -- [REQUIRED] The protocol to use for the output.
RemoteId (string) -- The remote ID for the Zixi-pull output stream.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this output.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
dict
The settings for the source of the flow.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source. Allowable encryption types: static-key.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
MaxBitrate (integer) -- The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
(dict) -- The definition of a media stream that you want to associate with the source.
EncodingName (string) -- [REQUIRED] The format you want to use 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 (list) -- The transport parameters that you want to associate with the media stream.
(dict) -- The transport parameters that you want to associate with an incoming media stream.
InputPort (integer) -- [REQUIRED] The port that you want the flow to listen on for an incoming media stream.
Interface (dict) -- [REQUIRED] The VPC interface that you want to use for the incoming media stream.
Name (string) -- [REQUIRED] The name of the VPC interface.
MediaStreamName (string) -- [REQUIRED] The name of the media stream.
MinLatency (integer) -- 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.
Name (string) -- The name of the source.
Protocol (string) -- The protocol that is used by the source.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) -- Source port for SRT-caller protocol.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceName (string) -- The name of the VPC interface to use for this source.
WhitelistCidr (string) -- The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) -- The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) -- [REQUIRED] The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
dict
The settings for source failover.
FailoverMode (string) -- The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
RecoveryWindow (integer) -- Search window time to look for dash-7 packets
SourcePriority (dict) -- The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
PrimarySource (string) -- The name of the source you choose as the primary source for this flow.
State (string) --
list
(dict) -- The settings for the source of the flow.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source. Allowable encryption types: static-key.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
MaxBitrate (integer) -- The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
(dict) -- The definition of a media stream that you want to associate with the source.
EncodingName (string) -- [REQUIRED] The format you want to use 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 (list) -- The transport parameters that you want to associate with the media stream.
(dict) -- The transport parameters that you want to associate with an incoming media stream.
InputPort (integer) -- [REQUIRED] The port that you want the flow to listen on for an incoming media stream.
Interface (dict) -- [REQUIRED] The VPC interface that you want to use for the incoming media stream.
Name (string) -- [REQUIRED] The name of the VPC interface.
MediaStreamName (string) -- [REQUIRED] The name of the media stream.
MinLatency (integer) -- 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.
Name (string) -- The name of the source.
Protocol (string) -- The protocol that is used by the source.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) -- Source port for SRT-caller protocol.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceName (string) -- The name of the VPC interface to use for this source.
WhitelistCidr (string) -- The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) -- The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) -- [REQUIRED] The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
list
The VPC interfaces you want on the flow.
(dict) -- Desired VPC Interface for a Flow
Name (string) -- [REQUIRED] The name of the VPC Interface. This value must be unique within the current flow.
NetworkInterfaceType (string) -- The type of network interface. If this value is not included in the request, MediaConnect uses ENA as the networkInterfaceType.
RoleArn (string) -- [REQUIRED] Role Arn MediaConnect can assumes to create ENIs in customer's account
SecurityGroupIds (list) -- [REQUIRED] Security Group IDs to be used on ENI.
(string) --
SubnetId (string) -- [REQUIRED] Subnet must be in the AZ of the Flow
dict
Create maintenance setting for a flow
MaintenanceDay (string) -- [REQUIRED] A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
MaintenanceStartHour (string) -- [REQUIRED] UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
dict
Response Syntax
{
'Flow': {
'AvailabilityZone': 'string',
'Description': 'string',
'EgressIp': 'string',
'Entitlements': [
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'EntitlementStatus': 'ENABLED'|'DISABLED',
'Name': 'string',
'Subscribers': [
'string',
]
},
],
'FlowArn': 'string',
'MediaStreams': [
{
'Attributes': {
'Fmtp': {
'ChannelOrder': 'string',
'Colorimetry': 'BT601'|'BT709'|'BT2020'|'BT2100'|'ST2065-1'|'ST2065-3'|'XYZ',
'ExactFramerate': 'string',
'Par': 'string',
'Range': 'NARROW'|'FULL'|'FULLPROTECT',
'ScanMode': 'progressive'|'interlace'|'progressive-segmented-frame',
'Tcs': 'SDR'|'PQ'|'HLG'|'LINEAR'|'BT2100LINPQ'|'BT2100LINHLG'|'ST2065-1'|'ST428-1'|'DENSITY'
},
'Lang': 'string'
},
'ClockRate': 123,
'Description': 'string',
'Fmt': 123,
'MediaStreamId': 123,
'MediaStreamName': 'string',
'MediaStreamType': 'video'|'audio'|'ancillary-data',
'VideoFormat': 'string'
},
],
'Name': 'string',
'Outputs': [
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Destination': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'ListenerAddress': 'string',
'MediaLiveInputArn': 'string',
'MediaStreamOutputConfigurations': [
{
'DestinationConfigurations': [
{
'DestinationIp': 'string',
'DestinationPort': 123,
'Interface': {
'Name': 'string'
},
'OutboundIp': 'string'
},
],
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'EncodingParameters': {
'CompressionFactor': 123.0,
'EncoderProfile': 'main'|'high'
},
'MediaStreamName': 'string'
},
],
'Name': 'string',
'OutputArn': 'string',
'Port': 123,
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'BridgeArn': 'string',
'BridgePorts': [
123,
]
},
],
'Source': {
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputIp': 'string',
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'Name': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
}
},
'SourceFailoverConfig': {
'FailoverMode': 'MERGE'|'FAILOVER',
'RecoveryWindow': 123,
'SourcePriority': {
'PrimarySource': 'string'
},
'State': 'ENABLED'|'DISABLED'
},
'Sources': [
{
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputIp': 'string',
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'Name': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
}
},
],
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
'VpcInterfaces': [
{
'Name': 'string',
'NetworkInterfaceIds': [
'string',
],
'NetworkInterfaceType': 'ena'|'efa',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
},
],
'Maintenance': {
'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
'MaintenanceDeadline': 'string',
'MaintenanceScheduledDate': 'string',
'MaintenanceStartHour': 'string'
}
}
}
Response Structure
(dict) -- AWS Elemental MediaConnect created the new flow successfully.
Flow (dict) -- The settings for a flow, including its source, outputs, and entitlements.
AvailabilityZone (string) -- The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
Description (string) -- A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EgressIp (string) -- The IP address from which video will be sent to output destinations.
Entitlements (list) -- The entitlements in this flow.
(dict) -- The settings for a flow entitlement.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) -- A description of the entitlement.
Encryption (dict) -- The type of encryption that will be used on the output that is associated with this entitlement.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
EntitlementArn (string) -- The ARN of the entitlement.
EntitlementStatus (string) -- An indication of whether the entitlement is enabled.
Name (string) -- The name of the entitlement.
Subscribers (list) -- The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
(string) --
FlowArn (string) -- The Amazon Resource Name (ARN) of the flow.
MediaStreams (list) -- The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
(dict) -- A single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams.
Attributes (dict) -- Attributes that are related to the media stream.
Fmtp (dict) -- A set of parameters that define the media stream.
ChannelOrder (string) -- The format of the audio channel.
Colorimetry (string) -- The format that is used for the representation of color.
ExactFramerate (string) -- The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
Par (string) -- The pixel aspect ratio (PAR) of the video.
Range (string) -- The encoding range of the video.
ScanMode (string) -- The type of compression that was used to smooth the video’s appearance
Tcs (string) -- The transfer characteristic system (TCS) that is used in the video.
Lang (string) -- The audio language, in a format that is recognized by the receiver.
ClockRate (integer) -- The sample rate for the stream. This value is measured in Hz.
Description (string) -- A description that can help you quickly identify what your media stream is used for.
Fmt (integer) -- The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.
MediaStreamId (integer) -- A unique identifier for the media stream.
MediaStreamName (string) -- A name that helps you distinguish one media stream from another.
MediaStreamType (string) -- The type of media stream.
VideoFormat (string) -- The resolution of the video.
Name (string) -- The name of the flow.
Outputs (list) -- The outputs in this flow.
(dict) -- The settings for an output.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) -- A description of the output.
Destination (string) -- The address where you want to send the output.
Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
EntitlementArn (string) -- The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
ListenerAddress (string) -- 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 the Zixi pull or SRT listener protocol.
MediaLiveInputArn (string) -- The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
MediaStreamOutputConfigurations (list) -- The configuration for each media stream that is associated with the output.
(dict) -- The media stream that is associated with the output, and the parameters for that association.
DestinationConfigurations (list) -- The transport parameters that are associated with each outbound media stream.
(dict) -- The transport parameters that are associated with an outbound media stream.
DestinationIp (string) -- The IP address where contents of the media stream will be sent.
DestinationPort (integer) -- The port to use when the content of the media stream is distributed to the output.
Interface (dict) -- The VPC interface that is used for the media stream associated with the output.
Name (string) -- The name of the VPC interface.
OutboundIp (string) -- The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol.
EncodingName (string) -- 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.
EncodingParameters (dict) -- Encoding parameters
CompressionFactor (float) -- A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
EncoderProfile (string) -- A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.
MediaStreamName (string) -- The name of the media stream.
Name (string) -- The name of the output. This value must be unique within the current flow.
OutputArn (string) -- The ARN of the output.
Port (integer) -- The port to use when content is distributed to this output.
Transport (dict) -- Attributes related to the transport stream that are used in the output.
CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
MinLatency (integer) -- 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.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) -- Source port for SRT-caller protocol.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this output.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
BridgeArn (string) -- The ARN of the bridge that added this output.
BridgePorts (list) -- The bridge output ports currently in use.
(integer) --
Source (dict) -- The settings for the source of the flow.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- 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) -- The IP address that the flow will be listening on for incoming content.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
(dict) -- The media stream that is associated with the source, and the parameters for that association.
EncodingName (string) -- 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 (list) -- The transport parameters that are associated with an incoming media stream.
(dict) -- The transport parameters that are associated with an incoming media stream.
InputIp (string) -- The IP address that the flow listens on for incoming content for a media stream.
InputPort (integer) -- The port that the flow listens on for an incoming media stream.
Interface (dict) -- The VPC interface where the media stream comes in from.
Name (string) -- The name of the VPC interface.
MediaStreamName (string) -- The name of the media stream.
Name (string) -- The name of the source.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SourceArn (string) -- The ARN of the source.
Transport (dict) -- Attributes related to the transport stream that are used in the source.
CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
MinLatency (integer) -- 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.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) -- Source port for SRT-caller protocol.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceName (string) -- The name of the VPC interface that is used for this source.
WhitelistCidr (string) -- The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) -- The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) -- The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
SourceFailoverConfig (dict) -- The settings for source failover.
FailoverMode (string) -- The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
RecoveryWindow (integer) -- Search window time to look for dash-7 packets
SourcePriority (dict) -- The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
PrimarySource (string) -- The name of the source you choose as the primary source for this flow.
State (string) --
Sources (list) --
(dict) -- The settings for the source of the flow.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- 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) -- The IP address that the flow will be listening on for incoming content.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
(dict) -- The media stream that is associated with the source, and the parameters for that association.
EncodingName (string) -- 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 (list) -- The transport parameters that are associated with an incoming media stream.
(dict) -- The transport parameters that are associated with an incoming media stream.
InputIp (string) -- The IP address that the flow listens on for incoming content for a media stream.
InputPort (integer) -- The port that the flow listens on for an incoming media stream.
Interface (dict) -- The VPC interface where the media stream comes in from.
Name (string) -- The name of the VPC interface.
MediaStreamName (string) -- The name of the media stream.
Name (string) -- The name of the source.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SourceArn (string) -- The ARN of the source.
Transport (dict) -- Attributes related to the transport stream that are used in the source.
CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
MinLatency (integer) -- 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.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) -- Source port for SRT-caller protocol.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceName (string) -- The name of the VPC interface that is used for this source.
WhitelistCidr (string) -- The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) -- The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) -- The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
Status (string) -- The current status of the flow.
VpcInterfaces (list) -- The VPC Interfaces for this flow.
(dict) -- The settings for a VPC Source.
Name (string) -- Immutable and has to be a unique against other VpcInterfaces in this Flow.
NetworkInterfaceIds (list) -- IDs of the network interfaces created in customer's account by MediaConnect.
(string) --
NetworkInterfaceType (string) -- The type of network interface.
RoleArn (string) -- Role Arn MediaConnect can assumes to create ENIs in customer's account
SecurityGroupIds (list) -- Security Group IDs to be used on ENI.
(string) --
SubnetId (string) -- Subnet must be in the AZ of the Flow
Maintenance (dict) -- The maintenance setting of a flow
MaintenanceDay (string) -- A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
MaintenanceDeadline (string) -- The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.
MaintenanceScheduledDate (string) -- A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
MaintenanceStartHour (string) -- UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
{'Flow': {'Outputs': {'BridgeArn': 'string',
'BridgePorts': ['integer'],
'Transport': {'Protocol': {'udp'}}},
'Source': {'GatewayBridgeSource': {'BridgeArn': 'string',
'VpcInterfaceAttachment': {'VpcInterfaceName': 'string'}},
'Transport': {'Protocol': {'udp'}}},
'Sources': {'GatewayBridgeSource': {'BridgeArn': 'string',
'VpcInterfaceAttachment': {'VpcInterfaceName': 'string'}},
'Transport': {'Protocol': {'udp'}}}}}
Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements.
See also: AWS API Documentation
Request Syntax
client.describe_flow(
FlowArn='string'
)
string
[REQUIRED] The ARN of the flow that you want to describe.
dict
Response Syntax
{
'Flow': {
'AvailabilityZone': 'string',
'Description': 'string',
'EgressIp': 'string',
'Entitlements': [
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'EntitlementStatus': 'ENABLED'|'DISABLED',
'Name': 'string',
'Subscribers': [
'string',
]
},
],
'FlowArn': 'string',
'MediaStreams': [
{
'Attributes': {
'Fmtp': {
'ChannelOrder': 'string',
'Colorimetry': 'BT601'|'BT709'|'BT2020'|'BT2100'|'ST2065-1'|'ST2065-3'|'XYZ',
'ExactFramerate': 'string',
'Par': 'string',
'Range': 'NARROW'|'FULL'|'FULLPROTECT',
'ScanMode': 'progressive'|'interlace'|'progressive-segmented-frame',
'Tcs': 'SDR'|'PQ'|'HLG'|'LINEAR'|'BT2100LINPQ'|'BT2100LINHLG'|'ST2065-1'|'ST428-1'|'DENSITY'
},
'Lang': 'string'
},
'ClockRate': 123,
'Description': 'string',
'Fmt': 123,
'MediaStreamId': 123,
'MediaStreamName': 'string',
'MediaStreamType': 'video'|'audio'|'ancillary-data',
'VideoFormat': 'string'
},
],
'Name': 'string',
'Outputs': [
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Destination': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'ListenerAddress': 'string',
'MediaLiveInputArn': 'string',
'MediaStreamOutputConfigurations': [
{
'DestinationConfigurations': [
{
'DestinationIp': 'string',
'DestinationPort': 123,
'Interface': {
'Name': 'string'
},
'OutboundIp': 'string'
},
],
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'EncodingParameters': {
'CompressionFactor': 123.0,
'EncoderProfile': 'main'|'high'
},
'MediaStreamName': 'string'
},
],
'Name': 'string',
'OutputArn': 'string',
'Port': 123,
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'BridgeArn': 'string',
'BridgePorts': [
123,
]
},
],
'Source': {
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputIp': 'string',
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'Name': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
}
},
'SourceFailoverConfig': {
'FailoverMode': 'MERGE'|'FAILOVER',
'RecoveryWindow': 123,
'SourcePriority': {
'PrimarySource': 'string'
},
'State': 'ENABLED'|'DISABLED'
},
'Sources': [
{
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputIp': 'string',
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'Name': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
}
},
],
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
'VpcInterfaces': [
{
'Name': 'string',
'NetworkInterfaceIds': [
'string',
],
'NetworkInterfaceType': 'ena'|'efa',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
},
],
'Maintenance': {
'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
'MaintenanceDeadline': 'string',
'MaintenanceScheduledDate': 'string',
'MaintenanceStartHour': 'string'
}
},
'Messages': {
'Errors': [
'string',
]
}
}
Response Structure
(dict) -- AWS Elemental MediaConnect returned the flow details successfully.
Flow (dict) -- The settings for a flow, including its source, outputs, and entitlements.
AvailabilityZone (string) -- The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
Description (string) -- A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EgressIp (string) -- The IP address from which video will be sent to output destinations.
Entitlements (list) -- The entitlements in this flow.
(dict) -- The settings for a flow entitlement.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) -- A description of the entitlement.
Encryption (dict) -- The type of encryption that will be used on the output that is associated with this entitlement.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
EntitlementArn (string) -- The ARN of the entitlement.
EntitlementStatus (string) -- An indication of whether the entitlement is enabled.
Name (string) -- The name of the entitlement.
Subscribers (list) -- The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
(string) --
FlowArn (string) -- The Amazon Resource Name (ARN) of the flow.
MediaStreams (list) -- The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
(dict) -- A single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams.
Attributes (dict) -- Attributes that are related to the media stream.
Fmtp (dict) -- A set of parameters that define the media stream.
ChannelOrder (string) -- The format of the audio channel.
Colorimetry (string) -- The format that is used for the representation of color.
ExactFramerate (string) -- The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
Par (string) -- The pixel aspect ratio (PAR) of the video.
Range (string) -- The encoding range of the video.
ScanMode (string) -- The type of compression that was used to smooth the video’s appearance
Tcs (string) -- The transfer characteristic system (TCS) that is used in the video.
Lang (string) -- The audio language, in a format that is recognized by the receiver.
ClockRate (integer) -- The sample rate for the stream. This value is measured in Hz.
Description (string) -- A description that can help you quickly identify what your media stream is used for.
Fmt (integer) -- The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.
MediaStreamId (integer) -- A unique identifier for the media stream.
MediaStreamName (string) -- A name that helps you distinguish one media stream from another.
MediaStreamType (string) -- The type of media stream.
VideoFormat (string) -- The resolution of the video.
Name (string) -- The name of the flow.
Outputs (list) -- The outputs in this flow.
(dict) -- The settings for an output.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) -- A description of the output.
Destination (string) -- The address where you want to send the output.
Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
EntitlementArn (string) -- The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
ListenerAddress (string) -- 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 the Zixi pull or SRT listener protocol.
MediaLiveInputArn (string) -- The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
MediaStreamOutputConfigurations (list) -- The configuration for each media stream that is associated with the output.
(dict) -- The media stream that is associated with the output, and the parameters for that association.
DestinationConfigurations (list) -- The transport parameters that are associated with each outbound media stream.
(dict) -- The transport parameters that are associated with an outbound media stream.
DestinationIp (string) -- The IP address where contents of the media stream will be sent.
DestinationPort (integer) -- The port to use when the content of the media stream is distributed to the output.
Interface (dict) -- The VPC interface that is used for the media stream associated with the output.
Name (string) -- The name of the VPC interface.
OutboundIp (string) -- The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol.
EncodingName (string) -- 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.
EncodingParameters (dict) -- Encoding parameters
CompressionFactor (float) -- A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
EncoderProfile (string) -- A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.
MediaStreamName (string) -- The name of the media stream.
Name (string) -- The name of the output. This value must be unique within the current flow.
OutputArn (string) -- The ARN of the output.
Port (integer) -- The port to use when content is distributed to this output.
Transport (dict) -- Attributes related to the transport stream that are used in the output.
CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
MinLatency (integer) -- 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.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) -- Source port for SRT-caller protocol.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this output.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
BridgeArn (string) -- The ARN of the bridge that added this output.
BridgePorts (list) -- The bridge output ports currently in use.
(integer) --
Source (dict) -- The settings for the source of the flow.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- 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) -- The IP address that the flow will be listening on for incoming content.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
(dict) -- The media stream that is associated with the source, and the parameters for that association.
EncodingName (string) -- 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 (list) -- The transport parameters that are associated with an incoming media stream.
(dict) -- The transport parameters that are associated with an incoming media stream.
InputIp (string) -- The IP address that the flow listens on for incoming content for a media stream.
InputPort (integer) -- The port that the flow listens on for an incoming media stream.
Interface (dict) -- The VPC interface where the media stream comes in from.
Name (string) -- The name of the VPC interface.
MediaStreamName (string) -- The name of the media stream.
Name (string) -- The name of the source.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SourceArn (string) -- The ARN of the source.
Transport (dict) -- Attributes related to the transport stream that are used in the source.
CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
MinLatency (integer) -- 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.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) -- Source port for SRT-caller protocol.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceName (string) -- The name of the VPC interface that is used for this source.
WhitelistCidr (string) -- The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) -- The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) -- The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
SourceFailoverConfig (dict) -- The settings for source failover.
FailoverMode (string) -- The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
RecoveryWindow (integer) -- Search window time to look for dash-7 packets
SourcePriority (dict) -- The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
PrimarySource (string) -- The name of the source you choose as the primary source for this flow.
State (string) --
Sources (list) --
(dict) -- The settings for the source of the flow.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- 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) -- The IP address that the flow will be listening on for incoming content.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
(dict) -- The media stream that is associated with the source, and the parameters for that association.
EncodingName (string) -- 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 (list) -- The transport parameters that are associated with an incoming media stream.
(dict) -- The transport parameters that are associated with an incoming media stream.
InputIp (string) -- The IP address that the flow listens on for incoming content for a media stream.
InputPort (integer) -- The port that the flow listens on for an incoming media stream.
Interface (dict) -- The VPC interface where the media stream comes in from.
Name (string) -- The name of the VPC interface.
MediaStreamName (string) -- The name of the media stream.
Name (string) -- The name of the source.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SourceArn (string) -- The ARN of the source.
Transport (dict) -- Attributes related to the transport stream that are used in the source.
CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
MinLatency (integer) -- 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.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) -- Source port for SRT-caller protocol.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceName (string) -- The name of the VPC interface that is used for this source.
WhitelistCidr (string) -- The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) -- The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) -- The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
Status (string) -- The current status of the flow.
VpcInterfaces (list) -- The VPC Interfaces for this flow.
(dict) -- The settings for a VPC Source.
Name (string) -- Immutable and has to be a unique against other VpcInterfaces in this Flow.
NetworkInterfaceIds (list) -- IDs of the network interfaces created in customer's account by MediaConnect.
(string) --
NetworkInterfaceType (string) -- The type of network interface.
RoleArn (string) -- Role Arn MediaConnect can assumes to create ENIs in customer's account
SecurityGroupIds (list) -- Security Group IDs to be used on ENI.
(string) --
SubnetId (string) -- Subnet must be in the AZ of the Flow
Maintenance (dict) -- The maintenance setting of a flow
MaintenanceDay (string) -- A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
MaintenanceDeadline (string) -- The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.
MaintenanceScheduledDate (string) -- A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
MaintenanceStartHour (string) -- UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
Messages (dict) -- Messages that provide the state of the flow.
Errors (list) -- A list of errors that might have been generated from processes on this flow.
(string) --
{'Flow': {'Outputs': {'BridgeArn': 'string',
'BridgePorts': ['integer'],
'Transport': {'Protocol': {'udp'}}},
'Source': {'GatewayBridgeSource': {'BridgeArn': 'string',
'VpcInterfaceAttachment': {'VpcInterfaceName': 'string'}},
'Transport': {'Protocol': {'udp'}}},
'Sources': {'GatewayBridgeSource': {'BridgeArn': 'string',
'VpcInterfaceAttachment': {'VpcInterfaceName': 'string'}},
'Transport': {'Protocol': {'udp'}}}}}
Updates flow
See also: AWS API Documentation
Request Syntax
client.update_flow(
FlowArn='string',
SourceFailoverConfig={
'FailoverMode': 'MERGE'|'FAILOVER',
'RecoveryWindow': 123,
'SourcePriority': {
'PrimarySource': 'string'
},
'State': 'ENABLED'|'DISABLED'
},
Maintenance={
'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
'MaintenanceScheduledDate': 'string',
'MaintenanceStartHour': 'string'
}
)
string
[REQUIRED] The flow that you want to update.
dict
The settings for source failover.
FailoverMode (string) -- The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
RecoveryWindow (integer) -- Recovery window time to look for dash-7 packets
SourcePriority (dict) -- The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
PrimarySource (string) -- The name of the source you choose as the primary source for this flow.
State (string) --
dict
Update maintenance setting for a flow
MaintenanceDay (string) -- A day of a week when the maintenance will happen. use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
MaintenanceScheduledDate (string) -- A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
MaintenanceStartHour (string) -- UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
dict
Response Syntax
{
'Flow': {
'AvailabilityZone': 'string',
'Description': 'string',
'EgressIp': 'string',
'Entitlements': [
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'EntitlementStatus': 'ENABLED'|'DISABLED',
'Name': 'string',
'Subscribers': [
'string',
]
},
],
'FlowArn': 'string',
'MediaStreams': [
{
'Attributes': {
'Fmtp': {
'ChannelOrder': 'string',
'Colorimetry': 'BT601'|'BT709'|'BT2020'|'BT2100'|'ST2065-1'|'ST2065-3'|'XYZ',
'ExactFramerate': 'string',
'Par': 'string',
'Range': 'NARROW'|'FULL'|'FULLPROTECT',
'ScanMode': 'progressive'|'interlace'|'progressive-segmented-frame',
'Tcs': 'SDR'|'PQ'|'HLG'|'LINEAR'|'BT2100LINPQ'|'BT2100LINHLG'|'ST2065-1'|'ST428-1'|'DENSITY'
},
'Lang': 'string'
},
'ClockRate': 123,
'Description': 'string',
'Fmt': 123,
'MediaStreamId': 123,
'MediaStreamName': 'string',
'MediaStreamType': 'video'|'audio'|'ancillary-data',
'VideoFormat': 'string'
},
],
'Name': 'string',
'Outputs': [
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Destination': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'ListenerAddress': 'string',
'MediaLiveInputArn': 'string',
'MediaStreamOutputConfigurations': [
{
'DestinationConfigurations': [
{
'DestinationIp': 'string',
'DestinationPort': 123,
'Interface': {
'Name': 'string'
},
'OutboundIp': 'string'
},
],
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'EncodingParameters': {
'CompressionFactor': 123.0,
'EncoderProfile': 'main'|'high'
},
'MediaStreamName': 'string'
},
],
'Name': 'string',
'OutputArn': 'string',
'Port': 123,
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'BridgeArn': 'string',
'BridgePorts': [
123,
]
},
],
'Source': {
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputIp': 'string',
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'Name': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
}
},
'SourceFailoverConfig': {
'FailoverMode': 'MERGE'|'FAILOVER',
'RecoveryWindow': 123,
'SourcePriority': {
'PrimarySource': 'string'
},
'State': 'ENABLED'|'DISABLED'
},
'Sources': [
{
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputIp': 'string',
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'Name': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
}
},
],
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
'VpcInterfaces': [
{
'Name': 'string',
'NetworkInterfaceIds': [
'string',
],
'NetworkInterfaceType': 'ena'|'efa',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
},
],
'Maintenance': {
'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
'MaintenanceDeadline': 'string',
'MaintenanceScheduledDate': 'string',
'MaintenanceStartHour': 'string'
}
}
}
Response Structure
(dict) -- AWS Elemental MediaConnect updated the flow successfully.
Flow (dict) -- The settings for a flow, including its source, outputs, and entitlements.
AvailabilityZone (string) -- The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
Description (string) -- A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EgressIp (string) -- The IP address from which video will be sent to output destinations.
Entitlements (list) -- The entitlements in this flow.
(dict) -- The settings for a flow entitlement.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) -- A description of the entitlement.
Encryption (dict) -- The type of encryption that will be used on the output that is associated with this entitlement.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
EntitlementArn (string) -- The ARN of the entitlement.
EntitlementStatus (string) -- An indication of whether the entitlement is enabled.
Name (string) -- The name of the entitlement.
Subscribers (list) -- The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
(string) --
FlowArn (string) -- The Amazon Resource Name (ARN) of the flow.
MediaStreams (list) -- The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
(dict) -- A single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams.
Attributes (dict) -- Attributes that are related to the media stream.
Fmtp (dict) -- A set of parameters that define the media stream.
ChannelOrder (string) -- The format of the audio channel.
Colorimetry (string) -- The format that is used for the representation of color.
ExactFramerate (string) -- The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
Par (string) -- The pixel aspect ratio (PAR) of the video.
Range (string) -- The encoding range of the video.
ScanMode (string) -- The type of compression that was used to smooth the video’s appearance
Tcs (string) -- The transfer characteristic system (TCS) that is used in the video.
Lang (string) -- The audio language, in a format that is recognized by the receiver.
ClockRate (integer) -- The sample rate for the stream. This value is measured in Hz.
Description (string) -- A description that can help you quickly identify what your media stream is used for.
Fmt (integer) -- The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.
MediaStreamId (integer) -- A unique identifier for the media stream.
MediaStreamName (string) -- A name that helps you distinguish one media stream from another.
MediaStreamType (string) -- The type of media stream.
VideoFormat (string) -- The resolution of the video.
Name (string) -- The name of the flow.
Outputs (list) -- The outputs in this flow.
(dict) -- The settings for an output.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) -- A description of the output.
Destination (string) -- The address where you want to send the output.
Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
EntitlementArn (string) -- The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
ListenerAddress (string) -- 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 the Zixi pull or SRT listener protocol.
MediaLiveInputArn (string) -- The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
MediaStreamOutputConfigurations (list) -- The configuration for each media stream that is associated with the output.
(dict) -- The media stream that is associated with the output, and the parameters for that association.
DestinationConfigurations (list) -- The transport parameters that are associated with each outbound media stream.
(dict) -- The transport parameters that are associated with an outbound media stream.
DestinationIp (string) -- The IP address where contents of the media stream will be sent.
DestinationPort (integer) -- The port to use when the content of the media stream is distributed to the output.
Interface (dict) -- The VPC interface that is used for the media stream associated with the output.
Name (string) -- The name of the VPC interface.
OutboundIp (string) -- The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol.
EncodingName (string) -- 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.
EncodingParameters (dict) -- Encoding parameters
CompressionFactor (float) -- A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
EncoderProfile (string) -- A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.
MediaStreamName (string) -- The name of the media stream.
Name (string) -- The name of the output. This value must be unique within the current flow.
OutputArn (string) -- The ARN of the output.
Port (integer) -- The port to use when content is distributed to this output.
Transport (dict) -- Attributes related to the transport stream that are used in the output.
CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
MinLatency (integer) -- 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.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) -- Source port for SRT-caller protocol.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this output.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
BridgeArn (string) -- The ARN of the bridge that added this output.
BridgePorts (list) -- The bridge output ports currently in use.
(integer) --
Source (dict) -- The settings for the source of the flow.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- 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) -- The IP address that the flow will be listening on for incoming content.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
(dict) -- The media stream that is associated with the source, and the parameters for that association.
EncodingName (string) -- 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 (list) -- The transport parameters that are associated with an incoming media stream.
(dict) -- The transport parameters that are associated with an incoming media stream.
InputIp (string) -- The IP address that the flow listens on for incoming content for a media stream.
InputPort (integer) -- The port that the flow listens on for an incoming media stream.
Interface (dict) -- The VPC interface where the media stream comes in from.
Name (string) -- The name of the VPC interface.
MediaStreamName (string) -- The name of the media stream.
Name (string) -- The name of the source.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SourceArn (string) -- The ARN of the source.
Transport (dict) -- Attributes related to the transport stream that are used in the source.
CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
MinLatency (integer) -- 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.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) -- Source port for SRT-caller protocol.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceName (string) -- The name of the VPC interface that is used for this source.
WhitelistCidr (string) -- The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) -- The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) -- The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
SourceFailoverConfig (dict) -- The settings for source failover.
FailoverMode (string) -- The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
RecoveryWindow (integer) -- Search window time to look for dash-7 packets
SourcePriority (dict) -- The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
PrimarySource (string) -- The name of the source you choose as the primary source for this flow.
State (string) --
Sources (list) --
(dict) -- The settings for the source of the flow.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- 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) -- The IP address that the flow will be listening on for incoming content.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
(dict) -- The media stream that is associated with the source, and the parameters for that association.
EncodingName (string) -- 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 (list) -- The transport parameters that are associated with an incoming media stream.
(dict) -- The transport parameters that are associated with an incoming media stream.
InputIp (string) -- The IP address that the flow listens on for incoming content for a media stream.
InputPort (integer) -- The port that the flow listens on for an incoming media stream.
Interface (dict) -- The VPC interface where the media stream comes in from.
Name (string) -- The name of the VPC interface.
MediaStreamName (string) -- The name of the media stream.
Name (string) -- The name of the source.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SourceArn (string) -- The ARN of the source.
Transport (dict) -- Attributes related to the transport stream that are used in the source.
CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
MinLatency (integer) -- 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.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) -- Source port for SRT-caller protocol.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceName (string) -- The name of the VPC interface that is used for this source.
WhitelistCidr (string) -- The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) -- The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) -- The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
Status (string) -- The current status of the flow.
VpcInterfaces (list) -- The VPC Interfaces for this flow.
(dict) -- The settings for a VPC Source.
Name (string) -- Immutable and has to be a unique against other VpcInterfaces in this Flow.
NetworkInterfaceIds (list) -- IDs of the network interfaces created in customer's account by MediaConnect.
(string) --
NetworkInterfaceType (string) -- The type of network interface.
RoleArn (string) -- Role Arn MediaConnect can assumes to create ENIs in customer's account
SecurityGroupIds (list) -- Security Group IDs to be used on ENI.
(string) --
SubnetId (string) -- Subnet must be in the AZ of the Flow
Maintenance (dict) -- The maintenance setting of a flow
MaintenanceDay (string) -- A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
MaintenanceDeadline (string) -- The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.
MaintenanceScheduledDate (string) -- A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
MaintenanceStartHour (string) -- UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
{'Protocol': {'udp'}}
Response {'Output': {'BridgeArn': 'string',
'BridgePorts': ['integer'],
'Transport': {'Protocol': {'udp'}}}}
Updates an existing flow output.
See also: AWS API Documentation
Request Syntax
client.update_flow_output(
CidrAllowList=[
'string',
],
Description='string',
Destination='string',
Encryption={
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
FlowArn='string',
MaxLatency=123,
MediaStreamOutputConfigurations=[
{
'DestinationConfigurations': [
{
'DestinationIp': 'string',
'DestinationPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'EncodingParameters': {
'CompressionFactor': 123.0,
'EncoderProfile': 'main'|'high'
},
'MediaStreamName': 'string'
},
],
MinLatency=123,
OutputArn='string',
Port=123,
Protocol='zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
RemoteId='string',
SenderControlPort=123,
SenderIpAddress='string',
SmoothingLatency=123,
StreamId='string',
VpcInterfaceAttachment={
'VpcInterfaceName': 'string'
}
)
list
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
string
A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
string
The IP address where you want to send the output.
dict
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Allowable encryption types: static-key.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
string
[REQUIRED] The flow that is associated with the output that you want to update.
integer
The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
list
The media streams that are associated with the output, and the parameters for those associations.
(dict) -- The media stream that you want to associate with the output, and the parameters for that association.
DestinationConfigurations (list) -- The transport parameters that you want to associate with the media stream.
(dict) -- The transport parameters that you want to associate with an outbound media stream.
DestinationIp (string) -- [REQUIRED] The IP address where you want MediaConnect to send contents of the media stream.
DestinationPort (integer) -- [REQUIRED] The port that you want MediaConnect to use when it distributes the media stream to the output.
Interface (dict) -- [REQUIRED] The VPC interface that you want to use for the media stream associated with the output.
Name (string) -- [REQUIRED] The name of the VPC interface.
EncodingName (string) -- [REQUIRED] The format that will be 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.
EncodingParameters (dict) -- A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.
CompressionFactor (float) -- [REQUIRED] A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
EncoderProfile (string) -- [REQUIRED] A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, if at least one source on the flow uses the CDI protocol.
MediaStreamName (string) -- [REQUIRED] The name of the media stream that is associated with the output.
integer
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.
string
[REQUIRED] The ARN of the output that you want to update.
integer
The port to use when content is distributed to this output.
string
The protocol to use for the output.
string
The remote ID for the Zixi-pull stream.
integer
The port that the flow uses to send outbound requests to initiate connection with the sender.
string
The IP address that the flow communicates with to initiate connection with the sender.
integer
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
string
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
dict
The name of the VPC interface attachment to use for this output.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
dict
Response Syntax
{
'FlowArn': 'string',
'Output': {
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Destination': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'ListenerAddress': 'string',
'MediaLiveInputArn': 'string',
'MediaStreamOutputConfigurations': [
{
'DestinationConfigurations': [
{
'DestinationIp': 'string',
'DestinationPort': 123,
'Interface': {
'Name': 'string'
},
'OutboundIp': 'string'
},
],
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'EncodingParameters': {
'CompressionFactor': 123.0,
'EncoderProfile': 'main'|'high'
},
'MediaStreamName': 'string'
},
],
'Name': 'string',
'OutputArn': 'string',
'Port': 123,
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'BridgeArn': 'string',
'BridgePorts': [
123,
]
}
}
Response Structure
(dict) -- AWS Elemental MediaConnect updated the output successfully.
FlowArn (string) -- The ARN of the flow that is associated with the updated output.
Output (dict) -- The new settings of the output that you updated.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) -- A description of the output.
Destination (string) -- The address where you want to send the output.
Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
EntitlementArn (string) -- The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
ListenerAddress (string) -- 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 the Zixi pull or SRT listener protocol.
MediaLiveInputArn (string) -- The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
MediaStreamOutputConfigurations (list) -- The configuration for each media stream that is associated with the output.
(dict) -- The media stream that is associated with the output, and the parameters for that association.
DestinationConfigurations (list) -- The transport parameters that are associated with each outbound media stream.
(dict) -- The transport parameters that are associated with an outbound media stream.
DestinationIp (string) -- The IP address where contents of the media stream will be sent.
DestinationPort (integer) -- The port to use when the content of the media stream is distributed to the output.
Interface (dict) -- The VPC interface that is used for the media stream associated with the output.
Name (string) -- The name of the VPC interface.
OutboundIp (string) -- The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol.
EncodingName (string) -- 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.
EncodingParameters (dict) -- Encoding parameters
CompressionFactor (float) -- A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
EncoderProfile (string) -- A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.
MediaStreamName (string) -- The name of the media stream.
Name (string) -- The name of the output. This value must be unique within the current flow.
OutputArn (string) -- The ARN of the output.
Port (integer) -- The port to use when content is distributed to this output.
Transport (dict) -- Attributes related to the transport stream that are used in the output.
CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
MinLatency (integer) -- 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.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) -- Source port for SRT-caller protocol.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this output.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
BridgeArn (string) -- The ARN of the bridge that added this output.
BridgePorts (list) -- The bridge output ports currently in use.
(integer) --
{'GatewayBridgeSource': {'BridgeArn': 'string',
'VpcInterfaceAttachment': {'VpcInterfaceName': 'string'}},
'Protocol': {'udp'}}
Response {'Source': {'GatewayBridgeSource': {'BridgeArn': 'string',
'VpcInterfaceAttachment': {'VpcInterfaceName': 'string'}},
'Transport': {'Protocol': {'udp'}}}}
Updates the source of a flow.
See also: AWS API Documentation
Request Syntax
client.update_flow_source(
Decryption={
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
Description='string',
EntitlementArn='string',
FlowArn='string',
IngestPort=123,
MaxBitrate=123,
MaxLatency=123,
MaxSyncBuffer=123,
MediaStreamSourceConfigurations=[
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
MinLatency=123,
Protocol='zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
SenderControlPort=123,
SenderIpAddress='string',
SourceArn='string',
SourceListenerAddress='string',
SourceListenerPort=123,
StreamId='string',
VpcInterfaceName='string',
WhitelistCidr='string',
GatewayBridgeSource={
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
}
)
dict
The type of encryption used on the content ingested from this source. Allowable encryption types: static-key.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
string
A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
string
The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
string
[REQUIRED] The flow that is associated with the source that you want to update.
integer
The port that the flow will be listening on for incoming content.
integer
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
integer
The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
integer
The size of the buffer (in milliseconds) to use to sync incoming source data.
list
The media streams that are associated with the source, and the parameters for those associations.
(dict) -- The definition of a media stream that you want to associate with the source.
EncodingName (string) -- [REQUIRED] The format you want to use 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 (list) -- The transport parameters that you want to associate with the media stream.
(dict) -- The transport parameters that you want to associate with an incoming media stream.
InputPort (integer) -- [REQUIRED] The port that you want the flow to listen on for an incoming media stream.
Interface (dict) -- [REQUIRED] The VPC interface that you want to use for the incoming media stream.
Name (string) -- [REQUIRED] The name of the VPC interface.
MediaStreamName (string) -- [REQUIRED] The name of the media stream.
integer
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.
string
The protocol that is used by the source.
integer
The port that the flow uses to send outbound requests to initiate connection with the sender.
string
The IP address that the flow communicates with to initiate connection with the sender.
string
[REQUIRED] The ARN of the source that you want to update.
string
Source IP or domain name for SRT-caller protocol.
integer
Source port for SRT-caller protocol.
string
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
string
The name of the VPC interface to use for this source.
string
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
dict
The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) -- The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.
dict
Response Syntax
{
'FlowArn': 'string',
'Source': {
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputIp': 'string',
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'Name': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
}
}
}
Response Structure
(dict) -- AWS Elemental MediaConnect updated the flow successfully.
FlowArn (string) -- The ARN of the flow that you want to update.
Source (dict) -- The settings for the source of the flow.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) -- 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.
DeviceId (string) -- 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.
KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) -- 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.
ResourceId (string) -- 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) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- 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.
Url (string) -- 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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- 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) -- The IP address that the flow will be listening on for incoming content.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
(dict) -- The media stream that is associated with the source, and the parameters for that association.
EncodingName (string) -- 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 (list) -- The transport parameters that are associated with an incoming media stream.
(dict) -- The transport parameters that are associated with an incoming media stream.
InputIp (string) -- The IP address that the flow listens on for incoming content for a media stream.
InputPort (integer) -- The port that the flow listens on for an incoming media stream.
Interface (dict) -- The VPC interface where the media stream comes in from.
Name (string) -- The name of the VPC interface.
MediaStreamName (string) -- The name of the media stream.
Name (string) -- The name of the source.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SourceArn (string) -- The ARN of the source.
Transport (dict) -- Attributes related to the transport stream that are used in the source.
CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
MinLatency (integer) -- 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.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) -- Source port for SRT-caller protocol.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceName (string) -- The name of the VPC interface that is used for this source.
WhitelistCidr (string) -- The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) -- The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) -- The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) -- The name of the VPC interface to use for this resource.