MediaConnect

Table of Contents

• MediaConnect
  • Client
  • Paginators
  • Waiters

Client

class MediaConnect.Client

A low-level client representing AWS MediaConnect API for AWS Elemental MediaConnect:

import boto3

client = boto3.client('mediaconnect')

These are the available methods:

• add_flow_media_streams()
• add_flow_outputs()
• add_flow_sources()
• add_flow_vpc_interfaces()
• can_paginate()
• close()
• create_flow()
• delete_flow()
• describe_flow()
• describe_offering()
• describe_reservation()
• get_paginator()
• get_waiter()
• grant_flow_entitlements()
• list_entitlements()
• list_flows()
• list_offerings()
• list_reservations()
• list_tags_for_resource()
• purchase_offering()
• remove_flow_media_stream()
• remove_flow_output()
• remove_flow_source()
• remove_flow_vpc_interface()
• revoke_flow_entitlement()
• start_flow()
• stop_flow()
• tag_resource()
• untag_resource()
• update_flow()
• update_flow_entitlement()
• update_flow_media_stream()
• update_flow_output()
• update_flow_source()

add_flow_media_streams(**kwargs)

Adds media streams to an existing flow. After you add a media stream to a flow, you can associate it with a source and/or an output that uses the ST 2110 JPEG XS or CDI protocol.

See also: AWS API Documentation

Request Syntax

response = client.add_flow_media_streams(
    FlowArn='string',
    MediaStreams=[
        {
            'Attributes': {
                'Fmtp': {
                    'ChannelOrder': 'string',
                    'Colorimetry': 'BT601'|'BT709'|'BT2020'|'BT2100'|'ST2065-1'|'ST2065-3'|'XYZ',
                    'ExactFramerate': 'string',
                    'Par': 'string',
                    'Range': 'NARROW'|'FULL'|'FULLPROTECT',
                    'ScanMode': 'progressive'|'interlace'|'progressive-segmented-frame',
                    'Tcs': 'SDR'|'PQ'|'HLG'|'LINEAR'|'BT2100LINPQ'|'BT2100LINHLG'|'ST2065-1'|'ST428-1'|'DENSITY'
                },
                'Lang': 'string'
            },
            'ClockRate': 123,
            'Description': 'string',
            'MediaStreamId': 123,
            'MediaStreamName': 'string',
            'MediaStreamType': 'video'|'audio'|'ancillary-data',
            'VideoFormat': 'string'
        },
    ]
)

Parameters

• FlowArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the flow.
• MediaStreams (list) --

  [REQUIRED] The media streams that you want to add to the flow.

  • (dict) -- The media stream that you want to add to the flow.
    • Attributes (dict) -- The attributes that you want to assign to the new media stream.
      • Fmtp (dict) -- The settings that you want to use to define the media stream.
        • ChannelOrder (string) -- The format of the audio channel.
        • Colorimetry (string) -- The format that is used for the representation of color.
        • ExactFramerate (string) -- 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.
        • Par (string) -- The pixel aspect ratio (PAR) of the video.
        • Range (string) -- The encoding range of the video.
        • ScanMode (string) -- The type of compression that was used to smooth the video’s appearance.
        • Tcs (string) -- The transfer characteristic system (TCS) that is used in the video.
      • Lang (string) -- The audio language, in a format that is recognized by the receiver.
    • ClockRate (integer) -- The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.
    • Description (string) -- A description that can help you quickly identify what your media stream is used for.
    • MediaStreamId (integer) -- [REQUIRED] A unique identifier for the media stream.
    • MediaStreamName (string) -- [REQUIRED] A name that helps you distinguish one media stream from another.
    • MediaStreamType (string) -- [REQUIRED] The type of media stream.
    • VideoFormat (string) -- The resolution of the video.

Return type

dict

Returns

Response Syntax

{
    'FlowArn': 'string',
    'MediaStreams': [
        {
            'Attributes': {
                'Fmtp': {
                    'ChannelOrder': 'string',
                    'Colorimetry': 'BT601'|'BT709'|'BT2020'|'BT2100'|'ST2065-1'|'ST2065-3'|'XYZ',
                    'ExactFramerate': 'string',
                    'Par': 'string',
                    'Range': 'NARROW'|'FULL'|'FULLPROTECT',
                    'ScanMode': 'progressive'|'interlace'|'progressive-segmented-frame',
                    'Tcs': 'SDR'|'PQ'|'HLG'|'LINEAR'|'BT2100LINPQ'|'BT2100LINHLG'|'ST2065-1'|'ST428-1'|'DENSITY'
                },
                'Lang': 'string'
            },
            'ClockRate': 123,
            'Description': 'string',
            'Fmt': 123,
            'MediaStreamId': 123,
            'MediaStreamName': 'string',
            'MediaStreamType': 'video'|'audio'|'ancillary-data',
            'VideoFormat': 'string'
        },
    ]
}

Response Structure

• (dict) -- MediaConnect created the new resource successfully.
  • FlowArn (string) -- The ARN of the flow that you added media streams to.
  • MediaStreams (list) -- The media streams that you added to the flow.
    • (dict) -- 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.
      • Attributes (dict) -- Attributes that are related to the media stream.
        • Fmtp (dict) -- A set of parameters that define the media stream.
          • ChannelOrder (string) -- The format of the audio channel.
          • Colorimetry (string) -- The format that is used for the representation of color.
          • ExactFramerate (string) -- 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.
          • Par (string) -- The pixel aspect ratio (PAR) of the video.
          • Range (string) -- The encoding range of the video.
          • ScanMode (string) -- The type of compression that was used to smooth the video’s appearance
          • Tcs (string) -- The transfer characteristic system (TCS) that is used in the video.
        • Lang (string) -- The audio language, in a format that is recognized by the receiver.
      • ClockRate (integer) -- The sample rate for the stream. This value is measured in Hz.
      • Description (string) -- A description that can help you quickly identify what your media stream is used for.
      • Fmt (integer) -- 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) -- A unique identifier for the media stream.
      • MediaStreamName (string) -- A name that helps you distinguish one media stream from another.
      • MediaStreamType (string) -- The type of media stream.
      • VideoFormat (string) -- The resolution of the video.

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

add_flow_outputs(**kwargs)

Adds outputs to an existing flow. You can create up to 50 outputs per flow.

See also: AWS API Documentation

Request Syntax

response = client.add_flow_outputs(
    FlowArn='string',
    Outputs=[
        {
            'CidrAllowList': [
                'string',
            ],
            'Description': 'string',
            'Destination': 'string',
            'Encryption': {
                'Algorithm': 'aes128'|'aes192'|'aes256',
                'ConstantInitializationVector': 'string',
                'DeviceId': 'string',
                'KeyType': 'speke'|'static-key'|'srt-password',
                'Region': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SecretArn': 'string',
                'Url': 'string'
            },
            'MaxLatency': 123,
            'MediaStreamOutputConfigurations': [
                {
                    'DestinationConfigurations': [
                        {
                            'DestinationIp': 'string',
                            'DestinationPort': 123,
                            'Interface': {
                                'Name': 'string'
                            }
                        },
                    ],
                    'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                    'EncodingParameters': {
                        'CompressionFactor': 123.0,
                        'EncoderProfile': 'main'|'high'
                    },
                    'MediaStreamName': 'string'
                },
            ],
            'MinLatency': 123,
            'Name': 'string',
            'Port': 123,
            'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
            'RemoteId': 'string',
            'SenderControlPort': 123,
            'SmoothingLatency': 123,
            'StreamId': 'string',
            'VpcInterfaceAttachment': {
                'VpcInterfaceName': 'string'
            }
        },
    ]
)

Parameters

• FlowArn (string) -- [REQUIRED] The flow that you want to add outputs to.
• Outputs (list) --

  [REQUIRED] A list of outputs that you want to add.

  • (dict) -- The output that you want to add to this flow.
    • CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
      • (string) --
    • Description (string) -- A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
    • Destination (string) -- The IP address from which video will be sent to output destinations.
    • Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
      • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
      • ConstantInitializationVector (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.
      • DeviceId (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.
      • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
      • Region (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.
      • ResourceId (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.
      • RoleArn (string) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
      • SecretArn (string) -- 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.
      • Url (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.
    • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
    • MediaStreamOutputConfigurations (list) -- The media streams that are associated with the output, and the parameters for those associations.
      • (dict) -- The media stream that you want to associate with the output, and the parameters for that association.
        • DestinationConfigurations (list) -- The transport parameters that you want to associate with the media stream.
          • (dict) -- The transport parameters that you want to associate with an outbound media stream.
            • DestinationIp (string) -- [REQUIRED] The IP address where you want MediaConnect to send contents of the media stream.
            • DestinationPort (integer) -- [REQUIRED] The port that you want MediaConnect to use when it distributes the media stream to the output.
            • Interface (dict) -- [REQUIRED] The VPC interface that you want to use for the media stream associated with the output.
              • Name (string) -- [REQUIRED] The name of the VPC interface.
        • EncodingName (string) -- [REQUIRED] 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, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
        • EncodingParameters (dict) -- 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.
          • CompressionFactor (float) -- [REQUIRED] 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.
          • EncoderProfile (string) -- [REQUIRED] 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, if at least one source on the flow uses the CDI protocol.
        • MediaStreamName (string) -- [REQUIRED] The name of the media stream that is associated with the output.
    • MinLatency (integer) -- 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.
    • Name (string) -- The name of the output. This value must be unique within the current flow.
    • Port (integer) -- The port to use when content is distributed to this output.
    • Protocol (string) -- [REQUIRED] The protocol to use for the output.
    • RemoteId (string) -- The remote ID for the Zixi-pull output stream.
    • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
    • SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
    • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
    • VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this output.
      • VpcInterfaceName (string) -- The name of the VPC interface to use for this output.

Return type

dict

Returns

Response Syntax

{
    'FlowArn': 'string',
    'Outputs': [
        {
            'DataTransferSubscriberFeePercent': 123,
            'Description': 'string',
            'Destination': 'string',
            'Encryption': {
                'Algorithm': 'aes128'|'aes192'|'aes256',
                'ConstantInitializationVector': 'string',
                'DeviceId': 'string',
                'KeyType': 'speke'|'static-key'|'srt-password',
                'Region': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SecretArn': 'string',
                'Url': 'string'
            },
            'EntitlementArn': 'string',
            'ListenerAddress': 'string',
            'MediaLiveInputArn': 'string',
            'MediaStreamOutputConfigurations': [
                {
                    'DestinationConfigurations': [
                        {
                            'DestinationIp': 'string',
                            'DestinationPort': 123,
                            'Interface': {
                                'Name': 'string'
                            },
                            'OutboundIp': 'string'
                        },
                    ],
                    'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                    'EncodingParameters': {
                        'CompressionFactor': 123.0,
                        'EncoderProfile': 'main'|'high'
                    },
                    'MediaStreamName': 'string'
                },
            ],
            'Name': 'string',
            'OutputArn': 'string',
            'Port': 123,
            'Transport': {
                'CidrAllowList': [
                    'string',
                ],
                'MaxBitrate': 123,
                'MaxLatency': 123,
                'MaxSyncBuffer': 123,
                'MinLatency': 123,
                'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
                'RemoteId': 'string',
                'SenderControlPort': 123,
                'SenderIpAddress': 'string',
                'SmoothingLatency': 123,
                'SourceListenerAddress': 'string',
                'SourceListenerPort': 123,
                'StreamId': 'string'
            },
            'VpcInterfaceAttachment': {
                'VpcInterfaceName': 'string'
            }
        },
    ]
}

Response Structure

• (dict) -- AWS Elemental MediaConnect added the outputs successfully.
  • FlowArn (string) -- The ARN of the flow that these outputs were added to.
  • Outputs (list) -- The details of the newly added outputs.
    • (dict) -- The settings for an output.
      • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
      • Description (string) -- A description of the output.
      • Destination (string) -- The address where you want to send the output.
      • Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
        • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
        • ConstantInitializationVector (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.
        • DeviceId (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.
        • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
        • Region (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.
        • ResourceId (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.
        • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
        • SecretArn (string) -- 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.
        • Url (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.
      • EntitlementArn (string) -- The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
      • ListenerAddress (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 the Zixi pull or SRT listener protocol.
      • MediaLiveInputArn (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.
      • MediaStreamOutputConfigurations (list) -- The configuration for each media stream that is associated with the output.
        • (dict) -- The media stream that is associated with the output, and the parameters for that association.
          • DestinationConfigurations (list) -- The transport parameters that are associated with each outbound media stream.
            • (dict) -- The transport parameters that are associated with an outbound media stream.
              • DestinationIp (string) -- The IP address where contents of the media stream will be sent.
              • DestinationPort (integer) -- The port to use when the content of the media stream is distributed to the output.
              • Interface (dict) -- The VPC interface that is used for the media stream associated with the output.
                • Name (string) -- The name of the VPC interface.
              • OutboundIp (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 protocol.
          • EncodingName (string) -- 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.
          • EncodingParameters (dict) -- Encoding parameters
            • CompressionFactor (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 floating point numbers in the range of 3.0 to 10.0, inclusive.
            • EncoderProfile (string) -- 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.
          • MediaStreamName (string) -- The name of the media stream.
      • Name (string) -- The name of the output. This value must be unique within the current flow.
      • OutputArn (string) -- The ARN of the output.
      • Port (integer) -- The port to use when content is distributed to this output.
      • Transport (dict) -- Attributes related to the transport stream that are used in the output.
        • CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
          • (string) --
        • MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
        • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
        • MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
        • MinLatency (integer) -- 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) -- The protocol that is used by the source or output.
        • RemoteId (string) -- The remote ID for the Zixi-pull stream.
        • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
        • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
        • SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
        • SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
        • SourceListenerPort (integer) -- Source port for SRT-caller protocol.
        • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
      • VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this output.
        • VpcInterfaceName (string) -- The name of the VPC interface to use for this output.

Exceptions

• MediaConnect.Client.exceptions.AddFlowOutputs420Exception
• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

add_flow_sources(**kwargs)

Adds Sources to flow

See also: AWS API Documentation

Request Syntax

response = client.add_flow_sources(
    FlowArn='string',
    Sources=[
        {
            'Decryption': {
                'Algorithm': 'aes128'|'aes192'|'aes256',
                'ConstantInitializationVector': 'string',
                'DeviceId': 'string',
                'KeyType': 'speke'|'static-key'|'srt-password',
                'Region': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SecretArn': 'string',
                'Url': 'string'
            },
            'Description': 'string',
            'EntitlementArn': 'string',
            'IngestPort': 123,
            'MaxBitrate': 123,
            'MaxLatency': 123,
            'MaxSyncBuffer': 123,
            'MediaStreamSourceConfigurations': [
                {
                    'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                    'InputConfigurations': [
                        {
                            'InputPort': 123,
                            'Interface': {
                                'Name': 'string'
                            }
                        },
                    ],
                    'MediaStreamName': 'string'
                },
            ],
            'MinLatency': 123,
            'Name': 'string',
            'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
            'SenderControlPort': 123,
            'SenderIpAddress': 'string',
            'SourceListenerAddress': 'string',
            'SourceListenerPort': 123,
            'StreamId': 'string',
            'VpcInterfaceName': 'string',
            'WhitelistCidr': 'string'
        },
    ]
)

Parameters

• FlowArn (string) -- [REQUIRED] The flow that you want to mutate.
• Sources (list) --

  [REQUIRED] A list of sources that you want to add.

  • (dict) -- The settings for the source of the flow.
    • Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
      • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
      • ConstantInitializationVector (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.
      • DeviceId (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.
      • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
      • Region (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.
      • ResourceId (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.
      • RoleArn (string) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
      • SecretArn (string) -- 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.
      • Url (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.
    • Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
    • EntitlementArn (string) -- The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
    • IngestPort (integer) -- The port that the flow will be listening on for incoming content.
    • MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
    • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
    • MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
    • MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
      • (dict) -- The definition of a media stream that you want to associate with the source.
        • EncodingName (string) -- [REQUIRED] The format you want to use 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 (list) -- The transport parameters that you want to associate with the media stream.
          • (dict) -- The transport parameters that you want to associate with an incoming media stream.
            • InputPort (integer) -- [REQUIRED] The port that you want the flow to listen on for an incoming media stream.
            • Interface (dict) -- [REQUIRED] The VPC interface that you want to use for the incoming media stream.
              • Name (string) -- [REQUIRED] The name of the VPC interface.
        • MediaStreamName (string) -- [REQUIRED] The name of the media stream.
    • MinLatency (integer) -- 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.
    • Name (string) -- The name of the source.
    • Protocol (string) -- The protocol that is used by the source.
    • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
    • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
    • SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
    • SourceListenerPort (integer) -- Source port for SRT-caller protocol.
    • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
    • VpcInterfaceName (string) -- The name of the VPC interface to use for this source.
    • WhitelistCidr (string) -- 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.

Return type

dict

Returns

Response Syntax

{
    'FlowArn': 'string',
    'Sources': [
        {
            'DataTransferSubscriberFeePercent': 123,
            'Decryption': {
                'Algorithm': 'aes128'|'aes192'|'aes256',
                'ConstantInitializationVector': 'string',
                'DeviceId': 'string',
                'KeyType': 'speke'|'static-key'|'srt-password',
                'Region': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SecretArn': 'string',
                'Url': 'string'
            },
            'Description': 'string',
            'EntitlementArn': 'string',
            'IngestIp': 'string',
            'IngestPort': 123,
            'MediaStreamSourceConfigurations': [
                {
                    'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                    'InputConfigurations': [
                        {
                            'InputIp': 'string',
                            'InputPort': 123,
                            'Interface': {
                                'Name': 'string'
                            }
                        },
                    ],
                    'MediaStreamName': 'string'
                },
            ],
            'Name': 'string',
            'SenderControlPort': 123,
            'SenderIpAddress': 'string',
            'SourceArn': 'string',
            'Transport': {
                'CidrAllowList': [
                    'string',
                ],
                'MaxBitrate': 123,
                'MaxLatency': 123,
                'MaxSyncBuffer': 123,
                'MinLatency': 123,
                'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
                'RemoteId': 'string',
                'SenderControlPort': 123,
                'SenderIpAddress': 'string',
                'SmoothingLatency': 123,
                'SourceListenerAddress': 'string',
                'SourceListenerPort': 123,
                'StreamId': 'string'
            },
            'VpcInterfaceName': 'string',
            'WhitelistCidr': 'string'
        },
    ]
}

Response Structure

• (dict) -- AWS Elemental MediaConnect added sources to the flow successfully.
  • FlowArn (string) -- The ARN of the flow that these sources were added to.
  • Sources (list) -- The details of the newly added sources.
    • (dict) -- The settings for the source of the flow.
      • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
      • Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
        • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
        • ConstantInitializationVector (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.
        • DeviceId (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.
        • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
        • Region (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.
        • ResourceId (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.
        • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
        • SecretArn (string) -- 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.
        • Url (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.
      • Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
      • EntitlementArn (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.
      • IngestIp (string) -- The IP address that the flow will be listening on for incoming content.
      • IngestPort (integer) -- The port that the flow will be listening on for incoming content.
      • MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
        • (dict) -- The media stream that is associated with the source, and the parameters for that association.
          • EncodingName (string) -- 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 (list) -- The transport parameters that are associated with an incoming media stream.
            • (dict) -- The transport parameters that are associated with an incoming media stream.
              • InputIp (string) -- The IP address that the flow listens on for incoming content for a media stream.
              • InputPort (integer) -- The port that the flow listens on for an incoming media stream.
              • Interface (dict) -- The VPC interface where the media stream comes in from.
                • Name (string) -- The name of the VPC interface.
          • MediaStreamName (string) -- The name of the media stream.
      • Name (string) -- The name of the source.
      • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
      • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
      • SourceArn (string) -- The ARN of the source.
      • Transport (dict) -- Attributes related to the transport stream that are used in the source.
        • CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
          • (string) --
        • MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
        • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
        • MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
        • MinLatency (integer) -- 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) -- The protocol that is used by the source or output.
        • RemoteId (string) -- The remote ID for the Zixi-pull stream.
        • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
        • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
        • SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
        • SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
        • SourceListenerPort (integer) -- Source port for SRT-caller protocol.
        • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
      • VpcInterfaceName (string) -- The name of the VPC interface that is used for this source.
      • WhitelistCidr (string) -- 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.

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

add_flow_vpc_interfaces(**kwargs)

Adds VPC interfaces to flow

See also: AWS API Documentation

Request Syntax

response = client.add_flow_vpc_interfaces(
    FlowArn='string',
    VpcInterfaces=[
        {
            'Name': 'string',
            'NetworkInterfaceType': 'ena'|'efa',
            'RoleArn': 'string',
            'SecurityGroupIds': [
                'string',
            ],
            'SubnetId': 'string'
        },
    ]
)

Parameters

• FlowArn (string) -- [REQUIRED] The flow that you want to mutate.
• VpcInterfaces (list) --

  [REQUIRED] A list of VPC interfaces that you want to add.

  • (dict) -- Desired VPC Interface for a Flow
    • Name (string) -- [REQUIRED] The name of the VPC Interface. This value must be unique within the current flow.
    • NetworkInterfaceType (string) -- The type of network interface. If this value is not included in the request, MediaConnect uses ENA as the networkInterfaceType.
    • RoleArn (string) -- [REQUIRED] Role Arn MediaConnect can assumes to create ENIs in customer's account
    • SecurityGroupIds (list) -- [REQUIRED] Security Group IDs to be used on ENI.
      • (string) --
    • SubnetId (string) -- [REQUIRED] Subnet must be in the AZ of the Flow

Return type

dict

Returns

Response Syntax

{
    'FlowArn': 'string',
    'VpcInterfaces': [
        {
            'Name': 'string',
            'NetworkInterfaceIds': [
                'string',
            ],
            'NetworkInterfaceType': 'ena'|'efa',
            'RoleArn': 'string',
            'SecurityGroupIds': [
                'string',
            ],
            'SubnetId': 'string'
        },
    ]
}

Response Structure

• (dict) -- The following VPC interface was added to the Flow configuration.
  • FlowArn (string) -- The ARN of the flow that these VPC interfaces were added to.
  • VpcInterfaces (list) -- The details of the newly added VPC interfaces.
    • (dict) -- The settings for a VPC Source.
      • Name (string) -- Immutable and has to be a unique against other VpcInterfaces in this Flow.
      • NetworkInterfaceIds (list) -- IDs of the network interfaces created in customer's account by MediaConnect.
        • (string) --
      • NetworkInterfaceType (string) -- The type of network interface.
      • RoleArn (string) -- Role Arn MediaConnect can assumes to create ENIs in customer's account
      • SecurityGroupIds (list) -- Security Group IDs to be used on ENI.
        • (string) --
      • SubnetId (string) -- Subnet must be in the AZ of the Flow

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters

operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").

Returns

True if the operation can be paginated, False otherwise.

close()

Closes underlying endpoint connections.

create_flow(**kwargs)

Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).

See also: AWS API Documentation

Request Syntax

response = client.create_flow(
    AvailabilityZone='string',
    Entitlements=[
        {
            'DataTransferSubscriberFeePercent': 123,
            'Description': 'string',
            'Encryption': {
                'Algorithm': 'aes128'|'aes192'|'aes256',
                'ConstantInitializationVector': 'string',
                'DeviceId': 'string',
                'KeyType': 'speke'|'static-key'|'srt-password',
                'Region': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SecretArn': 'string',
                'Url': 'string'
            },
            'EntitlementStatus': 'ENABLED'|'DISABLED',
            'Name': 'string',
            'Subscribers': [
                'string',
            ]
        },
    ],
    MediaStreams=[
        {
            'Attributes': {
                'Fmtp': {
                    'ChannelOrder': 'string',
                    'Colorimetry': 'BT601'|'BT709'|'BT2020'|'BT2100'|'ST2065-1'|'ST2065-3'|'XYZ',
                    'ExactFramerate': 'string',
                    'Par': 'string',
                    'Range': 'NARROW'|'FULL'|'FULLPROTECT',
                    'ScanMode': 'progressive'|'interlace'|'progressive-segmented-frame',
                    'Tcs': 'SDR'|'PQ'|'HLG'|'LINEAR'|'BT2100LINPQ'|'BT2100LINHLG'|'ST2065-1'|'ST428-1'|'DENSITY'
                },
                'Lang': 'string'
            },
            'ClockRate': 123,
            'Description': 'string',
            'MediaStreamId': 123,
            'MediaStreamName': 'string',
            'MediaStreamType': 'video'|'audio'|'ancillary-data',
            'VideoFormat': 'string'
        },
    ],
    Name='string',
    Outputs=[
        {
            'CidrAllowList': [
                'string',
            ],
            'Description': 'string',
            'Destination': 'string',
            'Encryption': {
                'Algorithm': 'aes128'|'aes192'|'aes256',
                'ConstantInitializationVector': 'string',
                'DeviceId': 'string',
                'KeyType': 'speke'|'static-key'|'srt-password',
                'Region': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SecretArn': 'string',
                'Url': 'string'
            },
            'MaxLatency': 123,
            'MediaStreamOutputConfigurations': [
                {
                    'DestinationConfigurations': [
                        {
                            'DestinationIp': 'string',
                            'DestinationPort': 123,
                            'Interface': {
                                'Name': 'string'
                            }
                        },
                    ],
                    'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                    'EncodingParameters': {
                        'CompressionFactor': 123.0,
                        'EncoderProfile': 'main'|'high'
                    },
                    'MediaStreamName': 'string'
                },
            ],
            'MinLatency': 123,
            'Name': 'string',
            'Port': 123,
            'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
            'RemoteId': 'string',
            'SenderControlPort': 123,
            'SmoothingLatency': 123,
            'StreamId': 'string',
            'VpcInterfaceAttachment': {
                'VpcInterfaceName': 'string'
            }
        },
    ],
    Source={
        'Decryption': {
            'Algorithm': 'aes128'|'aes192'|'aes256',
            'ConstantInitializationVector': 'string',
            'DeviceId': 'string',
            'KeyType': 'speke'|'static-key'|'srt-password',
            'Region': 'string',
            'ResourceId': 'string',
            'RoleArn': 'string',
            'SecretArn': 'string',
            'Url': 'string'
        },
        'Description': 'string',
        'EntitlementArn': 'string',
        'IngestPort': 123,
        'MaxBitrate': 123,
        'MaxLatency': 123,
        'MaxSyncBuffer': 123,
        'MediaStreamSourceConfigurations': [
            {
                'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                'InputConfigurations': [
                    {
                        'InputPort': 123,
                        'Interface': {
                            'Name': 'string'
                        }
                    },
                ],
                'MediaStreamName': 'string'
            },
        ],
        'MinLatency': 123,
        'Name': 'string',
        'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
        'SenderControlPort': 123,
        'SenderIpAddress': 'string',
        'SourceListenerAddress': 'string',
        'SourceListenerPort': 123,
        'StreamId': 'string',
        'VpcInterfaceName': 'string',
        'WhitelistCidr': 'string'
    },
    SourceFailoverConfig={
        'FailoverMode': 'MERGE'|'FAILOVER',
        'RecoveryWindow': 123,
        'SourcePriority': {
            'PrimarySource': 'string'
        },
        'State': 'ENABLED'|'DISABLED'
    },
    Sources=[
        {
            'Decryption': {
                'Algorithm': 'aes128'|'aes192'|'aes256',
                'ConstantInitializationVector': 'string',
                'DeviceId': 'string',
                'KeyType': 'speke'|'static-key'|'srt-password',
                'Region': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SecretArn': 'string',
                'Url': 'string'
            },
            'Description': 'string',
            'EntitlementArn': 'string',
            'IngestPort': 123,
            'MaxBitrate': 123,
            'MaxLatency': 123,
            'MaxSyncBuffer': 123,
            'MediaStreamSourceConfigurations': [
                {
                    'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                    'InputConfigurations': [
                        {
                            'InputPort': 123,
                            'Interface': {
                                'Name': 'string'
                            }
                        },
                    ],
                    'MediaStreamName': 'string'
                },
            ],
            'MinLatency': 123,
            'Name': 'string',
            'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
            'SenderControlPort': 123,
            'SenderIpAddress': 'string',
            'SourceListenerAddress': 'string',
            'SourceListenerPort': 123,
            'StreamId': 'string',
            'VpcInterfaceName': 'string',
            'WhitelistCidr': 'string'
        },
    ],
    VpcInterfaces=[
        {
            'Name': 'string',
            'NetworkInterfaceType': 'ena'|'efa',
            'RoleArn': 'string',
            'SecurityGroupIds': [
                'string',
            ],
            'SubnetId': 'string'
        },
    ],
    Maintenance={
        'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
        'MaintenanceStartHour': 'string'
    }
)

Parameters

• AvailabilityZone (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.
• Entitlements (list) --

  The entitlements that you want to grant on a flow.

  • (dict) -- The entitlements that you want to grant on a flow.
    • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
    • Description (string) -- A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
    • Encryption (dict) -- The type of encryption that will be used on the output that is associated with this entitlement.
      • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
      • ConstantInitializationVector (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.
      • DeviceId (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.
      • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
      • Region (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.
      • ResourceId (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.
      • RoleArn (string) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
      • SecretArn (string) -- 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.
      • Url (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.
    • EntitlementStatus (string) -- An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.
    • Name (string) -- The name of the entitlement. This value must be unique within the current flow.
    • Subscribers (list) -- [REQUIRED] The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source.
      • (string) --
• MediaStreams (list) --

  The media streams that you want to add to the flow. You can associate these media streams with sources and outputs on the flow.

  • (dict) -- The media stream that you want to add to the flow.
    • Attributes (dict) -- The attributes that you want to assign to the new media stream.
      • Fmtp (dict) -- The settings that you want to use to define the media stream.
        • ChannelOrder (string) -- The format of the audio channel.
        • Colorimetry (string) -- The format that is used for the representation of color.
        • ExactFramerate (string) -- 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.
        • Par (string) -- The pixel aspect ratio (PAR) of the video.
        • Range (string) -- The encoding range of the video.
        • ScanMode (string) -- The type of compression that was used to smooth the video’s appearance.
        • Tcs (string) -- The transfer characteristic system (TCS) that is used in the video.
      • Lang (string) -- The audio language, in a format that is recognized by the receiver.
    • ClockRate (integer) -- The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.
    • Description (string) -- A description that can help you quickly identify what your media stream is used for.
    • MediaStreamId (integer) -- [REQUIRED] A unique identifier for the media stream.
    • MediaStreamName (string) -- [REQUIRED] A name that helps you distinguish one media stream from another.
    • MediaStreamType (string) -- [REQUIRED] The type of media stream.
    • VideoFormat (string) -- The resolution of the video.
• Name (string) -- [REQUIRED] The name of the flow.
• Outputs (list) --

  The outputs that you want to add to this flow.

  • (dict) -- The output that you want to add to this flow.
    • CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
      • (string) --
    • Description (string) -- A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
    • Destination (string) -- The IP address from which video will be sent to output destinations.
    • Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
      • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
      • ConstantInitializationVector (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.
      • DeviceId (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.
      • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
      • Region (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.
      • ResourceId (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.
      • RoleArn (string) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
      • SecretArn (string) -- 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.
      • Url (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.
    • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
    • MediaStreamOutputConfigurations (list) -- The media streams that are associated with the output, and the parameters for those associations.
      • (dict) -- The media stream that you want to associate with the output, and the parameters for that association.
        • DestinationConfigurations (list) -- The transport parameters that you want to associate with the media stream.
          • (dict) -- The transport parameters that you want to associate with an outbound media stream.
            • DestinationIp (string) -- [REQUIRED] The IP address where you want MediaConnect to send contents of the media stream.
            • DestinationPort (integer) -- [REQUIRED] The port that you want MediaConnect to use when it distributes the media stream to the output.
            • Interface (dict) -- [REQUIRED] The VPC interface that you want to use for the media stream associated with the output.
              • Name (string) -- [REQUIRED] The name of the VPC interface.
        • EncodingName (string) -- [REQUIRED] 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, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
        • EncodingParameters (dict) -- 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.
          • CompressionFactor (float) -- [REQUIRED] 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.
          • EncoderProfile (string) -- [REQUIRED] 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, if at least one source on the flow uses the CDI protocol.
        • MediaStreamName (string) -- [REQUIRED] The name of the media stream that is associated with the output.
    • MinLatency (integer) -- 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.
    • Name (string) -- The name of the output. This value must be unique within the current flow.
    • Port (integer) -- The port to use when content is distributed to this output.
    • Protocol (string) -- [REQUIRED] The protocol to use for the output.
    • RemoteId (string) -- The remote ID for the Zixi-pull output stream.
    • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
    • SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
    • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
    • VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this output.
      • VpcInterfaceName (string) -- The name of the VPC interface to use for this output.
• Source (dict) --

  The settings for the source of the flow.

  • Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
    • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
    • ConstantInitializationVector (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.
    • DeviceId (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.
    • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
    • Region (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.
    • ResourceId (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.
    • RoleArn (string) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
    • SecretArn (string) -- 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.
    • Url (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.
  • Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
  • EntitlementArn (string) -- The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
  • IngestPort (integer) -- The port that the flow will be listening on for incoming content.
  • MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
  • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
  • MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
  • MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
    • (dict) -- The definition of a media stream that you want to associate with the source.
      • EncodingName (string) -- [REQUIRED] The format you want to use 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 (list) -- The transport parameters that you want to associate with the media stream.
        • (dict) -- The transport parameters that you want to associate with an incoming media stream.
          • InputPort (integer) -- [REQUIRED] The port that you want the flow to listen on for an incoming media stream.
          • Interface (dict) -- [REQUIRED] The VPC interface that you want to use for the incoming media stream.
            • Name (string) -- [REQUIRED] The name of the VPC interface.
      • MediaStreamName (string) -- [REQUIRED] The name of the media stream.
  • MinLatency (integer) -- 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.
  • Name (string) -- The name of the source.
  • Protocol (string) -- The protocol that is used by the source.
  • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
  • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
  • SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
  • SourceListenerPort (integer) -- Source port for SRT-caller protocol.
  • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
  • VpcInterfaceName (string) -- The name of the VPC interface to use for this source.
  • WhitelistCidr (string) -- 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.
• SourceFailoverConfig (dict) --

  The settings for source failover.

  • FailoverMode (string) -- 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) -- Search window time to look for dash-7 packets
  • SourcePriority (dict) -- The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
    • PrimarySource (string) -- The name of the source you choose as the primary source for this flow.
  • State (string) --
• Sources (list) --
  • (dict) -- The settings for the source of the flow.
    • Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
      • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
      • ConstantInitializationVector (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.
      • DeviceId (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.
      • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
      • Region (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.
      • ResourceId (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.
      • RoleArn (string) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
      • SecretArn (string) -- 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.
      • Url (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.
    • Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
    • EntitlementArn (string) -- The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
    • IngestPort (integer) -- The port that the flow will be listening on for incoming content.
    • MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
    • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
    • MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
    • MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
      • (dict) -- The definition of a media stream that you want to associate with the source.
        • EncodingName (string) -- [REQUIRED] The format you want to use 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 (list) -- The transport parameters that you want to associate with the media stream.
          • (dict) -- The transport parameters that you want to associate with an incoming media stream.
            • InputPort (integer) -- [REQUIRED] The port that you want the flow to listen on for an incoming media stream.
            • Interface (dict) -- [REQUIRED] The VPC interface that you want to use for the incoming media stream.
              • Name (string) -- [REQUIRED] The name of the VPC interface.
        • MediaStreamName (string) -- [REQUIRED] The name of the media stream.
    • MinLatency (integer) -- 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.
    • Name (string) -- The name of the source.
    • Protocol (string) -- The protocol that is used by the source.
    • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
    • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
    • SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
    • SourceListenerPort (integer) -- Source port for SRT-caller protocol.
    • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
    • VpcInterfaceName (string) -- The name of the VPC interface to use for this source.
    • WhitelistCidr (string) -- 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.
• VpcInterfaces (list) --

  The VPC interfaces you want on the flow.

  • (dict) -- Desired VPC Interface for a Flow
    • Name (string) -- [REQUIRED] The name of the VPC Interface. This value must be unique within the current flow.
    • NetworkInterfaceType (string) -- The type of network interface. If this value is not included in the request, MediaConnect uses ENA as the networkInterfaceType.
    • RoleArn (string) -- [REQUIRED] Role Arn MediaConnect can assumes to create ENIs in customer's account
    • SecurityGroupIds (list) -- [REQUIRED] Security Group IDs to be used on ENI.
      • (string) --
    • SubnetId (string) -- [REQUIRED] Subnet must be in the AZ of the Flow
• Maintenance (dict) --

  Create maintenance setting for a flow

  • MaintenanceDay (string) -- [REQUIRED] A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
  • MaintenanceStartHour (string) -- [REQUIRED] 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.

Return type

dict

Returns

Response Syntax

{
    'Flow': {
        'AvailabilityZone': 'string',
        'Description': 'string',
        'EgressIp': 'string',
        'Entitlements': [
            {
                'DataTransferSubscriberFeePercent': 123,
                'Description': 'string',
                'Encryption': {
                    'Algorithm': 'aes128'|'aes192'|'aes256',
                    'ConstantInitializationVector': 'string',
                    'DeviceId': 'string',
                    'KeyType': 'speke'|'static-key'|'srt-password',
                    'Region': 'string',
                    'ResourceId': 'string',
                    'RoleArn': 'string',
                    'SecretArn': 'string',
                    'Url': 'string'
                },
                'EntitlementArn': 'string',
                'EntitlementStatus': 'ENABLED'|'DISABLED',
                'Name': 'string',
                'Subscribers': [
                    'string',
                ]
            },
        ],
        'FlowArn': 'string',
        'MediaStreams': [
            {
                'Attributes': {
                    'Fmtp': {
                        'ChannelOrder': 'string',
                        'Colorimetry': 'BT601'|'BT709'|'BT2020'|'BT2100'|'ST2065-1'|'ST2065-3'|'XYZ',
                        'ExactFramerate': 'string',
                        'Par': 'string',
                        'Range': 'NARROW'|'FULL'|'FULLPROTECT',
                        'ScanMode': 'progressive'|'interlace'|'progressive-segmented-frame',
                        'Tcs': 'SDR'|'PQ'|'HLG'|'LINEAR'|'BT2100LINPQ'|'BT2100LINHLG'|'ST2065-1'|'ST428-1'|'DENSITY'
                    },
                    'Lang': 'string'
                },
                'ClockRate': 123,
                'Description': 'string',
                'Fmt': 123,
                'MediaStreamId': 123,
                'MediaStreamName': 'string',
                'MediaStreamType': 'video'|'audio'|'ancillary-data',
                'VideoFormat': 'string'
            },
        ],
        'Name': 'string',
        'Outputs': [
            {
                'DataTransferSubscriberFeePercent': 123,
                'Description': 'string',
                'Destination': 'string',
                'Encryption': {
                    'Algorithm': 'aes128'|'aes192'|'aes256',
                    'ConstantInitializationVector': 'string',
                    'DeviceId': 'string',
                    'KeyType': 'speke'|'static-key'|'srt-password',
                    'Region': 'string',
                    'ResourceId': 'string',
                    'RoleArn': 'string',
                    'SecretArn': 'string',
                    'Url': 'string'
                },
                'EntitlementArn': 'string',
                'ListenerAddress': 'string',
                'MediaLiveInputArn': 'string',
                'MediaStreamOutputConfigurations': [
                    {
                        'DestinationConfigurations': [
                            {
                                'DestinationIp': 'string',
                                'DestinationPort': 123,
                                'Interface': {
                                    'Name': 'string'
                                },
                                'OutboundIp': 'string'
                            },
                        ],
                        'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                        'EncodingParameters': {
                            'CompressionFactor': 123.0,
                            'EncoderProfile': 'main'|'high'
                        },
                        'MediaStreamName': 'string'
                    },
                ],
                'Name': 'string',
                'OutputArn': 'string',
                'Port': 123,
                'Transport': {
                    'CidrAllowList': [
                        'string',
                    ],
                    'MaxBitrate': 123,
                    'MaxLatency': 123,
                    'MaxSyncBuffer': 123,
                    'MinLatency': 123,
                    'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
                    'RemoteId': 'string',
                    'SenderControlPort': 123,
                    'SenderIpAddress': 'string',
                    'SmoothingLatency': 123,
                    'SourceListenerAddress': 'string',
                    'SourceListenerPort': 123,
                    'StreamId': 'string'
                },
                'VpcInterfaceAttachment': {
                    'VpcInterfaceName': 'string'
                }
            },
        ],
        'Source': {
            'DataTransferSubscriberFeePercent': 123,
            'Decryption': {
                'Algorithm': 'aes128'|'aes192'|'aes256',
                'ConstantInitializationVector': 'string',
                'DeviceId': 'string',
                'KeyType': 'speke'|'static-key'|'srt-password',
                'Region': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SecretArn': 'string',
                'Url': 'string'
            },
            'Description': 'string',
            'EntitlementArn': 'string',
            'IngestIp': 'string',
            'IngestPort': 123,
            'MediaStreamSourceConfigurations': [
                {
                    'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                    'InputConfigurations': [
                        {
                            'InputIp': 'string',
                            'InputPort': 123,
                            'Interface': {
                                'Name': 'string'
                            }
                        },
                    ],
                    'MediaStreamName': 'string'
                },
            ],
            'Name': 'string',
            'SenderControlPort': 123,
            'SenderIpAddress': 'string',
            'SourceArn': 'string',
            'Transport': {
                'CidrAllowList': [
                    'string',
                ],
                'MaxBitrate': 123,
                'MaxLatency': 123,
                'MaxSyncBuffer': 123,
                'MinLatency': 123,
                'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
                'RemoteId': 'string',
                'SenderControlPort': 123,
                'SenderIpAddress': 'string',
                'SmoothingLatency': 123,
                'SourceListenerAddress': 'string',
                'SourceListenerPort': 123,
                'StreamId': 'string'
            },
            'VpcInterfaceName': 'string',
            'WhitelistCidr': 'string'
        },
        'SourceFailoverConfig': {
            'FailoverMode': 'MERGE'|'FAILOVER',
            'RecoveryWindow': 123,
            'SourcePriority': {
                'PrimarySource': 'string'
            },
            'State': 'ENABLED'|'DISABLED'
        },
        'Sources': [
            {
                'DataTransferSubscriberFeePercent': 123,
                'Decryption': {
                    'Algorithm': 'aes128'|'aes192'|'aes256',
                    'ConstantInitializationVector': 'string',
                    'DeviceId': 'string',
                    'KeyType': 'speke'|'static-key'|'srt-password',
                    'Region': 'string',
                    'ResourceId': 'string',
                    'RoleArn': 'string',
                    'SecretArn': 'string',
                    'Url': 'string'
                },
                'Description': 'string',
                'EntitlementArn': 'string',
                'IngestIp': 'string',
                'IngestPort': 123,
                'MediaStreamSourceConfigurations': [
                    {
                        'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                        'InputConfigurations': [
                            {
                                'InputIp': 'string',
                                'InputPort': 123,
                                'Interface': {
                                    'Name': 'string'
                                }
                            },
                        ],
                        'MediaStreamName': 'string'
                    },
                ],
                'Name': 'string',
                'SenderControlPort': 123,
                'SenderIpAddress': 'string',
                'SourceArn': 'string',
                'Transport': {
                    'CidrAllowList': [
                        'string',
                    ],
                    'MaxBitrate': 123,
                    'MaxLatency': 123,
                    'MaxSyncBuffer': 123,
                    'MinLatency': 123,
                    'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
                    'RemoteId': 'string',
                    'SenderControlPort': 123,
                    'SenderIpAddress': 'string',
                    'SmoothingLatency': 123,
                    'SourceListenerAddress': 'string',
                    'SourceListenerPort': 123,
                    'StreamId': 'string'
                },
                'VpcInterfaceName': 'string',
                'WhitelistCidr': 'string'
            },
        ],
        'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
        'VpcInterfaces': [
            {
                'Name': 'string',
                'NetworkInterfaceIds': [
                    'string',
                ],
                'NetworkInterfaceType': 'ena'|'efa',
                'RoleArn': 'string',
                'SecurityGroupIds': [
                    'string',
                ],
                'SubnetId': 'string'
            },
        ],
        'Maintenance': {
            'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
            'MaintenanceDeadline': 'string',
            'MaintenanceScheduledDate': 'string',
            'MaintenanceStartHour': 'string'
        }
    }
}

Response Structure

• (dict) -- AWS Elemental MediaConnect created the new flow successfully.
  • Flow (dict) -- The settings for a flow, including its source, outputs, and entitlements.
    • AvailabilityZone (string) -- The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
    • Description (string) -- A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
    • EgressIp (string) -- The IP address from which video will be sent to output destinations.
    • Entitlements (list) -- The entitlements in this flow.
      • (dict) -- The settings for a flow entitlement.
        • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
        • Description (string) -- A description of the entitlement.
        • Encryption (dict) -- The type of encryption that will be used on the output that is associated with this entitlement.
          • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
          • ConstantInitializationVector (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.
          • DeviceId (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.
          • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
          • Region (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.
          • ResourceId (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.
          • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
          • SecretArn (string) -- 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.
          • Url (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.
        • EntitlementArn (string) -- The ARN of the entitlement.
        • EntitlementStatus (string) -- An indication of whether the entitlement is enabled.
        • Name (string) -- The name of the entitlement.
        • Subscribers (list) -- 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) --
    • FlowArn (string) -- The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
    • MediaStreams (list) -- The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
      • (dict) -- 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.
        • Attributes (dict) -- Attributes that are related to the media stream.
          • Fmtp (dict) -- A set of parameters that define the media stream.
            • ChannelOrder (string) -- The format of the audio channel.
            • Colorimetry (string) -- The format that is used for the representation of color.
            • ExactFramerate (string) -- 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.
            • Par (string) -- The pixel aspect ratio (PAR) of the video.
            • Range (string) -- The encoding range of the video.
            • ScanMode (string) -- The type of compression that was used to smooth the video’s appearance
            • Tcs (string) -- The transfer characteristic system (TCS) that is used in the video.
          • Lang (string) -- The audio language, in a format that is recognized by the receiver.
        • ClockRate (integer) -- The sample rate for the stream. This value is measured in Hz.
        • Description (string) -- A description that can help you quickly identify what your media stream is used for.
        • Fmt (integer) -- 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) -- A unique identifier for the media stream.
        • MediaStreamName (string) -- A name that helps you distinguish one media stream from another.
        • MediaStreamType (string) -- The type of media stream.
        • VideoFormat (string) -- The resolution of the video.
    • Name (string) -- The name of the flow.
    • Outputs (list) -- The outputs in this flow.
      • (dict) -- The settings for an output.
        • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
        • Description (string) -- A description of the output.
        • Destination (string) -- The address where you want to send the output.
        • Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
          • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
          • ConstantInitializationVector (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.
          • DeviceId (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.
          • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
          • Region (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.
          • ResourceId (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.
          • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
          • SecretArn (string) -- 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.
          • Url (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.
        • EntitlementArn (string) -- The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
        • ListenerAddress (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 the Zixi pull or SRT listener protocol.
        • MediaLiveInputArn (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.
        • MediaStreamOutputConfigurations (list) -- The configuration for each media stream that is associated with the output.
          • (dict) -- The media stream that is associated with the output, and the parameters for that association.
            • DestinationConfigurations (list) -- The transport parameters that are associated with each outbound media stream.
              • (dict) -- The transport parameters that are associated with an outbound media stream.
                • DestinationIp (string) -- The IP address where contents of the media stream will be sent.
                • DestinationPort (integer) -- The port to use when the content of the media stream is distributed to the output.
                • Interface (dict) -- The VPC interface that is used for the media stream associated with the output.
                  • Name (string) -- The name of the VPC interface.
                • OutboundIp (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 protocol.
            • EncodingName (string) -- 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.
            • EncodingParameters (dict) -- Encoding parameters
              • CompressionFactor (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 floating point numbers in the range of 3.0 to 10.0, inclusive.
              • EncoderProfile (string) -- 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.
            • MediaStreamName (string) -- The name of the media stream.
        • Name (string) -- The name of the output. This value must be unique within the current flow.
        • OutputArn (string) -- The ARN of the output.
        • Port (integer) -- The port to use when content is distributed to this output.
        • Transport (dict) -- Attributes related to the transport stream that are used in the output.
          • CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • (string) --
          • MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
          • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
          • MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
          • MinLatency (integer) -- 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) -- The protocol that is used by the source or output.
          • RemoteId (string) -- The remote ID for the Zixi-pull stream.
          • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
          • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
          • SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
          • SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
          • SourceListenerPort (integer) -- Source port for SRT-caller protocol.
          • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
        • VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this output.
          • VpcInterfaceName (string) -- The name of the VPC interface to use for this output.
    • Source (dict) -- The settings for the source of the flow.
      • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
      • Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
        • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
        • ConstantInitializationVector (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.
        • DeviceId (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.
        • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
        • Region (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.
        • ResourceId (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.
        • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
        • SecretArn (string) -- 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.
        • Url (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.
      • Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
      • EntitlementArn (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.
      • IngestIp (string) -- The IP address that the flow will be listening on for incoming content.
      • IngestPort (integer) -- The port that the flow will be listening on for incoming content.
      • MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
        • (dict) -- The media stream that is associated with the source, and the parameters for that association.
          • EncodingName (string) -- 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 (list) -- The transport parameters that are associated with an incoming media stream.
            • (dict) -- The transport parameters that are associated with an incoming media stream.
              • InputIp (string) -- The IP address that the flow listens on for incoming content for a media stream.
              • InputPort (integer) -- The port that the flow listens on for an incoming media stream.
              • Interface (dict) -- The VPC interface where the media stream comes in from.
                • Name (string) -- The name of the VPC interface.
          • MediaStreamName (string) -- The name of the media stream.
      • Name (string) -- The name of the source.
      • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
      • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
      • SourceArn (string) -- The ARN of the source.
      • Transport (dict) -- Attributes related to the transport stream that are used in the source.
        • CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
          • (string) --
        • MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
        • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
        • MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
        • MinLatency (integer) -- 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) -- The protocol that is used by the source or output.
        • RemoteId (string) -- The remote ID for the Zixi-pull stream.
        • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
        • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
        • SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
        • SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
        • SourceListenerPort (integer) -- Source port for SRT-caller protocol.
        • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
      • VpcInterfaceName (string) -- The name of the VPC interface that is used for this source.
      • WhitelistCidr (string) -- 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.
    • SourceFailoverConfig (dict) -- The settings for source failover.
      • FailoverMode (string) -- 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) -- Search window time to look for dash-7 packets
      • SourcePriority (dict) -- The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
        • PrimarySource (string) -- The name of the source you choose as the primary source for this flow.
      • State (string) --
    • Sources (list) --
      • (dict) -- The settings for the source of the flow.
        • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
        • Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
          • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
          • ConstantInitializationVector (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.
          • DeviceId (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.
          • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
          • Region (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.
          • ResourceId (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.
          • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
          • SecretArn (string) -- 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.
          • Url (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.
        • Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
        • EntitlementArn (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.
        • IngestIp (string) -- The IP address that the flow will be listening on for incoming content.
        • IngestPort (integer) -- The port that the flow will be listening on for incoming content.
        • MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
          • (dict) -- The media stream that is associated with the source, and the parameters for that association.
            • EncodingName (string) -- 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 (list) -- The transport parameters that are associated with an incoming media stream.
              • (dict) -- The transport parameters that are associated with an incoming media stream.
                • InputIp (string) -- The IP address that the flow listens on for incoming content for a media stream.
                • InputPort (integer) -- The port that the flow listens on for an incoming media stream.
                • Interface (dict) -- The VPC interface where the media stream comes in from.
                  • Name (string) -- The name of the VPC interface.
            • MediaStreamName (string) -- The name of the media stream.
        • Name (string) -- The name of the source.
        • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
        • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
        • SourceArn (string) -- The ARN of the source.
        • Transport (dict) -- Attributes related to the transport stream that are used in the source.
          • CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • (string) --
          • MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
          • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
          • MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
          • MinLatency (integer) -- 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) -- The protocol that is used by the source or output.
          • RemoteId (string) -- The remote ID for the Zixi-pull stream.
          • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
          • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
          • SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
          • SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
          • SourceListenerPort (integer) -- Source port for SRT-caller protocol.
          • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
        • VpcInterfaceName (string) -- The name of the VPC interface that is used for this source.
        • WhitelistCidr (string) -- 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.
    • Status (string) -- The current status of the flow.
    • VpcInterfaces (list) -- The VPC Interfaces for this flow.
      • (dict) -- The settings for a VPC Source.
        • Name (string) -- Immutable and has to be a unique against other VpcInterfaces in this Flow.
        • NetworkInterfaceIds (list) -- IDs of the network interfaces created in customer's account by MediaConnect.
          • (string) --
        • NetworkInterfaceType (string) -- The type of network interface.
        • RoleArn (string) -- Role Arn MediaConnect can assumes to create ENIs in customer's account
        • SecurityGroupIds (list) -- Security Group IDs to be used on ENI.
          • (string) --
        • SubnetId (string) -- Subnet must be in the AZ of the Flow
    • Maintenance (dict) -- The maintenance setting of a flow
      • MaintenanceDay (string) -- A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
      • MaintenanceDeadline (string) -- The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.
      • MaintenanceScheduledDate (string) -- A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
      • MaintenanceStartHour (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.

Exceptions

• MediaConnect.Client.exceptions.CreateFlow420Exception
• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

delete_flow(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_flow(
    FlowArn='string'
)

Parameters

FlowArn (string) -- [REQUIRED] The ARN of the flow that you want to delete.

Return type

dict

Returns

Response Syntax

{
    'FlowArn': 'string',
    'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR'
}

Response Structure

• (dict) -- AWS Elemental MediaConnect is deleting the flow.
  • FlowArn (string) -- The ARN of the flow that was deleted.
  • Status (string) -- The status of the flow when the DeleteFlow process begins.

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

describe_flow(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_flow(
    FlowArn='string'
)

Parameters

FlowArn (string) -- [REQUIRED] The ARN of the flow that you want to describe.

Return type

dict

Returns

Response Syntax

{
    'Flow': {
        'AvailabilityZone': 'string',
        'Description': 'string',
        'EgressIp': 'string',
        'Entitlements': [
            {
                'DataTransferSubscriberFeePercent': 123,
                'Description': 'string',
                'Encryption': {
                    'Algorithm': 'aes128'|'aes192'|'aes256',
                    'ConstantInitializationVector': 'string',
                    'DeviceId': 'string',
                    'KeyType': 'speke'|'static-key'|'srt-password',
                    'Region': 'string',
                    'ResourceId': 'string',
                    'RoleArn': 'string',
                    'SecretArn': 'string',
                    'Url': 'string'
                },
                'EntitlementArn': 'string',
                'EntitlementStatus': 'ENABLED'|'DISABLED',
                'Name': 'string',
                'Subscribers': [
                    'string',
                ]
            },
        ],
        'FlowArn': 'string',
        'MediaStreams': [
            {
                'Attributes': {
                    'Fmtp': {
                        'ChannelOrder': 'string',
                        'Colorimetry': 'BT601'|'BT709'|'BT2020'|'BT2100'|'ST2065-1'|'ST2065-3'|'XYZ',
                        'ExactFramerate': 'string',
                        'Par': 'string',
                        'Range': 'NARROW'|'FULL'|'FULLPROTECT',
                        'ScanMode': 'progressive'|'interlace'|'progressive-segmented-frame',
                        'Tcs': 'SDR'|'PQ'|'HLG'|'LINEAR'|'BT2100LINPQ'|'BT2100LINHLG'|'ST2065-1'|'ST428-1'|'DENSITY'
                    },
                    'Lang': 'string'
                },
                'ClockRate': 123,
                'Description': 'string',
                'Fmt': 123,
                'MediaStreamId': 123,
                'MediaStreamName': 'string',
                'MediaStreamType': 'video'|'audio'|'ancillary-data',
                'VideoFormat': 'string'
            },
        ],
        'Name': 'string',
        'Outputs': [
            {
                'DataTransferSubscriberFeePercent': 123,
                'Description': 'string',
                'Destination': 'string',
                'Encryption': {
                    'Algorithm': 'aes128'|'aes192'|'aes256',
                    'ConstantInitializationVector': 'string',
                    'DeviceId': 'string',
                    'KeyType': 'speke'|'static-key'|'srt-password',
                    'Region': 'string',
                    'ResourceId': 'string',
                    'RoleArn': 'string',
                    'SecretArn': 'string',
                    'Url': 'string'
                },
                'EntitlementArn': 'string',
                'ListenerAddress': 'string',
                'MediaLiveInputArn': 'string',
                'MediaStreamOutputConfigurations': [
                    {
                        'DestinationConfigurations': [
                            {
                                'DestinationIp': 'string',
                                'DestinationPort': 123,
                                'Interface': {
                                    'Name': 'string'
                                },
                                'OutboundIp': 'string'
                            },
                        ],
                        'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                        'EncodingParameters': {
                            'CompressionFactor': 123.0,
                            'EncoderProfile': 'main'|'high'
                        },
                        'MediaStreamName': 'string'
                    },
                ],
                'Name': 'string',
                'OutputArn': 'string',
                'Port': 123,
                'Transport': {
                    'CidrAllowList': [
                        'string',
                    ],
                    'MaxBitrate': 123,
                    'MaxLatency': 123,
                    'MaxSyncBuffer': 123,
                    'MinLatency': 123,
                    'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
                    'RemoteId': 'string',
                    'SenderControlPort': 123,
                    'SenderIpAddress': 'string',
                    'SmoothingLatency': 123,
                    'SourceListenerAddress': 'string',
                    'SourceListenerPort': 123,
                    'StreamId': 'string'
                },
                'VpcInterfaceAttachment': {
                    'VpcInterfaceName': 'string'
                }
            },
        ],
        'Source': {
            'DataTransferSubscriberFeePercent': 123,
            'Decryption': {
                'Algorithm': 'aes128'|'aes192'|'aes256',
                'ConstantInitializationVector': 'string',
                'DeviceId': 'string',
                'KeyType': 'speke'|'static-key'|'srt-password',
                'Region': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SecretArn': 'string',
                'Url': 'string'
            },
            'Description': 'string',
            'EntitlementArn': 'string',
            'IngestIp': 'string',
            'IngestPort': 123,
            'MediaStreamSourceConfigurations': [
                {
                    'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                    'InputConfigurations': [
                        {
                            'InputIp': 'string',
                            'InputPort': 123,
                            'Interface': {
                                'Name': 'string'
                            }
                        },
                    ],
                    'MediaStreamName': 'string'
                },
            ],
            'Name': 'string',
            'SenderControlPort': 123,
            'SenderIpAddress': 'string',
            'SourceArn': 'string',
            'Transport': {
                'CidrAllowList': [
                    'string',
                ],
                'MaxBitrate': 123,
                'MaxLatency': 123,
                'MaxSyncBuffer': 123,
                'MinLatency': 123,
                'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
                'RemoteId': 'string',
                'SenderControlPort': 123,
                'SenderIpAddress': 'string',
                'SmoothingLatency': 123,
                'SourceListenerAddress': 'string',
                'SourceListenerPort': 123,
                'StreamId': 'string'
            },
            'VpcInterfaceName': 'string',
            'WhitelistCidr': 'string'
        },
        'SourceFailoverConfig': {
            'FailoverMode': 'MERGE'|'FAILOVER',
            'RecoveryWindow': 123,
            'SourcePriority': {
                'PrimarySource': 'string'
            },
            'State': 'ENABLED'|'DISABLED'
        },
        'Sources': [
            {
                'DataTransferSubscriberFeePercent': 123,
                'Decryption': {
                    'Algorithm': 'aes128'|'aes192'|'aes256',
                    'ConstantInitializationVector': 'string',
                    'DeviceId': 'string',
                    'KeyType': 'speke'|'static-key'|'srt-password',
                    'Region': 'string',
                    'ResourceId': 'string',
                    'RoleArn': 'string',
                    'SecretArn': 'string',
                    'Url': 'string'
                },
                'Description': 'string',
                'EntitlementArn': 'string',
                'IngestIp': 'string',
                'IngestPort': 123,
                'MediaStreamSourceConfigurations': [
                    {
                        'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                        'InputConfigurations': [
                            {
                                'InputIp': 'string',
                                'InputPort': 123,
                                'Interface': {
                                    'Name': 'string'
                                }
                            },
                        ],
                        'MediaStreamName': 'string'
                    },
                ],
                'Name': 'string',
                'SenderControlPort': 123,
                'SenderIpAddress': 'string',
                'SourceArn': 'string',
                'Transport': {
                    'CidrAllowList': [
                        'string',
                    ],
                    'MaxBitrate': 123,
                    'MaxLatency': 123,
                    'MaxSyncBuffer': 123,
                    'MinLatency': 123,
                    'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
                    'RemoteId': 'string',
                    'SenderControlPort': 123,
                    'SenderIpAddress': 'string',
                    'SmoothingLatency': 123,
                    'SourceListenerAddress': 'string',
                    'SourceListenerPort': 123,
                    'StreamId': 'string'
                },
                'VpcInterfaceName': 'string',
                'WhitelistCidr': 'string'
            },
        ],
        'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
        'VpcInterfaces': [
            {
                'Name': 'string',
                'NetworkInterfaceIds': [
                    'string',
                ],
                'NetworkInterfaceType': 'ena'|'efa',
                'RoleArn': 'string',
                'SecurityGroupIds': [
                    'string',
                ],
                'SubnetId': 'string'
            },
        ],
        'Maintenance': {
            'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
            'MaintenanceDeadline': 'string',
            'MaintenanceScheduledDate': 'string',
            'MaintenanceStartHour': 'string'
        }
    },
    'Messages': {
        'Errors': [
            'string',
        ]
    }
}

Response Structure

• (dict) -- AWS Elemental MediaConnect returned the flow details successfully.
  • Flow (dict) -- The settings for a flow, including its source, outputs, and entitlements.
    • AvailabilityZone (string) -- The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
    • Description (string) -- A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
    • EgressIp (string) -- The IP address from which video will be sent to output destinations.
    • Entitlements (list) -- The entitlements in this flow.
      • (dict) -- The settings for a flow entitlement.
        • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
        • Description (string) -- A description of the entitlement.
        • Encryption (dict) -- The type of encryption that will be used on the output that is associated with this entitlement.
          • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
          • ConstantInitializationVector (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.
          • DeviceId (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.
          • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
          • Region (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.
          • ResourceId (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.
          • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
          • SecretArn (string) -- 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.
          • Url (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.
        • EntitlementArn (string) -- The ARN of the entitlement.
        • EntitlementStatus (string) -- An indication of whether the entitlement is enabled.
        • Name (string) -- The name of the entitlement.
        • Subscribers (list) -- 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) --
    • FlowArn (string) -- The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
    • MediaStreams (list) -- The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
      • (dict) -- 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.
        • Attributes (dict) -- Attributes that are related to the media stream.
          • Fmtp (dict) -- A set of parameters that define the media stream.
            • ChannelOrder (string) -- The format of the audio channel.
            • Colorimetry (string) -- The format that is used for the representation of color.
            • ExactFramerate (string) -- 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.
            • Par (string) -- The pixel aspect ratio (PAR) of the video.
            • Range (string) -- The encoding range of the video.
            • ScanMode (string) -- The type of compression that was used to smooth the video’s appearance
            • Tcs (string) -- The transfer characteristic system (TCS) that is used in the video.
          • Lang (string) -- The audio language, in a format that is recognized by the receiver.
        • ClockRate (integer) -- The sample rate for the stream. This value is measured in Hz.
        • Description (string) -- A description that can help you quickly identify what your media stream is used for.
        • Fmt (integer) -- 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) -- A unique identifier for the media stream.
        • MediaStreamName (string) -- A name that helps you distinguish one media stream from another.
        • MediaStreamType (string) -- The type of media stream.
        • VideoFormat (string) -- The resolution of the video.
    • Name (string) -- The name of the flow.
    • Outputs (list) -- The outputs in this flow.
      • (dict) -- The settings for an output.
        • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
        • Description (string) -- A description of the output.
        • Destination (string) -- The address where you want to send the output.
        • Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
          • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
          • ConstantInitializationVector (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.
          • DeviceId (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.
          • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
          • Region (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.
          • ResourceId (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.
          • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
          • SecretArn (string) -- 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.
          • Url (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.
        • EntitlementArn (string) -- The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
        • ListenerAddress (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 the Zixi pull or SRT listener protocol.
        • MediaLiveInputArn (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.
        • MediaStreamOutputConfigurations (list) -- The configuration for each media stream that is associated with the output.
          • (dict) -- The media stream that is associated with the output, and the parameters for that association.
            • DestinationConfigurations (list) -- The transport parameters that are associated with each outbound media stream.
              • (dict) -- The transport parameters that are associated with an outbound media stream.
                • DestinationIp (string) -- The IP address where contents of the media stream will be sent.
                • DestinationPort (integer) -- The port to use when the content of the media stream is distributed to the output.
                • Interface (dict) -- The VPC interface that is used for the media stream associated with the output.
                  • Name (string) -- The name of the VPC interface.
                • OutboundIp (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 protocol.
            • EncodingName (string) -- 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.
            • EncodingParameters (dict) -- Encoding parameters
              • CompressionFactor (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 floating point numbers in the range of 3.0 to 10.0, inclusive.
              • EncoderProfile (string) -- 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.
            • MediaStreamName (string) -- The name of the media stream.
        • Name (string) -- The name of the output. This value must be unique within the current flow.
        • OutputArn (string) -- The ARN of the output.
        • Port (integer) -- The port to use when content is distributed to this output.
        • Transport (dict) -- Attributes related to the transport stream that are used in the output.
          • CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • (string) --
          • MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
          • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
          • MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
          • MinLatency (integer) -- 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) -- The protocol that is used by the source or output.
          • RemoteId (string) -- The remote ID for the Zixi-pull stream.
          • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
          • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
          • SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
          • SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
          • SourceListenerPort (integer) -- Source port for SRT-caller protocol.
          • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
        • VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this output.
          • VpcInterfaceName (string) -- The name of the VPC interface to use for this output.
    • Source (dict) -- The settings for the source of the flow.
      • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
      • Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
        • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
        • ConstantInitializationVector (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.
        • DeviceId (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.
        • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
        • Region (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.
        • ResourceId (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.
        • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
        • SecretArn (string) -- 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.
        • Url (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.
      • Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
      • EntitlementArn (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.
      • IngestIp (string) -- The IP address that the flow will be listening on for incoming content.
      • IngestPort (integer) -- The port that the flow will be listening on for incoming content.
      • MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
        • (dict) -- The media stream that is associated with the source, and the parameters for that association.
          • EncodingName (string) -- 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 (list) -- The transport parameters that are associated with an incoming media stream.
            • (dict) -- The transport parameters that are associated with an incoming media stream.
              • InputIp (string) -- The IP address that the flow listens on for incoming content for a media stream.
              • InputPort (integer) -- The port that the flow listens on for an incoming media stream.
              • Interface (dict) -- The VPC interface where the media stream comes in from.
                • Name (string) -- The name of the VPC interface.
          • MediaStreamName (string) -- The name of the media stream.
      • Name (string) -- The name of the source.
      • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
      • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
      • SourceArn (string) -- The ARN of the source.
      • Transport (dict) -- Attributes related to the transport stream that are used in the source.
        • CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
          • (string) --
        • MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
        • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
        • MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
        • MinLatency (integer) -- 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) -- The protocol that is used by the source or output.
        • RemoteId (string) -- The remote ID for the Zixi-pull stream.
        • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
        • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
        • SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
        • SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
        • SourceListenerPort (integer) -- Source port for SRT-caller protocol.
        • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
      • VpcInterfaceName (string) -- The name of the VPC interface that is used for this source.
      • WhitelistCidr (string) -- 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.
    • SourceFailoverConfig (dict) -- The settings for source failover.
      • FailoverMode (string) -- 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) -- Search window time to look for dash-7 packets
      • SourcePriority (dict) -- The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
        • PrimarySource (string) -- The name of the source you choose as the primary source for this flow.
      • State (string) --
    • Sources (list) --
      • (dict) -- The settings for the source of the flow.
        • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
        • Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
          • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
          • ConstantInitializationVector (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.
          • DeviceId (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.
          • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
          • Region (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.
          • ResourceId (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.
          • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
          • SecretArn (string) -- 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.
          • Url (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.
        • Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
        • EntitlementArn (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.
        • IngestIp (string) -- The IP address that the flow will be listening on for incoming content.
        • IngestPort (integer) -- The port that the flow will be listening on for incoming content.
        • MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
          • (dict) -- The media stream that is associated with the source, and the parameters for that association.
            • EncodingName (string) -- 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 (list) -- The transport parameters that are associated with an incoming media stream.
              • (dict) -- The transport parameters that are associated with an incoming media stream.
                • InputIp (string) -- The IP address that the flow listens on for incoming content for a media stream.
                • InputPort (integer) -- The port that the flow listens on for an incoming media stream.
                • Interface (dict) -- The VPC interface where the media stream comes in from.
                  • Name (string) -- The name of the VPC interface.
            • MediaStreamName (string) -- The name of the media stream.
        • Name (string) -- The name of the source.
        • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
        • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
        • SourceArn (string) -- The ARN of the source.
        • Transport (dict) -- Attributes related to the transport stream that are used in the source.
          • CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • (string) --
          • MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
          • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
          • MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
          • MinLatency (integer) -- 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) -- The protocol that is used by the source or output.
          • RemoteId (string) -- The remote ID for the Zixi-pull stream.
          • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
          • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
          • SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
          • SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
          • SourceListenerPort (integer) -- Source port for SRT-caller protocol.
          • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
        • VpcInterfaceName (string) -- The name of the VPC interface that is used for this source.
        • WhitelistCidr (string) -- 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.
    • Status (string) -- The current status of the flow.
    • VpcInterfaces (list) -- The VPC Interfaces for this flow.
      • (dict) -- The settings for a VPC Source.
        • Name (string) -- Immutable and has to be a unique against other VpcInterfaces in this Flow.
        • NetworkInterfaceIds (list) -- IDs of the network interfaces created in customer's account by MediaConnect.
          • (string) --
        • NetworkInterfaceType (string) -- The type of network interface.
        • RoleArn (string) -- Role Arn MediaConnect can assumes to create ENIs in customer's account
        • SecurityGroupIds (list) -- Security Group IDs to be used on ENI.
          • (string) --
        • SubnetId (string) -- Subnet must be in the AZ of the Flow
    • Maintenance (dict) -- The maintenance setting of a flow
      • MaintenanceDay (string) -- A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
      • MaintenanceDeadline (string) -- The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.
      • MaintenanceScheduledDate (string) -- A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
      • MaintenanceStartHour (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.
  • Messages (dict) -- Messages that provide the state of the flow.
    • Errors (list) -- A list of errors that might have been generated from processes on this flow.
      • (string) --

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

describe_offering(**kwargs)

Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN).

See also: AWS API Documentation

Request Syntax

response = client.describe_offering(
    OfferingArn='string'
)

Parameters

OfferingArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the offering.

Return type

dict

Returns

Response Syntax

{
    'Offering': {
        'CurrencyCode': 'string',
        'Duration': 123,
        'DurationUnits': 'MONTHS',
        'OfferingArn': 'string',
        'OfferingDescription': 'string',
        'PricePerUnit': 'string',
        'PriceUnits': 'HOURLY',
        'ResourceSpecification': {
            'ReservedBitrate': 123,
            'ResourceType': 'Mbps_Outbound_Bandwidth'
        }
    }
}

Response Structure

• (dict) -- MediaConnect returned the offering details successfully.
  • Offering (dict) -- A savings plan that reserves a certain amount of outbound bandwidth usage at a discounted rate each month over a period of time.
    • CurrencyCode (string) -- The type of currency that is used for billing. The currencyCode used for all reservations is US dollars.
    • Duration (integer) -- The length of time that your reservation would be active.
    • DurationUnits (string) -- The unit of measurement for the duration of the offering.
    • OfferingArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
    • OfferingDescription (string) -- A description of the offering.
    • PricePerUnit (string) -- The cost of a single unit. This value, in combination with priceUnits, makes up the rate.
    • PriceUnits (string) -- The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate.
    • ResourceSpecification (dict) -- A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering.
      • ReservedBitrate (integer) -- The amount of outbound bandwidth that is discounted in the offering.
      • ResourceType (string) -- The type of resource and the unit that is being billed for.

Exceptions

• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException
• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException

describe_reservation(**kwargs)

Displays the details of a reservation. The response includes the reservation name, state, start date and time, and the details of the offering that make up the rest of the reservation (such as price, duration, and outbound bandwidth).

See also: AWS API Documentation

Request Syntax

response = client.describe_reservation(
    ReservationArn='string'
)

Parameters

ReservationArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the reservation.

Return type

dict

Returns

Response Syntax

{
    'Reservation': {
        'CurrencyCode': 'string',
        'Duration': 123,
        'DurationUnits': 'MONTHS',
        'End': 'string',
        'OfferingArn': 'string',
        'OfferingDescription': 'string',
        'PricePerUnit': 'string',
        'PriceUnits': 'HOURLY',
        'ReservationArn': 'string',
        'ReservationName': 'string',
        'ReservationState': 'ACTIVE'|'EXPIRED'|'PROCESSING'|'CANCELED',
        'ResourceSpecification': {
            'ReservedBitrate': 123,
            'ResourceType': 'Mbps_Outbound_Bandwidth'
        },
        'Start': 'string'
    }
}

Response Structure

• (dict) -- MediaConnect returned the reservation details successfully.
  • Reservation (dict) -- A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.
    • CurrencyCode (string) -- The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.
    • Duration (integer) -- The length of time that this reservation is active. MediaConnect defines this value in the offering.
    • DurationUnits (string) -- The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering.
    • End (string) -- The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration.
    • OfferingArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
    • OfferingDescription (string) -- A description of the offering. MediaConnect defines this value in the offering.
    • PricePerUnit (string) -- The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.
    • PriceUnits (string) -- The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering.
    • ReservationArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.
    • ReservationName (string) -- The name that you assigned to the reservation when you purchased the offering.
    • ReservationState (string) -- The status of your reservation.
    • ResourceSpecification (dict) -- A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in the offering.
      • ReservedBitrate (integer) -- The amount of outbound bandwidth that is discounted in the offering.
      • ResourceType (string) -- The type of resource and the unit that is being billed for.
    • Start (string) -- The day and time that the reservation becomes active. You set this value when you purchase the offering.

Exceptions

• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException
• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException

get_paginator(operation_name)

Create a paginator for an operation.

Parameters

operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").

Raises OperationNotPageableError

Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.

Return type

L{botocore.paginate.Paginator}

Returns

A paginator object.

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters

waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.

Returns

The specified waiter object.

Return type

botocore.waiter.Waiter

grant_flow_entitlements(**kwargs)

Grants entitlements to an existing flow.

See also: AWS API Documentation

Request Syntax

response = client.grant_flow_entitlements(
    Entitlements=[
        {
            'DataTransferSubscriberFeePercent': 123,
            'Description': 'string',
            'Encryption': {
                'Algorithm': 'aes128'|'aes192'|'aes256',
                'ConstantInitializationVector': 'string',
                'DeviceId': 'string',
                'KeyType': 'speke'|'static-key'|'srt-password',
                'Region': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SecretArn': 'string',
                'Url': 'string'
            },
            'EntitlementStatus': 'ENABLED'|'DISABLED',
            'Name': 'string',
            'Subscribers': [
                'string',
            ]
        },
    ],
    FlowArn='string'
)

Parameters

• Entitlements (list) --

  [REQUIRED] The list of entitlements that you want to grant.

  • (dict) -- The entitlements that you want to grant on a flow.
    • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
    • Description (string) -- A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
    • Encryption (dict) -- The type of encryption that will be used on the output that is associated with this entitlement.
      • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
      • ConstantInitializationVector (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.
      • DeviceId (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.
      • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
      • Region (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.
      • ResourceId (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.
      • RoleArn (string) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
      • SecretArn (string) -- 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.
      • Url (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.
    • EntitlementStatus (string) -- An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.
    • Name (string) -- The name of the entitlement. This value must be unique within the current flow.
    • Subscribers (list) -- [REQUIRED] The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source.
      • (string) --
• FlowArn (string) -- [REQUIRED] The flow that you want to grant entitlements on.

Return type

dict

Returns

Response Syntax

{
    'Entitlements': [
        {
            'DataTransferSubscriberFeePercent': 123,
            'Description': 'string',
            'Encryption': {
                'Algorithm': 'aes128'|'aes192'|'aes256',
                'ConstantInitializationVector': 'string',
                'DeviceId': 'string',
                'KeyType': 'speke'|'static-key'|'srt-password',
                'Region': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SecretArn': 'string',
                'Url': 'string'
            },
            'EntitlementArn': 'string',
            'EntitlementStatus': 'ENABLED'|'DISABLED',
            'Name': 'string',
            'Subscribers': [
                'string',
            ]
        },
    ],
    'FlowArn': 'string'
}

Response Structure

• (dict) -- AWS Elemental MediaConnect granted the entitlements successfully.
  • Entitlements (list) -- The entitlements that were just granted.
    • (dict) -- The settings for a flow entitlement.
      • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
      • Description (string) -- A description of the entitlement.
      • Encryption (dict) -- The type of encryption that will be used on the output that is associated with this entitlement.
        • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
        • ConstantInitializationVector (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.
        • DeviceId (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.
        • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
        • Region (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.
        • ResourceId (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.
        • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
        • SecretArn (string) -- 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.
        • Url (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.
      • EntitlementArn (string) -- The ARN of the entitlement.
      • EntitlementStatus (string) -- An indication of whether the entitlement is enabled.
      • Name (string) -- The name of the entitlement.
      • Subscribers (list) -- 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) --
  • FlowArn (string) -- The ARN of the flow that these entitlements were granted to.

Exceptions

• MediaConnect.Client.exceptions.GrantFlowEntitlements420Exception
• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

list_entitlements(**kwargs)

Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.

See also: AWS API Documentation

Request Syntax

response = client.list_entitlements(
    MaxResults=123,
    NextToken='string'
)

Parameters

• MaxResults (integer) -- The maximum number of results to return per API request. For example, you submit a ListEntitlements request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 20 results per page.
• NextToken (string) -- The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value.

Return type

dict

Returns

Response Syntax

{
    'Entitlements': [
        {
            'DataTransferSubscriberFeePercent': 123,
            'EntitlementArn': 'string',
            'EntitlementName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) -- AWS Elemental MediaConnect returned the list of entitlements successfully.
  • Entitlements (list) -- A list of entitlements that have been granted to you from other AWS accounts.
    • (dict) -- An entitlement that has been granted to you from other AWS accounts.
      • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
      • EntitlementArn (string) -- The ARN of the entitlement.
      • EntitlementName (string) -- The name of the entitlement.
  • NextToken (string) -- The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value.

Exceptions

• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException
• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException

list_flows(**kwargs)

Displays a list of flows that are associated with this account. This request returns a paginated result.

See also: AWS API Documentation

Request Syntax

response = client.list_flows(
    MaxResults=123,
    NextToken='string'
)

Parameters

• MaxResults (integer) -- The maximum number of results to return per API request. For example, you submit a ListFlows request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
• NextToken (string) -- The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.

Return type

dict

Returns

Response Syntax

{
    'Flows': [
        {
            'AvailabilityZone': 'string',
            'Description': 'string',
            'FlowArn': 'string',
            'Name': 'string',
            'SourceType': 'OWNED'|'ENTITLED',
            'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
            'Maintenance': {
                'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
                'MaintenanceDeadline': 'string',
                'MaintenanceScheduledDate': 'string',
                'MaintenanceStartHour': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) -- AWS Elemental MediaConnect returned the list of flows successfully.
  • Flows (list) -- A list of flow summaries.
    • (dict) -- Provides a summary of a flow, including its ARN, Availability Zone, and source type.
      • AvailabilityZone (string) -- The Availability Zone that the flow was created in.
      • Description (string) -- A description of the flow.
      • FlowArn (string) -- The ARN of the flow.
      • Name (string) -- The name of the flow.
      • SourceType (string) -- The type of source. This value is either owned (originated somewhere other than an AWS Elemental MediaConnect flow owned by another AWS account) or entitled (originated at an AWS Elemental MediaConnect flow owned by another AWS account).
      • Status (string) -- The current status of the flow.
      • Maintenance (dict) -- The maintenance setting of a flow
        • MaintenanceDay (string) -- A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
        • MaintenanceDeadline (string) -- The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.
        • MaintenanceScheduledDate (string) -- A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
        • MaintenanceStartHour (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.
  • NextToken (string) -- The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.

Exceptions

• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException
• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException

list_offerings(**kwargs)

Displays a list of all offerings that are available to this account in the current AWS Region. If you have an active reservation (which means you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings.

See also: AWS API Documentation

Request Syntax

response = client.list_offerings(
    MaxResults=123,
    NextToken='string'
)

Parameters

• MaxResults (integer) -- The maximum number of results to return per API request. For example, you submit a ListOfferings request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
• NextToken (string) -- The token that identifies which batch of results that you want to see. For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Offerings': [
        {
            'CurrencyCode': 'string',
            'Duration': 123,
            'DurationUnits': 'MONTHS',
            'OfferingArn': 'string',
            'OfferingDescription': 'string',
            'PricePerUnit': 'string',
            'PriceUnits': 'HOURLY',
            'ResourceSpecification': {
                'ReservedBitrate': 123,
                'ResourceType': 'Mbps_Outbound_Bandwidth'
            }
        },
    ]
}

Response Structure

• (dict) -- MediaConnect returned the list of offerings successfully.
  • NextToken (string) -- The token that identifies which batch of results that you want to see. For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.
  • Offerings (list) -- A list of offerings that are available to this account in the current AWS Region.
    • (dict) -- A savings plan that reserves a certain amount of outbound bandwidth usage at a discounted rate each month over a period of time.
      • CurrencyCode (string) -- The type of currency that is used for billing. The currencyCode used for all reservations is US dollars.
      • Duration (integer) -- The length of time that your reservation would be active.
      • DurationUnits (string) -- The unit of measurement for the duration of the offering.
      • OfferingArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
      • OfferingDescription (string) -- A description of the offering.
      • PricePerUnit (string) -- The cost of a single unit. This value, in combination with priceUnits, makes up the rate.
      • PriceUnits (string) -- The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate.
      • ResourceSpecification (dict) -- A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering.
        • ReservedBitrate (integer) -- The amount of outbound bandwidth that is discounted in the offering.
        • ResourceType (string) -- The type of resource and the unit that is being billed for.

Exceptions

• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException
• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException

list_reservations(**kwargs)

Displays a list of all reservations that have been purchased by this account in the current AWS Region. This list includes all reservations in all states (such as active and expired).

See also: AWS API Documentation

Request Syntax

response = client.list_reservations(
    MaxResults=123,
    NextToken='string'
)

Parameters

• MaxResults (integer) -- The maximum number of results to return per API request. For example, you submit a ListReservations request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
• NextToken (string) -- The token that identifies which batch of results that you want to see. For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Reservations': [
        {
            'CurrencyCode': 'string',
            'Duration': 123,
            'DurationUnits': 'MONTHS',
            'End': 'string',
            'OfferingArn': 'string',
            'OfferingDescription': 'string',
            'PricePerUnit': 'string',
            'PriceUnits': 'HOURLY',
            'ReservationArn': 'string',
            'ReservationName': 'string',
            'ReservationState': 'ACTIVE'|'EXPIRED'|'PROCESSING'|'CANCELED',
            'ResourceSpecification': {
                'ReservedBitrate': 123,
                'ResourceType': 'Mbps_Outbound_Bandwidth'
            },
            'Start': 'string'
        },
    ]
}

Response Structure

• (dict) -- MediaConnect returned the list of reservations successfully.
  • NextToken (string) -- The token that identifies which batch of results that you want to see. For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListReservations request a second time and specify the NextToken value.
  • Reservations (list) -- A list of all reservations that have been purchased by this account in the current AWS Region.
    • (dict) -- A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.
      • CurrencyCode (string) -- The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.
      • Duration (integer) -- The length of time that this reservation is active. MediaConnect defines this value in the offering.
      • DurationUnits (string) -- The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering.
      • End (string) -- The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration.
      • OfferingArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
      • OfferingDescription (string) -- A description of the offering. MediaConnect defines this value in the offering.
      • PricePerUnit (string) -- The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.
      • PriceUnits (string) -- The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering.
      • ReservationArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.
      • ReservationName (string) -- The name that you assigned to the reservation when you purchased the offering.
      • ReservationState (string) -- The status of your reservation.
      • ResourceSpecification (dict) -- A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in the offering.
        • ReservedBitrate (integer) -- The amount of outbound bandwidth that is discounted in the offering.
        • ResourceType (string) -- The type of resource and the unit that is being billed for.
      • Start (string) -- The day and time that the reservation becomes active. You set this value when you purchase the offering.

Exceptions

• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException
• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException

list_tags_for_resource(**kwargs)

List all tags on an AWS Elemental MediaConnect resource

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)

Parameters

ResourceArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource for which to list the tags.

Return type

dict

Returns

Response Syntax

{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) -- The tags for the resource
  • Tags (dict) -- A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
    • (string) --
      • (string) --

Exceptions

• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException

purchase_offering(**kwargs)

Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering.

See also: AWS API Documentation

Request Syntax

response = client.purchase_offering(
    OfferingArn='string',
    ReservationName='string',
    Start='string'
)

Parameters

• OfferingArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the offering.
• ReservationName (string) -- [REQUIRED] The name that you want to use for the reservation.
• Start (string) -- [REQUIRED] The date and time that you want the reservation to begin, in Coordinated Universal Time (UTC). You can specify any date and time between 12:00am on the first day of the current month to the current time on today's date, inclusive. Specify the start in a 24-hour notation. Use the following format: YYYY-MM-DDTHH:mm:SSZ, where T and Z are literal characters. For example, to specify 11:30pm on March 5, 2020, enter 2020-03-05T23:30:00Z.

Return type

dict

Returns

Response Syntax

{
    'Reservation': {
        'CurrencyCode': 'string',
        'Duration': 123,
        'DurationUnits': 'MONTHS',
        'End': 'string',
        'OfferingArn': 'string',
        'OfferingDescription': 'string',
        'PricePerUnit': 'string',
        'PriceUnits': 'HOURLY',
        'ReservationArn': 'string',
        'ReservationName': 'string',
        'ReservationState': 'ACTIVE'|'EXPIRED'|'PROCESSING'|'CANCELED',
        'ResourceSpecification': {
            'ReservedBitrate': 123,
            'ResourceType': 'Mbps_Outbound_Bandwidth'
        },
        'Start': 'string'
    }
}

Response Structure

• (dict) -- AWS Elemental MediaConnect purchased offering successfully.
  • Reservation (dict) -- A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.
    • CurrencyCode (string) -- The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.
    • Duration (integer) -- The length of time that this reservation is active. MediaConnect defines this value in the offering.
    • DurationUnits (string) -- The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering.
    • End (string) -- The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration.
    • OfferingArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
    • OfferingDescription (string) -- A description of the offering. MediaConnect defines this value in the offering.
    • PricePerUnit (string) -- The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.
    • PriceUnits (string) -- The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering.
    • ReservationArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.
    • ReservationName (string) -- The name that you assigned to the reservation when you purchased the offering.
    • ReservationState (string) -- The status of your reservation.
    • ResourceSpecification (dict) -- A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in the offering.
      • ReservedBitrate (integer) -- The amount of outbound bandwidth that is discounted in the offering.
      • ResourceType (string) -- The type of resource and the unit that is being billed for.
    • Start (string) -- The day and time that the reservation becomes active. You set this value when you purchase the offering.

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

remove_flow_media_stream(**kwargs)

Removes a media stream from a flow. This action is only available if the media stream is not associated with a source or output.

See also: AWS API Documentation

Request Syntax

response = client.remove_flow_media_stream(
    FlowArn='string',
    MediaStreamName='string'
)

Parameters

• FlowArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the flow.
• MediaStreamName (string) -- [REQUIRED] The name of the media stream that you want to remove.

Return type

dict

Returns

Response Syntax

{
    'FlowArn': 'string',
    'MediaStreamName': 'string'
}

Response Structure

• (dict) -- The media stream was successfully removed from the flow.
  • FlowArn (string) -- The Amazon Resource Name (ARN) of the flow.
  • MediaStreamName (string) -- The name of the media stream that was removed.

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

remove_flow_output(**kwargs)

Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output.

See also: AWS API Documentation

Request Syntax

response = client.remove_flow_output(
    FlowArn='string',
    OutputArn='string'
)

Parameters

• FlowArn (string) -- [REQUIRED] The flow that you want to remove an output from.
• OutputArn (string) -- [REQUIRED] The ARN of the output that you want to remove.

Return type

dict

Returns

Response Syntax

{
    'FlowArn': 'string',
    'OutputArn': 'string'
}

Response Structure

• (dict) -- output successfully removed from flow configuration.
  • FlowArn (string) -- The ARN of the flow that is associated with the output you removed.
  • OutputArn (string) -- The ARN of the output that was removed.

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

remove_flow_source(**kwargs)

Removes a source from an existing flow. This request can be made only if there is more than one source on the flow.

See also: AWS API Documentation

Request Syntax

response = client.remove_flow_source(
    FlowArn='string',
    SourceArn='string'
)

Parameters

• FlowArn (string) -- [REQUIRED] The flow that you want to remove a source from.
• SourceArn (string) -- [REQUIRED] The ARN of the source that you want to remove.

Return type

dict

Returns

Response Syntax

{
    'FlowArn': 'string',
    'SourceArn': 'string'
}

Response Structure

• (dict) -- source successfully removed from flow configuration.
  • FlowArn (string) -- The ARN of the flow that is associated with the source you removed.
  • SourceArn (string) -- The ARN of the source that was removed.

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

remove_flow_vpc_interface(**kwargs)

Removes a VPC Interface from an existing flow. This request can be made only on a VPC interface that does not have a Source or Output associated with it. If the VPC interface is referenced by a Source or Output, you must first delete or update the Source or Output to no longer reference the VPC interface.

See also: AWS API Documentation

Request Syntax

response = client.remove_flow_vpc_interface(
    FlowArn='string',
    VpcInterfaceName='string'
)

Parameters

• FlowArn (string) -- [REQUIRED] The flow that you want to remove a VPC interface from.
• VpcInterfaceName (string) -- [REQUIRED] The name of the VPC interface that you want to remove.

Return type

dict

Returns

Response Syntax

{
    'FlowArn': 'string',
    'NonDeletedNetworkInterfaceIds': [
        'string',
    ],
    'VpcInterfaceName': 'string'
}

Response Structure

• (dict) -- VPC interface successfully removed from flow configuration.
  • FlowArn (string) -- The ARN of the flow that is associated with the VPC interface you removed.
  • NonDeletedNetworkInterfaceIds (list) -- IDs of network interfaces associated with the removed VPC interface that Media Connect was unable to remove.
    • (string) --
  • VpcInterfaceName (string) -- The name of the VPC interface that was removed.

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

revoke_flow_entitlement(**kwargs)

Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.

See also: AWS API Documentation

Request Syntax

response = client.revoke_flow_entitlement(
    EntitlementArn='string',
    FlowArn='string'
)

Parameters

• EntitlementArn (string) -- [REQUIRED] The ARN of the entitlement that you want to revoke.
• FlowArn (string) -- [REQUIRED] The flow that you want to revoke an entitlement from.

Return type

dict

Returns

Response Syntax

{
    'EntitlementArn': 'string',
    'FlowArn': 'string'
}

Response Structure

• (dict) -- AWS Elemental MediaConnect revoked the entitlement successfully.
  • EntitlementArn (string) -- The ARN of the entitlement that was revoked.
  • FlowArn (string) -- The ARN of the flow that the entitlement was revoked from.

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

start_flow(**kwargs)

Starts a flow.

See also: AWS API Documentation

Request Syntax

response = client.start_flow(
    FlowArn='string'
)

Parameters

FlowArn (string) -- [REQUIRED] The ARN of the flow that you want to start.

Return type

dict

Returns

Response Syntax

{
    'FlowArn': 'string',
    'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR'
}

Response Structure

• (dict) -- AWS Elemental MediaConnect is starting the flow.
  • FlowArn (string) -- The ARN of the flow that you started.
  • Status (string) -- The status of the flow when the StartFlow process begins.

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

stop_flow(**kwargs)

Stops a flow.

See also: AWS API Documentation

Request Syntax

response = client.stop_flow(
    FlowArn='string'
)

Parameters

FlowArn (string) -- [REQUIRED] The ARN of the flow that you want to stop.

Return type

dict

Returns

Response Syntax

{
    'FlowArn': 'string',
    'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR'
}

Response Structure

• (dict) -- AWS Elemental MediaConnect is stopping the flow.
  • FlowArn (string) -- The ARN of the flow that you stopped.
  • Status (string) -- The status of the flow when the StopFlow process begins.

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

tag_resource(**kwargs)

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)

Parameters

• ResourceArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource to which to add tags.
• Tags (dict) --

  [REQUIRED] A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

  • (string) --
    • (string) --

Returns

None

Exceptions

• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException

untag_resource(**kwargs)

Deletes specified tags from a resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)

Parameters

• ResourceArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource from which to delete tags.
• TagKeys (list) --

  [REQUIRED] The keys of the tags to be removed.

  • (string) --

Returns

None

Exceptions

• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException

update_flow(**kwargs)

Updates flow

See also: AWS API Documentation

Request Syntax

response = client.update_flow(
    FlowArn='string',
    SourceFailoverConfig={
        'FailoverMode': 'MERGE'|'FAILOVER',
        'RecoveryWindow': 123,
        'SourcePriority': {
            'PrimarySource': 'string'
        },
        'State': 'ENABLED'|'DISABLED'
    },
    Maintenance={
        'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
        'MaintenanceScheduledDate': 'string',
        'MaintenanceStartHour': 'string'
    }
)

Parameters

• FlowArn (string) -- [REQUIRED] The flow that you want to update.
• SourceFailoverConfig (dict) --

  The settings for source failover.

  • FailoverMode (string) -- 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) -- Recovery window time to look for dash-7 packets
  • SourcePriority (dict) -- The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
    • PrimarySource (string) -- The name of the source you choose as the primary source for this flow.
  • State (string) --
• Maintenance (dict) --

  Update maintenance setting for a flow

  • MaintenanceDay (string) -- A day of a week when the maintenance will happen. use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
  • MaintenanceScheduledDate (string) -- A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
  • MaintenanceStartHour (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.

Return type

dict

Returns

Response Syntax

{
    'Flow': {
        'AvailabilityZone': 'string',
        'Description': 'string',
        'EgressIp': 'string',
        'Entitlements': [
            {
                'DataTransferSubscriberFeePercent': 123,
                'Description': 'string',
                'Encryption': {
                    'Algorithm': 'aes128'|'aes192'|'aes256',
                    'ConstantInitializationVector': 'string',
                    'DeviceId': 'string',
                    'KeyType': 'speke'|'static-key'|'srt-password',
                    'Region': 'string',
                    'ResourceId': 'string',
                    'RoleArn': 'string',
                    'SecretArn': 'string',
                    'Url': 'string'
                },
                'EntitlementArn': 'string',
                'EntitlementStatus': 'ENABLED'|'DISABLED',
                'Name': 'string',
                'Subscribers': [
                    'string',
                ]
            },
        ],
        'FlowArn': 'string',
        'MediaStreams': [
            {
                'Attributes': {
                    'Fmtp': {
                        'ChannelOrder': 'string',
                        'Colorimetry': 'BT601'|'BT709'|'BT2020'|'BT2100'|'ST2065-1'|'ST2065-3'|'XYZ',
                        'ExactFramerate': 'string',
                        'Par': 'string',
                        'Range': 'NARROW'|'FULL'|'FULLPROTECT',
                        'ScanMode': 'progressive'|'interlace'|'progressive-segmented-frame',
                        'Tcs': 'SDR'|'PQ'|'HLG'|'LINEAR'|'BT2100LINPQ'|'BT2100LINHLG'|'ST2065-1'|'ST428-1'|'DENSITY'
                    },
                    'Lang': 'string'
                },
                'ClockRate': 123,
                'Description': 'string',
                'Fmt': 123,
                'MediaStreamId': 123,
                'MediaStreamName': 'string',
                'MediaStreamType': 'video'|'audio'|'ancillary-data',
                'VideoFormat': 'string'
            },
        ],
        'Name': 'string',
        'Outputs': [
            {
                'DataTransferSubscriberFeePercent': 123,
                'Description': 'string',
                'Destination': 'string',
                'Encryption': {
                    'Algorithm': 'aes128'|'aes192'|'aes256',
                    'ConstantInitializationVector': 'string',
                    'DeviceId': 'string',
                    'KeyType': 'speke'|'static-key'|'srt-password',
                    'Region': 'string',
                    'ResourceId': 'string',
                    'RoleArn': 'string',
                    'SecretArn': 'string',
                    'Url': 'string'
                },
                'EntitlementArn': 'string',
                'ListenerAddress': 'string',
                'MediaLiveInputArn': 'string',
                'MediaStreamOutputConfigurations': [
                    {
                        'DestinationConfigurations': [
                            {
                                'DestinationIp': 'string',
                                'DestinationPort': 123,
                                'Interface': {
                                    'Name': 'string'
                                },
                                'OutboundIp': 'string'
                            },
                        ],
                        'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                        'EncodingParameters': {
                            'CompressionFactor': 123.0,
                            'EncoderProfile': 'main'|'high'
                        },
                        'MediaStreamName': 'string'
                    },
                ],
                'Name': 'string',
                'OutputArn': 'string',
                'Port': 123,
                'Transport': {
                    'CidrAllowList': [
                        'string',
                    ],
                    'MaxBitrate': 123,
                    'MaxLatency': 123,
                    'MaxSyncBuffer': 123,
                    'MinLatency': 123,
                    'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
                    'RemoteId': 'string',
                    'SenderControlPort': 123,
                    'SenderIpAddress': 'string',
                    'SmoothingLatency': 123,
                    'SourceListenerAddress': 'string',
                    'SourceListenerPort': 123,
                    'StreamId': 'string'
                },
                'VpcInterfaceAttachment': {
                    'VpcInterfaceName': 'string'
                }
            },
        ],
        'Source': {
            'DataTransferSubscriberFeePercent': 123,
            'Decryption': {
                'Algorithm': 'aes128'|'aes192'|'aes256',
                'ConstantInitializationVector': 'string',
                'DeviceId': 'string',
                'KeyType': 'speke'|'static-key'|'srt-password',
                'Region': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SecretArn': 'string',
                'Url': 'string'
            },
            'Description': 'string',
            'EntitlementArn': 'string',
            'IngestIp': 'string',
            'IngestPort': 123,
            'MediaStreamSourceConfigurations': [
                {
                    'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                    'InputConfigurations': [
                        {
                            'InputIp': 'string',
                            'InputPort': 123,
                            'Interface': {
                                'Name': 'string'
                            }
                        },
                    ],
                    'MediaStreamName': 'string'
                },
            ],
            'Name': 'string',
            'SenderControlPort': 123,
            'SenderIpAddress': 'string',
            'SourceArn': 'string',
            'Transport': {
                'CidrAllowList': [
                    'string',
                ],
                'MaxBitrate': 123,
                'MaxLatency': 123,
                'MaxSyncBuffer': 123,
                'MinLatency': 123,
                'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
                'RemoteId': 'string',
                'SenderControlPort': 123,
                'SenderIpAddress': 'string',
                'SmoothingLatency': 123,
                'SourceListenerAddress': 'string',
                'SourceListenerPort': 123,
                'StreamId': 'string'
            },
            'VpcInterfaceName': 'string',
            'WhitelistCidr': 'string'
        },
        'SourceFailoverConfig': {
            'FailoverMode': 'MERGE'|'FAILOVER',
            'RecoveryWindow': 123,
            'SourcePriority': {
                'PrimarySource': 'string'
            },
            'State': 'ENABLED'|'DISABLED'
        },
        'Sources': [
            {
                'DataTransferSubscriberFeePercent': 123,
                'Decryption': {
                    'Algorithm': 'aes128'|'aes192'|'aes256',
                    'ConstantInitializationVector': 'string',
                    'DeviceId': 'string',
                    'KeyType': 'speke'|'static-key'|'srt-password',
                    'Region': 'string',
                    'ResourceId': 'string',
                    'RoleArn': 'string',
                    'SecretArn': 'string',
                    'Url': 'string'
                },
                'Description': 'string',
                'EntitlementArn': 'string',
                'IngestIp': 'string',
                'IngestPort': 123,
                'MediaStreamSourceConfigurations': [
                    {
                        'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                        'InputConfigurations': [
                            {
                                'InputIp': 'string',
                                'InputPort': 123,
                                'Interface': {
                                    'Name': 'string'
                                }
                            },
                        ],
                        'MediaStreamName': 'string'
                    },
                ],
                'Name': 'string',
                'SenderControlPort': 123,
                'SenderIpAddress': 'string',
                'SourceArn': 'string',
                'Transport': {
                    'CidrAllowList': [
                        'string',
                    ],
                    'MaxBitrate': 123,
                    'MaxLatency': 123,
                    'MaxSyncBuffer': 123,
                    'MinLatency': 123,
                    'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
                    'RemoteId': 'string',
                    'SenderControlPort': 123,
                    'SenderIpAddress': 'string',
                    'SmoothingLatency': 123,
                    'SourceListenerAddress': 'string',
                    'SourceListenerPort': 123,
                    'StreamId': 'string'
                },
                'VpcInterfaceName': 'string',
                'WhitelistCidr': 'string'
            },
        ],
        'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
        'VpcInterfaces': [
            {
                'Name': 'string',
                'NetworkInterfaceIds': [
                    'string',
                ],
                'NetworkInterfaceType': 'ena'|'efa',
                'RoleArn': 'string',
                'SecurityGroupIds': [
                    'string',
                ],
                'SubnetId': 'string'
            },
        ],
        'Maintenance': {
            'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
            'MaintenanceDeadline': 'string',
            'MaintenanceScheduledDate': 'string',
            'MaintenanceStartHour': 'string'
        }
    }
}

Response Structure

• (dict) -- AWS Elemental MediaConnect updated the flow successfully.
  • Flow (dict) -- The settings for a flow, including its source, outputs, and entitlements.
    • AvailabilityZone (string) -- The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
    • Description (string) -- A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
    • EgressIp (string) -- The IP address from which video will be sent to output destinations.
    • Entitlements (list) -- The entitlements in this flow.
      • (dict) -- The settings for a flow entitlement.
        • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
        • Description (string) -- A description of the entitlement.
        • Encryption (dict) -- The type of encryption that will be used on the output that is associated with this entitlement.
          • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
          • ConstantInitializationVector (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.
          • DeviceId (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.
          • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
          • Region (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.
          • ResourceId (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.
          • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
          • SecretArn (string) -- 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.
          • Url (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.
        • EntitlementArn (string) -- The ARN of the entitlement.
        • EntitlementStatus (string) -- An indication of whether the entitlement is enabled.
        • Name (string) -- The name of the entitlement.
        • Subscribers (list) -- 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) --
    • FlowArn (string) -- The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
    • MediaStreams (list) -- The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
      • (dict) -- 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.
        • Attributes (dict) -- Attributes that are related to the media stream.
          • Fmtp (dict) -- A set of parameters that define the media stream.
            • ChannelOrder (string) -- The format of the audio channel.
            • Colorimetry (string) -- The format that is used for the representation of color.
            • ExactFramerate (string) -- 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.
            • Par (string) -- The pixel aspect ratio (PAR) of the video.
            • Range (string) -- The encoding range of the video.
            • ScanMode (string) -- The type of compression that was used to smooth the video’s appearance
            • Tcs (string) -- The transfer characteristic system (TCS) that is used in the video.
          • Lang (string) -- The audio language, in a format that is recognized by the receiver.
        • ClockRate (integer) -- The sample rate for the stream. This value is measured in Hz.
        • Description (string) -- A description that can help you quickly identify what your media stream is used for.
        • Fmt (integer) -- 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) -- A unique identifier for the media stream.
        • MediaStreamName (string) -- A name that helps you distinguish one media stream from another.
        • MediaStreamType (string) -- The type of media stream.
        • VideoFormat (string) -- The resolution of the video.
    • Name (string) -- The name of the flow.
    • Outputs (list) -- The outputs in this flow.
      • (dict) -- The settings for an output.
        • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
        • Description (string) -- A description of the output.
        • Destination (string) -- The address where you want to send the output.
        • Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
          • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
          • ConstantInitializationVector (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.
          • DeviceId (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.
          • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
          • Region (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.
          • ResourceId (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.
          • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
          • SecretArn (string) -- 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.
          • Url (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.
        • EntitlementArn (string) -- The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
        • ListenerAddress (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 the Zixi pull or SRT listener protocol.
        • MediaLiveInputArn (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.
        • MediaStreamOutputConfigurations (list) -- The configuration for each media stream that is associated with the output.
          • (dict) -- The media stream that is associated with the output, and the parameters for that association.
            • DestinationConfigurations (list) -- The transport parameters that are associated with each outbound media stream.
              • (dict) -- The transport parameters that are associated with an outbound media stream.
                • DestinationIp (string) -- The IP address where contents of the media stream will be sent.
                • DestinationPort (integer) -- The port to use when the content of the media stream is distributed to the output.
                • Interface (dict) -- The VPC interface that is used for the media stream associated with the output.
                  • Name (string) -- The name of the VPC interface.
                • OutboundIp (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 protocol.
            • EncodingName (string) -- 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.
            • EncodingParameters (dict) -- Encoding parameters
              • CompressionFactor (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 floating point numbers in the range of 3.0 to 10.0, inclusive.
              • EncoderProfile (string) -- 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.
            • MediaStreamName (string) -- The name of the media stream.
        • Name (string) -- The name of the output. This value must be unique within the current flow.
        • OutputArn (string) -- The ARN of the output.
        • Port (integer) -- The port to use when content is distributed to this output.
        • Transport (dict) -- Attributes related to the transport stream that are used in the output.
          • CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • (string) --
          • MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
          • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
          • MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
          • MinLatency (integer) -- 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) -- The protocol that is used by the source or output.
          • RemoteId (string) -- The remote ID for the Zixi-pull stream.
          • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
          • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
          • SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
          • SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
          • SourceListenerPort (integer) -- Source port for SRT-caller protocol.
          • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
        • VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this output.
          • VpcInterfaceName (string) -- The name of the VPC interface to use for this output.
    • Source (dict) -- The settings for the source of the flow.
      • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
      • Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
        • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
        • ConstantInitializationVector (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.
        • DeviceId (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.
        • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
        • Region (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.
        • ResourceId (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.
        • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
        • SecretArn (string) -- 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.
        • Url (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.
      • Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
      • EntitlementArn (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.
      • IngestIp (string) -- The IP address that the flow will be listening on for incoming content.
      • IngestPort (integer) -- The port that the flow will be listening on for incoming content.
      • MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
        • (dict) -- The media stream that is associated with the source, and the parameters for that association.
          • EncodingName (string) -- 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 (list) -- The transport parameters that are associated with an incoming media stream.
            • (dict) -- The transport parameters that are associated with an incoming media stream.
              • InputIp (string) -- The IP address that the flow listens on for incoming content for a media stream.
              • InputPort (integer) -- The port that the flow listens on for an incoming media stream.
              • Interface (dict) -- The VPC interface where the media stream comes in from.
                • Name (string) -- The name of the VPC interface.
          • MediaStreamName (string) -- The name of the media stream.
      • Name (string) -- The name of the source.
      • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
      • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
      • SourceArn (string) -- The ARN of the source.
      • Transport (dict) -- Attributes related to the transport stream that are used in the source.
        • CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
          • (string) --
        • MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
        • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
        • MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
        • MinLatency (integer) -- 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) -- The protocol that is used by the source or output.
        • RemoteId (string) -- The remote ID for the Zixi-pull stream.
        • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
        • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
        • SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
        • SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
        • SourceListenerPort (integer) -- Source port for SRT-caller protocol.
        • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
      • VpcInterfaceName (string) -- The name of the VPC interface that is used for this source.
      • WhitelistCidr (string) -- 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.
    • SourceFailoverConfig (dict) -- The settings for source failover.
      • FailoverMode (string) -- 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) -- Search window time to look for dash-7 packets
      • SourcePriority (dict) -- The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
        • PrimarySource (string) -- The name of the source you choose as the primary source for this flow.
      • State (string) --
    • Sources (list) --
      • (dict) -- The settings for the source of the flow.
        • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
        • Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
          • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
          • ConstantInitializationVector (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.
          • DeviceId (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.
          • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
          • Region (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.
          • ResourceId (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.
          • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
          • SecretArn (string) -- 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.
          • Url (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.
        • Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
        • EntitlementArn (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.
        • IngestIp (string) -- The IP address that the flow will be listening on for incoming content.
        • IngestPort (integer) -- The port that the flow will be listening on for incoming content.
        • MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
          • (dict) -- The media stream that is associated with the source, and the parameters for that association.
            • EncodingName (string) -- 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 (list) -- The transport parameters that are associated with an incoming media stream.
              • (dict) -- The transport parameters that are associated with an incoming media stream.
                • InputIp (string) -- The IP address that the flow listens on for incoming content for a media stream.
                • InputPort (integer) -- The port that the flow listens on for an incoming media stream.
                • Interface (dict) -- The VPC interface where the media stream comes in from.
                  • Name (string) -- The name of the VPC interface.
            • MediaStreamName (string) -- The name of the media stream.
        • Name (string) -- The name of the source.
        • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
        • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
        • SourceArn (string) -- The ARN of the source.
        • Transport (dict) -- Attributes related to the transport stream that are used in the source.
          • CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • (string) --
          • MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
          • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
          • MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
          • MinLatency (integer) -- 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) -- The protocol that is used by the source or output.
          • RemoteId (string) -- The remote ID for the Zixi-pull stream.
          • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
          • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
          • SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
          • SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
          • SourceListenerPort (integer) -- Source port for SRT-caller protocol.
          • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
        • VpcInterfaceName (string) -- The name of the VPC interface that is used for this source.
        • WhitelistCidr (string) -- 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.
    • Status (string) -- The current status of the flow.
    • VpcInterfaces (list) -- The VPC Interfaces for this flow.
      • (dict) -- The settings for a VPC Source.
        • Name (string) -- Immutable and has to be a unique against other VpcInterfaces in this Flow.
        • NetworkInterfaceIds (list) -- IDs of the network interfaces created in customer's account by MediaConnect.
          • (string) --
        • NetworkInterfaceType (string) -- The type of network interface.
        • RoleArn (string) -- Role Arn MediaConnect can assumes to create ENIs in customer's account
        • SecurityGroupIds (list) -- Security Group IDs to be used on ENI.
          • (string) --
        • SubnetId (string) -- Subnet must be in the AZ of the Flow
    • Maintenance (dict) -- The maintenance setting of a flow
      • MaintenanceDay (string) -- A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
      • MaintenanceDeadline (string) -- The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.
      • MaintenanceScheduledDate (string) -- A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
      • MaintenanceStartHour (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.

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

update_flow_entitlement(**kwargs)

You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed.

See also: AWS API Documentation

Request Syntax

response = client.update_flow_entitlement(
    Description='string',
    Encryption={
        'Algorithm': 'aes128'|'aes192'|'aes256',
        'ConstantInitializationVector': 'string',
        'DeviceId': 'string',
        'KeyType': 'speke'|'static-key'|'srt-password',
        'Region': 'string',
        'ResourceId': 'string',
        'RoleArn': 'string',
        'SecretArn': 'string',
        'Url': 'string'
    },
    EntitlementArn='string',
    EntitlementStatus='ENABLED'|'DISABLED',
    FlowArn='string',
    Subscribers=[
        'string',
    ]
)

Parameters

• Description (string) -- A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
• Encryption (dict) --

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

  • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
  • ConstantInitializationVector (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.
  • DeviceId (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.
  • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
  • Region (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.
  • ResourceId (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.
  • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
  • SecretArn (string) -- 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.
  • Url (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.
• EntitlementArn (string) -- [REQUIRED] The ARN of the entitlement that you want to update.
• EntitlementStatus (string) -- An indication of whether you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged.
• FlowArn (string) -- [REQUIRED] The flow that is associated with the entitlement that you want to update.
• Subscribers (list) --

  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) --

Return type

dict

Returns

Response Syntax

{
    'Entitlement': {
        'DataTransferSubscriberFeePercent': 123,
        'Description': 'string',
        'Encryption': {
            'Algorithm': 'aes128'|'aes192'|'aes256',
            'ConstantInitializationVector': 'string',
            'DeviceId': 'string',
            'KeyType': 'speke'|'static-key'|'srt-password',
            'Region': 'string',
            'ResourceId': 'string',
            'RoleArn': 'string',
            'SecretArn': 'string',
            'Url': 'string'
        },
        'EntitlementArn': 'string',
        'EntitlementStatus': 'ENABLED'|'DISABLED',
        'Name': 'string',
        'Subscribers': [
            'string',
        ]
    },
    'FlowArn': 'string'
}

Response Structure

• (dict) -- AWS Elemental MediaConnect updated the entitlement successfully.
  • Entitlement (dict) -- The new configuration of the entitlement that you updated.
    • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
    • Description (string) -- A description of the entitlement.
    • Encryption (dict) -- The type of encryption that will be used on the output that is associated with this entitlement.
      • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
      • ConstantInitializationVector (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.
      • DeviceId (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.
      • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
      • Region (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.
      • ResourceId (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.
      • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
      • SecretArn (string) -- 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.
      • Url (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.
    • EntitlementArn (string) -- The ARN of the entitlement.
    • EntitlementStatus (string) -- An indication of whether the entitlement is enabled.
    • Name (string) -- The name of the entitlement.
    • Subscribers (list) -- 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) --
  • FlowArn (string) -- The ARN of the flow that this entitlement was granted on.

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

update_flow_media_stream(**kwargs)

Updates an existing media stream.

See also: AWS API Documentation

Request Syntax

response = client.update_flow_media_stream(
    Attributes={
        'Fmtp': {
            'ChannelOrder': 'string',
            'Colorimetry': 'BT601'|'BT709'|'BT2020'|'BT2100'|'ST2065-1'|'ST2065-3'|'XYZ',
            'ExactFramerate': 'string',
            'Par': 'string',
            'Range': 'NARROW'|'FULL'|'FULLPROTECT',
            'ScanMode': 'progressive'|'interlace'|'progressive-segmented-frame',
            'Tcs': 'SDR'|'PQ'|'HLG'|'LINEAR'|'BT2100LINPQ'|'BT2100LINHLG'|'ST2065-1'|'ST428-1'|'DENSITY'
        },
        'Lang': 'string'
    },
    ClockRate=123,
    Description='string',
    FlowArn='string',
    MediaStreamName='string',
    MediaStreamType='video'|'audio'|'ancillary-data',
    VideoFormat='string'
)

Parameters

• Attributes (dict) --

  The attributes that you want to assign to the media stream.

  • Fmtp (dict) -- The settings that you want to use to define the media stream.
    • ChannelOrder (string) -- The format of the audio channel.
    • Colorimetry (string) -- The format that is used for the representation of color.
    • ExactFramerate (string) -- 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.
    • Par (string) -- The pixel aspect ratio (PAR) of the video.
    • Range (string) -- The encoding range of the video.
    • ScanMode (string) -- The type of compression that was used to smooth the video’s appearance.
    • Tcs (string) -- The transfer characteristic system (TCS) that is used in the video.
  • Lang (string) -- The audio language, in a format that is recognized by the receiver.
• ClockRate (integer) -- The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.
• Description (string) -- Description
• FlowArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the flow.
• MediaStreamName (string) -- [REQUIRED] The name of the media stream that you want to update.
• MediaStreamType (string) -- The type of media stream.
• VideoFormat (string) -- The resolution of the video.

Return type

dict

Returns

Response Syntax

{
    'FlowArn': 'string',
    'MediaStream': {
        'Attributes': {
            'Fmtp': {
                'ChannelOrder': 'string',
                'Colorimetry': 'BT601'|'BT709'|'BT2020'|'BT2100'|'ST2065-1'|'ST2065-3'|'XYZ',
                'ExactFramerate': 'string',
                'Par': 'string',
                'Range': 'NARROW'|'FULL'|'FULLPROTECT',
                'ScanMode': 'progressive'|'interlace'|'progressive-segmented-frame',
                'Tcs': 'SDR'|'PQ'|'HLG'|'LINEAR'|'BT2100LINPQ'|'BT2100LINHLG'|'ST2065-1'|'ST428-1'|'DENSITY'
            },
            'Lang': 'string'
        },
        'ClockRate': 123,
        'Description': 'string',
        'Fmt': 123,
        'MediaStreamId': 123,
        'MediaStreamName': 'string',
        'MediaStreamType': 'video'|'audio'|'ancillary-data',
        'VideoFormat': 'string'
    }
}

Response Structure

• (dict) -- MediaConnect is updating the media stream.
  • FlowArn (string) -- The ARN of the flow that is associated with the media stream that you updated.
  • MediaStream (dict) -- The media stream that you updated.
    • Attributes (dict) -- Attributes that are related to the media stream.
      • Fmtp (dict) -- A set of parameters that define the media stream.
        • ChannelOrder (string) -- The format of the audio channel.
        • Colorimetry (string) -- The format that is used for the representation of color.
        • ExactFramerate (string) -- 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.
        • Par (string) -- The pixel aspect ratio (PAR) of the video.
        • Range (string) -- The encoding range of the video.
        • ScanMode (string) -- The type of compression that was used to smooth the video’s appearance
        • Tcs (string) -- The transfer characteristic system (TCS) that is used in the video.
      • Lang (string) -- The audio language, in a format that is recognized by the receiver.
    • ClockRate (integer) -- The sample rate for the stream. This value is measured in Hz.
    • Description (string) -- A description that can help you quickly identify what your media stream is used for.
    • Fmt (integer) -- 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) -- A unique identifier for the media stream.
    • MediaStreamName (string) -- A name that helps you distinguish one media stream from another.
    • MediaStreamType (string) -- The type of media stream.
    • VideoFormat (string) -- The resolution of the video.

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

update_flow_output(**kwargs)

Updates an existing flow output.

See also: AWS API Documentation

Request Syntax

response = client.update_flow_output(
    CidrAllowList=[
        'string',
    ],
    Description='string',
    Destination='string',
    Encryption={
        'Algorithm': 'aes128'|'aes192'|'aes256',
        'ConstantInitializationVector': 'string',
        'DeviceId': 'string',
        'KeyType': 'speke'|'static-key'|'srt-password',
        'Region': 'string',
        'ResourceId': 'string',
        'RoleArn': 'string',
        'SecretArn': 'string',
        'Url': 'string'
    },
    FlowArn='string',
    MaxLatency=123,
    MediaStreamOutputConfigurations=[
        {
            'DestinationConfigurations': [
                {
                    'DestinationIp': 'string',
                    'DestinationPort': 123,
                    'Interface': {
                        'Name': 'string'
                    }
                },
            ],
            'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
            'EncodingParameters': {
                'CompressionFactor': 123.0,
                'EncoderProfile': 'main'|'high'
            },
            'MediaStreamName': 'string'
        },
    ],
    MinLatency=123,
    OutputArn='string',
    Port=123,
    Protocol='zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
    RemoteId='string',
    SenderControlPort=123,
    SenderIpAddress='string',
    SmoothingLatency=123,
    StreamId='string',
    VpcInterfaceAttachment={
        'VpcInterfaceName': 'string'
    }
)

Parameters

• CidrAllowList (list) --

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

  • (string) --
• Description (string) -- A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
• Destination (string) -- The IP address where you want to send the output.
• Encryption (dict) --

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

  • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
  • ConstantInitializationVector (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.
  • DeviceId (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.
  • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
  • Region (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.
  • ResourceId (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.
  • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
  • SecretArn (string) -- 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.
  • Url (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.
• FlowArn (string) -- [REQUIRED] The flow that is associated with the output that you want to update.
• MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
• MediaStreamOutputConfigurations (list) --

  The media streams that are associated with the output, and the parameters for those associations.

  • (dict) -- The media stream that you want to associate with the output, and the parameters for that association.
    • DestinationConfigurations (list) -- The transport parameters that you want to associate with the media stream.
      • (dict) -- The transport parameters that you want to associate with an outbound media stream.
        • DestinationIp (string) -- [REQUIRED] The IP address where you want MediaConnect to send contents of the media stream.
        • DestinationPort (integer) -- [REQUIRED] The port that you want MediaConnect to use when it distributes the media stream to the output.
        • Interface (dict) -- [REQUIRED] The VPC interface that you want to use for the media stream associated with the output.
          • Name (string) -- [REQUIRED] The name of the VPC interface.
    • EncodingName (string) -- [REQUIRED] 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, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
    • EncodingParameters (dict) -- 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.
      • CompressionFactor (float) -- [REQUIRED] 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.
      • EncoderProfile (string) -- [REQUIRED] 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, if at least one source on the flow uses the CDI protocol.
    • MediaStreamName (string) -- [REQUIRED] The name of the media stream that is associated with the output.
• MinLatency (integer) -- 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.
• OutputArn (string) -- [REQUIRED] The ARN of the output that you want to update.
• Port (integer) -- The port to use when content is distributed to this output.
• Protocol (string) -- The protocol to use for the output.
• RemoteId (string) -- The remote ID for the Zixi-pull stream.
• SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
• SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
• SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
• StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
• VpcInterfaceAttachment (dict) --

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

  • VpcInterfaceName (string) -- The name of the VPC interface to use for this output.

Return type

dict

Returns

Response Syntax

{
    'FlowArn': 'string',
    'Output': {
        'DataTransferSubscriberFeePercent': 123,
        'Description': 'string',
        'Destination': 'string',
        'Encryption': {
            'Algorithm': 'aes128'|'aes192'|'aes256',
            'ConstantInitializationVector': 'string',
            'DeviceId': 'string',
            'KeyType': 'speke'|'static-key'|'srt-password',
            'Region': 'string',
            'ResourceId': 'string',
            'RoleArn': 'string',
            'SecretArn': 'string',
            'Url': 'string'
        },
        'EntitlementArn': 'string',
        'ListenerAddress': 'string',
        'MediaLiveInputArn': 'string',
        'MediaStreamOutputConfigurations': [
            {
                'DestinationConfigurations': [
                    {
                        'DestinationIp': 'string',
                        'DestinationPort': 123,
                        'Interface': {
                            'Name': 'string'
                        },
                        'OutboundIp': 'string'
                    },
                ],
                'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                'EncodingParameters': {
                    'CompressionFactor': 123.0,
                    'EncoderProfile': 'main'|'high'
                },
                'MediaStreamName': 'string'
            },
        ],
        'Name': 'string',
        'OutputArn': 'string',
        'Port': 123,
        'Transport': {
            'CidrAllowList': [
                'string',
            ],
            'MaxBitrate': 123,
            'MaxLatency': 123,
            'MaxSyncBuffer': 123,
            'MinLatency': 123,
            'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
            'RemoteId': 'string',
            'SenderControlPort': 123,
            'SenderIpAddress': 'string',
            'SmoothingLatency': 123,
            'SourceListenerAddress': 'string',
            'SourceListenerPort': 123,
            'StreamId': 'string'
        },
        'VpcInterfaceAttachment': {
            'VpcInterfaceName': 'string'
        }
    }
}

Response Structure

• (dict) -- AWS Elemental MediaConnect updated the output successfully.
  • FlowArn (string) -- The ARN of the flow that is associated with the updated output.
  • Output (dict) -- The new settings of the output that you updated.
    • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
    • Description (string) -- A description of the output.
    • Destination (string) -- The address where you want to send the output.
    • Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
      • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
      • ConstantInitializationVector (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.
      • DeviceId (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.
      • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
      • Region (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.
      • ResourceId (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.
      • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
      • SecretArn (string) -- 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.
      • Url (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.
    • EntitlementArn (string) -- The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
    • ListenerAddress (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 the Zixi pull or SRT listener protocol.
    • MediaLiveInputArn (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.
    • MediaStreamOutputConfigurations (list) -- The configuration for each media stream that is associated with the output.
      • (dict) -- The media stream that is associated with the output, and the parameters for that association.
        • DestinationConfigurations (list) -- The transport parameters that are associated with each outbound media stream.
          • (dict) -- The transport parameters that are associated with an outbound media stream.
            • DestinationIp (string) -- The IP address where contents of the media stream will be sent.
            • DestinationPort (integer) -- The port to use when the content of the media stream is distributed to the output.
            • Interface (dict) -- The VPC interface that is used for the media stream associated with the output.
              • Name (string) -- The name of the VPC interface.
            • OutboundIp (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 protocol.
        • EncodingName (string) -- 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.
        • EncodingParameters (dict) -- Encoding parameters
          • CompressionFactor (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 floating point numbers in the range of 3.0 to 10.0, inclusive.
          • EncoderProfile (string) -- 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.
        • MediaStreamName (string) -- The name of the media stream.
    • Name (string) -- The name of the output. This value must be unique within the current flow.
    • OutputArn (string) -- The ARN of the output.
    • Port (integer) -- The port to use when content is distributed to this output.
    • Transport (dict) -- Attributes related to the transport stream that are used in the output.
      • CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
        • (string) --
      • MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
      • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
      • MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
      • MinLatency (integer) -- 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) -- The protocol that is used by the source or output.
      • RemoteId (string) -- The remote ID for the Zixi-pull stream.
      • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
      • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
      • SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
      • SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
      • SourceListenerPort (integer) -- Source port for SRT-caller protocol.
      • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
    • VpcInterfaceAttachment (dict) -- The name of the VPC interface attachment to use for this output.
      • VpcInterfaceName (string) -- The name of the VPC interface to use for this output.

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

update_flow_source(**kwargs)

Updates the source of a flow.

See also: AWS API Documentation

Request Syntax

response = client.update_flow_source(
    Decryption={
        'Algorithm': 'aes128'|'aes192'|'aes256',
        'ConstantInitializationVector': 'string',
        'DeviceId': 'string',
        'KeyType': 'speke'|'static-key'|'srt-password',
        'Region': 'string',
        'ResourceId': 'string',
        'RoleArn': 'string',
        'SecretArn': 'string',
        'Url': 'string'
    },
    Description='string',
    EntitlementArn='string',
    FlowArn='string',
    IngestPort=123,
    MaxBitrate=123,
    MaxLatency=123,
    MaxSyncBuffer=123,
    MediaStreamSourceConfigurations=[
        {
            'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
            'InputConfigurations': [
                {
                    'InputPort': 123,
                    'Interface': {
                        'Name': 'string'
                    }
                },
            ],
            'MediaStreamName': 'string'
        },
    ],
    MinLatency=123,
    Protocol='zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
    SenderControlPort=123,
    SenderIpAddress='string',
    SourceArn='string',
    SourceListenerAddress='string',
    SourceListenerPort=123,
    StreamId='string',
    VpcInterfaceName='string',
    WhitelistCidr='string'
)

Parameters

• Decryption (dict) --

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

  • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
  • ConstantInitializationVector (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.
  • DeviceId (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.
  • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
  • Region (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.
  • ResourceId (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.
  • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
  • SecretArn (string) -- 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.
  • Url (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.
• Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
• EntitlementArn (string) -- The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
• FlowArn (string) -- [REQUIRED] The flow that is associated with the source that you want to update.
• IngestPort (integer) -- The port that the flow will be listening on for incoming content.
• MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
• MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
• MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
• MediaStreamSourceConfigurations (list) --

  The media streams that are associated with the source, and the parameters for those associations.

  • (dict) -- The definition of a media stream that you want to associate with the source.
    • EncodingName (string) -- [REQUIRED] The format you want to use 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 (list) -- The transport parameters that you want to associate with the media stream.
      • (dict) -- The transport parameters that you want to associate with an incoming media stream.
        • InputPort (integer) -- [REQUIRED] The port that you want the flow to listen on for an incoming media stream.
        • Interface (dict) -- [REQUIRED] The VPC interface that you want to use for the incoming media stream.
          • Name (string) -- [REQUIRED] The name of the VPC interface.
    • MediaStreamName (string) -- [REQUIRED] The name of the media stream.
• MinLatency (integer) -- 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) -- The protocol that is used by the source.
• SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
• SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
• SourceArn (string) -- [REQUIRED] The ARN of the source that you want to update.
• SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
• SourceListenerPort (integer) -- Source port for SRT-caller protocol.
• StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
• VpcInterfaceName (string) -- The name of the VPC interface to use for this source.
• WhitelistCidr (string) -- 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.

Return type

dict

Returns

Response Syntax

{
    'FlowArn': 'string',
    'Source': {
        'DataTransferSubscriberFeePercent': 123,
        'Decryption': {
            'Algorithm': 'aes128'|'aes192'|'aes256',
            'ConstantInitializationVector': 'string',
            'DeviceId': 'string',
            'KeyType': 'speke'|'static-key'|'srt-password',
            'Region': 'string',
            'ResourceId': 'string',
            'RoleArn': 'string',
            'SecretArn': 'string',
            'Url': 'string'
        },
        'Description': 'string',
        'EntitlementArn': 'string',
        'IngestIp': 'string',
        'IngestPort': 123,
        'MediaStreamSourceConfigurations': [
            {
                'EncodingName': 'jxsv'|'raw'|'smpte291'|'pcm',
                'InputConfigurations': [
                    {
                        'InputIp': 'string',
                        'InputPort': 123,
                        'Interface': {
                            'Name': 'string'
                        }
                    },
                ],
                'MediaStreamName': 'string'
            },
        ],
        'Name': 'string',
        'SenderControlPort': 123,
        'SenderIpAddress': 'string',
        'SourceArn': 'string',
        'Transport': {
            'CidrAllowList': [
                'string',
            ],
            'MaxBitrate': 123,
            'MaxLatency': 123,
            'MaxSyncBuffer': 123,
            'MinLatency': 123,
            'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos',
            'RemoteId': 'string',
            'SenderControlPort': 123,
            'SenderIpAddress': 'string',
            'SmoothingLatency': 123,
            'SourceListenerAddress': 'string',
            'SourceListenerPort': 123,
            'StreamId': 'string'
        },
        'VpcInterfaceName': 'string',
        'WhitelistCidr': 'string'
    }
}

Response Structure

• (dict) -- AWS Elemental MediaConnect updated the flow successfully.
  • FlowArn (string) -- The ARN of the flow that you want to update.
  • Source (dict) -- The settings for the source of the flow.
    • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
    • Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
      • Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
      • ConstantInitializationVector (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.
      • DeviceId (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.
      • KeyType (string) -- The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
      • Region (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.
      • ResourceId (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.
      • RoleArn (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
      • SecretArn (string) -- 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.
      • Url (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.
    • Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
    • EntitlementArn (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.
    • IngestIp (string) -- The IP address that the flow will be listening on for incoming content.
    • IngestPort (integer) -- The port that the flow will be listening on for incoming content.
    • MediaStreamSourceConfigurations (list) -- The media streams that are associated with the source, and the parameters for those associations.
      • (dict) -- The media stream that is associated with the source, and the parameters for that association.
        • EncodingName (string) -- 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 (list) -- The transport parameters that are associated with an incoming media stream.
          • (dict) -- The transport parameters that are associated with an incoming media stream.
            • InputIp (string) -- The IP address that the flow listens on for incoming content for a media stream.
            • InputPort (integer) -- The port that the flow listens on for an incoming media stream.
            • Interface (dict) -- The VPC interface where the media stream comes in from.
              • Name (string) -- The name of the VPC interface.
        • MediaStreamName (string) -- The name of the media stream.
    • Name (string) -- The name of the source.
    • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
    • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
    • SourceArn (string) -- The ARN of the source.
    • Transport (dict) -- Attributes related to the transport stream that are used in the source.
      • CidrAllowList (list) -- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
        • (string) --
      • MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
      • MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
      • MaxSyncBuffer (integer) -- The size of the buffer (in milliseconds) to use to sync incoming source data.
      • MinLatency (integer) -- 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) -- The protocol that is used by the source or output.
      • RemoteId (string) -- The remote ID for the Zixi-pull stream.
      • SenderControlPort (integer) -- The port that the flow uses to send outbound requests to initiate connection with the sender.
      • SenderIpAddress (string) -- The IP address that the flow communicates with to initiate connection with the sender.
      • SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
      • SourceListenerAddress (string) -- Source IP or domain name for SRT-caller protocol.
      • SourceListenerPort (integer) -- Source port for SRT-caller protocol.
      • StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
    • VpcInterfaceName (string) -- The name of the VPC interface that is used for this source.
    • WhitelistCidr (string) -- 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.

Exceptions

• MediaConnect.Client.exceptions.BadRequestException
• MediaConnect.Client.exceptions.InternalServerErrorException
• MediaConnect.Client.exceptions.ForbiddenException
• MediaConnect.Client.exceptions.NotFoundException
• MediaConnect.Client.exceptions.ServiceUnavailableException
• MediaConnect.Client.exceptions.TooManyRequestsException

Paginators

The available paginators are:

• MediaConnect.Paginator.ListEntitlements
• MediaConnect.Paginator.ListFlows
• MediaConnect.Paginator.ListOfferings
• MediaConnect.Paginator.ListReservations

class MediaConnect.Paginator.ListEntitlements

paginator = client.get_paginator('list_entitlements')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MediaConnect.Client.list_entitlements().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

• MaxItems (integer) --

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) --

  The size of each page.

• StartingToken (string) --

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Entitlements': [
        {
            'DataTransferSubscriberFeePercent': 123,
            'EntitlementArn': 'string',
            'EntitlementName': 'string'
        },
    ],

}

Response Structure

• (dict) -- AWS Elemental MediaConnect returned the list of entitlements successfully.
  • Entitlements (list) -- A list of entitlements that have been granted to you from other AWS accounts.
    • (dict) -- An entitlement that has been granted to you from other AWS accounts.
      • DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
      • EntitlementArn (string) -- The ARN of the entitlement.
      • EntitlementName (string) -- The name of the entitlement.

class MediaConnect.Paginator.ListFlows

paginator = client.get_paginator('list_flows')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MediaConnect.Client.list_flows().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

• MaxItems (integer) --

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) --

  The size of each page.

• StartingToken (string) --

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Flows': [
        {
            'AvailabilityZone': 'string',
            'Description': 'string',
            'FlowArn': 'string',
            'Name': 'string',
            'SourceType': 'OWNED'|'ENTITLED',
            'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
            'Maintenance': {
                'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
                'MaintenanceDeadline': 'string',
                'MaintenanceScheduledDate': 'string',
                'MaintenanceStartHour': 'string'
            }
        },
    ],

}

Response Structure

• (dict) -- AWS Elemental MediaConnect returned the list of flows successfully.
  • Flows (list) -- A list of flow summaries.
    • (dict) -- Provides a summary of a flow, including its ARN, Availability Zone, and source type.
      • AvailabilityZone (string) -- The Availability Zone that the flow was created in.
      • Description (string) -- A description of the flow.
      • FlowArn (string) -- The ARN of the flow.
      • Name (string) -- The name of the flow.
      • SourceType (string) -- The type of source. This value is either owned (originated somewhere other than an AWS Elemental MediaConnect flow owned by another AWS account) or entitled (originated at an AWS Elemental MediaConnect flow owned by another AWS account).
      • Status (string) -- The current status of the flow.
      • Maintenance (dict) -- The maintenance setting of a flow
        • MaintenanceDay (string) -- A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
        • MaintenanceDeadline (string) -- The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.
        • MaintenanceScheduledDate (string) -- A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
        • MaintenanceStartHour (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.

class MediaConnect.Paginator.ListOfferings

paginator = client.get_paginator('list_offerings')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MediaConnect.Client.list_offerings().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

• MaxItems (integer) --

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) --

  The size of each page.

• StartingToken (string) --

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Offerings': [
        {
            'CurrencyCode': 'string',
            'Duration': 123,
            'DurationUnits': 'MONTHS',
            'OfferingArn': 'string',
            'OfferingDescription': 'string',
            'PricePerUnit': 'string',
            'PriceUnits': 'HOURLY',
            'ResourceSpecification': {
                'ReservedBitrate': 123,
                'ResourceType': 'Mbps_Outbound_Bandwidth'
            }
        },
    ]
}

Response Structure

• (dict) -- MediaConnect returned the list of offerings successfully.
  • Offerings (list) -- A list of offerings that are available to this account in the current AWS Region.
    • (dict) -- A savings plan that reserves a certain amount of outbound bandwidth usage at a discounted rate each month over a period of time.
      • CurrencyCode (string) -- The type of currency that is used for billing. The currencyCode used for all reservations is US dollars.
      • Duration (integer) -- The length of time that your reservation would be active.
      • DurationUnits (string) -- The unit of measurement for the duration of the offering.
      • OfferingArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
      • OfferingDescription (string) -- A description of the offering.
      • PricePerUnit (string) -- The cost of a single unit. This value, in combination with priceUnits, makes up the rate.
      • PriceUnits (string) -- The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate.
      • ResourceSpecification (dict) -- A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering.
        • ReservedBitrate (integer) -- The amount of outbound bandwidth that is discounted in the offering.
        • ResourceType (string) -- The type of resource and the unit that is being billed for.

class MediaConnect.Paginator.ListReservations

paginator = client.get_paginator('list_reservations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MediaConnect.Client.list_reservations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

• MaxItems (integer) --

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) --

  The size of each page.

• StartingToken (string) --

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Reservations': [
        {
            'CurrencyCode': 'string',
            'Duration': 123,
            'DurationUnits': 'MONTHS',
            'End': 'string',
            'OfferingArn': 'string',
            'OfferingDescription': 'string',
            'PricePerUnit': 'string',
            'PriceUnits': 'HOURLY',
            'ReservationArn': 'string',
            'ReservationName': 'string',
            'ReservationState': 'ACTIVE'|'EXPIRED'|'PROCESSING'|'CANCELED',
            'ResourceSpecification': {
                'ReservedBitrate': 123,
                'ResourceType': 'Mbps_Outbound_Bandwidth'
            },
            'Start': 'string'
        },
    ]
}

Response Structure

• (dict) -- MediaConnect returned the list of reservations successfully.
  • Reservations (list) -- A list of all reservations that have been purchased by this account in the current AWS Region.
    • (dict) -- A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.
      • CurrencyCode (string) -- The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.
      • Duration (integer) -- The length of time that this reservation is active. MediaConnect defines this value in the offering.
      • DurationUnits (string) -- The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering.
      • End (string) -- The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration.
      • OfferingArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
      • OfferingDescription (string) -- A description of the offering. MediaConnect defines this value in the offering.
      • PricePerUnit (string) -- The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.
      • PriceUnits (string) -- The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering.
      • ReservationArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.
      • ReservationName (string) -- The name that you assigned to the reservation when you purchased the offering.
      • ReservationState (string) -- The status of your reservation.
      • ResourceSpecification (dict) -- A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in the offering.
        • ReservedBitrate (integer) -- The amount of outbound bandwidth that is discounted in the offering.
        • ResourceType (string) -- The type of resource and the unit that is being billed for.
      • Start (string) -- The day and time that the reservation becomes active. You set this value when you purchase the offering.

Waiters

The available waiters are:

• MediaConnect.Waiter.FlowActive
• MediaConnect.Waiter.FlowDeleted
• MediaConnect.Waiter.FlowStandby

class MediaConnect.Waiter.FlowActive

waiter = client.get_waiter('flow_active')

wait(**kwargs)

Polls MediaConnect.Client.describe_flow() every 3 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    FlowArn='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters

• FlowArn (string) -- [REQUIRED] The ARN of the flow that you want to describe.
• WaiterConfig (dict) --

  A dictionary that provides parameters to control waiting behavior.

  • Delay (integer) --

    The amount of time in seconds to wait between attempts. Default: 3

  • MaxAttempts (integer) --

    The maximum number of attempts to be made. Default: 40

Returns

None

class MediaConnect.Waiter.FlowDeleted

waiter = client.get_waiter('flow_deleted')

wait(**kwargs)

Polls MediaConnect.Client.describe_flow() every 3 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    FlowArn='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters

• FlowArn (string) -- [REQUIRED] The ARN of the flow that you want to describe.
• WaiterConfig (dict) --

  A dictionary that provides parameters to control waiting behavior.

  • Delay (integer) --

    The amount of time in seconds to wait between attempts. Default: 3

  • MaxAttempts (integer) --

    The maximum number of attempts to be made. Default: 40

Returns

None

class MediaConnect.Waiter.FlowStandby

waiter = client.get_waiter('flow_standby')

wait(**kwargs)

Polls MediaConnect.Client.describe_flow() every 3 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    FlowArn='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters

• FlowArn (string) -- [REQUIRED] The ARN of the flow that you want to describe.
• WaiterConfig (dict) --

  A dictionary that provides parameters to control waiting behavior.

  • Delay (integer) --

    The amount of time in seconds to wait between attempts. Default: 3

  • MaxAttempts (integer) --

    The maximum number of attempts to be made. Default: 40

Returns

None