M2A Connect V3 (3.0)

Download OpenAPI specification:

E-mail: connect@m2ameda.tv License: Proprietary License

Manage video ingestion sources for AWS MediaConnect. Create and configure ingress flows with support for multiple protocols (SRT, RTP, RIST, Zixi, CDI, ST2110 JPEG-XS), set up redundant failover configurations, and monitor source health and metrics.

sources

Create, update, and manage video ingestion sources. Sources define how video content enters your MediaConnect infrastructure, including protocol configuration, geographic redundancy, failover settings, and VPC networking. Monitor source status and retrieve performance metrics to ensure reliable video delivery.

List all video ingestion sources

Retrieve all configured video sources for a target account. Each source represents a video ingestion point with its protocol configuration, ingress flows, provisioning status, and network settings. Use query parameters to filter results and control pagination.

Authorizations:

bearerAuth

path Parameters

organisation-id required	string <uuid> The ID of the owning Organistion.
target-account-id required	string <uuid> The ID of the owning Target Account.

query Parameters

include-deleted	boolean Option to return sources that have been marked as deleted.
include-hidden	boolean Option to return sources that have been marked as hidden.
inline	boolean Whether to inline the event data in the response. Default is `false`
last-evaluated-key	string <byte> The last evaluated key returned from the response. To be used to request the next page of results.
page-size	integer The maximum number of events that may be returned. A request may return fewer than the value of page-size.

Responses

Response samples

200
403
404

Content type

application/json

{"items": ["http://example.com"
]
}

Create a new video ingestion source

Create a new video source by defining ingress flows with protocol-specific configurations. Supports multiple protocols (SRT, RTP, RIST, Zixi, CDI, ST2110 JPEG-XS) and optional failover for redundancy. Configure VPC networking, encryption, and media stream definitions as needed. Names for flows, flow sources, VPC interfaces, and media streams are auto-generated if not provided.

Authorizations:

bearerAuth

path Parameters

organisation-id required	string <uuid> The ID of the owning Organistion.
target-account-id required	string <uuid> The ID of the owning Target Account.

Request Body schema: application/json
required

	object (alarm) Alarm configuration and status for monitoring source health
hidden	boolean Default: false Whether the source is hidden from listings
required	Array of objects = 1 items MediaConnect ingress flows for video content ingestion with geographic resiliency
required	object (standard_metadata) Metadata labels for organizing and identifying resources
proxy-enabled	boolean (proxy-enabled) Whether proxies are enabled for this source
proxy-tier	integer (proxy-tier) Proxy quality tier (1-5, higher accepts higher quality inputs)

Responses

Request samples

Payload

Content type

application/json

{"alarm": {"level": "TR_101_290_PRIORITY_1"
},
"hidden": false,
"ingress-flows": [{"name": "string",
"az": "string",
"failover-config": {"mode": "FAILOVER",
"primary-flow-source": "string"
},
"flow-sources": [{"protocol": "entitlement",
"name": "string",
"entitlement-arn": "string",
"decryption-settings": {"encryption-type": "AES128",
"key": "string"
},
"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
}
}
],
"media-streams": [{"name": "string",
"description": "string",
"stream-id": 0,
"stream-type": "ancillary-data",
"media-clock-rate": 90000
}
],
"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"region": "string",
"vpc-interfaces": [{"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"name": "string",
"network-interface-type": "ena",
"security-group-ids": ["string"
],
"subnet-id": "string"
}
]
}
],
"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"proxy-enabled": true,
"proxy-tier": 0
}

Response samples

201
400
403
404

Content type

application/json

{"alarm": {"level": "TR_101_290_PRIORITY_1"
},
"hidden": false,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ingress-flows": [{"name": "string",
"az": "string",
"failover-config": {"mode": "FAILOVER",
"primary-flow-source": "string"
},
"flow-sources": [{"protocol": "entitlement",
"name": "string",
"entitlement-arn": "string",
"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"decryption-settings": {"secret-id": "8535ae1a-28d8-4c24-b0ce-9abe31f0381c",
"encryption-type": "AES128",
"key": "string"
}
}
],
"media-streams": [{"name": "string",
"description": "string",
"stream-id": 0,
"stream-type": "ancillary-data",
"media-clock-rate": 90000
}
],
"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"region": "string",
"vpc-interfaces": [{"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"name": "string",
"network-interface-type": "ena",
"security-group-ids": ["string"
],
"subnet-id": "string"
}
]
}
],
"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"proxies": {"dash": {"url": "http://example.com"
}
},
"proxy-enabled": true,
"proxy-tier": 0,
"provisioned-flows": {"ingress-flows": [{"arn": "string",
"az": "string",
"flow-sources": [{"ip": "string",
"name": "string",
"port": 0,
"secret-arn": "string"
}
],
"name": "string",
"region": "string"
}
],
"egress-flows": [{"arn": "string",
"az": "string",
"region": "string",
"name": "string",
"ip": "string",
"port": 0
}
]
},
"provisioning-error-reason": "string",
"provisioning-status": "creation-pending",
"provisioning-status-timestamp": "2019-08-24T14:15:22Z"
}

Get a specific video source

Retrieve detailed configuration for a specific video source including all ingress flows, protocol settings, provisioning status, and provisioned MediaConnect flow details. Use this to verify source configuration or check provisioning progress. By default, sensitive decryption values (passphrases/keys) are masked for security and performance. Use '?include-passphrase=true' to retrieve decrypted values when needed.

Authorizations:

bearerAuth

path Parameters

organisation-id required	string <uuid> The ID of the owning Organistion.
target-account-id required	string <uuid> The ID of the owning Target Account.
source-id required	string <uuid> The ID of the Source.

query Parameters

include-passphrase

boolean

Default: false

Example: include-passphrase=true

Include decrypted passphrase/key values in decryption-settings. By default (false), sensitive values are masked for security and performance.

Responses

Response samples

200
403
404

Content type

application/json

{"alarm": {"level": "TR_101_290_PRIORITY_1"
},
"hidden": false,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ingress-flows": [{"name": "string",
"az": "string",
"failover-config": {"mode": "FAILOVER",
"primary-flow-source": "string"
},
"flow-sources": [{"protocol": "entitlement",
"name": "string",
"entitlement-arn": "string",
"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"decryption-settings": {"secret-id": "8535ae1a-28d8-4c24-b0ce-9abe31f0381c",
"encryption-type": "AES128",
"key": "string"
}
}
],
"media-streams": [{"name": "string",
"description": "string",
"stream-id": 0,
"stream-type": "ancillary-data",
"media-clock-rate": 90000
}
],
"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"region": "string",
"vpc-interfaces": [{"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"name": "string",
"network-interface-type": "ena",
"security-group-ids": ["string"
],
"subnet-id": "string"
}
]
}
],
"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"proxies": {"dash": {"url": "http://example.com"
}
},
"proxy-enabled": true,
"proxy-tier": 0,
"provisioned-flows": {"ingress-flows": [{"arn": "string",
"az": "string",
"flow-sources": [{"ip": "string",
"name": "string",
"port": 0,
"secret-arn": "string"
}
],
"name": "string",
"region": "string"
}
],
"egress-flows": [{"arn": "string",
"az": "string",
"region": "string",
"name": "string",
"ip": "string",
"port": 0
}
]
},
"provisioning-error-reason": "string",
"provisioning-status": "creation-pending",
"provisioning-status-timestamp": "2019-08-24T14:15:22Z"
}

Update an existing video source

Modify source configuration including ingress flows, protocol settings, failover configuration, delay settings, and visibility. Changes trigger reprovisioning of underlying MediaConnect resources. Names for flows, flow sources, VPC interfaces, and media streams are auto-generated if not provided.

Authorizations:

bearerAuth

path Parameters

organisation-id required	string <uuid> The ID of the owning Organistion.
target-account-id required	string <uuid> The ID of the owning Target Account.
source-id required	string <uuid> The ID of the Source.

Request Body schema: application/json
required

The Source update payload

	object (alarm) Alarm configuration and status for monitoring source health
hidden	boolean Default: false Whether the source is hidden from listings
	Array of objects = 1 items MediaConnect ingress flows for video content ingestion with geographic resiliency
	object (standard_metadata) Metadata labels for organizing and identifying resources
proxy-enabled	boolean (proxy-enabled) Whether proxies are enabled for this source
proxy-tier	integer (proxy-tier) Proxy quality tier (1-5, higher accepts higher quality inputs)

Responses

Request samples

Payload

Content type

application/json

{"alarm": {"level": "TR_101_290_PRIORITY_1"
},
"hidden": false,
"ingress-flows": [{"name": "string",
"az": "string",
"failover-config": {"mode": "FAILOVER",
"primary-flow-source": "string"
},
"flow-sources": [{"protocol": "entitlement",
"name": "string",
"entitlement-arn": "string",
"decryption-settings": {"encryption-type": "AES128",
"key": "string"
},
"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
}
}
],
"media-streams": [{"name": "string",
"description": "string",
"stream-id": 0,
"stream-type": "ancillary-data",
"media-clock-rate": 90000
}
],
"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"region": "string",
"vpc-interfaces": [{"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"name": "string",
"network-interface-type": "ena",
"security-group-ids": ["string"
],
"subnet-id": "string"
}
]
}
],
"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"proxy-enabled": true,
"proxy-tier": 0
}

Response samples

200
400
403
404
412

Content type

application/json

{"alarm": {"level": "TR_101_290_PRIORITY_1"
},
"hidden": false,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ingress-flows": [{"name": "string",
"az": "string",
"failover-config": {"mode": "FAILOVER",
"primary-flow-source": "string"
},
"flow-sources": [{"protocol": "entitlement",
"name": "string",
"entitlement-arn": "string",
"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"decryption-settings": {"secret-id": "8535ae1a-28d8-4c24-b0ce-9abe31f0381c",
"encryption-type": "AES128",
"key": "string"
}
}
],
"media-streams": [{"name": "string",
"description": "string",
"stream-id": 0,
"stream-type": "ancillary-data",
"media-clock-rate": 90000
}
],
"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"region": "string",
"vpc-interfaces": [{"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"name": "string",
"network-interface-type": "ena",
"security-group-ids": ["string"
],
"subnet-id": "string"
}
]
}
],
"metadata": {"labels": [{"key": "my-interesting-label",
"value": "This labels helpful value"
}
]
},
"proxies": {"dash": {"url": "http://example.com"
}
},
"proxy-enabled": true,
"proxy-tier": 0,
"provisioned-flows": {"ingress-flows": [{"arn": "string",
"az": "string",
"flow-sources": [{"ip": "string",
"name": "string",
"port": 0,
"secret-arn": "string"
}
],
"name": "string",
"region": "string"
}
],
"egress-flows": [{"arn": "string",
"az": "string",
"region": "string",
"name": "string",
"ip": "string",
"port": 0
}
]
},
"provisioning-error-reason": "string",
"provisioning-status": "creation-pending",
"provisioning-status-timestamp": "2019-08-24T14:15:22Z"
}

Delete a video source

Permanently delete a video source and deprovision all associated MediaConnect resources. This action cannot be undone. Active video streams will be interrupted.

Authorizations:

bearerAuth

path Parameters

organisation-id required	string <uuid> The ID of the owning Organistion.
target-account-id required	string <uuid> The ID of the owning Target Account.
source-id required	string <uuid> The ID of the Source.

Responses

Response samples

204
403
404

Content type

application/json

{"message": "Success"
}

Get source health status

Retrieve the current operational status of a video source including health indicators, error conditions, and connectivity state. Use this for monitoring and alerting on source availability.

Authorizations:

bearerAuth

path Parameters

organisation-id required	string <uuid> The ID of the owning Organistion.
target-account-id required	string <uuid> The ID of the owning Target Account.
source-id required	string <uuid> The ID of the Source.

Responses

Response samples

200
400
403
404

Content type

application/json

{"health": {"status": "healthy",
"reasons": ["InputNotConnected"
]
},
"running-status": "running"
}

Get source performance metrics

Retrieve time-series performance metrics for a video source including bitrate, packet loss, errors, and other quality indicators. Specify time range and desired metrics to analyze source performance and troubleshoot issues.

Authorizations:

bearerAuth

path Parameters

organisation-id required	string <uuid> The ID of the owning Organistion.
target-account-id required	string <uuid> The ID of the owning Target Account.
source-id required	string <uuid> The ID of the Source.

query Parameters

desired,	string A comma-seperated list of keys for desired metrics. Unknown keys are ignored.,
end-time	string <date-time> Example: end-time=2026-01-26T23:59:59Z The latest time in the desired time series in ISO 8601 format. If not provided, the current time is used.
start-time	string <date-time> Example: start-time=2026-01-20T00:00:00Z The earliest time in the desired time series in ISO 8601 format. If not provided, end-time minus 24H is used.

Responses

Response samples

200
403
404

Content type

application/json

{"series": [{"identity": "string",
"metrics": "string",
"samples": ["2019-08-24T14:15:22Z"
],
"values": [0
],
"unit": "string"
}
]
}

service-info

Retrieve stream metadata and service information for video sources. Access detailed program information, video/audio/data stream characteristics, codecs, frame rates, and other media properties detected from the video source. Currently limited to Transport Stream sources and ingress media instances.

List all service info for source media instances

Retrieve stream metadata for all media instances of a video source including program details, video/audio/data stream information, codecs, frame rates, and other media characteristics. Returns the latest service information for all pipelines and instance types.

Current Limitations: Currently limited to Transport Stream sources and ingress media instances only. Future support for other source types and egress instances.

Authorizations:

bearerAuth

path Parameters

organisation-id required	string <uuid> The ID of the owning Organistion.
target-account-id required	string <uuid> The ID of the owning Target Account.
source-id required	string <uuid> The ID of the Source.

Responses

Response samples

200
403
404
422

Content type

application/json

Example

Source with no media currently flowing

Shows a source with ingress instance but no active media stream

{"source-id": "c5277c7d-b06b-405e-b887-3b3f7be4e836",
"service-info-list": [{"pipeline-id": 0,
"type": "ingress",
"last-checked": "2026-01-14T16:32:19.000000+00:00",
"metadata-snapshot": {"last-updated": "2026-01-14T16:31:10.401000+00:00",
"transport-stream-media-info": {"programs": [ ]
}
}
}
]
}

M2A Connect V3 (3.0)

sources

List all video ingestion sources

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Create a new video ingestion source

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get a specific video source

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Update an existing video source

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete a video source

Authorizations:

path Parameters

Responses

Response samples

Get source health status

Authorizations:

path Parameters

Responses

Response samples

Get source performance metrics

Authorizations:

path Parameters

query Parameters

Responses

Response samples

service-info

List all service info for source media instances

Authorizations:

path Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required