MediaConnect ************ Client ====== class MediaConnect.Client A low-level client representing AWS MediaConnect Welcome to the Elemental MediaConnect API reference. MediaConnect is a service that lets you ingest live video content into the cloud and distribute it to destinations all over the world, both inside and outside the Amazon Web Services cloud. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types that are supported by MediaConnect. Use the following links to get started with the MediaConnect API: * Actions: An alphabetical list of all MediaConnect API operations. * Data types: An alphabetical list of all MediaConnect data types. * Common parameters: Parameters that all operations can use. * Common errors: Client and server errors that all operations can return. import boto3 client = boto3.client('mediaconnect') These are the available methods: * add_bridge_outputs * add_bridge_sources * add_flow_media_streams * add_flow_outputs * add_flow_sources * add_flow_vpc_interfaces * can_paginate * close * create_bridge * create_flow * create_gateway * delete_bridge * delete_flow * delete_gateway * deregister_gateway_instance * describe_bridge * describe_flow * describe_flow_source_metadata * describe_flow_source_thumbnail * describe_gateway * describe_gateway_instance * describe_offering * describe_reservation * get_paginator * get_waiter * grant_flow_entitlements * list_bridges * list_entitlements * list_flows * list_gateway_instances * list_gateways * list_offerings * list_reservations * list_tags_for_resource * purchase_offering * remove_bridge_output * remove_bridge_source * 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_bridge * update_bridge_output * update_bridge_source * update_bridge_state * update_flow * update_flow_entitlement * update_flow_media_stream * update_flow_output * update_flow_source * update_gateway_instance Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListBridges * ListEntitlements * ListFlows * ListGatewayInstances * ListGateways * ListOfferings * ListReservations Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * FlowActive * FlowDeleted * FlowStandby MediaConnect / Waiter / FlowStandby FlowStandby *********** 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 raised 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 MediaConnect / Waiter / FlowActive FlowActive ********** 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 raised 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 MediaConnect / Waiter / FlowDeleted FlowDeleted *********** 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 raised 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 MediaConnect / Paginator / ListEntitlements ListEntitlements **************** 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) --* * **Entitlements** *(list) --* A list of entitlements that have been granted to you from other Amazon Web Services accounts. * *(dict) --* An entitlement that has been granted to you from other Amazon Web Services 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. MediaConnect / Paginator / ListBridges ListBridges *********** class MediaConnect.Paginator.ListBridges paginator = client.get_paginator('list_bridges') paginate(**kwargs) Creates an iterator that will paginate through responses from "MediaConnect.Client.list_bridges()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( FilterArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **FilterArn** (*string*) -- Filter the list results to display only the bridges associated with the selected ARN. * **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** { 'Bridges': [ { 'BridgeArn': 'string', 'BridgeState': 'CREATING'|'STANDBY'|'STARTING'|'DEPLOYING'|'ACTIVE'|'STOPPING'|'DELETING'|'DELETED'|'START_FAILED'|'START_PENDING'|'STOP_FAILED'|'UPDATING', 'BridgeType': 'string', 'Name': 'string', 'PlacementArn': 'string' }, ], } **Response Structure** * *(dict) --* * **Bridges** *(list) --* A list of bridge summaries. * *(dict) --* Displays details of the selected bridge. * **BridgeArn** *(string) --* The ARN of the bridge. * **BridgeState** *(string) --* The state of the bridge. * **BridgeType** *(string) --* The type of the bridge. * **Name** *(string) --* The name of the bridge. * **PlacementArn** *(string) --* The ARN of the gateway associated with the bridge. MediaConnect / Paginator / ListFlows ListFlows ********* 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) --* * **Flows** *(list) --* A list of flow summaries. * *(dict) --* 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 MediaConnect flow owned by another Amazon Web Services account) or entitled (originated at a MediaConnect flow owned by another Amazon Web Services account). * **Status** *(string) --* The current status of the flow. * **Maintenance** *(dict) --* The maintenance settings for the flow. * **MaintenanceDay** *(string) --* A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Satur day/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. MediaConnect / Paginator / ListGateways ListGateways ************ class MediaConnect.Paginator.ListGateways paginator = client.get_paginator('list_gateways') paginate(**kwargs) Creates an iterator that will paginate through responses from "MediaConnect.Client.list_gateways()". 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** { 'Gateways': [ { 'GatewayArn': 'string', 'GatewayState': 'CREATING'|'ACTIVE'|'UPDATING'|'ERROR'|'DELETING'|'DELETED', 'Name': 'string' }, ], } **Response Structure** * *(dict) --* * **Gateways** *(list) --* A list of gateway summaries. * *(dict) --* A summary of a gateway, including its name, ARN, and status. * **GatewayArn** *(string) --* The Amazon Resource Name (ARN) of the gateway. * **GatewayState** *(string) --* The status of the gateway. * **Name** *(string) --* The name of the gateway. MediaConnect / Paginator / ListReservations ListReservations **************** 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) --* * **Reservations** *(list) --* A list of all reservations that have been purchased by this account in the current Amazon Web Services 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. MediaConnect / Paginator / ListOfferings ListOfferings ************* 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) --* * **Offerings** *(list) --* A list of offerings that are available to this account in the current Amazon Web Services 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. MediaConnect / Paginator / ListGatewayInstances ListGatewayInstances ******************** class MediaConnect.Paginator.ListGatewayInstances paginator = client.get_paginator('list_gateway_instances') paginate(**kwargs) Creates an iterator that will paginate through responses from "MediaConnect.Client.list_gateway_instances()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( FilterArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **FilterArn** (*string*) -- Filter the list results to display only the instances associated with the selected Gateway ARN. * **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** { 'Instances': [ { 'GatewayArn': 'string', 'GatewayInstanceArn': 'string', 'InstanceId': 'string', 'InstanceState': 'REGISTERING'|'ACTIVE'|'DEREGISTERING'|'DEREGISTERED'|'REGISTRATION_ERROR'|'DEREGISTRATION_ERROR' }, ], } **Response Structure** * *(dict) --* * **Instances** *(list) --* A list of instance summaries. * *(dict) --* A summary of an instance. * **GatewayArn** *(string) --* The Amazon Resource Name (ARN) of the gateway. * **GatewayInstanceArn** *(string) --* The Amazon Resource Name (ARN) of the instance. * **InstanceId** *(string) --* The managed instance ID generated by the SSM install. This will begin with "mi-". * **InstanceState** *(string) --* The status of the instance. MediaConnect / Client / describe_flow_source_thumbnail describe_flow_source_thumbnail ****************************** MediaConnect.Client.describe_flow_source_thumbnail(**kwargs) Describes the thumbnail for the flow source. See also: AWS API Documentation **Request Syntax** response = client.describe_flow_source_thumbnail( FlowArn='string' ) Parameters: **FlowArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the flow. Return type: dict Returns: **Response Syntax** { 'ThumbnailDetails': { 'FlowArn': 'string', 'Thumbnail': 'string', 'ThumbnailMessages': [ { 'Code': 'string', 'Message': 'string', 'ResourceName': 'string' }, ], 'Timecode': 'string', 'Timestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **ThumbnailDetails** *(dict) --* The details of the thumbnail, including thumbnail base64 string, timecode and the time when thumbnail was generated. * **FlowArn** *(string) --* The ARN of the flow that DescribeFlowSourceThumbnail was performed on. * **Thumbnail** *(string) --* Thumbnail Base64 string. * **ThumbnailMessages** *(list) --* Status code and messages about the flow source thumbnail. * *(dict) --* The details of an error message. * **Code** *(string) --* The error code. * **Message** *(string) --* The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed. * **ResourceName** *(string) --* The name of the resource. * **Timecode** *(string) --* Timecode of thumbnail. * **Timestamp** *(datetime) --* The timestamp of when thumbnail was generated. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / get_paginator get_paginator ************* MediaConnect.Client.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: "botocore.paginate.Paginator" Returns: A paginator object. MediaConnect / Client / list_offerings list_offerings ************** MediaConnect.Client.list_offerings(**kwargs) Displays a list of all offerings that are available to this account in the current Amazon Web Services 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 the 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) --* * **NextToken** *(string) --* The token that identifies the 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 Amazon Web Services 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.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / list_bridges list_bridges ************ MediaConnect.Client.list_bridges(**kwargs) Displays a list of bridges that are associated with this account and an optionally specified Amazon Resource Name (ARN). This request returns a paginated result. See also: AWS API Documentation **Request Syntax** response = client.list_bridges( FilterArn='string', MaxResults=123, NextToken='string' ) Parameters: * **FilterArn** (*string*) -- Filter the list results to display only the bridges associated with the selected ARN. * **MaxResults** (*integer*) -- The maximum number of results to return per API request. For example, you submit a "ListBridges" 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 the batch of results that you want to see. For example, you submit a "ListBridges" 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 "ListBridges" request a second time and specify the "NextToken" value. Return type: dict Returns: **Response Syntax** { 'Bridges': [ { 'BridgeArn': 'string', 'BridgeState': 'CREATING'|'STANDBY'|'STARTING'|'DEPLOYING'|'ACTIVE'|'STOPPING'|'DELETING'|'DELETED'|'START_FAILED'|'START_PENDING'|'STOP_FAILED'|'UPDATING', 'BridgeType': 'string', 'Name': 'string', 'PlacementArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Bridges** *(list) --* A list of bridge summaries. * *(dict) --* Displays details of the selected bridge. * **BridgeArn** *(string) --* The ARN of the bridge. * **BridgeState** *(string) --* The state of the bridge. * **BridgeType** *(string) --* The type of the bridge. * **Name** *(string) --* The name of the bridge. * **PlacementArn** *(string) --* The ARN of the gateway associated with the bridge. * **NextToken** *(string) --* The token that identifies the batch of results that you want to see. For example, you submit a "ListBridges" 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 "ListBridges" request a second time and specify the "NextToken" value. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / grant_flow_entitlements grant_flow_entitlements *********************** MediaConnect.Client.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 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. Allowable encryption types: static-key, speke. * **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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 Amazon Web Services 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 Amazon Resource Name (ARN) of 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) --* * **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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 Amazon Web Services 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.BadRequestException" * "MediaConnect.Client.exceptions.GrantFlowEntitlements420Exceptio n" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / create_bridge create_bridge ************* MediaConnect.Client.create_bridge(**kwargs) Creates a new bridge. The request must include one source. See also: AWS API Documentation **Request Syntax** response = client.create_bridge( EgressGatewayBridge={ 'MaxBitrate': 123 }, IngressGatewayBridge={ 'MaxBitrate': 123, 'MaxOutputs': 123 }, Name='string', Outputs=[ { 'NetworkOutput': { 'IpAddress': 'string', 'Name': 'string', 'NetworkName': 'string', 'Port': 123, 'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq', 'Ttl': 123 } }, ], PlacementArn='string', SourceFailoverConfig={ 'FailoverMode': 'MERGE'|'FAILOVER', 'RecoveryWindow': 123, 'SourcePriority': { 'PrimarySource': 'string' }, 'State': 'ENABLED'|'DISABLED' }, Sources=[ { 'FlowSource': { 'FlowArn': 'string', 'FlowVpcInterfaceAttachment': { 'VpcInterfaceName': 'string' }, 'Name': 'string' }, 'NetworkSource': { 'MulticastIp': 'string', 'MulticastSourceSettings': { 'MulticastSourceIp': 'string' }, 'Name': 'string', 'NetworkName': 'string', 'Port': 123, 'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq' } }, ] ) Parameters: * **EgressGatewayBridge** (*dict*) -- An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises. * **MaxBitrate** *(integer) --* **[REQUIRED]** The maximum expected bitrate (in bps) of the egress bridge. * **IngressGatewayBridge** (*dict*) -- An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud. * **MaxBitrate** *(integer) --* **[REQUIRED]** The maximum expected bitrate (in bps) of the ingress bridge. * **MaxOutputs** *(integer) --* **[REQUIRED]** The maximum number of expected outputs on the ingress bridge. * **Name** (*string*) -- **[REQUIRED]** The name of the bridge. This name can not be modified after the bridge is created. * **Outputs** (*list*) -- The outputs that you want to add to this bridge. * *(dict) --* Add outputs to the specified bridge. * **NetworkOutput** *(dict) --* The network output of the bridge. A network output is delivered to your premises. * **IpAddress** *(string) --* **[REQUIRED]** The network output IP Address. * **Name** *(string) --* **[REQUIRED]** The network output name. This name is used to reference the output and must be unique among outputs in this bridge. * **NetworkName** *(string) --* **[REQUIRED]** The network output's gateway network name. * **Port** *(integer) --* **[REQUIRED]** The network output port. * **Protocol** *(string) --* **[REQUIRED]** The network output protocol. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **Ttl** *(integer) --* **[REQUIRED]** The network output TTL. * **PlacementArn** (*string*) -- **[REQUIRED]** The bridge placement Amazon Resource Number (ARN). * **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) --* The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources. * **Sources** (*list*) -- **[REQUIRED]** The sources that you want to add to this bridge. * *(dict) --* Add an output to a bridge. * **FlowSource** *(dict) --* The source of the flow. * **FlowArn** *(string) --* **[REQUIRED]** The Amazon Resource Number (ARN) of the flow to use as a source of this bridge. * **FlowVpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **Name** *(string) --* **[REQUIRED]** The name of the flow source. This name is used to reference the source and must be unique among sources in this bridge. * **NetworkSource** *(dict) --* The source of the network. * **MulticastIp** *(string) --* **[REQUIRED]** The network source multicast IP. * **MulticastSourceSettings** *(dict) --* The settings related to the multicast source. * **MulticastSourceIp** *(string) --* The IP address of the source for source-specific multicast (SSM). * **Name** *(string) --* **[REQUIRED]** The name of the network source. This name is used to reference the source and must be unique among sources in this bridge. * **NetworkName** *(string) --* **[REQUIRED]** The network source's gateway network name. * **Port** *(integer) --* **[REQUIRED]** The network source port. * **Protocol** *(string) --* **[REQUIRED]** The network source protocol. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. Return type: dict Returns: **Response Syntax** { 'Bridge': { 'BridgeArn': 'string', 'BridgeMessages': [ { 'Code': 'string', 'Message': 'string', 'ResourceName': 'string' }, ], 'BridgeState': 'CREATING'|'STANDBY'|'STARTING'|'DEPLOYING'|'ACTIVE'|'STOPPING'|'DELETING'|'DELETED'|'START_FAILED'|'START_PENDING'|'STOP_FAILED'|'UPDATING', 'EgressGatewayBridge': { 'InstanceId': 'string', 'MaxBitrate': 123 }, 'IngressGatewayBridge': { 'InstanceId': 'string', 'MaxBitrate': 123, 'MaxOutputs': 123 }, 'Name': 'string', 'Outputs': [ { 'FlowOutput': { 'FlowArn': 'string', 'FlowSourceArn': 'string', 'Name': 'string' }, 'NetworkOutput': { 'IpAddress': 'string', 'Name': 'string', 'NetworkName': 'string', 'Port': 123, 'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq', 'Ttl': 123 } }, ], 'PlacementArn': 'string', 'SourceFailoverConfig': { 'FailoverMode': 'MERGE'|'FAILOVER', 'RecoveryWindow': 123, 'SourcePriority': { 'PrimarySource': 'string' }, 'State': 'ENABLED'|'DISABLED' }, 'Sources': [ { 'FlowSource': { 'FlowArn': 'string', 'FlowVpcInterfaceAttachment': { 'VpcInterfaceName': 'string' }, 'Name': 'string', 'OutputArn': 'string' }, 'NetworkSource': { 'MulticastIp': 'string', 'MulticastSourceSettings': { 'MulticastSourceIp': 'string' }, 'Name': 'string', 'NetworkName': 'string', 'Port': 123, 'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq' } }, ] } } **Response Structure** * *(dict) --* * **Bridge** *(dict) --* The name of the bridge that was created. * **BridgeArn** *(string) --* The Amazon Resource Number (ARN) of the bridge. * **BridgeMessages** *(list) --* Messages with details about the bridge. * *(dict) --* The details of an error message. * **Code** *(string) --* The error code. * **Message** *(string) --* The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed. * **ResourceName** *(string) --* The name of the resource. * **BridgeState** *(string) --* The state of the bridge. * **EgressGatewayBridge** *(dict) --* An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises. * **InstanceId** *(string) --* The ID of the instance running this bridge. * **MaxBitrate** *(integer) --* The maximum expected bitrate (in bps) of the egress bridge. * **IngressGatewayBridge** *(dict) --* An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud. * **InstanceId** *(string) --* The ID of the instance running this bridge. * **MaxBitrate** *(integer) --* The maximum expected bitrate (in bps) of the ingress bridge. * **MaxOutputs** *(integer) --* The maximum number of outputs on the ingress bridge. * **Name** *(string) --* The name of the bridge. * **Outputs** *(list) --* The outputs on this bridge. * *(dict) --* The output of the bridge. * **FlowOutput** *(dict) --* The output of the associated flow. * **FlowArn** *(string) --* The Amazon Resource Number (ARN) of the cloud flow. * **FlowSourceArn** *(string) --* The Amazon Resource Number (ARN) of the flow source. * **Name** *(string) --* The name of the bridge's output. * **NetworkOutput** *(dict) --* The network output for the bridge. * **IpAddress** *(string) --* The network output IP address. * **Name** *(string) --* The network output name. * **NetworkName** *(string) --* The network output's gateway network name. * **Port** *(integer) --* The network output's port. * **Protocol** *(string) --* The network output protocol. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **Ttl** *(integer) --* The network output TTL. * **PlacementArn** *(string) --* The placement Amazon Resource Number (ARN) of the bridge. * **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) --* The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources. * **Sources** *(list) --* The sources on this bridge. * *(dict) --* The bridge's source. * **FlowSource** *(dict) --* The source of the associated flow. * **FlowArn** *(string) --* The ARN of the cloud flow used as a source of this bridge. * **FlowVpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **Name** *(string) --* The name of the flow source. * **OutputArn** *(string) --* The Amazon Resource Number (ARN) of the output. * **NetworkSource** *(dict) --* The network source for the bridge. * **MulticastIp** *(string) --* The network source multicast IP. * **MulticastSourceSettings** *(dict) --* The settings related to the multicast source. * **MulticastSourceIp** *(string) --* The IP address of the source for source-specific multicast (SSM). * **Name** *(string) --* The name of the network source. * **NetworkName** *(string) --* The network source's gateway network name. * **Port** *(integer) --* The network source port. * **Protocol** *(string) --* The network source protocol. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.CreateBridge420Exception" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / describe_flow describe_flow ************* MediaConnect.Client.describe_flow(**kwargs) Displays the details of a flow. The response includes the flow Amazon Resource Name (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'|'udp'|'ndi-speed-hq', 'RemoteId': 'string', 'SenderControlPort': 123, 'SenderIpAddress': 'string', 'SmoothingLatency': 123, 'SourceListenerAddress': 'string', 'SourceListenerPort': 123, 'StreamId': 'string', 'NdiSpeedHqQuality': 123, 'NdiProgramName': 'string' }, 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' }, 'BridgeArn': 'string', 'BridgePorts': [ 123, ], 'OutputStatus': 'ENABLED'|'DISABLED', 'PeerIpAddress': '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'|'udp'|'ndi-speed-hq', 'RemoteId': 'string', 'SenderControlPort': 123, 'SenderIpAddress': 'string', 'SmoothingLatency': 123, 'SourceListenerAddress': 'string', 'SourceListenerPort': 123, 'StreamId': 'string', 'NdiSpeedHqQuality': 123, 'NdiProgramName': 'string' }, 'VpcInterfaceName': 'string', 'WhitelistCidr': 'string', 'GatewayBridgeSource': { 'BridgeArn': 'string', 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' } }, 'PeerIpAddress': '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'|'udp'|'ndi-speed-hq', 'RemoteId': 'string', 'SenderControlPort': 123, 'SenderIpAddress': 'string', 'SmoothingLatency': 123, 'SourceListenerAddress': 'string', 'SourceListenerPort': 123, 'StreamId': 'string', 'NdiSpeedHqQuality': 123, 'NdiProgramName': 'string' }, 'VpcInterfaceName': 'string', 'WhitelistCidr': 'string', 'GatewayBridgeSource': { 'BridgeArn': 'string', 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' } }, 'PeerIpAddress': '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' }, 'SourceMonitoringConfig': { 'ThumbnailState': 'ENABLED'|'DISABLED', 'AudioMonitoringSettings': [ { 'SilentAudio': { 'State': 'ENABLED'|'DISABLED', 'ThresholdSeconds': 123 } }, ], 'ContentQualityAnalysisState': 'ENABLED'|'DISABLED', 'VideoMonitoringSettings': [ { 'BlackFrames': { 'State': 'ENABLED'|'DISABLED', 'ThresholdSeconds': 123 }, 'FrozenFrames': { 'State': 'ENABLED'|'DISABLED', 'ThresholdSeconds': 123 } }, ] }, 'FlowSize': 'MEDIUM'|'LARGE', 'NdiConfig': { 'NdiState': 'ENABLED'|'DISABLED', 'MachineName': 'string', 'NdiDiscoveryServers': [ { 'DiscoveryServerAddress': 'string', 'DiscoveryServerPort': 123, 'VpcInterfaceAdapter': 'string' }, ] } }, 'Messages': { 'Errors': [ 'string', ] } } **Response Structure** * *(dict) --* * **Flow** *(dict) --* The flow that you requested a description of. * **AvailabilityZone** *(string) --* The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services Region. * **Description** *(string) --* A description of the flow. This value is not used or seen outside of the current 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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 Amazon Web Services 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) 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 media stream represents one component of your content, such as video, audio, or ancillary data. After you add a media stream to your flow, you can associate it with sources and outputs that use the ST 2110 JPEG XS or CDI protocol. * **Attributes** *(dict) --* Attributes that are related 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 used for the representation of color. * **ExactFramerate** *(string) --* The frame rate for the video stream, in frames/second. For example: 60000/1001. * **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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 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 you want to associate with an outbound media stream. * **DestinationIp** *(string) --* The IP address where you want MediaConnect to send contents of the media stream. * **DestinationPort** *(integer) --* The port that you want MediaConnect to use when it distributes the media stream to the output. * **Interface** *(dict) --* The VPC interface that you want to use 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 or 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) --* 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) --* 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 (in bps) for RIST, RTP, and RTP-FEC streams. * **MaxLatency** *(integer) --* The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller-based streams. * **NdiSpeedHqQuality** *(integer) --* A quality setting for the NDI Speed HQ encoder. * **NdiProgramName** *(string) --* A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. * **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 resource. * **BridgeArn** *(string) --* The ARN of the bridge added to this output. * **BridgePorts** *(list) --* The bridge output ports currently in use. * *(integer) --* * **OutputStatus** *(string) --* An indication of whether the output is transmitting data or not. * **PeerIpAddress** *(string) --* The IP address of the device that is currently receiving content from this output. Note: * For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address. * For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver. * Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs. * The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address. * **Source** *(dict) --* The source for 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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 MediaConnect account. * **EntitlementArn** *(string) --* The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services 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 media streams that you want to associate with the source. * *(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) --* A name that helps you distinguish one media stream from another. * **Name** *(string) --* The name of the source. * **SenderControlPort** *(integer) --* The IP address that the flow communicates with to initiate connection with the sender. * **SenderIpAddress** *(string) --* The port that the flow uses to send outbound requests 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 (in bps) for RIST, RTP, and RTP-FEC streams. * **MaxLatency** *(integer) --* The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller- based streams. * **NdiSpeedHqQuality** *(integer) --* A quality setting for the NDI Speed HQ encoder. * **NdiProgramName** *(string) --* A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. * **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. * **GatewayBridgeSource** *(dict) --* The source configuration for cloud flows receiving a stream from a bridge. * **BridgeArn** *(string) --* The ARN of the bridge feeding this flow. * **VpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this bridge source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **PeerIpAddress** *(string) --* The IP address of the device that is currently sending content to this source. Note: * For sources that use protocols where you specify the origin (such as SRT Caller), this value matches the configured origin address. * For sources that use listener protocols (such as SRT Listener or RTP), this value shows the address of the connected sender. * Peer IP addresses aren't available for entitlements and CDI/ST2110 sources. * The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address. * **SourceFailoverConfig** *(dict) --* The settings for the 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) --* The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources. * **Sources** *(list) --* The settings for the sources that are assigned to the flow. * *(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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 MediaConnect account. * **EntitlementArn** *(string) --* The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services 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 media streams that you want to associate with the source. * *(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) --* A name that helps you distinguish one media stream from another. * **Name** *(string) --* The name of the source. * **SenderControlPort** *(integer) --* The IP address that the flow communicates with to initiate connection with the sender. * **SenderIpAddress** *(string) --* The port that the flow uses to send outbound requests 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 (in bps) for RIST, RTP, and RTP-FEC streams. * **MaxLatency** *(integer) --* The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller-based streams. * **NdiSpeedHqQuality** *(integer) --* A quality setting for the NDI Speed HQ encoder. * **NdiProgramName** *(string) --* A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. * **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. * **GatewayBridgeSource** *(dict) --* The source configuration for cloud flows receiving a stream from a bridge. * **BridgeArn** *(string) --* The ARN of the bridge feeding this flow. * **VpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this bridge source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **PeerIpAddress** *(string) --* The IP address of the device that is currently sending content to this source. Note: * For sources that use protocols where you specify the origin (such as SRT Caller), this value matches the configured origin address. * For sources that use listener protocols (such as SRT Listener or RTP), this value shows the address of the connected sender. * Peer IP addresses aren't available for entitlements and CDI/ST2110 sources. * The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address. * **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) --* A role Arn MediaConnect can assume to create ENIs in your 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 settings for the flow. * **MaintenanceDay** *(string) --* A day of a week when the maintenance will happen. Use M onday/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. * **SourceMonitoringConfig** *(dict) --* The settings for source monitoring. * **ThumbnailState** *(string) --* Indicates whether thumbnails are enabled or disabled. * **AudioMonitoringSettings** *(list) --* Contains the settings for audio stream metrics monitoring. * *(dict) --* Specifies the configuration for audio stream metrics monitoring. * **SilentAudio** *(dict) --* Detects periods of silence. * **State** *(string) --* Indicates whether the "SilentAudio" metric is enabled or disabled. * **ThresholdSeconds** *(integer) --* Specifies the number of consecutive seconds of silence that triggers an event or alert. * **ContentQualityAnalysisState** *(string) --* Indicates whether content quality analysis is enabled or disabled. * **VideoMonitoringSettings** *(list) --* Contains the settings for video stream metrics monitoring. * *(dict) --* Specifies the configuration for video stream metrics monitoring. * **BlackFrames** *(dict) --* Detects video frames that are black. * **State** *(string) --* Indicates whether the "BlackFrames" metric is enabled or disabled.. * **ThresholdSeconds** *(integer) --* Specifies the number of consecutive seconds of black frames that triggers an event or alert. * **FrozenFrames** *(dict) --* Detects video frames that have not changed. * **State** *(string) --* Indicates whether the "FrozenFrames" metric is enabled or disabled. * **ThresholdSeconds** *(integer) --* Specifies the number of consecutive seconds of a static image that triggers an event or alert. * **FlowSize** *(string) --* Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow. * **NdiConfig** *(dict) --* Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs. * **NdiState** *(string) --* A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED. * **MachineName** *(string) --* A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix. * **NdiDiscoveryServers** *(list) --* A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly. * *(dict) --* Specifies the configuration settings for individual NDI discovery servers. A maximum of 3 servers is allowed. * **DiscoveryServerAddress** *(string) --* The unique network address of the NDI discovery server. * **DiscoveryServerPort** *(integer) --* The port for the NDI discovery server. Defaults to 5959 if a custom port isn't specified. * **VpcInterfaceAdapter** *(string) --* The identifier for the Virtual Private Cloud (VPC) network interface used by the flow. * **Messages** *(dict) --* Any errors that apply currently to the flow. If there are no errors, MediaConnect will not include this field in the response. * **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.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / remove_flow_media_stream remove_flow_media_stream ************************ MediaConnect.Client.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 that you want to update. * **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) --* * **FlowArn** *(string) --* The ARN of the flow that was updated. * **MediaStreamName** *(string) --* The name of the media stream that was removed. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / deregister_gateway_instance deregister_gateway_instance *************************** MediaConnect.Client.deregister_gateway_instance(**kwargs) Deregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option. See also: AWS API Documentation **Request Syntax** response = client.deregister_gateway_instance( Force=True|False, GatewayInstanceArn='string' ) Parameters: * **Force** (*boolean*) -- Force the deregistration of an instance. Force will deregister an instance, even if there are bridges running on it. * **GatewayInstanceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the gateway that contains the instance that you want to deregister. Return type: dict Returns: **Response Syntax** { 'GatewayInstanceArn': 'string', 'InstanceState': 'REGISTERING'|'ACTIVE'|'DEREGISTERING'|'DEREGISTERED'|'REGISTRATION_ERROR'|'DEREGISTRATION_ERROR' } **Response Structure** * *(dict) --* * **GatewayInstanceArn** *(string) --* The ARN of the instance. * **InstanceState** *(string) --* The status of the instance. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / list_reservations list_reservations ***************** MediaConnect.Client.list_reservations(**kwargs) Displays a list of all reservations that have been purchased by this account in the current Amazon Web Services 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 the 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) --* * **NextToken** *(string) --* The token that identifies the 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 Amazon Web Services 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.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / delete_bridge delete_bridge ************* MediaConnect.Client.delete_bridge(**kwargs) Deletes a bridge. Before you can delete a bridge, you must stop the bridge. See also: AWS API Documentation **Request Syntax** response = client.delete_bridge( BridgeArn='string' ) Parameters: **BridgeArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the bridge that you want to delete. Return type: dict Returns: **Response Syntax** { 'BridgeArn': 'string' } **Response Structure** * *(dict) --* * **BridgeArn** *(string) --* The ARN of the deleted bridge. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / update_flow_output update_flow_output ****************** MediaConnect.Client.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'|'udp'|'ndi-speed-hq', RemoteId='string', SenderControlPort=123, SenderIpAddress='string', SmoothingLatency=123, StreamId='string', VpcInterfaceAttachment={ 'VpcInterfaceName': 'string' }, OutputStatus='ENABLED'|'DISABLED', NdiProgramName='string', NdiSpeedHqQuality=123 ) 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 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). Allowable encryption types: 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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 Amazon Resource Name (ARN) of 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 and Zixi-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 media streams that you want to associate with the output. * *(dict) --* The definition of a media stream that you want to associate with the output. * **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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller-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 resource. * **OutputStatus** (*string*) -- An indication of whether the output should transmit data or not. If you don't specify the "outputStatus" field in your request, MediaConnect leaves the value unchanged. * **NdiProgramName** (*string*) -- A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. * **NdiSpeedHqQuality** (*integer*) -- A quality setting for the NDI Speed HQ encoder. 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'|'udp'|'ndi-speed-hq', 'RemoteId': 'string', 'SenderControlPort': 123, 'SenderIpAddress': 'string', 'SmoothingLatency': 123, 'SourceListenerAddress': 'string', 'SourceListenerPort': 123, 'StreamId': 'string', 'NdiSpeedHqQuality': 123, 'NdiProgramName': 'string' }, 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' }, 'BridgeArn': 'string', 'BridgePorts': [ 123, ], 'OutputStatus': 'ENABLED'|'DISABLED', 'PeerIpAddress': 'string' } } **Response Structure** * *(dict) --* * **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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 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 you want to associate with an outbound media stream. * **DestinationIp** *(string) --* The IP address where you want MediaConnect to send contents of the media stream. * **DestinationPort** *(integer) --* The port that you want MediaConnect to use when it distributes the media stream to the output. * **Interface** *(dict) --* The VPC interface that you want to use 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 or 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) --* 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) --* 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 (in bps) for RIST, RTP, and RTP-FEC streams. * **MaxLatency** *(integer) --* The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller-based streams. * **NdiSpeedHqQuality** *(integer) --* A quality setting for the NDI Speed HQ encoder. * **NdiProgramName** *(string) --* A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. * **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 resource. * **BridgeArn** *(string) --* The ARN of the bridge added to this output. * **BridgePorts** *(list) --* The bridge output ports currently in use. * *(integer) --* * **OutputStatus** *(string) --* An indication of whether the output is transmitting data or not. * **PeerIpAddress** *(string) --* The IP address of the device that is currently receiving content from this output. Note: * For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address. * For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver. * Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs. * The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / update_bridge update_bridge ************* MediaConnect.Client.update_bridge(**kwargs) Updates the bridge. See also: AWS API Documentation **Request Syntax** response = client.update_bridge( BridgeArn='string', EgressGatewayBridge={ 'MaxBitrate': 123 }, IngressGatewayBridge={ 'MaxBitrate': 123, 'MaxOutputs': 123 }, SourceFailoverConfig={ 'FailoverMode': 'MERGE'|'FAILOVER', 'RecoveryWindow': 123, 'SourcePriority': { 'PrimarySource': 'string' }, 'State': 'ENABLED'|'DISABLED' } ) Parameters: * **BridgeArn** (*string*) -- **[REQUIRED]** TheAmazon Resource Name (ARN) of the bridge that you want to update. * **EgressGatewayBridge** (*dict*) -- A cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises. * **MaxBitrate** *(integer) --* The maximum expected bitrate (in bps). * **IngressGatewayBridge** (*dict*) -- A ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud. * **MaxBitrate** *(integer) --* The maximum expected bitrate (in bps). * **MaxOutputs** *(integer) --* The maximum number of expected outputs. * **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) --* The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources. Return type: dict Returns: **Response Syntax** { 'Bridge': { 'BridgeArn': 'string', 'BridgeMessages': [ { 'Code': 'string', 'Message': 'string', 'ResourceName': 'string' }, ], 'BridgeState': 'CREATING'|'STANDBY'|'STARTING'|'DEPLOYING'|'ACTIVE'|'STOPPING'|'DELETING'|'DELETED'|'START_FAILED'|'START_PENDING'|'STOP_FAILED'|'UPDATING', 'EgressGatewayBridge': { 'InstanceId': 'string', 'MaxBitrate': 123 }, 'IngressGatewayBridge': { 'InstanceId': 'string', 'MaxBitrate': 123, 'MaxOutputs': 123 }, 'Name': 'string', 'Outputs': [ { 'FlowOutput': { 'FlowArn': 'string', 'FlowSourceArn': 'string', 'Name': 'string' }, 'NetworkOutput': { 'IpAddress': 'string', 'Name': 'string', 'NetworkName': 'string', 'Port': 123, 'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq', 'Ttl': 123 } }, ], 'PlacementArn': 'string', 'SourceFailoverConfig': { 'FailoverMode': 'MERGE'|'FAILOVER', 'RecoveryWindow': 123, 'SourcePriority': { 'PrimarySource': 'string' }, 'State': 'ENABLED'|'DISABLED' }, 'Sources': [ { 'FlowSource': { 'FlowArn': 'string', 'FlowVpcInterfaceAttachment': { 'VpcInterfaceName': 'string' }, 'Name': 'string', 'OutputArn': 'string' }, 'NetworkSource': { 'MulticastIp': 'string', 'MulticastSourceSettings': { 'MulticastSourceIp': 'string' }, 'Name': 'string', 'NetworkName': 'string', 'Port': 123, 'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq' } }, ] } } **Response Structure** * *(dict) --* * **Bridge** *(dict) --* The bridge that was updated. * **BridgeArn** *(string) --* The Amazon Resource Number (ARN) of the bridge. * **BridgeMessages** *(list) --* Messages with details about the bridge. * *(dict) --* The details of an error message. * **Code** *(string) --* The error code. * **Message** *(string) --* The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed. * **ResourceName** *(string) --* The name of the resource. * **BridgeState** *(string) --* The state of the bridge. * **EgressGatewayBridge** *(dict) --* An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises. * **InstanceId** *(string) --* The ID of the instance running this bridge. * **MaxBitrate** *(integer) --* The maximum expected bitrate (in bps) of the egress bridge. * **IngressGatewayBridge** *(dict) --* An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud. * **InstanceId** *(string) --* The ID of the instance running this bridge. * **MaxBitrate** *(integer) --* The maximum expected bitrate (in bps) of the ingress bridge. * **MaxOutputs** *(integer) --* The maximum number of outputs on the ingress bridge. * **Name** *(string) --* The name of the bridge. * **Outputs** *(list) --* The outputs on this bridge. * *(dict) --* The output of the bridge. * **FlowOutput** *(dict) --* The output of the associated flow. * **FlowArn** *(string) --* The Amazon Resource Number (ARN) of the cloud flow. * **FlowSourceArn** *(string) --* The Amazon Resource Number (ARN) of the flow source. * **Name** *(string) --* The name of the bridge's output. * **NetworkOutput** *(dict) --* The network output for the bridge. * **IpAddress** *(string) --* The network output IP address. * **Name** *(string) --* The network output name. * **NetworkName** *(string) --* The network output's gateway network name. * **Port** *(integer) --* The network output's port. * **Protocol** *(string) --* The network output protocol. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **Ttl** *(integer) --* The network output TTL. * **PlacementArn** *(string) --* The placement Amazon Resource Number (ARN) of the bridge. * **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) --* The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources. * **Sources** *(list) --* The sources on this bridge. * *(dict) --* The bridge's source. * **FlowSource** *(dict) --* The source of the associated flow. * **FlowArn** *(string) --* The ARN of the cloud flow used as a source of this bridge. * **FlowVpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **Name** *(string) --* The name of the flow source. * **OutputArn** *(string) --* The Amazon Resource Number (ARN) of the output. * **NetworkSource** *(dict) --* The network source for the bridge. * **MulticastIp** *(string) --* The network source multicast IP. * **MulticastSourceSettings** *(dict) --* The settings related to the multicast source. * **MulticastSourceIp** *(string) --* The IP address of the source for source-specific multicast (SSM). * **Name** *(string) --* The name of the network source. * **NetworkName** *(string) --* The network source's gateway network name. * **Port** *(integer) --* The network source port. * **Protocol** *(string) --* The network source protocol. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / can_paginate can_paginate ************ MediaConnect.Client.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. MediaConnect / Client / describe_flow_source_metadata describe_flow_source_metadata ***************************** MediaConnect.Client.describe_flow_source_metadata(**kwargs) The "DescribeFlowSourceMetadata" API is used to view information about the flow's source transport stream and programs. This API displays status messages about the flow's source as well as details about the program's video, audio, and other data. See also: AWS API Documentation **Request Syntax** response = client.describe_flow_source_metadata( FlowArn='string' ) Parameters: **FlowArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the flow. Return type: dict Returns: **Response Syntax** { 'FlowArn': 'string', 'Messages': [ { 'Code': 'string', 'Message': 'string', 'ResourceName': 'string' }, ], 'Timestamp': datetime(2015, 1, 1), 'TransportMediaInfo': { 'Programs': [ { 'PcrPid': 123, 'ProgramName': 'string', 'ProgramNumber': 123, 'ProgramPid': 123, 'Streams': [ { 'Channels': 123, 'Codec': 'string', 'FrameRate': 'string', 'FrameResolution': { 'FrameHeight': 123, 'FrameWidth': 123 }, 'Pid': 123, 'SampleRate': 123, 'SampleSize': 123, 'StreamType': 'string' }, ] }, ] } } **Response Structure** * *(dict) --* * **FlowArn** *(string) --* The ARN of the flow that DescribeFlowSourceMetadata was performed on. * **Messages** *(list) --* Provides a status code and message regarding issues found with the flow source metadata. * *(dict) --* The details of an error message. * **Code** *(string) --* The error code. * **Message** *(string) --* The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed. * **ResourceName** *(string) --* The name of the resource. * **Timestamp** *(datetime) --* The timestamp of the most recent change in metadata for this flow’s source. * **TransportMediaInfo** *(dict) --* Information about the flow's transport media. * **Programs** *(list) --* The list of transport stream programs in the current flow's source. * *(dict) --* The metadata of a single transport stream program. * **PcrPid** *(integer) --* The Program Clock Reference (PCR) Packet ID (PID) as it is reported in the Program Association Table. * **ProgramName** *(string) --* The program name as it is reported in the Program Association Table. * **ProgramNumber** *(integer) --* The program number as it is reported in the Program Association Table. * **ProgramPid** *(integer) --* The program Packet ID (PID) as it is reported in the Program Association Table. * **Streams** *(list) --* The list of elementary transport streams in the program. The list includes video, audio, and data streams. * *(dict) --* The metadata of an elementary transport stream. * **Channels** *(integer) --* The number of channels in the audio stream. * **Codec** *(string) --* The codec used by the stream. * **FrameRate** *(string) --* The frame rate used by the video stream. * **FrameResolution** *(dict) --* The frame resolution used by the video stream. * **FrameHeight** *(integer) --* The number of pixels in the height of the video frame. * **FrameWidth** *(integer) --* The number of pixels in the width of the video frame. * **Pid** *(integer) --* The Packet ID (PID) as it is reported in the Program Map Table. * **SampleRate** *(integer) --* The sample rate used by the audio stream. * **SampleSize** *(integer) --* The sample bit size used by the audio stream. * **StreamType** *(string) --* The Stream Type as it is reported in the Program Map Table. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / add_bridge_outputs add_bridge_outputs ****************** MediaConnect.Client.add_bridge_outputs(**kwargs) Adds outputs to an existing bridge. See also: AWS API Documentation **Request Syntax** response = client.add_bridge_outputs( BridgeArn='string', Outputs=[ { 'NetworkOutput': { 'IpAddress': 'string', 'Name': 'string', 'NetworkName': 'string', 'Port': 123, 'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq', 'Ttl': 123 } }, ] ) Parameters: * **BridgeArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the bridge that you want to update. * **Outputs** (*list*) -- **[REQUIRED]** The outputs that you want to add to this bridge. * *(dict) --* Add outputs to the specified bridge. * **NetworkOutput** *(dict) --* The network output of the bridge. A network output is delivered to your premises. * **IpAddress** *(string) --* **[REQUIRED]** The network output IP Address. * **Name** *(string) --* **[REQUIRED]** The network output name. This name is used to reference the output and must be unique among outputs in this bridge. * **NetworkName** *(string) --* **[REQUIRED]** The network output's gateway network name. * **Port** *(integer) --* **[REQUIRED]** The network output port. * **Protocol** *(string) --* **[REQUIRED]** The network output protocol. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **Ttl** *(integer) --* **[REQUIRED]** The network output TTL. Return type: dict Returns: **Response Syntax** { 'BridgeArn': 'string', 'Outputs': [ { 'FlowOutput': { 'FlowArn': 'string', 'FlowSourceArn': 'string', 'Name': 'string' }, 'NetworkOutput': { 'IpAddress': 'string', 'Name': 'string', 'NetworkName': 'string', 'Port': 123, 'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq', 'Ttl': 123 } }, ] } **Response Structure** * *(dict) --* * **BridgeArn** *(string) --* The ARN of the bridge that you added outputs to. * **Outputs** *(list) --* The outputs that you added to this bridge. * *(dict) --* The output of the bridge. * **FlowOutput** *(dict) --* The output of the associated flow. * **FlowArn** *(string) --* The Amazon Resource Number (ARN) of the cloud flow. * **FlowSourceArn** *(string) --* The Amazon Resource Number (ARN) of the flow source. * **Name** *(string) --* The name of the bridge's output. * **NetworkOutput** *(dict) --* The network output for the bridge. * **IpAddress** *(string) --* The network output IP address. * **Name** *(string) --* The network output name. * **NetworkName** *(string) --* The network output's gateway network name. * **Port** *(integer) --* The network output's port. * **Protocol** *(string) --* The network output protocol. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **Ttl** *(integer) --* The network output TTL. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / describe_offering describe_offering ***************** MediaConnect.Client.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 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) --* * **Offering** *(dict) --* The offering that you requested a description of. * **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.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / remove_flow_output remove_flow_output ****************** MediaConnect.Client.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 Amazon Resource Name (ARN) of 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) --* * **FlowArn** *(string) --* The ARN of the flow that the output was removed from. * **OutputArn** *(string) --* The ARN of the output that was removed. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / describe_gateway describe_gateway **************** MediaConnect.Client.describe_gateway(**kwargs) Displays the details of a gateway. The response includes the gateway Amazon Resource Name (ARN), name, and CIDR blocks, as well as details about the networks. See also: AWS API Documentation **Request Syntax** response = client.describe_gateway( GatewayArn='string' ) Parameters: **GatewayArn** (*string*) -- **[REQUIRED]** The ARN of the gateway that you want to describe. Return type: dict Returns: **Response Syntax** { 'Gateway': { 'EgressCidrBlocks': [ 'string', ], 'GatewayArn': 'string', 'GatewayMessages': [ { 'Code': 'string', 'Message': 'string', 'ResourceName': 'string' }, ], 'GatewayState': 'CREATING'|'ACTIVE'|'UPDATING'|'ERROR'|'DELETING'|'DELETED', 'Name': 'string', 'Networks': [ { 'CidrBlock': 'string', 'Name': 'string' }, ] } } **Response Structure** * *(dict) --* * **Gateway** *(dict) --* The gateway that you wanted to describe. * **EgressCidrBlocks** *(list) --* The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. * *(string) --* * **GatewayArn** *(string) --* The Amazon Resource Name (ARN) of the gateway. * **GatewayMessages** *(list) --* Messages with information about the gateway. * *(dict) --* The details of an error message. * **Code** *(string) --* The error code. * **Message** *(string) --* The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed. * **ResourceName** *(string) --* The name of the resource. * **GatewayState** *(string) --* The current status of the gateway. * **Name** *(string) --* The name of the gateway. This name can not be modified after the gateway is created. * **Networks** *(list) --* The list of networks in the gateway. * *(dict) --* The network settings for a gateway. * **CidrBlock** *(string) --* A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. * **Name** *(string) --* The name of the network. This name is used to reference the network and must be unique among networks in this gateway. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / add_bridge_sources add_bridge_sources ****************** MediaConnect.Client.add_bridge_sources(**kwargs) Adds sources to an existing bridge. See also: AWS API Documentation **Request Syntax** response = client.add_bridge_sources( BridgeArn='string', Sources=[ { 'FlowSource': { 'FlowArn': 'string', 'FlowVpcInterfaceAttachment': { 'VpcInterfaceName': 'string' }, 'Name': 'string' }, 'NetworkSource': { 'MulticastIp': 'string', 'MulticastSourceSettings': { 'MulticastSourceIp': 'string' }, 'Name': 'string', 'NetworkName': 'string', 'Port': 123, 'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq' } }, ] ) Parameters: * **BridgeArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the bridge that you want to update. * **Sources** (*list*) -- **[REQUIRED]** The sources that you want to add to this bridge. * *(dict) --* Add an output to a bridge. * **FlowSource** *(dict) --* The source of the flow. * **FlowArn** *(string) --* **[REQUIRED]** The Amazon Resource Number (ARN) of the flow to use as a source of this bridge. * **FlowVpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **Name** *(string) --* **[REQUIRED]** The name of the flow source. This name is used to reference the source and must be unique among sources in this bridge. * **NetworkSource** *(dict) --* The source of the network. * **MulticastIp** *(string) --* **[REQUIRED]** The network source multicast IP. * **MulticastSourceSettings** *(dict) --* The settings related to the multicast source. * **MulticastSourceIp** *(string) --* The IP address of the source for source-specific multicast (SSM). * **Name** *(string) --* **[REQUIRED]** The name of the network source. This name is used to reference the source and must be unique among sources in this bridge. * **NetworkName** *(string) --* **[REQUIRED]** The network source's gateway network name. * **Port** *(integer) --* **[REQUIRED]** The network source port. * **Protocol** *(string) --* **[REQUIRED]** The network source protocol. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. Return type: dict Returns: **Response Syntax** { 'BridgeArn': 'string', 'Sources': [ { 'FlowSource': { 'FlowArn': 'string', 'FlowVpcInterfaceAttachment': { 'VpcInterfaceName': 'string' }, 'Name': 'string', 'OutputArn': 'string' }, 'NetworkSource': { 'MulticastIp': 'string', 'MulticastSourceSettings': { 'MulticastSourceIp': 'string' }, 'Name': 'string', 'NetworkName': 'string', 'Port': 123, 'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq' } }, ] } **Response Structure** * *(dict) --* * **BridgeArn** *(string) --* The ARN of the bridge that you added sources to. * **Sources** *(list) --* The sources that you added to this bridge. * *(dict) --* The bridge's source. * **FlowSource** *(dict) --* The source of the associated flow. * **FlowArn** *(string) --* The ARN of the cloud flow used as a source of this bridge. * **FlowVpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **Name** *(string) --* The name of the flow source. * **OutputArn** *(string) --* The Amazon Resource Number (ARN) of the output. * **NetworkSource** *(dict) --* The network source for the bridge. * **MulticastIp** *(string) --* The network source multicast IP. * **MulticastSourceSettings** *(dict) --* The settings related to the multicast source. * **MulticastSourceIp** *(string) --* The IP address of the source for source-specific multicast (SSM). * **Name** *(string) --* The name of the network source. * **NetworkName** *(string) --* The network source's gateway network name. * **Port** *(integer) --* The network source port. * **Protocol** *(string) --* The network source protocol. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / update_flow_source update_flow_source ****************** MediaConnect.Client.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'|'udp'|'ndi-speed-hq', SenderControlPort=123, SenderIpAddress='string', SourceArn='string', SourceListenerAddress='string', SourceListenerPort=123, StreamId='string', VpcInterfaceName='string', WhitelistCidr='string', GatewayBridgeSource={ 'BridgeArn': 'string', 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' } } ) Parameters: * **Decryption** (*dict*) -- The type of encryption that is used on the content ingested from the 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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 of the source. This description is not visible outside of the current Amazon Web Services account. * **EntitlementArn** (*string*) -- The Amazon Resource Name (ARN) of the entitlement that allows you to subscribe to the flow. The entitlement is set by the content originator, and the ARN is generated as part of the originator's flow. * **FlowArn** (*string*) -- **[REQUIRED]** The ARN of the flow that you want to update. * **IngestPort** (*integer*) -- The port that the flow listens on for incoming content. If the protocol of the source is Zixi, the port must be set to 2088. * **MaxBitrate** (*integer*) -- The maximum bitrate for RIST, RTP, and RTP-FEC streams. * **MaxLatency** (*integer*) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams. * **MaxSyncBuffer** (*integer*) -- The size of the buffer (in milliseconds) to use to sync incoming source data. * **MediaStreamSourceConfigurations** (*list*) -- The media stream that is associated with the source, and the parameters for that association. * *(dict) --* The media stream that you want to associate with the source, and the parameters for that association. * **EncodingName** *(string) --* **[REQUIRED]** 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 media streams that you want to associate with the source. * *(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 the source uses to deliver the content to MediaConnect. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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*) -- The 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 and SRT caller-based streams. * **VpcInterfaceName** (*string*) -- The name of the VPC interface that you want to send your output to. * **WhitelistCidr** (*string*) -- The range of IP addresses that are allowed to contribute content to your source. Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. * **GatewayBridgeSource** (*dict*) -- The source configuration for cloud flows receiving a stream from a bridge. * **BridgeArn** *(string) --* The ARN of the bridge feeding this flow. * **VpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this bridge source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. 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'|'udp'|'ndi-speed-hq', 'RemoteId': 'string', 'SenderControlPort': 123, 'SenderIpAddress': 'string', 'SmoothingLatency': 123, 'SourceListenerAddress': 'string', 'SourceListenerPort': 123, 'StreamId': 'string', 'NdiSpeedHqQuality': 123, 'NdiProgramName': 'string' }, 'VpcInterfaceName': 'string', 'WhitelistCidr': 'string', 'GatewayBridgeSource': { 'BridgeArn': 'string', 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' } }, 'PeerIpAddress': 'string' } } **Response Structure** * *(dict) --* * **FlowArn** *(string) --* The ARN of the flow that you was updated. * **Source** *(dict) --* The details of the sources that are assigned to 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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 MediaConnect account. * **EntitlementArn** *(string) --* The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services 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 media streams that you want to associate with the source. * *(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) --* A name that helps you distinguish one media stream from another. * **Name** *(string) --* The name of the source. * **SenderControlPort** *(integer) --* The IP address that the flow communicates with to initiate connection with the sender. * **SenderIpAddress** *(string) --* The port that the flow uses to send outbound requests 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 (in bps) for RIST, RTP, and RTP-FEC streams. * **MaxLatency** *(integer) --* The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller-based streams. * **NdiSpeedHqQuality** *(integer) --* A quality setting for the NDI Speed HQ encoder. * **NdiProgramName** *(string) --* A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. * **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. * **GatewayBridgeSource** *(dict) --* The source configuration for cloud flows receiving a stream from a bridge. * **BridgeArn** *(string) --* The ARN of the bridge feeding this flow. * **VpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this bridge source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **PeerIpAddress** *(string) --* The IP address of the device that is currently sending content to this source. Note: * For sources that use protocols where you specify the origin (such as SRT Caller), this value matches the configured origin address. * For sources that use listener protocols (such as SRT Listener or RTP), this value shows the address of the connected sender. * Peer IP addresses aren't available for entitlements and CDI/ST2110 sources. * The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / describe_bridge describe_bridge *************** MediaConnect.Client.describe_bridge(**kwargs) Displays the details of a bridge. See also: AWS API Documentation **Request Syntax** response = client.describe_bridge( BridgeArn='string' ) Parameters: **BridgeArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the bridge that you want to describe. Return type: dict Returns: **Response Syntax** { 'Bridge': { 'BridgeArn': 'string', 'BridgeMessages': [ { 'Code': 'string', 'Message': 'string', 'ResourceName': 'string' }, ], 'BridgeState': 'CREATING'|'STANDBY'|'STARTING'|'DEPLOYING'|'ACTIVE'|'STOPPING'|'DELETING'|'DELETED'|'START_FAILED'|'START_PENDING'|'STOP_FAILED'|'UPDATING', 'EgressGatewayBridge': { 'InstanceId': 'string', 'MaxBitrate': 123 }, 'IngressGatewayBridge': { 'InstanceId': 'string', 'MaxBitrate': 123, 'MaxOutputs': 123 }, 'Name': 'string', 'Outputs': [ { 'FlowOutput': { 'FlowArn': 'string', 'FlowSourceArn': 'string', 'Name': 'string' }, 'NetworkOutput': { 'IpAddress': 'string', 'Name': 'string', 'NetworkName': 'string', 'Port': 123, 'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq', 'Ttl': 123 } }, ], 'PlacementArn': 'string', 'SourceFailoverConfig': { 'FailoverMode': 'MERGE'|'FAILOVER', 'RecoveryWindow': 123, 'SourcePriority': { 'PrimarySource': 'string' }, 'State': 'ENABLED'|'DISABLED' }, 'Sources': [ { 'FlowSource': { 'FlowArn': 'string', 'FlowVpcInterfaceAttachment': { 'VpcInterfaceName': 'string' }, 'Name': 'string', 'OutputArn': 'string' }, 'NetworkSource': { 'MulticastIp': 'string', 'MulticastSourceSettings': { 'MulticastSourceIp': 'string' }, 'Name': 'string', 'NetworkName': 'string', 'Port': 123, 'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq' } }, ] } } **Response Structure** * *(dict) --* * **Bridge** *(dict) --* The bridge that you requested a description of. * **BridgeArn** *(string) --* The Amazon Resource Number (ARN) of the bridge. * **BridgeMessages** *(list) --* Messages with details about the bridge. * *(dict) --* The details of an error message. * **Code** *(string) --* The error code. * **Message** *(string) --* The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed. * **ResourceName** *(string) --* The name of the resource. * **BridgeState** *(string) --* The state of the bridge. * **EgressGatewayBridge** *(dict) --* An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises. * **InstanceId** *(string) --* The ID of the instance running this bridge. * **MaxBitrate** *(integer) --* The maximum expected bitrate (in bps) of the egress bridge. * **IngressGatewayBridge** *(dict) --* An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud. * **InstanceId** *(string) --* The ID of the instance running this bridge. * **MaxBitrate** *(integer) --* The maximum expected bitrate (in bps) of the ingress bridge. * **MaxOutputs** *(integer) --* The maximum number of outputs on the ingress bridge. * **Name** *(string) --* The name of the bridge. * **Outputs** *(list) --* The outputs on this bridge. * *(dict) --* The output of the bridge. * **FlowOutput** *(dict) --* The output of the associated flow. * **FlowArn** *(string) --* The Amazon Resource Number (ARN) of the cloud flow. * **FlowSourceArn** *(string) --* The Amazon Resource Number (ARN) of the flow source. * **Name** *(string) --* The name of the bridge's output. * **NetworkOutput** *(dict) --* The network output for the bridge. * **IpAddress** *(string) --* The network output IP address. * **Name** *(string) --* The network output name. * **NetworkName** *(string) --* The network output's gateway network name. * **Port** *(integer) --* The network output's port. * **Protocol** *(string) --* The network output protocol. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **Ttl** *(integer) --* The network output TTL. * **PlacementArn** *(string) --* The placement Amazon Resource Number (ARN) of the bridge. * **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) --* The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources. * **Sources** *(list) --* The sources on this bridge. * *(dict) --* The bridge's source. * **FlowSource** *(dict) --* The source of the associated flow. * **FlowArn** *(string) --* The ARN of the cloud flow used as a source of this bridge. * **FlowVpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **Name** *(string) --* The name of the flow source. * **OutputArn** *(string) --* The Amazon Resource Number (ARN) of the output. * **NetworkSource** *(dict) --* The network source for the bridge. * **MulticastIp** *(string) --* The network source multicast IP. * **MulticastSourceSettings** *(dict) --* The settings related to the multicast source. * **MulticastSourceIp** *(string) --* The IP address of the source for source-specific multicast (SSM). * **Name** *(string) --* The name of the network source. * **NetworkName** *(string) --* The network source's gateway network name. * **Port** *(integer) --* The network source port. * **Protocol** *(string) --* The network source protocol. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / list_tags_for_resource list_tags_for_resource ********************** MediaConnect.Client.list_tags_for_resource(**kwargs) List all tags on a 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 MediaConnect resource for which to list the tags. Return type: dict Returns: **Response Syntax** { 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **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.BadRequestException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" MediaConnect / Client / remove_flow_source remove_flow_source ****************** MediaConnect.Client.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 Amazon Resource Name (ARN) of 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) --* * **FlowArn** *(string) --* The ARN of the flow that the source was removed from. * **SourceArn** *(string) --* The ARN of the source that was removed. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / untag_resource untag_resource ************** MediaConnect.Client.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) of the resource that you want to untag. * **TagKeys** (*list*) -- **[REQUIRED]** The keys of the tags to be removed. * *(string) --* Returns: None **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" MediaConnect / Client / start_flow start_flow ********** MediaConnect.Client.start_flow(**kwargs) Starts a flow. See also: AWS API Documentation **Request Syntax** response = client.start_flow( FlowArn='string' ) Parameters: **FlowArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (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) --* * **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.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / describe_reservation describe_reservation ******************** MediaConnect.Client.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 offering. 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) --* * **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.TooManyRequestsException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / get_waiter get_waiter ********** MediaConnect.Client.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" MediaConnect / Client / list_flows list_flows ********** MediaConnect.Client.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 the 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) --* * **Flows** *(list) --* A list of flow summaries. * *(dict) --* 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 MediaConnect flow owned by another Amazon Web Services account) or entitled (originated at a MediaConnect flow owned by another Amazon Web Services account). * **Status** *(string) --* The current status of the flow. * **Maintenance** *(dict) --* The maintenance settings for the flow. * **MaintenanceDay** *(string) --* A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sun day. * **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 the 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.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / list_gateway_instances list_gateway_instances ********************** MediaConnect.Client.list_gateway_instances(**kwargs) Displays a list of instances associated with the Amazon Web Services account. This request returns a paginated result. You can use the filterArn property to display only the instances associated with the selected Gateway Amazon Resource Name (ARN). See also: AWS API Documentation **Request Syntax** response = client.list_gateway_instances( FilterArn='string', MaxResults=123, NextToken='string' ) Parameters: * **FilterArn** (*string*) -- Filter the list results to display only the instances associated with the selected Gateway ARN. * **MaxResults** (*integer*) -- The maximum number of results to return per API request. For example, you submit a ListInstances 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 the batch of results that you want to see. For example, you submit a "ListInstances" 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 "ListInstances" request a second time and specify the "NextToken" value. Return type: dict Returns: **Response Syntax** { 'Instances': [ { 'GatewayArn': 'string', 'GatewayInstanceArn': 'string', 'InstanceId': 'string', 'InstanceState': 'REGISTERING'|'ACTIVE'|'DEREGISTERING'|'DEREGISTERED'|'REGISTRATION_ERROR'|'DEREGISTRATION_ERROR' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Instances** *(list) --* A list of instance summaries. * *(dict) --* A summary of an instance. * **GatewayArn** *(string) --* The Amazon Resource Name (ARN) of the gateway. * **GatewayInstanceArn** *(string) --* The Amazon Resource Name (ARN) of the instance. * **InstanceId** *(string) --* The managed instance ID generated by the SSM install. This will begin with "mi-". * **InstanceState** *(string) --* The status of the instance. * **NextToken** *(string) --* The token that identifies the batch of results that you want to see. For example, you submit a "ListInstances" 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 "ListInstances" request a second time and specify the "NextToken" value. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / update_flow_media_stream update_flow_media_stream ************************ MediaConnect.Client.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 for the stream. This value in measured in kHz. * **Description** (*string*) -- A description that can help you quickly identify what your media stream is used for. * **FlowArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the flow that is associated with the media stream that you updated. * **MediaStreamName** (*string*) -- **[REQUIRED]** The media stream that you updated. * **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) --* * **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) --* The settings that you want to use to define the media stream. * **ChannelOrder** *(string) --* The format of the audio channel. * **Colorimetry** *(string) --* The format used for the representation of color. * **ExactFramerate** *(string) --* The frame rate for the video stream, in frames/second. For example: 60000/1001. * **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.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / remove_bridge_source remove_bridge_source ******************** MediaConnect.Client.remove_bridge_source(**kwargs) Removes a source from a bridge. See also: AWS API Documentation **Request Syntax** response = client.remove_bridge_source( BridgeArn='string', SourceName='string' ) Parameters: * **BridgeArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the bridge that you want to update. * **SourceName** (*string*) -- **[REQUIRED]** The name of the bridge source that you want to remove. Return type: dict Returns: **Response Syntax** { 'BridgeArn': 'string', 'SourceName': 'string' } **Response Structure** * *(dict) --* * **BridgeArn** *(string) --* The ARN of the bridge from which the source was removed. * **SourceName** *(string) --* The name of the bridge source that was removed. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / update_bridge_source update_bridge_source ******************** MediaConnect.Client.update_bridge_source(**kwargs) Updates an existing bridge source. See also: AWS API Documentation **Request Syntax** response = client.update_bridge_source( BridgeArn='string', FlowSource={ 'FlowArn': 'string', 'FlowVpcInterfaceAttachment': { 'VpcInterfaceName': 'string' } }, NetworkSource={ 'MulticastIp': 'string', 'MulticastSourceSettings': { 'MulticastSourceIp': 'string' }, 'NetworkName': 'string', 'Port': 123, 'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq' }, SourceName='string' ) Parameters: * **BridgeArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the bridge that you want to update. * **FlowSource** (*dict*) -- The name of the flow that you want to update. * **FlowArn** *(string) --* The Amazon Resource Name (ARN) that identifies the MediaConnect resource from which to delete tags. * **FlowVpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **NetworkSource** (*dict*) -- The network for the bridge source. * **MulticastIp** *(string) --* The network source multicast IP. * **MulticastSourceSettings** *(dict) --* The settings related to the multicast source. * **MulticastSourceIp** *(string) --* The IP address of the source for source-specific multicast (SSM). * **NetworkName** *(string) --* The network source's gateway network name. * **Port** *(integer) --* The network source port. * **Protocol** *(string) --* The network source protocol. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **SourceName** (*string*) -- **[REQUIRED]** The name of the source that you want to update. Return type: dict Returns: **Response Syntax** { 'BridgeArn': 'string', 'Source': { 'FlowSource': { 'FlowArn': 'string', 'FlowVpcInterfaceAttachment': { 'VpcInterfaceName': 'string' }, 'Name': 'string', 'OutputArn': 'string' }, 'NetworkSource': { 'MulticastIp': 'string', 'MulticastSourceSettings': { 'MulticastSourceIp': 'string' }, 'Name': 'string', 'NetworkName': 'string', 'Port': 123, 'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq' } } } **Response Structure** * *(dict) --* * **BridgeArn** *(string) --* The ARN of the updated bridge source. * **Source** *(dict) --* The updated bridge source. * **FlowSource** *(dict) --* The source of the associated flow. * **FlowArn** *(string) --* The ARN of the cloud flow used as a source of this bridge. * **FlowVpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **Name** *(string) --* The name of the flow source. * **OutputArn** *(string) --* The Amazon Resource Number (ARN) of the output. * **NetworkSource** *(dict) --* The network source for the bridge. * **MulticastIp** *(string) --* The network source multicast IP. * **MulticastSourceSettings** *(dict) --* The settings related to the multicast source. * **MulticastSourceIp** *(string) --* The IP address of the source for source-specific multicast (SSM). * **Name** *(string) --* The name of the network source. * **NetworkName** *(string) --* The network source's gateway network name. * **Port** *(integer) --* The network source port. * **Protocol** *(string) --* The network source protocol. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / add_flow_sources add_flow_sources **************** MediaConnect.Client.add_flow_sources(**kwargs) Adds sources to a 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'|'udp'|'ndi-speed-hq', 'SenderControlPort': 123, 'SenderIpAddress': 'string', 'SourceListenerAddress': 'string', 'SourceListenerPort': 123, 'StreamId': 'string', 'VpcInterfaceName': 'string', 'WhitelistCidr': 'string', 'GatewayBridgeSource': { 'BridgeArn': 'string', 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' } } }, ] ) Parameters: * **FlowArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the flow that you want to update. * **Sources** (*list*) -- **[REQUIRED]** A list of sources that you want to add to the flow. * *(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. Allowable encryption types: 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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 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 (in bps) for RIST, RTP, and RTP- FEC streams. * **MaxLatency** *(integer) --* The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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 media stream that you want to associate with the source, and the parameters for that association. * **EncodingName** *(string) --* **[REQUIRED]** 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 media streams that you want to associate with the source. * *(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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller-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. * **GatewayBridgeSource** *(dict) --* The source configuration for cloud flows receiving a stream from a bridge. * **BridgeArn** *(string) --* **[REQUIRED]** The ARN of the bridge feeding this flow. * **VpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this bridge source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. 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'|'udp'|'ndi-speed-hq', 'RemoteId': 'string', 'SenderControlPort': 123, 'SenderIpAddress': 'string', 'SmoothingLatency': 123, 'SourceListenerAddress': 'string', 'SourceListenerPort': 123, 'StreamId': 'string', 'NdiSpeedHqQuality': 123, 'NdiProgramName': 'string' }, 'VpcInterfaceName': 'string', 'WhitelistCidr': 'string', 'GatewayBridgeSource': { 'BridgeArn': 'string', 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' } }, 'PeerIpAddress': 'string' }, ] } **Response Structure** * *(dict) --* * **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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 MediaConnect account. * **EntitlementArn** *(string) --* The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services 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 media streams that you want to associate with the source. * *(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) --* A name that helps you distinguish one media stream from another. * **Name** *(string) --* The name of the source. * **SenderControlPort** *(integer) --* The IP address that the flow communicates with to initiate connection with the sender. * **SenderIpAddress** *(string) --* The port that the flow uses to send outbound requests 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 (in bps) for RIST, RTP, and RTP-FEC streams. * **MaxLatency** *(integer) --* The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller- based streams. * **NdiSpeedHqQuality** *(integer) --* A quality setting for the NDI Speed HQ encoder. * **NdiProgramName** *(string) --* A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. * **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. * **GatewayBridgeSource** *(dict) --* The source configuration for cloud flows receiving a stream from a bridge. * **BridgeArn** *(string) --* The ARN of the bridge feeding this flow. * **VpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this bridge source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **PeerIpAddress** *(string) --* The IP address of the device that is currently sending content to this source. Note: * For sources that use protocols where you specify the origin (such as SRT Caller), this value matches the configured origin address. * For sources that use listener protocols (such as SRT Listener or RTP), this value shows the address of the connected sender. * Peer IP addresses aren't available for entitlements and CDI/ST2110 sources. * The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / add_flow_vpc_interfaces add_flow_vpc_interfaces *********************** MediaConnect.Client.add_flow_vpc_interfaces(**kwargs) Adds VPC interfaces to a 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 Amazon Resource Name (ARN) of the flow that you want to update. * **VpcInterfaces** (*list*) -- **[REQUIRED]** A list of VPC interfaces that you want to add to the flow. * *(dict) --* The details of the VPC interfaces that you want to add to the flow. * **Name** *(string) --* **[REQUIRED]** The name for the VPC interface. This name must be unique within the flow. * **NetworkInterfaceType** *(string) --* The type of network interface. * **RoleArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the role that you created when you set up MediaConnect as a trusted service. * **SecurityGroupIds** *(list) --* **[REQUIRED]** A virtual firewall to control inbound and outbound traffic. * *(string) --* * **SubnetId** *(string) --* **[REQUIRED]** The subnet IDs that you want to use for your VPC interface. A range of IP addresses in your VPC. When you create your VPC, you specify a range of IPv4 addresses for the VPC in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. This is the primary CIDR block for your VPC. When you create a subnet for your VPC, you specify the CIDR block for the subnet, which is a subset of the VPC CIDR block. The subnets that you use across all VPC interfaces on the flow must be in the same Availability Zone as the flow. 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) --* * **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) --* A role Arn MediaConnect can assume to create ENIs in your 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.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / update_flow_entitlement update_flow_entitlement *********************** MediaConnect.Client.update_flow_entitlement(**kwargs) Updates an entitlement. 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 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. Allowable encryption types: static-key, speke. * **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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 Amazon Resource Name (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 ARN of the flow that is associated with the entitlement that you want to update. * **Subscribers** (*list*) -- The Amazon Web Services 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) --* * **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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 Amazon Web Services 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.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / add_flow_media_streams add_flow_media_streams ********************** MediaConnect.Client.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) --* * **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 media stream represents one component of your content, such as video, audio, or ancillary data. After you add a media stream to your flow, you can associate it with sources and outputs that use the ST 2110 JPEG XS or CDI protocol. * **Attributes** *(dict) --* Attributes that are related 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 used for the representation of color. * **ExactFramerate** *(string) --* The frame rate for the video stream, in frames/second. For example: 60000/1001. * **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.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / remove_flow_vpc_interface remove_flow_vpc_interface ************************* MediaConnect.Client.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 Amazon Resource Name (ARN) of 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) --* * **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 MediaConnect was unable to remove. * *(string) --* * **VpcInterfaceName** *(string) --* The name of the VPC interface that was removed. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / purchase_offering purchase_offering ***************** MediaConnect.Client.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) --* * **Reservation** *(dict) --* The details of the reservation that you just created when you purchased the offering. * **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.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / describe_gateway_instance describe_gateway_instance ************************* MediaConnect.Client.describe_gateway_instance(**kwargs) Displays the details of an instance. See also: AWS API Documentation **Request Syntax** response = client.describe_gateway_instance( GatewayInstanceArn='string' ) Parameters: **GatewayInstanceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the gateway instance that you want to describe. Return type: dict Returns: **Response Syntax** { 'GatewayInstance': { 'BridgePlacement': 'AVAILABLE'|'LOCKED', 'ConnectionStatus': 'CONNECTED'|'DISCONNECTED', 'GatewayArn': 'string', 'GatewayInstanceArn': 'string', 'InstanceId': 'string', 'InstanceMessages': [ { 'Code': 'string', 'Message': 'string', 'ResourceName': 'string' }, ], 'InstanceState': 'REGISTERING'|'ACTIVE'|'DEREGISTERING'|'DEREGISTERED'|'REGISTRATION_ERROR'|'DEREGISTRATION_ERROR', 'RunningBridgeCount': 123 } } **Response Structure** * *(dict) --* * **GatewayInstance** *(dict) --* The gateway instance that you requested a description of. * **BridgePlacement** *(string) --* The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be deployed to this instance. * **ConnectionStatus** *(string) --* The connection state of the instance. * **GatewayArn** *(string) --* The Amazon Resource Name (ARN) of the instance. * **GatewayInstanceArn** *(string) --* The ARN of the gateway. * **InstanceId** *(string) --* The instance ID generated by the SSM install. This will begin with "mi-". * **InstanceMessages** *(list) --* Messages with information about the gateway. * *(dict) --* The details of an error message. * **Code** *(string) --* The error code. * **Message** *(string) --* The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed. * **ResourceName** *(string) --* The name of the resource. * **InstanceState** *(string) --* The status of the instance. * **RunningBridgeCount** *(integer) --* The running bridge count. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / close close ***** MediaConnect.Client.close() Closes underlying endpoint connections. MediaConnect / Client / update_flow update_flow *********** MediaConnect.Client.update_flow(**kwargs) Updates an existing 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' }, SourceMonitoringConfig={ 'ThumbnailState': 'ENABLED'|'DISABLED', 'AudioMonitoringSettings': [ { 'SilentAudio': { 'State': 'ENABLED'|'DISABLED', 'ThresholdSeconds': 123 } }, ], 'ContentQualityAnalysisState': 'ENABLED'|'DISABLED', 'VideoMonitoringSettings': [ { 'BlackFrames': { 'State': 'ENABLED'|'DISABLED', 'ThresholdSeconds': 123 }, 'FrozenFrames': { 'State': 'ENABLED'|'DISABLED', 'ThresholdSeconds': 123 } }, ] }, NdiConfig={ 'NdiState': 'ENABLED'|'DISABLED', 'MachineName': 'string', 'NdiDiscoveryServers': [ { 'DiscoveryServerAddress': 'string', 'DiscoveryServerPort': 123, 'VpcInterfaceAdapter': 'string' }, ] } ) Parameters: * **FlowArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of 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) --* The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources. * **Maintenance** (*dict*) -- The maintenance setting of the flow. * **MaintenanceDay** *(string) --* A day of a week when the maintenance will happen. * **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. * **SourceMonitoringConfig** (*dict*) -- The settings for source monitoring. * **ThumbnailState** *(string) --* Indicates whether thumbnails are enabled or disabled. * **AudioMonitoringSettings** *(list) --* Contains the settings for audio stream metrics monitoring. * *(dict) --* Specifies the configuration for audio stream metrics monitoring. * **SilentAudio** *(dict) --* Detects periods of silence. * **State** *(string) --* Indicates whether the "SilentAudio" metric is enabled or disabled. * **ThresholdSeconds** *(integer) --* Specifies the number of consecutive seconds of silence that triggers an event or alert. * **ContentQualityAnalysisState** *(string) --* Indicates whether content quality analysis is enabled or disabled. * **VideoMonitoringSettings** *(list) --* Contains the settings for video stream metrics monitoring. * *(dict) --* Specifies the configuration for video stream metrics monitoring. * **BlackFrames** *(dict) --* Detects video frames that are black. * **State** *(string) --* Indicates whether the "BlackFrames" metric is enabled or disabled.. * **ThresholdSeconds** *(integer) --* Specifies the number of consecutive seconds of black frames that triggers an event or alert. * **FrozenFrames** *(dict) --* Detects video frames that have not changed. * **State** *(string) --* Indicates whether the "FrozenFrames" metric is enabled or disabled. * **ThresholdSeconds** *(integer) --* Specifies the number of consecutive seconds of a static image that triggers an event or alert. * **NdiConfig** (*dict*) -- Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs. * **NdiState** *(string) --* A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED. * **MachineName** *(string) --* A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix. * **NdiDiscoveryServers** *(list) --* A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly. * *(dict) --* Specifies the configuration settings for individual NDI discovery servers. A maximum of 3 servers is allowed. * **DiscoveryServerAddress** *(string) --* **[REQUIRED]** The unique network address of the NDI discovery server. * **DiscoveryServerPort** *(integer) --* The port for the NDI discovery server. Defaults to 5959 if a custom port isn't specified. * **VpcInterfaceAdapter** *(string) --* **[REQUIRED]** The identifier for the Virtual Private Cloud (VPC) network interface used by the flow. 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'|'udp'|'ndi-speed-hq', 'RemoteId': 'string', 'SenderControlPort': 123, 'SenderIpAddress': 'string', 'SmoothingLatency': 123, 'SourceListenerAddress': 'string', 'SourceListenerPort': 123, 'StreamId': 'string', 'NdiSpeedHqQuality': 123, 'NdiProgramName': 'string' }, 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' }, 'BridgeArn': 'string', 'BridgePorts': [ 123, ], 'OutputStatus': 'ENABLED'|'DISABLED', 'PeerIpAddress': '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'|'udp'|'ndi-speed-hq', 'RemoteId': 'string', 'SenderControlPort': 123, 'SenderIpAddress': 'string', 'SmoothingLatency': 123, 'SourceListenerAddress': 'string', 'SourceListenerPort': 123, 'StreamId': 'string', 'NdiSpeedHqQuality': 123, 'NdiProgramName': 'string' }, 'VpcInterfaceName': 'string', 'WhitelistCidr': 'string', 'GatewayBridgeSource': { 'BridgeArn': 'string', 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' } }, 'PeerIpAddress': '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'|'udp'|'ndi-speed-hq', 'RemoteId': 'string', 'SenderControlPort': 123, 'SenderIpAddress': 'string', 'SmoothingLatency': 123, 'SourceListenerAddress': 'string', 'SourceListenerPort': 123, 'StreamId': 'string', 'NdiSpeedHqQuality': 123, 'NdiProgramName': 'string' }, 'VpcInterfaceName': 'string', 'WhitelistCidr': 'string', 'GatewayBridgeSource': { 'BridgeArn': 'string', 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' } }, 'PeerIpAddress': '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' }, 'SourceMonitoringConfig': { 'ThumbnailState': 'ENABLED'|'DISABLED', 'AudioMonitoringSettings': [ { 'SilentAudio': { 'State': 'ENABLED'|'DISABLED', 'ThresholdSeconds': 123 } }, ], 'ContentQualityAnalysisState': 'ENABLED'|'DISABLED', 'VideoMonitoringSettings': [ { 'BlackFrames': { 'State': 'ENABLED'|'DISABLED', 'ThresholdSeconds': 123 }, 'FrozenFrames': { 'State': 'ENABLED'|'DISABLED', 'ThresholdSeconds': 123 } }, ] }, 'FlowSize': 'MEDIUM'|'LARGE', 'NdiConfig': { 'NdiState': 'ENABLED'|'DISABLED', 'MachineName': 'string', 'NdiDiscoveryServers': [ { 'DiscoveryServerAddress': 'string', 'DiscoveryServerPort': 123, 'VpcInterfaceAdapter': 'string' }, ] } } } **Response Structure** * *(dict) --* * **Flow** *(dict) --* The updated flow. * **AvailabilityZone** *(string) --* The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services Region. * **Description** *(string) --* A description of the flow. This value is not used or seen outside of the current 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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 Amazon Web Services 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) 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 media stream represents one component of your content, such as video, audio, or ancillary data. After you add a media stream to your flow, you can associate it with sources and outputs that use the ST 2110 JPEG XS or CDI protocol. * **Attributes** *(dict) --* Attributes that are related 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 used for the representation of color. * **ExactFramerate** *(string) --* The frame rate for the video stream, in frames/second. For example: 60000/1001. * **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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 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 you want to associate with an outbound media stream. * **DestinationIp** *(string) --* The IP address where you want MediaConnect to send contents of the media stream. * **DestinationPort** *(integer) --* The port that you want MediaConnect to use when it distributes the media stream to the output. * **Interface** *(dict) --* The VPC interface that you want to use 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 or 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) --* 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) --* 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 (in bps) for RIST, RTP, and RTP-FEC streams. * **MaxLatency** *(integer) --* The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller-based streams. * **NdiSpeedHqQuality** *(integer) --* A quality setting for the NDI Speed HQ encoder. * **NdiProgramName** *(string) --* A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. * **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 resource. * **BridgeArn** *(string) --* The ARN of the bridge added to this output. * **BridgePorts** *(list) --* The bridge output ports currently in use. * *(integer) --* * **OutputStatus** *(string) --* An indication of whether the output is transmitting data or not. * **PeerIpAddress** *(string) --* The IP address of the device that is currently receiving content from this output. Note: * For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address. * For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver. * Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs. * The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address. * **Source** *(dict) --* The source for 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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 MediaConnect account. * **EntitlementArn** *(string) --* The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services 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 media streams that you want to associate with the source. * *(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) --* A name that helps you distinguish one media stream from another. * **Name** *(string) --* The name of the source. * **SenderControlPort** *(integer) --* The IP address that the flow communicates with to initiate connection with the sender. * **SenderIpAddress** *(string) --* The port that the flow uses to send outbound requests 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 (in bps) for RIST, RTP, and RTP-FEC streams. * **MaxLatency** *(integer) --* The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller- based streams. * **NdiSpeedHqQuality** *(integer) --* A quality setting for the NDI Speed HQ encoder. * **NdiProgramName** *(string) --* A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. * **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. * **GatewayBridgeSource** *(dict) --* The source configuration for cloud flows receiving a stream from a bridge. * **BridgeArn** *(string) --* The ARN of the bridge feeding this flow. * **VpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this bridge source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **PeerIpAddress** *(string) --* The IP address of the device that is currently sending content to this source. Note: * For sources that use protocols where you specify the origin (such as SRT Caller), this value matches the configured origin address. * For sources that use listener protocols (such as SRT Listener or RTP), this value shows the address of the connected sender. * Peer IP addresses aren't available for entitlements and CDI/ST2110 sources. * The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address. * **SourceFailoverConfig** *(dict) --* The settings for the 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) --* The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources. * **Sources** *(list) --* The settings for the sources that are assigned to the flow. * *(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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 MediaConnect account. * **EntitlementArn** *(string) --* The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services 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 media streams that you want to associate with the source. * *(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) --* A name that helps you distinguish one media stream from another. * **Name** *(string) --* The name of the source. * **SenderControlPort** *(integer) --* The IP address that the flow communicates with to initiate connection with the sender. * **SenderIpAddress** *(string) --* The port that the flow uses to send outbound requests 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 (in bps) for RIST, RTP, and RTP-FEC streams. * **MaxLatency** *(integer) --* The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller-based streams. * **NdiSpeedHqQuality** *(integer) --* A quality setting for the NDI Speed HQ encoder. * **NdiProgramName** *(string) --* A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. * **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. * **GatewayBridgeSource** *(dict) --* The source configuration for cloud flows receiving a stream from a bridge. * **BridgeArn** *(string) --* The ARN of the bridge feeding this flow. * **VpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this bridge source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **PeerIpAddress** *(string) --* The IP address of the device that is currently sending content to this source. Note: * For sources that use protocols where you specify the origin (such as SRT Caller), this value matches the configured origin address. * For sources that use listener protocols (such as SRT Listener or RTP), this value shows the address of the connected sender. * Peer IP addresses aren't available for entitlements and CDI/ST2110 sources. * The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address. * **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) --* A role Arn MediaConnect can assume to create ENIs in your 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 settings for the flow. * **MaintenanceDay** *(string) --* A day of a week when the maintenance will happen. Use M onday/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. * **SourceMonitoringConfig** *(dict) --* The settings for source monitoring. * **ThumbnailState** *(string) --* Indicates whether thumbnails are enabled or disabled. * **AudioMonitoringSettings** *(list) --* Contains the settings for audio stream metrics monitoring. * *(dict) --* Specifies the configuration for audio stream metrics monitoring. * **SilentAudio** *(dict) --* Detects periods of silence. * **State** *(string) --* Indicates whether the "SilentAudio" metric is enabled or disabled. * **ThresholdSeconds** *(integer) --* Specifies the number of consecutive seconds of silence that triggers an event or alert. * **ContentQualityAnalysisState** *(string) --* Indicates whether content quality analysis is enabled or disabled. * **VideoMonitoringSettings** *(list) --* Contains the settings for video stream metrics monitoring. * *(dict) --* Specifies the configuration for video stream metrics monitoring. * **BlackFrames** *(dict) --* Detects video frames that are black. * **State** *(string) --* Indicates whether the "BlackFrames" metric is enabled or disabled.. * **ThresholdSeconds** *(integer) --* Specifies the number of consecutive seconds of black frames that triggers an event or alert. * **FrozenFrames** *(dict) --* Detects video frames that have not changed. * **State** *(string) --* Indicates whether the "FrozenFrames" metric is enabled or disabled. * **ThresholdSeconds** *(integer) --* Specifies the number of consecutive seconds of a static image that triggers an event or alert. * **FlowSize** *(string) --* Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow. * **NdiConfig** *(dict) --* Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs. * **NdiState** *(string) --* A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED. * **MachineName** *(string) --* A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix. * **NdiDiscoveryServers** *(list) --* A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly. * *(dict) --* Specifies the configuration settings for individual NDI discovery servers. A maximum of 3 servers is allowed. * **DiscoveryServerAddress** *(string) --* The unique network address of the NDI discovery server. * **DiscoveryServerPort** *(integer) --* The port for the NDI discovery server. Defaults to 5959 if a custom port isn't specified. * **VpcInterfaceAdapter** *(string) --* The identifier for the Virtual Private Cloud (VPC) network interface used by the flow. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / revoke_flow_entitlement revoke_flow_entitlement *********************** MediaConnect.Client.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 Amazon Resource Name (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) --* * **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.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / list_gateways list_gateways ************* MediaConnect.Client.list_gateways(**kwargs) Displays a list of gateways that are associated with this account. This request returns a paginated result. See also: AWS API Documentation **Request Syntax** response = client.list_gateways( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of results to return per API request. For example, you submit a "ListGateways" 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 the batch of results that you want to see. For example, you submit a "ListGateways" 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 "ListGateways" request a second time and specify the "NextToken" value. Return type: dict Returns: **Response Syntax** { 'Gateways': [ { 'GatewayArn': 'string', 'GatewayState': 'CREATING'|'ACTIVE'|'UPDATING'|'ERROR'|'DELETING'|'DELETED', 'Name': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Gateways** *(list) --* A list of gateway summaries. * *(dict) --* A summary of a gateway, including its name, ARN, and status. * **GatewayArn** *(string) --* The Amazon Resource Name (ARN) of the gateway. * **GatewayState** *(string) --* The status of the gateway. * **Name** *(string) --* The name of the gateway. * **NextToken** *(string) --* The token that identifies the batch of results that you want to see. For example, you submit a "ListGateways" 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 "ListGateways" request a second time and specify the "NextToken" value. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / create_flow create_flow *********** MediaConnect.Client.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'|'udp'|'ndi-speed-hq', 'RemoteId': 'string', 'SenderControlPort': 123, 'SmoothingLatency': 123, 'StreamId': 'string', 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' }, 'OutputStatus': 'ENABLED'|'DISABLED', 'NdiSpeedHqQuality': 123, 'NdiProgramName': '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'|'udp'|'ndi-speed-hq', 'SenderControlPort': 123, 'SenderIpAddress': 'string', 'SourceListenerAddress': 'string', 'SourceListenerPort': 123, 'StreamId': 'string', 'VpcInterfaceName': 'string', 'WhitelistCidr': 'string', 'GatewayBridgeSource': { 'BridgeArn': 'string', 'VpcInterfaceAttachment': { 'VpcInterfaceName': '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'|'udp'|'ndi-speed-hq', 'SenderControlPort': 123, 'SenderIpAddress': 'string', 'SourceListenerAddress': 'string', 'SourceListenerPort': 123, 'StreamId': 'string', 'VpcInterfaceName': 'string', 'WhitelistCidr': 'string', 'GatewayBridgeSource': { 'BridgeArn': 'string', 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' } } }, ], VpcInterfaces=[ { 'Name': 'string', 'NetworkInterfaceType': 'ena'|'efa', 'RoleArn': 'string', 'SecurityGroupIds': [ 'string', ], 'SubnetId': 'string' }, ], Maintenance={ 'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday', 'MaintenanceStartHour': 'string' }, SourceMonitoringConfig={ 'ThumbnailState': 'ENABLED'|'DISABLED', 'AudioMonitoringSettings': [ { 'SilentAudio': { 'State': 'ENABLED'|'DISABLED', 'ThresholdSeconds': 123 } }, ], 'ContentQualityAnalysisState': 'ENABLED'|'DISABLED', 'VideoMonitoringSettings': [ { 'BlackFrames': { 'State': 'ENABLED'|'DISABLED', 'ThresholdSeconds': 123 }, 'FrozenFrames': { 'State': 'ENABLED'|'DISABLED', 'ThresholdSeconds': 123 } }, ] }, FlowSize='MEDIUM'|'LARGE', NdiConfig={ 'NdiState': 'ENABLED'|'DISABLED', 'MachineName': 'string', 'NdiDiscoveryServers': [ { 'DiscoveryServerAddress': 'string', 'DiscoveryServerPort': 123, 'VpcInterfaceAdapter': '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 Amazon Web Services 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 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. Allowable encryption types: static-key, speke. * **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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 Amazon Web Services 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) --* A request to add an output to a 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 Audit Manager 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). Allowable encryption types: 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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 and Zixi-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 media streams that you want to associate with the output. * *(dict) --* The definition of a media stream that you want to associate with the output. * **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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller-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 resource. * **OutputStatus** *(string) --* An indication of whether the new output should be enabled or disabled as soon as it is created. If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED. * **NdiSpeedHqQuality** *(integer) --* A quality setting for the NDI Speed HQ encoder. * **NdiProgramName** *(string) --* A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. * **Source** (*dict*) -- The settings for the source that you want to use for the new flow. * **Decryption** *(dict) --* The type of encryption that is used on the content ingested from this source. Allowable encryption types: 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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 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 (in bps) for RIST, RTP, and RTP- FEC streams. * **MaxLatency** *(integer) --* The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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 media stream that you want to associate with the source, and the parameters for that association. * **EncodingName** *(string) --* **[REQUIRED]** 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 media streams that you want to associate with the source. * *(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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller-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. * **GatewayBridgeSource** *(dict) --* The source configuration for cloud flows receiving a stream from a bridge. * **BridgeArn** *(string) --* **[REQUIRED]** The ARN of the bridge feeding this flow. * **VpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this bridge source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **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) --* The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources. * **Sources** (*list*) -- The sources that are assigned to the flow. * *(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. Allowable encryption types: 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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 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 (in bps) for RIST, RTP, and RTP- FEC streams. * **MaxLatency** *(integer) --* The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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 media stream that you want to associate with the source, and the parameters for that association. * **EncodingName** *(string) --* **[REQUIRED]** 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 media streams that you want to associate with the source. * *(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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller-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. * **GatewayBridgeSource** *(dict) --* The source configuration for cloud flows receiving a stream from a bridge. * **BridgeArn** *(string) --* **[REQUIRED]** The ARN of the bridge feeding this flow. * **VpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this bridge source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **VpcInterfaces** (*list*) -- The VPC interfaces you want on the flow. * *(dict) --* The details of the VPC interfaces that you want to add to the flow. * **Name** *(string) --* **[REQUIRED]** The name for the VPC interface. This name must be unique within the flow. * **NetworkInterfaceType** *(string) --* The type of network interface. * **RoleArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the role that you created when you set up MediaConnect as a trusted service. * **SecurityGroupIds** *(list) --* **[REQUIRED]** A virtual firewall to control inbound and outbound traffic. * *(string) --* * **SubnetId** *(string) --* **[REQUIRED]** The subnet IDs that you want to use for your VPC interface. A range of IP addresses in your VPC. When you create your VPC, you specify a range of IPv4 addresses for the VPC in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. This is the primary CIDR block for your VPC. When you create a subnet for your VPC, you specify the CIDR block for the subnet, which is a subset of the VPC CIDR block. The subnets that you use across all VPC interfaces on the flow must be in the same Availability Zone as the flow. * **Maintenance** (*dict*) -- The maintenance settings you want to use for the flow. * **MaintenanceDay** *(string) --* **[REQUIRED]** A day of a week when the maintenance will happen. * **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. * **SourceMonitoringConfig** (*dict*) -- The settings for source monitoring. * **ThumbnailState** *(string) --* Indicates whether thumbnails are enabled or disabled. * **AudioMonitoringSettings** *(list) --* Contains the settings for audio stream metrics monitoring. * *(dict) --* Specifies the configuration for audio stream metrics monitoring. * **SilentAudio** *(dict) --* Detects periods of silence. * **State** *(string) --* Indicates whether the "SilentAudio" metric is enabled or disabled. * **ThresholdSeconds** *(integer) --* Specifies the number of consecutive seconds of silence that triggers an event or alert. * **ContentQualityAnalysisState** *(string) --* Indicates whether content quality analysis is enabled or disabled. * **VideoMonitoringSettings** *(list) --* Contains the settings for video stream metrics monitoring. * *(dict) --* Specifies the configuration for video stream metrics monitoring. * **BlackFrames** *(dict) --* Detects video frames that are black. * **State** *(string) --* Indicates whether the "BlackFrames" metric is enabled or disabled.. * **ThresholdSeconds** *(integer) --* Specifies the number of consecutive seconds of black frames that triggers an event or alert. * **FrozenFrames** *(dict) --* Detects video frames that have not changed. * **State** *(string) --* Indicates whether the "FrozenFrames" metric is enabled or disabled. * **ThresholdSeconds** *(integer) --* Specifies the number of consecutive seconds of a static image that triggers an event or alert. * **FlowSize** (*string*) -- Determines the processing capacity and feature set of the flow. Set this optional parameter to "LARGE" if you want to enable NDI outputs on the flow. * **NdiConfig** (*dict*) -- Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs. * **NdiState** *(string) --* A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED. * **MachineName** *(string) --* A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix. * **NdiDiscoveryServers** *(list) --* A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly. * *(dict) --* Specifies the configuration settings for individual NDI discovery servers. A maximum of 3 servers is allowed. * **DiscoveryServerAddress** *(string) --* **[REQUIRED]** The unique network address of the NDI discovery server. * **DiscoveryServerPort** *(integer) --* The port for the NDI discovery server. Defaults to 5959 if a custom port isn't specified. * **VpcInterfaceAdapter** *(string) --* **[REQUIRED]** The identifier for the Virtual Private Cloud (VPC) network interface used by the flow. 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'|'udp'|'ndi-speed-hq', 'RemoteId': 'string', 'SenderControlPort': 123, 'SenderIpAddress': 'string', 'SmoothingLatency': 123, 'SourceListenerAddress': 'string', 'SourceListenerPort': 123, 'StreamId': 'string', 'NdiSpeedHqQuality': 123, 'NdiProgramName': 'string' }, 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' }, 'BridgeArn': 'string', 'BridgePorts': [ 123, ], 'OutputStatus': 'ENABLED'|'DISABLED', 'PeerIpAddress': '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'|'udp'|'ndi-speed-hq', 'RemoteId': 'string', 'SenderControlPort': 123, 'SenderIpAddress': 'string', 'SmoothingLatency': 123, 'SourceListenerAddress': 'string', 'SourceListenerPort': 123, 'StreamId': 'string', 'NdiSpeedHqQuality': 123, 'NdiProgramName': 'string' }, 'VpcInterfaceName': 'string', 'WhitelistCidr': 'string', 'GatewayBridgeSource': { 'BridgeArn': 'string', 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' } }, 'PeerIpAddress': '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'|'udp'|'ndi-speed-hq', 'RemoteId': 'string', 'SenderControlPort': 123, 'SenderIpAddress': 'string', 'SmoothingLatency': 123, 'SourceListenerAddress': 'string', 'SourceListenerPort': 123, 'StreamId': 'string', 'NdiSpeedHqQuality': 123, 'NdiProgramName': 'string' }, 'VpcInterfaceName': 'string', 'WhitelistCidr': 'string', 'GatewayBridgeSource': { 'BridgeArn': 'string', 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' } }, 'PeerIpAddress': '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' }, 'SourceMonitoringConfig': { 'ThumbnailState': 'ENABLED'|'DISABLED', 'AudioMonitoringSettings': [ { 'SilentAudio': { 'State': 'ENABLED'|'DISABLED', 'ThresholdSeconds': 123 } }, ], 'ContentQualityAnalysisState': 'ENABLED'|'DISABLED', 'VideoMonitoringSettings': [ { 'BlackFrames': { 'State': 'ENABLED'|'DISABLED', 'ThresholdSeconds': 123 }, 'FrozenFrames': { 'State': 'ENABLED'|'DISABLED', 'ThresholdSeconds': 123 } }, ] }, 'FlowSize': 'MEDIUM'|'LARGE', 'NdiConfig': { 'NdiState': 'ENABLED'|'DISABLED', 'MachineName': 'string', 'NdiDiscoveryServers': [ { 'DiscoveryServerAddress': 'string', 'DiscoveryServerPort': 123, 'VpcInterfaceAdapter': 'string' }, ] } } } **Response Structure** * *(dict) --* * **Flow** *(dict) --* The flow that you created. * **AvailabilityZone** *(string) --* The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services Region. * **Description** *(string) --* A description of the flow. This value is not used or seen outside of the current 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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 Amazon Web Services 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) 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 media stream represents one component of your content, such as video, audio, or ancillary data. After you add a media stream to your flow, you can associate it with sources and outputs that use the ST 2110 JPEG XS or CDI protocol. * **Attributes** *(dict) --* Attributes that are related 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 used for the representation of color. * **ExactFramerate** *(string) --* The frame rate for the video stream, in frames/second. For example: 60000/1001. * **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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 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 you want to associate with an outbound media stream. * **DestinationIp** *(string) --* The IP address where you want MediaConnect to send contents of the media stream. * **DestinationPort** *(integer) --* The port that you want MediaConnect to use when it distributes the media stream to the output. * **Interface** *(dict) --* The VPC interface that you want to use 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 or 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) --* 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) --* 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 (in bps) for RIST, RTP, and RTP-FEC streams. * **MaxLatency** *(integer) --* The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller-based streams. * **NdiSpeedHqQuality** *(integer) --* A quality setting for the NDI Speed HQ encoder. * **NdiProgramName** *(string) --* A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. * **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 resource. * **BridgeArn** *(string) --* The ARN of the bridge added to this output. * **BridgePorts** *(list) --* The bridge output ports currently in use. * *(integer) --* * **OutputStatus** *(string) --* An indication of whether the output is transmitting data or not. * **PeerIpAddress** *(string) --* The IP address of the device that is currently receiving content from this output. Note: * For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address. * For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver. * Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs. * The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address. * **Source** *(dict) --* The source for 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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 MediaConnect account. * **EntitlementArn** *(string) --* The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services 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 media streams that you want to associate with the source. * *(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) --* A name that helps you distinguish one media stream from another. * **Name** *(string) --* The name of the source. * **SenderControlPort** *(integer) --* The IP address that the flow communicates with to initiate connection with the sender. * **SenderIpAddress** *(string) --* The port that the flow uses to send outbound requests 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 (in bps) for RIST, RTP, and RTP-FEC streams. * **MaxLatency** *(integer) --* The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller- based streams. * **NdiSpeedHqQuality** *(integer) --* A quality setting for the NDI Speed HQ encoder. * **NdiProgramName** *(string) --* A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. * **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. * **GatewayBridgeSource** *(dict) --* The source configuration for cloud flows receiving a stream from a bridge. * **BridgeArn** *(string) --* The ARN of the bridge feeding this flow. * **VpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this bridge source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **PeerIpAddress** *(string) --* The IP address of the device that is currently sending content to this source. Note: * For sources that use protocols where you specify the origin (such as SRT Caller), this value matches the configured origin address. * For sources that use listener protocols (such as SRT Listener or RTP), this value shows the address of the connected sender. * Peer IP addresses aren't available for entitlements and CDI/ST2110 sources. * The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address. * **SourceFailoverConfig** *(dict) --* The settings for the 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) --* The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources. * **Sources** *(list) --* The settings for the sources that are assigned to the flow. * *(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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 MediaConnect account. * **EntitlementArn** *(string) --* The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services 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 media streams that you want to associate with the source. * *(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) --* A name that helps you distinguish one media stream from another. * **Name** *(string) --* The name of the source. * **SenderControlPort** *(integer) --* The IP address that the flow communicates with to initiate connection with the sender. * **SenderIpAddress** *(string) --* The port that the flow uses to send outbound requests 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 (in bps) for RIST, RTP, and RTP-FEC streams. * **MaxLatency** *(integer) --* The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller-based streams. * **NdiSpeedHqQuality** *(integer) --* A quality setting for the NDI Speed HQ encoder. * **NdiProgramName** *(string) --* A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. * **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. * **GatewayBridgeSource** *(dict) --* The source configuration for cloud flows receiving a stream from a bridge. * **BridgeArn** *(string) --* The ARN of the bridge feeding this flow. * **VpcInterfaceAttachment** *(dict) --* The name of the VPC interface attachment to use for this bridge source. * **VpcInterfaceName** *(string) --* The name of the VPC interface to use for this resource. * **PeerIpAddress** *(string) --* The IP address of the device that is currently sending content to this source. Note: * For sources that use protocols where you specify the origin (such as SRT Caller), this value matches the configured origin address. * For sources that use listener protocols (such as SRT Listener or RTP), this value shows the address of the connected sender. * Peer IP addresses aren't available for entitlements and CDI/ST2110 sources. * The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address. * **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) --* A role Arn MediaConnect can assume to create ENIs in your 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 settings for the flow. * **MaintenanceDay** *(string) --* A day of a week when the maintenance will happen. Use M onday/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. * **SourceMonitoringConfig** *(dict) --* The settings for source monitoring. * **ThumbnailState** *(string) --* Indicates whether thumbnails are enabled or disabled. * **AudioMonitoringSettings** *(list) --* Contains the settings for audio stream metrics monitoring. * *(dict) --* Specifies the configuration for audio stream metrics monitoring. * **SilentAudio** *(dict) --* Detects periods of silence. * **State** *(string) --* Indicates whether the "SilentAudio" metric is enabled or disabled. * **ThresholdSeconds** *(integer) --* Specifies the number of consecutive seconds of silence that triggers an event or alert. * **ContentQualityAnalysisState** *(string) --* Indicates whether content quality analysis is enabled or disabled. * **VideoMonitoringSettings** *(list) --* Contains the settings for video stream metrics monitoring. * *(dict) --* Specifies the configuration for video stream metrics monitoring. * **BlackFrames** *(dict) --* Detects video frames that are black. * **State** *(string) --* Indicates whether the "BlackFrames" metric is enabled or disabled.. * **ThresholdSeconds** *(integer) --* Specifies the number of consecutive seconds of black frames that triggers an event or alert. * **FrozenFrames** *(dict) --* Detects video frames that have not changed. * **State** *(string) --* Indicates whether the "FrozenFrames" metric is enabled or disabled. * **ThresholdSeconds** *(integer) --* Specifies the number of consecutive seconds of a static image that triggers an event or alert. * **FlowSize** *(string) --* Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow. * **NdiConfig** *(dict) --* Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs. * **NdiState** *(string) --* A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED. * **MachineName** *(string) --* A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix. * **NdiDiscoveryServers** *(list) --* A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly. * *(dict) --* Specifies the configuration settings for individual NDI discovery servers. A maximum of 3 servers is allowed. * **DiscoveryServerAddress** *(string) --* The unique network address of the NDI discovery server. * **DiscoveryServerPort** *(integer) --* The port for the NDI discovery server. Defaults to 5959 if a custom port isn't specified. * **VpcInterfaceAdapter** *(string) --* The identifier for the Virtual Private Cloud (VPC) network interface used by the flow. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" * "MediaConnect.Client.exceptions.CreateFlow420Exception" MediaConnect / Client / delete_gateway delete_gateway ************** MediaConnect.Client.delete_gateway(**kwargs) Deletes a gateway. Before you can delete a gateway, you must deregister its instances and delete its bridges. See also: AWS API Documentation **Request Syntax** response = client.delete_gateway( GatewayArn='string' ) Parameters: **GatewayArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the gateway that you want to delete. Return type: dict Returns: **Response Syntax** { 'GatewayArn': 'string' } **Response Structure** * *(dict) --* * **GatewayArn** *(string) --* The ARN of the gateway that was deleted. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / list_entitlements list_entitlements ***************** MediaConnect.Client.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 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 the 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) --* * **Entitlements** *(list) --* A list of entitlements that have been granted to you from other Amazon Web Services accounts. * *(dict) --* An entitlement that has been granted to you from other Amazon Web Services 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 the 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.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / create_gateway create_gateway ************** MediaConnect.Client.create_gateway(**kwargs) Creates a new gateway. The request must include at least one network (up to four). See also: AWS API Documentation **Request Syntax** response = client.create_gateway( EgressCidrBlocks=[ 'string', ], Name='string', Networks=[ { 'CidrBlock': 'string', 'Name': 'string' }, ] ) Parameters: * **EgressCidrBlocks** (*list*) -- **[REQUIRED]** The range of IP addresses that are allowed to contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. * *(string) --* * **Name** (*string*) -- **[REQUIRED]** The name of the gateway. This name can not be modified after the gateway is created. * **Networks** (*list*) -- **[REQUIRED]** The list of networks that you want to add to the gateway. * *(dict) --* The network settings for a gateway. * **CidrBlock** *(string) --* **[REQUIRED]** A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter- Domain Routing (CIDR) block; for example, 10.0.0.0/16. * **Name** *(string) --* **[REQUIRED]** The name of the network. This name is used to reference the network and must be unique among networks in this gateway. Return type: dict Returns: **Response Syntax** { 'Gateway': { 'EgressCidrBlocks': [ 'string', ], 'GatewayArn': 'string', 'GatewayMessages': [ { 'Code': 'string', 'Message': 'string', 'ResourceName': 'string' }, ], 'GatewayState': 'CREATING'|'ACTIVE'|'UPDATING'|'ERROR'|'DELETING'|'DELETED', 'Name': 'string', 'Networks': [ { 'CidrBlock': 'string', 'Name': 'string' }, ] } } **Response Structure** * *(dict) --* * **Gateway** *(dict) --* The gateway that you created. * **EgressCidrBlocks** *(list) --* The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. * *(string) --* * **GatewayArn** *(string) --* The Amazon Resource Name (ARN) of the gateway. * **GatewayMessages** *(list) --* Messages with information about the gateway. * *(dict) --* The details of an error message. * **Code** *(string) --* The error code. * **Message** *(string) --* The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed. * **ResourceName** *(string) --* The name of the resource. * **GatewayState** *(string) --* The current status of the gateway. * **Name** *(string) --* The name of the gateway. This name can not be modified after the gateway is created. * **Networks** *(list) --* The list of networks in the gateway. * *(dict) --* The network settings for a gateway. * **CidrBlock** *(string) --* A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. * **Name** *(string) --* The name of the network. This name is used to reference the network and must be unique among networks in this gateway. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.CreateGateway420Exception" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / tag_resource tag_resource ************ MediaConnect.Client.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 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.BadRequestException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" MediaConnect / Client / update_gateway_instance update_gateway_instance *********************** MediaConnect.Client.update_gateway_instance(**kwargs) Updates an existing gateway instance. See also: AWS API Documentation **Request Syntax** response = client.update_gateway_instance( BridgePlacement='AVAILABLE'|'LOCKED', GatewayInstanceArn='string' ) Parameters: * **BridgePlacement** (*string*) -- The state of the instance. "ACTIVE" or "INACTIVE". * **GatewayInstanceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the gateway instance that you want to update. Return type: dict Returns: **Response Syntax** { 'BridgePlacement': 'AVAILABLE'|'LOCKED', 'GatewayInstanceArn': 'string' } **Response Structure** * *(dict) --* * **BridgePlacement** *(string) --* The state of the instance. "ACTIVE" or "INACTIVE". * **GatewayInstanceArn** *(string) --* The ARN of the instance that was updated. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / remove_bridge_output remove_bridge_output ******************** MediaConnect.Client.remove_bridge_output(**kwargs) Removes an output from a bridge. See also: AWS API Documentation **Request Syntax** response = client.remove_bridge_output( BridgeArn='string', OutputName='string' ) Parameters: * **BridgeArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the bridge that you want to update. * **OutputName** (*string*) -- **[REQUIRED]** The name of the bridge output that you want to remove. Return type: dict Returns: **Response Syntax** { 'BridgeArn': 'string', 'OutputName': 'string' } **Response Structure** * *(dict) --* * **BridgeArn** *(string) --* The ARN of the bridge from which the output was removed. * **OutputName** *(string) --* The name of the bridge output that was removed. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / update_bridge_state update_bridge_state ******************* MediaConnect.Client.update_bridge_state(**kwargs) Updates the bridge state. See also: AWS API Documentation **Request Syntax** response = client.update_bridge_state( BridgeArn='string', DesiredState='ACTIVE'|'STANDBY'|'DELETED' ) Parameters: * **BridgeArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the bridge that you want to update the state of. * **DesiredState** (*string*) -- **[REQUIRED]** The desired state for the bridge. Return type: dict Returns: **Response Syntax** { 'BridgeArn': 'string', 'DesiredState': 'ACTIVE'|'STANDBY'|'DELETED' } **Response Structure** * *(dict) --* * **BridgeArn** *(string) --* The ARN of the updated bridge. * **DesiredState** *(string) --* The new state of the bridge. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / stop_flow stop_flow ********* MediaConnect.Client.stop_flow(**kwargs) Stops a flow. See also: AWS API Documentation **Request Syntax** response = client.stop_flow( FlowArn='string' ) Parameters: **FlowArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (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) --* * **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.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / update_bridge_output update_bridge_output ******************** MediaConnect.Client.update_bridge_output(**kwargs) Updates an existing bridge output. See also: AWS API Documentation **Request Syntax** response = client.update_bridge_output( BridgeArn='string', NetworkOutput={ 'IpAddress': 'string', 'NetworkName': 'string', 'Port': 123, 'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq', 'Ttl': 123 }, OutputName='string' ) Parameters: * **BridgeArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the bridge that you want to update. * **NetworkOutput** (*dict*) -- The network of the bridge output. * **IpAddress** *(string) --* The network output IP Address. * **NetworkName** *(string) --* The network output's gateway network name. * **Port** *(integer) --* The network output port. * **Protocol** *(string) --* The network output protocol. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **Ttl** *(integer) --* The network output TTL. * **OutputName** (*string*) -- **[REQUIRED]** Tname of the output that you want to update. Return type: dict Returns: **Response Syntax** { 'BridgeArn': 'string', 'Output': { 'FlowOutput': { 'FlowArn': 'string', 'FlowSourceArn': 'string', 'Name': 'string' }, 'NetworkOutput': { 'IpAddress': 'string', 'Name': 'string', 'NetworkName': 'string', 'Port': 123, 'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq', 'Ttl': 123 } } } **Response Structure** * *(dict) --* * **BridgeArn** *(string) --* The ARN of the bridge that was updated. * **Output** *(dict) --* The bridge output that was updated. * **FlowOutput** *(dict) --* The output of the associated flow. * **FlowArn** *(string) --* The Amazon Resource Number (ARN) of the cloud flow. * **FlowSourceArn** *(string) --* The Amazon Resource Number (ARN) of the flow source. * **Name** *(string) --* The name of the bridge's output. * **NetworkOutput** *(dict) --* The network output for the bridge. * **IpAddress** *(string) --* The network output IP address. * **Name** *(string) --* The network output name. * **NetworkName** *(string) --* The network output's gateway network name. * **Port** *(integer) --* The network output's port. * **Protocol** *(string) --* The network output protocol. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **Ttl** *(integer) --* The network output TTL. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ConflictException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / add_flow_outputs add_flow_outputs **************** MediaConnect.Client.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'|'udp'|'ndi-speed-hq', 'RemoteId': 'string', 'SenderControlPort': 123, 'SmoothingLatency': 123, 'StreamId': 'string', 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' }, 'OutputStatus': 'ENABLED'|'DISABLED', 'NdiSpeedHqQuality': 123, 'NdiProgramName': 'string' }, ] ) Parameters: * **FlowArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the flow that you want to add outputs to. * **Outputs** (*list*) -- **[REQUIRED]** A list of outputs that you want to add to the flow. * *(dict) --* A request to add an output to a 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 Audit Manager 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). Allowable encryption types: 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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 and Zixi-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 media streams that you want to associate with the output. * *(dict) --* The definition of a media stream that you want to associate with the output. * **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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller-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 resource. * **OutputStatus** *(string) --* An indication of whether the new output should be enabled or disabled as soon as it is created. If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED. * **NdiSpeedHqQuality** *(integer) --* A quality setting for the NDI Speed HQ encoder. * **NdiProgramName** *(string) --* A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. 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'|'udp'|'ndi-speed-hq', 'RemoteId': 'string', 'SenderControlPort': 123, 'SenderIpAddress': 'string', 'SmoothingLatency': 123, 'SourceListenerAddress': 'string', 'SourceListenerPort': 123, 'StreamId': 'string', 'NdiSpeedHqQuality': 123, 'NdiProgramName': 'string' }, 'VpcInterfaceAttachment': { 'VpcInterfaceName': 'string' }, 'BridgeArn': 'string', 'BridgePorts': [ 123, ], 'OutputStatus': 'ENABLED'|'DISABLED', 'PeerIpAddress': 'string' }, ] } **Response Structure** * *(dict) --* * **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 Amazon Web Services 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 MediaConnect as a trusted entity). * **SecretArn** *(string) --* The ARN of the secret that you created in 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 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 you want to associate with an outbound media stream. * **DestinationIp** *(string) --* The IP address where you want MediaConnect to send contents of the media stream. * **DestinationPort** *(integer) --* The port that you want MediaConnect to use when it distributes the media stream to the output. * **Interface** *(dict) --* The VPC interface that you want to use 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 or 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) --* 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) --* 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 (in bps) for RIST, RTP, and RTP-FEC streams. * **MaxLatency** *(integer) --* The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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. Note: Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * **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 and SRT caller- based streams. * **NdiSpeedHqQuality** *(integer) --* A quality setting for the NDI Speed HQ encoder. * **NdiProgramName** *(string) --* A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. * **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 resource. * **BridgeArn** *(string) --* The ARN of the bridge added to this output. * **BridgePorts** *(list) --* The bridge output ports currently in use. * *(integer) --* * **OutputStatus** *(string) --* An indication of whether the output is transmitting data or not. * **PeerIpAddress** *(string) --* The IP address of the device that is currently receiving content from this output. Note: * For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address. * For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver. * Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs. * The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address. **Exceptions** * "MediaConnect.Client.exceptions.BadRequestException" * "MediaConnect.Client.exceptions.AddFlowOutputs420Exception" * "MediaConnect.Client.exceptions.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException" MediaConnect / Client / delete_flow delete_flow *********** MediaConnect.Client.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 Amazon Resource Name (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) --* * **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.TooManyRequestsException" * "MediaConnect.Client.exceptions.ForbiddenException" * "MediaConnect.Client.exceptions.InternalServerErrorException" * "MediaConnect.Client.exceptions.NotFoundException" * "MediaConnect.Client.exceptions.ServiceUnavailableException"