Skip to content

UpdateFlowSourceRequest

Source code in docs_src/capo_mediaconnect/types/update_flow_source_request.py
class UpdateFlowSourceRequest(TypedDict, closed=True):
    decryption: NotRequired[
        "capo_mediaconnect.types.update_encryption.UpdateEncryption"
    ]
    """<p>The type of encryption that is used on the content ingested from the source. </p>"""
    description: NotRequired["str"]
    """<p>A description of the source. This description is not visible outside of the current Amazon Web Services account. </p>"""
    entitlement_arn: NotRequired["str"]
    """<p>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. </p>"""
    flow_arn: "capo_mediaconnect.types.flow_arn.FlowArn"
    """<p> The ARN of the flow that you want to update. </p>"""
    ingest_port: NotRequired["int"]
    """<p>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. </p>"""
    max_bitrate: NotRequired["int"]
    """<p>The maximum bitrate for RIST, RTP, and RTP-FEC streams. </p>"""
    max_latency: NotRequired["int"]
    """<p>The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams. </p>"""
    max_sync_buffer: NotRequired["int"]
    """<p>The size of the buffer (in milliseconds) to use to sync incoming source data. </p>"""
    media_stream_source_configurations: NotRequired[
        "capo_mediaconnect.types.__list_of_media_stream_source_configuration_request.__listOfMediaStreamSourceConfigurationRequest"
    ]
    """<p>The media stream that is associated with the source, and the parameters for that association. </p>"""
    min_latency: NotRequired["int"]
    """<p>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. </p>"""
    protocol: NotRequired["capo_mediaconnect.types.protocol.Protocol"]
    """<p>The protocol that the source uses to deliver the content to MediaConnect. </p> <note> <p>Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.</p> </note>"""
    sender_control_port: NotRequired["int"]
    """<p>The port that the flow uses to send outbound requests to initiate connection with the sender. </p>"""
    sender_ip_address: NotRequired["str"]
    """<p>The IP address that the flow communicates with to initiate connection with the sender. </p>"""
    source_arn: "str"
    """<p>The ARN of the source that you want to update. </p>"""
    source_listener_address: NotRequired["str"]
    """<p>The source IP or domain name for SRT-caller protocol. </p>"""
    source_listener_port: NotRequired["int"]
    """<p>Source port for SRT-caller protocol. </p>"""
    stream_id: NotRequired["str"]
    """<p>The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams. </p>"""
    vpc_interface_name: NotRequired["str"]
    """<p>The name of the VPC interface that you want to send your output to.</p>"""
    whitelist_cidr: NotRequired["str"]
    """<p>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. </p>"""
    gateway_bridge_source: NotRequired[
        "capo_mediaconnect.types.update_gateway_bridge_source_request.UpdateGatewayBridgeSourceRequest"
    ]
    """<p>The source configuration for cloud flows receiving a stream from a bridge. </p>"""
    ndi_source_settings: NotRequired[
        "capo_mediaconnect.types.ndi_source_settings.NdiSourceSettings"
    ]
    """<p> The settings for the NDI source. This includes the exact name of the upstream NDI sender that you want to connect to your source. </p>"""
    router_integration_state: NotRequired["capo_mediaconnect.types.state.State"]
    """<p>Indicates whether to enable or disable router integration for this flow source.</p>"""
    router_integration_transit_decryption: NotRequired[
        "capo_mediaconnect.types.flow_transit_encryption.FlowTransitEncryption"
    ]
    """<p>The encryption configuration for the flow source when router integration is enabled.</p>"""

decryption instance-attribute

decryption: NotRequired[UpdateEncryption]

The type of encryption that is used on the content ingested from the source.

description instance-attribute

description: NotRequired[str]

A description of the source. This description is not visible outside of the current Amazon Web Services account.

entitlement_arn instance-attribute

entitlement_arn: NotRequired[str]

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.

flow_arn instance-attribute

flow_arn: FlowArn

The ARN of the flow that you want to update.

gateway_bridge_source instance-attribute

gateway_bridge_source: NotRequired[UpdateGatewayBridgeSourceRequest]

The source configuration for cloud flows receiving a stream from a bridge.

ingest_port instance-attribute

ingest_port: NotRequired[int]

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.

max_bitrate instance-attribute

max_bitrate: NotRequired[int]

The maximum bitrate for RIST, RTP, and RTP-FEC streams.

max_latency instance-attribute

max_latency: NotRequired[int]

The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.

max_sync_buffer instance-attribute

max_sync_buffer: NotRequired[int]

The size of the buffer (in milliseconds) to use to sync incoming source data.

media_stream_source_configurations instance-attribute

media_stream_source_configurations: NotRequired[
    __listOfMediaStreamSourceConfigurationRequest
]

The media stream that is associated with the source, and the parameters for that association.

min_latency instance-attribute

min_latency: NotRequired[int]

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.

ndi_source_settings instance-attribute

ndi_source_settings: NotRequired[NdiSourceSettings]

The settings for the NDI source. This includes the exact name of the upstream NDI sender that you want to connect to your source.

protocol instance-attribute

protocol: NotRequired[Protocol]

The protocol that the source uses to deliver the content to MediaConnect.

Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.

router_integration_state instance-attribute

router_integration_state: NotRequired[State]

Indicates whether to enable or disable router integration for this flow source.

router_integration_transit_decryption instance-attribute

router_integration_transit_decryption: NotRequired[FlowTransitEncryption]

The encryption configuration for the flow source when router integration is enabled.

sender_control_port instance-attribute

sender_control_port: NotRequired[int]

The port that the flow uses to send outbound requests to initiate connection with the sender.

sender_ip_address instance-attribute

sender_ip_address: NotRequired[str]

The IP address that the flow communicates with to initiate connection with the sender.

source_arn instance-attribute

source_arn: str

The ARN of the source that you want to update.

source_listener_address instance-attribute

source_listener_address: NotRequired[str]

The source IP or domain name for SRT-caller protocol.

source_listener_port instance-attribute

source_listener_port: NotRequired[int]

Source port for SRT-caller protocol.

stream_id instance-attribute

stream_id: NotRequired[str]

The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.

vpc_interface_name instance-attribute

vpc_interface_name: NotRequired[str]

The name of the VPC interface that you want to send your output to.

whitelist_cidr instance-attribute

whitelist_cidr: NotRequired[str]

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.