Skip to content

Flow

Source code in docs_src/capo_mediaconnect/types/flow.py
class Flow(TypedDict, closed=True):
    availability_zone: NotRequired["str"]
    """<p> 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.</p>"""
    description: NotRequired["str"]
    """<p> A description of the flow. This value is not used or seen outside of the current MediaConnect account.</p>"""
    egress_ip: NotRequired["str"]
    """<p> The IP address from which video will be sent to output destinations.</p>"""
    entitlements: NotRequired[
        "capo_mediaconnect.types.__list_of_entitlement.__listOfEntitlement"
    ]
    """<p> The entitlements in this flow.</p>"""
    flow_arn: NotRequired["str"]
    """<p> The Amazon Resource Name (ARN) of the flow.</p>"""
    media_streams: NotRequired[
        "capo_mediaconnect.types.__list_of_media_stream.__listOfMediaStream"
    ]
    """<p> 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.</p>"""
    name: NotRequired["str"]
    """<p> The name of the flow.</p>"""
    outputs: NotRequired["capo_mediaconnect.types.__list_of_output.__listOfOutput"]
    """<p> The outputs in this flow.</p>"""
    source: NotRequired["capo_mediaconnect.types.source.Source"]
    """<p> The source for the flow. </p>"""
    source_failover_config: NotRequired[
        "capo_mediaconnect.types.failover_config.FailoverConfig"
    ]
    """<p> The settings for the source failover. </p>"""
    sources: NotRequired["capo_mediaconnect.types.__list_of_source.__listOfSource"]
    """<p>The settings for the sources that are assigned to the flow. </p>"""
    status: NotRequired["capo_mediaconnect.types.status.Status"]
    """<p> The current status of the flow.</p>"""
    vpc_interfaces: NotRequired[
        "capo_mediaconnect.types.__list_of_vpc_interface.__listOfVpcInterface"
    ]
    """<p> The VPC Interfaces for this flow.</p>"""
    maintenance: NotRequired["capo_mediaconnect.types.maintenance.Maintenance"]
    """<p> The maintenance settings for the flow. </p>"""
    source_monitoring_config: NotRequired[
        "capo_mediaconnect.types.monitoring_config.MonitoringConfig"
    ]
    """<p> The settings for source monitoring. </p>"""
    flow_size: NotRequired["capo_mediaconnect.types.flow_size.FlowSize"]
    """<p> Determines the processing capacity and feature set of the flow. </p>"""
    ndi_config: NotRequired["capo_mediaconnect.types.ndi_config.NdiConfig"]
    """<p>Specifies the configuration settings for a flow's NDI source or output. Required when the flow includes an NDI source or output.</p>"""
    encoding_config: NotRequired[
        "capo_mediaconnect.types.encoding_config.EncodingConfig"
    ]
    """<p> The encoding configuration to apply to the NDIĀ® source when transcoding it to a transport stream for downstream distribution. </p>"""

availability_zone instance-attribute

availability_zone: NotRequired[str]

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 instance-attribute

description: NotRequired[str]

A description of the flow. This value is not used or seen outside of the current MediaConnect account.

egress_ip instance-attribute

egress_ip: NotRequired[str]

The IP address from which video will be sent to output destinations.

encoding_config instance-attribute

encoding_config: NotRequired[EncodingConfig]

The encoding configuration to apply to the NDIĀ® source when transcoding it to a transport stream for downstream distribution.

entitlements instance-attribute

entitlements: NotRequired[__listOfEntitlement]

The entitlements in this flow.

flow_arn instance-attribute

flow_arn: NotRequired[str]

The Amazon Resource Name (ARN) of the flow.

flow_size instance-attribute

flow_size: NotRequired[FlowSize]

Determines the processing capacity and feature set of the flow.

maintenance instance-attribute

maintenance: NotRequired[Maintenance]

The maintenance settings for the flow.

media_streams instance-attribute

media_streams: NotRequired[__listOfMediaStream]

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.

name instance-attribute

name: NotRequired[str]

The name of the flow.

ndi_config instance-attribute

ndi_config: NotRequired[NdiConfig]

Specifies the configuration settings for a flow's NDI source or output. Required when the flow includes an NDI source or output.

outputs instance-attribute

outputs: NotRequired[__listOfOutput]

The outputs in this flow.

source instance-attribute

source: NotRequired[Source]

The source for the flow.

source_failover_config instance-attribute

source_failover_config: NotRequired[FailoverConfig]

The settings for the source failover.

source_monitoring_config instance-attribute

source_monitoring_config: NotRequired[MonitoringConfig]

The settings for source monitoring.

sources instance-attribute

sources: NotRequired[__listOfSource]

The settings for the sources that are assigned to the flow.

status instance-attribute

status: NotRequired[Status]

The current status of the flow.

vpc_interfaces instance-attribute

vpc_interfaces: NotRequired[__listOfVpcInterface]

The VPC Interfaces for this flow.