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: name: vpcInterfaceName description: The name of the VPC interface to use for this source. WhitelistCidr: allOf: - $ref: '#/components/schemas/__string' - xml: name: whitelistCidr description: 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: allOf: - $ref: '#/components/schemas/SetGatewayBridgeSourceRequest' - xml: name: gatewayBridgeSource description: The source configuration for cloud flows receiving a stream from a bridge. sourceFailoverConfig: description: The settings for source failover. type: object properties: FailoverMode: allOf: - $ref: '#/components/schemas/FailoverMode' - xml: name: failoverMode description: 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: allOf: - $ref: '#/components/schemas/__integer' - xml: name: recoveryWindow description: Search window time to look for dash-7 packets SourcePriority: allOf: - $ref: '#/components/schemas/SourcePriority' - xml: name: sourcePriority description: The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams. State: allOf: - $ref: '#/components/schemas/State' - xml: name: state sources: description: '' type: array items: $ref: '#/components/schemas/SetSourceRequest' vpcInterfaces: description: The VPC interfaces you want on the flow. type: array items: $ref: '#/components/schemas/VpcInterfaceRequest' maintenance: description: Create maintenance setting for a flow type: object properties: MaintenanceDay: allOf: - $ref: '#/components/schemas/MaintenanceDay' - xml: name: maintenanceDay description: A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday. MaintenanceStartHour: allOf: - $ref: '#/components/schemas/__string' - xml: name: maintenanceStartHour description: '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.' summary: Amazon MediaConnect Create Flow x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Flows get: operationId: ListFlows description: Displays a list of flows that are associated with this account. This request returns a paginated result. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListFlowsResponse' examples: ListFlows200Example: summary: Default ListFlows 200 response x-microcks-default: true value: Flows: example-value NextToken: example-value '480': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: ListFlows480Example: summary: Default ListFlows 480 response x-microcks-default: true value: result: success '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListFlows481Example: summary: Default ListFlows 481 response x-microcks-default: true value: result: success '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListFlows482Example: summary: Default ListFlows 482 response x-microcks-default: true value: result: success '483': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListFlows483Example: summary: Default ListFlows 483 response x-microcks-default: true value: result: success parameters: - name: maxResults in: query required: false description: 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. schema: type: integer minimum: 1 maximum: 1000 example: 1 - name: nextToken in: query required: false description: The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value. schema: type: string example: example-value - name: MaxResults in: query schema: type: string description: Pagination limit required: false example: example-value - name: NextToken in: query schema: type: string description: Pagination token required: false example: example-value summary: Amazon MediaConnect List Flows x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Flows /v1/flows/{flowArn}: 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' delete: operationId: DeleteFlow description: Deletes a flow. Before you can delete a flow, you must stop the flow. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteFlowResponse' examples: DeleteFlow202Example: summary: Default DeleteFlow 202 response x-microcks-default: true value: FlowArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow Status: ACTIVE '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DeleteFlow480Example: summary: Default DeleteFlow 480 response x-microcks-default: true value: result: success '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DeleteFlow481Example: summary: Default DeleteFlow 481 response x-microcks-default: true value: result: success '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DeleteFlow482Example: summary: Default DeleteFlow 482 response x-microcks-default: true value: result: success '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DeleteFlow483Example: summary: Default DeleteFlow 483 response x-microcks-default: true value: result: success '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DeleteFlow484Example: summary: Default DeleteFlow 484 response x-microcks-default: true value: result: success '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DeleteFlow485Example: summary: Default DeleteFlow 485 response x-microcks-default: true value: result: success parameters: - name: flowArn in: path required: true description: The ARN of the flow that you want to delete. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow summary: Amazon MediaConnect Delete Flow x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Flows get: operationId: DescribeFlow description: Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeFlowResponse' examples: DescribeFlow200Example: summary: Default DescribeFlow 200 response x-microcks-default: true value: Flow: example-value Messages: example-value '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DescribeFlow480Example: summary: Default DescribeFlow 480 response x-microcks-default: true value: result: success '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DescribeFlow481Example: summary: Default DescribeFlow 481 response x-microcks-default: true value: result: success '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DescribeFlow482Example: summary: Default DescribeFlow 482 response x-microcks-default: true value: result: success '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DescribeFlow483Example: summary: Default DescribeFlow 483 response x-microcks-default: true value: result: success '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DescribeFlow484Example: summary: Default DescribeFlow 484 response x-microcks-default: true value: result: success '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeFlow485Example: summary: Default DescribeFlow 485 response x-microcks-default: true value: result: success parameters: - name: flowArn in: path required: true description: The ARN of the flow that you want to describe. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow summary: Amazon MediaConnect Describe Flow x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Flows put: operationId: UpdateFlow description: Updates flow responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateFlowResponse' examples: UpdateFlow202Example: summary: Default UpdateFlow 202 response x-microcks-default: true value: Flow: example-value '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateFlow480Example: summary: Default UpdateFlow 480 response x-microcks-default: true value: result: success '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateFlow481Example: summary: Default UpdateFlow 481 response x-microcks-default: true value: result: success '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateFlow482Example: summary: Default UpdateFlow 482 response x-microcks-default: true value: result: success '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateFlow483Example: summary: Default UpdateFlow 483 response x-microcks-default: true value: result: success '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateFlow484Example: summary: Default UpdateFlow 484 response x-microcks-default: true value: result: success '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateFlow485Example: summary: Default UpdateFlow 485 response x-microcks-default: true value: result: success parameters: - name: flowArn in: path required: true description: The flow that you want to update. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow requestBody: required: true content: application/json: schema: type: object properties: sourceFailoverConfig: description: The settings for source failover. type: object properties: FailoverMode: allOf: - $ref: '#/components/schemas/FailoverMode' - xml: name: failoverMode description: 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: allOf: - $ref: '#/components/schemas/__integer' - xml: name: recoveryWindow description: Recovery window time to look for dash-7 packets SourcePriority: allOf: - $ref: '#/components/schemas/SourcePriority' - xml: name: sourcePriority description: The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams. State: allOf: - $ref: '#/components/schemas/State' - xml: name: state maintenance: description: Update maintenance setting for a flow type: object properties: MaintenanceDay: allOf: - $ref: '#/components/schemas/MaintenanceDay' - xml: name: maintenanceDay description: A day of a week when the maintenance will happen. use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday. MaintenanceScheduledDate: allOf: - $ref: '#/components/schemas/__string' - xml: name: maintenanceScheduledDate description: 'A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.' MaintenanceStartHour: allOf: - $ref: '#/components/schemas/__string' - xml: name: maintenanceStartHour description: '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.' summary: Amazon MediaConnect Update Flow x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Flows /v1/flows/{flowArn}/entitlements: 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: GrantFlowEntitlements description: Grants entitlements to an existing flow. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GrantFlowEntitlementsResponse' examples: GrantFlowEntitlements200Example: summary: Default GrantFlowEntitlements 200 response x-microcks-default: true value: Entitlements: example-value FlowArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow '480': description: GrantFlowEntitlements420Exception content: application/json: schema: $ref: '#/components/schemas/GrantFlowEntitlements420Exception' examples: GrantFlowEntitlements480Example: summary: Default GrantFlowEntitlements 480 response x-microcks-default: true value: result: success '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: GrantFlowEntitlements481Example: summary: Default GrantFlowEntitlements 481 response x-microcks-default: true value: result: success '482': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: GrantFlowEntitlements482Example: summary: Default GrantFlowEntitlements 482 response x-microcks-default: true value: result: success '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: GrantFlowEntitlements483Example: summary: Default GrantFlowEntitlements 483 response x-microcks-default: true value: result: success '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: GrantFlowEntitlements484Example: summary: Default GrantFlowEntitlements 484 response x-microcks-default: true value: result: success '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: GrantFlowEntitlements485Example: summary: Default GrantFlowEntitlements 485 response x-microcks-default: true value: result: success '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: GrantFlowEntitlements486Example: summary: Default GrantFlowEntitlements 486 response x-microcks-default: true value: result: success parameters: - name: flowArn in: path required: true description: The flow that you want to grant entitlements on. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow requestBody: required: true content: application/json: schema: type: object required: - entitlements properties: entitlements: description: The list of entitlements that you want to grant. type: array items: $ref: '#/components/schemas/GrantEntitlementRequest' summary: Amazon MediaConnect Grant Flow Entitlements x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Flows /v1/flows/{flowArn}/mediaStreams/{mediaStreamName}: 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' delete: operationId: RemoveFlowMediaStream description: Removes a media stream from a flow. This action is only available if the media stream is not associated with a source or output. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RemoveFlowMediaStreamResponse' examples: RemoveFlowMediaStream200Example: summary: Default RemoveFlowMediaStream 200 response x-microcks-default: true value: FlowArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow MediaStreamName: example-flow '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: RemoveFlowMediaStream480Example: summary: Default RemoveFlowMediaStream 480 response x-microcks-default: true value: result: success '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: RemoveFlowMediaStream481Example: summary: Default RemoveFlowMediaStream 481 response x-microcks-default: true value: result: success '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: RemoveFlowMediaStream482Example: summary: Default RemoveFlowMediaStream 482 response x-microcks-default: true value: result: success '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: RemoveFlowMediaStream483Example: summary: Default RemoveFlowMediaStream 483 response x-microcks-default: true value: result: success '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: RemoveFlowMediaStream484Example: summary: Default RemoveFlowMediaStream 484 response x-microcks-default: true value: result: success '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: RemoveFlowMediaStream485Example: summary: Default RemoveFlowMediaStream 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 - name: mediaStreamName in: path required: true description: The name of the media stream that you want to remove. schema: type: string example: example-flow summary: Amazon MediaConnect Remove Flow Media Stream x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Flows put: operationId: UpdateFlowMediaStream description: Updates an existing media stream. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateFlowMediaStreamResponse' examples: UpdateFlowMediaStream202Example: summary: Default UpdateFlowMediaStream 202 response x-microcks-default: true value: FlowArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow MediaStream: example-value '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateFlowMediaStream480Example: summary: Default UpdateFlowMediaStream 480 response x-microcks-default: true value: result: success '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateFlowMediaStream481Example: summary: Default UpdateFlowMediaStream 481 response x-microcks-default: true value: result: success '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateFlowMediaStream482Example: summary: Default UpdateFlowMediaStream 482 response x-microcks-default: true value: result: success '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateFlowMediaStream483Example: summary: Default UpdateFlowMediaStream 483 response x-microcks-default: true value: result: success '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateFlowMediaStream484Example: summary: Default UpdateFlowMediaStream 484 response x-microcks-default: true value: result: success '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateFlowMediaStream485Example: summary: Default UpdateFlowMediaStream 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 - name: mediaStreamName in: path required: true description: The name of the media stream that you want to update. schema: type: string example: example-flow requestBody: required: true content: application/json: schema: type: object properties: attributes: description: Attributes that are related to the media stream. type: object properties: Fmtp: allOf: - $ref: '#/components/schemas/FmtpRequest' - xml: name: fmtp description: The settings that you want to use to define the media stream. Lang: allOf: - $ref: '#/components/schemas/__string' - xml: name: lang description: The audio language, in a format that is recognized by the receiver. clockRate: description: 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. type: integer description: description: Description type: string mediaStreamType: description: The type of media stream. type: string enum: - video - audio - ancillary-data videoFormat: description: The resolution of the video. type: string summary: Amazon MediaConnect Update Flow Media Stream x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Flows /v1/flows/{flowArn}/outputs/{outputArn}: 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' delete: operationId: RemoveFlowOutput description: 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. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/RemoveFlowOutputResponse' examples: RemoveFlowOutput202Example: summary: Default RemoveFlowOutput 202 response x-microcks-default: true value: FlowArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow OutputArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: RemoveFlowOutput480Example: summary: Default RemoveFlowOutput 480 response x-microcks-default: true value: result: success '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: RemoveFlowOutput481Example: summary: Default RemoveFlowOutput 481 response x-microcks-default: true value: result: success '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: RemoveFlowOutput482Example: summary: Default RemoveFlowOutput 482 response x-microcks-default: true value: result: success '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: RemoveFlowOutput483Example: summary: Default RemoveFlowOutput 483 response x-microcks-default: true value: result: success '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: RemoveFlowOutput484Example: summary: Default RemoveFlowOutput 484 response x-microcks-default: true value: result: success '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: RemoveFlowOutput485Example: summary: Default RemoveFlowOutput 485 response x-microcks-default: true value: result: success parameters: - name: flowArn in: path required: true description: The flow that you want to remove an output from. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow - name: outputArn in: path required: true description: The ARN of the output that you want to remove. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow summary: Amazon MediaConnect Remove Flow Output x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Flows put: operationId: UpdateFlowOutput description: Updates an existing flow output. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateFlowOutputResponse' examples: UpdateFlowOutput202Example: summary: Default UpdateFlowOutput 202 response x-microcks-default: true value: FlowArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow Output: example-value '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateFlowOutput480Example: summary: Default UpdateFlowOutput 480 response x-microcks-default: true value: result: success '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateFlowOutput481Example: summary: Default UpdateFlowOutput 481 response x-microcks-default: true value: result: success '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateFlowOutput482Example: summary: Default UpdateFlowOutput 482 response x-microcks-default: true value: result: success '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateFlowOutput483Example: summary: Default UpdateFlowOutput 483 response x-microcks-default: true value: result: success '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateFlowOutput484Example: summary: Default UpdateFlowOutput 484 response x-microcks-default: true value: result: success '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateFlowOutput485Example: summary: Default UpdateFlowOutput 485 response x-microcks-default: true value: result: success parameters: - name: flowArn in: path required: true description: The flow that is associated with the output that you want to update. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow - name: outputArn in: path required: true description: The ARN of the output that you want to update. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow requestBody: required: true content: application/json: schema: type: object properties: cidrAllowList: description: 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. type: array items: $ref: '#/components/schemas/__string' description: description: A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user. type: string destination: description: The IP address where you want to send the output. type: string encryption: description: Information about the encryption of the flow. type: object properties: Algorithm: allOf: - $ref: '#/components/schemas/Algorithm' - xml: name: algorithm description: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). ConstantInitializationVector: allOf: - $ref: '#/components/schemas/__string' - xml: name: constantInitializationVector description: 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: allOf: - $ref: '#/components/schemas/__string' - xml: name: deviceId description: 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: allOf: - $ref: '#/components/schemas/KeyType' - xml: name: keyType description: 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: allOf: - $ref: '#/components/schemas/__string' - xml: name: region description: The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption. ResourceId: allOf: - $ref: '#/components/schemas/__string' - xml: name: resourceId description: 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: allOf: - $ref: '#/components/schemas/__string' - xml: name: roleArn description: The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity). SecretArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: secretArn description: The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption. Url: allOf: - $ref: '#/components/schemas/__string' - xml: name: url description: 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: description: The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams. type: integer mediaStreamOutputConfigurations: description: The media streams that are associated with the output, and the parameters for those associations. type: array items: $ref: '#/components/schemas/MediaStreamOutputConfigurationRequest' 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. type: integer port: description: The port to use when content is distributed to this output. type: integer protocol: description: The protocol to use for the output. type: string enum: - zixi-push - rtp-fec - rtp - zixi-pull - rist - st2110-jpegxs - cdi - srt-listener - srt-caller - fujitsu-qos - udp remoteId: description: The remote ID for the Zixi-pull stream. type: string senderControlPort: description: The port that the flow uses to send outbound requests to initiate connection with the sender. type: integer senderIpAddress: description: The IP address that the flow communicates with to initiate connection with the sender. type: string smoothingLatency: description: The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams. type: integer streamId: description: The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams. type: string vpcInterfaceAttachment: description: The settings for attaching a VPC interface to an resource. type: object properties: VpcInterfaceName: allOf: - $ref: '#/components/schemas/__string' - xml: name: vpcInterfaceName description: The name of the VPC interface to use for this resource. summary: Amazon MediaConnect Update Flow Output x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Flows /v1/flows/{flowArn}/source/{sourceArn}: 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' delete: operationId: RemoveFlowSource description: Removes a source from an existing flow. This request can be made only if there is more than one source on the flow. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/RemoveFlowSourceResponse' examples: RemoveFlowSource202Example: summary: Default RemoveFlowSource 202 response x-microcks-default: true value: FlowArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow SourceArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: RemoveFlowSource480Example: summary: Default RemoveFlowSource 480 response x-microcks-default: true value: result: success '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: RemoveFlowSource481Example: summary: Default RemoveFlowSource 481 response x-microcks-default: true value: result: success '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: RemoveFlowSource482Example: summary: Default RemoveFlowSource 482 response x-microcks-default: true value: result: success '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: RemoveFlowSource483Example: summary: Default RemoveFlowSource 483 response x-microcks-default: true value: result: success '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: RemoveFlowSource484Example: summary: Default RemoveFlowSource 484 response x-microcks-default: true value: result: success '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: RemoveFlowSource485Example: summary: Default RemoveFlowSource 485 response x-microcks-default: true value: result: success parameters: - name: flowArn in: path required: true description: The flow that you want to remove a source from. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow - name: sourceArn in: path required: true description: The ARN of the source that you want to remove. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow summary: Amazon MediaConnect Remove Flow Source x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Flows put: operationId: UpdateFlowSource description: Updates the source of a flow. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateFlowSourceResponse' examples: UpdateFlowSource202Example: summary: Default UpdateFlowSource 202 response x-microcks-default: true value: FlowArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow Source: example-value '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateFlowSource480Example: summary: Default UpdateFlowSource 480 response x-microcks-default: true value: result: success '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateFlowSource481Example: summary: Default UpdateFlowSource 481 response x-microcks-default: true value: result: success '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateFlowSource482Example: summary: Default UpdateFlowSource 482 response x-microcks-default: true value: result: success '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateFlowSource483Example: summary: Default UpdateFlowSource 483 response x-microcks-default: true value: result: success '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateFlowSource484Example: summary: Default UpdateFlowSource 484 response x-microcks-default: true value: result: success '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateFlowSource485Example: summary: Default UpdateFlowSource 485 response x-microcks-default: true value: result: success parameters: - name: flowArn in: path required: true description: The flow that is associated with the source that you want to update. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow - name: sourceArn in: path required: true description: The ARN of the source that you want to update. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow requestBody: required: true content: application/json: schema: type: object properties: decryption: description: Information about the encryption of the flow. type: object properties: Algorithm: allOf: - $ref: '#/components/schemas/Algorithm' - xml: name: algorithm description: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). ConstantInitializationVector: allOf: - $ref: '#/components/schemas/__string' - xml: name: constantInitializationVector description: 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: allOf: - $ref: '#/components/schemas/__string' - xml: name: deviceId description: 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: allOf: - $ref: '#/components/schemas/KeyType' - xml: name: keyType description: 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: allOf: - $ref: '#/components/schemas/__string' - xml: name: region description: The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption. ResourceId: allOf: - $ref: '#/components/schemas/__string' - xml: name: resourceId description: 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: allOf: - $ref: '#/components/schemas/__string' - xml: name: roleArn description: The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity). SecretArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: secretArn description: The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption. Url: allOf: - $ref: '#/components/schemas/__string' - xml: name: url description: 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: description: A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account. type: string 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. type: string ingestPort: description: The port that the flow will be listening on for incoming content. type: integer maxBitrate: description: The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams. type: integer maxLatency: description: The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams. type: integer maxSyncBuffer: description: The size of the buffer (in milliseconds) to use to sync incoming source data. type: integer mediaStreamSourceConfigurations: description: The media streams that are associated with the source, and the parameters for those associations. type: array items: $ref: '#/components/schemas/MediaStreamSourceConfigurationRequest' 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. type: integer protocol: description: The protocol that is used by the source. type: string enum: - zixi-push - rtp-fec - rtp - zixi-pull - rist - st2110-jpegxs - cdi - srt-listener - srt-caller - fujitsu-qos - udp senderControlPort: description: The port that the flow uses to send outbound requests to initiate connection with the sender. type: integer senderIpAddress: description: The IP address that the flow communicates with to initiate connection with the sender. type: string sourceListenerAddress: description: Source IP or domain name for SRT-caller protocol. type: string sourceListenerPort: description: Source port for SRT-caller protocol. type: integer streamId: description: The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams. type: string vpcInterfaceName: description: The name of the VPC interface to use for this source. type: string whitelistCidr: description: 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. type: string gatewayBridgeSource: description: The source configuration for cloud flows receiving a stream from a bridge. type: object properties: BridgeArn: allOf: - $ref: '#/components/schemas/__string' - pattern: ^arn:.+:mediaconnect.+:bridge:.+$ xml: name: bridgeArn description: The ARN of the bridge feeding this flow. VpcInterfaceAttachment: allOf: - $ref: '#/components/schemas/VpcInterfaceAttachment' - xml: name: vpcInterfaceAttachment description: The name of the VPC interface attachment to use for this bridge source. summary: Amazon MediaConnect Update Flow Source x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Flows /v1/flows/{flowArn}/vpcInterfaces/{vpcInterfaceName}: 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' delete: operationId: RemoveFlowVpcInterface description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RemoveFlowVpcInterfaceResponse' examples: RemoveFlowVpcInterface200Example: summary: Default RemoveFlowVpcInterface 200 response x-microcks-default: true value: FlowArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow NonDeletedNetworkInterfaceIds: example-value VpcInterfaceName: example-flow '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: RemoveFlowVpcInterface480Example: summary: Default RemoveFlowVpcInterface 480 response x-microcks-default: true value: result: success '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: RemoveFlowVpcInterface481Example: summary: Default RemoveFlowVpcInterface 481 response x-microcks-default: true value: result: success '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: RemoveFlowVpcInterface482Example: summary: Default RemoveFlowVpcInterface 482 response x-microcks-default: true value: result: success '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: RemoveFlowVpcInterface483Example: summary: Default RemoveFlowVpcInterface 483 response x-microcks-default: true value: result: success '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: RemoveFlowVpcInterface484Example: summary: Default RemoveFlowVpcInterface 484 response x-microcks-default: true value: result: success '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: RemoveFlowVpcInterface485Example: summary: Default RemoveFlowVpcInterface 485 response x-microcks-default: true value: result: success parameters: - name: flowArn in: path required: true description: The flow that you want to remove a VPC interface from. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow - name: vpcInterfaceName in: path required: true description: The name of the VPC interface that you want to remove. schema: type: string example: example-flow summary: Amazon MediaConnect Remove Flow Vpc Interface x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Flows /v1/flows/{flowArn}/entitlements/{entitlementArn}: 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' delete: operationId: RevokeFlowEntitlement description: Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/RevokeFlowEntitlementResponse' examples: RevokeFlowEntitlement202Example: summary: Default RevokeFlowEntitlement 202 response x-microcks-default: true value: EntitlementArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow FlowArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: RevokeFlowEntitlement480Example: summary: Default RevokeFlowEntitlement 480 response x-microcks-default: true value: result: success '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: RevokeFlowEntitlement481Example: summary: Default RevokeFlowEntitlement 481 response x-microcks-default: true value: result: success '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: RevokeFlowEntitlement482Example: summary: Default RevokeFlowEntitlement 482 response x-microcks-default: true value: result: success '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: RevokeFlowEntitlement483Example: summary: Default RevokeFlowEntitlement 483 response x-microcks-default: true value: result: success '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: RevokeFlowEntitlement484Example: summary: Default RevokeFlowEntitlement 484 response x-microcks-default: true value: result: success '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: RevokeFlowEntitlement485Example: summary: Default RevokeFlowEntitlement 485 response x-microcks-default: true value: result: success parameters: - name: entitlementArn in: path required: true description: The ARN of the entitlement that you want to revoke. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow - name: flowArn in: path required: true description: The flow that you want to revoke an entitlement from. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow summary: Amazon MediaConnect Revoke Flow Entitlement x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Flows put: operationId: UpdateFlowEntitlement description: 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. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateFlowEntitlementResponse' examples: UpdateFlowEntitlement202Example: summary: Default UpdateFlowEntitlement 202 response x-microcks-default: true value: Entitlement: example-value FlowArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateFlowEntitlement480Example: summary: Default UpdateFlowEntitlement 480 response x-microcks-default: true value: result: success '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateFlowEntitlement481Example: summary: Default UpdateFlowEntitlement 481 response x-microcks-default: true value: result: success '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateFlowEntitlement482Example: summary: Default UpdateFlowEntitlement 482 response x-microcks-default: true value: result: success '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateFlowEntitlement483Example: summary: Default UpdateFlowEntitlement 483 response x-microcks-default: true value: result: success '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateFlowEntitlement484Example: summary: Default UpdateFlowEntitlement 484 response x-microcks-default: true value: result: success '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateFlowEntitlement485Example: summary: Default UpdateFlowEntitlement 485 response x-microcks-default: true value: result: success parameters: - name: entitlementArn in: path required: true description: The ARN of the entitlement that you want to update. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow - name: flowArn in: path required: true description: The flow that is associated with the entitlement that you want to update. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow requestBody: required: true content: application/json: schema: type: object properties: description: description: A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user. type: string encryption: description: Information about the encryption of the flow. type: object properties: Algorithm: allOf: - $ref: '#/components/schemas/Algorithm' - xml: name: algorithm description: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). ConstantInitializationVector: allOf: - $ref: '#/components/schemas/__string' - xml: name: constantInitializationVector description: 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: allOf: - $ref: '#/components/schemas/__string' - xml: name: deviceId description: 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: allOf: - $ref: '#/components/schemas/KeyType' - xml: name: keyType description: 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: allOf: - $ref: '#/components/schemas/__string' - xml: name: region description: The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption. ResourceId: allOf: - $ref: '#/components/schemas/__string' - xml: name: resourceId description: 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: allOf: - $ref: '#/components/schemas/__string' - xml: name: roleArn description: The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity). SecretArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: secretArn description: The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption. Url: allOf: - $ref: '#/components/schemas/__string' - xml: name: url description: 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: description: 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. type: string enum: - ENABLED - DISABLED subscribers: description: The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source. type: array items: $ref: '#/components/schemas/__string' summary: Amazon MediaConnect Update Flow Entitlement x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Flows /v1/flows/start/{flowArn}: 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: StartFlow description: Starts a flow. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/StartFlowResponse' examples: StartFlow202Example: summary: Default StartFlow 202 response x-microcks-default: true value: FlowArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow Status: ACTIVE '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: StartFlow480Example: summary: Default StartFlow 480 response x-microcks-default: true value: result: success '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: StartFlow481Example: summary: Default StartFlow 481 response x-microcks-default: true value: result: success '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: StartFlow482Example: summary: Default StartFlow 482 response x-microcks-default: true value: result: success '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: StartFlow483Example: summary: Default StartFlow 483 response x-microcks-default: true value: result: success '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: StartFlow484Example: summary: Default StartFlow 484 response x-microcks-default: true value: result: success '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: StartFlow485Example: summary: Default StartFlow 485 response x-microcks-default: true value: result: success parameters: - name: flowArn in: path required: true description: The ARN of the flow that you want to start. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow summary: Amazon MediaConnect Start Flow x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Flows /v1/flows/stop/{flowArn}: 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: StopFlow description: Stops a flow. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/StopFlowResponse' examples: StopFlow202Example: summary: Default StopFlow 202 response x-microcks-default: true value: FlowArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow Status: ACTIVE '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: StopFlow480Example: summary: Default StopFlow 480 response x-microcks-default: true value: result: success '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: StopFlow481Example: summary: Default StopFlow 481 response x-microcks-default: true value: result: success '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: StopFlow482Example: summary: Default StopFlow 482 response x-microcks-default: true value: result: success '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: StopFlow483Example: summary: Default StopFlow 483 response x-microcks-default: true value: result: success '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: StopFlow484Example: summary: Default StopFlow 484 response x-microcks-default: true value: result: success '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: StopFlow485Example: summary: Default StopFlow 485 response x-microcks-default: true value: result: success parameters: - name: flowArn in: path required: true description: The ARN of the flow that you want to stop. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow summary: Amazon MediaConnect Stop Flow x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Flows components: schemas: DeleteFlowResponse: type: object properties: FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The ARN of the flow that was deleted. Status: allOf: - $ref: '#/components/schemas/Status' - xml: name: status description: The status of the flow when the DeleteFlow process begins. NetworkInterfaceType: type: string enum: - ena - efa Tcs: type: string enum: - SDR - PQ - HLG - LINEAR - BT2100LINPQ - BT2100LINHLG - ST2065-1 - ST428-1 - DENSITY EntitlementStatus: type: string enum: - ENABLED - DISABLED RemoveFlowSourceResponse: type: object properties: FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The ARN of the flow that is associated with the source you removed. SourceArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: sourceArn description: The ARN of the source that was removed. UpdateFlowOutputResponse: type: object properties: FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The ARN of the flow that is associated with the updated output. Output: allOf: - $ref: '#/components/schemas/Output' - xml: name: output description: The new settings of the output that you updated. GrantEntitlementRequest: type: object required: - Subscribers properties: DataTransferSubscriberFeePercent: allOf: - $ref: '#/components/schemas/__integer' - xml: name: dataTransferSubscriberFeePercent description: Percentage from 0-100 of the data transfer cost to be billed to the subscriber. Description: allOf: - $ref: '#/components/schemas/__string' - xml: name: description description: A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user. Encryption: allOf: - $ref: '#/components/schemas/Encryption' - xml: name: encryption description: 'The type of encryption that will be used on the output that is associated with this entitlement. Allowable encryption types: static-key, speke.' EntitlementStatus: allOf: - $ref: '#/components/schemas/EntitlementStatus' - xml: name: entitlementStatus description: 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: allOf: - $ref: '#/components/schemas/__string' - xml: name: name description: The name of the entitlement. This value must be unique within the current flow. Subscribers: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: subscribers description: The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source. description: The entitlements that you want to grant on a flow. VpcInterfaceRequest: type: object required: - SubnetId - SecurityGroupIds - RoleArn - Name properties: Name: allOf: - $ref: '#/components/schemas/__string' - xml: name: name description: The name of the VPC Interface. This value must be unique within the current flow. NetworkInterfaceType: allOf: - $ref: '#/components/schemas/NetworkInterfaceType' - xml: name: networkInterfaceType description: The type of network interface. If this value is not included in the request, MediaConnect uses ENA as the networkInterfaceType. RoleArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: roleArn description: Role Arn MediaConnect can assumes to create ENIs in customer's account SecurityGroupIds: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: securityGroupIds description: Security Group IDs to be used on ENI. SubnetId: allOf: - $ref: '#/components/schemas/__string' - xml: name: subnetId description: Subnet must be in the AZ of the Flow description: Desired VPC Interface for a Flow InternalServerErrorException: {} GrantFlowEntitlements420Exception: {} __listOfMediaStreamSourceConfigurationRequest: type: array items: $ref: '#/components/schemas/MediaStreamSourceConfigurationRequest' InputConfigurationRequest: type: object required: - InputPort - Interface properties: InputPort: allOf: - $ref: '#/components/schemas/__integer' - xml: name: inputPort description: The port that you want the flow to listen on for an incoming media stream. Interface: allOf: - $ref: '#/components/schemas/InterfaceRequest' - xml: name: interface description: The VPC interface that you want to use for the incoming media stream. description: The transport parameters that you want to associate with an incoming media stream. __listOf__integer: type: array items: $ref: '#/components/schemas/__integer' UpdateFlowMediaStreamResponse: type: object properties: FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The ARN of the flow that is associated with the media stream that you updated. MediaStream: allOf: - $ref: '#/components/schemas/MediaStream' - xml: name: mediaStream description: The media stream that you updated. KeyType: type: string enum: - speke - static-key - srt-password BadRequestException: {} MediaStreamOutputConfigurationRequest: type: object required: - MediaStreamName - EncodingName properties: DestinationConfigurations: allOf: - $ref: '#/components/schemas/__listOfDestinationConfigurationRequest' - xml: name: destinationConfigurations description: The transport parameters that you want to associate with the media stream. EncodingName: allOf: - $ref: '#/components/schemas/EncodingName' - xml: name: encodingName description: 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: allOf: - $ref: '#/components/schemas/EncodingParametersRequest' - xml: name: encodingParameters description: A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source. MediaStreamName: allOf: - $ref: '#/components/schemas/__string' - xml: name: mediaStreamName description: The name of the media stream that is associated with the output. description: The media stream that you want to associate with the output, and the parameters for that association. CreateFlowResponse: type: object properties: Flow: allOf: - $ref: '#/components/schemas/Flow' - xml: name: flow StartFlowResponse: type: object properties: FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The ARN of the flow that you started. Status: allOf: - $ref: '#/components/schemas/Status' - xml: name: status description: The status of the flow when the StartFlow process begins. Protocol: type: string enum: - zixi-push - rtp-fec - rtp - zixi-pull - rist - st2110-jpegxs - cdi - srt-listener - srt-caller - fujitsu-qos - udp Status: type: string enum: - STANDBY - ACTIVE - UPDATING - DELETING - STARTING - STOPPING - ERROR Interface: type: object required: - Name properties: Name: allOf: - $ref: '#/components/schemas/__string' - xml: name: name description: The name of the VPC interface. description: The VPC interface that is used for the media stream associated with the source or output. EncoderProfile: type: string enum: - main - high SourcePriority: type: object properties: PrimarySource: allOf: - $ref: '#/components/schemas/__string' - xml: name: primarySource description: The name of the source you choose as the primary source for this flow. description: The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams. AddFlowOutputs420Exception: {} ScanMode: type: string enum: - progressive - interlace - progressive-segmented-frame Colorimetry: type: string enum: - BT601 - BT709 - BT2020 - BT2100 - ST2065-1 - ST2065-3 - XYZ Range: type: string enum: - NARROW - FULL - FULLPROTECT __listOfListedFlow: type: array items: $ref: '#/components/schemas/ListedFlow' UpdateFlowSourceResponse: type: object properties: FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The ARN of the flow that you want to update. Source: allOf: - $ref: '#/components/schemas/Source' - xml: name: source description: The settings for the source of the flow. __listOfVpcInterface: type: array items: $ref: '#/components/schemas/VpcInterface' __listOfMediaStreamOutputConfigurationRequest: type: array items: $ref: '#/components/schemas/MediaStreamOutputConfigurationRequest' InterfaceRequest: type: object required: - Name properties: Name: allOf: - $ref: '#/components/schemas/__string' - xml: name: name description: The name of the VPC interface. description: The VPC interface that you want to designate where the media stream is coming from or going to. AddFlowSourcesResponse: type: object properties: FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The ARN of the flow that these sources were added to. Sources: allOf: - $ref: '#/components/schemas/__listOfSource' - xml: name: sources description: The details of the newly added sources. FmtpRequest: type: object properties: ChannelOrder: allOf: - $ref: '#/components/schemas/__string' - xml: name: channelOrder description: The format of the audio channel. Colorimetry: allOf: - $ref: '#/components/schemas/Colorimetry' - xml: name: colorimetry description: The format that is used for the representation of color. ExactFramerate: allOf: - $ref: '#/components/schemas/__string' - xml: name: exactFramerate description: '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: allOf: - $ref: '#/components/schemas/__string' - xml: name: par description: The pixel aspect ratio (PAR) of the video. Range: allOf: - $ref: '#/components/schemas/Range' - xml: name: range description: The encoding range of the video. ScanMode: allOf: - $ref: '#/components/schemas/ScanMode' - xml: name: scanMode description: The type of compression that was used to smooth the video’s appearance. Tcs: allOf: - $ref: '#/components/schemas/Tcs' - xml: name: tcs description: The transfer characteristic system (TCS) that is used in the video. description: The settings that you want to use to define the media stream. Algorithm: type: string enum: - aes128 - aes192 - aes256 Encryption: type: object required: - RoleArn properties: Algorithm: allOf: - $ref: '#/components/schemas/Algorithm' - xml: name: algorithm description: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). ConstantInitializationVector: allOf: - $ref: '#/components/schemas/__string' - xml: name: constantInitializationVector description: 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: allOf: - $ref: '#/components/schemas/__string' - xml: name: deviceId description: 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: allOf: - $ref: '#/components/schemas/KeyType' - xml: name: keyType description: 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: allOf: - $ref: '#/components/schemas/__string' - xml: name: region description: The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption. ResourceId: allOf: - $ref: '#/components/schemas/__string' - xml: name: resourceId description: 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: allOf: - $ref: '#/components/schemas/__string' - xml: name: roleArn description: The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity). SecretArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: secretArn description: The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption. Url: allOf: - $ref: '#/components/schemas/__string' - xml: name: url description: 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: Information about the encryption of the flow. UpdateFlowEntitlementResponse: type: object properties: Entitlement: allOf: - $ref: '#/components/schemas/Entitlement' - xml: name: entitlement description: The new configuration of the entitlement that you updated. FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The ARN of the flow that this entitlement was granted on. ForbiddenException: {} FailoverMode: type: string enum: - MERGE - FAILOVER MaintenanceDay: type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday SetGatewayBridgeSourceRequest: type: object required: - BridgeArn properties: BridgeArn: allOf: - $ref: '#/components/schemas/__string' - pattern: ^arn:.+:mediaconnect.+:bridge:.+$ xml: name: bridgeArn description: The ARN of the bridge feeding this flow. VpcInterfaceAttachment: allOf: - $ref: '#/components/schemas/VpcInterfaceAttachment' - xml: name: vpcInterfaceAttachment description: The name of the VPC interface attachment to use for this bridge source. description: The source configuration for cloud flows receiving a stream from a bridge. __listOfSource: type: array items: $ref: '#/components/schemas/Source' MediaStreamSourceConfiguration: type: object required: - MediaStreamName - EncodingName properties: EncodingName: allOf: - $ref: '#/components/schemas/EncodingName' - xml: name: encodingName description: 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: allOf: - $ref: '#/components/schemas/__listOfInputConfiguration' - xml: name: inputConfigurations description: The transport parameters that are associated with an incoming media stream. MediaStreamName: allOf: - $ref: '#/components/schemas/__string' - xml: name: mediaStreamName description: The name of the media stream. description: The media stream that is associated with the source, and the parameters for that association. RemoveFlowMediaStreamResponse: type: object properties: FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The Amazon Resource Name (ARN) of the flow. MediaStreamName: allOf: - $ref: '#/components/schemas/__string' - xml: name: mediaStreamName description: The name of the media stream that was removed. AddFlowMediaStreamsResponse: type: object properties: FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The ARN of the flow that you added media streams to. MediaStreams: allOf: - $ref: '#/components/schemas/__listOfMediaStream' - xml: name: mediaStreams description: The media streams that you added to the flow. MediaStream: type: object required: - MediaStreamType - MediaStreamId - MediaStreamName - Fmt properties: Attributes: allOf: - $ref: '#/components/schemas/MediaStreamAttributes' - xml: name: attributes description: Attributes that are related to the media stream. ClockRate: allOf: - $ref: '#/components/schemas/__integer' - xml: name: clockRate description: The sample rate for the stream. This value is measured in Hz. Description: allOf: - $ref: '#/components/schemas/__string' - xml: name: description description: A description that can help you quickly identify what your media stream is used for. Fmt: allOf: - $ref: '#/components/schemas/__integer' - xml: name: fmt description: 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: allOf: - $ref: '#/components/schemas/__integer' - xml: name: mediaStreamId description: A unique identifier for the media stream. MediaStreamName: allOf: - $ref: '#/components/schemas/__string' - xml: name: mediaStreamName description: A name that helps you distinguish one media stream from another. MediaStreamType: allOf: - $ref: '#/components/schemas/MediaStreamType' - xml: name: mediaStreamType description: The type of media stream. VideoFormat: allOf: - $ref: '#/components/schemas/__string' - xml: name: videoFormat description: The resolution of the video. description: A single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams. __string: type: string VpcInterface: type: object required: - NetworkInterfaceType - NetworkInterfaceIds - SubnetId - SecurityGroupIds - RoleArn - Name properties: Name: allOf: - $ref: '#/components/schemas/__string' - xml: name: name description: Immutable and has to be a unique against other VpcInterfaces in this Flow. NetworkInterfaceIds: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: networkInterfaceIds description: IDs of the network interfaces created in customer's account by MediaConnect. NetworkInterfaceType: allOf: - $ref: '#/components/schemas/NetworkInterfaceType' - xml: name: networkInterfaceType description: The type of network interface. RoleArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: roleArn description: Role Arn MediaConnect can assumes to create ENIs in customer's account SecurityGroupIds: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: securityGroupIds description: Security Group IDs to be used on ENI. SubnetId: allOf: - $ref: '#/components/schemas/__string' - xml: name: subnetId description: Subnet must be in the AZ of the Flow description: The settings for a VPC Source. GrantFlowEntitlementsResponse: type: object properties: Entitlements: allOf: - $ref: '#/components/schemas/__listOfEntitlement' - xml: name: entitlements description: The entitlements that were just granted. FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The ARN of the flow that these entitlements were granted to. __double: type: number format: double EncodingName: type: string enum: - jxsv - raw - smpte291 - pcm EncodingParametersRequest: type: object required: - EncoderProfile - CompressionFactor properties: CompressionFactor: allOf: - $ref: '#/components/schemas/__double' - xml: name: compressionFactor description: '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: allOf: - $ref: '#/components/schemas/EncoderProfile' - xml: name: encoderProfile description: 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. description: 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. __listOfOutput: type: array items: $ref: '#/components/schemas/Output' Flow: type: object required: - Status - AvailabilityZone - Source - Name - Entitlements - Outputs - FlowArn properties: AvailabilityZone: allOf: - $ref: '#/components/schemas/__string' - xml: name: 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. Description: allOf: - $ref: '#/components/schemas/__string' - xml: name: description description: A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account. EgressIp: allOf: - $ref: '#/components/schemas/__string' - xml: name: egressIp description: The IP address from which video will be sent to output destinations. Entitlements: allOf: - $ref: '#/components/schemas/__listOfEntitlement' - xml: name: entitlements description: The entitlements in this flow. FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The Amazon Resource Name (ARN) of the flow. MediaStreams: allOf: - $ref: '#/components/schemas/__listOfMediaStream' - xml: name: mediaStreams description: 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. Name: allOf: - $ref: '#/components/schemas/__string' - xml: name: name description: The name of the flow. Outputs: allOf: - $ref: '#/components/schemas/__listOfOutput' - xml: name: outputs description: The outputs in this flow. Source: allOf: - $ref: '#/components/schemas/Source' - xml: name: source SourceFailoverConfig: allOf: - $ref: '#/components/schemas/FailoverConfig' - xml: name: sourceFailoverConfig Sources: allOf: - $ref: '#/components/schemas/__listOfSource' - xml: name: sources Status: allOf: - $ref: '#/components/schemas/Status' - xml: name: status description: The current status of the flow. VpcInterfaces: allOf: - $ref: '#/components/schemas/__listOfVpcInterface' - xml: name: vpcInterfaces description: The VPC Interfaces for this flow. Maintenance: allOf: - $ref: '#/components/schemas/Maintenance' - xml: name: maintenance description: The settings for a flow, including its source, outputs, and entitlements. MediaStreamType: type: string enum: - video - audio - ancillary-data DestinationConfigurationRequest: type: object required: - DestinationIp - DestinationPort - Interface properties: DestinationIp: allOf: - $ref: '#/components/schemas/__string' - xml: name: destinationIp description: The IP address where you want MediaConnect to send contents of the media stream. DestinationPort: allOf: - $ref: '#/components/schemas/__integer' - xml: name: destinationPort description: The port that you want MediaConnect to use when it distributes the media stream to the output. Interface: allOf: - $ref: '#/components/schemas/InterfaceRequest' - xml: name: interface description: The VPC interface that you want to use for the media stream associated with the output. description: The transport parameters that you want to associate with an outbound media stream. MediaStreamSourceConfigurationRequest: type: object required: - MediaStreamName - EncodingName properties: EncodingName: allOf: - $ref: '#/components/schemas/EncodingName' - xml: name: encodingName description: The format you want to use to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. InputConfigurations: allOf: - $ref: '#/components/schemas/__listOfInputConfigurationRequest' - xml: name: inputConfigurations description: The transport parameters that you want to associate with the media stream. MediaStreamName: allOf: - $ref: '#/components/schemas/__string' - xml: name: mediaStreamName description: The name of the media stream. description: The definition of a media stream that you want to associate with the source. SetSourceRequest: 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: name: vpcInterfaceName description: The name of the VPC interface to use for this source. WhitelistCidr: allOf: - $ref: '#/components/schemas/__string' - xml: name: whitelistCidr description: 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: allOf: - $ref: '#/components/schemas/SetGatewayBridgeSourceRequest' - xml: name: gatewayBridgeSource description: The source configuration for cloud flows receiving a stream from a bridge. description: The settings for the source of the flow. FailoverConfig: type: object properties: FailoverMode: allOf: - $ref: '#/components/schemas/FailoverMode' - xml: name: failoverMode description: 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: allOf: - $ref: '#/components/schemas/__integer' - xml: name: recoveryWindow description: Search window time to look for dash-7 packets SourcePriority: allOf: - $ref: '#/components/schemas/SourcePriority' - xml: name: sourcePriority description: The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams. State: allOf: - $ref: '#/components/schemas/State' - xml: name: state description: The settings for source failover. __integer: type: integer __listOfMediaStreamOutputConfiguration: type: array items: $ref: '#/components/schemas/MediaStreamOutputConfiguration' __listOfInputConfiguration: type: array items: $ref: '#/components/schemas/InputConfiguration' __listOfDestinationConfigurationRequest: type: array items: $ref: '#/components/schemas/DestinationConfigurationRequest' CreateFlow420Exception: {} MediaStreamAttributesRequest: type: object properties: Fmtp: allOf: - $ref: '#/components/schemas/FmtpRequest' - xml: name: fmtp description: The settings that you want to use to define the media stream. Lang: allOf: - $ref: '#/components/schemas/__string' - xml: name: lang description: The audio language, in a format that is recognized by the receiver. description: Attributes that are related to the media stream. DestinationConfiguration: type: object required: - DestinationIp - DestinationPort - Interface - OutboundIp properties: DestinationIp: allOf: - $ref: '#/components/schemas/__string' - xml: name: destinationIp description: The IP address where contents of the media stream will be sent. DestinationPort: allOf: - $ref: '#/components/schemas/__integer' - xml: name: destinationPort description: The port to use when the content of the media stream is distributed to the output. Interface: allOf: - $ref: '#/components/schemas/Interface' - xml: name: interface description: The VPC interface that is used for the media stream associated with the output. OutboundIp: allOf: - $ref: '#/components/schemas/__string' - xml: name: outboundIp description: The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol. description: The transport parameters that are associated with an outbound media stream. AddFlowVpcInterfacesResponse: type: object properties: FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The ARN of the flow that these VPC interfaces were added to. VpcInterfaces: allOf: - $ref: '#/components/schemas/__listOfVpcInterface' - xml: name: vpcInterfaces description: The details of the newly added VPC interfaces. AddMediaStreamRequest: type: object required: - MediaStreamType - MediaStreamId - MediaStreamName properties: Attributes: allOf: - $ref: '#/components/schemas/MediaStreamAttributesRequest' - xml: name: attributes description: The attributes that you want to assign to the new media stream. ClockRate: allOf: - $ref: '#/components/schemas/__integer' - xml: name: clockRate description: 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: allOf: - $ref: '#/components/schemas/__string' - xml: name: description description: A description that can help you quickly identify what your media stream is used for. MediaStreamId: allOf: - $ref: '#/components/schemas/__integer' - xml: name: mediaStreamId description: A unique identifier for the media stream. MediaStreamName: allOf: - $ref: '#/components/schemas/__string' - xml: name: mediaStreamName description: A name that helps you distinguish one media stream from another. MediaStreamType: allOf: - $ref: '#/components/schemas/MediaStreamType' - xml: name: mediaStreamType description: The type of media stream. VideoFormat: allOf: - $ref: '#/components/schemas/__string' - xml: name: videoFormat description: The resolution of the video. description: The media stream that you want to add to the flow. TooManyRequestsException: {} __listOfMediaStream: type: array items: $ref: '#/components/schemas/MediaStream' UpdateFlowResponse: type: object properties: Flow: allOf: - $ref: '#/components/schemas/Flow' - xml: name: flow GatewayBridgeSource: type: object required: - BridgeArn properties: BridgeArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: bridgeArn description: The ARN of the bridge feeding this flow. VpcInterfaceAttachment: allOf: - $ref: '#/components/schemas/VpcInterfaceAttachment' - xml: name: vpcInterfaceAttachment description: The name of the VPC interface attachment to use for this bridge source. description: The source configuration for cloud flows receiving a stream from a bridge. __listOfMediaStreamSourceConfiguration: type: array items: $ref: '#/components/schemas/MediaStreamSourceConfiguration' ListFlowsResponse: type: object properties: Flows: allOf: - $ref: '#/components/schemas/__listOfListedFlow' - xml: name: flows description: A list of flow summaries. NextToken: allOf: - $ref: '#/components/schemas/__string' - xml: name: nextToken description: The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value. EncodingParameters: type: object required: - EncoderProfile - CompressionFactor properties: CompressionFactor: allOf: - $ref: '#/components/schemas/__double' - xml: name: compressionFactor description: '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: allOf: - $ref: '#/components/schemas/EncoderProfile' - xml: name: encoderProfile description: 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. description: 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. __listOfEntitlement: type: array items: $ref: '#/components/schemas/Entitlement' __listOf__string: type: array items: $ref: '#/components/schemas/__string' AddFlowOutputsResponse: type: object properties: FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The ARN of the flow that these outputs were added to. Outputs: allOf: - $ref: '#/components/schemas/__listOfOutput' - xml: name: outputs description: The details of the newly added outputs. Messages: type: object required: - Errors properties: Errors: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: errors description: A list of errors that might have been generated from processes on this flow. description: Messages that provide the state of the flow. Source: type: object required: - Name - SourceArn properties: DataTransferSubscriberFeePercent: allOf: - $ref: '#/components/schemas/__integer' - xml: name: dataTransferSubscriberFeePercent description: Percentage from 0-100 of the data transfer cost to be billed to the subscriber. Decryption: allOf: - $ref: '#/components/schemas/Encryption' - xml: name: decryption description: The type of encryption that is used on the content ingested from this source. 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' - xml: name: entitlementArn description: The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow. IngestIp: allOf: - $ref: '#/components/schemas/__string' - xml: name: ingestIp description: The IP address that the flow will be listening on for incoming content. IngestPort: allOf: - $ref: '#/components/schemas/__integer' - xml: name: ingestPort description: The port that the flow will be listening on for incoming content. MediaStreamSourceConfigurations: allOf: - $ref: '#/components/schemas/__listOfMediaStreamSourceConfiguration' - xml: name: mediaStreamSourceConfigurations description: The media streams that are associated with the source, and the parameters for those associations. Name: allOf: - $ref: '#/components/schemas/__string' - xml: name: name description: The name of 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. SourceArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: sourceArn description: The ARN of the source. Transport: allOf: - $ref: '#/components/schemas/Transport' - xml: name: transport description: Attributes related to the transport stream that are used in the source. VpcInterfaceName: allOf: - $ref: '#/components/schemas/__string' - xml: name: vpcInterfaceName description: The name of the VPC interface that is used for this source. WhitelistCidr: allOf: - $ref: '#/components/schemas/__string' - xml: name: whitelistCidr description: 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: allOf: - $ref: '#/components/schemas/GatewayBridgeSource' - xml: name: gatewayBridgeSource description: The source configuration for cloud flows receiving a stream from a bridge. description: The settings for the source of the flow. __listOfDestinationConfiguration: type: array items: $ref: '#/components/schemas/DestinationConfiguration' __listOfInputConfigurationRequest: type: array items: $ref: '#/components/schemas/InputConfigurationRequest' AddOutputRequest: type: object required: - Protocol properties: CidrAllowList: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: cidrAllowList description: 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. Description: allOf: - $ref: '#/components/schemas/__string' - xml: name: description description: A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user. Destination: allOf: - $ref: '#/components/schemas/__string' - xml: name: destination description: The IP address from which video will be sent to output destinations. Encryption: allOf: - $ref: '#/components/schemas/Encryption' - xml: name: encryption description: '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.' 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. MediaStreamOutputConfigurations: allOf: - $ref: '#/components/schemas/__listOfMediaStreamOutputConfigurationRequest' - xml: name: mediaStreamOutputConfigurations description: The media streams that are associated with the output, 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 output. This value must be unique within the current flow. Port: allOf: - $ref: '#/components/schemas/__integer' - xml: name: port description: The port to use when content is distributed to this output. Protocol: allOf: - $ref: '#/components/schemas/Protocol' - xml: name: protocol description: The protocol to use for the output. RemoteId: allOf: - $ref: '#/components/schemas/__string' - xml: name: remoteId description: The remote ID for the Zixi-pull output stream. 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. SmoothingLatency: allOf: - $ref: '#/components/schemas/__integer' - xml: name: smoothingLatency description: The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams. 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. VpcInterfaceAttachment: allOf: - $ref: '#/components/schemas/VpcInterfaceAttachment' - xml: name: vpcInterfaceAttachment description: The name of the VPC interface attachment to use for this output. description: The output that you want to add to this flow. ListedFlow: type: object required: - Status - Description - SourceType - AvailabilityZone - FlowArn - Name properties: AvailabilityZone: allOf: - $ref: '#/components/schemas/__string' - xml: name: availabilityZone description: The Availability Zone that the flow was created in. Description: allOf: - $ref: '#/components/schemas/__string' - xml: name: description description: A description of the flow. FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The ARN of the flow. Name: allOf: - $ref: '#/components/schemas/__string' - xml: name: name description: The name of the flow. SourceType: allOf: - $ref: '#/components/schemas/SourceType' - xml: name: sourceType description: The type of source. This value is either owned (originated somewhere other than an AWS Elemental MediaConnect flow owned by another AWS account) or entitled (originated at an AWS Elemental MediaConnect flow owned by another AWS account). Status: allOf: - $ref: '#/components/schemas/Status' - xml: name: status description: The current status of the flow. Maintenance: allOf: - $ref: '#/components/schemas/Maintenance' - xml: name: maintenance description: Provides a summary of a flow, including its ARN, Availability Zone, and source type. InputConfiguration: type: object required: - InputPort - InputIp - Interface properties: InputIp: allOf: - $ref: '#/components/schemas/__string' - xml: name: inputIp description: The IP address that the flow listens on for incoming content for a media stream. InputPort: allOf: - $ref: '#/components/schemas/__integer' - xml: name: inputPort description: The port that the flow listens on for an incoming media stream. Interface: allOf: - $ref: '#/components/schemas/Interface' - xml: name: interface description: The VPC interface where the media stream comes in from. description: The transport parameters that are associated with an incoming media stream. MediaStreamAttributes: type: object required: - Fmtp properties: Fmtp: allOf: - $ref: '#/components/schemas/Fmtp' - xml: name: fmtp description: A set of parameters that define the media stream. Lang: allOf: - $ref: '#/components/schemas/__string' - xml: name: lang description: The audio language, in a format that is recognized by the receiver. description: Attributes that are related to the media stream. Maintenance: type: object properties: MaintenanceDay: allOf: - $ref: '#/components/schemas/MaintenanceDay' - xml: name: maintenanceDay description: A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday. MaintenanceDeadline: allOf: - $ref: '#/components/schemas/__string' - xml: name: maintenanceDeadline description: 'The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.' MaintenanceScheduledDate: allOf: - $ref: '#/components/schemas/__string' - xml: name: maintenanceScheduledDate description: 'A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.' MaintenanceStartHour: allOf: - $ref: '#/components/schemas/__string' - xml: name: maintenanceStartHour description: '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.' description: The maintenance setting of a flow SourceType: type: string enum: - OWNED - ENTITLED RevokeFlowEntitlementResponse: type: object properties: EntitlementArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: entitlementArn description: The ARN of the entitlement that was revoked. FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The ARN of the flow that the entitlement was revoked from. Output: type: object required: - OutputArn - Name properties: DataTransferSubscriberFeePercent: allOf: - $ref: '#/components/schemas/__integer' - xml: name: dataTransferSubscriberFeePercent description: Percentage from 0-100 of the data transfer cost to be billed to the subscriber. Description: allOf: - $ref: '#/components/schemas/__string' - xml: name: description description: A description of the output. Destination: allOf: - $ref: '#/components/schemas/__string' - xml: name: destination description: The address where you want to send the output. Encryption: allOf: - $ref: '#/components/schemas/Encryption' - xml: name: encryption description: The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). EntitlementArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: entitlementArn description: The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows. ListenerAddress: allOf: - $ref: '#/components/schemas/__string' - xml: name: listenerAddress description: 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: allOf: - $ref: '#/components/schemas/__string' - xml: name: mediaLiveInputArn description: The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input. MediaStreamOutputConfigurations: allOf: - $ref: '#/components/schemas/__listOfMediaStreamOutputConfiguration' - xml: name: mediaStreamOutputConfigurations description: The configuration for each media stream that is associated with the output. Name: allOf: - $ref: '#/components/schemas/__string' - xml: name: name description: The name of the output. This value must be unique within the current flow. OutputArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: outputArn description: The ARN of the output. Port: allOf: - $ref: '#/components/schemas/__integer' - xml: name: port description: The port to use when content is distributed to this output. Transport: allOf: - $ref: '#/components/schemas/Transport' - xml: name: transport description: Attributes related to the transport stream that are used in the output. VpcInterfaceAttachment: allOf: - $ref: '#/components/schemas/VpcInterfaceAttachment' - xml: name: vpcInterfaceAttachment description: The name of the VPC interface attachment to use for this output. BridgeArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: bridgeArn description: The ARN of the bridge that added this output. BridgePorts: allOf: - $ref: '#/components/schemas/__listOf__integer' - xml: name: bridgePorts description: The bridge output ports currently in use. description: The settings for an output. RemoveFlowVpcInterfaceResponse: type: object properties: FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The ARN of the flow that is associated with the VPC interface you removed. NonDeletedNetworkInterfaceIds: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: nonDeletedNetworkInterfaceIds description: IDs of network interfaces associated with the removed VPC interface that Media Connect was unable to remove. VpcInterfaceName: allOf: - $ref: '#/components/schemas/__string' - xml: name: vpcInterfaceName description: The name of the VPC interface that was removed. State: type: string enum: - ENABLED - DISABLED Transport: type: object required: - Protocol properties: CidrAllowList: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: cidrAllowList description: 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. 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. 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. Protocol: allOf: - $ref: '#/components/schemas/Protocol' - xml: name: protocol description: The protocol that is used by the source or output. RemoteId: allOf: - $ref: '#/components/schemas/__string' - xml: name: remoteId description: The remote ID for the Zixi-pull stream. 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. SmoothingLatency: allOf: - $ref: '#/components/schemas/__integer' - xml: name: smoothingLatency description: The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams. 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. description: Attributes related to the transport stream that are used in a source or output. Fmtp: type: object properties: ChannelOrder: allOf: - $ref: '#/components/schemas/__string' - xml: name: channelOrder description: The format of the audio channel. Colorimetry: allOf: - $ref: '#/components/schemas/Colorimetry' - xml: name: colorimetry description: The format that is used for the representation of color. ExactFramerate: allOf: - $ref: '#/components/schemas/__string' - xml: name: exactFramerate description: '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: allOf: - $ref: '#/components/schemas/__string' - xml: name: par description: The pixel aspect ratio (PAR) of the video. Range: allOf: - $ref: '#/components/schemas/Range' - xml: name: range description: The encoding range of the video. ScanMode: allOf: - $ref: '#/components/schemas/ScanMode' - xml: name: scanMode description: The type of compression that was used to smooth the video’s appearance Tcs: allOf: - $ref: '#/components/schemas/Tcs' - xml: name: tcs description: The transfer characteristic system (TCS) that is used in the video. description: FMTP Entitlement: type: object required: - EntitlementArn - Subscribers - Name properties: DataTransferSubscriberFeePercent: allOf: - $ref: '#/components/schemas/__integer' - xml: name: dataTransferSubscriberFeePercent description: Percentage from 0-100 of the data transfer cost to be billed to the subscriber. Description: allOf: - $ref: '#/components/schemas/__string' - xml: name: description description: A description of the entitlement. Encryption: allOf: - $ref: '#/components/schemas/Encryption' - xml: name: encryption description: The type of encryption that will be used on the output that is associated with this entitlement. EntitlementArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: entitlementArn description: The ARN of the entitlement. EntitlementStatus: allOf: - $ref: '#/components/schemas/EntitlementStatus' - xml: name: entitlementStatus description: An indication of whether the entitlement is enabled. Name: allOf: - $ref: '#/components/schemas/__string' - xml: name: name description: The name of the entitlement. Subscribers: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: subscribers description: The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source. description: The settings for a flow entitlement. NotFoundException: {} VpcInterfaceAttachment: type: object properties: VpcInterfaceName: allOf: - $ref: '#/components/schemas/__string' - xml: name: vpcInterfaceName description: The name of the VPC interface to use for this resource. description: The settings for attaching a VPC interface to an resource. DescribeFlowResponse: type: object properties: Flow: allOf: - $ref: '#/components/schemas/Flow' - xml: name: flow Messages: allOf: - $ref: '#/components/schemas/Messages' - xml: name: messages ServiceUnavailableException: {} StopFlowResponse: type: object properties: FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The ARN of the flow that you stopped. Status: allOf: - $ref: '#/components/schemas/Status' - xml: name: status description: The status of the flow when the StopFlow process begins. RemoveFlowOutputResponse: type: object properties: FlowArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: flowArn description: The ARN of the flow that is associated with the output you removed. OutputArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: outputArn description: The ARN of the output that was removed. MediaStreamOutputConfiguration: type: object required: - MediaStreamName - EncodingName properties: DestinationConfigurations: allOf: - $ref: '#/components/schemas/__listOfDestinationConfiguration' - xml: name: destinationConfigurations description: The transport parameters that are associated with each outbound media stream. EncodingName: allOf: - $ref: '#/components/schemas/EncodingName' - xml: name: encodingName description: 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: allOf: - $ref: '#/components/schemas/EncodingParameters' - xml: name: encodingParameters description: Encoding parameters MediaStreamName: allOf: - $ref: '#/components/schemas/__string' - xml: name: mediaStreamName description: The name of the media stream. description: The media stream that is associated with the output, and the parameters for that association. parameters: X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/mediaconnect/ x-hasEquivalentPaths: true