Amazon MediaTailor Channels API

openapi: 3.0.0
info:
  version: 2018-04-23
  x-release: v4
  title: AWS MediaTailor Alerts#resourceArn Channels API
  description: <p>Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/">AWS Elemental MediaTailor User Guide</a>.</p> <p>Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).</p>
  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: mediatailor
  x-aws-signingName: mediatailor
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/mediatailor-2018-04-23.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://api.mediatailor.{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 MediaTailor multi-region endpoint
- url: https://api.mediatailor.{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 MediaTailor multi-region endpoint
- url: http://api.mediatailor.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The MediaTailor endpoint for China (Beijing) and China (Ningxia)
- url: https://api.mediatailor.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The MediaTailor endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Channels
paths:
  /channels:
    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: ListChannels
      description: Retrieves information about the channels that are associated with the current AWS account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListChannelsResponse'
              examples:
                ListChannels200Example:
                  summary: Default ListChannels 200 response
                  x-microcks-default: true
                  value:
                    Items: example-value
                    NextToken: example-value
      parameters:
      - name: maxResults
        in: query
        required: false
        description: The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> channels, use the value of <code>NextToken</code> in the response to get the next page of results.
        schema:
          type: integer
          minimum: 1
          maximum: 100
      - name: nextToken
        in: query
        required: false
        description: Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
        schema:
          type: string
      - name: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      summary: Amazon MediaTailor List Channels
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Channels
components:
  schemas:
    __listOfChannel:
      type: array
      items:
        $ref: '#/components/schemas/Channel'
    Channel:
      type: object
      required:
      - Arn
      - ChannelName
      - ChannelState
      - LogConfiguration
      - Outputs
      - PlaybackMode
      - Tier
      properties:
        Arn:
          allOf:
          - $ref: '#/components/schemas/__string'
          - description: The ARN of the channel.
        ChannelName:
          allOf:
          - $ref: '#/components/schemas/__string'
          - description: The name of the channel.
        ChannelState:
          allOf:
          - $ref: '#/components/schemas/__string'
          - description: Returns the state whether the channel is running or not.
        CreationTime:
          allOf:
          - $ref: '#/components/schemas/__timestampUnix'
          - description: The timestamp of when the channel was created.
        FillerSlate:
          allOf:
          - $ref: '#/components/schemas/SlateSource'
          - description: The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the <code>LINEAR</code> <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code> <code>PlaybackMode</code>.
        LastModifiedTime:
          allOf:
          - $ref: '#/components/schemas/__timestampUnix'
          - description: The timestamp of when the channel was last modified.
        LogConfiguration:
          allOf:
          - $ref: '#/components/schemas/LogConfigurationForChannel'
          - description: The log configuration.
        Outputs:
          allOf:
          - $ref: '#/components/schemas/ResponseOutputs'
          - description: The channel's output properties.
        PlaybackMode:
          allOf:
          - $ref: '#/components/schemas/__string'
          - description: <p>The type of playback mode for this channel.</p> <p> <code>LINEAR</code> - Programs play back-to-back only once.</p> <p> <code>LOOP</code> - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.</p>
        Tags:
          allOf:
          - $ref: '#/components/schemas/__mapOf__string'
          - xml:
              name: tags
            description: The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.
        Tier:
          allOf:
          - $ref: '#/components/schemas/__string'
          - description: The tier for this channel. STANDARD tier channels can contain live programs.
      description: The configuration parameters for a channel. For information about MediaTailor channels, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html">Working with channels</a> in the <i>MediaTailor User Guide</i>.
    __mapOf__string:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/__string'
    __timestampUnix:
      type: string
      format: date-time
    ListChannelsResponse:
      type: object
      properties:
        Items:
          allOf:
          - $ref: '#/components/schemas/__listOfChannel'
          - description: A list of channels that are associated with this account.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/__string'
          - description: Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
    __integer:
      type: integer
    LogType:
      type: string
      enum:
      - AS_RUN
    ResponseOutputItem:
      type: object
      required:
      - ManifestName
      - PlaybackUrl
      - SourceGroup
      properties:
        DashPlaylistSettings:
          allOf:
          - $ref: '#/components/schemas/DashPlaylistSettings'
          - description: DASH manifest configuration settings.
        HlsPlaylistSettings:
          allOf:
          - $ref: '#/components/schemas/HlsPlaylistSettings'
          - description: HLS manifest configuration settings.
        ManifestName:
          allOf:
          - $ref: '#/components/schemas/__string'
          - description: The name of the manifest for the channel that will appear in the channel output's playback URL.
        PlaybackUrl:
          allOf:
          - $ref: '#/components/schemas/__string'
          - description: The URL used for playback by content players.
        SourceGroup:
          allOf:
          - $ref: '#/components/schemas/__string'
          - description: A string used to associate a package configuration source group with a channel output.
      description: The output item response.
    LogConfigurationForChannel:
      type: object
      properties:
        LogTypes:
          allOf:
          - $ref: '#/components/schemas/LogTypes'
          - description: The log types.
      description: The log configuration for the channel.
    SlateSource:
      type: object
      properties:
        SourceLocationName:
          allOf:
          - $ref: '#/components/schemas/__string'
          - description: The name of the source location where the slate VOD source is stored.
        VodSourceName:
          allOf:
          - $ref: '#/components/schemas/__string'
          - description: The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
      description: Slate VOD source configuration.
    ResponseOutputs:
      type: array
      items:
        $ref: '#/components/schemas/ResponseOutputItem'
    HlsPlaylistSettings:
      type: object
      properties:
        ManifestWindowSeconds:
          allOf:
          - $ref: '#/components/schemas/__integer'
          - description: 'The total duration (in seconds) of each manifest. Minimum value: <code>30</code> seconds. Maximum value: <code>3600</code> seconds.'
      description: HLS playlist configuration parameters.
    DashPlaylistSettings:
      type: object
      properties:
        ManifestWindowSeconds:
          allOf:
          - $ref: '#/components/schemas/__integer'
          - description: 'The total duration (in seconds) of each manifest. Minimum value: <code>30</code> seconds. Maximum value: <code>3600</code> seconds.'
        MinBufferTimeSeconds:
          allOf:
          - $ref: '#/components/schemas/__integer'
          - description: 'Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: <code>2</code> seconds. Maximum value: <code>60</code> seconds.'
        MinUpdatePeriodSeconds:
          allOf:
          - $ref: '#/components/schemas/__integer'
          - description: 'Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: <code>2</code> seconds. Maximum value: <code>60</code> seconds.'
        SuggestedPresentationDelaySeconds:
          allOf:
          - $ref: '#/components/schemas/__integer'
          - description: 'Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: <code>2</code> seconds. Maximum value: <code>60</code> seconds.'
      description: Dash manifest configuration parameters.
    LogTypes:
      type: array
      items:
        $ref: '#/components/schemas/LogType'
    __string:
      type: string
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      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-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/mediatailor/
x-hasEquivalentPaths: true