The Flows API from Amazon MediaConnect — 14 operation(s) for flows.
openapi: 3.0.0
info:
version: 2018-11-14
x-release: v4
title: AWS MediaConnect Bridges Flows API
description: API for AWS Elemental MediaConnect
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: mediaconnect
x-aws-signingName: mediaconnect
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/mediaconnect-2018-11-14.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://mediaconnect.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS MediaConnect multi-region endpoint
- url: https://mediaconnect.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS MediaConnect multi-region endpoint
- url: http://mediaconnect.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS MediaConnect endpoint for China (Beijing) and China (Ningxia)
- url: https://mediaconnect.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS MediaConnect endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Flows
paths:
/v1/flows/{flowArn}/mediaStreams:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: AddFlowMediaStreams
description: 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.
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AddFlowMediaStreamsResponse'
examples:
AddFlowMediaStreams201Example:
summary: Default AddFlowMediaStreams 201 response
x-microcks-default: true
value:
FlowArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow
MediaStreams: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
AddFlowMediaStreams480Example:
summary: Default AddFlowMediaStreams 480 response
x-microcks-default: true
value:
result: success
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
AddFlowMediaStreams481Example:
summary: Default AddFlowMediaStreams 481 response
x-microcks-default: true
value:
result: success
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
AddFlowMediaStreams482Example:
summary: Default AddFlowMediaStreams 482 response
x-microcks-default: true
value:
result: success
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
AddFlowMediaStreams483Example:
summary: Default AddFlowMediaStreams 483 response
x-microcks-default: true
value:
result: success
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
AddFlowMediaStreams484Example:
summary: Default AddFlowMediaStreams 484 response
x-microcks-default: true
value:
result: success
'485':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
AddFlowMediaStreams485Example:
summary: Default AddFlowMediaStreams 485 response
x-microcks-default: true
value:
result: success
parameters:
- name: flowArn
in: path
required: true
description: The Amazon Resource Name (ARN) of the flow.
schema:
type: string
example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- mediaStreams
properties:
mediaStreams:
description: The media streams that you want to add to the flow.
type: array
items:
$ref: '#/components/schemas/AddMediaStreamRequest'
summary: Amazon MediaConnect Add Flow Media Streams
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Flows
/v1/flows/{flowArn}/outputs:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: AddFlowOutputs
description: Adds outputs to an existing flow. You can create up to 50 outputs per flow.
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AddFlowOutputsResponse'
examples:
AddFlowOutputs201Example:
summary: Default AddFlowOutputs 201 response
x-microcks-default: true
value:
FlowArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow
Outputs: example-value
'480':
description: AddFlowOutputs420Exception
content:
application/json:
schema:
$ref: '#/components/schemas/AddFlowOutputs420Exception'
examples:
AddFlowOutputs480Example:
summary: Default AddFlowOutputs 480 response
x-microcks-default: true
value:
result: success
'481':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
AddFlowOutputs481Example:
summary: Default AddFlowOutputs 481 response
x-microcks-default: true
value:
result: success
'482':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
AddFlowOutputs482Example:
summary: Default AddFlowOutputs 482 response
x-microcks-default: true
value:
result: success
'483':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
AddFlowOutputs483Example:
summary: Default AddFlowOutputs 483 response
x-microcks-default: true
value:
result: success
'484':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
AddFlowOutputs484Example:
summary: Default AddFlowOutputs 484 response
x-microcks-default: true
value:
result: success
'485':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
AddFlowOutputs485Example:
summary: Default AddFlowOutputs 485 response
x-microcks-default: true
value:
result: success
'486':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
AddFlowOutputs486Example:
summary: Default AddFlowOutputs 486 response
x-microcks-default: true
value:
result: success
parameters:
- name: flowArn
in: path
required: true
description: The flow that you want to add outputs to.
schema:
type: string
example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- outputs
properties:
outputs:
description: A list of outputs that you want to add.
type: array
items:
$ref: '#/components/schemas/AddOutputRequest'
summary: Amazon MediaConnect Add Flow Outputs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Flows
/v1/flows/{flowArn}/source:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: AddFlowSources
description: Adds Sources to flow
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AddFlowSourcesResponse'
examples:
AddFlowSources201Example:
summary: Default AddFlowSources 201 response
x-microcks-default: true
value:
FlowArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow
Sources: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
AddFlowSources480Example:
summary: Default AddFlowSources 480 response
x-microcks-default: true
value:
result: success
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
AddFlowSources481Example:
summary: Default AddFlowSources 481 response
x-microcks-default: true
value:
result: success
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
AddFlowSources482Example:
summary: Default AddFlowSources 482 response
x-microcks-default: true
value:
result: success
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
AddFlowSources483Example:
summary: Default AddFlowSources 483 response
x-microcks-default: true
value:
result: success
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
AddFlowSources484Example:
summary: Default AddFlowSources 484 response
x-microcks-default: true
value:
result: success
'485':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
AddFlowSources485Example:
summary: Default AddFlowSources 485 response
x-microcks-default: true
value:
result: success
parameters:
- name: flowArn
in: path
required: true
description: The flow that you want to mutate.
schema:
type: string
example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- sources
properties:
sources:
description: A list of sources that you want to add.
type: array
items:
$ref: '#/components/schemas/SetSourceRequest'
summary: Amazon MediaConnect Add Flow Sources
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Flows
/v1/flows/{flowArn}/vpcInterfaces:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: AddFlowVpcInterfaces
description: Adds VPC interfaces to flow
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AddFlowVpcInterfacesResponse'
examples:
AddFlowVpcInterfaces201Example:
summary: Default AddFlowVpcInterfaces 201 response
x-microcks-default: true
value:
FlowArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow
VpcInterfaces: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
AddFlowVpcInterfaces480Example:
summary: Default AddFlowVpcInterfaces 480 response
x-microcks-default: true
value:
result: success
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
AddFlowVpcInterfaces481Example:
summary: Default AddFlowVpcInterfaces 481 response
x-microcks-default: true
value:
result: success
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
AddFlowVpcInterfaces482Example:
summary: Default AddFlowVpcInterfaces 482 response
x-microcks-default: true
value:
result: success
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
AddFlowVpcInterfaces483Example:
summary: Default AddFlowVpcInterfaces 483 response
x-microcks-default: true
value:
result: success
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
AddFlowVpcInterfaces484Example:
summary: Default AddFlowVpcInterfaces 484 response
x-microcks-default: true
value:
result: success
'485':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
AddFlowVpcInterfaces485Example:
summary: Default AddFlowVpcInterfaces 485 response
x-microcks-default: true
value:
result: success
parameters:
- name: flowArn
in: path
required: true
description: The flow that you want to mutate.
schema:
type: string
example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- vpcInterfaces
properties:
vpcInterfaces:
description: A list of VPC interfaces that you want to add.
type: array
items:
$ref: '#/components/schemas/VpcInterfaceRequest'
summary: Amazon MediaConnect Add Flow Vpc Interfaces
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Flows
/v1/flows:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateFlow
description: Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFlowResponse'
examples:
CreateFlow201Example:
summary: Default CreateFlow 201 response
x-microcks-default: true
value:
Flow: example-value
'480':
description: CreateFlow420Exception
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFlow420Exception'
examples:
CreateFlow480Example:
summary: Default CreateFlow 480 response
x-microcks-default: true
value:
result: success
'481':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
CreateFlow481Example:
summary: Default CreateFlow 481 response
x-microcks-default: true
value:
result: success
'482':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
CreateFlow482Example:
summary: Default CreateFlow 482 response
x-microcks-default: true
value:
result: success
'483':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
CreateFlow483Example:
summary: Default CreateFlow 483 response
x-microcks-default: true
value:
result: success
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
CreateFlow484Example:
summary: Default CreateFlow 484 response
x-microcks-default: true
value:
result: success
'485':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
CreateFlow485Example:
summary: Default CreateFlow 485 response
x-microcks-default: true
value:
result: success
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
properties:
availabilityZone:
description: The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region.
type: string
entitlements:
description: The entitlements that you want to grant on a flow.
type: array
items:
$ref: '#/components/schemas/GrantEntitlementRequest'
mediaStreams:
description: The media streams that you want to add to the flow. You can associate these media streams with sources and outputs on the flow.
type: array
items:
$ref: '#/components/schemas/AddMediaStreamRequest'
name:
description: The name of the flow.
type: string
outputs:
description: The outputs that you want to add to this flow.
type: array
items:
$ref: '#/components/schemas/AddOutputRequest'
source:
description: The settings for the source of the flow.
type: object
properties:
Decryption:
allOf:
- $ref: '#/components/schemas/Encryption'
- xml:
name: decryption
description: 'The type of encryption that is used on the content ingested from this source. Allowable encryption types: static-key.'
Description:
allOf:
- $ref: '#/components/schemas/__string'
- xml:
name: description
description: A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn:
allOf:
- $ref: '#/components/schemas/__string'
- pattern: ^arn:.+:mediaconnect.+:entitlement:.+$
xml:
name: entitlementArn
description: 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:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: ingestPort
description: The port that the flow will be listening on for incoming content.
MaxBitrate:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: maxBitrate
description: The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
MaxLatency:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: maxLatency
description: The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MaxSyncBuffer:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: maxSyncBuffer
description: The size of the buffer (in milliseconds) to use to sync incoming source data.
MediaStreamSourceConfigurations:
allOf:
- $ref: '#/components/schemas/__listOfMediaStreamSourceConfigurationRequest'
- xml:
name: mediaStreamSourceConfigurations
description: The media streams that are associated with the source, and the parameters for those associations.
MinLatency:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: minLatency
description: 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:
allOf:
- $ref: '#/components/schemas/__string'
- xml:
name: name
description: The name of the source.
Protocol:
allOf:
- $ref: '#/components/schemas/Protocol'
- xml:
name: protocol
description: The protocol that is used by the source.
SenderControlPort:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: senderControlPort
description: The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderIpAddress:
allOf:
- $ref: '#/components/schemas/__string'
- xml:
name: senderIpAddress
description: The IP address that the flow communicates with to initiate connection with the sender.
SourceListenerAddress:
allOf:
- $ref: '#/components/schemas/__string'
- xml:
name: sourceListenerAddress
description: Source IP or domain name for SRT-caller protocol.
SourceListenerPort:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: sourceListenerPort
description: Source port for SRT-caller protocol.
StreamId:
allOf:
- $ref: '#/components/schemas/__string'
- xml:
name: streamId
description: The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceName:
allOf:
- $ref: '#/components/schemas/__string'
- xml:
# --- truncated at 32 KB (203 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-mediaconnect/refs/heads/main/openapi/amazon-mediaconnect-flows-api-openapi.yml