Skip to content
AWS for Query.Farm

aws.mediaconnect.describe_flow

Example SQL Queries

SELECT * FROM
aws.mediaconnect.describe_flow
WHERE
"flow_arn" = 'VALUE';

Description

Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements.

Table Definition

Column NameColumn Data Type
flow_arn Required Input Column

The ARN of the flow that you want to describe.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
flow

The settings for a flow, including its source, outputs, and entitlements.

STRUCT(
    "availability_zone" VARCHAR,
    "description" VARCHAR,
    "egress_ip" VARCHAR,
    "entitlements" STRUCT(
        "data_transfer_subscriber_fee_percent" BIGINT,
        "description" VARCHAR,
        "encryption" STRUCT(
            "algorithm" VARCHAR,
            "constant_initialization_vector" VARCHAR,
            "device_id" VARCHAR,
            "key_type" VARCHAR,
            "region" VARCHAR,
            "resource_id" VARCHAR,
            "role_arn" VARCHAR,
            "secret_arn" VARCHAR,
            "url" VARCHAR
        ),
        "entitlement_arn" VARCHAR,
        "entitlement_status" VARCHAR,
        "name" VARCHAR,
        "subscribers" VARCHAR[]
    )[],
    "flow_arn" VARCHAR,
    "media_streams" STRUCT(
        "attributes" STRUCT(
            "fmtp" STRUCT(
                "channel_order" VARCHAR,
                "colorimetry" VARCHAR,
                "exact_framerate" VARCHAR,
                "par" VARCHAR,
                "range" VARCHAR,
                "scan_mode" VARCHAR,
                "tcs" VARCHAR
            ),
            "lang" VARCHAR
        ),
        "clock_rate" BIGINT,
        "description" VARCHAR,
        "fmt" BIGINT,
        "media_stream_id" BIGINT,
        "media_stream_name" VARCHAR,
        "media_stream_type" VARCHAR,
        "video_format" VARCHAR
    )[],
    "name" VARCHAR,
    "outputs" STRUCT(
        "data_transfer_subscriber_fee_percent" BIGINT,
        "description" VARCHAR,
        "destination" VARCHAR,
        "encryption" STRUCT(
            "algorithm" VARCHAR,
            "constant_initialization_vector" VARCHAR,
            "device_id" VARCHAR,
            "key_type" VARCHAR,
            "region" VARCHAR,
            "resource_id" VARCHAR,
            "role_arn" VARCHAR,
            "secret_arn" VARCHAR,
            "url" VARCHAR
        ),
        "entitlement_arn" VARCHAR,
        "listener_address" VARCHAR,
        "media_live_input_arn" VARCHAR,
        "media_stream_output_configurations" STRUCT(
            "destination_configurations" STRUCT(
                "destination_ip" VARCHAR,
                "destination_port" BIGINT,
                "interface" STRUCT(
                    "name" VARCHAR
                ),
                "outbound_ip" VARCHAR
            )[],
            "encoding_name" VARCHAR,
            "encoding_parameters" STRUCT(
                "compression_factor" DOUBLE,
                "encoder_profile" VARCHAR
            ),
            "media_stream_name" VARCHAR
        )[],
        "name" VARCHAR,
        "output_arn" VARCHAR,
        "port" BIGINT,
        "transport" STRUCT(
            "cidr_allow_list" VARCHAR[],
            "max_bitrate" BIGINT,
            "max_latency" BIGINT,
            "max_sync_buffer" BIGINT,
            "min_latency" BIGINT,
            "protocol" VARCHAR,
            "remote_id" VARCHAR,
            "sender_control_port" BIGINT,
            "sender_ip_address" VARCHAR,
            "smoothing_latency" BIGINT,
            "source_listener_address" VARCHAR,
            "source_listener_port" BIGINT,
            "stream_id" VARCHAR
        ),
        "vpc_interface_attachment" STRUCT(
            "vpc_interface_name" VARCHAR
        ),
        "bridge_arn" VARCHAR,
        "bridge_ports" BIGINT[],
        "output_status" VARCHAR
    )[],
    "source" STRUCT(
        "data_transfer_subscriber_fee_percent" BIGINT,
        "decryption" STRUCT(
            "algorithm" VARCHAR,
            "constant_initialization_vector" VARCHAR,
            "device_id" VARCHAR,
            "key_type" VARCHAR,
            "region" VARCHAR,
            "resource_id" VARCHAR,
            "role_arn" VARCHAR,
            "secret_arn" VARCHAR,
            "url" VARCHAR
        ),
        "description" VARCHAR,
        "entitlement_arn" VARCHAR,
        "ingest_ip" VARCHAR,
        "ingest_port" BIGINT,
        "media_stream_source_configurations" STRUCT(
            "encoding_name" VARCHAR,
            "input_configurations" STRUCT(
                "input_ip" VARCHAR,
                "input_port" BIGINT,
                "interface" STRUCT(
                    "name" VARCHAR
                )
            )[],
            "media_stream_name" VARCHAR
        )[],
        "name" VARCHAR,
        "sender_control_port" BIGINT,
        "sender_ip_address" VARCHAR,
        "source_arn" VARCHAR,
        "transport" STRUCT(
            "cidr_allow_list" VARCHAR[],
            "max_bitrate" BIGINT,
            "max_latency" BIGINT,
            "max_sync_buffer" BIGINT,
            "min_latency" BIGINT,
            "protocol" VARCHAR,
            "remote_id" VARCHAR,
            "sender_control_port" BIGINT,
            "sender_ip_address" VARCHAR,
            "smoothing_latency" BIGINT,
            "source_listener_address" VARCHAR,
            "source_listener_port" BIGINT,
            "stream_id" VARCHAR
        ),
        "vpc_interface_name" VARCHAR,
        "whitelist_cidr" VARCHAR,
        "gateway_bridge_source" STRUCT(
            "bridge_arn" VARCHAR,
            "vpc_interface_attachment" STRUCT(
                "vpc_interface_name" VARCHAR
            )
        )
    ),
    "source_failover_config" STRUCT(
        "failover_mode" VARCHAR,
        "recovery_window" BIGINT,
        "source_priority" STRUCT(
            "primary_source" VARCHAR
        ),
        "state" VARCHAR
    ),
    "sources" STRUCT(
        "data_transfer_subscriber_fee_percent" BIGINT,
        "decryption" STRUCT(
            "algorithm" VARCHAR,
            "constant_initialization_vector" VARCHAR,
            "device_id" VARCHAR,
            "key_type" VARCHAR,
            "region" VARCHAR,
            "resource_id" VARCHAR,
            "role_arn" VARCHAR,
            "secret_arn" VARCHAR,
            "url" VARCHAR
        ),
        "description" VARCHAR,
        "entitlement_arn" VARCHAR,
        "ingest_ip" VARCHAR,
        "ingest_port" BIGINT,
        "media_stream_source_configurations" STRUCT(
            "encoding_name" VARCHAR,
            "input_configurations" STRUCT(
                "input_ip" VARCHAR,
                "input_port" BIGINT,
                "interface" STRUCT(
                    "name" VARCHAR
                )
            )[],
            "media_stream_name" VARCHAR
        )[],
        "name" VARCHAR,
        "sender_control_port" BIGINT,
        "sender_ip_address" VARCHAR,
        "source_arn" VARCHAR,
        "transport" STRUCT(
            "cidr_allow_list" VARCHAR[],
            "max_bitrate" BIGINT,
            "max_latency" BIGINT,
            "max_sync_buffer" BIGINT,
            "min_latency" BIGINT,
            "protocol" VARCHAR,
            "remote_id" VARCHAR,
            "sender_control_port" BIGINT,
            "sender_ip_address" VARCHAR,
            "smoothing_latency" BIGINT,
            "source_listener_address" VARCHAR,
            "source_listener_port" BIGINT,
            "stream_id" VARCHAR
        ),
        "vpc_interface_name" VARCHAR,
        "whitelist_cidr" VARCHAR,
        "gateway_bridge_source" STRUCT(
            "bridge_arn" VARCHAR,
            "vpc_interface_attachment" STRUCT(
                "vpc_interface_name" VARCHAR
            )
        )
    )[],
    "status" VARCHAR,
    "vpc_interfaces" STRUCT(
        "name" VARCHAR,
        "network_interface_ids" VARCHAR[],
        "network_interface_type" VARCHAR,
        "role_arn" VARCHAR,
        "security_group_ids" VARCHAR[],
        "subnet_id" VARCHAR
    )[],
    "maintenance" STRUCT(
        "maintenance_day" VARCHAR,
        "maintenance_deadline" VARCHAR,
        "maintenance_scheduled_date" VARCHAR,
        "maintenance_start_hour" VARCHAR
    )
)
Show child fields
flow.availability_zone

The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.

flow.description

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

flow.egress_ip

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

flow.entitlements[]
Show child fields
flow.entitlements[].data_transfer_subscriber_fee_percent

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

flow.entitlements[].description

A description of the entitlement.

flow.entitlements[].encryption

The type of encryption that will be used on the output that is associated with this entitlement.

Show child fields
flow.entitlements[].encryption.algorithm

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

flow.entitlements[].encryption.constant_initialization_vector

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.

flow.entitlements[].encryption.device_id

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.

flow.entitlements[].encryption.key_type

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

flow.entitlements[].encryption.region

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.

flow.entitlements[].encryption.resource_id

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.

flow.entitlements[].encryption.role_arn

The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).

flow.entitlements[].encryption.secret_arn

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.

flow.entitlements[].encryption.url

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.

flow.entitlements[].entitlement_arn

The ARN of the entitlement.

flow.entitlements[].entitlement_status

An indication of whether the entitlement is enabled.

flow.entitlements[].name

The name of the entitlement.

flow.entitlements[].subscribers[]
flow.flow_arn

The Amazon Resource Name (ARN) of the flow.

flow.maintenance

The maintenance setting of a flow

Show child fields
flow.maintenance.maintenance_day

A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.

flow.maintenance.maintenance_deadline

The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.

flow.maintenance.maintenance_scheduled_date

A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.

flow.maintenance.maintenance_start_hour

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.

flow.media_streams[]
Show child fields
flow.media_streams[].attributes

Attributes that are related to the media stream.

Show child fields
flow.media_streams[].attributes.fmtp

A set of parameters that define the media stream.

Show child fields
flow.media_streams[].attributes.fmtp.channel_order

The format of the audio channel.

flow.media_streams[].attributes.fmtp.colorimetry

The format that is used for the representation of color.

flow.media_streams[].attributes.fmtp.exact_framerate

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.

flow.media_streams[].attributes.fmtp.par

The pixel aspect ratio (PAR) of the video.

flow.media_streams[].attributes.fmtp.range

The encoding range of the video.

flow.media_streams[].attributes.fmtp.scan_mode

The type of compression that was used to smooth the video’s appearance

flow.media_streams[].attributes.fmtp.tcs

The transfer characteristic system (TCS) that is used in the video.

flow.media_streams[].attributes.lang

The audio language, in a format that is recognized by the receiver.

flow.media_streams[].clock_rate

The sample rate for the stream. This value is measured in Hz.

flow.media_streams[].description

A description that can help you quickly identify what your media stream is used for.

flow.media_streams[].fmt

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.

flow.media_streams[].media_stream_id

A unique identifier for the media stream.

flow.media_streams[].media_stream_name

A name that helps you distinguish one media stream from another.

flow.media_streams[].media_stream_type

The type of media stream.

flow.media_streams[].video_format

The resolution of the video.

flow.name

The name of the flow.

flow.outputs[]
Show child fields
flow.outputs[].bridge_arn

The ARN of the bridge that added this output.

flow.outputs[].bridge_ports[]
flow.outputs[].data_transfer_subscriber_fee_percent

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

flow.outputs[].description

A description of the output.

flow.outputs[].destination

The address where you want to send the output.

flow.outputs[].encryption

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

Show child fields
flow.outputs[].encryption.algorithm

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

flow.outputs[].encryption.constant_initialization_vector

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.

flow.outputs[].encryption.device_id

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.

flow.outputs[].encryption.key_type

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

flow.outputs[].encryption.region

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.

flow.outputs[].encryption.resource_id

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.

flow.outputs[].encryption.role_arn

The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).

flow.outputs[].encryption.secret_arn

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.

flow.outputs[].encryption.url

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.

flow.outputs[].entitlement_arn

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

flow.outputs[].listener_address

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.

flow.outputs[].media_live_input_arn

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

flow.outputs[].media_stream_output_configurations[]
Show child fields
flow.outputs[].media_stream_output_configurations[].destination_configurations[]
Show child fields
flow.outputs[].media_stream_output_configurations[].destination_configurations[].destination_ip

The IP address where contents of the media stream will be sent.

flow.outputs[].media_stream_output_configurations[].destination_configurations[].destination_port

The port to use when the content of the media stream is distributed to the output.

flow.outputs[].media_stream_output_configurations[].destination_configurations[].interface

The VPC interface that is used for the media stream associated with the output.

Show child fields
flow.outputs[].media_stream_output_configurations[].destination_configurations[].interface.name

The name of the VPC interface.

flow.outputs[].media_stream_output_configurations[].destination_configurations[].outbound_ip

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 protocol.

flow.outputs[].media_stream_output_configurations[].encoding_name

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.

flow.outputs[].media_stream_output_configurations[].encoding_parameters

Encoding parameters

Show child fields
flow.outputs[].media_stream_output_configurations[].encoding_parameters.compression_factor

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.

flow.outputs[].media_stream_output_configurations[].encoding_parameters.encoder_profile

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.

flow.outputs[].media_stream_output_configurations[].media_stream_name

The name of the media stream.

flow.outputs[].name

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

flow.outputs[].output_arn

The ARN of the output.

flow.outputs[].output_status

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

flow.outputs[].port

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

flow.outputs[].transport

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

Show child fields
flow.outputs[].transport.cidr_allow_list[]
flow.outputs[].transport.max_bitrate

The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.

flow.outputs[].transport.max_latency

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

flow.outputs[].transport.max_sync_buffer

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

flow.outputs[].transport.min_latency

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.

flow.outputs[].transport.protocol

The protocol that is used by the source or output.

flow.outputs[].transport.remote_id

The remote ID for the Zixi-pull stream.

flow.outputs[].transport.sender_control_port

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

flow.outputs[].transport.sender_ip_address

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

flow.outputs[].transport.smoothing_latency

The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.

flow.outputs[].transport.source_listener_address

Source IP or domain name for SRT-caller protocol.

flow.outputs[].transport.source_listener_port

Source port for SRT-caller protocol.

flow.outputs[].transport.stream_id

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

flow.outputs[].vpc_interface_attachment

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

Show child fields
flow.outputs[].vpc_interface_attachment.vpc_interface_name

The name of the VPC interface to use for this resource.

flow.source

The settings for the source of the flow.

Show child fields
flow.source.data_transfer_subscriber_fee_percent

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

flow.source.decryption

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

Show child fields
flow.source.decryption.algorithm

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

flow.source.decryption.constant_initialization_vector

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.

flow.source.decryption.device_id

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.

flow.source.decryption.key_type

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

flow.source.decryption.region

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.

flow.source.decryption.resource_id

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.

flow.source.decryption.role_arn

The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).

flow.source.decryption.secret_arn

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.

flow.source.decryption.url

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.

flow.source.description

A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.

flow.source.entitlement_arn

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.

flow.source.gateway_bridge_source

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

Show child fields
flow.source.gateway_bridge_source.bridge_arn

The ARN of the bridge feeding this flow.

flow.source.gateway_bridge_source.vpc_interface_attachment

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

Show child fields
flow.source.gateway_bridge_source.vpc_interface_attachment.vpc_interface_name

The name of the VPC interface to use for this resource.

flow.source.ingest_ip

The IP address that the flow will be listening on for incoming content.

flow.source.ingest_port

The port that the flow will be listening on for incoming content.

flow.source.media_stream_source_configurations[]
Show child fields
flow.source.media_stream_source_configurations[].encoding_name

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.

flow.source.media_stream_source_configurations[].input_configurations[]
Show child fields
flow.source.media_stream_source_configurations[].input_configurations[].input_ip

The IP address that the flow listens on for incoming content for a media stream.

flow.source.media_stream_source_configurations[].input_configurations[].input_port

The port that the flow listens on for an incoming media stream.

flow.source.media_stream_source_configurations[].input_configurations[].interface

The VPC interface where the media stream comes in from.

Show child fields
flow.source.media_stream_source_configurations[].input_configurations[].interface.name

The name of the VPC interface.

flow.source.media_stream_source_configurations[].media_stream_name

The name of the media stream.

flow.source.name

The name of the source.

flow.source.sender_control_port

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

flow.source.sender_ip_address

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

flow.source.source_arn

The ARN of the source.

flow.source.transport

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

Show child fields
flow.source.transport.cidr_allow_list[]
flow.source.transport.max_bitrate

The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.

flow.source.transport.max_latency

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

flow.source.transport.max_sync_buffer

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

flow.source.transport.min_latency

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.

flow.source.transport.protocol

The protocol that is used by the source or output.

flow.source.transport.remote_id

The remote ID for the Zixi-pull stream.

flow.source.transport.sender_control_port

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

flow.source.transport.sender_ip_address

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

flow.source.transport.smoothing_latency

The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.

flow.source.transport.source_listener_address

Source IP or domain name for SRT-caller protocol.

flow.source.transport.source_listener_port

Source port for SRT-caller protocol.

flow.source.transport.stream_id

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

flow.source.vpc_interface_name

The name of the VPC interface that is used for this source.

flow.source.whitelist_cidr

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.

flow.source_failover_config

The settings for source failover.

Show child fields
flow.source_failover_config.failover_mode

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.

flow.source_failover_config.recovery_window

Search window time to look for dash-7 packets

flow.source_failover_config.source_priority

The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.

Show child fields
flow.source_failover_config.source_priority.primary_source

The name of the source you choose as the primary source for this flow.

flow.source_failover_config.state
flow.sources[]
Show child fields
flow.sources[].data_transfer_subscriber_fee_percent

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

flow.sources[].decryption

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

Show child fields
flow.sources[].decryption.algorithm

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

flow.sources[].decryption.constant_initialization_vector

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.

flow.sources[].decryption.device_id

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.

flow.sources[].decryption.key_type

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

flow.sources[].decryption.region

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.

flow.sources[].decryption.resource_id

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.

flow.sources[].decryption.role_arn

The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).

flow.sources[].decryption.secret_arn

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.

flow.sources[].decryption.url

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.

flow.sources[].description

A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.

flow.sources[].entitlement_arn

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.

flow.sources[].gateway_bridge_source

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

Show child fields
flow.sources[].gateway_bridge_source.bridge_arn

The ARN of the bridge feeding this flow.

flow.sources[].gateway_bridge_source.vpc_interface_attachment

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

Show child fields
flow.sources[].gateway_bridge_source.vpc_interface_attachment.vpc_interface_name

The name of the VPC interface to use for this resource.

flow.sources[].ingest_ip

The IP address that the flow will be listening on for incoming content.

flow.sources[].ingest_port

The port that the flow will be listening on for incoming content.

flow.sources[].media_stream_source_configurations[]
Show child fields
flow.sources[].media_stream_source_configurations[].encoding_name

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.

flow.sources[].media_stream_source_configurations[].input_configurations[]
Show child fields
flow.sources[].media_stream_source_configurations[].input_configurations[].input_ip

The IP address that the flow listens on for incoming content for a media stream.

flow.sources[].media_stream_source_configurations[].input_configurations[].input_port

The port that the flow listens on for an incoming media stream.

flow.sources[].media_stream_source_configurations[].input_configurations[].interface

The VPC interface where the media stream comes in from.

Show child fields
flow.sources[].media_stream_source_configurations[].input_configurations[].interface.name

The name of the VPC interface.

flow.sources[].media_stream_source_configurations[].media_stream_name

The name of the media stream.

flow.sources[].name

The name of the source.

flow.sources[].sender_control_port

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

flow.sources[].sender_ip_address

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

flow.sources[].source_arn

The ARN of the source.

flow.sources[].transport

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

Show child fields
flow.sources[].transport.cidr_allow_list[]
flow.sources[].transport.max_bitrate

The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.

flow.sources[].transport.max_latency

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

flow.sources[].transport.max_sync_buffer

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

flow.sources[].transport.min_latency

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.

flow.sources[].transport.protocol

The protocol that is used by the source or output.

flow.sources[].transport.remote_id

The remote ID for the Zixi-pull stream.

flow.sources[].transport.sender_control_port

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

flow.sources[].transport.sender_ip_address

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

flow.sources[].transport.smoothing_latency

The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.

flow.sources[].transport.source_listener_address

Source IP or domain name for SRT-caller protocol.

flow.sources[].transport.source_listener_port

Source port for SRT-caller protocol.

flow.sources[].transport.stream_id

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

flow.sources[].vpc_interface_name

The name of the VPC interface that is used for this source.

flow.sources[].whitelist_cidr

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.

flow.status

The current status of the flow.

flow.vpc_interfaces[]
Show child fields
flow.vpc_interfaces[].name

Immutable and has to be a unique against other VpcInterfaces in this Flow.

flow.vpc_interfaces[].network_interface_ids[]
flow.vpc_interfaces[].network_interface_type

The type of network interface.

flow.vpc_interfaces[].role_arn

Role Arn MediaConnect can assumes to create ENIs in customer's account

flow.vpc_interfaces[].security_group_ids[]
flow.vpc_interfaces[].subnet_id

Subnet must be in the AZ of the Flow

messages

Messages that provide the state of the flow.

STRUCT(
    "errors" VARCHAR[]
)
Show child fields
messages.errors[]