URI HTTP methods Schemas Properties See also

Flows: describe, update, delete

URI

/v1/flows/flowArn

HTTP methods

GET

Operation ID: DescribeFlow

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.

Path parameters
Name	Type	Required	Description
`flowArn`	String	True	The Amazon Resource Name (ARN) of the flow.

Responses
Status code	Response model	Description
`200`	`DescribeFlowResponse`	MediaConnect returned the flow details successfully.
`400`	`ResponseError`	The request that you submitted is not valid.
`403`	`ResponseError`	You don't have the required permissions to perform this operation.
`404`	`ResponseError`	MediaConnect did not find the resource that you specified in the request.
`429`	`ResponseError`	You have exceeded the service request rate limit for your MediaConnect account.
`500`	`ResponseError`	MediaConnect can't fulfill your request because it encountered an unexpected condition.
`503`	`ResponseError`	MediaConnect is currently unavailable. Try again later.

PUT

Operation ID: UpdateFlow

Updates the properties of the flow, including the source failover configuration.

Path parameters
Name	Type	Required	Description
`flowArn`	String	True	The Amazon Resource Name (ARN) of the flow.

Responses
Status code	Response model	Description
`202`	`UpdateFlowResponse`	MediaConnect is starting the flow.
`400`	`ResponseError`	The request that you submitted is not valid.
`403`	`ResponseError`	You don't have the required permissions to perform this operation.
`404`	`ResponseError`	MediaConnect did not find the resource that you specified in the request.
`429`	`ResponseError`	You have exceeded the service request rate limit for your MediaConnect account.
`500`	`ResponseError`	MediaConnect can't fulfill your request because it encountered an unexpected condition.
`503`	`ResponseError`	MediaConnect is currently unavailable. Try again later.

DELETE

Operation ID: DeleteFlow

Deletes a flow. Before you can delete a flow, you must stop the flow.

Path parameters
Name	Type	Required	Description
`flowArn`	String	True	The Amazon Resource Name (ARN) of the flow.

Responses
Status code	Response model	Description
`202`	`DeleteFlowResponse`	MediaConnect is deleting the flow.
`400`	`ResponseError`	The request that you submitted is not valid.
`403`	`ResponseError`	You don't have the required permissions to perform this operation.
`404`	`ResponseError`	MediaConnect did not find the resource that you specified in the request.
`429`	`ResponseError`	You have exceeded the service request rate limit for your MediaConnect account.
`500`	`ResponseError`	MediaConnect can't fulfill your request because it encountered an unexpected condition.
`503`	`ResponseError`	MediaConnect is currently unavailable. Try again later.

Schemas

Request bodies


{
  "sourceFailoverConfig": {
    "failoverMode": enum,
    "recoveryWindow": integer,
    "state": enum,
    "sourcePriority": {
      "primarySource": "string"
    }
  },
  "maintenance": {
    "maintenanceScheduledDate": "string",
    "maintenanceDay": enum,
    "maintenanceStartHour": "string"
  }
}

Response bodies


{
  "messages": {
    "errors": [
      "string"
    ]
  },
  "flow": {
    "entitlements": [
      {
        "entitlementStatus": enum,
        "encryption": {
          "resourceId": "string",
          "roleArn": "string",
          "secretArn": "string",
          "constantInitializationVector": "string",
          "keyType": enum,
          "region": "string",
          "deviceId": "string",
          "url": "string",
          "algorithm": enum
        },
        "subscribers": [
          "string"
        ],
        "name": "string",
        "description": "string",
        "dataTransferSubscriberFeePercent": integer,
        "entitlementArn": "string"
      }
    ],
    "outputs": [
      {
        "listenerAddress": "string",
        "mediaStreamOutputConfigurations": [
          {
            "encodingParameters": {
              "encoderProfile": enum,
              "compressionFactor": number
            },
            "mediaStreamName": "string",
            "encodingName": enum,
            "destinationConfigurations": [
              {
                "destinationIp": "string",
                "destinationPort": integer,
                "outboundIp": "string",
                "interface": {
                  "name": "string"
                }
              }
            ]
          }
        ],
        "destination": "string",
        "description": "string",
        "entitlementArn": "string",
        "transport": {
          "streamId": "string",
          "minLatency": integer,
          "maxLatency": integer,
          "maxBitrate": integer,
          "sourceListenerPort": integer,
          "smoothingLatency": integer,
          "remoteId": "string",
          "sourceListenerAddress": "string",
          "senderIpAddress": "string",
          "protocol": enum,
          "senderControlPort": integer,
          "cidrAllowList": [
            "string"
          ],
          "maxSyncBuffer": integer
        },
        "vpcInterfaceAttachment": {
          "vpcInterfaceName": "string"
        },
        "outputArn": "string",
        "encryption": {
          "resourceId": "string",
          "roleArn": "string",
          "secretArn": "string",
          "constantInitializationVector": "string",
          "keyType": enum,
          "region": "string",
          "deviceId": "string",
          "url": "string",
          "algorithm": enum
        },
        "port": integer,
        "name": "string",
        "dataTransferSubscriberFeePercent": integer,
        "mediaLiveInputArn": "string"
      }
    ],
    "sources": [
      {
        "sourceArn": "string",
        "vpcInterfaceName": "string",
        "description": "string",
        "entitlementArn": "string",
        "transport": {
          "streamId": "string",
          "minLatency": integer,
          "maxLatency": integer,
          "maxBitrate": integer,
          "sourceListenerPort": integer,
          "smoothingLatency": integer,
          "remoteId": "string",
          "sourceListenerAddress": "string",
          "senderIpAddress": "string",
          "protocol": enum,
          "senderControlPort": integer,
          "cidrAllowList": [
            "string"
          ],
          "maxSyncBuffer": integer
        },
        "mediaStreamSourceConfigurations": [
          {
            "mediaStreamName": "string",
            "encodingName": enum,
            "inputConfigurations": [
              {
                "inputIp": "string",
                "inputPort": integer,
                "interface": {
                  "name": "string"
                }
              }
            ]
          }
        ],
        "whitelistCidr": "string",
        "senderIpAddress": "string",
        "senderControlPort": integer,
        "name": "string",
        "dataTransferSubscriberFeePercent": integer,
        "ingestIp": "string",
        "decryption": {
          "resourceId": "string",
          "roleArn": "string",
          "secretArn": "string",
          "constantInitializationVector": "string",
          "keyType": enum,
          "region": "string",
          "deviceId": "string",
          "url": "string",
          "algorithm": enum
        },
        "ingestPort": integer
      }
    ],
    "description": "string",
    "sourceFailoverConfig": {
      "failoverMode": enum,
      "recoveryWindow": integer,
      "state": enum,
      "sourcePriority": {
        "primarySource": "string"
      }
    },
    "source": {
      "sourceArn": "string",
      "vpcInterfaceName": "string",
      "description": "string",
      "entitlementArn": "string",
      "transport": {
        "streamId": "string",
        "minLatency": integer,
        "maxLatency": integer,
        "maxBitrate": integer,
        "sourceListenerPort": integer,
        "smoothingLatency": integer,
        "remoteId": "string",
        "sourceListenerAddress": "string",
        "senderIpAddress": "string",
        "protocol": enum,
        "senderControlPort": integer,
        "cidrAllowList": [
          "string"
        ],
        "maxSyncBuffer": integer
      },
      "mediaStreamSourceConfigurations": [
        {
          "mediaStreamName": "string",
          "encodingName": enum,
          "inputConfigurations": [
            {
              "inputIp": "string",
              "inputPort": integer,
              "interface": {
                "name": "string"
              }
            }
          ]
        }
      ],
      "whitelistCidr": "string",
      "senderIpAddress": "string",
      "senderControlPort": integer,
      "name": "string",
      "dataTransferSubscriberFeePercent": integer,
      "ingestIp": "string",
      "decryption": {
        "resourceId": "string",
        "roleArn": "string",
        "secretArn": "string",
        "constantInitializationVector": "string",
        "keyType": enum,
        "region": "string",
        "deviceId": "string",
        "url": "string",
        "algorithm": enum
      },
      "ingestPort": integer
    },
    "availabilityZone": "string",
    "mediaStreams": [
      {
        "mediaStreamId": integer,
        "mediaStreamType": enum,
        "videoFormat": "string",
        "mediaStreamName": "string",
        "description": "string",
        "attributes": {
          "fmtp": {
            "colorimetry": enum,
            "par": "string",
            "tcs": enum,
            "scanMode": enum,
            "range": enum,
            "channelOrder": "string",
            "exactFramerate": "string"
          },
          "lang": "string"
        },
        "fmt": integer,
        "clockRate": integer
      }
    ],
    "flowArn": "string",
    "name": "string",
    "egressIp": "string",
    "vpcInterfaces": [
      {
        "subnetId": "string",
        "roleArn": "string",
        "securityGroupIds": [
          "string"
        ],
        "name": "string",
        "networkInterfaceType": enum,
        "networkInterfaceIds": [
          "string"
        ]
      }
    ],
    "maintenance": {
      "maintenanceScheduledDate": "string",
      "maintenanceDeadline": "string",
      "maintenanceDay": enum,
      "maintenanceStartHour": "string"
    },
    "status": enum
  }
}


{
  "flow": {
    "entitlements": [
      {
        "entitlementStatus": enum,
        "encryption": {
          "resourceId": "string",
          "roleArn": "string",
          "secretArn": "string",
          "constantInitializationVector": "string",
          "keyType": enum,
          "region": "string",
          "deviceId": "string",
          "url": "string",
          "algorithm": enum
        },
        "subscribers": [
          "string"
        ],
        "name": "string",
        "description": "string",
        "dataTransferSubscriberFeePercent": integer,
        "entitlementArn": "string"
      }
    ],
    "outputs": [
      {
        "listenerAddress": "string",
        "mediaStreamOutputConfigurations": [
          {
            "encodingParameters": {
              "encoderProfile": enum,
              "compressionFactor": number
            },
            "mediaStreamName": "string",
            "encodingName": enum,
            "destinationConfigurations": [
              {
                "destinationIp": "string",
                "destinationPort": integer,
                "outboundIp": "string",
                "interface": {
                  "name": "string"
                }
              }
            ]
          }
        ],
        "destination": "string",
        "description": "string",
        "entitlementArn": "string",
        "transport": {
          "streamId": "string",
          "minLatency": integer,
          "maxLatency": integer,
          "maxBitrate": integer,
          "sourceListenerPort": integer,
          "smoothingLatency": integer,
          "remoteId": "string",
          "sourceListenerAddress": "string",
          "senderIpAddress": "string",
          "protocol": enum,
          "senderControlPort": integer,
          "cidrAllowList": [
            "string"
          ],
          "maxSyncBuffer": integer
        },
        "vpcInterfaceAttachment": {
          "vpcInterfaceName": "string"
        },
        "outputArn": "string",
        "encryption": {
          "resourceId": "string",
          "roleArn": "string",
          "secretArn": "string",
          "constantInitializationVector": "string",
          "keyType": enum,
          "region": "string",
          "deviceId": "string",
          "url": "string",
          "algorithm": enum
        },
        "port": integer,
        "name": "string",
        "dataTransferSubscriberFeePercent": integer,
        "mediaLiveInputArn": "string"
      }
    ],
    "sources": [
      {
        "sourceArn": "string",
        "vpcInterfaceName": "string",
        "description": "string",
        "entitlementArn": "string",
        "transport": {
          "streamId": "string",
          "minLatency": integer,
          "maxLatency": integer,
          "maxBitrate": integer,
          "sourceListenerPort": integer,
          "smoothingLatency": integer,
          "remoteId": "string",
          "sourceListenerAddress": "string",
          "senderIpAddress": "string",
          "protocol": enum,
          "senderControlPort": integer,
          "cidrAllowList": [
            "string"
          ],
          "maxSyncBuffer": integer
        },
        "mediaStreamSourceConfigurations": [
          {
            "mediaStreamName": "string",
            "encodingName": enum,
            "inputConfigurations": [
              {
                "inputIp": "string",
                "inputPort": integer,
                "interface": {
                  "name": "string"
                }
              }
            ]
          }
        ],
        "whitelistCidr": "string",
        "senderIpAddress": "string",
        "senderControlPort": integer,
        "name": "string",
        "dataTransferSubscriberFeePercent": integer,
        "ingestIp": "string",
        "decryption": {
          "resourceId": "string",
          "roleArn": "string",
          "secretArn": "string",
          "constantInitializationVector": "string",
          "keyType": enum,
          "region": "string",
          "deviceId": "string",
          "url": "string",
          "algorithm": enum
        },
        "ingestPort": integer
      }
    ],
    "description": "string",
    "sourceFailoverConfig": {
      "failoverMode": enum,
      "recoveryWindow": integer,
      "state": enum,
      "sourcePriority": {
        "primarySource": "string"
      }
    },
    "source": {
      "sourceArn": "string",
      "vpcInterfaceName": "string",
      "description": "string",
      "entitlementArn": "string",
      "transport": {
        "streamId": "string",
        "minLatency": integer,
        "maxLatency": integer,
        "maxBitrate": integer,
        "sourceListenerPort": integer,
        "smoothingLatency": integer,
        "remoteId": "string",
        "sourceListenerAddress": "string",
        "senderIpAddress": "string",
        "protocol": enum,
        "senderControlPort": integer,
        "cidrAllowList": [
          "string"
        ],
        "maxSyncBuffer": integer
      },
      "mediaStreamSourceConfigurations": [
        {
          "mediaStreamName": "string",
          "encodingName": enum,
          "inputConfigurations": [
            {
              "inputIp": "string",
              "inputPort": integer,
              "interface": {
                "name": "string"
              }
            }
          ]
        }
      ],
      "whitelistCidr": "string",
      "senderIpAddress": "string",
      "senderControlPort": integer,
      "name": "string",
      "dataTransferSubscriberFeePercent": integer,
      "ingestIp": "string",
      "decryption": {
        "resourceId": "string",
        "roleArn": "string",
        "secretArn": "string",
        "constantInitializationVector": "string",
        "keyType": enum,
        "region": "string",
        "deviceId": "string",
        "url": "string",
        "algorithm": enum
      },
      "ingestPort": integer
    },
    "availabilityZone": "string",
    "mediaStreams": [
      {
        "mediaStreamId": integer,
        "mediaStreamType": enum,
        "videoFormat": "string",
        "mediaStreamName": "string",
        "description": "string",
        "attributes": {
          "fmtp": {
            "colorimetry": enum,
            "par": "string",
            "tcs": enum,
            "scanMode": enum,
            "range": enum,
            "channelOrder": "string",
            "exactFramerate": "string"
          },
          "lang": "string"
        },
        "fmt": integer,
        "clockRate": integer
      }
    ],
    "flowArn": "string",
    "name": "string",
    "egressIp": "string",
    "vpcInterfaces": [
      {
        "subnetId": "string",
        "roleArn": "string",
        "securityGroupIds": [
          "string"
        ],
        "name": "string",
        "networkInterfaceType": enum,
        "networkInterfaceIds": [
          "string"
        ]
      }
    ],
    "maintenance": {
      "maintenanceScheduledDate": "string",
      "maintenanceDeadline": "string",
      "maintenanceDay": enum,
      "maintenanceStartHour": "string"
    },
    "status": enum
  }
}


{
  "flowArn": "string",
  "status": enum
}


{
  "message": "string"
}

Properties

DeleteFlowResponse

The result of a successful DeleteFlow request.

Property Type Required Description

Property	Type	Required	Description
`flowArn`	string	True	The ARN of the flow that you deleted.
`status`	string Values: `STANDBY \| ACTIVE \| UPDATING \| DELETING \| STARTING \| STOPPING \| ERROR`	True	The status of the flow when the DeleteFlow process begins.

flowArn

string

True

The ARN of the flow that you deleted.

status

string

True

The status of the flow when the DeleteFlow process begins.

DescribeFlowResponse

The result of a successful DescribeFlow request.

Property	Type	Required	Description
`flow`	Flow	True	The flow that you requested a description of.
`messages`	Messages	False	Any errors that apply currently to the flow. If there are no errors, MediaConnect will not include this field in the response.

DestinationConfiguration

The definition of a media stream that is associated with the output.

Property	Type	Required	Description
`destinationIp`	string	True	The IP address where contents of the media stream will be sent.
`destinationPort`	integer Format: int32	True	The port to use when the content of the media stream is distributed to the output.
`interface`	Interface	True	The VPC interface that is used for the media stream associated with the output.
`outboundIp`	string	True	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.

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.

Property Type Required Description

Property	Type	Required	Description
`compressionFactor`	number Format: float	True	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.
`encoderProfile`	string Values: `main \| high`	True	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.

compressionFactor

number

Format: float

True

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.

encoderProfile

string

Values: main | high

True

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.

Encryption

Information about the encryption of the flow.

Property	Type	Required	Description
`algorithm`	string Values: `aes128 \| aes192 \| aes256`	False	The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
`constantInitializationVector`	string	False	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.
`deviceId`	string	False	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.
`keyType`	string Values: `speke \| static-key \| srt-password`	False	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`).
`region`	string	False	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.
`resourceId`	string	False	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.
`roleArn`	string	True	The Amazon Resource Name (ARN) of the role that you created during setup (when you set up MediaConnect as a trusted entity).
`secretArn`	string	False	The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
`url`	string	False	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.

Entitlement

The settings for a flow entitlement.

Property	Type	Required	Description
`dataTransferSubscriberFeePercent`	integer	False	The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.
`description`	string	False	A description of the entitlement. This description appears only on the MediaConnect console and is not visible outside of the current AWS account.
`encryption`	Encryption	False	The type of encryption that MediaConnect will use on the output that is associated with the entitlement.
`entitlementArn`	string	True	The ARN of the entitlement.
`entitlementStatus`	string Values: `ENABLED \| DISABLED`	False	An indication of whether the entitlement is enabled.
`name`	string	True	The name of the entitlement.
`subscribers`	Array of type string	True	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.

FailoverConfig

The settings for source failover.

Property	Type	Required	Description
`failoverMode`	string Values: `MERGE \| FAILOVER`	False	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.
`recoveryWindow`	integer	False	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`	SourcePriority	False	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.
`state`	string Values: `ENABLED \| DISABLED`	False	The state of source failover on the flow. If the state is disabled, the flow can have only one source. If the state is enabled, the flow can have one or two sources.

Flow

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

Property	Type	Required	Description
`availabilityZone`	string	True	The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region.
`description`	string	False	A description of the flow. This description appears only on the MediaConnect console and is not visible outside of the current AWS account.
`egressIp`	string	False	The outgoing IP address that MediaConnect uses to send video from the flow.
`entitlements`	Array of type Entitlement	True	The entitlements in the flow.
`flowArn`	string	True	The Amazon Resource Name (ARN) of the flow.
`maintenance`	Maintenance	False
`mediaStreams`	Array of type MediaStream	False	The media streams associated with the flow. You can associate any of these media streams with sources and outputs on the flow.
`name`	string	True	The name of the flow.
`outputs`	Array of type Output	True	The outputs in the flow.
`source`	Source	True	The source for the flow.
`sourceFailoverConfig`	FailoverConfig	False	The settings for source failover.
`sources`	Array of type Source	False	The settings for the sources that are assigned to the flow.
`status`	string Values: `STANDBY \| ACTIVE \| UPDATING \| DELETING \| STARTING \| STOPPING \| ERROR`	True	The current status of the flow.
`vpcInterfaces`	Array of type VpcInterface	False	The VPC interfaces that you added to this flow.

Fmtp

A set of parameters that define the media stream.

Property	Type	Required	Description
`channelOrder`	string	False	The format of the audio channel.
`colorimetry`	string Values: `BT601 \| BT709 \| BT2020 \| BT2100 \| ST2065-1 \| ST2065-3 \| XYZ`	False	The format used for the representation of color.
`exactFramerate`	string	False	The frame rate for the video stream, in frames/second. For example: 60000/1001.
`par`	string	False	The pixel aspect ratio (PAR) of the video.
`range`	string Values: `NARROW \| FULL \| FULLPROTECT`	False	The encoding range of the video.
`scanMode`	string Values: `progressive \| interlace \| progressive-segmented-frame`	False	The type of compression that was used to smooth the video’s appearance.
`tcs`	string Values: `SDR \| PQ \| HLG \| LINEAR \| BT2100LINPQ \| BT2100LINHLG \| ST2065-1 \| ST428-1 \| DENSITY`	False	The transfer characteristic system (TCS) that is used in the video.

InputConfiguration

The transport parameters associated with an incoming media stream.

Property Type Required Description

Property	Type	Required	Description
`inputIp`	string	True	The IP address that the flow listens on for incoming content for a media stream.
`inputPort`	integer Format: int32	True	The port that the flow listens on for an incoming media stream.
`interface`	Interface	True	The VPC interface where the media stream comes in from.

inputIp

string

True

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

inputPort

integer

Format: int32

True

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

interface

Interface

True

The VPC interface where the media stream comes in from.

Interface

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

Property	Type	Required	Description
`name`	string	True	The name of the VPC interface that you want to use for the media stream associated with the output.

Maintenance

The maintenance setting of a flow

Property	Type	Required	Description
`maintenanceDay`	string Values: `Monday \| Tuesday \| Wednesday \| Thursday \| Friday \| Saturday \| Sunday`	False	A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
`maintenanceDeadline`	string	False	The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.
`maintenanceScheduledDate`	string	False	A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
`maintenanceStartHour`	string	False	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.

MediaStream

A single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams.

Property	Type	Required	Description
`attributes`	MediaStreamAttributes	False	Attributes that are related to the media stream.
`clockRate`	integer Format: int32	False	The sample rate for the stream. This value in measured in kHz.
`description`	string	False	A description that can help you quickly identify what your media stream is used for.
`fmt`	integer Format: int32	True	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.
`mediaStreamId`	integer Format: int32	True	A unique identifier for the media stream.
`mediaStreamName`	string	True	A name that helps you distinguish one media stream from another.
`mediaStreamType`	string Values: `video \| audio \| ancillary-data`	True	The type of media stream.
`videoFormat`	string	False	The resolution of the video.

MediaStreamAttributes

Attributes that are related to the media stream.

Property	Type	Required	Description
`fmtp`	Fmtp	True	A set of parameters that define the media stream.
`lang`	string	False	The audio language, in a format that is recognized by the receiver.

MediaStreamOutputConfiguration

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

Property	Type	Required	Description
`destinationConfigurations`	Array of type DestinationConfiguration	False	The media streams that you want to associate with the output.
`encodingName`	string Values: `jxsv \| raw \| smpte291 \| pcm`	True	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`	EncodingParameters	False	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.
`mediaStreamName`	string	True	A name that helps you distinguish one media stream from another.

MediaStreamSourceConfiguration

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

Property Type Required Description

Property	Type	Required	Description
`encodingName`	string Values: `jxsv \| raw \| smpte291 \| pcm`	True	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`.
`inputConfigurations`	Array of type InputConfiguration	False	The media streams that you want to associate with the source.
`mediaStreamName`	string	True	A name that helps you distinguish one media stream from another.

encodingName

string

Values: jxsv | raw | smpte291 | pcm

True

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.

inputConfigurations

Array of type InputConfiguration

False

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

mediaStreamName

string

True

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

Messages

Messages that provide the state of the flow.

Property	Type	Required	Description
`errors`	Array of type string	True	A list of errors that apply currently to the flow. If there are no errors, MediaConnect will not include this field in the response.

Output

The settings for an output.

Property	Type	Required	Description
`dataTransferSubscriberFeePercent`	integer	False	The percentage of the entitlement data transfer fee that the subscriber is responsible for.
`description`	string	False	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.
`destination`	string	False	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`	Encryption	False	The encryption credentials that you want to use for the output.
`entitlementArn`	string	False	The ARN of the entitlement on the originator's flow. This value is relevant only on entitled flows.
`listenerAddress`	string	False	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.
`mediaLiveInputArn`	string	False	The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
`mediaStreamOutputConfigurations`	Array of type MediaStreamOutputConfiguration	False	The configuration for each media stream that is associated with the output.
`name`	string	True	The name of the output. This value must be unique within the current flow.
`outputArn`	string	True	The ARN of the output.
`port`	integer	False	The port to use when content is distributed to the output.
`transport`	Transport	False	Attributes that are related to the transport stream.
`vpcInterfaceAttachment`	VpcInterfaceAttachment	False	The VPC interface that you want to send your output to.

ResponseError

An exception raised by MediaConnect when you submit a request that cannot be completed. For more information, see the error message and documentation for the operation.

Property	Type	Required	Description
`message`	string	True	The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.

Source

The details of the sources of the flow.

Property	Type	Required	Description
`dataTransferSubscriberFeePercent`	integer	False	The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.
`decryption`	Encryption	False	The type of encryption that is used on the content ingested from the source.
`description`	string	False	A description of the source. This description is not visible outside of the current AWS account.
`entitlementArn`	string	False	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.
`ingestIp`	string	False	The IP address that the flow listens on for incoming content.
`ingestPort`	integer	False	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.
`mediaStreamSourceConfigurations`	Array of type MediaStreamSourceConfiguration	False	The media stream that is associated with the source, and the parameters for that association.
`name`	string	True	The name of the source.
`senderControlPort`	integer Format: int32	False	The port that the flow uses to send outbound requests to initiate connection with the sender.
`senderIpAddress`	string	False	The IP address that the flow communicates with to initiate connection with the sender.
`sourceArn`	string	True	The ARN of the source.
`transport`	Transport	False	Attributes that are related to the transport stream.
`vpcInterfaceName`	string	False	The name of the VPC interface that the source content comes from.
`whitelistCidr`	string	False	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.

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.

Property	Type	Required	Description
`primarySource`	string	False	The name of the source you choose as the primary source for this flow.

Transport

Attributes that are related to the transport stream.

Property	Type	Required	Description
`cidrAllowList`	Array of type string	False	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.
`maxBitrate`	integer Format: int64	False	The maximum bitrate for RIST, RTP, and RTP-FEC streams.
`maxLatency`	integer Format: int64	False	The maximum latency in milliseconds for a RIST source, a Zixi-based source, a Fujitsu-based source, or a Zixi-based output.
`maxSyncBuffer`	integer Format: int32	False	The size of the buffer (in milliseconds) to use to sync incoming source data.
`minLatency`	integer Format: int64	False	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.
`protocol`	string Values: `zixi-push \| rtp-fec \| rtp \| zixi-pull \| rist \| st2110-jpegxs \| cdi \| srt-listener \| srt-caller \| fujitsu-qos`	True	The protocol that is used by the source or output.
`remoteId`	string	False	The identifier that is assigned to the Zixi receiver. This parameter applies only to outputs that use Zixi pull.
`senderControlPort`	integer Format: int32	False	The port that the flow uses to send outbound requests to initiate connection with the sender.
`senderIpAddress`	string	False	The IP address that the flow communicates with to initiate connection with the sender.
`smoothingLatency`	integer Format: int64	False	The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
`sourceListenerAddress`	string	False	Source IP or domain name for SRT-caller protocol.
`sourceListenerPort`	integer	False	Source port for SRT-caller protocol.
`streamId`	string	False	The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.

UpdateFailoverConfig

The settings for source failover.

Property	Type	Required	Description
`failoverMode`	string Values: `MERGE \| FAILOVER`	False	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.
`recoveryWindow`	integer	False	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`	SourcePriority	False	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.
`state`	string Values: `ENABLED \| DISABLED`	False	The state of source failover on the flow. If the state is disabled, the flow can have only one source. If the state is enabled, the flow can have one or two sources.

UpdateFlowRequest

Updates an existing flow.

Property	Type	Required	Description
`maintenance`	UpdateMaintenance	False
`sourceFailoverConfig`	UpdateFailoverConfig	False	The settings for source failover.

UpdateFlowResponse

The result of a successful UpdateFlow request.

Property	Type	Required	Description
`flow`	Flow	True	The settings for a flow, including its source, outputs, and entitlements.

UpdateMaintenance

Update maintenance setting for a flow

Property Type Required Description

Property	Type	Required	Description
`maintenanceDay`	string Values: `Monday \| Tuesday \| Wednesday \| Thursday \| Friday \| Saturday \| Sunday`	False	A day of a week when the maintenance will happen. use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
`maintenanceScheduledDate`	string	False	A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
`maintenanceStartHour`	string	False	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.

maintenanceDay

string

False

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

maintenanceScheduledDate

string

False

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

maintenanceStartHour

string

False

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.

VpcInterface

The details of a VPC interface.

Property	Type	Required	Description
`name`	string	True	The name for the VPC interface. This name must be unique within the flow.
`networkInterfaceIds`	Array of type string	True	The IDs of the network interfaces that MediaConnect created in your account.
`networkInterfaceType`	string Values: `ena \| efa`	True	The type of network interface.
`roleArn`	string	True	The ARN of the IAM role that you created when you set up MediaConnect as a trusted service.
`securityGroupIds`	Array of type string	True	A virtual firewall to control inbound and outbound traffic.
`subnetId`	string	True	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.

VpcInterfaceAttachment

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

Property	Type	Required	Description
`vpcInterfaceName`	string	False	The name of the VPC interface that you want to send your output to.