2021/06/11 - AWS MediaConnect - 3 updated api methods
Changes When you enable source failover, you can now designate one of two sources as the primary source. You can choose between two failover modes to prevent any disruption to the video stream. Merge combines the sources into a single stream. Failover allows switching between a primary and a backup stream.
{'SourceFailoverConfig': {'FailoverMode': 'MERGE | FAILOVER',
'SourcePriority': {'PrimarySource': 'string'}}}
Response {'Flow': {'SourceFailoverConfig': {'FailoverMode': 'MERGE | FAILOVER',
'SourcePriority': {'PrimarySource': 'string'}}}}
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',
'RemoteId': 'string',
'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',
'StreamId': 'string',
'VpcInterfaceName': 'string',
'WhitelistCidr': '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',
'StreamId': 'string',
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string'
},
],
VpcInterfaces=[
{
'Name': 'string',
'NetworkInterfaceType': 'ena'|'efa',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': '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.
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).
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 for Zixi-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.
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-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 output.
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.
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 for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-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.
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.
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 for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-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.
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
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',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': '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',
'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',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': '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',
'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',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string'
},
],
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
'VpcInterfaces': [
{
'Name': 'string',
'NetworkInterfaceIds': [
'string',
],
'NetworkInterfaceType': 'ena'|'efa',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': '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), a unique identifier for any AWS resource, 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 for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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.
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-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 output.
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.
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 for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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.
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-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.
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.
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 for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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.
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-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.
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
{'Flow': {'SourceFailoverConfig': {'FailoverMode': 'MERGE | FAILOVER',
'SourcePriority': {'PrimarySource': 'string'}}}}
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',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': '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',
'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',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': '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',
'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',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string'
},
],
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
'VpcInterfaces': [
{
'Name': 'string',
'NetworkInterfaceIds': [
'string',
],
'NetworkInterfaceType': 'ena'|'efa',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': '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), a unique identifier for any AWS resource, 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 for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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.
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-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 output.
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.
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 for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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.
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-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.
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.
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 for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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.
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-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.
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
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) --
{'SourceFailoverConfig': {'FailoverMode': 'MERGE | FAILOVER',
'SourcePriority': {'PrimarySource': 'string'}}}
Response {'Flow': {'SourceFailoverConfig': {'FailoverMode': 'MERGE | FAILOVER',
'SourcePriority': {'PrimarySource': 'string'}}}}
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'
}
)
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
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',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': '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',
'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',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': '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',
'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',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string'
},
],
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
'VpcInterfaces': [
{
'Name': 'string',
'NetworkInterfaceIds': [
'string',
],
'NetworkInterfaceType': 'ena'|'efa',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': '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), a unique identifier for any AWS resource, 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 for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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.
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-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 output.
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.
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 for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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.
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-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.
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.
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 for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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.
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-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.
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