Amazon MediaTailor Channels API

openapi: 3.1.0
info:
  title: AWS MediaTailor Channels API
  version: '2018-04-23'
  description: Generated from AWS's published Smithy model for AWS MediaTailor. 5 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://api.mediatailor.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /channel/{ChannelName}:
    post:
      operationId: CreateChannel
      summary: Create Channel
      description: Creates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor
        User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateChannelResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateChannelRequest'
      tags:
      - Channels
    get:
      operationId: DescribeChannel
      summary: Describe Channel
      description: Describes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor
        User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeChannelResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeChannelRequest'
      tags:
      - Channels
    put:
      operationId: UpdateChannel
      summary: Update Channel
      description: Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor
        User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateChannelResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateChannelRequest'
      tags:
      - Channels
    delete:
      operationId: DeleteChannel
      summary: Delete Channel
      description: Deletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor
        User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteChannelResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteChannelRequest'
      tags:
      - Channels
  /channels:
    get:
      operationId: ListChannels
      summary: List Channels
      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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListChannelsRequest'
      tags:
      - Channels
components:
  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: mediatailor
  schemas:
    Channel:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the channel.
        ChannelName:
          type: string
          description: The name of the channel.
        ChannelState:
          type: string
          description: Returns the state whether the channel is running or not.
        CreationTime:
          type: string
          format: date-time
          description: The timestamp of when the channel was created.
        FillerSlate:
          $ref: '#/components/schemas/SlateSource'
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp of when the channel was last modified.
        Outputs:
          type: array
          items:
            $ref: '#/components/schemas/ResponseOutputItem'
          description: The channel's output properties.
        PlaybackMode:
          type: string
          description: The type of playback mode for this channel. LINEAR - Programs play back-to-back only once. LOOP - 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.
        Tags:
          type: object
          additionalProperties:
            type: string
          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 Tagging AWS Elemental
            MediaTailor Resources.
        Tier:
          type: string
          description: The tier for this channel. STANDARD tier channels can contain live programs.
        LogConfiguration:
          $ref: '#/components/schemas/LogConfigurationForChannel'
        Audiences:
          type: array
          items:
            type: string
          description: The list of audiences defined in channel.
      required:
      - Arn
      - ChannelName
      - ChannelState
      - Outputs
      - PlaybackMode
      - Tier
      - LogConfiguration
    CreateChannelRequest:
      type: object
      properties:
        ChannelName:
          type: string
          description: The name of the channel.
        FillerSlate:
          $ref: '#/components/schemas/SlateSource'
        Outputs:
          type: array
          items:
            $ref: '#/components/schemas/RequestOutputItem'
          description: The channel's output properties.
        PlaybackMode:
          type: string
          enum:
          - LOOP
          - LINEAR
          description: The type of playback mode to use for this channel. LINEAR - The programs in the schedule play once
            back-to-back in the schedule. LOOP - The programs in the schedule play back-to-back in an endless loop. When the
            last program in the schedule stops playing, playback loops back to the first program in the schedule.
        Tags:
          type: object
          additionalProperties:
            type: string
          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 Tagging AWS Elemental
            MediaTailor Resources.
        Tier:
          type: string
          enum:
          - BASIC
          - STANDARD
          description: The tier of the channel.
        TimeShiftConfiguration:
          $ref: '#/components/schemas/TimeShiftConfiguration'
        Audiences:
          type: array
          items:
            type: string
          description: The list of audiences defined in channel.
      required:
      - ChannelName
      - Outputs
      - PlaybackMode
    CreateChannelResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) to assign to the channel.
        ChannelName:
          type: string
          description: The name to assign to the channel.
        ChannelState:
          type: string
          enum:
          - RUNNING
          - STOPPED
          description: Indicates whether the channel is in a running state or not.
        CreationTime:
          type: string
          format: date-time
          description: The timestamp of when the channel was created.
        FillerSlate:
          $ref: '#/components/schemas/SlateSource'
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp of when the channel was last modified.
        Outputs:
          type: array
          items:
            $ref: '#/components/schemas/ResponseOutputItem'
          description: The output properties to assign to the channel.
        PlaybackMode:
          type: string
          description: The playback mode to assign to the channel.
        Tags:
          type: object
          additionalProperties:
            type: string
          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 Tagging AWS Elemental
            MediaTailor Resources.
        Tier:
          type: string
          description: The tier of the channel.
        TimeShiftConfiguration:
          $ref: '#/components/schemas/TimeShiftConfiguration'
        Audiences:
          type: array
          items:
            type: string
          description: The list of audiences defined in channel.
    DashPlaylistSettings:
      type: object
      properties:
        ManifestWindowSeconds:
          type: integer
          description: 'The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.'
        MinBufferTimeSeconds:
          type: integer
          description: 'Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum
            value: 2 seconds. Maximum value: 60 seconds.'
        MinUpdatePeriodSeconds:
          type: integer
          description: 'Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.
            Minimum value: 2 seconds. Maximum value: 60 seconds.'
        SuggestedPresentationDelaySeconds:
          type: integer
          description: 'Amount of time (in seconds) that the player should be from the live point at the end of the manifest.
            Minimum value: 2 seconds. Maximum value: 60 seconds.'
    DeleteChannelRequest:
      type: object
      properties:
        ChannelName:
          type: string
          description: The name of the channel.
      required:
      - ChannelName
    DeleteChannelResponse:
      type: object
      properties: {}
    DescribeChannelRequest:
      type: object
      properties:
        ChannelName:
          type: string
          description: The name of the channel.
      required:
      - ChannelName
    DescribeChannelResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the channel.
        ChannelName:
          type: string
          description: The name of the channel.
        ChannelState:
          type: string
          enum:
          - RUNNING
          - STOPPED
          description: Indicates whether the channel is in a running state or not.
        CreationTime:
          type: string
          format: date-time
          description: The timestamp of when the channel was created.
        FillerSlate:
          $ref: '#/components/schemas/SlateSource'
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp of when the channel was last modified.
        Outputs:
          type: array
          items:
            $ref: '#/components/schemas/ResponseOutputItem'
          description: The channel's output properties.
        PlaybackMode:
          type: string
          description: The channel's playback mode.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags assigned 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 Tagging AWS Elemental
            MediaTailor Resources.
        Tier:
          type: string
          description: The channel's tier.
        LogConfiguration:
          $ref: '#/components/schemas/LogConfigurationForChannel'
        TimeShiftConfiguration:
          $ref: '#/components/schemas/TimeShiftConfiguration'
        Audiences:
          type: array
          items:
            type: string
          description: The list of audiences defined in channel.
      required:
      - LogConfiguration
    HlsPlaylistSettings:
      type: object
      properties:
        ManifestWindowSeconds:
          type: integer
          description: 'The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.'
        AdMarkupType:
          type: array
          items:
            type: string
            enum:
            - DATERANGE
            - SCTE35_ENHANCED
          description: Determines the type of SCTE 35 tags to use in ad markup. Specify DATERANGE to use DATERANGE tags (for
            live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).
    ListChannelsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of channels that you want MediaTailor to return in response to the current request.
            If there are more than MaxResults channels, use the value of NextToken in the response to get the next page of
            results. The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might
            contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all
            results, you must continue making requests using the NextToken value from each response until the response no
            longer includes a NextToken value.
        NextToken:
          type: 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. For the first ListChannels request, omit this value. For subsequent requests,
            get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue
            making requests until the response no longer includes a NextToken value, which indicates that all results have
            been retrieved.
    ListChannelsResponse:
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/Channel'
          description: A list of channels that are associated with this account.
        NextToken:
          type: 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.
    LogConfigurationForChannel:
      type: object
      properties:
        LogTypes:
          type: array
          items:
            type: string
            enum:
            - AS_RUN
          description: The log types.
    RequestOutputItem:
      type: object
      properties:
        DashPlaylistSettings:
          $ref: '#/components/schemas/DashPlaylistSettings'
        HlsPlaylistSettings:
          $ref: '#/components/schemas/HlsPlaylistSettings'
        ManifestName:
          type: string
          description: The name of the manifest for the channel. The name appears in the PlaybackUrl.
        SourceGroup:
          type: string
          description: A string used to match which HttpPackageConfiguration is used for each VodSource.
      required:
      - ManifestName
      - SourceGroup
    ResponseOutputItem:
      type: object
      properties:
        DashPlaylistSettings:
          $ref: '#/components/schemas/DashPlaylistSettings'
        HlsPlaylistSettings:
          $ref: '#/components/schemas/HlsPlaylistSettings'
        ManifestName:
          type: string
          description: The name of the manifest for the channel that will appear in the channel output's playback URL.
        PlaybackUrl:
          type: string
          description: The URL that your player uses for playback.
        DualStackPlaybackUrl:
          type: string
          description: The dual-stack (IPv4 and IPv6) URL that your player uses for playback.
        SourceGroup:
          type: string
          description: A string used to associate a package configuration source group with a channel output.
      required:
      - ManifestName
      - PlaybackUrl
      - SourceGroup
    SlateSource:
      type: object
      properties:
        SourceLocationName:
          type: string
          description: The name of the source location where the slate VOD source is stored.
        VodSourceName:
          type: string
          description: The slate VOD source name. The VOD source must already exist in a source location before it can be
            used for slate.
    TimeShiftConfiguration:
      type: object
      properties:
        MaxTimeDelaySeconds:
          type: integer
          description: The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds,
            and the maximum allowed maximum time delay is 21600 seconds (6 hours).
      required:
      - MaxTimeDelaySeconds
    UpdateChannelRequest:
      type: object
      properties:
        ChannelName:
          type: string
          description: The name of the channel.
        FillerSlate:
          $ref: '#/components/schemas/SlateSource'
        Outputs:
          type: array
          items:
            $ref: '#/components/schemas/RequestOutputItem'
          description: The channel's output properties.
        TimeShiftConfiguration:
          $ref: '#/components/schemas/TimeShiftConfiguration'
        Audiences:
          type: array
          items:
            type: string
          description: The list of audiences defined in channel.
      required:
      - ChannelName
      - Outputs
    UpdateChannelResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) associated with the channel.
        ChannelName:
          type: string
          description: The name of the channel.
        ChannelState:
          type: string
          enum:
          - RUNNING
          - STOPPED
          description: Returns the state whether the channel is running or not.
        CreationTime:
          type: string
          format: date-time
          description: The timestamp of when the channel was created.
        FillerSlate:
          $ref: '#/components/schemas/SlateSource'
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp that indicates when the channel was last modified.
        Outputs:
          type: array
          items:
            $ref: '#/components/schemas/ResponseOutputItem'
          description: The channel's output properties.
        PlaybackMode:
          type: string
          description: The type of playback mode for this channel. LINEAR - Programs play back-to-back only once. LOOP - 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.
        Tags:
          type: object
          additionalProperties:
            type: string
          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 Tagging AWS Elemental
            MediaTailor Resources.
        Tier:
          type: string
          description: The tier associated with this Channel.
        TimeShiftConfiguration:
          $ref: '#/components/schemas/TimeShiftConfiguration'
        Audiences:
          type: array
          items:
            type: string
          description: The list of audiences defined in channel.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/mediatailor/service/2018-04-23/mediatailor-2018-04-23.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)