Skip to content

Output

Source code in docs_src/capo_mediaconnect/types/output.py
class Output(TypedDict, closed=True):
    data_transfer_subscriber_fee_percent: NotRequired["int"]
    """<p> Percentage from 0-100 of the data transfer cost to be billed to the subscriber.</p>"""
    description: NotRequired["str"]
    """<p> A description of the output.</p>"""
    destination: NotRequired["str"]
    """<p> The address where you want to send the output.</p>"""
    encryption: NotRequired["capo_mediaconnect.types.encryption.Encryption"]
    """<p> The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).</p>"""
    entitlement_arn: NotRequired["str"]
    """<p> The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.</p>"""
    listener_address: NotRequired["str"]
    """<p> 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.</p>"""
    media_live_input_arn: NotRequired["str"]
    """<p> The input ARN of the MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.</p>"""
    media_stream_output_configurations: NotRequired[
        "capo_mediaconnect.types.__list_of_media_stream_output_configuration.__listOfMediaStreamOutputConfiguration"
    ]
    """<p> The configuration for each media stream that is associated with the output.</p>"""
    name: NotRequired["str"]
    """<p> The name of the output. This value must be unique within the current flow.</p>"""
    output_arn: NotRequired["str"]
    """<p> The ARN of the output.</p>"""
    port: NotRequired["int"]
    """<p> The port to use when content is distributed to this output.</p>"""
    transport: NotRequired["capo_mediaconnect.types.transport.Transport"]
    """<p> Attributes related to the transport stream that are used in the output.</p>"""
    vpc_interface_attachment: NotRequired[
        "capo_mediaconnect.types.vpc_interface_attachment.VpcInterfaceAttachment"
    ]
    """<p> The name of the VPC interface attachment to use for this output.</p>"""
    bridge_arn: NotRequired["str"]
    """<p> The ARN of the bridge added to this output.</p>"""
    bridge_ports: NotRequired[
        "capo_mediaconnect.types.__list_of_integer.__listOfInteger"
    ]
    """<p> The bridge output ports currently in use.</p>"""
    output_status: NotRequired["capo_mediaconnect.types.output_status.OutputStatus"]
    """<p> An indication of whether the output is transmitting data or not.</p>"""
    peer_ip_address: NotRequired["str"]
    """<p>The IP address of the device that is currently receiving content from this output.</p> <note> <ul> <li> <p>For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address.</p> </li> <li> <p>For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver. </p> </li> <li> <p>Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDIĀ® sources and outputs, and CDI/ST2110 outputs. </p> </li> <li> <p>The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.</p> </li> </ul> </note>"""
    router_integration_state: NotRequired["capo_mediaconnect.types.state.State"]
    """<p>Indicates if router integration is enabled or disabled on the flow output.</p>"""
    router_integration_transit_encryption: NotRequired[
        "capo_mediaconnect.types.flow_transit_encryption.FlowTransitEncryption"
    ]
    """<p>The encryption configuration for the output when router integration is enabled.</p>"""
    connected_router_input_arn: NotRequired["str"]
    """<p>The ARN of the router input that's connected to this flow output.</p>"""

bridge_arn instance-attribute

bridge_arn: NotRequired[str]

The ARN of the bridge added to this output.

bridge_ports instance-attribute

bridge_ports: NotRequired[__listOfInteger]

The bridge output ports currently in use.

connected_router_input_arn instance-attribute

connected_router_input_arn: NotRequired[str]

The ARN of the router input that's connected to this flow output.

data_transfer_subscriber_fee_percent instance-attribute

data_transfer_subscriber_fee_percent: NotRequired[int]

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

description instance-attribute

description: NotRequired[str]

A description of the output.

destination instance-attribute

destination: NotRequired[str]

The address where you want to send the output.

encryption instance-attribute

encryption: NotRequired[Encryption]

The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

entitlement_arn instance-attribute

entitlement_arn: NotRequired[str]

The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.

listener_address instance-attribute

listener_address: NotRequired[str]

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.

media_live_input_arn instance-attribute

media_live_input_arn: NotRequired[str]

The input ARN of the MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.

media_stream_output_configurations instance-attribute

media_stream_output_configurations: NotRequired[__listOfMediaStreamOutputConfiguration]

The configuration for each media stream that is associated with the output.

name instance-attribute

name: NotRequired[str]

The name of the output. This value must be unique within the current flow.

output_arn instance-attribute

output_arn: NotRequired[str]

The ARN of the output.

output_status instance-attribute

output_status: NotRequired[OutputStatus]

An indication of whether the output is transmitting data or not.

peer_ip_address instance-attribute

peer_ip_address: NotRequired[str]

The IP address of the device that is currently receiving content from this output.

  • For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address.

  • For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver.

  • Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDIĀ® sources and outputs, and CDI/ST2110 outputs.

  • The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.

port instance-attribute

port: NotRequired[int]

The port to use when content is distributed to this output.

router_integration_state instance-attribute

router_integration_state: NotRequired[State]

Indicates if router integration is enabled or disabled on the flow output.

router_integration_transit_encryption instance-attribute

router_integration_transit_encryption: NotRequired[FlowTransitEncryption]

The encryption configuration for the output when router integration is enabled.

transport instance-attribute

transport: NotRequired[Transport]

Attributes related to the transport stream that are used in the output.

vpc_interface_attachment instance-attribute

vpc_interface_attachment: NotRequired[VpcInterfaceAttachment]

The name of the VPC interface attachment to use for this output.