openapi: 3.0.0 info: version: 2018-11-14 x-release: v4 title: AWS MediaConnect 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 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/mediaconnect/ 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) x-hasEquivalentPaths: true paths: "/v1/bridges/{bridgeArn}/outputs": post: operationId: AddBridgeOutputs description: Adds outputs to an existing bridge. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/AddBridgeOutputsResponse" examples: AddBridgeOutputs202Example: summary: Default AddBridgeOutputs 202 response x-microcks-default: true value: BridgeArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow Outputs: example-value "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: AddBridgeOutputs480Example: summary: Default AddBridgeOutputs 480 response x-microcks-default: true value: result: success "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: AddBridgeOutputs481Example: summary: Default AddBridgeOutputs 481 response x-microcks-default: true value: result: success "482": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: AddBridgeOutputs482Example: summary: Default AddBridgeOutputs 482 response x-microcks-default: true value: result: success "483": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: AddBridgeOutputs483Example: summary: Default AddBridgeOutputs 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: AddBridgeOutputs484Example: summary: Default AddBridgeOutputs 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AddBridgeOutputs485Example: summary: Default AddBridgeOutputs 485 response x-microcks-default: true value: result: success "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: AddBridgeOutputs486Example: summary: Default AddBridgeOutputs 486 response x-microcks-default: true value: result: success parameters: - name: bridgeArn in: path required: true description: The ARN of the bridge 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 required: - outputs properties: outputs: description: The outputs that you want to add to this bridge. type: array items: $ref: "#/components/schemas/AddBridgeOutputRequest" summary: Amazon MediaConnect Add Bridge Outputs x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/bridges/{bridgeArn}/sources": post: operationId: AddBridgeSources description: Adds sources to an existing bridge. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/AddBridgeSourcesResponse" examples: AddBridgeSources202Example: summary: Default AddBridgeSources 202 response x-microcks-default: true value: BridgeArn: 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: AddBridgeSources480Example: summary: Default AddBridgeSources 480 response x-microcks-default: true value: result: success "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: AddBridgeSources481Example: summary: Default AddBridgeSources 481 response x-microcks-default: true value: result: success "482": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: AddBridgeSources482Example: summary: Default AddBridgeSources 482 response x-microcks-default: true value: result: success "483": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: AddBridgeSources483Example: summary: Default AddBridgeSources 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: AddBridgeSources484Example: summary: Default AddBridgeSources 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AddBridgeSources485Example: summary: Default AddBridgeSources 485 response x-microcks-default: true value: result: success "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: AddBridgeSources486Example: summary: Default AddBridgeSources 486 response x-microcks-default: true value: result: success parameters: - name: bridgeArn in: path required: true description: The ARN of the bridge 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 required: - sources properties: sources: description: The sources that you want to add to this bridge. type: array items: $ref: "#/components/schemas/AddBridgeSourceRequest" summary: Amazon MediaConnect Add Bridge Sources x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/flows/{flowArn}/mediaStreams": 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 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" "/v1/flows/{flowArn}/outputs": 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 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" "/v1/flows/{flowArn}/source": 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 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" "/v1/flows/{flowArn}/vpcInterfaces": 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 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" /v1/bridges: post: operationId: CreateBridge description: Creates a new bridge. The request must include one source. responses: "201": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateBridgeResponse" examples: CreateBridge201Example: summary: Default CreateBridge 201 response x-microcks-default: true value: Bridge: example-value "480": description: CreateBridge420Exception content: application/json: schema: $ref: "#/components/schemas/CreateBridge420Exception" examples: CreateBridge480Example: summary: Default CreateBridge 480 response x-microcks-default: true value: result: success "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: CreateBridge481Example: summary: Default CreateBridge 481 response x-microcks-default: true value: result: success "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: CreateBridge482Example: summary: Default CreateBridge 482 response x-microcks-default: true value: result: success "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: CreateBridge483Example: summary: Default CreateBridge 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: CreateBridge484Example: summary: Default CreateBridge 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: CreateBridge485Example: summary: Default CreateBridge 485 response x-microcks-default: true value: result: success "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: CreateBridge486Example: summary: Default CreateBridge 486 response x-microcks-default: true value: result: success parameters: [] requestBody: required: true content: application/json: schema: type: object required: - name - placementArn - sources properties: egressGatewayBridge: description: Create a bridge with the egress bridge type. An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises. type: object properties: MaxBitrate: allOf: - $ref: "#/components/schemas/__integer" - xml: name: maxBitrate description: The maximum expected bitrate (in bps). ingressGatewayBridge: description: Create a bridge with the ingress bridge type. An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud. type: object properties: MaxBitrate: allOf: - $ref: "#/components/schemas/__integer" - xml: name: maxBitrate description: The maximum expected bitrate (in bps). MaxOutputs: allOf: - $ref: "#/components/schemas/__integer" - xml: name: maxOutputs description: The maximum number of expected outputs. name: description: The name of the bridge. This name can not be modified after the bridge is created. type: string outputs: description: The outputs that you want to add to this bridge. type: array items: $ref: "#/components/schemas/AddBridgeOutputRequest" placementArn: description: The bridge placement Amazon Resource Number (ARN). type: string 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: The sources that you want to add to this bridge. type: array items: $ref: "#/components/schemas/AddBridgeSourceRequest" summary: Amazon MediaConnect Create Bridge x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" get: operationId: ListBridges description: Displays a list of bridges that are associated with this account and an optionally specified Arn. This request returns a paginated result. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListBridgesResponse" examples: ListBridges200Example: summary: Default ListBridges 200 response x-microcks-default: true value: Bridges: example-value NextToken: example-value "480": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: ListBridges480Example: summary: Default ListBridges 480 response x-microcks-default: true value: result: success "481": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: ListBridges481Example: summary: Default ListBridges 481 response x-microcks-default: true value: result: success "482": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: ListBridges482Example: summary: Default ListBridges 482 response x-microcks-default: true value: result: success "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: ListBridges483Example: summary: Default ListBridges 483 response x-microcks-default: true value: result: success "484": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: ListBridges484Example: summary: Default ListBridges 484 response x-microcks-default: true value: result: success parameters: - name: filterArn in: query required: false description: Filter the list results to display only the bridges associated with the selected Amazon Resource Name (ARN). schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow - name: maxResults in: query required: false description: The maximum number of results to return per API request. For example, you submit a ListBridges request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page. 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 ListBridges request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListBridges request a second time and specify the NextToken value. 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 Bridges x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1/flows: 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 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" 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 /v1/gateways: post: operationId: CreateGateway description: Creates a new gateway. The request must include at least one network (up to 4). responses: "201": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateGatewayResponse" examples: CreateGateway201Example: summary: Default CreateGateway 201 response x-microcks-default: true value: Gateway: example-value "480": description: CreateGateway420Exception content: application/json: schema: $ref: "#/components/schemas/CreateGateway420Exception" examples: CreateGateway480Example: summary: Default CreateGateway 480 response x-microcks-default: true value: result: success "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: CreateGateway481Example: summary: Default CreateGateway 481 response x-microcks-default: true value: result: success "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: CreateGateway482Example: summary: Default CreateGateway 482 response x-microcks-default: true value: result: success "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: CreateGateway483Example: summary: Default CreateGateway 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: CreateGateway484Example: summary: Default CreateGateway 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: CreateGateway485Example: summary: Default CreateGateway 485 response x-microcks-default: true value: result: success "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: CreateGateway486Example: summary: Default CreateGateway 486 response x-microcks-default: true value: result: success parameters: [] requestBody: required: true content: application/json: schema: type: object required: - egressCidrBlocks - name - networks properties: egressCidrBlocks: description: The range of IP addresses that are allowed to contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. type: array items: $ref: "#/components/schemas/__string" name: description: The name of the gateway. This name can not be modified after the gateway is created. type: string networks: description: The list of networks that you want to add. type: array items: $ref: "#/components/schemas/GatewayNetwork" summary: Amazon MediaConnect Create Gateway x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" get: operationId: ListGateways description: Displays a list of gateways that are associated with this account. This request returns a paginated result. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListGatewaysResponse" examples: ListGateways200Example: summary: Default ListGateways 200 response x-microcks-default: true value: Gateways: example-value NextToken: example-value "480": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: ListGateways480Example: summary: Default ListGateways 480 response x-microcks-default: true value: result: success "481": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: ListGateways481Example: summary: Default ListGateways 481 response x-microcks-default: true value: result: success "482": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: ListGateways482Example: summary: Default ListGateways 482 response x-microcks-default: true value: result: success "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: ListGateways483Example: summary: Default ListGateways 483 response x-microcks-default: true value: result: success "484": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: ListGateways484Example: summary: Default ListGateways 484 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 ListGateways request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page. 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 ListGateways request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListGateways request a second time and specify the NextToken value. 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 Gateways x-microcks-operation: delay: 0 dispatcher: FALLBACK "/v1/bridges/{bridgeArn}": delete: operationId: DeleteBridge description: Deletes a bridge. Before you can delete a bridge, you must stop the bridge. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteBridgeResponse" examples: DeleteBridge200Example: summary: Default DeleteBridge 200 response x-microcks-default: true value: BridgeArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: DeleteBridge480Example: summary: Default DeleteBridge 480 response x-microcks-default: true value: result: success "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: DeleteBridge481Example: summary: Default DeleteBridge 481 response x-microcks-default: true value: result: success "482": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: DeleteBridge482Example: summary: Default DeleteBridge 482 response x-microcks-default: true value: result: success "483": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: DeleteBridge483Example: summary: Default DeleteBridge 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: DeleteBridge484Example: summary: Default DeleteBridge 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DeleteBridge485Example: summary: Default DeleteBridge 485 response x-microcks-default: true value: result: success "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: DeleteBridge486Example: summary: Default DeleteBridge 486 response x-microcks-default: true value: result: success parameters: - name: bridgeArn in: path required: true description: The ARN of the bridge that you want to delete. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow summary: Amazon MediaConnect Delete Bridge x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" get: operationId: DescribeBridge description: Displays the details of a bridge. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeBridgeResponse" examples: DescribeBridge200Example: summary: Default DescribeBridge 200 response x-microcks-default: true value: Bridge: example-value "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: DescribeBridge480Example: summary: Default DescribeBridge 480 response x-microcks-default: true value: result: success "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: DescribeBridge481Example: summary: Default DescribeBridge 481 response x-microcks-default: true value: result: success "482": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: DescribeBridge482Example: summary: Default DescribeBridge 482 response x-microcks-default: true value: result: success "483": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: DescribeBridge483Example: summary: Default DescribeBridge 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: DescribeBridge484Example: summary: Default DescribeBridge 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DescribeBridge485Example: summary: Default DescribeBridge 485 response x-microcks-default: true value: result: success "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: DescribeBridge486Example: summary: Default DescribeBridge 486 response x-microcks-default: true value: result: success parameters: - name: bridgeArn in: path required: true description: The ARN of the bridge that you want to describe. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow summary: Amazon MediaConnect Describe Bridge x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateBridge description: Updates the bridge responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateBridgeResponse" examples: UpdateBridge202Example: summary: Default UpdateBridge 202 response x-microcks-default: true value: Bridge: example-value "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: UpdateBridge480Example: summary: Default UpdateBridge 480 response x-microcks-default: true value: result: success "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: UpdateBridge481Example: summary: Default UpdateBridge 481 response x-microcks-default: true value: result: success "482": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: UpdateBridge482Example: summary: Default UpdateBridge 482 response x-microcks-default: true value: result: success "483": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: UpdateBridge483Example: summary: Default UpdateBridge 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: UpdateBridge484Example: summary: Default UpdateBridge 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: UpdateBridge485Example: summary: Default UpdateBridge 485 response x-microcks-default: true value: result: success "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: UpdateBridge486Example: summary: Default UpdateBridge 486 response x-microcks-default: true value: result: success parameters: - name: bridgeArn in: path required: true description: The Amazon Resource Number (ARN) of the bridge 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: egressGatewayBridge: description: "" type: object properties: MaxBitrate: allOf: - $ref: "#/components/schemas/__integer" - xml: name: maxBitrate description: Update an existing egress-type bridge. ingressGatewayBridge: description: "" type: object properties: MaxBitrate: allOf: - $ref: "#/components/schemas/__integer" - xml: name: maxBitrate description: The maximum expected bitrate (in bps). MaxOutputs: allOf: - $ref: "#/components/schemas/__integer" - xml: name: maxOutputs description: The maximum number of expected outputs. 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 summary: Amazon MediaConnect Update Bridge x-microcks-operation: delay: 0 dispatcher: FALLBACK "/v1/flows/{flowArn}": 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 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" 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 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 "/v1/gateways/{gatewayArn}": delete: operationId: DeleteGateway description: Deletes a gateway. Before you can delete a gateway, you must deregister its instances and delete its bridges. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteGatewayResponse" examples: DeleteGateway200Example: summary: Default DeleteGateway 200 response x-microcks-default: true value: GatewayArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: DeleteGateway480Example: summary: Default DeleteGateway 480 response x-microcks-default: true value: result: success "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: DeleteGateway481Example: summary: Default DeleteGateway 481 response x-microcks-default: true value: result: success "482": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: DeleteGateway482Example: summary: Default DeleteGateway 482 response x-microcks-default: true value: result: success "483": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: DeleteGateway483Example: summary: Default DeleteGateway 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: DeleteGateway484Example: summary: Default DeleteGateway 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DeleteGateway485Example: summary: Default DeleteGateway 485 response x-microcks-default: true value: result: success "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: DeleteGateway486Example: summary: Default DeleteGateway 486 response x-microcks-default: true value: result: success parameters: - name: gatewayArn in: path required: true description: The ARN of the gateway that you want to delete. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow summary: Amazon MediaConnect Delete Gateway x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" get: operationId: DescribeGateway description: Displays the details of a gateway. The response includes the gateway ARN, name, and CIDR blocks, as well as details about the networks. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeGatewayResponse" examples: DescribeGateway200Example: summary: Default DescribeGateway 200 response x-microcks-default: true value: Gateway: example-value "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: DescribeGateway480Example: summary: Default DescribeGateway 480 response x-microcks-default: true value: result: success "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: DescribeGateway481Example: summary: Default DescribeGateway 481 response x-microcks-default: true value: result: success "482": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: DescribeGateway482Example: summary: Default DescribeGateway 482 response x-microcks-default: true value: result: success "483": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: DescribeGateway483Example: summary: Default DescribeGateway 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: DescribeGateway484Example: summary: Default DescribeGateway 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DescribeGateway485Example: summary: Default DescribeGateway 485 response x-microcks-default: true value: result: success "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: DescribeGateway486Example: summary: Default DescribeGateway 486 response x-microcks-default: true value: result: success parameters: - name: gatewayArn in: path required: true description: The Amazon Resource Name (ARN) of the gateway that you want to describe. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow summary: Amazon MediaConnect Describe Gateway x-microcks-operation: delay: 0 dispatcher: FALLBACK "/v1/gateway-instances/{gatewayInstanceArn}": delete: operationId: DeregisterGatewayInstance description: Deregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/DeregisterGatewayInstanceResponse" examples: DeregisterGatewayInstance202Example: summary: Default DeregisterGatewayInstance 202 response x-microcks-default: true value: GatewayInstanceArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow InstanceState: example-value "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: DeregisterGatewayInstance480Example: summary: Default DeregisterGatewayInstance 480 response x-microcks-default: true value: result: success "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: DeregisterGatewayInstance481Example: summary: Default DeregisterGatewayInstance 481 response x-microcks-default: true value: result: success "482": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: DeregisterGatewayInstance482Example: summary: Default DeregisterGatewayInstance 482 response x-microcks-default: true value: result: success "483": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: DeregisterGatewayInstance483Example: summary: Default DeregisterGatewayInstance 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: DeregisterGatewayInstance484Example: summary: Default DeregisterGatewayInstance 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DeregisterGatewayInstance485Example: summary: Default DeregisterGatewayInstance 485 response x-microcks-default: true value: result: success "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: DeregisterGatewayInstance486Example: summary: Default DeregisterGatewayInstance 486 response x-microcks-default: true value: result: success parameters: - name: force in: query required: false description: Force the deregistration of an instance. Force will deregister an instance, even if there are bridges running on it. schema: type: boolean example: true - name: gatewayInstanceArn in: path required: true description: The Amazon Resource Name (ARN) of the gateway that contains the instance that you want to deregister. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow summary: Amazon MediaConnect Deregister Gateway Instance x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" get: operationId: DescribeGatewayInstance description: Displays the details of an instance. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeGatewayInstanceResponse" examples: DescribeGatewayInstance200Example: summary: Default DescribeGatewayInstance 200 response x-microcks-default: true value: GatewayInstance: example-value "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: DescribeGatewayInstance480Example: summary: Default DescribeGatewayInstance 480 response x-microcks-default: true value: result: success "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: DescribeGatewayInstance481Example: summary: Default DescribeGatewayInstance 481 response x-microcks-default: true value: result: success "482": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: DescribeGatewayInstance482Example: summary: Default DescribeGatewayInstance 482 response x-microcks-default: true value: result: success "483": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: DescribeGatewayInstance483Example: summary: Default DescribeGatewayInstance 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: DescribeGatewayInstance484Example: summary: Default DescribeGatewayInstance 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DescribeGatewayInstance485Example: summary: Default DescribeGatewayInstance 485 response x-microcks-default: true value: result: success "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: DescribeGatewayInstance486Example: summary: Default DescribeGatewayInstance 486 response x-microcks-default: true value: result: success parameters: - name: gatewayInstanceArn in: path required: true description: The Amazon Resource Name (ARN) of the gateway instance that you want to describe. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow summary: Amazon MediaConnect Describe Gateway Instance x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateGatewayInstance description: Updates the configuration of an existing Gateway Instance. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateGatewayInstanceResponse" examples: UpdateGatewayInstance200Example: summary: Default UpdateGatewayInstance 200 response x-microcks-default: true value: BridgePlacement: example-value GatewayInstanceArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: UpdateGatewayInstance480Example: summary: Default UpdateGatewayInstance 480 response x-microcks-default: true value: result: success "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: UpdateGatewayInstance481Example: summary: Default UpdateGatewayInstance 481 response x-microcks-default: true value: result: success "482": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: UpdateGatewayInstance482Example: summary: Default UpdateGatewayInstance 482 response x-microcks-default: true value: result: success "483": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: UpdateGatewayInstance483Example: summary: Default UpdateGatewayInstance 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: UpdateGatewayInstance484Example: summary: Default UpdateGatewayInstance 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: UpdateGatewayInstance485Example: summary: Default UpdateGatewayInstance 485 response x-microcks-default: true value: result: success "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: UpdateGatewayInstance486Example: summary: Default UpdateGatewayInstance 486 response x-microcks-default: true value: result: success parameters: - name: gatewayInstanceArn in: path required: true description: The Amazon Resource Name (ARN) of the instance 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: bridgePlacement: description: The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be added to this instance. type: string enum: - AVAILABLE - LOCKED summary: Amazon MediaConnect Update Gateway Instance x-microcks-operation: delay: 0 dispatcher: FALLBACK "/v1/offerings/{offeringArn}": get: operationId: DescribeOffering description: Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN). responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeOfferingResponse" examples: DescribeOffering200Example: summary: Default DescribeOffering 200 response x-microcks-default: true value: Offering: example-value "480": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: DescribeOffering480Example: summary: Default DescribeOffering 480 response x-microcks-default: true value: result: success "481": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: DescribeOffering481Example: summary: Default DescribeOffering 481 response x-microcks-default: true value: result: success "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DescribeOffering482Example: summary: Default DescribeOffering 482 response x-microcks-default: true value: result: success "483": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: DescribeOffering483Example: summary: Default DescribeOffering 483 response x-microcks-default: true value: result: success "484": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: DescribeOffering484Example: summary: Default DescribeOffering 484 response x-microcks-default: true value: result: success parameters: - name: offeringArn in: path required: true description: The Amazon Resource Name (ARN) of the offering. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow summary: Amazon MediaConnect Describe Offering x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: PurchaseOffering description: Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering. responses: "201": description: Success content: application/json: schema: $ref: "#/components/schemas/PurchaseOfferingResponse" examples: PurchaseOffering201Example: summary: Default PurchaseOffering 201 response x-microcks-default: true value: Reservation: example-value "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: PurchaseOffering480Example: summary: Default PurchaseOffering 480 response x-microcks-default: true value: result: success "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: PurchaseOffering481Example: summary: Default PurchaseOffering 481 response x-microcks-default: true value: result: success "482": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: PurchaseOffering482Example: summary: Default PurchaseOffering 482 response x-microcks-default: true value: result: success "483": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: PurchaseOffering483Example: summary: Default PurchaseOffering 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: PurchaseOffering484Example: summary: Default PurchaseOffering 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: PurchaseOffering485Example: summary: Default PurchaseOffering 485 response x-microcks-default: true value: result: success parameters: - name: offeringArn in: path required: true description: The Amazon Resource Name (ARN) of the offering. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow requestBody: required: true content: application/json: schema: type: object required: - reservationName - start properties: reservationName: description: The name that you want to use for the reservation. type: string start: description: "The date and time that you want the reservation to begin, in Coordinated Universal Time (UTC). You can specify any date and time between 12:00am on the first day of the current month to the current time on today's date, inclusive. Specify the start in a 24-hour notation. Use the following format: YYYY-MM-DDTHH:mm:SSZ, where T and Z are literal characters. For example, to specify 11:30pm on March 5, 2020, enter 2020-03-05T23:30:00Z." type: string summary: Amazon MediaConnect Purchase Offering x-microcks-operation: delay: 0 dispatcher: FALLBACK "/v1/reservations/{reservationArn}": get: operationId: DescribeReservation description: Displays the details of a reservation. The response includes the reservation name, state, start date and time, and the details of the offering that make up the rest of the reservation (such as price, duration, and outbound bandwidth). responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeReservationResponse" examples: DescribeReservation200Example: summary: Default DescribeReservation 200 response x-microcks-default: true value: Reservation: example-value "480": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: DescribeReservation480Example: summary: Default DescribeReservation 480 response x-microcks-default: true value: result: success "481": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: DescribeReservation481Example: summary: Default DescribeReservation 481 response x-microcks-default: true value: result: success "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DescribeReservation482Example: summary: Default DescribeReservation 482 response x-microcks-default: true value: result: success "483": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: DescribeReservation483Example: summary: Default DescribeReservation 483 response x-microcks-default: true value: result: success "484": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: DescribeReservation484Example: summary: Default DescribeReservation 484 response x-microcks-default: true value: result: success parameters: - name: reservationArn in: path required: true description: The Amazon Resource Name (ARN) of the reservation. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow summary: Amazon MediaConnect Describe Reservation x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/flows/{flowArn}/entitlements": 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 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" /v1/entitlements: get: operationId: ListEntitlements description: Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListEntitlementsResponse" examples: ListEntitlements200Example: summary: Default ListEntitlements 200 response x-microcks-default: true value: Entitlements: example-value NextToken: example-value "480": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: ListEntitlements480Example: summary: Default ListEntitlements 480 response x-microcks-default: true value: result: success "481": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: ListEntitlements481Example: summary: Default ListEntitlements 481 response x-microcks-default: true value: result: success "482": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: ListEntitlements482Example: summary: Default ListEntitlements 482 response x-microcks-default: true value: result: success "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: ListEntitlements483Example: summary: Default ListEntitlements 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 ListEntitlements request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 20 results per page. 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 ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value. 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 Entitlements x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /v1/gateway-instances: get: operationId: ListGatewayInstances description: Displays a list of instances associated with the AWS account. This request returns a paginated result. You can use the filterArn property to display only the instances associated with the selected Gateway Amazon Resource Name (ARN). responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListGatewayInstancesResponse" examples: ListGatewayInstances200Example: summary: Default ListGatewayInstances 200 response x-microcks-default: true value: Instances: example-value NextToken: example-value "480": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: ListGatewayInstances480Example: summary: Default ListGatewayInstances 480 response x-microcks-default: true value: result: success "481": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: ListGatewayInstances481Example: summary: Default ListGatewayInstances 481 response x-microcks-default: true value: result: success "482": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: ListGatewayInstances482Example: summary: Default ListGatewayInstances 482 response x-microcks-default: true value: result: success "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: ListGatewayInstances483Example: summary: Default ListGatewayInstances 483 response x-microcks-default: true value: result: success "484": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: ListGatewayInstances484Example: summary: Default ListGatewayInstances 484 response x-microcks-default: true value: result: success parameters: - name: filterArn in: query required: false description: Filter the list results to display only the instances associated with the selected Gateway Amazon Resource Name (ARN). schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow - name: maxResults in: query required: false description: The maximum number of results to return per API request. For example, you submit a ListInstances request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page. 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 ListInstances request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListInstances request a second time and specify the NextToken value. 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 Gateway Instances x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /v1/offerings: get: operationId: ListOfferings description: Displays a list of all offerings that are available to this account in the current AWS Region. If you have an active reservation (which means you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListOfferingsResponse" examples: ListOfferings200Example: summary: Default ListOfferings 200 response x-microcks-default: true value: NextToken: example-value Offerings: example-value "480": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: ListOfferings480Example: summary: Default ListOfferings 480 response x-microcks-default: true value: result: success "481": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: ListOfferings481Example: summary: Default ListOfferings 481 response x-microcks-default: true value: result: success "482": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: ListOfferings482Example: summary: Default ListOfferings 482 response x-microcks-default: true value: result: success "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: ListOfferings483Example: summary: Default ListOfferings 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 ListOfferings request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page. 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 ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value. 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 Offerings x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /v1/reservations: get: operationId: ListReservations description: Displays a list of all reservations that have been purchased by this account in the current AWS Region. This list includes all reservations in all states (such as active and expired). responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListReservationsResponse" examples: ListReservations200Example: summary: Default ListReservations 200 response x-microcks-default: true value: NextToken: example-value Reservations: example-value "480": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: ListReservations480Example: summary: Default ListReservations 480 response x-microcks-default: true value: result: success "481": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: ListReservations481Example: summary: Default ListReservations 481 response x-microcks-default: true value: result: success "482": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: ListReservations482Example: summary: Default ListReservations 482 response x-microcks-default: true value: result: success "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: ListReservations483Example: summary: Default ListReservations 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 ListReservations request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page. 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 ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value. 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 Reservations x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/tags/{resourceArn}": get: operationId: ListTagsForResource description: List all tags on an AWS Elemental MediaConnect resource responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListTagsForResourceResponse" examples: ListTagsForResource200Example: summary: Default ListTagsForResource 200 response x-microcks-default: true value: Tags: example-value "480": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: ListTagsForResource480Example: summary: Default ListTagsForResource 480 response x-microcks-default: true value: result: success "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: ListTagsForResource481Example: summary: Default ListTagsForResource 481 response x-microcks-default: true value: result: success "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: ListTagsForResource482Example: summary: Default ListTagsForResource 482 response x-microcks-default: true value: result: success parameters: - name: resourceArn in: path required: true description: The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource for which to list the tags. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow summary: Amazon MediaConnect List Tags for Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: TagResource description: Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. responses: "204": description: Success "480": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: TagResource480Example: summary: Default TagResource 480 response x-microcks-default: true value: result: success "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: TagResource481Example: summary: Default TagResource 481 response x-microcks-default: true value: result: success "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: TagResource482Example: summary: Default TagResource 482 response x-microcks-default: true value: result: success parameters: - name: resourceArn in: path required: true description: The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource to which to add tags. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow requestBody: required: true content: application/json: schema: type: object required: - tags properties: tags: description: A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. type: object additionalProperties: $ref: "#/components/schemas/__string" summary: Amazon MediaConnect Tag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK "/v1/bridges/{bridgeArn}/outputs/{outputName}": delete: operationId: RemoveBridgeOutput description: Removes an output from a bridge. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/RemoveBridgeOutputResponse" examples: RemoveBridgeOutput202Example: summary: Default RemoveBridgeOutput 202 response x-microcks-default: true value: BridgeArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow OutputName: example-flow "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: RemoveBridgeOutput480Example: summary: Default RemoveBridgeOutput 480 response x-microcks-default: true value: result: success "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: RemoveBridgeOutput481Example: summary: Default RemoveBridgeOutput 481 response x-microcks-default: true value: result: success "482": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: RemoveBridgeOutput482Example: summary: Default RemoveBridgeOutput 482 response x-microcks-default: true value: result: success "483": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: RemoveBridgeOutput483Example: summary: Default RemoveBridgeOutput 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: RemoveBridgeOutput484Example: summary: Default RemoveBridgeOutput 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: RemoveBridgeOutput485Example: summary: Default RemoveBridgeOutput 485 response x-microcks-default: true value: result: success "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: RemoveBridgeOutput486Example: summary: Default RemoveBridgeOutput 486 response x-microcks-default: true value: result: success parameters: - name: bridgeArn in: path required: true description: The ARN of the bridge that you want to update. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow - name: outputName in: path required: true description: The name of the bridge output that you want to remove. schema: type: string example: example-flow summary: Amazon MediaConnect Remove Bridge Output x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" put: operationId: UpdateBridgeOutput description: Updates an existing bridge output. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateBridgeOutputResponse" examples: UpdateBridgeOutput202Example: summary: Default UpdateBridgeOutput 202 response x-microcks-default: true value: BridgeArn: 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: UpdateBridgeOutput480Example: summary: Default UpdateBridgeOutput 480 response x-microcks-default: true value: result: success "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: UpdateBridgeOutput481Example: summary: Default UpdateBridgeOutput 481 response x-microcks-default: true value: result: success "482": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: UpdateBridgeOutput482Example: summary: Default UpdateBridgeOutput 482 response x-microcks-default: true value: result: success "483": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: UpdateBridgeOutput483Example: summary: Default UpdateBridgeOutput 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: UpdateBridgeOutput484Example: summary: Default UpdateBridgeOutput 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: UpdateBridgeOutput485Example: summary: Default UpdateBridgeOutput 485 response x-microcks-default: true value: result: success "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: UpdateBridgeOutput486Example: summary: Default UpdateBridgeOutput 486 response x-microcks-default: true value: result: success parameters: - name: bridgeArn in: path required: true description: The ARN of the bridge that you want to update. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow - name: outputName in: path required: true description: The name of the bridge output that you want to update. schema: type: string example: example-flow requestBody: required: true content: application/json: schema: type: object properties: networkOutput: description: Update an existing network output. type: object properties: IpAddress: allOf: - $ref: "#/components/schemas/__string" - xml: name: ipAddress description: The network output IP Address. NetworkName: allOf: - $ref: "#/components/schemas/__string" - xml: name: networkName description: The network output's gateway network name. Port: allOf: - $ref: "#/components/schemas/__integer" - xml: name: port description: The network output port. Protocol: allOf: - $ref: "#/components/schemas/Protocol" - xml: name: protocol description: The network output protocol. Ttl: allOf: - $ref: "#/components/schemas/__integer" - xml: name: ttl description: The network output TTL. summary: Amazon MediaConnect Update Bridge Output x-microcks-operation: delay: 0 dispatcher: FALLBACK "/v1/bridges/{bridgeArn}/sources/{sourceName}": delete: operationId: RemoveBridgeSource description: Removes a source from a bridge. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/RemoveBridgeSourceResponse" examples: RemoveBridgeSource202Example: summary: Default RemoveBridgeSource 202 response x-microcks-default: true value: BridgeArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow SourceName: example-flow "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: RemoveBridgeSource480Example: summary: Default RemoveBridgeSource 480 response x-microcks-default: true value: result: success "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: RemoveBridgeSource481Example: summary: Default RemoveBridgeSource 481 response x-microcks-default: true value: result: success "482": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: RemoveBridgeSource482Example: summary: Default RemoveBridgeSource 482 response x-microcks-default: true value: result: success "483": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: RemoveBridgeSource483Example: summary: Default RemoveBridgeSource 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: RemoveBridgeSource484Example: summary: Default RemoveBridgeSource 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: RemoveBridgeSource485Example: summary: Default RemoveBridgeSource 485 response x-microcks-default: true value: result: success "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: RemoveBridgeSource486Example: summary: Default RemoveBridgeSource 486 response x-microcks-default: true value: result: success parameters: - name: bridgeArn in: path required: true description: The ARN of the bridge that you want to update. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow - name: sourceName in: path required: true description: The name of the bridge source that you want to remove. schema: type: string example: example-flow summary: Amazon MediaConnect Remove Bridge Source x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" put: operationId: UpdateBridgeSource description: Updates an existing bridge source. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateBridgeSourceResponse" examples: UpdateBridgeSource202Example: summary: Default UpdateBridgeSource 202 response x-microcks-default: true value: BridgeArn: 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: UpdateBridgeSource480Example: summary: Default UpdateBridgeSource 480 response x-microcks-default: true value: result: success "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: UpdateBridgeSource481Example: summary: Default UpdateBridgeSource 481 response x-microcks-default: true value: result: success "482": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: UpdateBridgeSource482Example: summary: Default UpdateBridgeSource 482 response x-microcks-default: true value: result: success "483": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: UpdateBridgeSource483Example: summary: Default UpdateBridgeSource 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: UpdateBridgeSource484Example: summary: Default UpdateBridgeSource 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: UpdateBridgeSource485Example: summary: Default UpdateBridgeSource 485 response x-microcks-default: true value: result: success "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: UpdateBridgeSource486Example: summary: Default UpdateBridgeSource 486 response x-microcks-default: true value: result: success parameters: - name: bridgeArn in: path required: true description: The ARN of the bridge that you want to update. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow - name: sourceName in: path required: true description: The name of the source that you want to update. schema: type: string example: example-flow requestBody: required: true content: application/json: schema: type: object properties: flowSource: description: Update the flow source of the bridge. type: object properties: FlowArn: allOf: - $ref: "#/components/schemas/__string" - pattern: ^arn:.+:mediaconnect.+:flow:.+$ xml: name: flowArn description: The ARN of the cloud flow to use as a source of this bridge. FlowVpcInterfaceAttachment: allOf: - $ref: "#/components/schemas/VpcInterfaceAttachment" - xml: name: flowVpcInterfaceAttachment description: The name of the VPC interface attachment to use for this source. networkSource: description: Update the network source of the bridge. type: object properties: MulticastIp: allOf: - $ref: "#/components/schemas/__string" - xml: name: multicastIp description: The network source multicast IP. NetworkName: allOf: - $ref: "#/components/schemas/__string" - xml: name: networkName description: The network source's gateway network name. Port: allOf: - $ref: "#/components/schemas/__integer" - xml: name: port description: The network source port. Protocol: allOf: - $ref: "#/components/schemas/Protocol" - xml: name: protocol description: The network source protocol. summary: Amazon MediaConnect Update Bridge Source x-microcks-operation: delay: 0 dispatcher: FALLBACK "/v1/flows/{flowArn}/mediaStreams/{mediaStreamName}": 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 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" 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 "/v1/flows/{flowArn}/outputs/{outputArn}": 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 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" 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 "/v1/flows/{flowArn}/source/{sourceArn}": 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 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" 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 "/v1/flows/{flowArn}/vpcInterfaces/{vpcInterfaceName}": 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 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" "/v1/flows/{flowArn}/entitlements/{entitlementArn}": 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 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" 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 "/v1/flows/start/{flowArn}": 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 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" "/v1/flows/stop/{flowArn}": 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 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" "/tags/{resourceArn}#tagKeys": delete: operationId: UntagResource description: Deletes specified tags from a resource. responses: "204": description: Success "480": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: UntagResource480Example: summary: Default UntagResource 480 response x-microcks-default: true value: result: success "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: UntagResource481Example: summary: Default UntagResource 481 response x-microcks-default: true value: result: success "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: UntagResource482Example: summary: Default UntagResource 482 response x-microcks-default: true value: result: success parameters: - name: resourceArn in: path required: true description: The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource from which to delete tags. schema: type: string example: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow - name: tagKeys in: query required: true description: The keys of the tags to be removed. schema: type: array items: $ref: "#/components/schemas/__string" example: [] summary: Amazon MediaConnect Untag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/bridges/{bridgeArn}/state": put: operationId: UpdateBridgeState description: Updates the bridge state responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateBridgeStateResponse" examples: UpdateBridgeState202Example: summary: Default UpdateBridgeState 202 response x-microcks-default: true value: BridgeArn: arn:aws:mediaconnect:us-east-1:123456789012:flow:example-flow DesiredState: example-value "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: UpdateBridgeState480Example: summary: Default UpdateBridgeState 480 response x-microcks-default: true value: result: success "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: UpdateBridgeState481Example: summary: Default UpdateBridgeState 481 response x-microcks-default: true value: result: success "482": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: UpdateBridgeState482Example: summary: Default UpdateBridgeState 482 response x-microcks-default: true value: result: success "483": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: UpdateBridgeState483Example: summary: Default UpdateBridgeState 483 response x-microcks-default: true value: result: success "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: UpdateBridgeState484Example: summary: Default UpdateBridgeState 484 response x-microcks-default: true value: result: success "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: UpdateBridgeState485Example: summary: Default UpdateBridgeState 485 response x-microcks-default: true value: result: success "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: UpdateBridgeState486Example: summary: Default UpdateBridgeState 486 response x-microcks-default: true value: result: success parameters: - name: bridgeArn in: path required: true description: The ARN of the bridge 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 required: - desiredState properties: desiredState: description: "" type: string enum: - ACTIVE - STANDBY - DELETED summary: Amazon MediaConnect Update Bridge State x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm 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-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders 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 schemas: AddBridgeOutputsResponse: type: object properties: BridgeArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: bridgeArn description: The Amazon Resource Number (ARN) of the bridge. Outputs: allOf: - $ref: "#/components/schemas/__listOfBridgeOutput" - xml: name: outputs description: The outputs that you added to this bridge. AddBridgeOutputRequest: type: object properties: NetworkOutput: allOf: - $ref: "#/components/schemas/AddBridgeNetworkOutputRequest" - xml: name: networkOutput description: Add an output to a bridge. BadRequestException: {} InternalServerErrorException: {} ForbiddenException: {} NotFoundException: {} ServiceUnavailableException: {} TooManyRequestsException: {} ConflictException: {} AddBridgeSourcesResponse: type: object properties: BridgeArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: bridgeArn description: The Amazon Resource Number (ARN) of the bridge. Sources: allOf: - $ref: "#/components/schemas/__listOfBridgeSource" - xml: name: sources description: The sources that you added to this bridge. AddBridgeSourceRequest: type: object properties: FlowSource: allOf: - $ref: "#/components/schemas/AddBridgeFlowSourceRequest" - xml: name: flowSource NetworkSource: allOf: - $ref: "#/components/schemas/AddBridgeNetworkSourceRequest" - xml: name: networkSource description: Add a source to an existing bridge. 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. 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. 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. 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. AddFlowOutputs420Exception: {} 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. 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. 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. 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 CreateBridgeResponse: type: object properties: Bridge: allOf: - $ref: "#/components/schemas/Bridge" - xml: name: bridge __integer: type: integer FailoverMode: type: string enum: - MERGE - FAILOVER 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. State: type: string enum: - ENABLED - DISABLED CreateBridge420Exception: {} CreateFlowResponse: type: object properties: Flow: allOf: - $ref: "#/components/schemas/Flow" - xml: name: flow 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. 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. __string: type: string __listOfMediaStreamSourceConfigurationRequest: type: array items: $ref: "#/components/schemas/MediaStreamSourceConfigurationRequest" Protocol: type: string enum: - zixi-push - rtp-fec - rtp - zixi-pull - rist - st2110-jpegxs - cdi - srt-listener - srt-caller - fujitsu-qos - udp 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. MaintenanceDay: type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday CreateFlow420Exception: {} CreateGatewayResponse: type: object properties: Gateway: allOf: - $ref: "#/components/schemas/Gateway" - xml: name: gateway GatewayNetwork: type: object required: - CidrBlock - Name properties: CidrBlock: allOf: - $ref: "#/components/schemas/__string" - xml: name: cidrBlock description: A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: The name of the network. This name is used to reference the network and must be unique among networks in this gateway. description: The network settings for a gateway. CreateGateway420Exception: {} DeleteBridgeResponse: type: object properties: BridgeArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: bridgeArn description: The Amazon Resource Number (ARN) of the deleted bridge. 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. DeleteGatewayResponse: type: object properties: GatewayArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: gatewayArn description: The Amazon Resource Name (ARN) of the gateway that was deleted. DeregisterGatewayInstanceResponse: type: object properties: GatewayInstanceArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: gatewayInstanceArn description: The Amazon Resource Name (ARN) of the instance. InstanceState: allOf: - $ref: "#/components/schemas/InstanceState" - xml: name: instanceState description: The status of the instance. DescribeBridgeResponse: type: object properties: Bridge: allOf: - $ref: "#/components/schemas/Bridge" - xml: name: bridge DescribeFlowResponse: type: object properties: Flow: allOf: - $ref: "#/components/schemas/Flow" - xml: name: flow Messages: allOf: - $ref: "#/components/schemas/Messages" - xml: name: messages DescribeGatewayResponse: type: object properties: Gateway: allOf: - $ref: "#/components/schemas/Gateway" - xml: name: gateway DescribeGatewayInstanceResponse: type: object properties: GatewayInstance: allOf: - $ref: "#/components/schemas/GatewayInstance" - xml: name: gatewayInstance DescribeOfferingResponse: type: object properties: Offering: allOf: - $ref: "#/components/schemas/Offering" - xml: name: offering DescribeReservationResponse: type: object properties: Reservation: allOf: - $ref: "#/components/schemas/Reservation" - xml: name: reservation 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. GrantFlowEntitlements420Exception: {} ListBridgesResponse: type: object properties: Bridges: allOf: - $ref: "#/components/schemas/__listOfListedBridge" - xml: name: bridges description: A list of bridge 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 ListBridges request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListBridges request a second time and specify the NextToken value. ListEntitlementsResponse: type: object properties: Entitlements: allOf: - $ref: "#/components/schemas/__listOfListedEntitlement" - xml: name: entitlements description: A list of entitlements that have been granted to you from other AWS accounts. 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 ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value. 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. ListGatewayInstancesResponse: type: object properties: Instances: allOf: - $ref: "#/components/schemas/__listOfListedGatewayInstance" - xml: name: instances description: A list of instance 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 ListInstances request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListInstances request a second time and specify the NextToken value. ListGatewaysResponse: type: object properties: Gateways: allOf: - $ref: "#/components/schemas/__listOfListedGateway" - xml: name: gateways description: A list of gateway 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 ListGateways request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListGateways request a second time and specify the NextToken value. ListOfferingsResponse: type: object properties: 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 ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value. Offerings: allOf: - $ref: "#/components/schemas/__listOfOffering" - xml: name: offerings description: A list of offerings that are available to this account in the current AWS Region. ListReservationsResponse: type: object properties: 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 ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListReservations request a second time and specify the NextToken value. Reservations: allOf: - $ref: "#/components/schemas/__listOfReservation" - xml: name: reservations description: A list of all reservations that have been purchased by this account in the current AWS Region. ListTagsForResourceResponse: type: object properties: Tags: allOf: - $ref: "#/components/schemas/__mapOf__string" - xml: name: tags description: A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. PurchaseOfferingResponse: type: object properties: Reservation: allOf: - $ref: "#/components/schemas/Reservation" - xml: name: reservation RemoveBridgeOutputResponse: type: object properties: BridgeArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: bridgeArn OutputName: allOf: - $ref: "#/components/schemas/__string" - xml: name: outputName RemoveBridgeSourceResponse: type: object properties: BridgeArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: bridgeArn SourceName: allOf: - $ref: "#/components/schemas/__string" - xml: name: sourceName 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. 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. 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. 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. 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. 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. 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. UpdateBridgeResponse: type: object properties: Bridge: allOf: - $ref: "#/components/schemas/Bridge" - xml: name: bridge UpdateBridgeOutputResponse: type: object properties: BridgeArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: bridgeArn description: The Amazon Resource Number (ARN) of the bridge. Output: allOf: - $ref: "#/components/schemas/BridgeOutput" - xml: name: output description: The output that you updated. UpdateBridgeSourceResponse: type: object properties: BridgeArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: bridgeArn description: The Amazon Resource Number (ARN) of the bridge. Source: allOf: - $ref: "#/components/schemas/BridgeSource" - xml: name: source 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. UpdateBridgeStateResponse: type: object properties: BridgeArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: bridgeArn description: The Amazon Resource Number (ARN) of the bridge. DesiredState: allOf: - $ref: "#/components/schemas/DesiredState" - xml: name: desiredState description: The state of the bridge. ACTIVE or STANDBY. UpdateFlowResponse: type: object properties: Flow: allOf: - $ref: "#/components/schemas/Flow" - xml: name: 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. Algorithm: type: string enum: - aes128 - aes192 - aes256 KeyType: type: string enum: - speke - static-key - srt-password 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. 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. 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. 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. 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. 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. UpdateGatewayInstanceResponse: type: object properties: BridgePlacement: allOf: - $ref: "#/components/schemas/BridgePlacement" - xml: name: bridgePlacement description: The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be added to this instance. GatewayInstanceArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: gatewayInstanceArn description: The Amazon Resource Name (ARN) of the instance. AddBridgeFlowSourceRequest: type: object required: - FlowArn - Name properties: FlowArn: allOf: - $ref: "#/components/schemas/__string" - pattern: ^arn:.+:mediaconnect.+:flow:.+$ xml: name: flowArn description: The Amazon Resource Number (ARN) of the cloud flow to use as a source of this bridge. FlowVpcInterfaceAttachment: allOf: - $ref: "#/components/schemas/VpcInterfaceAttachment" - xml: name: flowVpcInterfaceAttachment description: The name of the VPC interface attachment to use for this source. Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: The name of the flow source. This name is used to reference the source and must be unique among sources in this bridge. description: Add a flow source to an existing bridge. AddBridgeNetworkOutputRequest: type: object required: - NetworkName - Port - IpAddress - Protocol - Ttl - Name properties: IpAddress: allOf: - $ref: "#/components/schemas/__string" - xml: name: ipAddress description: The network output IP Address. Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: The network output name. This name is used to reference the output and must be unique among outputs in this bridge. NetworkName: allOf: - $ref: "#/components/schemas/__string" - xml: name: networkName description: The network output's gateway network name. Port: allOf: - $ref: "#/components/schemas/__integer" - xml: name: port description: The network output port. Protocol: allOf: - $ref: "#/components/schemas/Protocol" - xml: name: protocol description: The network output protocol. Ttl: allOf: - $ref: "#/components/schemas/__integer" - xml: name: ttl description: The network output TTL. description: Add a network output to an existing bridge. AddBridgeNetworkSourceRequest: type: object required: - NetworkName - MulticastIp - Port - Protocol - Name properties: MulticastIp: allOf: - $ref: "#/components/schemas/__string" - xml: name: multicastIp description: The network source multicast IP. Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: The name of the network source. This name is used to reference the source and must be unique among sources in this bridge. NetworkName: allOf: - $ref: "#/components/schemas/__string" - xml: name: networkName description: The network source's gateway network name. Port: allOf: - $ref: "#/components/schemas/__integer" - xml: name: port description: The network source port. Protocol: allOf: - $ref: "#/components/schemas/Protocol" - xml: name: protocol description: The network source protocol. description: Add a network source to an existing bridge. __listOfAddBridgeOutputRequest: type: array items: $ref: "#/components/schemas/AddBridgeOutputRequest" AddBridgeOutputsRequest: type: object required: - Outputs title: AddBridgeOutputsRequest properties: Outputs: allOf: - $ref: "#/components/schemas/__listOfAddBridgeOutputRequest" - xml: name: outputs description: The outputs that you want to add to this bridge. description: A request to add outputs to the specified bridge. __listOfBridgeOutput: type: array items: $ref: "#/components/schemas/BridgeOutput" __listOfAddBridgeSourceRequest: type: array items: $ref: "#/components/schemas/AddBridgeSourceRequest" AddBridgeSourcesRequest: type: object required: - Sources title: AddBridgeSourcesRequest properties: Sources: allOf: - $ref: "#/components/schemas/__listOfAddBridgeSourceRequest" - xml: name: sources description: The sources that you want to add to this bridge. description: A request to add sources to the specified bridge. __listOfBridgeSource: type: array items: $ref: "#/components/schemas/BridgeSource" AddEgressGatewayBridgeRequest: type: object required: - MaxBitrate properties: MaxBitrate: allOf: - $ref: "#/components/schemas/__integer" - xml: name: maxBitrate description: The maximum expected bitrate (in bps). __listOfAddMediaStreamRequest: type: array items: $ref: "#/components/schemas/AddMediaStreamRequest" AddFlowMediaStreamsRequest: type: object required: - MediaStreams title: AddFlowMediaStreamsRequest properties: MediaStreams: allOf: - $ref: "#/components/schemas/__listOfAddMediaStreamRequest" - xml: name: mediaStreams description: The media streams that you want to add to the flow. description: A request to add media streams to the flow. __listOfMediaStream: type: array items: $ref: "#/components/schemas/MediaStream" __listOfAddOutputRequest: type: array items: $ref: "#/components/schemas/AddOutputRequest" AddFlowOutputsRequest: type: object required: - Outputs title: AddFlowOutputsRequest properties: Outputs: allOf: - $ref: "#/components/schemas/__listOfAddOutputRequest" - xml: name: outputs description: A list of outputs that you want to add. description: A request to add outputs to the specified flow. __listOfOutput: type: array items: $ref: "#/components/schemas/Output" __listOfSetSourceRequest: type: array items: $ref: "#/components/schemas/SetSourceRequest" AddFlowSourcesRequest: type: object required: - Sources title: AddFlowSourcesRequest properties: Sources: allOf: - $ref: "#/components/schemas/__listOfSetSourceRequest" - xml: name: sources description: A list of sources that you want to add. description: A request to add sources to the flow. __listOfSource: type: array items: $ref: "#/components/schemas/Source" __listOfVpcInterfaceRequest: type: array items: $ref: "#/components/schemas/VpcInterfaceRequest" AddFlowVpcInterfacesRequest: type: object required: - VpcInterfaces title: AddFlowVpcInterfacesRequest properties: VpcInterfaces: allOf: - $ref: "#/components/schemas/__listOfVpcInterfaceRequest" - xml: name: vpcInterfaces description: A list of VPC interfaces that you want to add. description: A request to add VPC interfaces to the flow. __listOfVpcInterface: type: array items: $ref: "#/components/schemas/VpcInterface" AddIngressGatewayBridgeRequest: type: object required: - MaxOutputs - MaxBitrate properties: MaxBitrate: allOf: - $ref: "#/components/schemas/__integer" - xml: name: maxBitrate description: The maximum expected bitrate (in bps). MaxOutputs: allOf: - $ref: "#/components/schemas/__integer" - xml: name: maxOutputs description: The maximum number of expected outputs. AddMaintenance: type: object required: - MaintenanceDay - MaintenanceStartHour 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." description: Create maintenance setting for a flow 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. MediaStreamType: type: string enum: - video - audio - ancillary-data __listOf__string: type: array items: $ref: "#/components/schemas/__string" __listOfMediaStreamOutputConfigurationRequest: type: array items: $ref: "#/components/schemas/MediaStreamOutputConfigurationRequest" __listOfMessageDetail: type: array items: $ref: "#/components/schemas/MessageDetail" BridgeState: type: string enum: - CREATING - STANDBY - STARTING - DEPLOYING - ACTIVE - STOPPING - DELETING - DELETED - START_FAILED - START_PENDING - STOP_FAILED - UPDATING EgressGatewayBridge: type: object required: - MaxBitrate properties: InstanceId: allOf: - $ref: "#/components/schemas/__string" - xml: name: instanceId description: The ID of the instance running this bridge. MaxBitrate: allOf: - $ref: "#/components/schemas/__integer" - xml: name: maxBitrate description: The maximum expected bitrate (in bps) of the egress bridge. IngressGatewayBridge: type: object required: - MaxOutputs - MaxBitrate properties: InstanceId: allOf: - $ref: "#/components/schemas/__string" - xml: name: instanceId description: The ID of the instance running this bridge. MaxBitrate: allOf: - $ref: "#/components/schemas/__integer" - xml: name: maxBitrate description: The maximum expected bitrate (in bps) of the ingress bridge. MaxOutputs: allOf: - $ref: "#/components/schemas/__integer" - xml: name: maxOutputs description: The maximum number of outputs on the ingress bridge. 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. Bridge: type: object required: - BridgeArn - BridgeState - PlacementArn - Name properties: BridgeArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: bridgeArn description: The Amazon Resource Number (ARN) of the bridge. BridgeMessages: allOf: - $ref: "#/components/schemas/__listOfMessageDetail" - xml: name: bridgeMessages BridgeState: allOf: - $ref: "#/components/schemas/BridgeState" - xml: name: bridgeState EgressGatewayBridge: allOf: - $ref: "#/components/schemas/EgressGatewayBridge" - xml: name: egressGatewayBridge IngressGatewayBridge: allOf: - $ref: "#/components/schemas/IngressGatewayBridge" - xml: name: ingressGatewayBridge Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: The name of the bridge. Outputs: allOf: - $ref: "#/components/schemas/__listOfBridgeOutput" - xml: name: outputs description: The outputs on this bridge. PlacementArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: placementArn description: The placement Amazon Resource Number (ARN) of the bridge. SourceFailoverConfig: allOf: - $ref: "#/components/schemas/FailoverConfig" - xml: name: sourceFailoverConfig Sources: allOf: - $ref: "#/components/schemas/__listOfBridgeSource" - xml: name: sources description: The sources on this bridge. description: A Bridge is the connection between your datacenter's Instances and the AWS cloud. A bridge can be used to send video from the AWS cloud to your datacenter or from your datacenter to the AWS cloud. BridgeFlowOutput: type: object required: - FlowSourceArn - FlowArn - Name properties: FlowArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: flowArn description: The Amazon Resource Number (ARN) of the cloud flow. FlowSourceArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: flowSourceArn description: The Amazon Resource Number (ARN) of the flow source. Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: The name of the bridge's output. description: The output of the bridge. A flow output is delivered to the AWS cloud. BridgeFlowSource: type: object required: - FlowArn - Name properties: FlowArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: flowArn description: The ARN of the cloud flow used as a source of this bridge. FlowVpcInterfaceAttachment: allOf: - $ref: "#/components/schemas/VpcInterfaceAttachment" - xml: name: flowVpcInterfaceAttachment description: The name of the VPC interface attachment to use for this source. Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: The name of the flow source. OutputArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: outputArn description: The Amazon Resource Number (ARN) of the output. description: The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow. BridgeNetworkOutput: type: object required: - NetworkName - Port - IpAddress - Protocol - Ttl - Name properties: IpAddress: allOf: - $ref: "#/components/schemas/__string" - xml: name: ipAddress description: The network output IP Address. Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: The network output name. NetworkName: allOf: - $ref: "#/components/schemas/__string" - xml: name: networkName description: The network output's gateway network name. Port: allOf: - $ref: "#/components/schemas/__integer" - xml: name: port description: The network output port. Protocol: allOf: - $ref: "#/components/schemas/Protocol" - xml: name: protocol description: The network output protocol. Ttl: allOf: - $ref: "#/components/schemas/__integer" - xml: name: ttl description: The network output TTL. description: The output of the bridge. A network output is delivered to your premises. BridgeNetworkSource: type: object required: - NetworkName - MulticastIp - Port - Protocol - Name properties: MulticastIp: allOf: - $ref: "#/components/schemas/__string" - xml: name: multicastIp description: The network source multicast IP. Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: The name of the network source. NetworkName: allOf: - $ref: "#/components/schemas/__string" - xml: name: networkName description: The network source's gateway network name. Port: allOf: - $ref: "#/components/schemas/__integer" - xml: name: port description: The network source port. Protocol: allOf: - $ref: "#/components/schemas/Protocol" - xml: name: protocol description: The network source protocol. description: The source of the bridge. A network source originates at your premises. BridgeOutput: type: object properties: FlowOutput: allOf: - $ref: "#/components/schemas/BridgeFlowOutput" - xml: name: flowOutput NetworkOutput: allOf: - $ref: "#/components/schemas/BridgeNetworkOutput" - xml: name: networkOutput description: The output of the bridge. BridgePlacement: type: string enum: - AVAILABLE - LOCKED BridgeSource: type: object properties: FlowSource: allOf: - $ref: "#/components/schemas/BridgeFlowSource" - xml: name: flowSource NetworkSource: allOf: - $ref: "#/components/schemas/BridgeNetworkSource" - xml: name: networkSource description: The bridge's source. Colorimetry: type: string enum: - BT601 - BT709 - BT2020 - BT2100 - ST2065-1 - ST2065-3 - XYZ ConnectionStatus: type: string enum: - CONNECTED - DISCONNECTED CreateBridgeRequest: type: object required: - Sources - PlacementArn - Name title: CreateBridgeRequest properties: EgressGatewayBridge: allOf: - $ref: "#/components/schemas/AddEgressGatewayBridgeRequest" - xml: name: egressGatewayBridge description: Create a bridge with the egress bridge type. An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises. IngressGatewayBridge: allOf: - $ref: "#/components/schemas/AddIngressGatewayBridgeRequest" - xml: name: ingressGatewayBridge description: Create a bridge with the ingress bridge type. An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud. Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: The name of the bridge. This name can not be modified after the bridge is created. Outputs: allOf: - $ref: "#/components/schemas/__listOfAddBridgeOutputRequest" - xml: name: outputs description: The outputs that you want to add to this bridge. PlacementArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: placementArn description: The bridge placement Amazon Resource Number (ARN). SourceFailoverConfig: allOf: - $ref: "#/components/schemas/FailoverConfig" - xml: name: sourceFailoverConfig description: The settings for source failover. Sources: allOf: - $ref: "#/components/schemas/__listOfAddBridgeSourceRequest" - xml: name: sources description: The sources that you want to add to this bridge. description: Creates a new bridge. The request must include one source. __listOfGrantEntitlementRequest: type: array items: $ref: "#/components/schemas/GrantEntitlementRequest" CreateFlowRequest: type: object required: - Name title: CreateFlowRequest 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 Region. Entitlements: allOf: - $ref: "#/components/schemas/__listOfGrantEntitlementRequest" - xml: name: entitlements description: The entitlements that you want to grant on a flow. MediaStreams: allOf: - $ref: "#/components/schemas/__listOfAddMediaStreamRequest" - xml: name: 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. Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: The name of the flow. Outputs: allOf: - $ref: "#/components/schemas/__listOfAddOutputRequest" - xml: name: outputs description: The outputs that you want to add to this flow. Source: allOf: - $ref: "#/components/schemas/SetSourceRequest" - xml: name: source SourceFailoverConfig: allOf: - $ref: "#/components/schemas/FailoverConfig" - xml: name: sourceFailoverConfig Sources: allOf: - $ref: "#/components/schemas/__listOfSetSourceRequest" - xml: name: sources VpcInterfaces: allOf: - $ref: "#/components/schemas/__listOfVpcInterfaceRequest" - xml: name: vpcInterfaces description: The VPC interfaces you want on the flow. Maintenance: allOf: - $ref: "#/components/schemas/AddMaintenance" - xml: name: maintenance 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). 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. __listOfGatewayNetwork: type: array items: $ref: "#/components/schemas/GatewayNetwork" CreateGatewayRequest: type: object required: - Networks - EgressCidrBlocks - Name title: CreateGatewayRequest properties: EgressCidrBlocks: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: egressCidrBlocks description: The range of IP addresses that are allowed to contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: The name of the gateway. This name can not be modified after the gateway is created. Networks: allOf: - $ref: "#/components/schemas/__listOfGatewayNetwork" - xml: name: networks description: The list of networks that you want to add. description: Creates a new gateway. The request must include at least one network (up to 4). Gateway: type: object required: - GatewayArn - Networks - EgressCidrBlocks - Name properties: EgressCidrBlocks: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: egressCidrBlocks description: The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. GatewayArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: gatewayArn description: The Amazon Resource Name (ARN) of the gateway. GatewayMessages: allOf: - $ref: "#/components/schemas/__listOfMessageDetail" - xml: name: gatewayMessages GatewayState: allOf: - $ref: "#/components/schemas/GatewayState" - xml: name: gatewayState description: The current status of the gateway. Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: The name of the gateway. This name can not be modified after the gateway is created. Networks: allOf: - $ref: "#/components/schemas/__listOfGatewayNetwork" - xml: name: networks description: The list of networks in the gateway. description: The settings for a gateway, including its networks. DeleteBridgeRequest: type: object title: DeleteBridgeRequest properties: {} DeleteFlowRequest: type: object title: DeleteFlowRequest properties: {} Status: type: string enum: - STANDBY - ACTIVE - UPDATING - DELETING - STARTING - STOPPING - ERROR DeleteGatewayRequest: type: object title: DeleteGatewayRequest properties: {} __boolean: type: boolean DeregisterGatewayInstanceRequest: type: object title: DeregisterGatewayInstanceRequest properties: {} InstanceState: type: string enum: - REGISTERING - ACTIVE - DEREGISTERING - DEREGISTERED - REGISTRATION_ERROR - DEREGISTRATION_ERROR DescribeBridgeRequest: type: object title: DescribeBridgeRequest properties: {} DescribeFlowRequest: type: object title: DescribeFlowRequest properties: {} 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. DescribeGatewayInstanceRequest: type: object title: DescribeGatewayInstanceRequest properties: {} GatewayInstance: type: object required: - GatewayArn - InstanceState - GatewayInstanceArn - InstanceId - RunningBridgeCount - BridgePlacement - ConnectionStatus properties: BridgePlacement: allOf: - $ref: "#/components/schemas/BridgePlacement" - xml: name: bridgePlacement description: The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be added to this instance. ConnectionStatus: allOf: - $ref: "#/components/schemas/ConnectionStatus" - xml: name: connectionStatus description: The connection state of the instance. GatewayArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: gatewayArn description: The Amazon Resource Name (ARN) of the instance. GatewayInstanceArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: gatewayInstanceArn description: The Amazon Resource Name (ARN) of the gateway. InstanceId: allOf: - $ref: "#/components/schemas/__string" - xml: name: instanceId description: The managed instance ID generated by the SSM install. This will begin with "mi-". InstanceMessages: allOf: - $ref: "#/components/schemas/__listOfMessageDetail" - xml: name: instanceMessages InstanceState: allOf: - $ref: "#/components/schemas/InstanceState" - xml: name: instanceState description: The status of the instance. RunningBridgeCount: allOf: - $ref: "#/components/schemas/__integer" - xml: name: runningBridgeCount description: The running bridge count. description: The settings for an instance in a gateway. DescribeGatewayRequest: type: object title: DescribeGatewayRequest properties: {} DescribeOfferingRequest: type: object title: DescribeOfferingRequest properties: {} Offering: type: object required: - CurrencyCode - OfferingArn - OfferingDescription - DurationUnits - Duration - PricePerUnit - ResourceSpecification - PriceUnits properties: CurrencyCode: allOf: - $ref: "#/components/schemas/__string" - xml: name: currencyCode description: The type of currency that is used for billing. The currencyCode used for all reservations is US dollars. Duration: allOf: - $ref: "#/components/schemas/__integer" - xml: name: duration description: The length of time that your reservation would be active. DurationUnits: allOf: - $ref: "#/components/schemas/DurationUnits" - xml: name: durationUnits description: The unit of measurement for the duration of the offering. OfferingArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: offeringArn description: The Amazon Resource Name (ARN) that MediaConnect assigns to the offering. OfferingDescription: allOf: - $ref: "#/components/schemas/__string" - xml: name: offeringDescription description: A description of the offering. PricePerUnit: allOf: - $ref: "#/components/schemas/__string" - xml: name: pricePerUnit description: The cost of a single unit. This value, in combination with priceUnits, makes up the rate. PriceUnits: allOf: - $ref: "#/components/schemas/PriceUnits" - xml: name: priceUnits description: The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. ResourceSpecification: allOf: - $ref: "#/components/schemas/ResourceSpecification" - xml: name: resourceSpecification description: A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. description: A savings plan that reserves a certain amount of outbound bandwidth usage at a discounted rate each month over a period of time. DescribeReservationRequest: type: object title: DescribeReservationRequest properties: {} Reservation: type: object required: - CurrencyCode - ReservationState - OfferingArn - ReservationArn - Start - OfferingDescription - ReservationName - End - Duration - DurationUnits - PricePerUnit - ResourceSpecification - PriceUnits properties: CurrencyCode: allOf: - $ref: "#/components/schemas/__string" - xml: name: currencyCode description: The type of currency that is used for billing. The currencyCode used for your reservation is US dollars. Duration: allOf: - $ref: "#/components/schemas/__integer" - xml: name: duration description: The length of time that this reservation is active. MediaConnect defines this value in the offering. DurationUnits: allOf: - $ref: "#/components/schemas/DurationUnits" - xml: name: durationUnits description: The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering. End: allOf: - $ref: "#/components/schemas/__string" - xml: name: end description: The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration. OfferingArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: offeringArn description: The Amazon Resource Name (ARN) that MediaConnect assigns to the offering. OfferingDescription: allOf: - $ref: "#/components/schemas/__string" - xml: name: offeringDescription description: A description of the offering. MediaConnect defines this value in the offering. PricePerUnit: allOf: - $ref: "#/components/schemas/__string" - xml: name: pricePerUnit description: The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering. PriceUnits: allOf: - $ref: "#/components/schemas/PriceUnits" - xml: name: priceUnits description: The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering. ReservationArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: reservationArn description: The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering. ReservationName: allOf: - $ref: "#/components/schemas/__string" - xml: name: reservationName description: The name that you assigned to the reservation when you purchased the offering. ReservationState: allOf: - $ref: "#/components/schemas/ReservationState" - xml: name: reservationState description: The status of your reservation. ResourceSpecification: allOf: - $ref: "#/components/schemas/ResourceSpecification" - xml: name: resourceSpecification description: A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in the offering. Start: allOf: - $ref: "#/components/schemas/__string" - xml: name: start description: The day and time that the reservation becomes active. You set this value when you purchase the offering. description: A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate. DesiredState: type: string enum: - ACTIVE - STANDBY - DELETED 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. 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. 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. 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. DurationUnits: type: string enum: - MONTHS EncoderProfile: type: string enum: - main - high EncodingName: type: string enum: - jxsv - raw - smpte291 - pcm __double: type: number format: double 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. 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. EntitlementStatus: type: string enum: - ENABLED - DISABLED 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. __listOfEntitlement: type: array items: $ref: "#/components/schemas/Entitlement" 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. 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 Range: type: string enum: - NARROW - FULL - FULLPROTECT ScanMode: type: string enum: - progressive - interlace - progressive-segmented-frame Tcs: type: string enum: - SDR - PQ - HLG - LINEAR - BT2100LINPQ - BT2100LINHLG - ST2065-1 - ST428-1 - DENSITY 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 GatewayState: type: string enum: - CREATING - ACTIVE - UPDATING - ERROR - DELETING - DELETED 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. GrantFlowEntitlementsRequest: type: object required: - Entitlements title: GrantFlowEntitlementsRequest properties: Entitlements: allOf: - $ref: "#/components/schemas/__listOfGrantEntitlementRequest" - xml: name: entitlements description: The list of entitlements that you want to grant. description: A request to grant entitlements on a flow. 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. 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. MaxResults: type: integer minimum: 1 maximum: 1000 ListBridgesRequest: type: object title: ListBridgesRequest properties: {} __listOfListedBridge: type: array items: $ref: "#/components/schemas/ListedBridge" ListEntitlementsRequest: type: object title: ListEntitlementsRequest properties: {} __listOfListedEntitlement: type: array items: $ref: "#/components/schemas/ListedEntitlement" ListFlowsRequest: type: object title: ListFlowsRequest properties: {} __listOfListedFlow: type: array items: $ref: "#/components/schemas/ListedFlow" ListGatewayInstancesRequest: type: object title: ListGatewayInstancesRequest properties: {} __listOfListedGatewayInstance: type: array items: $ref: "#/components/schemas/ListedGatewayInstance" ListGatewaysRequest: type: object title: ListGatewaysRequest properties: {} __listOfListedGateway: type: array items: $ref: "#/components/schemas/ListedGateway" ListOfferingsRequest: type: object title: ListOfferingsRequest properties: {} __listOfOffering: type: array items: $ref: "#/components/schemas/Offering" ListReservationsRequest: type: object title: ListReservationsRequest properties: {} __listOfReservation: type: array items: $ref: "#/components/schemas/Reservation" ListTagsForResourceRequest: type: object title: ListTagsForResourceRequest properties: {} __mapOf__string: type: object additionalProperties: $ref: "#/components/schemas/__string" ListedBridge: type: object required: - BridgeArn - BridgeState - PlacementArn - BridgeType - Name properties: BridgeArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: bridgeArn description: The ARN of the bridge. BridgeState: allOf: - $ref: "#/components/schemas/BridgeState" - xml: name: bridgeState BridgeType: allOf: - $ref: "#/components/schemas/__string" - xml: name: bridgeType description: The type of the bridge. Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: The name of the bridge. PlacementArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: placementArn description: The ARN of the gateway associated with the bridge. description: Displays details of the selected bridge. ListedEntitlement: type: object required: - EntitlementArn - EntitlementName 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. EntitlementArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: entitlementArn description: The ARN of the entitlement. EntitlementName: allOf: - $ref: "#/components/schemas/__string" - xml: name: entitlementName description: The name of the entitlement. description: An entitlement that has been granted to you from other AWS accounts. SourceType: type: string enum: - OWNED - ENTITLED 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. ListedGateway: type: object required: - GatewayArn - GatewayState - Name properties: GatewayArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: gatewayArn description: The Amazon Resource Name (ARN) of the gateway. GatewayState: allOf: - $ref: "#/components/schemas/GatewayState" - xml: name: gatewayState Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: The name of the gateway. description: Provides a summary of a gateway, including its name, ARN, and status. ListedGatewayInstance: type: object required: - GatewayArn - GatewayInstanceArn - InstanceId properties: GatewayArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: gatewayArn description: The Amazon Resource Name (ARN) of the gateway. GatewayInstanceArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: gatewayInstanceArn description: The Amazon Resource Name (ARN) of the instance. InstanceId: allOf: - $ref: "#/components/schemas/__string" - xml: name: instanceId description: The managed instance ID generated by the SSM install. This will begin with "mi-". InstanceState: allOf: - $ref: "#/components/schemas/InstanceState" - xml: name: instanceState description: The status of the instance. description: Provides a summary of an instance. 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. 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. __listOfDestinationConfiguration: type: array items: $ref: "#/components/schemas/DestinationConfiguration" 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. __listOfDestinationConfigurationRequest: type: array items: $ref: "#/components/schemas/DestinationConfigurationRequest" __listOfInputConfiguration: type: array items: $ref: "#/components/schemas/InputConfiguration" 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. __listOfInputConfigurationRequest: type: array items: $ref: "#/components/schemas/InputConfigurationRequest" MessageDetail: type: object required: - Message - Code properties: Code: allOf: - $ref: "#/components/schemas/__string" - xml: name: code description: The error code. Message: allOf: - $ref: "#/components/schemas/__string" - xml: name: message description: The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed. ResourceName: allOf: - $ref: "#/components/schemas/__string" - xml: name: resourceName description: The name of the resource. NetworkInterfaceType: type: string enum: - ena - efa PriceUnits: type: string enum: - HOURLY ResourceSpecification: type: object required: - ResourceType properties: ReservedBitrate: allOf: - $ref: "#/components/schemas/__integer" - xml: name: reservedBitrate description: The amount of outbound bandwidth that is discounted in the offering. ResourceType: allOf: - $ref: "#/components/schemas/ResourceType" - xml: name: resourceType description: The type of resource and the unit that is being billed for. description: A definition of what is being billed for, including the type and amount. __listOfMediaStreamOutputConfiguration: type: array items: $ref: "#/components/schemas/MediaStreamOutputConfiguration" 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. __listOf__integer: type: array items: $ref: "#/components/schemas/__integer" 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. PurchaseOfferingRequest: type: object required: - Start - ReservationName title: PurchaseOfferingRequest properties: ReservationName: allOf: - $ref: "#/components/schemas/__string" - xml: name: reservationName description: The name that you want to use for the reservation. Start: allOf: - $ref: "#/components/schemas/__string" - xml: name: start description: "The date and time that you want the reservation to begin, in Coordinated Universal Time (UTC). You can specify any date and time between 12:00am on the first day of the current month to the current time on today's date, inclusive. Specify the start in a 24-hour notation. Use the following format: YYYY-MM-DDTHH:mm:SSZ, where T and Z are literal characters. For example, to specify 11:30pm on March 5, 2020, enter 2020-03-05T23:30:00Z." description: A request to purchase a offering. RemoveBridgeOutputRequest: type: object title: RemoveBridgeOutputRequest properties: {} RemoveBridgeSourceRequest: type: object title: RemoveBridgeSourceRequest properties: {} RemoveFlowMediaStreamRequest: type: object title: RemoveFlowMediaStreamRequest properties: {} RemoveFlowOutputRequest: type: object title: RemoveFlowOutputRequest properties: {} RemoveFlowSourceRequest: type: object title: RemoveFlowSourceRequest properties: {} RemoveFlowVpcInterfaceRequest: type: object title: RemoveFlowVpcInterfaceRequest properties: {} ReservationState: type: string enum: - ACTIVE - EXPIRED - PROCESSING - CANCELED ResourceType: type: string enum: - Mbps_Outbound_Bandwidth RevokeFlowEntitlementRequest: type: object title: RevokeFlowEntitlementRequest properties: {} __listOfMediaStreamSourceConfiguration: type: array items: $ref: "#/components/schemas/MediaStreamSourceConfiguration" StartFlowRequest: type: object title: StartFlowRequest properties: {} StopFlowRequest: type: object title: StopFlowRequest properties: {} TagResourceRequest: type: object required: - Tags title: TagResourceRequest properties: Tags: allOf: - $ref: "#/components/schemas/__mapOf__string" - xml: name: tags description: A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. description: The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. UntagResourceRequest: type: object title: UntagResourceRequest properties: {} UpdateBridgeFlowSourceRequest: type: object properties: FlowArn: allOf: - $ref: "#/components/schemas/__string" - pattern: ^arn:.+:mediaconnect.+:flow:.+$ xml: name: flowArn description: The ARN of the cloud flow to use as a source of this bridge. FlowVpcInterfaceAttachment: allOf: - $ref: "#/components/schemas/VpcInterfaceAttachment" - xml: name: flowVpcInterfaceAttachment description: The name of the VPC interface attachment to use for this source. description: Update the flow source of the bridge. UpdateBridgeNetworkOutputRequest: type: object properties: IpAddress: allOf: - $ref: "#/components/schemas/__string" - xml: name: ipAddress description: The network output IP Address. NetworkName: allOf: - $ref: "#/components/schemas/__string" - xml: name: networkName description: The network output's gateway network name. Port: allOf: - $ref: "#/components/schemas/__integer" - xml: name: port description: The network output port. Protocol: allOf: - $ref: "#/components/schemas/Protocol" - xml: name: protocol description: The network output protocol. Ttl: allOf: - $ref: "#/components/schemas/__integer" - xml: name: ttl description: The network output TTL. description: Update an existing network output. UpdateBridgeNetworkSourceRequest: type: object properties: MulticastIp: allOf: - $ref: "#/components/schemas/__string" - xml: name: multicastIp description: The network source multicast IP. NetworkName: allOf: - $ref: "#/components/schemas/__string" - xml: name: networkName description: The network source's gateway network name. Port: allOf: - $ref: "#/components/schemas/__integer" - xml: name: port description: The network source port. Protocol: allOf: - $ref: "#/components/schemas/Protocol" - xml: name: protocol description: The network source protocol. description: Update the network source of the bridge. UpdateBridgeOutputRequest: type: object title: UpdateBridgeOutputRequest properties: NetworkOutput: allOf: - $ref: "#/components/schemas/UpdateBridgeNetworkOutputRequest" - xml: name: networkOutput description: The fields that you want to update in the bridge output. UpdateEgressGatewayBridgeRequest: type: object properties: MaxBitrate: allOf: - $ref: "#/components/schemas/__integer" - xml: name: maxBitrate description: Update an existing egress-type bridge. UpdateIngressGatewayBridgeRequest: type: object properties: MaxBitrate: allOf: - $ref: "#/components/schemas/__integer" - xml: name: maxBitrate description: The maximum expected bitrate (in bps). MaxOutputs: allOf: - $ref: "#/components/schemas/__integer" - xml: name: maxOutputs description: The maximum number of expected outputs. UpdateFailoverConfig: 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 description: The settings for source failover. UpdateBridgeRequest: type: object title: UpdateBridgeRequest properties: EgressGatewayBridge: allOf: - $ref: "#/components/schemas/UpdateEgressGatewayBridgeRequest" - xml: name: egressGatewayBridge IngressGatewayBridge: allOf: - $ref: "#/components/schemas/UpdateIngressGatewayBridgeRequest" - xml: name: ingressGatewayBridge SourceFailoverConfig: allOf: - $ref: "#/components/schemas/UpdateFailoverConfig" - xml: name: sourceFailoverConfig description: A request to update the bridge. UpdateBridgeSourceRequest: type: object title: UpdateBridgeSourceRequest properties: FlowSource: allOf: - $ref: "#/components/schemas/UpdateBridgeFlowSourceRequest" - xml: name: flowSource NetworkSource: allOf: - $ref: "#/components/schemas/UpdateBridgeNetworkSourceRequest" - xml: name: networkSource description: The fields that you want to update in the bridge source. UpdateBridgeStateRequest: type: object required: - DesiredState title: UpdateBridgeStateRequest properties: DesiredState: allOf: - $ref: "#/components/schemas/DesiredState" - xml: name: desiredState description: A request to update the bridge state. UpdateEncryption: 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: Information about the encryption of the flow. UpdateFlowEntitlementRequest: type: object title: UpdateFlowEntitlementRequest properties: 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/UpdateEncryption" - xml: name: encryption description: "The type of encryption that will be used on the output associated with this entitlement. Allowable encryption types: static-key, speke." EntitlementStatus: allOf: - $ref: "#/components/schemas/EntitlementStatus" - xml: name: 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. 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 entitlement fields that you want to update. UpdateFlowMediaStreamRequest: type: object title: UpdateFlowMediaStreamRequest properties: Attributes: allOf: - $ref: "#/components/schemas/MediaStreamAttributesRequest" - xml: name: attributes description: The attributes that you want to assign to the 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: Description 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 fields that you want to update in the media stream. UpdateFlowOutputRequest: type: object title: UpdateFlowOutputRequest 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 where you want to send the output. Encryption: allOf: - $ref: "#/components/schemas/UpdateEncryption" - 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. 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 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. 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 fields that you want to update in the output. UpdateMaintenance: 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." description: Update maintenance setting for a flow UpdateFlowRequest: type: object title: UpdateFlowRequest properties: SourceFailoverConfig: allOf: - $ref: "#/components/schemas/UpdateFailoverConfig" - xml: name: sourceFailoverConfig Maintenance: allOf: - $ref: "#/components/schemas/UpdateMaintenance" - xml: name: maintenance description: A request to update flow. UpdateGatewayBridgeSourceRequest: 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. description: The source configuration for cloud flows receiving a stream from a bridge. UpdateFlowSourceRequest: type: object title: UpdateFlowSourceRequest properties: Decryption: allOf: - $ref: "#/components/schemas/UpdateEncryption" - xml: name: decryption description: "The type of encryption 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. 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/UpdateGatewayBridgeSourceRequest" - xml: name: gatewayBridgeSource description: The source configuration for cloud flows receiving a stream from a bridge. description: A request to update the source of a flow. UpdateGatewayInstanceRequest: type: object title: UpdateGatewayInstanceRequest properties: BridgePlacement: allOf: - $ref: "#/components/schemas/BridgePlacement" - xml: name: bridgePlacement description: The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be added to this instance. description: A request to update gateway instance state. 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. security: - hmac: []