MediaConnect / Client / add_flow_sources

add_flow_sources#

MediaConnect.Client.add_flow_sources(**kwargs)#

Adds Sources to flow

Request Syntax

response = client.add_flow_sources(
    FlowArn='string',
    Sources=[
        {
            'Decryption': {
                'Algorithm': 'aes128'|'aes192'|'aes256',
                'ConstantInitializationVector': 'string',
                'DeviceId': 'string',
                'KeyType': 'speke'|'static-key'|'srt-password',
                'Region': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SecretArn': 'string',
                'Url': 'string'
            },
            'Description': 'string',
            'EntitlementArn': 'string',
            'IngestPort': 123,
            'MaxBitrate': 123,
            'MaxLatency': 123,
            'MaxSyncBuffer': 123,
            'MediaStreamSourceConfigurations': [
                {
                    'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                    'InputConfigurations': [
                        {
                            'InputPort': 123,
                            'Interface': {
                                'Name': 'string'
                            }
                        },
                    ],
                    'MediaStreamName': 'string'
                },
            ],
            'MinLatency': 123,
            'Name': 'string',
            'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
            'SenderControlPort': 123,
            'SenderIpAddress': 'string',
            'SourceListenerAddress': 'string',
            'SourceListenerPort': 123,
            'StreamId': 'string',
            'VpcInterfaceName': 'string',
            'WhitelistCidr': 'string',
            'GatewayBridgeSource': {
                'BridgeArn': 'string',
                'VpcInterfaceAttachment': {
                    'VpcInterfaceName': 'string'
                }
            }
        },
    ]
)

Parameters:

FlowArn (string) – [REQUIRED] The flow that you want to mutate.
Sources (list) –
[REQUIRED] A list of sources that you want to add.
- (dict) – The settings for the source of the flow.
  - Decryption (dict) – The type of encryption that is used on the content ingested from this source. Allowable encryption types: static-key.
    - Algorithm (string) – The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
    - ConstantInitializationVector (string) – A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
    - DeviceId (string) – The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
    - KeyType (string) – The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
    - Region (string) – The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
    - ResourceId (string) – An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
    - RoleArn (string) – [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
    - SecretArn (string) – The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
    - Url (string) – The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
  - Description (string) – A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
  - EntitlementArn (string) – The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator’s flow.
  - IngestPort (integer) – The port that the flow will be listening on for incoming content.
  - MaxBitrate (integer) – The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
  - MaxLatency (integer) – The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
  - MaxSyncBuffer (integer) – The size of the buffer (in milliseconds) to use to sync incoming source data.
  - MediaStreamSourceConfigurations (list) – The media streams that are associated with the source, and the parameters for those associations.
    - (dict) – The definition of a media stream that you want to associate with the source.
      - EncodingName (string) – [REQUIRED] The format you want to use to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
      - InputConfigurations (list) – The transport parameters that you want to associate with the media stream.
        
        (dict) – The transport parameters that you want to associate with an incoming media stream.
        
        InputPort (integer) – [REQUIRED] The port that you want the flow to listen on for an incoming media stream.
        
        Interface (dict) – [REQUIRED] The VPC interface that you want to use for the incoming media stream.
        
        Name (string) – [REQUIRED] The name of the VPC interface.
      - MediaStreamName (string) – [REQUIRED] The name of the media stream.
  - MinLatency (integer) – The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
  - Name (string) – The name of the source.
  - Protocol (string) – The protocol that is used by the source.
  - SenderControlPort (integer) – The port that the flow uses to send outbound requests to initiate connection with the sender.
  - SenderIpAddress (string) – The IP address that the flow communicates with to initiate connection with the sender.
  - SourceListenerAddress (string) – Source IP or domain name for SRT-caller protocol.
  - SourceListenerPort (integer) – Source port for SRT-caller protocol.
  - StreamId (string) – The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
  - VpcInterfaceName (string) – The name of the VPC interface to use for this source.
  - WhitelistCidr (string) – The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
  - GatewayBridgeSource (dict) – The source configuration for cloud flows receiving a stream from a bridge.
    - BridgeArn (string) – [REQUIRED] The ARN of the bridge feeding this flow.
    - VpcInterfaceAttachment (dict) – The name of the VPC interface attachment to use for this bridge source.
      - VpcInterfaceName (string) – The name of the VPC interface to use for this resource.

Return type:

dict

Returns:

Response Syntax

{
    'FlowArn': 'string',
    'Sources': [
        {
            'DataTransferSubscriberFeePercent': 123,
            'Decryption': {
                'Algorithm': 'aes128'|'aes192'|'aes256',
                'ConstantInitializationVector': 'string',
                'DeviceId': 'string',
                'KeyType': 'speke'|'static-key'|'srt-password',
                'Region': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SecretArn': 'string',
                'Url': 'string'
            },
            'Description': 'string',
            'EntitlementArn': 'string',
            'IngestIp': 'string',
            'IngestPort': 123,
            'MediaStreamSourceConfigurations': [
                {
                    'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                    'InputConfigurations': [
                        {
                            'InputIp': 'string',
                            'InputPort': 123,
                            'Interface': {
                                'Name': 'string'
                            }
                        },
                    ],
                    'MediaStreamName': 'string'
                },
            ],
            'Name': 'string',
            'SenderControlPort': 123,
            'SenderIpAddress': 'string',
            'SourceArn': 'string',
            'Transport': {
                'CidrAllowList': [
                    'string',
                ],
                'MaxBitrate': 123,
                'MaxLatency': 123,
                'MaxSyncBuffer': 123,
                'MinLatency': 123,
                'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
                'RemoteId': 'string',
                'SenderControlPort': 123,
                'SenderIpAddress': 'string',
                'SmoothingLatency': 123,
                'SourceListenerAddress': 'string',
                'SourceListenerPort': 123,
                'StreamId': 'string'
            },
            'VpcInterfaceName': 'string',
            'WhitelistCidr': 'string',
            'GatewayBridgeSource': {
                'BridgeArn': 'string',
                'VpcInterfaceAttachment': {
                    'VpcInterfaceName': 'string'
                }
            }
        },
    ]
}

Response Structure

(dict) – AWS Elemental MediaConnect added sources to the flow successfully.
- FlowArn (string) – The ARN of the flow that these sources were added to.
- Sources (list) – The details of the newly added sources.
  - (dict) – The settings for the source of the flow.
    - DataTransferSubscriberFeePercent (integer) – Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
    - Decryption (dict) – The type of encryption that is used on the content ingested from this source.
      - Algorithm (string) – The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
      - ConstantInitializationVector (string) – A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
      - DeviceId (string) – The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      - KeyType (string) – The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
      - Region (string) – The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      - ResourceId (string) – An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      - RoleArn (string) – The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
      - SecretArn (string) – The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
      - Url (string) – The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
    - Description (string) – A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
    - EntitlementArn (string) – The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator’s flow.
    - IngestIp (string) – The IP address that the flow will be listening on for incoming content.
    - IngestPort (integer) – The port that the flow will be listening on for incoming content.
    - MediaStreamSourceConfigurations (list) – The media streams that are associated with the source, and the parameters for those associations.
      - (dict) – The media stream that is associated with the source, and the parameters for that association.
        
        EncodingName (string) – The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
        
        InputConfigurations (list) – The transport parameters that are associated with an incoming media stream.
        
        (dict) – The transport parameters that are associated with an incoming media stream.
        
        InputIp (string) – The IP address that the flow listens on for incoming content for a media stream.
        
        InputPort (integer) – The port that the flow listens on for an incoming media stream.
        
        Interface (dict) – The VPC interface where the media stream comes in from.
        
        Name (string) – The name of the VPC interface.
        
        MediaStreamName (string) – The name of the media stream.
    - Name (string) – The name of the source.
    - SenderControlPort (integer) – The port that the flow uses to send outbound requests to initiate connection with the sender.
    - SenderIpAddress (string) – The IP address that the flow communicates with to initiate connection with the sender.
    - SourceArn (string) – The ARN of the source.
    - Transport (dict) – Attributes related to the transport stream that are used in the source.
      - CidrAllowList (list) – The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
        
        (string) –
      - MaxBitrate (integer) – The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
      - MaxLatency (integer) – The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
      - MaxSyncBuffer (integer) – The size of the buffer (in milliseconds) to use to sync incoming source data.
      - MinLatency (integer) – The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
      - Protocol (string) – The protocol that is used by the source or output.
      - RemoteId (string) – The remote ID for the Zixi-pull stream.
      - SenderControlPort (integer) – The port that the flow uses to send outbound requests to initiate connection with the sender.
      - SenderIpAddress (string) – The IP address that the flow communicates with to initiate connection with the sender.
      - SmoothingLatency (integer) – The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
      - SourceListenerAddress (string) – Source IP or domain name for SRT-caller protocol.
      - SourceListenerPort (integer) – Source port for SRT-caller protocol.
      - StreamId (string) – The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
    - VpcInterfaceName (string) – The name of the VPC interface that is used for this source.
    - WhitelistCidr (string) – The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    - GatewayBridgeSource (dict) – The source configuration for cloud flows receiving a stream from a bridge.
      - BridgeArn (string) – The ARN of the bridge feeding this flow.
      - VpcInterfaceAttachment (dict) – The name of the VPC interface attachment to use for this bridge source.
        
        VpcInterfaceName (string) – The name of the VPC interface to use for this resource.

add_flow_sources#

Request Syntax

Response Syntax

Response Structure

Exceptions