Amazon MediaConnect Mediaconnect Sourceendpoint API

openapi: 3.2.0
info:
  title: AWS MediaConnect Sourceendpoint API
  version: '2018-11-14'
  description: Generated from AWS's published Smithy model for AWS MediaConnect. 6 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://mediaconnect.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Sourceendpoint
paths:
  /v1/sourceEndpoint:
    post:
      operationId: RegisterSourceEndpoint
      summary: Register Source Endpoint
      description: Registers a new source endpoint in MediaConnect.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterSourceEndpointResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '420':
          description: SourceEndpointServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceEndpointServiceQuotaExceededException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterSourceEndpointRequest'
      tags:
      - Sourceendpoint
  /v1/sourceEndpoint/{Arn}:
    get:
      operationId: GetSourceEndpoint
      summary: Get Source Endpoint
      description: Retrieves information about a source endpoint.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSourceEndpointResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetSourceEndpointRequest'
      tags:
      - Sourceendpoint
    put:
      operationId: UpdateSourceEndpoint
      summary: Update Source Endpoint
      description: Updates the configuration of a source endpoint.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSourceEndpointResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSourceEndpointRequest'
      tags:
      - Sourceendpoint
    delete:
      operationId: DeregisterSourceEndpoint
      summary: Deregister Source Endpoint
      description: Deregisters a source endpoint from MediaConnect.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeregisterSourceEndpointResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeregisterSourceEndpointRequest'
      tags:
      - Sourceendpoint
components:
  schemas:
    SrtCallerStandardSourceEndpointConfiguration:
      type: object
      properties:
        DestinationIngestPort:
          type: integer
          description: The port on which the destination listens for the connection. The valid range is 3000 to 30000.
        MinimumLatencyMilliseconds:
          type: integer
          description: The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        EncryptionPassphrase:
          $ref: '#/components/schemas/EndpointEncryptionSecretConfiguration'
      required:
      - DestinationIngestPort
      - MinimumLatencyMilliseconds
    StandardSourceEndpointAssociatedResourceDetails:
      type: object
      properties: {}
    InternalServerErrorException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    RtpStandardSourceEndpointConfiguration:
      type: object
      properties:
        DestinationIngestPort:
          type: integer
          description: The port on the destination that receives the content. The valid range is 3000 to 30000.
        ForwardErrorCorrectionState:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Indicates whether forward error correction (FEC) is enabled for the source endpoint.
      required:
      - DestinationIngestPort
      - ForwardErrorCorrectionState
    RouterOutputSourceEndpointConfiguration:
      type: object
      properties:
        RouterOutputArn:
          type: string
          description: The Amazon Resource Name (ARN) of the router output that the source endpoint represents.
      required:
      - RouterOutputArn
    SecretsManagerEndpointEncryptionConfiguration:
      type: object
      properties:
        EncryptionSecretType:
          type: string
          enum:
          - AES_128_KEY
          - AES_192_KEY
          - AES_256_KEY
          - SRT_PASSPHRASE
          description: 'The type of secret used to encrypt the connection. Valid values include the following: AES_128_KEY – A 128-bit AES encryption key. AES_192_KEY – A 192-bit AES encryption key. AES_256_KEY – A 256-bit AES encryption key. SRT_PASSPHRASE – An SRT passphrase.'
        EncryptionSecret:
          $ref: '#/components/schemas/EndpointEncryptionSecretConfiguration'
      required:
      - EncryptionSecret
    AutomaticEndpointEncryptionConfiguration:
      type: object
      properties: {}
    PublicSourceEndpointNetworkingConfiguration:
      type: object
      properties:
        SourceAllowRules:
          type: array
          items:
            $ref: '#/components/schemas/PublicSourceEndpointNetworkingConfigurationAllowRule'
          description: The rules that specify which CIDR blocks can connect to the source endpoint. You can specify up to 10 rules.
      required:
      - SourceAllowRules
    VpcSourceEndpointNetworkingConfiguration:
      type: object
      properties:
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: The IDs of the security groups to associate with the source endpoint. You can specify from 1 to 5 security groups.
        SubnetId:
          type: string
          description: The ID of the subnet to use for the source endpoint.
      required:
      - SecurityGroupIds
      - SubnetId
    GetSourceEndpointResponse:
      type: object
      properties:
        SourceEndpoint:
          $ref: '#/components/schemas/SourceEndpoint'
      required:
      - SourceEndpoint
    EndpointEncryptionSecretConfiguration:
      type: object
      properties:
        SecretArn:
          type: string
          description: The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
      required:
      - SecretArn
    StandardSourceEndpointProtocolConfiguration:
      type: object
      properties:
        Rist:
          $ref: '#/components/schemas/RistStandardSourceEndpointConfiguration'
        SrtListener:
          $ref: '#/components/schemas/SrtListenerStandardSourceEndpointConfiguration'
        SrtCaller:
          $ref: '#/components/schemas/SrtCallerStandardSourceEndpointConfiguration'
        Rtp:
          $ref: '#/components/schemas/RtpStandardSourceEndpointConfiguration'
      description: Exactly one member is set.
    ConsumedResourceShareDetails:
      type: object
      properties:
        OwnerAccountId:
          type: string
          description: The ID of the Amazon Web Services account that owns the shared endpoint.
      required:
      - OwnerAccountId
    RegisterSourceEndpointResponse:
      type: object
      properties:
        SourceEndpoint:
          $ref: '#/components/schemas/SourceEndpoint'
      required:
      - SourceEndpoint
    ForbiddenException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    RouterOutputSourceEndpointAssociatedResourceDetails:
      type: object
      properties:
        Name:
          type: string
          description: The name of the router output.
        MaximumBitrate:
          type: integer
          description: The maximum bitrate of the router output, in bits per second.
        State:
          type: string
          enum:
          - CREATING
          - STANDBY
          - STARTING
          - ACTIVE
          - STOPPING
          - DELETING
          - UPDATING
          - ERROR
          - RECOVERING
          - MIGRATING
          description: The state of the router output.
        Messages:
          type: array
          items:
            $ref: '#/components/schemas/RouterOutputMessage'
          description: The status messages for the router output.
      required:
      - Name
      - MaximumBitrate
      - State
      - Messages
    PublicSourceEndpointNetworkingConfigurationAllowRule:
      type: object
      properties:
        Cidr:
          type: string
          description: The CIDR block that is allowed to connect to the source endpoint, in CIDR notation.
      required:
      - Cidr
    RouterOutputMessage:
      type: object
      properties:
        Code:
          type: string
          description: The code associated with the router output message.
        Message:
          type: string
          description: The message text associated with the router output message.
      required:
      - Code
      - Message
    RouterOutputSourceEndpointConnectionDetails:
      type: object
      properties:
        DestinationDecryptionType:
          type: string
          enum:
          - SECRETS_MANAGER
          - AUTOMATIC
          description: The type of decryption that the destination uses for the connection.
        DestinationDecryptionConfiguration:
          $ref: '#/components/schemas/EndpointEncryptionConfiguration'
        DestinationEndpointType:
          type: string
          enum:
          - STANDARD
          - ROUTER_INPUT
          description: The type of the connected destination endpoint.
    OwnedResourceShareDetails:
      type: object
      properties:
        ShareState:
          type: string
          enum:
          - SHARED
          - UNSHARED
          description: 'The sharing state of the endpoint. Valid values include the following: SHARED – The endpoint is shared with one or more accounts. UNSHARED – The endpoint is not shared with other accounts.'
      required:
      - ShareState
    SourceEndpointConfiguration:
      type: object
      properties:
        Standard:
          $ref: '#/components/schemas/StandardSourceEndpointConfiguration'
        RouterOutput:
          $ref: '#/components/schemas/RouterOutputSourceEndpointConfiguration'
      description: Exactly one member is set.
    DeregisterSourceEndpointResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the source endpoint that was deregistered.
        Name:
          type: string
          description: The name of the source endpoint that was deregistered.
      required:
      - Arn
      - Name
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    SourceEndpointServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ServiceUnavailableException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    StandardSourceEndpointNetworkingConfiguration:
      type: object
      properties:
        Public:
          $ref: '#/components/schemas/PublicSourceEndpointNetworkingConfiguration'
        Vpc:
          $ref: '#/components/schemas/VpcSourceEndpointNetworkingConfiguration'
      description: Exactly one member is set.
    SrtListenerStandardSourceEndpointConfiguration:
      type: object
      properties:
        SourceListenerPort:
          type: integer
          description: The port that the source endpoint listens on for incoming connections. The valid range is 1024 to 65535.
        SourceAddress:
          type: string
          description: The IP address that the source endpoint listens on for incoming connections.
        MinimumLatencyMilliseconds:
          type: integer
          description: The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        StreamId:
          type: string
          description: The stream ID that identifies the content for the SRT connection.
        EncryptionPassphrase:
          $ref: '#/components/schemas/EndpointEncryptionSecretConfiguration'
      required:
      - SourceListenerPort
      - SourceAddress
      - MinimumLatencyMilliseconds
    UpdateSourceEndpointResponse:
      type: object
      properties:
        SourceEndpoint:
          $ref: '#/components/schemas/SourceEndpoint'
      required:
      - SourceEndpoint
    EndpointEncryptionConfiguration:
      type: object
      properties:
        SecretsManager:
          $ref: '#/components/schemas/SecretsManagerEndpointEncryptionConfiguration'
        Automatic:
          $ref: '#/components/schemas/AutomaticEndpointEncryptionConfiguration'
      description: Exactly one member is set.
    StandardSourceEndpointConfiguration:
      type: object
      properties:
        Name:
          type: string
          description: The name of the source endpoint.
        SourceNetworkingConfiguration:
          $ref: '#/components/schemas/StandardSourceEndpointNetworkingConfiguration'
        ProtocolConfiguration:
          $ref: '#/components/schemas/StandardSourceEndpointProtocolConfiguration'
        SourceNetworkingType:
          type: string
          enum:
          - PUBLIC
          - VPC
          description: 'The networking type of the source endpoint. Valid values include the following: PUBLIC – The source endpoint is publicly accessible. VPC – The source endpoint is in a virtual private cloud (VPC).'
        Protocol:
          type: string
          enum:
          - RTP
          - RIST
          - SRT_CALLER
          - SRT_LISTENER
          description: 'The protocol used by the source endpoint. Valid values include the following: RTP – Real-time Transport Protocol. RIST – Reliable Internet Stream Transport. SRT_CALLER – Secure Reliable Transport (SRT) in caller mode. SRT_LISTENER – Secure Reliable Transport (SRT) in listener mode.'
      required:
      - Name
      - SourceNetworkingConfiguration
      - ProtocolConfiguration
    StandardSourceEndpointConnectionDetails:
      type: object
      properties:
        DestinationIpAddress:
          type: string
          description: The IP address of the destination that receives the content.
        DestinationIngestPort:
          type: integer
          description: The port on the destination that receives the content.
        DestinationDecryptionType:
          type: string
          enum:
          - SECRETS_MANAGER
          - AUTOMATIC
          description: The type of decryption that the destination uses for the connection.
        DestinationDecryptionConfiguration:
          $ref: '#/components/schemas/EndpointEncryptionConfiguration'
        DestinationEndpointType:
          type: string
          enum:
          - STANDARD
          - ROUTER_INPUT
          description: The type of the connected destination endpoint.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ResourceShareDetails:
      type: object
      properties:
        Owned:
          $ref: '#/components/schemas/OwnedResourceShareDetails'
        Consumed:
          $ref: '#/components/schemas/ConsumedResourceShareDetails'
      description: Exactly one member is set.
    DeregisterSourceEndpointRequest:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the source endpoint to deregister.
      required:
      - Arn
    SourceEndpoint:
      type: object
      properties:
        Name:
          type: string
          description: The name of the source endpoint.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the source endpoint.
        Id:
          type: string
          description: The unique identifier of the source endpoint.
        Description:
          type: string
          description: The description of the source endpoint.
        RegionName:
          type: string
          description: The name of the Amazon Web Services Region in which the source endpoint is located.
        AvailabilityZone:
          type: string
          description: The Availability Zone in which the source endpoint is located.
        AvailabilityZoneId:
          type: string
          description: The ID of the Availability Zone in which the source endpoint is located.
        CreatedAt:
          type: string
          description: The date and time when the source endpoint was created.
        UpdatedAt:
          type: string
          description: The date and time when the source endpoint was last updated.
        LifecycleManagement:
          type: string
          enum:
          - MANAGED
          - UNMANAGED
          description: The entity that manages the lifecycle of the source endpoint.
        Messages:
          type: array
          items:
            $ref: '#/components/schemas/SourceEndpointMessage'
          description: The status messages for the source endpoint.
        SourceType:
          type: string
          enum:
          - STANDARD
          - ROUTER_OUTPUT
          description: 'The type of the source endpoint. Valid values include the following: STANDARD – A source endpoint that represents an external source over a standard protocol, such as RTP, RIST, or SRT. ROUTER_OUTPUT – A source endpoint that represents a router output.'
        Configuration:
          $ref: '#/components/schemas/SourceEndpointConfiguration'
        ResourceShareOwnership:
          type: string
          enum:
          - OWNED
          - CONSUMED
          description: Indicates whether this account owns the source endpoint or consumes it from another account through RAM.
        ResourceShareDetails:
          $ref: '#/components/schemas/ResourceShareDetails'
        RegistrationState:
          type: string
          enum:
          - REGISTERED
          - REGISTERING
          - DEREGISTERING
          - REGISTRATION_FAILED
          description: 'The registration state of the source endpoint. Valid values include the following: REGISTERED – The source endpoint is registered and ready to use. REGISTERING – MediaConnect is registering the source endpoint. DEREGISTERING – MediaConnect is deregistering the source endpoint. REGISTRATION_FAILED – MediaConnect couldn''t register the source endpoint.'
        ConnectionState:
          type: string
          enum:
          - CONNECTED
          - DISCONNECTED
          - CONNECTING
          - DISCONNECTING
          description: 'The connection state of the source endpoint. Valid values include the following: CONNECTED – The source endpoint is connected to a destination endpoint. DISCONNECTED – The source endpoint isn''t connected to a destination endpoint. CONNECTING – The source endpoint is connecting to a destination endpoint. DISCONNECTING – The source endpoint is disconnecting from a destination endpoint.'
        ConnectionDetails:
          $ref: '#/components/schemas/SourceEndpointConnectionDetails'
        ConnectedDestinations:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the destination endpoints that are connected to the source endpoint.
        EncryptionType:
          type: string
          enum:
          - SECRETS_MANAGER
          - AUTOMATIC
          description: The type of encryption used for the source endpoint connection.
        EncryptionConfiguration:
          $ref: '#/components/schemas/EndpointEncryptionConfiguration'
        AssociatedResourceDetails:
          $ref: '#/components/schemas/SourceEndpointAssociatedResourceDetails'
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags associated with the source endpoint. Each tag is a key-value pair.
      required:
      - Name
      - Arn
      - Id
      - Description
      - RegionName
      - CreatedAt
      - UpdatedAt
      - LifecycleManagement
      - Messages
      - SourceType
      - Configuration
      - ResourceShareOwnership
      - ResourceShareDetails
      - RegistrationState
      - ConnectionState
      - ConnectedDestinations
      - AssociatedResourceDetails
      - Tags
    RegisterSourceEndpointRequest:
      type: object
      properties:
        RegionName:
          type: string
          description: The name of the Amazon Web Services Region in which to register the source endpoint. Defaults to the current region if not specified.
        Description:
          type: string
          description: A description to help you identify the source endpoint.
        Configuration:
          $ref: '#/components/schemas/SourceEndpointConfiguration'
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags to apply to the source endpoint. Each tag is a key-value pair.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If this token matches a previous request, the service ignores the request, but does not return an error.
      required:
      - Configuration
    RistStandardSourceEndpointConfiguration:
      type: object
      properties:
        DestinationIngestPort:
          type: integer
          description: The port on the destination that receives the content. The valid range is 3000 to 30000.
        RecoveryLatencyMilliseconds:
          type: integer
          description: The amount of time, in milliseconds, that the source endpoint allows for recovering lost packets. The valid range is 10 to 10000.
      required:
      - DestinationIngestPort
      - RecoveryLatencyMilliseconds
    SourceEndpointConnectionDetails:
      type: object
      properties:
        Standard:
          $ref: '#/components/schemas/StandardSourceEndpointConnectionDetails'
        RouterOutput:
          $ref: '#/components/schemas/RouterOutputSourceEndpointConnectionDetails'
      description: Exactly one member is set.
    TooManyRequestsException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    UpdateSourceEndpointRequest:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the source endpoint to update.
        Description:
          type: string
          description: A description to help you identify the source endpoint.
        Configuration:
          $ref: '#/components/schemas/SourceEndpointConfiguration'
      required:
      - Arn
    SourceEndpointMessage:
      type: object
      properties:
        Code:
          type: string
          description: The message code.
        Message:
          type: string
          description: The message text.
      required:
      - Code
      - Message
    SourceEndpointAssociatedResourceDetails:
      type: object
      properties:
        Standard:
          $ref: '#/components/schemas/StandardSourceEndpointAssociatedResourceDetails'
        RouterOutput:
          $ref: '#/components/schemas/RouterOutputSourceEndpointAssociatedResourceDetails'
      description: Exactly one member is set.
    GetSourceEndpointRequest:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the source endpoint to retrieve.
      required:
      - Arn
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: mediaconnect
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/mediaconnect/service/2018-11-14/mediaconnect-2018-11-14.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)