2025/11/19 - AWS MediaConnect - 30 new7 updated api methods
Changes This release adds support for global routing in AWS Elemental MediaConnect. You can now use router inputs and router outputs to manage global video and audio routing workflows both within the AWS-Cloud and over the public internet.
Associates a router input with a router output in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.take_router_input(
RouterOutputArn='string',
RouterInputArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router output that you want to associate with a router input.
string
The Amazon Resource Name (ARN) of the router input that you want to associate with a router output.
dict
Response Syntax
{
'RoutedState': 'ROUTED'|'ROUTING'|'UNROUTED',
'RouterOutputArn': 'string',
'RouterOutputName': 'string',
'RouterInputArn': 'string',
'RouterInputName': 'string'
}
Response Structure
(dict) --
RoutedState (string) --
The state of the association between the router input and output.
RouterOutputArn (string) --
The ARN of the associated router output.
RouterOutputName (string) --
The name of the associated router output.
RouterInputArn (string) --
The ARN of the associated router input.
RouterInputName (string) --
The name of the associated router input.
Restarts a router output. This operation can be used to recover from errors or refresh the output state.
See also: AWS API Documentation
Request Syntax
client.restart_router_output(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router output that you want to restart.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the router output that was restarted.
Name (string) --
The name of the router output that was restarted.
State (string) --
The current state of the router output after the restart operation.
Retrieves information about multiple router inputs in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.batch_get_router_input(
Arns=[
'string',
]
)
list
[REQUIRED]
The Amazon Resource Names (ARNs) of the router inputs you want to retrieve information about.
(string) --
dict
Response Syntax
{
'RouterInputs': [
{
'Name': 'string',
'Arn': 'string',
'Id': 'string',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
'InputType': 'STANDARD'|'FAILOVER'|'MERGE'|'MEDIACONNECT_FLOW',
'Configuration': {
'Standard': {
'NetworkInterfaceArn': 'string',
'ProtocolConfiguration': {
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'SourceAddress': 'string',
'SourcePort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
},
'Failover': {
'NetworkInterfaceArn': 'string',
'ProtocolConfigurations': [
{
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'SourceAddress': 'string',
'SourcePort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
],
'SourcePriorityMode': 'NO_PRIORITY'|'PRIMARY_SECONDARY',
'PrimarySourceIndex': 123
},
'Merge': {
'NetworkInterfaceArn': 'string',
'ProtocolConfigurations': [
{
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
}
},
],
'MergeRecoveryWindowMilliseconds': 123
},
'MediaConnectFlow': {
'FlowArn': 'string',
'FlowOutputArn': 'string',
'SourceTransitDecryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
}
},
'RoutedOutputs': 123,
'MaximumRoutedOutputs': 123,
'RegionName': 'string',
'AvailabilityZone': 'string',
'MaximumBitrate': 123,
'Tier': 'INPUT_100'|'INPUT_50'|'INPUT_20',
'RoutingScope': 'REGIONAL'|'GLOBAL',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Messages': [
{
'Code': 'string',
'Message': 'string'
},
],
'TransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
'Tags': {
'string': 'string'
},
'StreamDetails': {
'Standard': {
'SourceIpAddress': 'string'
},
'Failover': {
'SourceIndexZeroStreamDetails': {
'SourceIndex': 123,
'SourceIpAddress': 'string'
},
'SourceIndexOneStreamDetails': {
'SourceIndex': 123,
'SourceIpAddress': 'string'
}
},
'Merge': {
'SourceIndexZeroStreamDetails': {
'SourceIndex': 123,
'SourceIpAddress': 'string'
},
'SourceIndexOneStreamDetails': {
'SourceIndex': 123,
'SourceIpAddress': 'string'
}
},
'MediaConnectFlow': {}
},
'IpAddress': 'string',
'MaintenanceType': 'PREFERRED_DAY_TIME'|'DEFAULT',
'MaintenanceConfiguration': {
'PreferredDayTime': {
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'Time': 'string'
},
'Default': {}
},
'MaintenanceScheduleType': 'WINDOW',
'MaintenanceSchedule': {
'Window': {
'Start': datetime(2015, 1, 1),
'End': datetime(2015, 1, 1),
'ScheduledTime': datetime(2015, 1, 1)
}
}
},
],
'Errors': [
{
'Arn': 'string',
'Code': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
RouterInputs (list) --
An array of router inputs that were successfully retrieved.
(dict) --
A router input in AWS Elemental MediaConnect. A router input is a source of media content that can be routed to one or more router outputs.
Name (string) --
The name of the router input.
Arn (string) --
The Amazon Resource Name (ARN) of the router input.
Id (string) --
The unique identifier of the router input.
State (string) --
The current state of the router input.
InputType (string) --
The type of the router input.
Configuration (dict) --
The configuration settings for a router input.
Standard (dict) --
The configuration settings for a standard router input, including the protocol, protocol-specific configuration, network interface, and availability zone.
NetworkInterfaceArn (string) --
The Amazon Resource Name (ARN) of the network interface associated with the standard router input.
ProtocolConfiguration (dict) --
The configuration settings for the protocol used by the standard router input.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) --
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) --
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) --
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
SrtListener (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
Port (integer) --
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in listener mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
SourceAddress (string) --
The source IP address for the SRT protocol in caller mode.
SourcePort (integer) --
The source port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Protocol (string) --
The protocol used by the standard router input.
Failover (dict) --
Configuration settings for a failover router input that allows switching between two input sources.
NetworkInterfaceArn (string) --
The ARN of the network interface to use for this failover router input.
ProtocolConfigurations (list) --
A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type.
(dict) --
Protocol configuration settings for failover router inputs.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) --
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) --
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) --
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
SrtListener (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
Port (integer) --
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in listener mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
SourceAddress (string) --
The source IP address for the SRT protocol in caller mode.
SourcePort (integer) --
The source port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SourcePriorityMode (string) --
The mode for determining source priority in failover configurations.
PrimarySourceIndex (integer) --
The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY
Merge (dict) --
Configuration settings for a merge router input that combines two input sources.
NetworkInterfaceArn (string) --
The ARN of the network interface to use for this merge router input.
ProtocolConfigurations (list) --
A list of exactly two protocol configurations for the merge input sources. Both must use the same protocol type.
(dict) --
Protocol configuration settings for merge router inputs.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) --
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) --
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) --
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
MergeRecoveryWindowMilliseconds (integer) --
The time window in milliseconds for merging the two input sources.
MediaConnectFlow (dict) --
Configuration settings for connecting a router input to a flow output.
FlowArn (string) --
The ARN of the flow to connect to.
FlowOutputArn (string) --
The ARN of the flow output to connect to this router input.
SourceTransitDecryption (dict) --
The decryption configuration for the flow source when connected to this router input.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
RoutedOutputs (integer) --
The number of router outputs associated with the router input.
MaximumRoutedOutputs (integer) --
The maximum number of outputs that can be simultaneously routed to this input.
RegionName (string) --
The AWS Region where the router input is located.
AvailabilityZone (string) --
The Availability Zone of the router input.
MaximumBitrate (integer) --
The maximum bitrate for the router input.
Tier (string) --
The tier level of the router input.
RoutingScope (string) --
Indicates whether the router input is configured for Regional or global routing.
CreatedAt (datetime) --
The timestamp when the router input was created.
UpdatedAt (datetime) --
The timestamp when the router input was last updated.
Messages (list) --
The messages associated with the router input.
(dict) --
A message associated with a router input, including a code and a message.
Code (string) --
The code associated with the router input message.
Message (string) --
The message text associated with the router input message.
TransitEncryption (dict) --
The transit encryption settings for a router input.
EncryptionKeyType (string) --
Specifies the type of encryption key to use for transit encryption.
EncryptionKeyConfiguration (dict) --
Contains the configuration details for the encryption key used in transit encryption, including the key source and associated parameters.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
Tags (dict) --
Key-value pairs that can be used to tag and organize this router input.
(string) --
(string) --
StreamDetails (dict) --
Configuration details for the router input stream.
Standard (dict) --
Configuration details for a standard router input stream type.
SourceIpAddress (string) --
The source IP address for the standard router input stream.
Failover (dict) --
Configuration details for a failover router input that can automatically switch between two sources.
SourceIndexZeroStreamDetails (dict) --
Configuration details for the primary source (index 0) in the failover setup.
SourceIndex (integer) --
The index number (0 or 1) assigned to this source in the failover configuration.
SourceIpAddress (string) --
The IP address of the source for this indexed stream.
SourceIndexOneStreamDetails (dict) --
Configuration details for the secondary source (index 1) in the failover setup.
SourceIndex (integer) --
The index number (0 or 1) assigned to this source in the failover configuration.
SourceIpAddress (string) --
The IP address of the source for this indexed stream.
Merge (dict) --
Configuration details for a merge router input that combines two input sources.
SourceIndexZeroStreamDetails (dict) --
Configuration details for the first source (index 0) in the merge setup.
SourceIndex (integer) --
The index number (0 or 1) assigned to this source in the merge configuration.
SourceIpAddress (string) --
The IP address of the source for this indexed stream in the merge setup.
SourceIndexOneStreamDetails (dict) --
Configuration details for the second source (index 1) in the merge setup.
SourceIndex (integer) --
The index number (0 or 1) assigned to this source in the merge configuration.
SourceIpAddress (string) --
The IP address of the source for this indexed stream in the merge setup.
MediaConnectFlow (dict) --
Configuration details for a MediaConnect flow when used as a router input source.
IpAddress (string) --
The IP address of the router input.
MaintenanceType (string) --
The type of maintenance configuration applied to this router input.
MaintenanceConfiguration (dict) --
The maintenance configuration settings applied to this router input.
PreferredDayTime (dict) --
Preferred day and time maintenance configuration settings.
Day (string) --
The preferred day for maintenance operations.
Time (string) --
The preferred time for maintenance operations.
Default (dict) --
Default maintenance configuration settings.
MaintenanceScheduleType (string) --
The type of maintenance schedule currently in effect for this router input.
MaintenanceSchedule (dict) --
The current maintenance schedule details for this router input.
Window (dict) --
Defines a specific time window for maintenance operations.
Start (datetime) --
The start time of the maintenance window.
End (datetime) --
The end time of the maintenance window.
ScheduledTime (datetime) --
The date and time when the maintenance window is scheduled to occur.
Errors (list) --
An array of errors that occurred when retrieving the requested router inputs.
(dict) --
An error that occurred when retrieving multiple router inputs in the BatchGetRouterInput operation, including the ARN, error code, and error message.
Arn (string) --
The Amazon Resource Name (ARN) of the router input for which the error occurred.
Code (string) --
The error code associated with the error.
Message (string) --
A message describing the error.
Retrieves information about a specific router network interface in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.get_router_network_interface(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router network interface that you want to retrieve information about.
dict
Response Syntax
{
'RouterNetworkInterface': {
'Name': 'string',
'Arn': 'string',
'Id': 'string',
'State': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'ERROR'|'RECOVERING',
'NetworkInterfaceType': 'PUBLIC'|'VPC',
'Configuration': {
'Public': {
'AllowRules': [
{
'Cidr': 'string'
},
]
},
'Vpc': {
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
}
},
'AssociatedOutputCount': 123,
'AssociatedInputCount': 123,
'RegionName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
RouterNetworkInterface (dict) --
The details of the requested router network interface, including its configuration and other attributes.
Name (string) --
The name of the router network interface.
Arn (string) --
The Amazon Resource Name (ARN) of the router network interface.
Id (string) --
The unique identifier of the router network interface.
State (string) --
The current state of the router network interface.
NetworkInterfaceType (string) --
The type of the router network interface.
Configuration (dict) --
The configuration settings for a router network interface.
Public (dict) --
The configuration settings for a public router network interface, including the list of allowed CIDR blocks.
AllowRules (list) --
The list of allowed CIDR blocks for the public router network interface.
(dict) --
A rule that allows a specific CIDR block to access the public router network interface.
Cidr (string) --
The CIDR block that is allowed to access the public router network interface.
Vpc (dict) --
The configuration settings for a router network interface within a VPC, including the security group IDs and subnet ID.
SecurityGroupIds (list) --
The IDs of the security groups to associate with the router network interface within the VPC.
(string) --
SubnetId (string) --
The ID of the subnet within the VPC to associate the router network interface with.
AssociatedOutputCount (integer) --
The number of router outputs associated with the network interface.
AssociatedInputCount (integer) --
The number of router inputs associated with the network interface.
RegionName (string) --
The AWS Region where the router network interface is located.
CreatedAt (datetime) --
The timestamp when the router network interface was created.
UpdatedAt (datetime) --
The timestamp when the router network interface was last updated.
Tags (dict) --
Key-value pairs that can be used to tag and organize this router network interface.
(string) --
(string) --
Deletes a router network interface from AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.delete_router_network_interface(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router network interface that you want to delete.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'State': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'ERROR'|'RECOVERING'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the deleted router network interface.
Name (string) --
The name of the deleted router network interface.
State (string) --
The current state of the deleted router network interface, indicating where it is in the deletion process.
Creates a new router output in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.create_router_output(
Name='string',
Configuration={
'Standard': {
'NetworkInterfaceArn': 'string',
'ProtocolConfiguration': {
'Rtp': {
'DestinationAddress': 'string',
'DestinationPort': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'DestinationAddress': 'string',
'DestinationPort': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'EncryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'DestinationAddress': 'string',
'DestinationPort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'EncryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
},
'MediaConnectFlow': {
'FlowArn': 'string',
'FlowSourceArn': 'string',
'DestinationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
},
'MediaLiveInput': {
'MediaLiveInputArn': 'string',
'MediaLivePipelineId': 'PIPELINE_0'|'PIPELINE_1',
'DestinationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
}
},
MaximumBitrate=123,
RoutingScope='REGIONAL'|'GLOBAL',
Tier='OUTPUT_100'|'OUTPUT_50'|'OUTPUT_20',
RegionName='string',
AvailabilityZone='string',
MaintenanceConfiguration={
'PreferredDayTime': {
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'Time': 'string'
},
'Default': {}
},
Tags={
'string': 'string'
},
ClientToken='string'
)
string
[REQUIRED]
The name of the router output.
dict
[REQUIRED]
The configuration settings for the router output.
Standard (dict) --
The configuration settings for a standard router output, including the protocol, protocol-specific configuration, network interface, and availability zone.
NetworkInterfaceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the network interface associated with the standard router output.
ProtocolConfiguration (dict) -- [REQUIRED]
The configuration settings for the protocol used by the standard router output.
Rtp (dict) --
The configuration settings for a router output using the RTP (Real-Time Transport Protocol) protocol, including the destination address and port, and forward error correction state.
DestinationAddress (string) -- [REQUIRED]
The destination IP address for the RTP protocol in the router output configuration.
DestinationPort (integer) -- [REQUIRED]
The destination port number for the RTP protocol in the router output configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router output configuration.
Rist (dict) --
The configuration settings for a router output using the RIST (Reliable Internet Stream Transport) protocol, including the destination address and port.
DestinationAddress (string) -- [REQUIRED]
The destination IP address for the RIST protocol in the router output configuration.
DestinationPort (integer) -- [REQUIRED]
The destination port number for the RIST protocol in the router output configuration.
SrtListener (dict) --
The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and encryption key configuration.
Port (integer) -- [REQUIRED]
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) -- [REQUIRED]
The minimum latency in milliseconds for the SRT protocol in listener mode.
EncryptionConfiguration (dict) --
Defines the encryption settings for an SRT listener output, including the encryption key configuration and associated parameters.
EncryptionKey (dict) -- [REQUIRED]
Specifies the encryption key configuration used for encrypting SRT streams, including the key source and associated credentials.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in caller mode, including the destination address and port, minimum latency, stream ID, and encryption key configuration.
DestinationAddress (string) -- [REQUIRED]
The destination IP address for the SRT protocol in caller mode.
DestinationPort (integer) -- [REQUIRED]
The destination port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) -- [REQUIRED]
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
EncryptionConfiguration (dict) --
Defines the encryption settings for an SRT caller output, including the encryption key configuration and associated parameters.
EncryptionKey (dict) -- [REQUIRED]
Specifies the encryption key configuration used for encrypting SRT streams, including the key source and associated credentials.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Protocol (string) --
The protocol used by the standard router output.
MediaConnectFlow (dict) --
Configuration settings for connecting a router output to a MediaConnect flow source.
FlowArn (string) --
The ARN of the flow to connect to this router output.
FlowSourceArn (string) --
The ARN of the flow source to connect to this router output.
DestinationTransitEncryption (dict) -- [REQUIRED]
The encryption configuration for the flow destination when connected to this router output.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) -- [REQUIRED]
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
MediaLiveInput (dict) --
Configuration settings for connecting a router output to a MediaLive input.
MediaLiveInputArn (string) --
The ARN of the MediaLive input to connect to this router output.
MediaLivePipelineId (string) --
The index of the MediaLive pipeline to connect to this router output.
DestinationTransitEncryption (dict) -- [REQUIRED]
The encryption configuration for the MediaLive input when connected to this router output.
EncryptionKeyType (string) --
The type of encryption key to use for MediaLive transit encryption.
EncryptionKeyConfiguration (dict) -- [REQUIRED]
The configuration details for the MediaLive encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
integer
[REQUIRED]
The maximum bitrate for the router output.
string
[REQUIRED]
Specifies whether the router output can take inputs that are in different Regions. REGIONAL (default) - can only take inputs from same Region. GLOBAL - can take inputs from any Region.
string
[REQUIRED]
The tier level for the router output.
string
The AWS Region for the router output. Defaults to the current region if not specified.
string
The Availability Zone where you want to create the router output. This must be a valid Availability Zone for the region specified by regionName, or the current region if no regionName is provided.
dict
The maintenance configuration settings for the router output, including preferred maintenance windows and schedules.
PreferredDayTime (dict) --
Preferred day and time maintenance configuration settings.
Day (string) -- [REQUIRED]
The preferred day for maintenance operations.
Time (string) -- [REQUIRED]
The preferred time for maintenance operations.
Default (dict) --
Default maintenance configuration settings.
dict
Key-value pairs that can be used to tag this router output.
(string) --
(string) --
string
A unique identifier for the request to ensure idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'RouterOutput': {
'Name': 'string',
'Arn': 'string',
'Id': 'string',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
'OutputType': 'STANDARD'|'MEDIACONNECT_FLOW'|'MEDIALIVE_INPUT',
'Configuration': {
'Standard': {
'NetworkInterfaceArn': 'string',
'ProtocolConfiguration': {
'Rtp': {
'DestinationAddress': 'string',
'DestinationPort': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'DestinationAddress': 'string',
'DestinationPort': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'EncryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'DestinationAddress': 'string',
'DestinationPort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'EncryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
},
'MediaConnectFlow': {
'FlowArn': 'string',
'FlowSourceArn': 'string',
'DestinationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
},
'MediaLiveInput': {
'MediaLiveInputArn': 'string',
'MediaLivePipelineId': 'PIPELINE_0'|'PIPELINE_1',
'DestinationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
}
},
'RoutedState': 'ROUTED'|'ROUTING'|'UNROUTED',
'RegionName': 'string',
'AvailabilityZone': 'string',
'MaximumBitrate': 123,
'RoutingScope': 'REGIONAL'|'GLOBAL',
'Tier': 'OUTPUT_100'|'OUTPUT_50'|'OUTPUT_20',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Messages': [
{
'Code': 'string',
'Message': 'string'
},
],
'Tags': {
'string': 'string'
},
'StreamDetails': {
'Standard': {
'DestinationIpAddress': 'string'
},
'MediaConnectFlow': {},
'MediaLiveInput': {}
},
'IpAddress': 'string',
'RoutedInputArn': 'string',
'MaintenanceType': 'PREFERRED_DAY_TIME'|'DEFAULT',
'MaintenanceConfiguration': {
'PreferredDayTime': {
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'Time': 'string'
},
'Default': {}
},
'MaintenanceScheduleType': 'WINDOW',
'MaintenanceSchedule': {
'Window': {
'Start': datetime(2015, 1, 1),
'End': datetime(2015, 1, 1),
'ScheduledTime': datetime(2015, 1, 1)
}
}
}
}
Response Structure
(dict) --
RouterOutput (dict) --
The newly-created router output.
Name (string) --
The name of the router output.
Arn (string) --
The Amazon Resource Name (ARN) of the router output.
Id (string) --
The unique identifier of the router output.
State (string) --
The overall state of the router output.
OutputType (string) --
The type of the router output.
Configuration (dict) --
The configuration settings for a router output.
Standard (dict) --
The configuration settings for a standard router output, including the protocol, protocol-specific configuration, network interface, and availability zone.
NetworkInterfaceArn (string) --
The Amazon Resource Name (ARN) of the network interface associated with the standard router output.
ProtocolConfiguration (dict) --
The configuration settings for the protocol used by the standard router output.
Rtp (dict) --
The configuration settings for a router output using the RTP (Real-Time Transport Protocol) protocol, including the destination address and port, and forward error correction state.
DestinationAddress (string) --
The destination IP address for the RTP protocol in the router output configuration.
DestinationPort (integer) --
The destination port number for the RTP protocol in the router output configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router output configuration.
Rist (dict) --
The configuration settings for a router output using the RIST (Reliable Internet Stream Transport) protocol, including the destination address and port.
DestinationAddress (string) --
The destination IP address for the RIST protocol in the router output configuration.
DestinationPort (integer) --
The destination port number for the RIST protocol in the router output configuration.
SrtListener (dict) --
The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and encryption key configuration.
Port (integer) --
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in listener mode.
EncryptionConfiguration (dict) --
Defines the encryption settings for an SRT listener output, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for encrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in caller mode, including the destination address and port, minimum latency, stream ID, and encryption key configuration.
DestinationAddress (string) --
The destination IP address for the SRT protocol in caller mode.
DestinationPort (integer) --
The destination port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
EncryptionConfiguration (dict) --
Defines the encryption settings for an SRT caller output, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for encrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Protocol (string) --
The protocol used by the standard router output.
MediaConnectFlow (dict) --
Configuration settings for connecting a router output to a MediaConnect flow source.
FlowArn (string) --
The ARN of the flow to connect to this router output.
FlowSourceArn (string) --
The ARN of the flow source to connect to this router output.
DestinationTransitEncryption (dict) --
The encryption configuration for the flow destination when connected to this router output.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
MediaLiveInput (dict) --
Configuration settings for connecting a router output to a MediaLive input.
MediaLiveInputArn (string) --
The ARN of the MediaLive input to connect to this router output.
MediaLivePipelineId (string) --
The index of the MediaLive pipeline to connect to this router output.
DestinationTransitEncryption (dict) --
The encryption configuration for the MediaLive input when connected to this router output.
EncryptionKeyType (string) --
The type of encryption key to use for MediaLive transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the MediaLive encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
RoutedState (string) --
The current state of the association between the router output and its input.
RegionName (string) --
The AWS Region where the router output is located.
AvailabilityZone (string) --
The Availability Zone of the router output.
MaximumBitrate (integer) --
The maximum bitrate for the router output.
RoutingScope (string) --
Indicates whether the router output is configured for Regional or global routing.
Tier (string) --
The tier level of the router output.
CreatedAt (datetime) --
The timestamp when the router output was created.
UpdatedAt (datetime) --
The timestamp when the router output was last updated.
Messages (list) --
The messages associated with the router output.
(dict) --
A message associated with a router output.
Code (string) --
The code associated with the router output message.
Message (string) --
The message text associated with the router output message.
Tags (dict) --
Key-value pairs that can be used to tag and organize this router output.
(string) --
(string) --
StreamDetails (dict) --
Information about the router output's stream, including connection state and destination details. The specific details provided vary based on the router output type.
Standard (dict) --
Configuration details for a standard router output stream type. Contains information about the destination IP address and connection state for basic output routing.
DestinationIpAddress (string) --
The IP address where the output stream will be sent. This is the destination address that will receive the routed media content.
MediaConnectFlow (dict) --
Configuration details for a MediaConnect flow when used as a router output destination.
MediaLiveInput (dict) --
Configuration details for a MediaLive input when used as a router output destination.
IpAddress (string) --
The IP address of the router output.
RoutedInputArn (string) --
The Amazon Resource Name (ARN) of the router input associated with the output.
MaintenanceType (string) --
The type of maintenance configuration applied to this router output.
MaintenanceConfiguration (dict) --
The maintenance configuration settings applied to this router output.
PreferredDayTime (dict) --
Preferred day and time maintenance configuration settings.
Day (string) --
The preferred day for maintenance operations.
Time (string) --
The preferred time for maintenance operations.
Default (dict) --
Default maintenance configuration settings.
MaintenanceScheduleType (string) --
The type of maintenance schedule currently in effect for this router output.
MaintenanceSchedule (dict) --
The current maintenance schedule details for this router output.
Window (dict) --
Defines a specific time window for maintenance operations.
Start (datetime) --
The start time of the maintenance window.
End (datetime) --
The end time of the maintenance window.
ScheduledTime (datetime) --
The date and time when the maintenance window is scheduled to occur.
Updates the configuration of an existing router network interface in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.update_router_network_interface(
Arn='string',
Name='string',
Configuration={
'Public': {
'AllowRules': [
{
'Cidr': 'string'
},
]
},
'Vpc': {
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
}
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router network interface that you want to update.
string
The updated name for the router network interface.
dict
The updated configuration settings for the router network interface. Changing the type of the configuration is not supported.
Public (dict) --
The configuration settings for a public router network interface, including the list of allowed CIDR blocks.
AllowRules (list) -- [REQUIRED]
The list of allowed CIDR blocks for the public router network interface.
(dict) --
A rule that allows a specific CIDR block to access the public router network interface.
Cidr (string) -- [REQUIRED]
The CIDR block that is allowed to access the public router network interface.
Vpc (dict) --
The configuration settings for a router network interface within a VPC, including the security group IDs and subnet ID.
SecurityGroupIds (list) -- [REQUIRED]
The IDs of the security groups to associate with the router network interface within the VPC.
(string) --
SubnetId (string) -- [REQUIRED]
The ID of the subnet within the VPC to associate the router network interface with.
dict
Response Syntax
{
'RouterNetworkInterface': {
'Name': 'string',
'Arn': 'string',
'Id': 'string',
'State': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'ERROR'|'RECOVERING',
'NetworkInterfaceType': 'PUBLIC'|'VPC',
'Configuration': {
'Public': {
'AllowRules': [
{
'Cidr': 'string'
},
]
},
'Vpc': {
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
}
},
'AssociatedOutputCount': 123,
'AssociatedInputCount': 123,
'RegionName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
RouterNetworkInterface (dict) --
The updated router network interface.
Name (string) --
The name of the router network interface.
Arn (string) --
The Amazon Resource Name (ARN) of the router network interface.
Id (string) --
The unique identifier of the router network interface.
State (string) --
The current state of the router network interface.
NetworkInterfaceType (string) --
The type of the router network interface.
Configuration (dict) --
The configuration settings for a router network interface.
Public (dict) --
The configuration settings for a public router network interface, including the list of allowed CIDR blocks.
AllowRules (list) --
The list of allowed CIDR blocks for the public router network interface.
(dict) --
A rule that allows a specific CIDR block to access the public router network interface.
Cidr (string) --
The CIDR block that is allowed to access the public router network interface.
Vpc (dict) --
The configuration settings for a router network interface within a VPC, including the security group IDs and subnet ID.
SecurityGroupIds (list) --
The IDs of the security groups to associate with the router network interface within the VPC.
(string) --
SubnetId (string) --
The ID of the subnet within the VPC to associate the router network interface with.
AssociatedOutputCount (integer) --
The number of router outputs associated with the network interface.
AssociatedInputCount (integer) --
The number of router inputs associated with the network interface.
RegionName (string) --
The AWS Region where the router network interface is located.
CreatedAt (datetime) --
The timestamp when the router network interface was created.
UpdatedAt (datetime) --
The timestamp when the router network interface was last updated.
Tags (dict) --
Key-value pairs that can be used to tag and organize this router network interface.
(string) --
(string) --
Starts a router input in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.start_router_input(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router input that you want to start.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
'MaintenanceScheduleType': 'WINDOW',
'MaintenanceSchedule': {
'Window': {
'Start': datetime(2015, 1, 1),
'End': datetime(2015, 1, 1),
'ScheduledTime': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
Arn (string) --
The ARN of the router input that was started.
Name (string) --
The name of the router input that was started.
State (string) --
The current state of the router input after being started.
MaintenanceScheduleType (string) --
The type of maintenance schedule associated with the router input.
MaintenanceSchedule (dict) --
The details of the maintenance schedule for the router input.
Window (dict) --
Defines a specific time window for maintenance operations.
Start (datetime) --
The start time of the maintenance window.
End (datetime) --
The end time of the maintenance window.
ScheduledTime (datetime) --
The date and time when the maintenance window is scheduled to occur.
Retrieves a list of router network interfaces in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.list_router_network_interfaces(
MaxResults=123,
NextToken='string',
Filters=[
{
'RegionNames': [
'string',
],
'NetworkInterfaceTypes': [
'PUBLIC'|'VPC',
],
'NameContains': [
'string',
]
},
]
)
integer
The maximum number of router network interfaces to return in the response.
string
A token used to retrieve the next page of results.
list
The filters to apply when retrieving the list of router network interfaces.
(dict) --
A filter that can be used to retrieve a list of router network interfaces.
RegionNames (list) --
The AWS Regions of the router network interfaces to include in the filter.
(string) --
NetworkInterfaceTypes (list) --
The types of router network interfaces to include in the filter.
(string) --
NameContains (list) --
The names of the router network interfaces to include in the filter.
(string) --
dict
Response Syntax
{
'RouterNetworkInterfaces': [
{
'Name': 'string',
'Arn': 'string',
'Id': 'string',
'NetworkInterfaceType': 'PUBLIC'|'VPC',
'AssociatedOutputCount': 123,
'AssociatedInputCount': 123,
'State': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'ERROR'|'RECOVERING',
'RegionName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RouterNetworkInterfaces (list) --
The summary information for the retrieved router network interfaces.
(dict) --
A summary of a router network interface, including its name, type, ARN, ID, associated input/output counts, state, and other key details. This structure is used in the response of the ListRouterNetworkInterfaces operation.
Name (string) --
The name of the router network interface.
Arn (string) --
The Amazon Resource Name (ARN) of the router network interface.
Id (string) --
The unique identifier of the router network interface.
NetworkInterfaceType (string) --
The type of the router network interface.
AssociatedOutputCount (integer) --
The number of router outputs associated with the network interface.
AssociatedInputCount (integer) --
The number of router inputs associated with the network interface.
State (string) --
The current state of the router network interface.
RegionName (string) --
The AWS Region where the router network interface is located.
CreatedAt (datetime) --
The timestamp when the network interface was created.
UpdatedAt (datetime) --
The timestamp when the router network interface was last updated.
NextToken (string) --
The token to use to retrieve the next page of results.
Deletes a router input from AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.delete_router_input(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router input that you want to delete.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the deleted router input.
Name (string) --
The name of the deleted router input.
State (string) --
The current state of the deleted router input, indicating where it is in the deletion process.
Retrieves information about multiple router network interfaces in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.batch_get_router_network_interface(
Arns=[
'string',
]
)
list
[REQUIRED]
The Amazon Resource Names (ARNs) of the router network interfaces you want to retrieve information about.
(string) --
dict
Response Syntax
{
'RouterNetworkInterfaces': [
{
'Name': 'string',
'Arn': 'string',
'Id': 'string',
'State': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'ERROR'|'RECOVERING',
'NetworkInterfaceType': 'PUBLIC'|'VPC',
'Configuration': {
'Public': {
'AllowRules': [
{
'Cidr': 'string'
},
]
},
'Vpc': {
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
}
},
'AssociatedOutputCount': 123,
'AssociatedInputCount': 123,
'RegionName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
},
],
'Errors': [
{
'Arn': 'string',
'Code': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
RouterNetworkInterfaces (list) --
An array of router network interfaces that were successfully retrieved.
(dict) --
A router network interface in AWS Elemental MediaConnect. A router network interface is a network interface that can be associated with one or more router inputs and outputs.
Name (string) --
The name of the router network interface.
Arn (string) --
The Amazon Resource Name (ARN) of the router network interface.
Id (string) --
The unique identifier of the router network interface.
State (string) --
The current state of the router network interface.
NetworkInterfaceType (string) --
The type of the router network interface.
Configuration (dict) --
The configuration settings for a router network interface.
Public (dict) --
The configuration settings for a public router network interface, including the list of allowed CIDR blocks.
AllowRules (list) --
The list of allowed CIDR blocks for the public router network interface.
(dict) --
A rule that allows a specific CIDR block to access the public router network interface.
Cidr (string) --
The CIDR block that is allowed to access the public router network interface.
Vpc (dict) --
The configuration settings for a router network interface within a VPC, including the security group IDs and subnet ID.
SecurityGroupIds (list) --
The IDs of the security groups to associate with the router network interface within the VPC.
(string) --
SubnetId (string) --
The ID of the subnet within the VPC to associate the router network interface with.
AssociatedOutputCount (integer) --
The number of router outputs associated with the network interface.
AssociatedInputCount (integer) --
The number of router inputs associated with the network interface.
RegionName (string) --
The AWS Region where the router network interface is located.
CreatedAt (datetime) --
The timestamp when the router network interface was created.
UpdatedAt (datetime) --
The timestamp when the router network interface was last updated.
Tags (dict) --
Key-value pairs that can be used to tag and organize this router network interface.
(string) --
(string) --
Errors (list) --
An array of errors that occurred when retrieving the requested router network interfaces.
(dict) --
An error that occurred when retrieving multiple router network interfaces in the BatchGetRouterNetworkInterface operation, including the ARN, error code, and error message.
Arn (string) --
The Amazon Resource Name (ARN) of the router network interface for which the error occurred.
Code (string) --
The error code associated with the error.
Message (string) --
A message describing the error.
Retrieves the thumbnail for a router input in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.get_router_input_thumbnail(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router input that you want to see a thumbnail of.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'ThumbnailDetails': {
'ThumbnailMessages': [
{
'Code': 'string',
'Message': 'string'
},
],
'Thumbnail': b'bytes',
'Timecode': 'string',
'Timestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Arn (string) --
The ARN of the router input.
Name (string) --
The name of the router input.
ThumbnailDetails (dict) --
The details of the thumbnail associated with the router input, including the thumbnail image, timecode, timestamp, and any associated error messages.
ThumbnailMessages (list) --
The messages associated with the router input thumbnail.
(dict) --
A message associated with a router input, including a code and a message.
Code (string) --
The code associated with the router input message.
Message (string) --
The message text associated with the router input message.
Thumbnail (bytes) --
The thumbnail image, encoded as a Base64-encoded binary data object.
Timecode (string) --
The timecode associated with the thumbnail.
Timestamp (datetime) --
The timestamp associated with the thumbnail.
Retrieves detailed metadata information about a specific router input source, including stream details and connection state.
See also: AWS API Documentation
Request Syntax
client.get_router_input_source_metadata(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router input to retrieve metadata for.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'SourceMetadataDetails': {
'SourceMetadataMessages': [
{
'Code': 'string',
'Message': 'string'
},
],
'Timestamp': datetime(2015, 1, 1),
'RouterInputMetadata': {
'TransportStreamMediaInfo': {
'Programs': [
{
'PcrPid': 123,
'ProgramName': 'string',
'ProgramNumber': 123,
'ProgramPid': 123,
'Streams': [
{
'Channels': 123,
'Codec': 'string',
'FrameRate': 'string',
'FrameResolution': {
'FrameHeight': 123,
'FrameWidth': 123
},
'Pid': 123,
'SampleRate': 123,
'SampleSize': 123,
'StreamType': 'string'
},
]
},
]
}
}
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the router input.
Name (string) --
The name of the router input.
SourceMetadataDetails (dict) --
Detailed metadata information about the router input source, including connection state, timestamps, and stream configuration.
SourceMetadataMessages (list) --
Collection of metadata messages associated with the router input source.
(dict) --
A message associated with a router input, including a code and a message.
Code (string) --
The code associated with the router input message.
Message (string) --
The message text associated with the router input message.
Timestamp (datetime) --
The timestamp when the metadata was last updated.
RouterInputMetadata (dict) --
Metadata information specific to the router input configuration and state.
TransportStreamMediaInfo (dict) --
The metadata of the transport stream in the current flow's source.
Programs (list) --
The list of transport stream programs in the current flow's source.
(dict) --
The metadata of a single transport stream program.
PcrPid (integer) --
The Program Clock Reference (PCR) Packet ID (PID) as it is reported in the Program Association Table.
ProgramName (string) --
The program name as it is reported in the Program Association Table.
ProgramNumber (integer) --
The program number as it is reported in the Program Association Table.
ProgramPid (integer) --
The program Packet ID (PID) as it is reported in the Program Association Table.
Streams (list) --
The list of elementary transport streams in the program. The list includes video, audio, and data streams.
(dict) --
The metadata of an elementary transport stream.
Channels (integer) --
The number of channels in the audio stream.
Codec (string) --
The codec used by the stream.
FrameRate (string) --
The frame rate used by the video stream.
FrameResolution (dict) --
The frame resolution used by the video stream.
FrameHeight (integer) --
The number of pixels in the height of the video frame.
FrameWidth (integer) --
The number of pixels in the width of the video frame.
Pid (integer) --
The Packet ID (PID) as it is reported in the Program Map Table.
SampleRate (integer) --
The sample rate used by the audio stream.
SampleSize (integer) --
The sample bit size used by the audio stream.
StreamType (string) --
The Stream Type as it is reported in the Program Map Table.
Stops a router input in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.stop_router_input(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router input that you want to stop.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the router input that was stopped.
Name (string) --
The name of the router input that was stopped.
State (string) --
The current state of the router input after being stopped.
Updates the configuration of an existing router input in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.update_router_input(
Arn='string',
Name='string',
Configuration={
'Standard': {
'NetworkInterfaceArn': 'string',
'ProtocolConfiguration': {
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'SourceAddress': 'string',
'SourcePort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
},
'Failover': {
'NetworkInterfaceArn': 'string',
'ProtocolConfigurations': [
{
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'SourceAddress': 'string',
'SourcePort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
],
'SourcePriorityMode': 'NO_PRIORITY'|'PRIMARY_SECONDARY',
'PrimarySourceIndex': 123
},
'Merge': {
'NetworkInterfaceArn': 'string',
'ProtocolConfigurations': [
{
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
}
},
],
'MergeRecoveryWindowMilliseconds': 123
},
'MediaConnectFlow': {
'FlowArn': 'string',
'FlowOutputArn': 'string',
'SourceTransitDecryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
}
},
MaximumBitrate=123,
RoutingScope='REGIONAL'|'GLOBAL',
Tier='INPUT_100'|'INPUT_50'|'INPUT_20',
TransitEncryption={
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
MaintenanceConfiguration={
'PreferredDayTime': {
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'Time': 'string'
},
'Default': {}
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router input that you want to update.
string
The updated name for the router input.
dict
The updated configuration settings for the router input. Changing the type of the configuration is not supported.
Standard (dict) --
The configuration settings for a standard router input, including the protocol, protocol-specific configuration, network interface, and availability zone.
NetworkInterfaceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the network interface associated with the standard router input.
ProtocolConfiguration (dict) -- [REQUIRED]
The configuration settings for the protocol used by the standard router input.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) -- [REQUIRED]
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) -- [REQUIRED]
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) -- [REQUIRED]
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
SrtListener (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
Port (integer) -- [REQUIRED]
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) -- [REQUIRED]
The minimum latency in milliseconds for the SRT protocol in listener mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) -- [REQUIRED]
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
SourceAddress (string) -- [REQUIRED]
The source IP address for the SRT protocol in caller mode.
SourcePort (integer) -- [REQUIRED]
The source port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) -- [REQUIRED]
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) -- [REQUIRED]
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Protocol (string) --
The protocol used by the standard router input.
Failover (dict) --
Configuration settings for a failover router input that allows switching between two input sources.
NetworkInterfaceArn (string) -- [REQUIRED]
The ARN of the network interface to use for this failover router input.
ProtocolConfigurations (list) -- [REQUIRED]
A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type.
(dict) --
Protocol configuration settings for failover router inputs.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) -- [REQUIRED]
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) -- [REQUIRED]
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) -- [REQUIRED]
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
SrtListener (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
Port (integer) -- [REQUIRED]
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) -- [REQUIRED]
The minimum latency in milliseconds for the SRT protocol in listener mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) -- [REQUIRED]
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
SourceAddress (string) -- [REQUIRED]
The source IP address for the SRT protocol in caller mode.
SourcePort (integer) -- [REQUIRED]
The source port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) -- [REQUIRED]
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) -- [REQUIRED]
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SourcePriorityMode (string) -- [REQUIRED]
The mode for determining source priority in failover configurations.
PrimarySourceIndex (integer) --
The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY
Merge (dict) --
Configuration settings for a merge router input that combines two input sources.
NetworkInterfaceArn (string) -- [REQUIRED]
The ARN of the network interface to use for this merge router input.
ProtocolConfigurations (list) -- [REQUIRED]
A list of exactly two protocol configurations for the merge input sources. Both must use the same protocol type.
(dict) --
Protocol configuration settings for merge router inputs.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) -- [REQUIRED]
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) -- [REQUIRED]
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) -- [REQUIRED]
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
MergeRecoveryWindowMilliseconds (integer) -- [REQUIRED]
The time window in milliseconds for merging the two input sources.
MediaConnectFlow (dict) --
Configuration settings for connecting a router input to a flow output.
FlowArn (string) --
The ARN of the flow to connect to.
FlowOutputArn (string) --
The ARN of the flow output to connect to this router input.
SourceTransitDecryption (dict) -- [REQUIRED]
The decryption configuration for the flow source when connected to this router input.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) -- [REQUIRED]
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
integer
The updated maximum bitrate for the router input.
string
Specifies whether the router input can be assigned to outputs in different Regions. REGIONAL (default) - can be assigned only to outputs in the same Region. GLOBAL - can be assigned to outputs in any Region.
string
The updated tier level for the router input.
dict
The updated transit encryption settings for the router input.
EncryptionKeyType (string) --
Specifies the type of encryption key to use for transit encryption.
EncryptionKeyConfiguration (dict) -- [REQUIRED]
Contains the configuration details for the encryption key used in transit encryption, including the key source and associated parameters.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
dict
The updated maintenance configuration settings for the router input, including any changes to preferred maintenance windows and schedules.
PreferredDayTime (dict) --
Preferred day and time maintenance configuration settings.
Day (string) -- [REQUIRED]
The preferred day for maintenance operations.
Time (string) -- [REQUIRED]
The preferred time for maintenance operations.
Default (dict) --
Default maintenance configuration settings.
dict
Response Syntax
{
'RouterInput': {
'Name': 'string',
'Arn': 'string',
'Id': 'string',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
'InputType': 'STANDARD'|'FAILOVER'|'MERGE'|'MEDIACONNECT_FLOW',
'Configuration': {
'Standard': {
'NetworkInterfaceArn': 'string',
'ProtocolConfiguration': {
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'SourceAddress': 'string',
'SourcePort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
},
'Failover': {
'NetworkInterfaceArn': 'string',
'ProtocolConfigurations': [
{
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'SourceAddress': 'string',
'SourcePort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
],
'SourcePriorityMode': 'NO_PRIORITY'|'PRIMARY_SECONDARY',
'PrimarySourceIndex': 123
},
'Merge': {
'NetworkInterfaceArn': 'string',
'ProtocolConfigurations': [
{
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
}
},
],
'MergeRecoveryWindowMilliseconds': 123
},
'MediaConnectFlow': {
'FlowArn': 'string',
'FlowOutputArn': 'string',
'SourceTransitDecryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
}
},
'RoutedOutputs': 123,
'MaximumRoutedOutputs': 123,
'RegionName': 'string',
'AvailabilityZone': 'string',
'MaximumBitrate': 123,
'Tier': 'INPUT_100'|'INPUT_50'|'INPUT_20',
'RoutingScope': 'REGIONAL'|'GLOBAL',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Messages': [
{
'Code': 'string',
'Message': 'string'
},
],
'TransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
'Tags': {
'string': 'string'
},
'StreamDetails': {
'Standard': {
'SourceIpAddress': 'string'
},
'Failover': {
'SourceIndexZeroStreamDetails': {
'SourceIndex': 123,
'SourceIpAddress': 'string'
},
'SourceIndexOneStreamDetails': {
'SourceIndex': 123,
'SourceIpAddress': 'string'
}
},
'Merge': {
'SourceIndexZeroStreamDetails': {
'SourceIndex': 123,
'SourceIpAddress': 'string'
},
'SourceIndexOneStreamDetails': {
'SourceIndex': 123,
'SourceIpAddress': 'string'
}
},
'MediaConnectFlow': {}
},
'IpAddress': 'string',
'MaintenanceType': 'PREFERRED_DAY_TIME'|'DEFAULT',
'MaintenanceConfiguration': {
'PreferredDayTime': {
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'Time': 'string'
},
'Default': {}
},
'MaintenanceScheduleType': 'WINDOW',
'MaintenanceSchedule': {
'Window': {
'Start': datetime(2015, 1, 1),
'End': datetime(2015, 1, 1),
'ScheduledTime': datetime(2015, 1, 1)
}
}
}
}
Response Structure
(dict) --
RouterInput (dict) --
The updated router input.
Name (string) --
The name of the router input.
Arn (string) --
The Amazon Resource Name (ARN) of the router input.
Id (string) --
The unique identifier of the router input.
State (string) --
The current state of the router input.
InputType (string) --
The type of the router input.
Configuration (dict) --
The configuration settings for a router input.
Standard (dict) --
The configuration settings for a standard router input, including the protocol, protocol-specific configuration, network interface, and availability zone.
NetworkInterfaceArn (string) --
The Amazon Resource Name (ARN) of the network interface associated with the standard router input.
ProtocolConfiguration (dict) --
The configuration settings for the protocol used by the standard router input.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) --
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) --
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) --
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
SrtListener (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
Port (integer) --
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in listener mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
SourceAddress (string) --
The source IP address for the SRT protocol in caller mode.
SourcePort (integer) --
The source port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Protocol (string) --
The protocol used by the standard router input.
Failover (dict) --
Configuration settings for a failover router input that allows switching between two input sources.
NetworkInterfaceArn (string) --
The ARN of the network interface to use for this failover router input.
ProtocolConfigurations (list) --
A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type.
(dict) --
Protocol configuration settings for failover router inputs.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) --
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) --
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) --
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
SrtListener (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
Port (integer) --
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in listener mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
SourceAddress (string) --
The source IP address for the SRT protocol in caller mode.
SourcePort (integer) --
The source port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SourcePriorityMode (string) --
The mode for determining source priority in failover configurations.
PrimarySourceIndex (integer) --
The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY
Merge (dict) --
Configuration settings for a merge router input that combines two input sources.
NetworkInterfaceArn (string) --
The ARN of the network interface to use for this merge router input.
ProtocolConfigurations (list) --
A list of exactly two protocol configurations for the merge input sources. Both must use the same protocol type.
(dict) --
Protocol configuration settings for merge router inputs.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) --
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) --
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) --
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
MergeRecoveryWindowMilliseconds (integer) --
The time window in milliseconds for merging the two input sources.
MediaConnectFlow (dict) --
Configuration settings for connecting a router input to a flow output.
FlowArn (string) --
The ARN of the flow to connect to.
FlowOutputArn (string) --
The ARN of the flow output to connect to this router input.
SourceTransitDecryption (dict) --
The decryption configuration for the flow source when connected to this router input.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
RoutedOutputs (integer) --
The number of router outputs associated with the router input.
MaximumRoutedOutputs (integer) --
The maximum number of outputs that can be simultaneously routed to this input.
RegionName (string) --
The AWS Region where the router input is located.
AvailabilityZone (string) --
The Availability Zone of the router input.
MaximumBitrate (integer) --
The maximum bitrate for the router input.
Tier (string) --
The tier level of the router input.
RoutingScope (string) --
Indicates whether the router input is configured for Regional or global routing.
CreatedAt (datetime) --
The timestamp when the router input was created.
UpdatedAt (datetime) --
The timestamp when the router input was last updated.
Messages (list) --
The messages associated with the router input.
(dict) --
A message associated with a router input, including a code and a message.
Code (string) --
The code associated with the router input message.
Message (string) --
The message text associated with the router input message.
TransitEncryption (dict) --
The transit encryption settings for a router input.
EncryptionKeyType (string) --
Specifies the type of encryption key to use for transit encryption.
EncryptionKeyConfiguration (dict) --
Contains the configuration details for the encryption key used in transit encryption, including the key source and associated parameters.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
Tags (dict) --
Key-value pairs that can be used to tag and organize this router input.
(string) --
(string) --
StreamDetails (dict) --
Configuration details for the router input stream.
Standard (dict) --
Configuration details for a standard router input stream type.
SourceIpAddress (string) --
The source IP address for the standard router input stream.
Failover (dict) --
Configuration details for a failover router input that can automatically switch between two sources.
SourceIndexZeroStreamDetails (dict) --
Configuration details for the primary source (index 0) in the failover setup.
SourceIndex (integer) --
The index number (0 or 1) assigned to this source in the failover configuration.
SourceIpAddress (string) --
The IP address of the source for this indexed stream.
SourceIndexOneStreamDetails (dict) --
Configuration details for the secondary source (index 1) in the failover setup.
SourceIndex (integer) --
The index number (0 or 1) assigned to this source in the failover configuration.
SourceIpAddress (string) --
The IP address of the source for this indexed stream.
Merge (dict) --
Configuration details for a merge router input that combines two input sources.
SourceIndexZeroStreamDetails (dict) --
Configuration details for the first source (index 0) in the merge setup.
SourceIndex (integer) --
The index number (0 or 1) assigned to this source in the merge configuration.
SourceIpAddress (string) --
The IP address of the source for this indexed stream in the merge setup.
SourceIndexOneStreamDetails (dict) --
Configuration details for the second source (index 1) in the merge setup.
SourceIndex (integer) --
The index number (0 or 1) assigned to this source in the merge configuration.
SourceIpAddress (string) --
The IP address of the source for this indexed stream in the merge setup.
MediaConnectFlow (dict) --
Configuration details for a MediaConnect flow when used as a router input source.
IpAddress (string) --
The IP address of the router input.
MaintenanceType (string) --
The type of maintenance configuration applied to this router input.
MaintenanceConfiguration (dict) --
The maintenance configuration settings applied to this router input.
PreferredDayTime (dict) --
Preferred day and time maintenance configuration settings.
Day (string) --
The preferred day for maintenance operations.
Time (string) --
The preferred time for maintenance operations.
Default (dict) --
Default maintenance configuration settings.
MaintenanceScheduleType (string) --
The type of maintenance schedule currently in effect for this router input.
MaintenanceSchedule (dict) --
The current maintenance schedule details for this router input.
Window (dict) --
Defines a specific time window for maintenance operations.
Start (datetime) --
The start time of the maintenance window.
End (datetime) --
The end time of the maintenance window.
ScheduledTime (datetime) --
The date and time when the maintenance window is scheduled to occur.
Lists the tags associated with a global resource in AWS Elemental MediaConnect. The API supports the following global resources: router inputs, router outputs and router network interfaces.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_global_resource(
ResourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the global resource whose tags you want to list.
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Tags (dict) --
A map of tag keys and values associated with the global resource.
(string) --
(string) --
Deletes a router output from AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.delete_router_output(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router output that you want to delete.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the deleted router output.
Name (string) --
The name of the deleted router output.
State (string) --
The current state of the deleted router output, indicating where it is in the deletion process.
Starts a router output in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.start_router_output(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router output that you want to start.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
'MaintenanceScheduleType': 'WINDOW',
'MaintenanceSchedule': {
'Window': {
'Start': datetime(2015, 1, 1),
'End': datetime(2015, 1, 1),
'ScheduledTime': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the router output that was started.
Name (string) --
The name of the router output that was started.
State (string) --
The current state of the router output after being started.
MaintenanceScheduleType (string) --
The type of maintenance schedule associated with the router output.
MaintenanceSchedule (dict) --
The details of the maintenance schedule for the router output.
Window (dict) --
Defines a specific time window for maintenance operations.
Start (datetime) --
The start time of the maintenance window.
End (datetime) --
The end time of the maintenance window.
ScheduledTime (datetime) --
The date and time when the maintenance window is scheduled to occur.
Creates a new router network interface in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.create_router_network_interface(
Name='string',
Configuration={
'Public': {
'AllowRules': [
{
'Cidr': 'string'
},
]
},
'Vpc': {
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
}
},
RegionName='string',
Tags={
'string': 'string'
},
ClientToken='string'
)
string
[REQUIRED]
The name of the router network interface.
dict
[REQUIRED]
The configuration settings for the router network interface.
Public (dict) --
The configuration settings for a public router network interface, including the list of allowed CIDR blocks.
AllowRules (list) -- [REQUIRED]
The list of allowed CIDR blocks for the public router network interface.
(dict) --
A rule that allows a specific CIDR block to access the public router network interface.
Cidr (string) -- [REQUIRED]
The CIDR block that is allowed to access the public router network interface.
Vpc (dict) --
The configuration settings for a router network interface within a VPC, including the security group IDs and subnet ID.
SecurityGroupIds (list) -- [REQUIRED]
The IDs of the security groups to associate with the router network interface within the VPC.
(string) --
SubnetId (string) -- [REQUIRED]
The ID of the subnet within the VPC to associate the router network interface with.
string
The AWS Region for the router network interface. Defaults to the current region if not specified.
dict
Key-value pairs that can be used to tag and organize this router network interface.
(string) --
(string) --
string
A unique identifier for the request to ensure idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'RouterNetworkInterface': {
'Name': 'string',
'Arn': 'string',
'Id': 'string',
'State': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'ERROR'|'RECOVERING',
'NetworkInterfaceType': 'PUBLIC'|'VPC',
'Configuration': {
'Public': {
'AllowRules': [
{
'Cidr': 'string'
},
]
},
'Vpc': {
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
}
},
'AssociatedOutputCount': 123,
'AssociatedInputCount': 123,
'RegionName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
RouterNetworkInterface (dict) --
The newly-created router network interface.
Name (string) --
The name of the router network interface.
Arn (string) --
The Amazon Resource Name (ARN) of the router network interface.
Id (string) --
The unique identifier of the router network interface.
State (string) --
The current state of the router network interface.
NetworkInterfaceType (string) --
The type of the router network interface.
Configuration (dict) --
The configuration settings for a router network interface.
Public (dict) --
The configuration settings for a public router network interface, including the list of allowed CIDR blocks.
AllowRules (list) --
The list of allowed CIDR blocks for the public router network interface.
(dict) --
A rule that allows a specific CIDR block to access the public router network interface.
Cidr (string) --
The CIDR block that is allowed to access the public router network interface.
Vpc (dict) --
The configuration settings for a router network interface within a VPC, including the security group IDs and subnet ID.
SecurityGroupIds (list) --
The IDs of the security groups to associate with the router network interface within the VPC.
(string) --
SubnetId (string) --
The ID of the subnet within the VPC to associate the router network interface with.
AssociatedOutputCount (integer) --
The number of router outputs associated with the network interface.
AssociatedInputCount (integer) --
The number of router inputs associated with the network interface.
RegionName (string) --
The AWS Region where the router network interface is located.
CreatedAt (datetime) --
The timestamp when the router network interface was created.
UpdatedAt (datetime) --
The timestamp when the router network interface was last updated.
Tags (dict) --
Key-value pairs that can be used to tag and organize this router network interface.
(string) --
(string) --
Retrieves information about a specific router output in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.get_router_output(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router output that you want to retrieve information about.
dict
Response Syntax
{
'RouterOutput': {
'Name': 'string',
'Arn': 'string',
'Id': 'string',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
'OutputType': 'STANDARD'|'MEDIACONNECT_FLOW'|'MEDIALIVE_INPUT',
'Configuration': {
'Standard': {
'NetworkInterfaceArn': 'string',
'ProtocolConfiguration': {
'Rtp': {
'DestinationAddress': 'string',
'DestinationPort': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'DestinationAddress': 'string',
'DestinationPort': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'EncryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'DestinationAddress': 'string',
'DestinationPort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'EncryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
},
'MediaConnectFlow': {
'FlowArn': 'string',
'FlowSourceArn': 'string',
'DestinationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
},
'MediaLiveInput': {
'MediaLiveInputArn': 'string',
'MediaLivePipelineId': 'PIPELINE_0'|'PIPELINE_1',
'DestinationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
}
},
'RoutedState': 'ROUTED'|'ROUTING'|'UNROUTED',
'RegionName': 'string',
'AvailabilityZone': 'string',
'MaximumBitrate': 123,
'RoutingScope': 'REGIONAL'|'GLOBAL',
'Tier': 'OUTPUT_100'|'OUTPUT_50'|'OUTPUT_20',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Messages': [
{
'Code': 'string',
'Message': 'string'
},
],
'Tags': {
'string': 'string'
},
'StreamDetails': {
'Standard': {
'DestinationIpAddress': 'string'
},
'MediaConnectFlow': {},
'MediaLiveInput': {}
},
'IpAddress': 'string',
'RoutedInputArn': 'string',
'MaintenanceType': 'PREFERRED_DAY_TIME'|'DEFAULT',
'MaintenanceConfiguration': {
'PreferredDayTime': {
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'Time': 'string'
},
'Default': {}
},
'MaintenanceScheduleType': 'WINDOW',
'MaintenanceSchedule': {
'Window': {
'Start': datetime(2015, 1, 1),
'End': datetime(2015, 1, 1),
'ScheduledTime': datetime(2015, 1, 1)
}
}
}
}
Response Structure
(dict) --
RouterOutput (dict) --
The details of the requested router output, including its configuration, state, and other attributes.
Name (string) --
The name of the router output.
Arn (string) --
The Amazon Resource Name (ARN) of the router output.
Id (string) --
The unique identifier of the router output.
State (string) --
The overall state of the router output.
OutputType (string) --
The type of the router output.
Configuration (dict) --
The configuration settings for a router output.
Standard (dict) --
The configuration settings for a standard router output, including the protocol, protocol-specific configuration, network interface, and availability zone.
NetworkInterfaceArn (string) --
The Amazon Resource Name (ARN) of the network interface associated with the standard router output.
ProtocolConfiguration (dict) --
The configuration settings for the protocol used by the standard router output.
Rtp (dict) --
The configuration settings for a router output using the RTP (Real-Time Transport Protocol) protocol, including the destination address and port, and forward error correction state.
DestinationAddress (string) --
The destination IP address for the RTP protocol in the router output configuration.
DestinationPort (integer) --
The destination port number for the RTP protocol in the router output configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router output configuration.
Rist (dict) --
The configuration settings for a router output using the RIST (Reliable Internet Stream Transport) protocol, including the destination address and port.
DestinationAddress (string) --
The destination IP address for the RIST protocol in the router output configuration.
DestinationPort (integer) --
The destination port number for the RIST protocol in the router output configuration.
SrtListener (dict) --
The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and encryption key configuration.
Port (integer) --
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in listener mode.
EncryptionConfiguration (dict) --
Defines the encryption settings for an SRT listener output, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for encrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in caller mode, including the destination address and port, minimum latency, stream ID, and encryption key configuration.
DestinationAddress (string) --
The destination IP address for the SRT protocol in caller mode.
DestinationPort (integer) --
The destination port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
EncryptionConfiguration (dict) --
Defines the encryption settings for an SRT caller output, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for encrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Protocol (string) --
The protocol used by the standard router output.
MediaConnectFlow (dict) --
Configuration settings for connecting a router output to a MediaConnect flow source.
FlowArn (string) --
The ARN of the flow to connect to this router output.
FlowSourceArn (string) --
The ARN of the flow source to connect to this router output.
DestinationTransitEncryption (dict) --
The encryption configuration for the flow destination when connected to this router output.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
MediaLiveInput (dict) --
Configuration settings for connecting a router output to a MediaLive input.
MediaLiveInputArn (string) --
The ARN of the MediaLive input to connect to this router output.
MediaLivePipelineId (string) --
The index of the MediaLive pipeline to connect to this router output.
DestinationTransitEncryption (dict) --
The encryption configuration for the MediaLive input when connected to this router output.
EncryptionKeyType (string) --
The type of encryption key to use for MediaLive transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the MediaLive encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
RoutedState (string) --
The current state of the association between the router output and its input.
RegionName (string) --
The AWS Region where the router output is located.
AvailabilityZone (string) --
The Availability Zone of the router output.
MaximumBitrate (integer) --
The maximum bitrate for the router output.
RoutingScope (string) --
Indicates whether the router output is configured for Regional or global routing.
Tier (string) --
The tier level of the router output.
CreatedAt (datetime) --
The timestamp when the router output was created.
UpdatedAt (datetime) --
The timestamp when the router output was last updated.
Messages (list) --
The messages associated with the router output.
(dict) --
A message associated with a router output.
Code (string) --
The code associated with the router output message.
Message (string) --
The message text associated with the router output message.
Tags (dict) --
Key-value pairs that can be used to tag and organize this router output.
(string) --
(string) --
StreamDetails (dict) --
Information about the router output's stream, including connection state and destination details. The specific details provided vary based on the router output type.
Standard (dict) --
Configuration details for a standard router output stream type. Contains information about the destination IP address and connection state for basic output routing.
DestinationIpAddress (string) --
The IP address where the output stream will be sent. This is the destination address that will receive the routed media content.
MediaConnectFlow (dict) --
Configuration details for a MediaConnect flow when used as a router output destination.
MediaLiveInput (dict) --
Configuration details for a MediaLive input when used as a router output destination.
IpAddress (string) --
The IP address of the router output.
RoutedInputArn (string) --
The Amazon Resource Name (ARN) of the router input associated with the output.
MaintenanceType (string) --
The type of maintenance configuration applied to this router output.
MaintenanceConfiguration (dict) --
The maintenance configuration settings applied to this router output.
PreferredDayTime (dict) --
Preferred day and time maintenance configuration settings.
Day (string) --
The preferred day for maintenance operations.
Time (string) --
The preferred time for maintenance operations.
Default (dict) --
Default maintenance configuration settings.
MaintenanceScheduleType (string) --
The type of maintenance schedule currently in effect for this router output.
MaintenanceSchedule (dict) --
The current maintenance schedule details for this router output.
Window (dict) --
Defines a specific time window for maintenance operations.
Start (datetime) --
The start time of the maintenance window.
End (datetime) --
The end time of the maintenance window.
ScheduledTime (datetime) --
The date and time when the maintenance window is scheduled to occur.
Retrieves information about a specific router input in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.get_router_input(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router input to retrieve information about.
dict
Response Syntax
{
'RouterInput': {
'Name': 'string',
'Arn': 'string',
'Id': 'string',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
'InputType': 'STANDARD'|'FAILOVER'|'MERGE'|'MEDIACONNECT_FLOW',
'Configuration': {
'Standard': {
'NetworkInterfaceArn': 'string',
'ProtocolConfiguration': {
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'SourceAddress': 'string',
'SourcePort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
},
'Failover': {
'NetworkInterfaceArn': 'string',
'ProtocolConfigurations': [
{
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'SourceAddress': 'string',
'SourcePort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
],
'SourcePriorityMode': 'NO_PRIORITY'|'PRIMARY_SECONDARY',
'PrimarySourceIndex': 123
},
'Merge': {
'NetworkInterfaceArn': 'string',
'ProtocolConfigurations': [
{
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
}
},
],
'MergeRecoveryWindowMilliseconds': 123
},
'MediaConnectFlow': {
'FlowArn': 'string',
'FlowOutputArn': 'string',
'SourceTransitDecryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
}
},
'RoutedOutputs': 123,
'MaximumRoutedOutputs': 123,
'RegionName': 'string',
'AvailabilityZone': 'string',
'MaximumBitrate': 123,
'Tier': 'INPUT_100'|'INPUT_50'|'INPUT_20',
'RoutingScope': 'REGIONAL'|'GLOBAL',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Messages': [
{
'Code': 'string',
'Message': 'string'
},
],
'TransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
'Tags': {
'string': 'string'
},
'StreamDetails': {
'Standard': {
'SourceIpAddress': 'string'
},
'Failover': {
'SourceIndexZeroStreamDetails': {
'SourceIndex': 123,
'SourceIpAddress': 'string'
},
'SourceIndexOneStreamDetails': {
'SourceIndex': 123,
'SourceIpAddress': 'string'
}
},
'Merge': {
'SourceIndexZeroStreamDetails': {
'SourceIndex': 123,
'SourceIpAddress': 'string'
},
'SourceIndexOneStreamDetails': {
'SourceIndex': 123,
'SourceIpAddress': 'string'
}
},
'MediaConnectFlow': {}
},
'IpAddress': 'string',
'MaintenanceType': 'PREFERRED_DAY_TIME'|'DEFAULT',
'MaintenanceConfiguration': {
'PreferredDayTime': {
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'Time': 'string'
},
'Default': {}
},
'MaintenanceScheduleType': 'WINDOW',
'MaintenanceSchedule': {
'Window': {
'Start': datetime(2015, 1, 1),
'End': datetime(2015, 1, 1),
'ScheduledTime': datetime(2015, 1, 1)
}
}
}
}
Response Structure
(dict) --
RouterInput (dict) --
The details of the requested router input, including its configuration, state, and other attributes.
Name (string) --
The name of the router input.
Arn (string) --
The Amazon Resource Name (ARN) of the router input.
Id (string) --
The unique identifier of the router input.
State (string) --
The current state of the router input.
InputType (string) --
The type of the router input.
Configuration (dict) --
The configuration settings for a router input.
Standard (dict) --
The configuration settings for a standard router input, including the protocol, protocol-specific configuration, network interface, and availability zone.
NetworkInterfaceArn (string) --
The Amazon Resource Name (ARN) of the network interface associated with the standard router input.
ProtocolConfiguration (dict) --
The configuration settings for the protocol used by the standard router input.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) --
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) --
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) --
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
SrtListener (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
Port (integer) --
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in listener mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
SourceAddress (string) --
The source IP address for the SRT protocol in caller mode.
SourcePort (integer) --
The source port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Protocol (string) --
The protocol used by the standard router input.
Failover (dict) --
Configuration settings for a failover router input that allows switching between two input sources.
NetworkInterfaceArn (string) --
The ARN of the network interface to use for this failover router input.
ProtocolConfigurations (list) --
A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type.
(dict) --
Protocol configuration settings for failover router inputs.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) --
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) --
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) --
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
SrtListener (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
Port (integer) --
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in listener mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
SourceAddress (string) --
The source IP address for the SRT protocol in caller mode.
SourcePort (integer) --
The source port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SourcePriorityMode (string) --
The mode for determining source priority in failover configurations.
PrimarySourceIndex (integer) --
The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY
Merge (dict) --
Configuration settings for a merge router input that combines two input sources.
NetworkInterfaceArn (string) --
The ARN of the network interface to use for this merge router input.
ProtocolConfigurations (list) --
A list of exactly two protocol configurations for the merge input sources. Both must use the same protocol type.
(dict) --
Protocol configuration settings for merge router inputs.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) --
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) --
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) --
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
MergeRecoveryWindowMilliseconds (integer) --
The time window in milliseconds for merging the two input sources.
MediaConnectFlow (dict) --
Configuration settings for connecting a router input to a flow output.
FlowArn (string) --
The ARN of the flow to connect to.
FlowOutputArn (string) --
The ARN of the flow output to connect to this router input.
SourceTransitDecryption (dict) --
The decryption configuration for the flow source when connected to this router input.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
RoutedOutputs (integer) --
The number of router outputs associated with the router input.
MaximumRoutedOutputs (integer) --
The maximum number of outputs that can be simultaneously routed to this input.
RegionName (string) --
The AWS Region where the router input is located.
AvailabilityZone (string) --
The Availability Zone of the router input.
MaximumBitrate (integer) --
The maximum bitrate for the router input.
Tier (string) --
The tier level of the router input.
RoutingScope (string) --
Indicates whether the router input is configured for Regional or global routing.
CreatedAt (datetime) --
The timestamp when the router input was created.
UpdatedAt (datetime) --
The timestamp when the router input was last updated.
Messages (list) --
The messages associated with the router input.
(dict) --
A message associated with a router input, including a code and a message.
Code (string) --
The code associated with the router input message.
Message (string) --
The message text associated with the router input message.
TransitEncryption (dict) --
The transit encryption settings for a router input.
EncryptionKeyType (string) --
Specifies the type of encryption key to use for transit encryption.
EncryptionKeyConfiguration (dict) --
Contains the configuration details for the encryption key used in transit encryption, including the key source and associated parameters.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
Tags (dict) --
Key-value pairs that can be used to tag and organize this router input.
(string) --
(string) --
StreamDetails (dict) --
Configuration details for the router input stream.
Standard (dict) --
Configuration details for a standard router input stream type.
SourceIpAddress (string) --
The source IP address for the standard router input stream.
Failover (dict) --
Configuration details for a failover router input that can automatically switch between two sources.
SourceIndexZeroStreamDetails (dict) --
Configuration details for the primary source (index 0) in the failover setup.
SourceIndex (integer) --
The index number (0 or 1) assigned to this source in the failover configuration.
SourceIpAddress (string) --
The IP address of the source for this indexed stream.
SourceIndexOneStreamDetails (dict) --
Configuration details for the secondary source (index 1) in the failover setup.
SourceIndex (integer) --
The index number (0 or 1) assigned to this source in the failover configuration.
SourceIpAddress (string) --
The IP address of the source for this indexed stream.
Merge (dict) --
Configuration details for a merge router input that combines two input sources.
SourceIndexZeroStreamDetails (dict) --
Configuration details for the first source (index 0) in the merge setup.
SourceIndex (integer) --
The index number (0 or 1) assigned to this source in the merge configuration.
SourceIpAddress (string) --
The IP address of the source for this indexed stream in the merge setup.
SourceIndexOneStreamDetails (dict) --
Configuration details for the second source (index 1) in the merge setup.
SourceIndex (integer) --
The index number (0 or 1) assigned to this source in the merge configuration.
SourceIpAddress (string) --
The IP address of the source for this indexed stream in the merge setup.
MediaConnectFlow (dict) --
Configuration details for a MediaConnect flow when used as a router input source.
IpAddress (string) --
The IP address of the router input.
MaintenanceType (string) --
The type of maintenance configuration applied to this router input.
MaintenanceConfiguration (dict) --
The maintenance configuration settings applied to this router input.
PreferredDayTime (dict) --
Preferred day and time maintenance configuration settings.
Day (string) --
The preferred day for maintenance operations.
Time (string) --
The preferred time for maintenance operations.
Default (dict) --
Default maintenance configuration settings.
MaintenanceScheduleType (string) --
The type of maintenance schedule currently in effect for this router input.
MaintenanceSchedule (dict) --
The current maintenance schedule details for this router input.
Window (dict) --
Defines a specific time window for maintenance operations.
Start (datetime) --
The start time of the maintenance window.
End (datetime) --
The end time of the maintenance window.
ScheduledTime (datetime) --
The date and time when the maintenance window is scheduled to occur.
Stops a router output in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.stop_router_output(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router output that you want to stop.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the router output that was stopped.
Name (string) --
The name of the router output that was stopped.
State (string) --
The current state of the router output after being stopped.
Retrieves a list of router inputs in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.list_router_inputs(
MaxResults=123,
NextToken='string',
Filters=[
{
'RegionNames': [
'string',
],
'InputTypes': [
'STANDARD'|'FAILOVER'|'MERGE'|'MEDIACONNECT_FLOW',
],
'NameContains': [
'string',
],
'NetworkInterfaceArns': [
'string',
],
'RoutingScopes': [
'REGIONAL'|'GLOBAL',
]
},
]
)
integer
The maximum number of router inputs to return in the response.
string
A token used to retrieve the next page of results.
list
The filters to apply when retrieving the list of router inputs.
(dict) --
A filter that can be used to retrieve a list of router inputs.
RegionNames (list) --
The AWS Regions of the router inputs to include in the filter.
(string) --
InputTypes (list) --
The types of router inputs to include in the filter.
(string) --
NameContains (list) --
The names of the router inputs to include in the filter.
(string) --
NetworkInterfaceArns (list) --
The Amazon Resource Names (ARNs) of the network interfaces associated with the router inputs to include in the filter.
(string) --
RoutingScopes (list) --
Filter criteria to list router inputs based on their routing scope (REGIONAL or GLOBAL).
(string) --
dict
Response Syntax
{
'RouterInputs': [
{
'Name': 'string',
'Arn': 'string',
'Id': 'string',
'InputType': 'STANDARD'|'FAILOVER'|'MERGE'|'MEDIACONNECT_FLOW',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
'RoutedOutputs': 123,
'RegionName': 'string',
'AvailabilityZone': 'string',
'MaximumBitrate': 123,
'RoutingScope': 'REGIONAL'|'GLOBAL',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'MessageCount': 123,
'NetworkInterfaceArn': 'string',
'MaintenanceScheduleType': 'WINDOW',
'MaintenanceSchedule': {
'Window': {
'Start': datetime(2015, 1, 1),
'End': datetime(2015, 1, 1),
'ScheduledTime': datetime(2015, 1, 1)
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RouterInputs (list) --
The summary information for the retrieved router inputs.
(dict) --
A summary of a router input, including its name, type, ARN, ID, state, and other key details. This structure is used in the response of the ListRouterInputs operation.
Name (string) --
The name of the router input.
Arn (string) --
The Amazon Resource Name (ARN) of the router input.
Id (string) --
The unique identifier of the router input.
InputType (string) --
The type of the router input.
State (string) --
The overall state of the router input.
RoutedOutputs (integer) --
The number of router outputs that are associated with this router input.
RegionName (string) --
The AWS Region where the router input is located.
AvailabilityZone (string) --
The Availability Zone of the router input.
MaximumBitrate (integer) --
The maximum bitrate of the router input.
RoutingScope (string) --
Indicates whether the router input is configured for Regional or global routing.
CreatedAt (datetime) --
The timestamp when the router input was created.
UpdatedAt (datetime) --
The timestamp when the router input was last updated.
MessageCount (integer) --
The number of messages associated with the router input.
NetworkInterfaceArn (string) --
The ARN of the network interface associated with the router input.
MaintenanceScheduleType (string) --
The type of maintenance schedule currently associated with the listed router input.
MaintenanceSchedule (dict) --
The details of the maintenance schedule for the listed router input.
Window (dict) --
Defines a specific time window for maintenance operations.
Start (datetime) --
The start time of the maintenance window.
End (datetime) --
The end time of the maintenance window.
ScheduledTime (datetime) --
The date and time when the maintenance window is scheduled to occur.
NextToken (string) --
The token to use to retrieve the next page of results.
Restarts a router input. This operation can be used to recover from errors or refresh the input state.
See also: AWS API Documentation
Request Syntax
client.restart_router_input(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router input that you want to restart.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the router input that was restarted.
Name (string) --
The name of the router input that was restarted.
State (string) --
The current state of the router input after the restart operation.
Creates a new router input in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.create_router_input(
Name='string',
Configuration={
'Standard': {
'NetworkInterfaceArn': 'string',
'ProtocolConfiguration': {
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'SourceAddress': 'string',
'SourcePort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
},
'Failover': {
'NetworkInterfaceArn': 'string',
'ProtocolConfigurations': [
{
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'SourceAddress': 'string',
'SourcePort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
],
'SourcePriorityMode': 'NO_PRIORITY'|'PRIMARY_SECONDARY',
'PrimarySourceIndex': 123
},
'Merge': {
'NetworkInterfaceArn': 'string',
'ProtocolConfigurations': [
{
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
}
},
],
'MergeRecoveryWindowMilliseconds': 123
},
'MediaConnectFlow': {
'FlowArn': 'string',
'FlowOutputArn': 'string',
'SourceTransitDecryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
}
},
MaximumBitrate=123,
RoutingScope='REGIONAL'|'GLOBAL',
Tier='INPUT_100'|'INPUT_50'|'INPUT_20',
RegionName='string',
AvailabilityZone='string',
TransitEncryption={
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
MaintenanceConfiguration={
'PreferredDayTime': {
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'Time': 'string'
},
'Default': {}
},
Tags={
'string': 'string'
},
ClientToken='string'
)
string
[REQUIRED]
The name of the router input.
dict
[REQUIRED]
The configuration settings for the router input, which can include the protocol, network interface, and other details.
Standard (dict) --
The configuration settings for a standard router input, including the protocol, protocol-specific configuration, network interface, and availability zone.
NetworkInterfaceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the network interface associated with the standard router input.
ProtocolConfiguration (dict) -- [REQUIRED]
The configuration settings for the protocol used by the standard router input.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) -- [REQUIRED]
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) -- [REQUIRED]
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) -- [REQUIRED]
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
SrtListener (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
Port (integer) -- [REQUIRED]
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) -- [REQUIRED]
The minimum latency in milliseconds for the SRT protocol in listener mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) -- [REQUIRED]
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
SourceAddress (string) -- [REQUIRED]
The source IP address for the SRT protocol in caller mode.
SourcePort (integer) -- [REQUIRED]
The source port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) -- [REQUIRED]
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) -- [REQUIRED]
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Protocol (string) --
The protocol used by the standard router input.
Failover (dict) --
Configuration settings for a failover router input that allows switching between two input sources.
NetworkInterfaceArn (string) -- [REQUIRED]
The ARN of the network interface to use for this failover router input.
ProtocolConfigurations (list) -- [REQUIRED]
A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type.
(dict) --
Protocol configuration settings for failover router inputs.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) -- [REQUIRED]
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) -- [REQUIRED]
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) -- [REQUIRED]
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
SrtListener (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
Port (integer) -- [REQUIRED]
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) -- [REQUIRED]
The minimum latency in milliseconds for the SRT protocol in listener mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) -- [REQUIRED]
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
SourceAddress (string) -- [REQUIRED]
The source IP address for the SRT protocol in caller mode.
SourcePort (integer) -- [REQUIRED]
The source port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) -- [REQUIRED]
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) -- [REQUIRED]
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SourcePriorityMode (string) -- [REQUIRED]
The mode for determining source priority in failover configurations.
PrimarySourceIndex (integer) --
The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY
Merge (dict) --
Configuration settings for a merge router input that combines two input sources.
NetworkInterfaceArn (string) -- [REQUIRED]
The ARN of the network interface to use for this merge router input.
ProtocolConfigurations (list) -- [REQUIRED]
A list of exactly two protocol configurations for the merge input sources. Both must use the same protocol type.
(dict) --
Protocol configuration settings for merge router inputs.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) -- [REQUIRED]
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) -- [REQUIRED]
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) -- [REQUIRED]
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
MergeRecoveryWindowMilliseconds (integer) -- [REQUIRED]
The time window in milliseconds for merging the two input sources.
MediaConnectFlow (dict) --
Configuration settings for connecting a router input to a flow output.
FlowArn (string) --
The ARN of the flow to connect to.
FlowOutputArn (string) --
The ARN of the flow output to connect to this router input.
SourceTransitDecryption (dict) -- [REQUIRED]
The decryption configuration for the flow source when connected to this router input.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) -- [REQUIRED]
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
integer
[REQUIRED]
The maximum bitrate for the router input.
string
[REQUIRED]
Specifies whether the router input can be assigned to outputs in different Regions. REGIONAL (default) - connects only to outputs in same Region. GLOBAL - connects to outputs in any Region.
string
[REQUIRED]
The tier level for the router input.
string
The AWS Region for the router input. Defaults to the current region if not specified.
string
The Availability Zone where you want to create the router input. This must be a valid Availability Zone for the region specified by regionName, or the current region if no regionName is provided.
dict
The transit encryption settings for the router input.
EncryptionKeyType (string) --
Specifies the type of encryption key to use for transit encryption.
EncryptionKeyConfiguration (dict) -- [REQUIRED]
Contains the configuration details for the encryption key used in transit encryption, including the key source and associated parameters.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
dict
The maintenance configuration settings for the router input, including preferred maintenance windows and schedules.
PreferredDayTime (dict) --
Preferred day and time maintenance configuration settings.
Day (string) -- [REQUIRED]
The preferred day for maintenance operations.
Time (string) -- [REQUIRED]
The preferred time for maintenance operations.
Default (dict) --
Default maintenance configuration settings.
dict
Key-value pairs that can be used to tag and organize this router input.
(string) --
(string) --
string
A unique identifier for the request to ensure idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'RouterInput': {
'Name': 'string',
'Arn': 'string',
'Id': 'string',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
'InputType': 'STANDARD'|'FAILOVER'|'MERGE'|'MEDIACONNECT_FLOW',
'Configuration': {
'Standard': {
'NetworkInterfaceArn': 'string',
'ProtocolConfiguration': {
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'SourceAddress': 'string',
'SourcePort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
},
'Failover': {
'NetworkInterfaceArn': 'string',
'ProtocolConfigurations': [
{
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'SourceAddress': 'string',
'SourcePort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'DecryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
],
'SourcePriorityMode': 'NO_PRIORITY'|'PRIMARY_SECONDARY',
'PrimarySourceIndex': 123
},
'Merge': {
'NetworkInterfaceArn': 'string',
'ProtocolConfigurations': [
{
'Rtp': {
'Port': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'Port': 123,
'RecoveryLatencyMilliseconds': 123
}
},
],
'MergeRecoveryWindowMilliseconds': 123
},
'MediaConnectFlow': {
'FlowArn': 'string',
'FlowOutputArn': 'string',
'SourceTransitDecryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
}
},
'RoutedOutputs': 123,
'MaximumRoutedOutputs': 123,
'RegionName': 'string',
'AvailabilityZone': 'string',
'MaximumBitrate': 123,
'Tier': 'INPUT_100'|'INPUT_50'|'INPUT_20',
'RoutingScope': 'REGIONAL'|'GLOBAL',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Messages': [
{
'Code': 'string',
'Message': 'string'
},
],
'TransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
'Tags': {
'string': 'string'
},
'StreamDetails': {
'Standard': {
'SourceIpAddress': 'string'
},
'Failover': {
'SourceIndexZeroStreamDetails': {
'SourceIndex': 123,
'SourceIpAddress': 'string'
},
'SourceIndexOneStreamDetails': {
'SourceIndex': 123,
'SourceIpAddress': 'string'
}
},
'Merge': {
'SourceIndexZeroStreamDetails': {
'SourceIndex': 123,
'SourceIpAddress': 'string'
},
'SourceIndexOneStreamDetails': {
'SourceIndex': 123,
'SourceIpAddress': 'string'
}
},
'MediaConnectFlow': {}
},
'IpAddress': 'string',
'MaintenanceType': 'PREFERRED_DAY_TIME'|'DEFAULT',
'MaintenanceConfiguration': {
'PreferredDayTime': {
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'Time': 'string'
},
'Default': {}
},
'MaintenanceScheduleType': 'WINDOW',
'MaintenanceSchedule': {
'Window': {
'Start': datetime(2015, 1, 1),
'End': datetime(2015, 1, 1),
'ScheduledTime': datetime(2015, 1, 1)
}
}
}
}
Response Structure
(dict) --
RouterInput (dict) --
The newly-created router input.
Name (string) --
The name of the router input.
Arn (string) --
The Amazon Resource Name (ARN) of the router input.
Id (string) --
The unique identifier of the router input.
State (string) --
The current state of the router input.
InputType (string) --
The type of the router input.
Configuration (dict) --
The configuration settings for a router input.
Standard (dict) --
The configuration settings for a standard router input, including the protocol, protocol-specific configuration, network interface, and availability zone.
NetworkInterfaceArn (string) --
The Amazon Resource Name (ARN) of the network interface associated with the standard router input.
ProtocolConfiguration (dict) --
The configuration settings for the protocol used by the standard router input.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) --
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) --
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) --
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
SrtListener (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
Port (integer) --
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in listener mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
SourceAddress (string) --
The source IP address for the SRT protocol in caller mode.
SourcePort (integer) --
The source port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Protocol (string) --
The protocol used by the standard router input.
Failover (dict) --
Configuration settings for a failover router input that allows switching between two input sources.
NetworkInterfaceArn (string) --
The ARN of the network interface to use for this failover router input.
ProtocolConfigurations (list) --
A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type.
(dict) --
Protocol configuration settings for failover router inputs.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) --
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) --
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) --
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
SrtListener (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
Port (integer) --
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in listener mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
SourceAddress (string) --
The source IP address for the SRT protocol in caller mode.
SourcePort (integer) --
The source port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
DecryptionConfiguration (dict) --
Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SourcePriorityMode (string) --
The mode for determining source priority in failover configurations.
PrimarySourceIndex (integer) --
The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY
Merge (dict) --
Configuration settings for a merge router input that combines two input sources.
NetworkInterfaceArn (string) --
The ARN of the network interface to use for this merge router input.
ProtocolConfigurations (list) --
A list of exactly two protocol configurations for the merge input sources. Both must use the same protocol type.
(dict) --
Protocol configuration settings for merge router inputs.
Rtp (dict) --
The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
Port (integer) --
The port number used for the RTP protocol in the router input configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router input configuration.
Rist (dict) --
The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
Port (integer) --
The port number used for the RIST protocol in the router input configuration.
RecoveryLatencyMilliseconds (integer) --
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
MergeRecoveryWindowMilliseconds (integer) --
The time window in milliseconds for merging the two input sources.
MediaConnectFlow (dict) --
Configuration settings for connecting a router input to a flow output.
FlowArn (string) --
The ARN of the flow to connect to.
FlowOutputArn (string) --
The ARN of the flow output to connect to this router input.
SourceTransitDecryption (dict) --
The decryption configuration for the flow source when connected to this router input.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
RoutedOutputs (integer) --
The number of router outputs associated with the router input.
MaximumRoutedOutputs (integer) --
The maximum number of outputs that can be simultaneously routed to this input.
RegionName (string) --
The AWS Region where the router input is located.
AvailabilityZone (string) --
The Availability Zone of the router input.
MaximumBitrate (integer) --
The maximum bitrate for the router input.
Tier (string) --
The tier level of the router input.
RoutingScope (string) --
Indicates whether the router input is configured for Regional or global routing.
CreatedAt (datetime) --
The timestamp when the router input was created.
UpdatedAt (datetime) --
The timestamp when the router input was last updated.
Messages (list) --
The messages associated with the router input.
(dict) --
A message associated with a router input, including a code and a message.
Code (string) --
The code associated with the router input message.
Message (string) --
The message text associated with the router input message.
TransitEncryption (dict) --
The transit encryption settings for a router input.
EncryptionKeyType (string) --
Specifies the type of encryption key to use for transit encryption.
EncryptionKeyConfiguration (dict) --
Contains the configuration details for the encryption key used in transit encryption, including the key source and associated parameters.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
Tags (dict) --
Key-value pairs that can be used to tag and organize this router input.
(string) --
(string) --
StreamDetails (dict) --
Configuration details for the router input stream.
Standard (dict) --
Configuration details for a standard router input stream type.
SourceIpAddress (string) --
The source IP address for the standard router input stream.
Failover (dict) --
Configuration details for a failover router input that can automatically switch between two sources.
SourceIndexZeroStreamDetails (dict) --
Configuration details for the primary source (index 0) in the failover setup.
SourceIndex (integer) --
The index number (0 or 1) assigned to this source in the failover configuration.
SourceIpAddress (string) --
The IP address of the source for this indexed stream.
SourceIndexOneStreamDetails (dict) --
Configuration details for the secondary source (index 1) in the failover setup.
SourceIndex (integer) --
The index number (0 or 1) assigned to this source in the failover configuration.
SourceIpAddress (string) --
The IP address of the source for this indexed stream.
Merge (dict) --
Configuration details for a merge router input that combines two input sources.
SourceIndexZeroStreamDetails (dict) --
Configuration details for the first source (index 0) in the merge setup.
SourceIndex (integer) --
The index number (0 or 1) assigned to this source in the merge configuration.
SourceIpAddress (string) --
The IP address of the source for this indexed stream in the merge setup.
SourceIndexOneStreamDetails (dict) --
Configuration details for the second source (index 1) in the merge setup.
SourceIndex (integer) --
The index number (0 or 1) assigned to this source in the merge configuration.
SourceIpAddress (string) --
The IP address of the source for this indexed stream in the merge setup.
MediaConnectFlow (dict) --
Configuration details for a MediaConnect flow when used as a router input source.
IpAddress (string) --
The IP address of the router input.
MaintenanceType (string) --
The type of maintenance configuration applied to this router input.
MaintenanceConfiguration (dict) --
The maintenance configuration settings applied to this router input.
PreferredDayTime (dict) --
Preferred day and time maintenance configuration settings.
Day (string) --
The preferred day for maintenance operations.
Time (string) --
The preferred time for maintenance operations.
Default (dict) --
Default maintenance configuration settings.
MaintenanceScheduleType (string) --
The type of maintenance schedule currently in effect for this router input.
MaintenanceSchedule (dict) --
The current maintenance schedule details for this router input.
Window (dict) --
Defines a specific time window for maintenance operations.
Start (datetime) --
The start time of the maintenance window.
End (datetime) --
The end time of the maintenance window.
ScheduledTime (datetime) --
The date and time when the maintenance window is scheduled to occur.
Retrieves a list of router outputs in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.list_router_outputs(
MaxResults=123,
NextToken='string',
Filters=[
{
'RegionNames': [
'string',
],
'OutputTypes': [
'STANDARD'|'MEDIACONNECT_FLOW'|'MEDIALIVE_INPUT',
],
'NameContains': [
'string',
],
'NetworkInterfaceArns': [
'string',
],
'RoutedInputArns': [
'string',
],
'RoutingScopes': [
'REGIONAL'|'GLOBAL',
]
},
]
)
integer
The maximum number of router outputs to return in the response.
string
A token used to retrieve the next page of results.
list
The filters to apply when retrieving the list of router outputs.
(dict) --
A filter that can be used to retrieve a list of router outputs.
RegionNames (list) --
The AWS Regions of the router outputs to include in the filter.
(string) --
OutputTypes (list) --
The types of router outputs to include in the filter.
(string) --
NameContains (list) --
The names of the router outputs to include in the filter.
(string) --
NetworkInterfaceArns (list) --
The Amazon Resource Names (ARNs) of the network interfaces associated with the router outputs to include in the filter.
(string) --
RoutedInputArns (list) --
The ARNs of the router inputs associated with the router outputs to include in the filter.
(string) --
RoutingScopes (list) --
Filter criteria to list router outputs based on their routing scope.
(string) --
dict
Response Syntax
{
'RouterOutputs': [
{
'Name': 'string',
'Arn': 'string',
'Id': 'string',
'OutputType': 'STANDARD'|'MEDIACONNECT_FLOW'|'MEDIALIVE_INPUT',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
'RoutedState': 'ROUTED'|'ROUTING'|'UNROUTED',
'RegionName': 'string',
'AvailabilityZone': 'string',
'MaximumBitrate': 123,
'RoutingScope': 'REGIONAL'|'GLOBAL',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'MessageCount': 123,
'RoutedInputArn': 'string',
'NetworkInterfaceArn': 'string',
'MaintenanceScheduleType': 'WINDOW',
'MaintenanceSchedule': {
'Window': {
'Start': datetime(2015, 1, 1),
'End': datetime(2015, 1, 1),
'ScheduledTime': datetime(2015, 1, 1)
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RouterOutputs (list) --
The summary information for the retrieved router outputs.
(dict) --
A summary of a router output, including its name, type, ARN, ID, state, routed state, and other key details. This structure is used in the response of the ListRouterOutputs operation.
Name (string) --
The name of the router output.
Arn (string) --
The Amazon Resource Name (ARN) of the router output.
Id (string) --
The unique identifier of the router output.
OutputType (string) --
The type of the router output.
State (string) --
The overall state of the router output.
RoutedState (string) --
The current state of the association between the router output and its input.
RegionName (string) --
The AWS Region where the router output is located.
AvailabilityZone (string) --
The Availability Zone of the router output.
MaximumBitrate (integer) --
The maximum bitrate of the router output.
RoutingScope (string) --
Indicates whether the router output is configured for Regional or global routing.
CreatedAt (datetime) --
The timestamp when the router output was created.
UpdatedAt (datetime) --
The timestamp when the router output was last updated.
MessageCount (integer) --
The number of messages associated with the router output.
RoutedInputArn (string) --
The ARN of the router input associated with the output.
NetworkInterfaceArn (string) --
The ARN of the network interface associated with the router output.
MaintenanceScheduleType (string) --
The type of maintenance schedule currently associated with the listed router output.
MaintenanceSchedule (dict) --
The details of the maintenance schedule for the listed router output.
Window (dict) --
Defines a specific time window for maintenance operations.
Start (datetime) --
The start time of the maintenance window.
End (datetime) --
The end time of the maintenance window.
ScheduledTime (datetime) --
The date and time when the maintenance window is scheduled to occur.
NextToken (string) --
The token to use to retrieve the next page of results.
Removes tags from a global resource in AWS Elemental MediaConnect. The API supports the following global resources: router inputs, router outputs and router network interfaces.
See also: AWS API Documentation
Request Syntax
client.untag_global_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the global resource to remove tags from.
list
[REQUIRED]
The keys of the tags to remove from the global resource.
(string) --
None
Updates the configuration of an existing router output in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.update_router_output(
Arn='string',
Name='string',
Configuration={
'Standard': {
'NetworkInterfaceArn': 'string',
'ProtocolConfiguration': {
'Rtp': {
'DestinationAddress': 'string',
'DestinationPort': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'DestinationAddress': 'string',
'DestinationPort': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'EncryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'DestinationAddress': 'string',
'DestinationPort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'EncryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
},
'MediaConnectFlow': {
'FlowArn': 'string',
'FlowSourceArn': 'string',
'DestinationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
},
'MediaLiveInput': {
'MediaLiveInputArn': 'string',
'MediaLivePipelineId': 'PIPELINE_0'|'PIPELINE_1',
'DestinationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
}
},
MaximumBitrate=123,
RoutingScope='REGIONAL'|'GLOBAL',
Tier='OUTPUT_100'|'OUTPUT_50'|'OUTPUT_20',
MaintenanceConfiguration={
'PreferredDayTime': {
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'Time': 'string'
},
'Default': {}
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the router output that you want to update.
string
The updated name for the router output.
dict
The updated configuration settings for the router output. Changing the type of the configuration is not supported.
Standard (dict) --
The configuration settings for a standard router output, including the protocol, protocol-specific configuration, network interface, and availability zone.
NetworkInterfaceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the network interface associated with the standard router output.
ProtocolConfiguration (dict) -- [REQUIRED]
The configuration settings for the protocol used by the standard router output.
Rtp (dict) --
The configuration settings for a router output using the RTP (Real-Time Transport Protocol) protocol, including the destination address and port, and forward error correction state.
DestinationAddress (string) -- [REQUIRED]
The destination IP address for the RTP protocol in the router output configuration.
DestinationPort (integer) -- [REQUIRED]
The destination port number for the RTP protocol in the router output configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router output configuration.
Rist (dict) --
The configuration settings for a router output using the RIST (Reliable Internet Stream Transport) protocol, including the destination address and port.
DestinationAddress (string) -- [REQUIRED]
The destination IP address for the RIST protocol in the router output configuration.
DestinationPort (integer) -- [REQUIRED]
The destination port number for the RIST protocol in the router output configuration.
SrtListener (dict) --
The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and encryption key configuration.
Port (integer) -- [REQUIRED]
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) -- [REQUIRED]
The minimum latency in milliseconds for the SRT protocol in listener mode.
EncryptionConfiguration (dict) --
Defines the encryption settings for an SRT listener output, including the encryption key configuration and associated parameters.
EncryptionKey (dict) -- [REQUIRED]
Specifies the encryption key configuration used for encrypting SRT streams, including the key source and associated credentials.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in caller mode, including the destination address and port, minimum latency, stream ID, and encryption key configuration.
DestinationAddress (string) -- [REQUIRED]
The destination IP address for the SRT protocol in caller mode.
DestinationPort (integer) -- [REQUIRED]
The destination port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) -- [REQUIRED]
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
EncryptionConfiguration (dict) --
Defines the encryption settings for an SRT caller output, including the encryption key configuration and associated parameters.
EncryptionKey (dict) -- [REQUIRED]
Specifies the encryption key configuration used for encrypting SRT streams, including the key source and associated credentials.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Protocol (string) --
The protocol used by the standard router output.
MediaConnectFlow (dict) --
Configuration settings for connecting a router output to a MediaConnect flow source.
FlowArn (string) --
The ARN of the flow to connect to this router output.
FlowSourceArn (string) --
The ARN of the flow source to connect to this router output.
DestinationTransitEncryption (dict) -- [REQUIRED]
The encryption configuration for the flow destination when connected to this router output.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) -- [REQUIRED]
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
MediaLiveInput (dict) --
Configuration settings for connecting a router output to a MediaLive input.
MediaLiveInputArn (string) --
The ARN of the MediaLive input to connect to this router output.
MediaLivePipelineId (string) --
The index of the MediaLive pipeline to connect to this router output.
DestinationTransitEncryption (dict) -- [REQUIRED]
The encryption configuration for the MediaLive input when connected to this router output.
EncryptionKeyType (string) --
The type of encryption key to use for MediaLive transit encryption.
EncryptionKeyConfiguration (dict) -- [REQUIRED]
The configuration details for the MediaLive encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
integer
The updated maximum bitrate for the router output.
string
Specifies whether the router output can take inputs that are in different Regions. REGIONAL (default) - can only take inputs from same Region. GLOBAL - can take inputs from any Region.
string
The updated tier level for the router output.
dict
The updated maintenance configuration settings for the router output, including any changes to preferred maintenance windows and schedules.
PreferredDayTime (dict) --
Preferred day and time maintenance configuration settings.
Day (string) -- [REQUIRED]
The preferred day for maintenance operations.
Time (string) -- [REQUIRED]
The preferred time for maintenance operations.
Default (dict) --
Default maintenance configuration settings.
dict
Response Syntax
{
'RouterOutput': {
'Name': 'string',
'Arn': 'string',
'Id': 'string',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
'OutputType': 'STANDARD'|'MEDIACONNECT_FLOW'|'MEDIALIVE_INPUT',
'Configuration': {
'Standard': {
'NetworkInterfaceArn': 'string',
'ProtocolConfiguration': {
'Rtp': {
'DestinationAddress': 'string',
'DestinationPort': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'DestinationAddress': 'string',
'DestinationPort': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'EncryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'DestinationAddress': 'string',
'DestinationPort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'EncryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
},
'MediaConnectFlow': {
'FlowArn': 'string',
'FlowSourceArn': 'string',
'DestinationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
},
'MediaLiveInput': {
'MediaLiveInputArn': 'string',
'MediaLivePipelineId': 'PIPELINE_0'|'PIPELINE_1',
'DestinationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
}
},
'RoutedState': 'ROUTED'|'ROUTING'|'UNROUTED',
'RegionName': 'string',
'AvailabilityZone': 'string',
'MaximumBitrate': 123,
'RoutingScope': 'REGIONAL'|'GLOBAL',
'Tier': 'OUTPUT_100'|'OUTPUT_50'|'OUTPUT_20',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Messages': [
{
'Code': 'string',
'Message': 'string'
},
],
'Tags': {
'string': 'string'
},
'StreamDetails': {
'Standard': {
'DestinationIpAddress': 'string'
},
'MediaConnectFlow': {},
'MediaLiveInput': {}
},
'IpAddress': 'string',
'RoutedInputArn': 'string',
'MaintenanceType': 'PREFERRED_DAY_TIME'|'DEFAULT',
'MaintenanceConfiguration': {
'PreferredDayTime': {
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'Time': 'string'
},
'Default': {}
},
'MaintenanceScheduleType': 'WINDOW',
'MaintenanceSchedule': {
'Window': {
'Start': datetime(2015, 1, 1),
'End': datetime(2015, 1, 1),
'ScheduledTime': datetime(2015, 1, 1)
}
}
}
}
Response Structure
(dict) --
RouterOutput (dict) --
The updated router output.
Name (string) --
The name of the router output.
Arn (string) --
The Amazon Resource Name (ARN) of the router output.
Id (string) --
The unique identifier of the router output.
State (string) --
The overall state of the router output.
OutputType (string) --
The type of the router output.
Configuration (dict) --
The configuration settings for a router output.
Standard (dict) --
The configuration settings for a standard router output, including the protocol, protocol-specific configuration, network interface, and availability zone.
NetworkInterfaceArn (string) --
The Amazon Resource Name (ARN) of the network interface associated with the standard router output.
ProtocolConfiguration (dict) --
The configuration settings for the protocol used by the standard router output.
Rtp (dict) --
The configuration settings for a router output using the RTP (Real-Time Transport Protocol) protocol, including the destination address and port, and forward error correction state.
DestinationAddress (string) --
The destination IP address for the RTP protocol in the router output configuration.
DestinationPort (integer) --
The destination port number for the RTP protocol in the router output configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router output configuration.
Rist (dict) --
The configuration settings for a router output using the RIST (Reliable Internet Stream Transport) protocol, including the destination address and port.
DestinationAddress (string) --
The destination IP address for the RIST protocol in the router output configuration.
DestinationPort (integer) --
The destination port number for the RIST protocol in the router output configuration.
SrtListener (dict) --
The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and encryption key configuration.
Port (integer) --
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in listener mode.
EncryptionConfiguration (dict) --
Defines the encryption settings for an SRT listener output, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for encrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in caller mode, including the destination address and port, minimum latency, stream ID, and encryption key configuration.
DestinationAddress (string) --
The destination IP address for the SRT protocol in caller mode.
DestinationPort (integer) --
The destination port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
EncryptionConfiguration (dict) --
Defines the encryption settings for an SRT caller output, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for encrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Protocol (string) --
The protocol used by the standard router output.
MediaConnectFlow (dict) --
Configuration settings for connecting a router output to a MediaConnect flow source.
FlowArn (string) --
The ARN of the flow to connect to this router output.
FlowSourceArn (string) --
The ARN of the flow source to connect to this router output.
DestinationTransitEncryption (dict) --
The encryption configuration for the flow destination when connected to this router output.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
MediaLiveInput (dict) --
Configuration settings for connecting a router output to a MediaLive input.
MediaLiveInputArn (string) --
The ARN of the MediaLive input to connect to this router output.
MediaLivePipelineId (string) --
The index of the MediaLive pipeline to connect to this router output.
DestinationTransitEncryption (dict) --
The encryption configuration for the MediaLive input when connected to this router output.
EncryptionKeyType (string) --
The type of encryption key to use for MediaLive transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the MediaLive encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
RoutedState (string) --
The current state of the association between the router output and its input.
RegionName (string) --
The AWS Region where the router output is located.
AvailabilityZone (string) --
The Availability Zone of the router output.
MaximumBitrate (integer) --
The maximum bitrate for the router output.
RoutingScope (string) --
Indicates whether the router output is configured for Regional or global routing.
Tier (string) --
The tier level of the router output.
CreatedAt (datetime) --
The timestamp when the router output was created.
UpdatedAt (datetime) --
The timestamp when the router output was last updated.
Messages (list) --
The messages associated with the router output.
(dict) --
A message associated with a router output.
Code (string) --
The code associated with the router output message.
Message (string) --
The message text associated with the router output message.
Tags (dict) --
Key-value pairs that can be used to tag and organize this router output.
(string) --
(string) --
StreamDetails (dict) --
Information about the router output's stream, including connection state and destination details. The specific details provided vary based on the router output type.
Standard (dict) --
Configuration details for a standard router output stream type. Contains information about the destination IP address and connection state for basic output routing.
DestinationIpAddress (string) --
The IP address where the output stream will be sent. This is the destination address that will receive the routed media content.
MediaConnectFlow (dict) --
Configuration details for a MediaConnect flow when used as a router output destination.
MediaLiveInput (dict) --
Configuration details for a MediaLive input when used as a router output destination.
IpAddress (string) --
The IP address of the router output.
RoutedInputArn (string) --
The Amazon Resource Name (ARN) of the router input associated with the output.
MaintenanceType (string) --
The type of maintenance configuration applied to this router output.
MaintenanceConfiguration (dict) --
The maintenance configuration settings applied to this router output.
PreferredDayTime (dict) --
Preferred day and time maintenance configuration settings.
Day (string) --
The preferred day for maintenance operations.
Time (string) --
The preferred time for maintenance operations.
Default (dict) --
Default maintenance configuration settings.
MaintenanceScheduleType (string) --
The type of maintenance schedule currently in effect for this router output.
MaintenanceSchedule (dict) --
The current maintenance schedule details for this router output.
Window (dict) --
Defines a specific time window for maintenance operations.
Start (datetime) --
The start time of the maintenance window.
End (datetime) --
The end time of the maintenance window.
ScheduledTime (datetime) --
The date and time when the maintenance window is scheduled to occur.
Adds tags to a global resource in AWS Elemental MediaConnect. The API supports the following global resources: router inputs, router outputs and router network interfaces.
See also: AWS API Documentation
Request Syntax
client.tag_global_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the global resource to tag.
dict
[REQUIRED]
A map of tag keys and values to add to the global resource.
(string) --
(string) --
None
Retrieves information about multiple router outputs in AWS Elemental MediaConnect.
See also: AWS API Documentation
Request Syntax
client.batch_get_router_output(
Arns=[
'string',
]
)
list
[REQUIRED]
The Amazon Resource Names (ARNs) of the router outputs you want to retrieve information about.
(string) --
dict
Response Syntax
{
'RouterOutputs': [
{
'Name': 'string',
'Arn': 'string',
'Id': 'string',
'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
'OutputType': 'STANDARD'|'MEDIACONNECT_FLOW'|'MEDIALIVE_INPUT',
'Configuration': {
'Standard': {
'NetworkInterfaceArn': 'string',
'ProtocolConfiguration': {
'Rtp': {
'DestinationAddress': 'string',
'DestinationPort': 123,
'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
},
'Rist': {
'DestinationAddress': 'string',
'DestinationPort': 123
},
'SrtListener': {
'Port': 123,
'MinimumLatencyMilliseconds': 123,
'EncryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
},
'SrtCaller': {
'DestinationAddress': 'string',
'DestinationPort': 123,
'MinimumLatencyMilliseconds': 123,
'StreamId': 'string',
'EncryptionConfiguration': {
'EncryptionKey': {
'SecretArn': 'string',
'RoleArn': 'string'
}
}
}
},
'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
},
'MediaConnectFlow': {
'FlowArn': 'string',
'FlowSourceArn': 'string',
'DestinationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
},
'MediaLiveInput': {
'MediaLiveInputArn': 'string',
'MediaLivePipelineId': 'PIPELINE_0'|'PIPELINE_1',
'DestinationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
}
},
'RoutedState': 'ROUTED'|'ROUTING'|'UNROUTED',
'RegionName': 'string',
'AvailabilityZone': 'string',
'MaximumBitrate': 123,
'RoutingScope': 'REGIONAL'|'GLOBAL',
'Tier': 'OUTPUT_100'|'OUTPUT_50'|'OUTPUT_20',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Messages': [
{
'Code': 'string',
'Message': 'string'
},
],
'Tags': {
'string': 'string'
},
'StreamDetails': {
'Standard': {
'DestinationIpAddress': 'string'
},
'MediaConnectFlow': {},
'MediaLiveInput': {}
},
'IpAddress': 'string',
'RoutedInputArn': 'string',
'MaintenanceType': 'PREFERRED_DAY_TIME'|'DEFAULT',
'MaintenanceConfiguration': {
'PreferredDayTime': {
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'Time': 'string'
},
'Default': {}
},
'MaintenanceScheduleType': 'WINDOW',
'MaintenanceSchedule': {
'Window': {
'Start': datetime(2015, 1, 1),
'End': datetime(2015, 1, 1),
'ScheduledTime': datetime(2015, 1, 1)
}
}
},
],
'Errors': [
{
'Arn': 'string',
'Code': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
RouterOutputs (list) --
An array of router outputs that were successfully retrieved.
(dict) --
A router output in AWS Elemental MediaConnect. A router output is a destination for media content that can receive input from one or more router inputs.
Name (string) --
The name of the router output.
Arn (string) --
The Amazon Resource Name (ARN) of the router output.
Id (string) --
The unique identifier of the router output.
State (string) --
The overall state of the router output.
OutputType (string) --
The type of the router output.
Configuration (dict) --
The configuration settings for a router output.
Standard (dict) --
The configuration settings for a standard router output, including the protocol, protocol-specific configuration, network interface, and availability zone.
NetworkInterfaceArn (string) --
The Amazon Resource Name (ARN) of the network interface associated with the standard router output.
ProtocolConfiguration (dict) --
The configuration settings for the protocol used by the standard router output.
Rtp (dict) --
The configuration settings for a router output using the RTP (Real-Time Transport Protocol) protocol, including the destination address and port, and forward error correction state.
DestinationAddress (string) --
The destination IP address for the RTP protocol in the router output configuration.
DestinationPort (integer) --
The destination port number for the RTP protocol in the router output configuration.
ForwardErrorCorrection (string) --
The state of forward error correction for the RTP protocol in the router output configuration.
Rist (dict) --
The configuration settings for a router output using the RIST (Reliable Internet Stream Transport) protocol, including the destination address and port.
DestinationAddress (string) --
The destination IP address for the RIST protocol in the router output configuration.
DestinationPort (integer) --
The destination port number for the RIST protocol in the router output configuration.
SrtListener (dict) --
The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and encryption key configuration.
Port (integer) --
The port number for the SRT protocol in listener mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in listener mode.
EncryptionConfiguration (dict) --
Defines the encryption settings for an SRT listener output, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for encrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
SrtCaller (dict) --
The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in caller mode, including the destination address and port, minimum latency, stream ID, and encryption key configuration.
DestinationAddress (string) --
The destination IP address for the SRT protocol in caller mode.
DestinationPort (integer) --
The destination port number for the SRT protocol in caller mode.
MinimumLatencyMilliseconds (integer) --
The minimum latency in milliseconds for the SRT protocol in caller mode.
StreamId (string) --
The stream ID for the SRT protocol in caller mode.
EncryptionConfiguration (dict) --
Defines the encryption settings for an SRT caller output, including the encryption key configuration and associated parameters.
EncryptionKey (dict) --
Specifies the encryption key configuration used for encrypting SRT streams, including the key source and associated credentials.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Protocol (string) --
The protocol used by the standard router output.
MediaConnectFlow (dict) --
Configuration settings for connecting a router output to a MediaConnect flow source.
FlowArn (string) --
The ARN of the flow to connect to this router output.
FlowSourceArn (string) --
The ARN of the flow source to connect to this router output.
DestinationTransitEncryption (dict) --
The encryption configuration for the flow destination when connected to this router output.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
MediaLiveInput (dict) --
Configuration settings for connecting a router output to a MediaLive input.
MediaLiveInputArn (string) --
The ARN of the MediaLive input to connect to this router output.
MediaLivePipelineId (string) --
The index of the MediaLive pipeline to connect to this router output.
DestinationTransitEncryption (dict) --
The encryption configuration for the MediaLive input when connected to this router output.
EncryptionKeyType (string) --
The type of encryption key to use for MediaLive transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the MediaLive encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
RoutedState (string) --
The current state of the association between the router output and its input.
RegionName (string) --
The AWS Region where the router output is located.
AvailabilityZone (string) --
The Availability Zone of the router output.
MaximumBitrate (integer) --
The maximum bitrate for the router output.
RoutingScope (string) --
Indicates whether the router output is configured for Regional or global routing.
Tier (string) --
The tier level of the router output.
CreatedAt (datetime) --
The timestamp when the router output was created.
UpdatedAt (datetime) --
The timestamp when the router output was last updated.
Messages (list) --
The messages associated with the router output.
(dict) --
A message associated with a router output.
Code (string) --
The code associated with the router output message.
Message (string) --
The message text associated with the router output message.
Tags (dict) --
Key-value pairs that can be used to tag and organize this router output.
(string) --
(string) --
StreamDetails (dict) --
Information about the router output's stream, including connection state and destination details. The specific details provided vary based on the router output type.
Standard (dict) --
Configuration details for a standard router output stream type. Contains information about the destination IP address and connection state for basic output routing.
DestinationIpAddress (string) --
The IP address where the output stream will be sent. This is the destination address that will receive the routed media content.
MediaConnectFlow (dict) --
Configuration details for a MediaConnect flow when used as a router output destination.
MediaLiveInput (dict) --
Configuration details for a MediaLive input when used as a router output destination.
IpAddress (string) --
The IP address of the router output.
RoutedInputArn (string) --
The Amazon Resource Name (ARN) of the router input associated with the output.
MaintenanceType (string) --
The type of maintenance configuration applied to this router output.
MaintenanceConfiguration (dict) --
The maintenance configuration settings applied to this router output.
PreferredDayTime (dict) --
Preferred day and time maintenance configuration settings.
Day (string) --
The preferred day for maintenance operations.
Time (string) --
The preferred time for maintenance operations.
Default (dict) --
Default maintenance configuration settings.
MaintenanceScheduleType (string) --
The type of maintenance schedule currently in effect for this router output.
MaintenanceSchedule (dict) --
The current maintenance schedule details for this router output.
Window (dict) --
Defines a specific time window for maintenance operations.
Start (datetime) --
The start time of the maintenance window.
End (datetime) --
The end time of the maintenance window.
ScheduledTime (datetime) --
The date and time when the maintenance window is scheduled to occur.
Errors (list) --
An array of errors that occurred when retrieving the requested router outputs.
(dict) --
An error that occurred when retrieving multiple router outputs in the BatchGetRouterOutput operation, including the ARN, error code, and error message.
Arn (string) --
The Amazon Resource Name (ARN) of the router output for which the error occurred.
Code (string) --
The error code associated with the error.
Message (string) --
A message describing the error.
{'Outputs': {'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitEncryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}}}
Response {'Outputs': {'ConnectedRouterInputArn': 'string',
'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitEncryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}}}
Adds outputs to an existing flow. You can create up to 50 outputs per flow.
See also: AWS API Documentation
Request Syntax
client.add_flow_outputs(
FlowArn='string',
Outputs=[
{
'CidrAllowList': [
'string',
],
'Description': 'string',
'Destination': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'MaxLatency': 123,
'MediaStreamOutputConfigurations': [
{
'DestinationConfigurations': [
{
'DestinationIp': 'string',
'DestinationPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'EncodingParameters': {
'CompressionFactor': 123.0,
'EncoderProfile': 'main'|'high'
},
'MediaStreamName': 'string'
},
],
'MinLatency': 123,
'Name': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'RemoteId': 'string',
'SenderControlPort': 123,
'SmoothingLatency': 123,
'StreamId': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'OutputStatus': 'ENABLED'|'DISABLED',
'NdiSpeedHqQuality': 123,
'NdiProgramName': 'string',
'OutputTags': {
'string': 'string'
},
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the flow that you want to add outputs to.
list
[REQUIRED]
A list of outputs that you want to add to the flow.
(dict) --
A request to add an output to a 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 Audit Manager console and will not be seen by the end user.
Destination (string) --
The IP address from which video will be sent to output destinations.
Encryption (dict) --
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Allowable encryption types: static-key.
Algorithm (string) --
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) --
A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
DeviceId (string) --
The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
KeyType (string) --
The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) --
The Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (string) --
The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based and 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 media streams that you want to associate with the output.
(dict) --
The definition of a media stream that you want to associate with the output.
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) --
The protocol to use for the output.
RemoteId (string) --
The remote ID for the Zixi-pull output stream.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SmoothingLatency (integer) --
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this output.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
OutputStatus (string) --
An indication of whether the new output should be enabled or disabled as soon as it is created. If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED.
NdiSpeedHqQuality (integer) --
A quality setting for the NDI Speed HQ encoder.
NdiProgramName (string) --
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
OutputTags (dict) --
The key-value pairs that can be used to tag and organize the output.
(string) --
(string) --
RouterIntegrationState (string) --
Indicates whether to enable or disable router integration when creating a new flow output.
RouterIntegrationTransitEncryption (dict) --
The configuration that defines how content is encrypted during transit between the MediaConnect router and a MediaConnect flow.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) -- [REQUIRED]
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
dict
Response Syntax
{
'FlowArn': 'string',
'Outputs': [
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Destination': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'ListenerAddress': 'string',
'MediaLiveInputArn': 'string',
'MediaStreamOutputConfigurations': [
{
'DestinationConfigurations': [
{
'DestinationIp': 'string',
'DestinationPort': 123,
'Interface': {
'Name': 'string'
},
'OutboundIp': 'string'
},
],
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'EncodingParameters': {
'CompressionFactor': 123.0,
'EncoderProfile': 'main'|'high'
},
'MediaStreamName': 'string'
},
],
'Name': 'string',
'OutputArn': 'string',
'Port': 123,
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'NdiSpeedHqQuality': 123,
'NdiProgramName': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'BridgeArn': 'string',
'BridgePorts': [
123,
],
'OutputStatus': 'ENABLED'|'DISABLED',
'PeerIpAddress': 'string',
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
'ConnectedRouterInputArn': 'string'
},
]
}
Response Structure
(dict) --
FlowArn (string) --
The ARN of the flow that these outputs were added to.
Outputs (list) --
The details of the newly added outputs.
(dict) --
The settings for an output.
DataTransferSubscriberFeePercent (integer) --
Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) --
A description of the output.
Destination (string) --
The address where you want to send the output.
Encryption (dict) --
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Algorithm (string) --
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) --
A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
DeviceId (string) --
The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
KeyType (string) --
The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) --
The Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 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 you want to associate with an outbound media stream.
DestinationIp (string) --
The IP address where you want MediaConnect to send contents of the media stream.
DestinationPort (integer) --
The port that you want MediaConnect to use when it distributes the media stream to the output.
Interface (dict) --
The VPC interface that you want to use 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 or 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) --
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) --
A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
EncoderProfile (string) --
A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.
MediaStreamName (string) --
The name of the media stream.
Name (string) --
The name of the output. This value must be unique within the current flow.
OutputArn (string) --
The ARN of the output.
Port (integer) --
The port to use when content is distributed to this output.
Transport (dict) --
Attributes related to the transport stream that are used in the output.
CidrAllowList (list) --
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16
(string) --
MaxBitrate (integer) --
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based 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.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) --
The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) --
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) --
Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) --
Source port for SRT-caller protocol.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
NdiSpeedHqQuality (integer) --
A quality setting for the NDI Speed HQ encoder.
NdiProgramName (string) --
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this output.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
BridgeArn (string) --
The ARN of the bridge added to this output.
BridgePorts (list) --
The bridge output ports currently in use.
(integer) --
OutputStatus (string) --
An indication of whether the output is transmitting data or not.
PeerIpAddress (string) --
The IP address of the device that is currently receiving content from this output.
RouterIntegrationState (string) --
Indicates if router integration is enabled or disabled on the flow output.
RouterIntegrationTransitEncryption (dict) --
The encryption configuration for the output when router integration is enabled.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
ConnectedRouterInputArn (string) --
The ARN of the router input that's connected to this flow output.
{'Sources': {'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitDecryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}}}
Response {'Sources': {'ConnectedRouterOutputArn': 'string',
'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitDecryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}}}
Adds sources to a flow.
See also: AWS API Documentation
Request Syntax
client.add_flow_sources(
FlowArn='string',
Sources=[
{
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestPort': 123,
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'MinLatency': 123,
'Name': 'string',
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
'SourceTags': {
'string': 'string'
},
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitDecryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the flow that you want to update.
list
[REQUIRED]
A list of sources that you want to add to the flow.
(dict) --
The settings for the source of the flow.
Decryption (dict) --
The type of encryption that is used on the content ingested from this source. Allowable encryption types: static-key.
Algorithm (string) --
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) --
A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
DeviceId (string) --
The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
KeyType (string) --
The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) --
The Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 MediaConnect account.
EntitlementArn (string) --
The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
IngestPort (integer) --
The port that the flow will be listening on for incoming content.
MaxBitrate (integer) --
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based 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 media stream that you want to associate with the source, and the parameters for that association.
EncodingName (string) -- [REQUIRED]
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 media streams that you want to associate with the source.
(dict) --
The transport parameters that you want to associate with an incoming media stream.
InputPort (integer) -- [REQUIRED]
The port that you want the flow to listen on for an incoming media stream.
Interface (dict) -- [REQUIRED]
The VPC interface that you want to use for the incoming media stream.
Name (string) -- [REQUIRED]
The name of the VPC interface.
MediaStreamName (string) -- [REQUIRED]
The name of the media stream.
MinLatency (integer) --
The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
Name (string) --
The name of the source.
Protocol (string) --
The protocol that is used by the source.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) --
The IP address that the flow communicates with to initiate connection with the sender.
SourceListenerAddress (string) --
Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) --
Source port for SRT-caller protocol.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceName (string) --
The name of the VPC interface to use for this source.
WhitelistCidr (string) --
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) --
The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) -- [REQUIRED]
The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
SourceTags (dict) --
The key-value pairs that can be used to tag and organize the source.
(string) --
(string) --
RouterIntegrationState (string) --
Indicates whether to enable or disable router integration when setting a flow source.
RouterIntegrationTransitDecryption (dict) --
The decryption configuration for the flow source when router integration is enabled. Specifies how the source content should be decrypted when router integration is used.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) -- [REQUIRED]
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
dict
Response Syntax
{
'FlowArn': 'string',
'Sources': [
{
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputIp': 'string',
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'Name': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'NdiSpeedHqQuality': 123,
'NdiProgramName': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
'PeerIpAddress': 'string',
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitDecryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
'ConnectedRouterOutputArn': 'string'
},
]
}
Response Structure
(dict) --
FlowArn (string) --
The ARN of the flow that these sources were added to.
Sources (list) --
The details of the newly added sources.
(dict) --
The settings for the source of the flow.
DataTransferSubscriberFeePercent (integer) --
Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Decryption (dict) --
The type of encryption that is used on the content ingested from this source.
Algorithm (string) --
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) --
A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
DeviceId (string) --
The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
KeyType (string) --
The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) --
The Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 MediaConnect account.
EntitlementArn (string) --
The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services 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 media streams that you want to associate with the source.
(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) --
A name that helps you distinguish one media stream from another.
Name (string) --
The name of the source.
SenderControlPort (integer) --
The IP address that the flow communicates with to initiate connection with the sender.
SenderIpAddress (string) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SourceArn (string) --
The ARN of the source.
Transport (dict) --
Attributes related to the transport stream that are used in the source.
CidrAllowList (list) --
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16
(string) --
MaxBitrate (integer) --
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based 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.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) --
The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) --
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) --
Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) --
Source port for SRT-caller protocol.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
NdiSpeedHqQuality (integer) --
A quality setting for the NDI Speed HQ encoder.
NdiProgramName (string) --
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
VpcInterfaceName (string) --
The name of the VPC interface that is used for this source.
WhitelistCidr (string) --
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) --
The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) --
The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
PeerIpAddress (string) --
The IP address of the device that is currently sending content to this source.
RouterIntegrationState (string) --
Indicates if router integration is enabled or disabled on the flow source.
RouterIntegrationTransitDecryption (dict) --
The decryption configuration for the flow source when router integration is enabled.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
ConnectedRouterOutputArn (string) --
The ARN of the router output that's currently connected to this source.
{'Outputs': {'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitEncryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}},
'Source': {'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitDecryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}},
'Sources': {'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitDecryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}}}
Response {'Flow': {'Outputs': {'ConnectedRouterInputArn': 'string',
'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitEncryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}},
'Source': {'ConnectedRouterOutputArn': 'string',
'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitDecryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}},
'Sources': {'ConnectedRouterOutputArn': 'string',
'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitDecryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}}}}
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',
],
'EntitlementTags': {
'string': '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',
'MediaStreamTags': {
'string': 'string'
}
},
],
Name='string',
Outputs=[
{
'CidrAllowList': [
'string',
],
'Description': 'string',
'Destination': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'MaxLatency': 123,
'MediaStreamOutputConfigurations': [
{
'DestinationConfigurations': [
{
'DestinationIp': 'string',
'DestinationPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'EncodingParameters': {
'CompressionFactor': 123.0,
'EncoderProfile': 'main'|'high'
},
'MediaStreamName': 'string'
},
],
'MinLatency': 123,
'Name': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'RemoteId': 'string',
'SenderControlPort': 123,
'SmoothingLatency': 123,
'StreamId': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'OutputStatus': 'ENABLED'|'DISABLED',
'NdiSpeedHqQuality': 123,
'NdiProgramName': 'string',
'OutputTags': {
'string': 'string'
},
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
},
],
Source={
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestPort': 123,
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'MinLatency': 123,
'Name': 'string',
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
'SourceTags': {
'string': 'string'
},
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitDecryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
},
SourceFailoverConfig={
'FailoverMode': 'MERGE'|'FAILOVER',
'RecoveryWindow': 123,
'SourcePriority': {
'PrimarySource': 'string'
},
'State': 'ENABLED'|'DISABLED'
},
Sources=[
{
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestPort': 123,
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'MinLatency': 123,
'Name': 'string',
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
'SourceTags': {
'string': 'string'
},
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitDecryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
},
],
VpcInterfaces=[
{
'Name': 'string',
'NetworkInterfaceType': 'ena'|'efa',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string',
'VpcInterfaceTags': {
'string': 'string'
}
},
],
Maintenance={
'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
'MaintenanceStartHour': 'string'
},
SourceMonitoringConfig={
'ThumbnailState': 'ENABLED'|'DISABLED',
'AudioMonitoringSettings': [
{
'SilentAudio': {
'State': 'ENABLED'|'DISABLED',
'ThresholdSeconds': 123
}
},
],
'ContentQualityAnalysisState': 'ENABLED'|'DISABLED',
'VideoMonitoringSettings': [
{
'BlackFrames': {
'State': 'ENABLED'|'DISABLED',
'ThresholdSeconds': 123
},
'FrozenFrames': {
'State': 'ENABLED'|'DISABLED',
'ThresholdSeconds': 123
}
},
]
},
FlowSize='MEDIUM'|'LARGE',
NdiConfig={
'NdiState': 'ENABLED'|'DISABLED',
'MachineName': 'string',
'NdiDiscoveryServers': [
{
'DiscoveryServerAddress': 'string',
'DiscoveryServerPort': 123,
'VpcInterfaceAdapter': 'string'
},
]
},
FlowTags={
'string': 'string'
}
)
string
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services 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 MediaConnect console and will not be seen by the subscriber or end user.
Encryption (dict) --
The type of encryption that will be used on the output that is associated with this entitlement. Allowable encryption types: static-key, speke.
Algorithm (string) --
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) --
A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
DeviceId (string) --
The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
KeyType (string) --
The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) --
The Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 Amazon Web Services 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) --
EntitlementTags (dict) --
The key-value pairs that can be used to tag and organize the entitlement.
(string) --
(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.
MediaStreamTags (dict) --
The key-value pairs that can be used to tag and organize the media stream.
(string) --
(string) --
string
[REQUIRED]
The name of the flow.
list
The outputs that you want to add to this flow.
(dict) --
A request to add an output to a 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 Audit Manager console and will not be seen by the end user.
Destination (string) --
The IP address from which video will be sent to output destinations.
Encryption (dict) --
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Allowable encryption types: static-key.
Algorithm (string) --
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) --
A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
DeviceId (string) --
The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
KeyType (string) --
The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) --
The Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (string) --
The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based and 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 media streams that you want to associate with the output.
(dict) --
The definition of a media stream that you want to associate with the output.
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) --
The protocol to use for the output.
RemoteId (string) --
The remote ID for the Zixi-pull output stream.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SmoothingLatency (integer) --
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this output.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
OutputStatus (string) --
An indication of whether the new output should be enabled or disabled as soon as it is created. If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED.
NdiSpeedHqQuality (integer) --
A quality setting for the NDI Speed HQ encoder.
NdiProgramName (string) --
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
OutputTags (dict) --
The key-value pairs that can be used to tag and organize the output.
(string) --
(string) --
RouterIntegrationState (string) --
Indicates whether to enable or disable router integration when creating a new flow output.
RouterIntegrationTransitEncryption (dict) --
The configuration that defines how content is encrypted during transit between the MediaConnect router and a MediaConnect flow.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) -- [REQUIRED]
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
dict
The settings for the source that you want to use for the new flow.
Decryption (dict) --
The type of encryption that is used on the content ingested from this source. Allowable encryption types: static-key.
Algorithm (string) --
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) --
A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
DeviceId (string) --
The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
KeyType (string) --
The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) --
The Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 MediaConnect account.
EntitlementArn (string) --
The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
IngestPort (integer) --
The port that the flow will be listening on for incoming content.
MaxBitrate (integer) --
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based 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 media stream that you want to associate with the source, and the parameters for that association.
EncodingName (string) -- [REQUIRED]
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 media streams that you want to associate with the source.
(dict) --
The transport parameters that you want to associate with an incoming media stream.
InputPort (integer) -- [REQUIRED]
The port that you want the flow to listen on for an incoming media stream.
Interface (dict) -- [REQUIRED]
The VPC interface that you want to use for the incoming media stream.
Name (string) -- [REQUIRED]
The name of the VPC interface.
MediaStreamName (string) -- [REQUIRED]
The name of the media stream.
MinLatency (integer) --
The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
Name (string) --
The name of the source.
Protocol (string) --
The protocol that is used by the source.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) --
The IP address that the flow communicates with to initiate connection with the sender.
SourceListenerAddress (string) --
Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) --
Source port for SRT-caller protocol.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceName (string) --
The name of the VPC interface to use for this source.
WhitelistCidr (string) --
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) --
The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) -- [REQUIRED]
The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
SourceTags (dict) --
The key-value pairs that can be used to tag and organize the source.
(string) --
(string) --
RouterIntegrationState (string) --
Indicates whether to enable or disable router integration when setting a flow source.
RouterIntegrationTransitDecryption (dict) --
The decryption configuration for the flow source when router integration is enabled. Specifies how the source content should be decrypted when router integration is used.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) -- [REQUIRED]
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
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) --
The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.
list
The sources that are assigned to the flow.
(dict) --
The settings for the source of the flow.
Decryption (dict) --
The type of encryption that is used on the content ingested from this source. Allowable encryption types: static-key.
Algorithm (string) --
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) --
A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
DeviceId (string) --
The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
KeyType (string) --
The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) --
The Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 MediaConnect account.
EntitlementArn (string) --
The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
IngestPort (integer) --
The port that the flow will be listening on for incoming content.
MaxBitrate (integer) --
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based 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 media stream that you want to associate with the source, and the parameters for that association.
EncodingName (string) -- [REQUIRED]
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 media streams that you want to associate with the source.
(dict) --
The transport parameters that you want to associate with an incoming media stream.
InputPort (integer) -- [REQUIRED]
The port that you want the flow to listen on for an incoming media stream.
Interface (dict) -- [REQUIRED]
The VPC interface that you want to use for the incoming media stream.
Name (string) -- [REQUIRED]
The name of the VPC interface.
MediaStreamName (string) -- [REQUIRED]
The name of the media stream.
MinLatency (integer) --
The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
Name (string) --
The name of the source.
Protocol (string) --
The protocol that is used by the source.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) --
The IP address that the flow communicates with to initiate connection with the sender.
SourceListenerAddress (string) --
Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) --
Source port for SRT-caller protocol.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceName (string) --
The name of the VPC interface to use for this source.
WhitelistCidr (string) --
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) --
The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) -- [REQUIRED]
The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
SourceTags (dict) --
The key-value pairs that can be used to tag and organize the source.
(string) --
(string) --
RouterIntegrationState (string) --
Indicates whether to enable or disable router integration when setting a flow source.
RouterIntegrationTransitDecryption (dict) --
The decryption configuration for the flow source when router integration is enabled. Specifies how the source content should be decrypted when router integration is used.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) -- [REQUIRED]
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
list
The VPC interfaces you want on the flow.
(dict) --
The details of the VPC interfaces that you want to add to the flow.
Name (string) -- [REQUIRED]
The name for the VPC interface. This name must be unique within the flow.
NetworkInterfaceType (string) --
The type of network interface.
RoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the role that you created when you set up MediaConnect as a trusted service.
SecurityGroupIds (list) -- [REQUIRED]
A virtual firewall to control inbound and outbound traffic.
(string) --
SubnetId (string) -- [REQUIRED]
The subnet IDs that you want to use for your VPC interface. A range of IP addresses in your VPC. When you create your VPC, you specify a range of IPv4 addresses for the VPC in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. This is the primary CIDR block for your VPC. When you create a subnet for your VPC, you specify the CIDR block for the subnet, which is a subset of the VPC CIDR block. The subnets that you use across all VPC interfaces on the flow must be in the same Availability Zone as the flow.
VpcInterfaceTags (dict) --
The key-value pairs that can be used to tag and organize the VPC network interface.
(string) --
(string) --
dict
The maintenance settings you want to use for the flow.
MaintenanceDay (string) -- [REQUIRED]
A day of a week when the maintenance will happen.
MaintenanceStartHour (string) -- [REQUIRED]
UTC time when the maintenance will happen.
Use 24-hour HH:MM format.
Minutes must be 00.
Example: 13:00.
The default value is 02:00.
dict
The settings for source monitoring.
ThumbnailState (string) --
Indicates whether thumbnails are enabled or disabled.
AudioMonitoringSettings (list) --
Contains the settings for audio stream metrics monitoring.
(dict) --
Specifies the configuration for audio stream metrics monitoring.
SilentAudio (dict) --
Detects periods of silence.
State (string) --
Indicates whether the SilentAudio metric is enabled or disabled.
ThresholdSeconds (integer) --
Specifies the number of consecutive seconds of silence that triggers an event or alert.
ContentQualityAnalysisState (string) --
Indicates whether content quality analysis is enabled or disabled.
VideoMonitoringSettings (list) --
Contains the settings for video stream metrics monitoring.
(dict) --
Specifies the configuration for video stream metrics monitoring.
BlackFrames (dict) --
Detects video frames that are black.
State (string) --
Indicates whether the BlackFrames metric is enabled or disabled..
ThresholdSeconds (integer) --
Specifies the number of consecutive seconds of black frames that triggers an event or alert.
FrozenFrames (dict) --
Detects video frames that have not changed.
State (string) --
Indicates whether the FrozenFrames metric is enabled or disabled.
ThresholdSeconds (integer) --
Specifies the number of consecutive seconds of a static image that triggers an event or alert.
string
Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.
dict
Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.
NdiState (string) --
A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED.
MachineName (string) --
A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix.
NdiDiscoveryServers (list) --
A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly.
(dict) --
Specifies the configuration settings for individual NDI discovery servers. A maximum of 3 servers is allowed.
DiscoveryServerAddress (string) -- [REQUIRED]
The unique network address of the NDI discovery server.
DiscoveryServerPort (integer) --
The port for the NDI discovery server. Defaults to 5959 if a custom port isn't specified.
VpcInterfaceAdapter (string) -- [REQUIRED]
The identifier for the Virtual Private Cloud (VPC) network interface used by the flow.
dict
The key-value pairs that can be used to tag and organize the flow.
(string) --
(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'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'NdiSpeedHqQuality': 123,
'NdiProgramName': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'BridgeArn': 'string',
'BridgePorts': [
123,
],
'OutputStatus': 'ENABLED'|'DISABLED',
'PeerIpAddress': 'string',
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
'ConnectedRouterInputArn': 'string'
},
],
'Source': {
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputIp': 'string',
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'Name': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'NdiSpeedHqQuality': 123,
'NdiProgramName': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
'PeerIpAddress': 'string',
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitDecryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
'ConnectedRouterOutputArn': 'string'
},
'SourceFailoverConfig': {
'FailoverMode': 'MERGE'|'FAILOVER',
'RecoveryWindow': 123,
'SourcePriority': {
'PrimarySource': 'string'
},
'State': 'ENABLED'|'DISABLED'
},
'Sources': [
{
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputIp': 'string',
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'Name': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'NdiSpeedHqQuality': 123,
'NdiProgramName': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
'PeerIpAddress': 'string',
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitDecryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
'ConnectedRouterOutputArn': 'string'
},
],
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
'VpcInterfaces': [
{
'Name': 'string',
'NetworkInterfaceIds': [
'string',
],
'NetworkInterfaceType': 'ena'|'efa',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
},
],
'Maintenance': {
'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
'MaintenanceDeadline': 'string',
'MaintenanceScheduledDate': 'string',
'MaintenanceStartHour': 'string'
},
'SourceMonitoringConfig': {
'ThumbnailState': 'ENABLED'|'DISABLED',
'AudioMonitoringSettings': [
{
'SilentAudio': {
'State': 'ENABLED'|'DISABLED',
'ThresholdSeconds': 123
}
},
],
'ContentQualityAnalysisState': 'ENABLED'|'DISABLED',
'VideoMonitoringSettings': [
{
'BlackFrames': {
'State': 'ENABLED'|'DISABLED',
'ThresholdSeconds': 123
},
'FrozenFrames': {
'State': 'ENABLED'|'DISABLED',
'ThresholdSeconds': 123
}
},
]
},
'FlowSize': 'MEDIUM'|'LARGE',
'NdiConfig': {
'NdiState': 'ENABLED'|'DISABLED',
'MachineName': 'string',
'NdiDiscoveryServers': [
{
'DiscoveryServerAddress': 'string',
'DiscoveryServerPort': 123,
'VpcInterfaceAdapter': 'string'
},
]
}
}
}
Response Structure
(dict) --
Flow (dict) --
The flow that you created.
AvailabilityZone (string) --
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services Region.
Description (string) --
A description of the flow. This value is not used or seen outside of the current 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 Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 Amazon Web Services account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
(string) --
FlowArn (string) --
The Amazon Resource Name (ARN) of the flow.
MediaStreams (list) --
The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
(dict) --
A media stream represents one component of your content, such as video, audio, or ancillary data. After you add a media stream to your flow, you can associate it with sources and outputs that use the ST 2110 JPEG XS or CDI protocol.
Attributes (dict) --
Attributes that are related to the 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 used for the representation of color.
ExactFramerate (string) --
The frame rate for the video stream, in frames/second. For example: 60000/1001.
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 Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 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 you want to associate with an outbound media stream.
DestinationIp (string) --
The IP address where you want MediaConnect to send contents of the media stream.
DestinationPort (integer) --
The port that you want MediaConnect to use when it distributes the media stream to the output.
Interface (dict) --
The VPC interface that you want to use 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 or 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) --
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) --
A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
EncoderProfile (string) --
A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.
MediaStreamName (string) --
The name of the media stream.
Name (string) --
The name of the output. This value must be unique within the current flow.
OutputArn (string) --
The ARN of the output.
Port (integer) --
The port to use when content is distributed to this output.
Transport (dict) --
Attributes related to the transport stream that are used in the output.
CidrAllowList (list) --
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16
(string) --
MaxBitrate (integer) --
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based 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.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) --
The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) --
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) --
Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) --
Source port for SRT-caller protocol.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
NdiSpeedHqQuality (integer) --
A quality setting for the NDI Speed HQ encoder.
NdiProgramName (string) --
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this output.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
BridgeArn (string) --
The ARN of the bridge added to this output.
BridgePorts (list) --
The bridge output ports currently in use.
(integer) --
OutputStatus (string) --
An indication of whether the output is transmitting data or not.
PeerIpAddress (string) --
The IP address of the device that is currently receiving content from this output.
RouterIntegrationState (string) --
Indicates if router integration is enabled or disabled on the flow output.
RouterIntegrationTransitEncryption (dict) --
The encryption configuration for the output when router integration is enabled.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
ConnectedRouterInputArn (string) --
The ARN of the router input that's connected to this flow output.
Source (dict) --
The source for 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 Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 MediaConnect account.
EntitlementArn (string) --
The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services 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 media streams that you want to associate with the source.
(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) --
A name that helps you distinguish one media stream from another.
Name (string) --
The name of the source.
SenderControlPort (integer) --
The IP address that the flow communicates with to initiate connection with the sender.
SenderIpAddress (string) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SourceArn (string) --
The ARN of the source.
Transport (dict) --
Attributes related to the transport stream that are used in the source.
CidrAllowList (list) --
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16
(string) --
MaxBitrate (integer) --
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based 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.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) --
The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) --
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) --
Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) --
Source port for SRT-caller protocol.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
NdiSpeedHqQuality (integer) --
A quality setting for the NDI Speed HQ encoder.
NdiProgramName (string) --
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
VpcInterfaceName (string) --
The name of the VPC interface that is used for this source.
WhitelistCidr (string) --
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) --
The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) --
The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
PeerIpAddress (string) --
The IP address of the device that is currently sending content to this source.
RouterIntegrationState (string) --
Indicates if router integration is enabled or disabled on the flow source.
RouterIntegrationTransitDecryption (dict) --
The decryption configuration for the flow source when router integration is enabled.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
ConnectedRouterOutputArn (string) --
The ARN of the router output that's currently connected to this source.
SourceFailoverConfig (dict) --
The settings for the 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) --
The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.
Sources (list) --
The settings for the sources that are assigned to the flow.
(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 Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 MediaConnect account.
EntitlementArn (string) --
The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services 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 media streams that you want to associate with the source.
(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) --
A name that helps you distinguish one media stream from another.
Name (string) --
The name of the source.
SenderControlPort (integer) --
The IP address that the flow communicates with to initiate connection with the sender.
SenderIpAddress (string) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SourceArn (string) --
The ARN of the source.
Transport (dict) --
Attributes related to the transport stream that are used in the source.
CidrAllowList (list) --
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16
(string) --
MaxBitrate (integer) --
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based 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.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) --
The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) --
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) --
Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) --
Source port for SRT-caller protocol.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
NdiSpeedHqQuality (integer) --
A quality setting for the NDI Speed HQ encoder.
NdiProgramName (string) --
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
VpcInterfaceName (string) --
The name of the VPC interface that is used for this source.
WhitelistCidr (string) --
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) --
The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) --
The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
PeerIpAddress (string) --
The IP address of the device that is currently sending content to this source.
RouterIntegrationState (string) --
Indicates if router integration is enabled or disabled on the flow source.
RouterIntegrationTransitDecryption (dict) --
The decryption configuration for the flow source when router integration is enabled.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
ConnectedRouterOutputArn (string) --
The ARN of the router output that's currently connected to this source.
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) --
A role Arn MediaConnect can assume to create ENIs in your account.
SecurityGroupIds (list) --
Security Group IDs to be used on ENI.
(string) --
SubnetId (string) --
Subnet must be in the AZ of the Flow.
Maintenance (dict) --
The maintenance settings for the flow.
MaintenanceDay (string) --
A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
MaintenanceDeadline (string) --
The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.
MaintenanceScheduledDate (string) --
A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
MaintenanceStartHour (string) --
UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
SourceMonitoringConfig (dict) --
The settings for source monitoring.
ThumbnailState (string) --
Indicates whether thumbnails are enabled or disabled.
AudioMonitoringSettings (list) --
Contains the settings for audio stream metrics monitoring.
(dict) --
Specifies the configuration for audio stream metrics monitoring.
SilentAudio (dict) --
Detects periods of silence.
State (string) --
Indicates whether the SilentAudio metric is enabled or disabled.
ThresholdSeconds (integer) --
Specifies the number of consecutive seconds of silence that triggers an event or alert.
ContentQualityAnalysisState (string) --
Indicates whether content quality analysis is enabled or disabled.
VideoMonitoringSettings (list) --
Contains the settings for video stream metrics monitoring.
(dict) --
Specifies the configuration for video stream metrics monitoring.
BlackFrames (dict) --
Detects video frames that are black.
State (string) --
Indicates whether the BlackFrames metric is enabled or disabled..
ThresholdSeconds (integer) --
Specifies the number of consecutive seconds of black frames that triggers an event or alert.
FrozenFrames (dict) --
Detects video frames that have not changed.
State (string) --
Indicates whether the FrozenFrames metric is enabled or disabled.
ThresholdSeconds (integer) --
Specifies the number of consecutive seconds of a static image that triggers an event or alert.
FlowSize (string) --
Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.
NdiConfig (dict) --
Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.
NdiState (string) --
A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED.
MachineName (string) --
A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix.
NdiDiscoveryServers (list) --
A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly.
(dict) --
Specifies the configuration settings for individual NDI discovery servers. A maximum of 3 servers is allowed.
DiscoveryServerAddress (string) --
The unique network address of the NDI discovery server.
DiscoveryServerPort (integer) --
The port for the NDI discovery server. Defaults to 5959 if a custom port isn't specified.
VpcInterfaceAdapter (string) --
The identifier for the Virtual Private Cloud (VPC) network interface used by the flow.
{'Flow': {'Outputs': {'ConnectedRouterInputArn': 'string',
'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitEncryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}},
'Source': {'ConnectedRouterOutputArn': 'string',
'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitDecryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}},
'Sources': {'ConnectedRouterOutputArn': 'string',
'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitDecryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}}}}
Displays the details of a flow. The response includes the flow Amazon Resource Name (ARN), name, and Availability Zone, as well as details about the source, outputs, and entitlements.
See also: AWS API Documentation
Request Syntax
client.describe_flow(
FlowArn='string'
)
string
[REQUIRED]
The ARN of the flow that you want to describe.
dict
Response Syntax
{
'Flow': {
'AvailabilityZone': 'string',
'Description': 'string',
'EgressIp': 'string',
'Entitlements': [
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'EntitlementStatus': 'ENABLED'|'DISABLED',
'Name': 'string',
'Subscribers': [
'string',
]
},
],
'FlowArn': 'string',
'MediaStreams': [
{
'Attributes': {
'Fmtp': {
'ChannelOrder': 'string',
'Colorimetry': 'BT601'|'BT709'|'BT2020'|'BT2100'|'ST2065-1'|'ST2065-3'|'XYZ',
'ExactFramerate': 'string',
'Par': 'string',
'Range': 'NARROW'|'FULL'|'FULLPROTECT',
'ScanMode': 'progressive'|'interlace'|'progressive-segmented-frame',
'Tcs': 'SDR'|'PQ'|'HLG'|'LINEAR'|'BT2100LINPQ'|'BT2100LINHLG'|'ST2065-1'|'ST428-1'|'DENSITY'
},
'Lang': 'string'
},
'ClockRate': 123,
'Description': 'string',
'Fmt': 123,
'MediaStreamId': 123,
'MediaStreamName': 'string',
'MediaStreamType': 'video'|'audio'|'ancillary-data',
'VideoFormat': 'string'
},
],
'Name': 'string',
'Outputs': [
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Destination': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'ListenerAddress': 'string',
'MediaLiveInputArn': 'string',
'MediaStreamOutputConfigurations': [
{
'DestinationConfigurations': [
{
'DestinationIp': 'string',
'DestinationPort': 123,
'Interface': {
'Name': 'string'
},
'OutboundIp': 'string'
},
],
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'EncodingParameters': {
'CompressionFactor': 123.0,
'EncoderProfile': 'main'|'high'
},
'MediaStreamName': 'string'
},
],
'Name': 'string',
'OutputArn': 'string',
'Port': 123,
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'NdiSpeedHqQuality': 123,
'NdiProgramName': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'BridgeArn': 'string',
'BridgePorts': [
123,
],
'OutputStatus': 'ENABLED'|'DISABLED',
'PeerIpAddress': 'string',
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
'ConnectedRouterInputArn': 'string'
},
],
'Source': {
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputIp': 'string',
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'Name': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'NdiSpeedHqQuality': 123,
'NdiProgramName': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
'PeerIpAddress': 'string',
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitDecryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
'ConnectedRouterOutputArn': 'string'
},
'SourceFailoverConfig': {
'FailoverMode': 'MERGE'|'FAILOVER',
'RecoveryWindow': 123,
'SourcePriority': {
'PrimarySource': 'string'
},
'State': 'ENABLED'|'DISABLED'
},
'Sources': [
{
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputIp': 'string',
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'Name': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'NdiSpeedHqQuality': 123,
'NdiProgramName': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
'PeerIpAddress': 'string',
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitDecryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
'ConnectedRouterOutputArn': 'string'
},
],
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
'VpcInterfaces': [
{
'Name': 'string',
'NetworkInterfaceIds': [
'string',
],
'NetworkInterfaceType': 'ena'|'efa',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
},
],
'Maintenance': {
'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
'MaintenanceDeadline': 'string',
'MaintenanceScheduledDate': 'string',
'MaintenanceStartHour': 'string'
},
'SourceMonitoringConfig': {
'ThumbnailState': 'ENABLED'|'DISABLED',
'AudioMonitoringSettings': [
{
'SilentAudio': {
'State': 'ENABLED'|'DISABLED',
'ThresholdSeconds': 123
}
},
],
'ContentQualityAnalysisState': 'ENABLED'|'DISABLED',
'VideoMonitoringSettings': [
{
'BlackFrames': {
'State': 'ENABLED'|'DISABLED',
'ThresholdSeconds': 123
},
'FrozenFrames': {
'State': 'ENABLED'|'DISABLED',
'ThresholdSeconds': 123
}
},
]
},
'FlowSize': 'MEDIUM'|'LARGE',
'NdiConfig': {
'NdiState': 'ENABLED'|'DISABLED',
'MachineName': 'string',
'NdiDiscoveryServers': [
{
'DiscoveryServerAddress': 'string',
'DiscoveryServerPort': 123,
'VpcInterfaceAdapter': 'string'
},
]
}
},
'Messages': {
'Errors': [
'string',
]
}
}
Response Structure
(dict) --
Flow (dict) --
The flow that you requested a description of.
AvailabilityZone (string) --
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services Region.
Description (string) --
A description of the flow. This value is not used or seen outside of the current 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 Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 Amazon Web Services account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
(string) --
FlowArn (string) --
The Amazon Resource Name (ARN) of the flow.
MediaStreams (list) --
The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
(dict) --
A media stream represents one component of your content, such as video, audio, or ancillary data. After you add a media stream to your flow, you can associate it with sources and outputs that use the ST 2110 JPEG XS or CDI protocol.
Attributes (dict) --
Attributes that are related to the 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 used for the representation of color.
ExactFramerate (string) --
The frame rate for the video stream, in frames/second. For example: 60000/1001.
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 Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 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 you want to associate with an outbound media stream.
DestinationIp (string) --
The IP address where you want MediaConnect to send contents of the media stream.
DestinationPort (integer) --
The port that you want MediaConnect to use when it distributes the media stream to the output.
Interface (dict) --
The VPC interface that you want to use 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 or 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) --
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) --
A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
EncoderProfile (string) --
A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.
MediaStreamName (string) --
The name of the media stream.
Name (string) --
The name of the output. This value must be unique within the current flow.
OutputArn (string) --
The ARN of the output.
Port (integer) --
The port to use when content is distributed to this output.
Transport (dict) --
Attributes related to the transport stream that are used in the output.
CidrAllowList (list) --
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16
(string) --
MaxBitrate (integer) --
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based 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.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) --
The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) --
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) --
Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) --
Source port for SRT-caller protocol.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
NdiSpeedHqQuality (integer) --
A quality setting for the NDI Speed HQ encoder.
NdiProgramName (string) --
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this output.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
BridgeArn (string) --
The ARN of the bridge added to this output.
BridgePorts (list) --
The bridge output ports currently in use.
(integer) --
OutputStatus (string) --
An indication of whether the output is transmitting data or not.
PeerIpAddress (string) --
The IP address of the device that is currently receiving content from this output.
RouterIntegrationState (string) --
Indicates if router integration is enabled or disabled on the flow output.
RouterIntegrationTransitEncryption (dict) --
The encryption configuration for the output when router integration is enabled.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
ConnectedRouterInputArn (string) --
The ARN of the router input that's connected to this flow output.
Source (dict) --
The source for 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 Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 MediaConnect account.
EntitlementArn (string) --
The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services 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 media streams that you want to associate with the source.
(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) --
A name that helps you distinguish one media stream from another.
Name (string) --
The name of the source.
SenderControlPort (integer) --
The IP address that the flow communicates with to initiate connection with the sender.
SenderIpAddress (string) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SourceArn (string) --
The ARN of the source.
Transport (dict) --
Attributes related to the transport stream that are used in the source.
CidrAllowList (list) --
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16
(string) --
MaxBitrate (integer) --
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based 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.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) --
The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) --
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) --
Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) --
Source port for SRT-caller protocol.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
NdiSpeedHqQuality (integer) --
A quality setting for the NDI Speed HQ encoder.
NdiProgramName (string) --
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
VpcInterfaceName (string) --
The name of the VPC interface that is used for this source.
WhitelistCidr (string) --
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) --
The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) --
The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
PeerIpAddress (string) --
The IP address of the device that is currently sending content to this source.
RouterIntegrationState (string) --
Indicates if router integration is enabled or disabled on the flow source.
RouterIntegrationTransitDecryption (dict) --
The decryption configuration for the flow source when router integration is enabled.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
ConnectedRouterOutputArn (string) --
The ARN of the router output that's currently connected to this source.
SourceFailoverConfig (dict) --
The settings for the 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) --
The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.
Sources (list) --
The settings for the sources that are assigned to the flow.
(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 Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 MediaConnect account.
EntitlementArn (string) --
The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services 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 media streams that you want to associate with the source.
(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) --
A name that helps you distinguish one media stream from another.
Name (string) --
The name of the source.
SenderControlPort (integer) --
The IP address that the flow communicates with to initiate connection with the sender.
SenderIpAddress (string) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SourceArn (string) --
The ARN of the source.
Transport (dict) --
Attributes related to the transport stream that are used in the source.
CidrAllowList (list) --
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16
(string) --
MaxBitrate (integer) --
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based 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.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) --
The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) --
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) --
Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) --
Source port for SRT-caller protocol.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
NdiSpeedHqQuality (integer) --
A quality setting for the NDI Speed HQ encoder.
NdiProgramName (string) --
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
VpcInterfaceName (string) --
The name of the VPC interface that is used for this source.
WhitelistCidr (string) --
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) --
The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) --
The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
PeerIpAddress (string) --
The IP address of the device that is currently sending content to this source.
RouterIntegrationState (string) --
Indicates if router integration is enabled or disabled on the flow source.
RouterIntegrationTransitDecryption (dict) --
The decryption configuration for the flow source when router integration is enabled.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
ConnectedRouterOutputArn (string) --
The ARN of the router output that's currently connected to this source.
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) --
A role Arn MediaConnect can assume to create ENIs in your account.
SecurityGroupIds (list) --
Security Group IDs to be used on ENI.
(string) --
SubnetId (string) --
Subnet must be in the AZ of the Flow.
Maintenance (dict) --
The maintenance settings for the flow.
MaintenanceDay (string) --
A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
MaintenanceDeadline (string) --
The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.
MaintenanceScheduledDate (string) --
A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
MaintenanceStartHour (string) --
UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
SourceMonitoringConfig (dict) --
The settings for source monitoring.
ThumbnailState (string) --
Indicates whether thumbnails are enabled or disabled.
AudioMonitoringSettings (list) --
Contains the settings for audio stream metrics monitoring.
(dict) --
Specifies the configuration for audio stream metrics monitoring.
SilentAudio (dict) --
Detects periods of silence.
State (string) --
Indicates whether the SilentAudio metric is enabled or disabled.
ThresholdSeconds (integer) --
Specifies the number of consecutive seconds of silence that triggers an event or alert.
ContentQualityAnalysisState (string) --
Indicates whether content quality analysis is enabled or disabled.
VideoMonitoringSettings (list) --
Contains the settings for video stream metrics monitoring.
(dict) --
Specifies the configuration for video stream metrics monitoring.
BlackFrames (dict) --
Detects video frames that are black.
State (string) --
Indicates whether the BlackFrames metric is enabled or disabled..
ThresholdSeconds (integer) --
Specifies the number of consecutive seconds of black frames that triggers an event or alert.
FrozenFrames (dict) --
Detects video frames that have not changed.
State (string) --
Indicates whether the FrozenFrames metric is enabled or disabled.
ThresholdSeconds (integer) --
Specifies the number of consecutive seconds of a static image that triggers an event or alert.
FlowSize (string) --
Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.
NdiConfig (dict) --
Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.
NdiState (string) --
A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED.
MachineName (string) --
A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix.
NdiDiscoveryServers (list) --
A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly.
(dict) --
Specifies the configuration settings for individual NDI discovery servers. A maximum of 3 servers is allowed.
DiscoveryServerAddress (string) --
The unique network address of the NDI discovery server.
DiscoveryServerPort (integer) --
The port for the NDI discovery server. Defaults to 5959 if a custom port isn't specified.
VpcInterfaceAdapter (string) --
The identifier for the Virtual Private Cloud (VPC) network interface used by the flow.
Messages (dict) --
Any errors that apply currently to the flow. If there are no errors, MediaConnect will not include this field in the response.
Errors (list) --
A list of errors that might have been generated from processes on this flow.
(string) --
{'Flow': {'Outputs': {'ConnectedRouterInputArn': 'string',
'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitEncryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}},
'Source': {'ConnectedRouterOutputArn': 'string',
'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitDecryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}},
'Sources': {'ConnectedRouterOutputArn': 'string',
'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitDecryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}}}}
Updates an existing flow.
See also: AWS API Documentation
Request Syntax
client.update_flow(
FlowArn='string',
SourceFailoverConfig={
'FailoverMode': 'MERGE'|'FAILOVER',
'RecoveryWindow': 123,
'SourcePriority': {
'PrimarySource': 'string'
},
'State': 'ENABLED'|'DISABLED'
},
Maintenance={
'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
'MaintenanceScheduledDate': 'string',
'MaintenanceStartHour': 'string'
},
SourceMonitoringConfig={
'ThumbnailState': 'ENABLED'|'DISABLED',
'AudioMonitoringSettings': [
{
'SilentAudio': {
'State': 'ENABLED'|'DISABLED',
'ThresholdSeconds': 123
}
},
],
'ContentQualityAnalysisState': 'ENABLED'|'DISABLED',
'VideoMonitoringSettings': [
{
'BlackFrames': {
'State': 'ENABLED'|'DISABLED',
'ThresholdSeconds': 123
},
'FrozenFrames': {
'State': 'ENABLED'|'DISABLED',
'ThresholdSeconds': 123
}
},
]
},
NdiConfig={
'NdiState': 'ENABLED'|'DISABLED',
'MachineName': 'string',
'NdiDiscoveryServers': [
{
'DiscoveryServerAddress': 'string',
'DiscoveryServerPort': 123,
'VpcInterfaceAdapter': 'string'
},
]
},
FlowSize='MEDIUM'|'LARGE'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of 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) --
The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.
dict
The maintenance setting of the flow.
MaintenanceDay (string) --
A day of a week when the maintenance will happen.
MaintenanceScheduledDate (string) --
A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
MaintenanceStartHour (string) --
UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
dict
The settings for source monitoring.
ThumbnailState (string) --
Indicates whether thumbnails are enabled or disabled.
AudioMonitoringSettings (list) --
Contains the settings for audio stream metrics monitoring.
(dict) --
Specifies the configuration for audio stream metrics monitoring.
SilentAudio (dict) --
Detects periods of silence.
State (string) --
Indicates whether the SilentAudio metric is enabled or disabled.
ThresholdSeconds (integer) --
Specifies the number of consecutive seconds of silence that triggers an event or alert.
ContentQualityAnalysisState (string) --
Indicates whether content quality analysis is enabled or disabled.
VideoMonitoringSettings (list) --
Contains the settings for video stream metrics monitoring.
(dict) --
Specifies the configuration for video stream metrics monitoring.
BlackFrames (dict) --
Detects video frames that are black.
State (string) --
Indicates whether the BlackFrames metric is enabled or disabled..
ThresholdSeconds (integer) --
Specifies the number of consecutive seconds of black frames that triggers an event or alert.
FrozenFrames (dict) --
Detects video frames that have not changed.
State (string) --
Indicates whether the FrozenFrames metric is enabled or disabled.
ThresholdSeconds (integer) --
Specifies the number of consecutive seconds of a static image that triggers an event or alert.
dict
Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.
NdiState (string) --
A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED.
MachineName (string) --
A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix.
NdiDiscoveryServers (list) --
A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly.
(dict) --
Specifies the configuration settings for individual NDI discovery servers. A maximum of 3 servers is allowed.
DiscoveryServerAddress (string) -- [REQUIRED]
The unique network address of the NDI discovery server.
DiscoveryServerPort (integer) --
The port for the NDI discovery server. Defaults to 5959 if a custom port isn't specified.
VpcInterfaceAdapter (string) -- [REQUIRED]
The identifier for the Virtual Private Cloud (VPC) network interface used by the flow.
string
Determines the processing capacity and feature set 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'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'NdiSpeedHqQuality': 123,
'NdiProgramName': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'BridgeArn': 'string',
'BridgePorts': [
123,
],
'OutputStatus': 'ENABLED'|'DISABLED',
'PeerIpAddress': 'string',
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
'ConnectedRouterInputArn': 'string'
},
],
'Source': {
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputIp': 'string',
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'Name': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'NdiSpeedHqQuality': 123,
'NdiProgramName': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
'PeerIpAddress': 'string',
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitDecryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
'ConnectedRouterOutputArn': 'string'
},
'SourceFailoverConfig': {
'FailoverMode': 'MERGE'|'FAILOVER',
'RecoveryWindow': 123,
'SourcePriority': {
'PrimarySource': 'string'
},
'State': 'ENABLED'|'DISABLED'
},
'Sources': [
{
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputIp': 'string',
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'Name': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'NdiSpeedHqQuality': 123,
'NdiProgramName': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
'PeerIpAddress': 'string',
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitDecryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
'ConnectedRouterOutputArn': 'string'
},
],
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
'VpcInterfaces': [
{
'Name': 'string',
'NetworkInterfaceIds': [
'string',
],
'NetworkInterfaceType': 'ena'|'efa',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
},
],
'Maintenance': {
'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
'MaintenanceDeadline': 'string',
'MaintenanceScheduledDate': 'string',
'MaintenanceStartHour': 'string'
},
'SourceMonitoringConfig': {
'ThumbnailState': 'ENABLED'|'DISABLED',
'AudioMonitoringSettings': [
{
'SilentAudio': {
'State': 'ENABLED'|'DISABLED',
'ThresholdSeconds': 123
}
},
],
'ContentQualityAnalysisState': 'ENABLED'|'DISABLED',
'VideoMonitoringSettings': [
{
'BlackFrames': {
'State': 'ENABLED'|'DISABLED',
'ThresholdSeconds': 123
},
'FrozenFrames': {
'State': 'ENABLED'|'DISABLED',
'ThresholdSeconds': 123
}
},
]
},
'FlowSize': 'MEDIUM'|'LARGE',
'NdiConfig': {
'NdiState': 'ENABLED'|'DISABLED',
'MachineName': 'string',
'NdiDiscoveryServers': [
{
'DiscoveryServerAddress': 'string',
'DiscoveryServerPort': 123,
'VpcInterfaceAdapter': 'string'
},
]
}
}
}
Response Structure
(dict) --
Flow (dict) --
The updated flow.
AvailabilityZone (string) --
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services Region.
Description (string) --
A description of the flow. This value is not used or seen outside of the current 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 Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 Amazon Web Services account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
(string) --
FlowArn (string) --
The Amazon Resource Name (ARN) of the flow.
MediaStreams (list) --
The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
(dict) --
A media stream represents one component of your content, such as video, audio, or ancillary data. After you add a media stream to your flow, you can associate it with sources and outputs that use the ST 2110 JPEG XS or CDI protocol.
Attributes (dict) --
Attributes that are related to the 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 used for the representation of color.
ExactFramerate (string) --
The frame rate for the video stream, in frames/second. For example: 60000/1001.
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 Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 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 you want to associate with an outbound media stream.
DestinationIp (string) --
The IP address where you want MediaConnect to send contents of the media stream.
DestinationPort (integer) --
The port that you want MediaConnect to use when it distributes the media stream to the output.
Interface (dict) --
The VPC interface that you want to use 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 or 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) --
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) --
A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
EncoderProfile (string) --
A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.
MediaStreamName (string) --
The name of the media stream.
Name (string) --
The name of the output. This value must be unique within the current flow.
OutputArn (string) --
The ARN of the output.
Port (integer) --
The port to use when content is distributed to this output.
Transport (dict) --
Attributes related to the transport stream that are used in the output.
CidrAllowList (list) --
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16
(string) --
MaxBitrate (integer) --
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based 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.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) --
The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) --
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) --
Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) --
Source port for SRT-caller protocol.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
NdiSpeedHqQuality (integer) --
A quality setting for the NDI Speed HQ encoder.
NdiProgramName (string) --
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this output.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
BridgeArn (string) --
The ARN of the bridge added to this output.
BridgePorts (list) --
The bridge output ports currently in use.
(integer) --
OutputStatus (string) --
An indication of whether the output is transmitting data or not.
PeerIpAddress (string) --
The IP address of the device that is currently receiving content from this output.
RouterIntegrationState (string) --
Indicates if router integration is enabled or disabled on the flow output.
RouterIntegrationTransitEncryption (dict) --
The encryption configuration for the output when router integration is enabled.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
ConnectedRouterInputArn (string) --
The ARN of the router input that's connected to this flow output.
Source (dict) --
The source for 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 Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 MediaConnect account.
EntitlementArn (string) --
The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services 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 media streams that you want to associate with the source.
(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) --
A name that helps you distinguish one media stream from another.
Name (string) --
The name of the source.
SenderControlPort (integer) --
The IP address that the flow communicates with to initiate connection with the sender.
SenderIpAddress (string) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SourceArn (string) --
The ARN of the source.
Transport (dict) --
Attributes related to the transport stream that are used in the source.
CidrAllowList (list) --
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16
(string) --
MaxBitrate (integer) --
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based 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.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) --
The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) --
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) --
Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) --
Source port for SRT-caller protocol.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
NdiSpeedHqQuality (integer) --
A quality setting for the NDI Speed HQ encoder.
NdiProgramName (string) --
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
VpcInterfaceName (string) --
The name of the VPC interface that is used for this source.
WhitelistCidr (string) --
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) --
The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) --
The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
PeerIpAddress (string) --
The IP address of the device that is currently sending content to this source.
RouterIntegrationState (string) --
Indicates if router integration is enabled or disabled on the flow source.
RouterIntegrationTransitDecryption (dict) --
The decryption configuration for the flow source when router integration is enabled.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
ConnectedRouterOutputArn (string) --
The ARN of the router output that's currently connected to this source.
SourceFailoverConfig (dict) --
The settings for the 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) --
The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.
Sources (list) --
The settings for the sources that are assigned to the flow.
(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 Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 MediaConnect account.
EntitlementArn (string) --
The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services 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 media streams that you want to associate with the source.
(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) --
A name that helps you distinguish one media stream from another.
Name (string) --
The name of the source.
SenderControlPort (integer) --
The IP address that the flow communicates with to initiate connection with the sender.
SenderIpAddress (string) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SourceArn (string) --
The ARN of the source.
Transport (dict) --
Attributes related to the transport stream that are used in the source.
CidrAllowList (list) --
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16
(string) --
MaxBitrate (integer) --
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based 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.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) --
The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) --
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) --
Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) --
Source port for SRT-caller protocol.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
NdiSpeedHqQuality (integer) --
A quality setting for the NDI Speed HQ encoder.
NdiProgramName (string) --
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
VpcInterfaceName (string) --
The name of the VPC interface that is used for this source.
WhitelistCidr (string) --
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) --
The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) --
The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
PeerIpAddress (string) --
The IP address of the device that is currently sending content to this source.
RouterIntegrationState (string) --
Indicates if router integration is enabled or disabled on the flow source.
RouterIntegrationTransitDecryption (dict) --
The decryption configuration for the flow source when router integration is enabled.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
ConnectedRouterOutputArn (string) --
The ARN of the router output that's currently connected to this source.
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) --
A role Arn MediaConnect can assume to create ENIs in your account.
SecurityGroupIds (list) --
Security Group IDs to be used on ENI.
(string) --
SubnetId (string) --
Subnet must be in the AZ of the Flow.
Maintenance (dict) --
The maintenance settings for the flow.
MaintenanceDay (string) --
A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
MaintenanceDeadline (string) --
The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.
MaintenanceScheduledDate (string) --
A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
MaintenanceStartHour (string) --
UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
SourceMonitoringConfig (dict) --
The settings for source monitoring.
ThumbnailState (string) --
Indicates whether thumbnails are enabled or disabled.
AudioMonitoringSettings (list) --
Contains the settings for audio stream metrics monitoring.
(dict) --
Specifies the configuration for audio stream metrics monitoring.
SilentAudio (dict) --
Detects periods of silence.
State (string) --
Indicates whether the SilentAudio metric is enabled or disabled.
ThresholdSeconds (integer) --
Specifies the number of consecutive seconds of silence that triggers an event or alert.
ContentQualityAnalysisState (string) --
Indicates whether content quality analysis is enabled or disabled.
VideoMonitoringSettings (list) --
Contains the settings for video stream metrics monitoring.
(dict) --
Specifies the configuration for video stream metrics monitoring.
BlackFrames (dict) --
Detects video frames that are black.
State (string) --
Indicates whether the BlackFrames metric is enabled or disabled..
ThresholdSeconds (integer) --
Specifies the number of consecutive seconds of black frames that triggers an event or alert.
FrozenFrames (dict) --
Detects video frames that have not changed.
State (string) --
Indicates whether the FrozenFrames metric is enabled or disabled.
ThresholdSeconds (integer) --
Specifies the number of consecutive seconds of a static image that triggers an event or alert.
FlowSize (string) --
Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.
NdiConfig (dict) --
Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.
NdiState (string) --
A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED.
MachineName (string) --
A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix.
NdiDiscoveryServers (list) --
A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly.
(dict) --
Specifies the configuration settings for individual NDI discovery servers. A maximum of 3 servers is allowed.
DiscoveryServerAddress (string) --
The unique network address of the NDI discovery server.
DiscoveryServerPort (integer) --
The port for the NDI discovery server. Defaults to 5959 if a custom port isn't specified.
VpcInterfaceAdapter (string) --
The identifier for the Virtual Private Cloud (VPC) network interface used by the flow.
{'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitEncryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| AUTOMATIC'}}
Response {'Output': {'ConnectedRouterInputArn': 'string',
'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitEncryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}}}
Updates an existing flow output.
See also: AWS API Documentation
Request Syntax
client.update_flow_output(
CidrAllowList=[
'string',
],
Description='string',
Destination='string',
Encryption={
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
FlowArn='string',
MaxLatency=123,
MediaStreamOutputConfigurations=[
{
'DestinationConfigurations': [
{
'DestinationIp': 'string',
'DestinationPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'EncodingParameters': {
'CompressionFactor': 123.0,
'EncoderProfile': 'main'|'high'
},
'MediaStreamName': 'string'
},
],
MinLatency=123,
OutputArn='string',
Port=123,
Protocol='zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
RemoteId='string',
SenderControlPort=123,
SenderIpAddress='string',
SmoothingLatency=123,
StreamId='string',
VpcInterfaceAttachment={
'VpcInterfaceName': 'string'
},
OutputStatus='ENABLED'|'DISABLED',
NdiProgramName='string',
NdiSpeedHqQuality=123,
RouterIntegrationState='ENABLED'|'DISABLED',
RouterIntegrationTransitEncryption={
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
)
list
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
(string) --
string
A description of the output. This description appears only on the MediaConnect console and will not be seen by the end user.
string
The IP address where you want to send the output.
dict
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Allowable encryption types: static-key.
Algorithm (string) --
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) --
A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
DeviceId (string) --
The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
KeyType (string) --
The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) --
The Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (string) --
The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the flow that is associated with the output that you want to update.
integer
The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
list
The media streams that are associated with the output, and the parameters for those associations.
(dict) --
The media stream that you want to associate with the output, and the parameters for that association.
DestinationConfigurations (list) --
The media streams that you want to associate with the output.
(dict) --
The definition of a media stream that you want to associate with the output.
DestinationIp (string) -- [REQUIRED]
The IP address where you want MediaConnect to send contents of the media stream.
DestinationPort (integer) -- [REQUIRED]
The port that you want MediaConnect to use when it distributes the media stream to the output.
Interface (dict) -- [REQUIRED]
The VPC interface that you want to use for the media stream associated with the output.
Name (string) -- [REQUIRED]
The name of the VPC interface.
EncodingName (string) -- [REQUIRED]
The format that will be used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
EncodingParameters (dict) --
A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.
CompressionFactor (float) -- [REQUIRED]
A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
EncoderProfile (string) -- [REQUIRED]
A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, if at least one source on the flow uses the CDI protocol.
MediaStreamName (string) -- [REQUIRED]
The name of the media stream that is associated with the output.
integer
The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
string
[REQUIRED]
The ARN of the output that you want to update.
integer
The port to use when content is distributed to this output.
string
The protocol to use for the output.
string
The remote ID for the Zixi-pull stream.
integer
The port that the flow uses to send outbound requests to initiate connection with the sender.
string
The IP address that the flow communicates with to initiate connection with the sender.
integer
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
string
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
dict
The name of the VPC interface attachment to use for this output.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
string
An indication of whether the output should transmit data or not. If you don't specify the outputStatus field in your request, MediaConnect leaves the value unchanged.
string
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
integer
A quality setting for the NDI Speed HQ encoder.
string
Indicates whether to enable or disable router integration for this flow output.
dict
The configuration that defines how content is encrypted during transit between the MediaConnect router and a MediaConnect flow.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) -- [REQUIRED]
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
dict
Response Syntax
{
'FlowArn': 'string',
'Output': {
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Destination': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'ListenerAddress': 'string',
'MediaLiveInputArn': 'string',
'MediaStreamOutputConfigurations': [
{
'DestinationConfigurations': [
{
'DestinationIp': 'string',
'DestinationPort': 123,
'Interface': {
'Name': 'string'
},
'OutboundIp': 'string'
},
],
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'EncodingParameters': {
'CompressionFactor': 123.0,
'EncoderProfile': 'main'|'high'
},
'MediaStreamName': 'string'
},
],
'Name': 'string',
'OutputArn': 'string',
'Port': 123,
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'NdiSpeedHqQuality': 123,
'NdiProgramName': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
},
'BridgeArn': 'string',
'BridgePorts': [
123,
],
'OutputStatus': 'ENABLED'|'DISABLED',
'PeerIpAddress': 'string',
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitEncryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
'ConnectedRouterInputArn': 'string'
}
}
Response Structure
(dict) --
FlowArn (string) --
The ARN of the flow that is associated with the updated output.
Output (dict) --
The new settings of the output that you updated.
DataTransferSubscriberFeePercent (integer) --
Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) --
A description of the output.
Destination (string) --
The address where you want to send the output.
Encryption (dict) --
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Algorithm (string) --
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (string) --
A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
DeviceId (string) --
The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
KeyType (string) --
The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region (string) --
The Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 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 you want to associate with an outbound media stream.
DestinationIp (string) --
The IP address where you want MediaConnect to send contents of the media stream.
DestinationPort (integer) --
The port that you want MediaConnect to use when it distributes the media stream to the output.
Interface (dict) --
The VPC interface that you want to use 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 or 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) --
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) --
A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
EncoderProfile (string) --
A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.
MediaStreamName (string) --
The name of the media stream.
Name (string) --
The name of the output. This value must be unique within the current flow.
OutputArn (string) --
The ARN of the output.
Port (integer) --
The port to use when content is distributed to this output.
Transport (dict) --
Attributes related to the transport stream that are used in the output.
CidrAllowList (list) --
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16
(string) --
MaxBitrate (integer) --
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based 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.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) --
The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) --
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) --
Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) --
Source port for SRT-caller protocol.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
NdiSpeedHqQuality (integer) --
A quality setting for the NDI Speed HQ encoder.
NdiProgramName (string) --
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this output.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
BridgeArn (string) --
The ARN of the bridge added to this output.
BridgePorts (list) --
The bridge output ports currently in use.
(integer) --
OutputStatus (string) --
An indication of whether the output is transmitting data or not.
PeerIpAddress (string) --
The IP address of the device that is currently receiving content from this output.
RouterIntegrationState (string) --
Indicates if router integration is enabled or disabled on the flow output.
RouterIntegrationTransitEncryption (dict) --
The encryption configuration for the output when router integration is enabled.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
ConnectedRouterInputArn (string) --
The ARN of the router input that's connected to this flow output.
{'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitDecryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| AUTOMATIC'}}
Response {'Source': {'ConnectedRouterOutputArn': 'string',
'RouterIntegrationState': 'ENABLED | DISABLED',
'RouterIntegrationTransitDecryption': {'EncryptionKeyConfiguration': {'Automatic': {},
'SecretsManager': {'RoleArn': 'string',
'SecretArn': 'string'}},
'EncryptionKeyType': 'SECRETS_MANAGER '
'| '
'AUTOMATIC'}}}
Updates the source of a flow.
See also: AWS API Documentation
Request Syntax
client.update_flow_source(
Decryption={
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
Description='string',
EntitlementArn='string',
FlowArn='string',
IngestPort=123,
MaxBitrate=123,
MaxLatency=123,
MaxSyncBuffer=123,
MediaStreamSourceConfigurations=[
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
MinLatency=123,
Protocol='zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
SenderControlPort=123,
SenderIpAddress='string',
SourceArn='string',
SourceListenerAddress='string',
SourceListenerPort=123,
StreamId='string',
VpcInterfaceName='string',
WhitelistCidr='string',
GatewayBridgeSource={
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
RouterIntegrationState='ENABLED'|'DISABLED',
RouterIntegrationTransitDecryption={
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
}
)
dict
The type of encryption that is used on the content ingested from the 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 Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (string) --
The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
string
A description of the source. This description is not visible outside of the current Amazon Web Services account.
string
The Amazon Resource Name (ARN) of the entitlement that allows you to subscribe to the flow. The entitlement is set by the content originator, and the ARN is generated as part of the originator's flow.
string
[REQUIRED]
The ARN of the flow that you want to update.
integer
The port that the flow listens on for incoming content. If the protocol of the source is Zixi, the port must be set to 2088.
integer
The maximum bitrate for RIST, RTP, and RTP-FEC streams.
integer
The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
integer
The size of the buffer (in milliseconds) to use to sync incoming source data.
list
The media stream that is associated with the source, and the parameters for that association.
(dict) --
The media stream that you want to associate with the source, and the parameters for that association.
EncodingName (string) -- [REQUIRED]
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 media streams that you want to associate with the source.
(dict) --
The transport parameters that you want to associate with an incoming media stream.
InputPort (integer) -- [REQUIRED]
The port that you want the flow to listen on for an incoming media stream.
Interface (dict) -- [REQUIRED]
The VPC interface that you want to use for the incoming media stream.
Name (string) -- [REQUIRED]
The name of the VPC interface.
MediaStreamName (string) -- [REQUIRED]
The name of the media stream.
integer
The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
string
The protocol that the source uses to deliver the content to MediaConnect.
integer
The port that the flow uses to send outbound requests to initiate connection with the sender.
string
The IP address that the flow communicates with to initiate connection with the sender.
string
[REQUIRED]
The ARN of the source that you want to update.
string
The source IP or domain name for SRT-caller protocol.
integer
Source port for SRT-caller protocol.
string
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
string
The name of the VPC interface that you want to send your output to.
string
The range of IP addresses that are allowed to contribute content to your source. Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
dict
The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) --
The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
string
Indicates whether to enable or disable router integration for this flow source.
dict
The encryption configuration for the flow source when router integration is enabled.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) -- [REQUIRED]
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) -- [REQUIRED]
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) -- [REQUIRED]
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
dict
Response Syntax
{
'FlowArn': 'string',
'Source': {
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'MediaStreamSourceConfigurations': [
{
'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
'InputConfigurations': [
{
'InputIp': 'string',
'InputPort': 123,
'Interface': {
'Name': 'string'
}
},
],
'MediaStreamName': 'string'
},
],
'Name': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MaxSyncBuffer': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
'RemoteId': 'string',
'SenderControlPort': 123,
'SenderIpAddress': 'string',
'SmoothingLatency': 123,
'SourceListenerAddress': 'string',
'SourceListenerPort': 123,
'StreamId': 'string',
'NdiSpeedHqQuality': 123,
'NdiProgramName': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string',
'GatewayBridgeSource': {
'BridgeArn': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
'PeerIpAddress': 'string',
'RouterIntegrationState': 'ENABLED'|'DISABLED',
'RouterIntegrationTransitDecryption': {
'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
'EncryptionKeyConfiguration': {
'SecretsManager': {
'SecretArn': 'string',
'RoleArn': 'string'
},
'Automatic': {}
}
},
'ConnectedRouterOutputArn': 'string'
}
}
Response Structure
(dict) --
FlowArn (string) --
The ARN of the flow that you was updated.
Source (dict) --
The details of the sources that are assigned to 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 Amazon Web Services 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 MediaConnect as a trusted entity).
SecretArn (string) --
The ARN of the secret that you created in 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 MediaConnect account.
EntitlementArn (string) --
The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services 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 media streams that you want to associate with the source.
(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) --
A name that helps you distinguish one media stream from another.
Name (string) --
The name of the source.
SenderControlPort (integer) --
The IP address that the flow communicates with to initiate connection with the sender.
SenderIpAddress (string) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SourceArn (string) --
The ARN of the source.
Transport (dict) --
Attributes related to the transport stream that are used in the source.
CidrAllowList (list) --
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16
(string) --
MaxBitrate (integer) --
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) --
The maximum latency in milliseconds. This parameter applies only to RIST-based 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.
SenderControlPort (integer) --
The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress (string) --
The IP address that the flow communicates with to initiate connection with the sender.
SmoothingLatency (integer) --
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
SourceListenerAddress (string) --
Source IP or domain name for SRT-caller protocol.
SourceListenerPort (integer) --
Source port for SRT-caller protocol.
StreamId (string) --
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
NdiSpeedHqQuality (integer) --
A quality setting for the NDI Speed HQ encoder.
NdiProgramName (string) --
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
VpcInterfaceName (string) --
The name of the VPC interface that is used for this source.
WhitelistCidr (string) --
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
GatewayBridgeSource (dict) --
The source configuration for cloud flows receiving a stream from a bridge.
BridgeArn (string) --
The ARN of the bridge feeding this flow.
VpcInterfaceAttachment (dict) --
The name of the VPC interface attachment to use for this bridge source.
VpcInterfaceName (string) --
The name of the VPC interface to use for this resource.
PeerIpAddress (string) --
The IP address of the device that is currently sending content to this source.
RouterIntegrationState (string) --
Indicates if router integration is enabled or disabled on the flow source.
RouterIntegrationTransitDecryption (dict) --
The decryption configuration for the flow source when router integration is enabled.
EncryptionKeyType (string) --
The type of encryption key to use for flow transit encryption.
EncryptionKeyConfiguration (dict) --
The configuration details for the encryption key.
SecretsManager (dict) --
The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret used for transit encryption.
RoleArn (string) --
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Automatic (dict) --
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
ConnectedRouterOutputArn (string) --
The ARN of the router output that's currently connected to this source.