Amazon MediaConnect Bridges API

openapi: 3.2.0
info:
  version: 1.0.0
  x-release: v4
  title: AWS MediaConnect Bridges API
  description: API for AWS Elemental MediaConnect
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: mediaconnect
  x-aws-signingName: mediaconnect
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/mediaconnect-2018-11-14.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://mediaconnect.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS MediaConnect multi-region endpoint
- url: https://mediaconnect.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS MediaConnect multi-region endpoint
- url: http://mediaconnect.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS MediaConnect endpoint for China (Beijing) and China (Ningxia)
- url: https://mediaconnect.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS MediaConnect endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Bridges
paths:
  /v1/bridges/{bridgeArn}/outputs:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: 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
      tags:
      - Bridges
  /v1/bridges/{bridgeArn}/sources:
    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: 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
      tags:
      - Bridges
  /v1/bridges:
    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: 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
      tags:
      - Bridges
    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
      tags:
      - Bridges
  /v1/bridges/{bridgeArn}:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    delete:
      operationId: 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
      tags:
      - Bridges
    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:
        

# --- truncated at 32 KB (90 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-mediaconnect/refs/heads/main/openapi/amazon-mediaconnect-bridges-api-openapi.yml