Flows: describe, update, delete

The Amazon Resource Name (ARN) of the flow.

MediaConnect returned the flow details successfully.

The request that you submitted is not valid.

You don't have the required permissions to perform this operation.

MediaConnect did not find the resource that you specified in the request.

You have exceeded the service request rate limit for your MediaConnect account.

MediaConnect can't fulfill your request because it encountered an unexpected condition.

MediaConnect is currently unavailable. Try again later.

The Amazon Resource Name (ARN) of the flow.

MediaConnect is starting the flow.

The request that you submitted is not valid.

You don't have the required permissions to perform this operation.

MediaConnect did not find the resource that you specified in the request.

You have exceeded the service request rate limit for your MediaConnect account.

MediaConnect can't fulfill your request because it encountered an unexpected condition.

MediaConnect is currently unavailable. Try again later.

The Amazon Resource Name (ARN) of the flow.

MediaConnect is deleting the flow.

The request that you submitted is not valid.

You don't have the required permissions to perform this operation.

MediaConnect did not find the resource that you specified in the request.

You have exceeded the service request rate limit for your MediaConnect account.

MediaConnect can't fulfill your request because it encountered an unexpected condition.

MediaConnect is currently unavailable. Try again later.

string

The ARN of the flow that you deleted.

string

Values: STANDBY | ACTIVE | UPDATING | DELETING | STARTING | STOPPING | ERROR

The status of the flow when the DeleteFlow process begins.

Flow

The flow that you requested a description of.

Messages

Any errors that apply currently to the flow. If there are no errors, MediaConnect will not include this field in the response.

string

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

integer

Format: int32

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

Interface

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

string

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

number

Format: float

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 in the range of 3.0 to 10.0, inclusive.

string

Values: main | high

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.

string

Values: aes128 | aes192 | aes256

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

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.

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.

string

Values: speke | static-key | srt-password

The type of key that is used for the encryption. If you don't specify a keyType value, the service uses the default setting (static-key).

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.

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.

string

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

string

The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.

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.

integer

The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.

string

A description of the entitlement. This description appears only on the MediaConnect console and is not visible outside of the current AWS account.

Encryption

The type of encryption that MediaConnect will use on the output that is associated with the entitlement.

string

The ARN of the entitlement.

string

Values: ENABLED | DISABLED

An indication of whether the entitlement is enabled.

string

The name of the entitlement.

Array of type string

The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.

string

Values: MERGE | FAILOVER

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.

integer

The size of the buffer (delay) that the service maintains. A larger buffer means a longer delay in transmitting the stream, but more room for error correction. A smaller buffer means a shorter delay, but less room for error correction. You can choose a value from 100-500 ms. If you keep this field blank, the service uses the default value of 200 ms. This setting only applies when Failover Mode is set to MERGE.

SourcePriority

The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams. This setting only applies when Failover Mode is set to FAILOVER.

string

Values: ENABLED | DISABLED

The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.

string

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

string

A description of the flow. This description appears only on the MediaConnect console and is not visible outside of the current AWS account.

string

The outgoing IP address that MediaConnect uses to send video from the flow.

Array of type Entitlement

The entitlements in the flow.

string

The Amazon Resource Name (ARN) of the flow.

Maintenance

Array of type MediaStream

The media streams associated with the flow. You can associate any of these media streams with sources and outputs on the flow.

string

The name of the flow.

Array of type Output

The outputs in the flow.

Source

The source for the flow.

FailoverConfig

The settings for source failover.

MonitoringConfig

Array of type Source

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

string

Values: STANDBY | ACTIVE | UPDATING | DELETING | STARTING | STOPPING | ERROR

The current status of the flow.

Array of type VpcInterface

The VPC interfaces that you added to this flow.

string

The format of the audio channel.

string

Values: BT601 | BT709 | BT2020 | BT2100 | ST2065-1 | ST2065-3 | XYZ

The format used for the representation of color.

string

The frame rate for the video stream, in frames/second. For example: 60000/1001.

string

The pixel aspect ratio (PAR) of the video.

string

Values: NARROW | FULL | FULLPROTECT

The encoding range of the video.

string

Values: progressive | interlace | progressive-segmented-frame

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

string

Values: SDR | PQ | HLG | LINEAR | BT2100LINPQ | BT2100LINHLG | ST2065-1 | ST428-1 | DENSITY

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

string

The ARN of the bridge feeding this flow.

VpcInterfaceAttachment

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

string

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

integer

Format: int32

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

Interface

The VPC interface where the media stream comes in from.

string

The name of the VPC interface that you want to use for the media stream associated with the output.

string

Values: Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday

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

string

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

string

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

string

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.

MediaStreamAttributes

Attributes that are related to the media stream.

integer

Format: int32

The sample rate for the stream. This value in measured in kHz.

string

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

integer

Format: int32

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.

integer

Format: int32

A unique identifier for the media stream.

string

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

string

Values: video | audio | ancillary-data

The type of media stream.

string

The resolution of the video.

Fmtp

A set of parameters that define the media stream.

string

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

Array of type DestinationConfiguration

The media streams that you want to associate with the output.

string

Values: jxsv | raw | smpte291 | pcm

The format that will be 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 streams on sources or outputs that use the CDI protocol, set the encoding name to raw.

For video streams on sources or outputs that use the ST 2110 JPEG XS protocol, set the encoding name to jxsv.

EncodingParameters

A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.

string

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

string

Values: jxsv | raw | smpte291 | pcm

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.

Array of type InputConfiguration

The media streams that you want to associate with the source.

string

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

Array of type string

A list of errors that apply currently to the flow. If there are no errors, MediaConnect will not include this field in the response.

string

Values: ENABLED | DISABLED

The state of thumbnail monitoring.

string

The ARN of the bridge that added this output.

Array of type integer

The bridge output ports currently in use.

integer

The percentage of the entitlement data transfer fee that the subscriber is responsible for.

string

A description of the output. This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.

string

The IP address where you want to send the output. This field applies only to outputs that use a push protocol, such as RIST or Zixi push.

Encryption

The encryption credentials that you want to use for the output.

string

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

string

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 a pull protocol, such as Zixi pull or SRT listener.

string

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

Array of type MediaStreamOutputConfiguration

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

string

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

string

The ARN of the output.

string

Values: ENABLED | DISABLED

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

integer

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

Transport

Attributes that are related to the transport stream.

VpcInterfaceAttachment

The VPC interface that you want to send your output to.

string

The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.

integer

The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.

Encryption

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

string

A description of the source. This description is not visible outside of the current AWS account.

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.

GatewayBridgeSource

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

string

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

integer

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.

Array of type MediaStreamSourceConfiguration

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

string

The name of the source.

integer

Format: int32

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

string

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

string

The ARN of the source.

Transport

Attributes that are related to the transport stream.

string

The name of the VPC interface that the source content comes from.

string

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.

string

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

Array of type string

The range of IP addresses that are allowed to initiate output requests to this flow. Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

integer

Format: int64

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

integer

Format: int64

The maximum latency in milliseconds for a RIST source, a Zixi-based source, or a Zixi-based output.

integer

Format: int32

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

integer

Format: int64

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.

string

Values: zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener | srt-caller | udp

The protocol that is used by the source or output.

string

The identifier that is assigned to the Zixi receiver. This parameter applies only to outputs that use Zixi pull.

integer

Format: int32

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

string

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

integer

Format: int64

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

string

Source IP or domain name for SRT-caller protocol.

integer

Source port for SRT-caller protocol.

string

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

string

Values: MERGE | FAILOVER

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.

integer

The size of the buffer (delay) that you want the service to maintain. A larger buffer means a longer delay in transmitting the stream, but more room for error correction. A smaller buffer means a shorter delay, but less room for error correction. You can choose a value from 100-500 ms. If you keep this field blank, the service uses the default value of 200 ms. This setting only applies when Failover Mode is set to MERGE.

SourcePriority

The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams. This setting only applies when Failover Mode is set to FAILOVER.

string

Values: ENABLED | DISABLED

The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.

UpdateMaintenance

UpdateFailoverConfig

The settings for source failover.

MonitoringConfig

Flow

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

string

Values: Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday

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

string

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

string

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.

string

The name for the VPC interface. This name must be unique within the flow.

Array of type string

The IDs of the network interfaces that MediaConnect created in your account.

string

Values: ena | efa

The type of network interface.

string

The ARN of the IAM role that you created when you set up MediaConnect as a trusted service.

Array of type string

A virtual firewall to control inbound and outbound traffic.

string

The subnet IDs that you specified for your VPC interface.

A subnet ID is a range of IP addresses in your VPC. When you create your VPC, you specify a range of IPv4 addresses for the VPC in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. This is the primary CIDR block for your VPC. When you create a subnet for your VPC, you specify the CIDR block for the subnet, which is a subset of the VPC CIDR block.

The subnets that you use across all VPC interfaces on the flow must be in the same Availability Zone as the flow.

string

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