openapi: 3.0.0
info:
  version: 2015-07-09
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Stream Videos API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</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: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.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://apigateway.{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 Amazon API Gateway multi-region endpoint
- url: https://apigateway.{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 Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Stream Videos
paths:
  /accounts/{account_id}/stream:
    get:
      description: Lists up to 1000 videos from a single request. For a specific range, refer to the optional parameters.
      operationId: stream-videos-list-videos
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_account_identifier'
      - in: query
        name: status
        schema:
          $ref: '#/components/schemas/stream_media_state'
      - in: query
        name: creator
        schema:
          $ref: '#/components/schemas/stream_creator'
      - in: query
        name: type
        schema:
          $ref: '#/components/schemas/stream_type'
      - in: query
        name: asc
        schema:
          $ref: '#/components/schemas/stream_asc'
      - in: query
        name: search
        schema:
          $ref: '#/components/schemas/stream_search'
      - in: query
        name: start
        schema:
          $ref: '#/components/schemas/stream_start'
      - in: query
        name: end
        schema:
          $ref: '#/components/schemas/stream_end'
      - in: query
        name: include_counts
        schema:
          $ref: '#/components/schemas/stream_include_counts'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: List videos response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_video_response_collection'
          description: List videos response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List videos
      tags:
      - Stream Videos
      x-api-token-group:
      - Stream Write
      - Stream Read
    post:
      description: Initiates a video upload using the TUS protocol. On success, the server responds with a status code 201 (created) and includes a `location` header to indicate where the content should be uploaded. Refer to https://tus.io for protocol details.
      operationId: stream-videos-initiate-video-uploads-using-tus
      parameters:
      - in: header
        name: Tus-Resumable
        required: true
        schema:
          $ref: '#/components/schemas/stream_tus_resumable'
      - in: header
        name: Upload-Creator
        schema:
          $ref: '#/components/schemas/stream_creator'
      - in: header
        name: Upload-Length
        required: true
        schema:
          $ref: '#/components/schemas/stream_upload_length'
      - in: header
        name: Upload-Metadata
        schema:
          $ref: '#/components/schemas/stream_upload_metadata'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json: {}
          description: Initiate video uploads using TUS response failure
        '200':
          content:
            application/json: {}
          description: Initiate video uploads using TUS response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Initiate video uploads using TUS
      tags:
      - Stream Videos
      x-api-token-group:
      - Stream Write
  /accounts/{account_id}/stream/{identifier}:
    delete:
      description: Deletes a video and its copies from Cloudflare Stream.
      operationId: stream-videos-delete-video
      parameters:
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json: {}
          description: Delete video response failure
        '200':
          content:
            application/json: {}
          description: Delete video response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Delete video
      tags:
      - Stream Videos
      x-api-token-group:
      - Stream Write
    get:
      description: Fetches details for a single video.
      operationId: stream-videos-retrieve-video-details
      parameters:
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Retrieve video details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_video_response_single'
          description: Retrieve video details response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Retrieve video details
      tags:
      - Stream Videos
      x-api-token-group:
      - Stream Write
      - Stream Read
    post:
      description: Edit details for a single video.
      operationId: stream-videos-update-video-details
      parameters:
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_video_update'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Edit video details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_video_response_single'
          description: Edit video details response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Edit video details
      tags:
      - Stream Videos
  /accounts/{account_id}/stream/{identifier}/embed:
    get:
      description: Fetches an HTML code snippet to embed a video in a web page delivered through Cloudflare. On success, returns an HTML fragment for use on web pages to display a video. On failure, returns a JSON response body.
      operationId: stream-videos-retreieve-embed-code-html
      parameters:
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Retreieve embed Code HTML response failure
        '200':
          content:
            application/json:
              schema:
                example: <stream id="ea95132c15732412d22c1476fa83f27a"></stream><script data-cfasync="false" defer type="text/javascript" src="https://embed.cloudflarestream.com/embed/we4g.fla9.latest.js"></script>
          description: Retreieve embed Code HTML response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Retrieve embed Code HTML
      tags:
      - Stream Videos
  /accounts/{account_id}/stream/{identifier}/token:
    post:
      description: Creates a signed URL token for a video. If a body is not provided in the request, a token is created with default values.
      operationId: stream-videos-create-signed-url-tokens-for-videos
      parameters:
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_signed_token_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Create signed URL tokens for videos response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_signed_token_response'
          description: Create signed URL tokens for videos response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Create signed URL tokens for videos
      tags:
      - Stream Videos
  /accounts/{account_id}/stream/copy:
    post:
      description: Uploads a video to Stream from a provided URL.
      operationId: stream-videos-upload-videos-from-a-url
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_account_identifier'
      - in: header
        name: Upload-Creator
        schema:
          $ref: '#/components/schemas/stream_creator'
      - in: header
        name: Upload-Metadata
        schema:
          $ref: '#/components/schemas/stream_upload_metadata'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_video_copy_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Upload videos from a URL response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_video_response_single'
          description: Upload videos from a URL response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Upload videos from a URL
      tags:
      - Stream Videos
  /accounts/{account_id}/stream/direct_upload:
    post:
      description: Creates a direct upload that allows video uploads without an API key.
      operationId: stream-videos-upload-videos-via-direct-upload-ur-ls
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_account_identifier'
      - in: header
        name: Upload-Creator
        schema:
          $ref: '#/components/schemas/stream_creator'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_direct_upload_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Upload videos via direct upload URLs response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_direct_upload_response'
          description: Upload videos via direct upload URLs response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Upload videos via direct upload URLs
      tags:
      - Stream Videos
  /accounts/{account_id}/stream/storage-usage:
    get:
      description: Returns information about an account's storage use.
      operationId: stream-videos-storage-usage
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_account_identifier'
      - in: query
        name: creator
        schema:
          $ref: '#/components/schemas/stream_creator'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Returns information about an account's storage use response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_storage_use_response'
          description: Returns information about an account's storage use response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Storage use
      tags:
      - Stream Videos
components:
  schemas:
    stream_asc:
      default: false
      description: Lists videos in ascending order of creation.
      example: true
      type: boolean
    stream_pctComplete:
      description: Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
      maximum: 100
      minimum: 0
      type: string
    stream_watermark_size:
      description: The size of the image in bytes.
      example: 29472
      type: number
    stream_playback:
      properties:
        dash:
          description: DASH Media Presentation Description for the video.
          example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd
          type: string
        hls:
          description: The HLS manifest for the video.
          example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8
          type: string
      type: object
    stream_type:
      description: Specifies whether the video is `vod` or `live`.
      example: live
      type: string
    stream_errorReasonCode:
      description: Specifies why the video failed to encode. This field is empty if the video is not in an `error` state. Preferred for programmatic use.
      example: ERR_NON_VIDEO
      type: string
    stream_search:
      description: Searches over the `name` key in the `meta` field. This field can be set with or after the upload request.
      example: puppy.mp4
      type: string
    stream_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/stream_messages'
        messages:
          $ref: '#/components/schemas/stream_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    stream_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    stream_preview:
      description: The video's preview page URI. This field is omitted until encoding is complete.
      example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/watch
      format: uri
      type: string
    stream_allowedOrigins:
      description: Lists the origins allowed to display the video. Enter allowed origin domains in an array and use `*` for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.
      example:
      - example.com
      items:
        type: string
      type: array
    stream_identifier:
      description: A Cloudflare-generated unique identifier for a media item.
      example: ea95132c15732412d22c1476fa83f27a
      maxLength: 32
      type: string
    stream_creator:
      description: A user-defined identifier for the media creator.
      example: creator-id_abcde12345
      maxLength: 64
      type: string
    stream_tus_resumable:
      description: 'Specifies the TUS protocol version. This value must be included in every upload request.

        Notes: The only supported version of TUS protocol is 1.0.0.'
      enum:
      - 1.0.0
      example: 1.0.0
      type: string
    stream_video_copy_request:
      properties:
        allowedOrigins:
          $ref: '#/components/schemas/stream_allowedOrigins'
        creator:
          $ref: '#/components/schemas/stream_creator'
        meta:
          $ref: '#/components/schemas/stream_media_metadata'
        requireSignedURLs:
          $ref: '#/components/schemas/stream_requireSignedURLs'
        scheduledDeletion:
          $ref: '#/components/schemas/stream_scheduledDeletion'
        thumbnailTimestampPct:
          $ref: '#/components/schemas/stream_thumbnailTimestampPct'
        url:
          description: A video's URL. The server must be publicly routable and support `HTTP HEAD` requests and `HTTP GET` range requests. The server should respond to `HTTP HEAD` requests with a `content-range` header that includes the size of the file.
          example: https://example.com/myvideo.mp4
          format: uri
          type: string
        watermark:
          $ref: '#/components/schemas/stream_watermark_at_upload'
      required:
      - url
    stream_video_response_collection:
      allOf:
      - $ref: '#/components/schemas/stream_api-response-common'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/stream_videos'
            type: array
      - properties:
          range:
            description: The total number of remaining videos based on cursor position.
            example: 1000
            type: integer
          total:
            description: The total number of videos that match the provided filters.
            example: 35586
            type: integer
    stream_padding:
      default: 0.05
      description: The whitespace between the adjacent edges (determined by position) of the video and the image. `0.0` indicates no padding, and `1.0` indicates a fully padded video width or length, as determined by the algorithm.
      example: 0.1
      maximum: 1
      minimum: 0
      type: number
    stream_scheduledDeletion:
      description: Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a `null` value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time.
      example: '2014-01-02T02:20:00Z'
      format: date-time
      type: string
    stream_upload_length:
      description: Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
      minimum: 0
      type: integer
    stream_errorReasonText:
      description: Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an `error` state.
      example: The file was not recognized as a valid video file.
      type: string
    stream_position:
      default: upperRight
      description: 'The location of the image. Valid positions are: `upperRight`, `upperLeft`, `lowerLeft`, `lowerRight`, and `center`. Note that `center` ignores the `padding` parameter.'
      example: center
      type: string
    stream_readyToStreamAt:
      description: Indicates the time at which the video became playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
      example: '2014-01-02T02:20:00Z'
      format: date-time
      type: string
    stream_signed_token_response:
      allOf:
      - $ref: '#/components/schemas/stream_api-response-single'
      - properties:
          result:
            properties:
              token:
                description: The signed token used with the signed URLs feature.
                example: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIn0.eyJzdWIiOiJlYTk1MTMyYzE1NzMyNDEyZDIyYzE0NzZmYTgzZjI3YSIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIiwiZXhwIjoiMTUzNzQ2MDM2NSIsIm5iZiI6IjE1Mzc0NTMxNjUifQ.OZhqOARADn1iubK6GKcn25hN3nU-hCFF5q9w2C4yup0C4diG7aMIowiRpP-eDod8dbAJubsiFuTKrqPcmyCKWYsiv0TQueukqbQlF7HCO1TV-oF6El5-7ldJ46eD-ZQ0XgcIYEKrQOYFF8iDQbqPm3REWd6BnjKZdeVrLzuRaiSnZ9qqFpGu5dfxIY9-nZKDubJHqCr3Imtb211VIG_b9MdtO92JjvkDS-rxT_pkEfTZSafl1OU-98A7KBGtPSJHz2dHORIrUiTA6on4eIXTj9aFhGiir4rSn-rn0OjPRTtJMWIDMoQyE_fwrSYzB7MPuzL2t82BWaEbHZTfixBm5A
                type: string
    stream_width:
      description: The width of the image in pixels.
      type: integer
    stream_storage_use_response:
      allOf:
      - $ref: '#/components/schemas/stream_api-response-single'
      - properties:
          result:
            properties:
              creator:
                $ref: '#/components/schemas/stream_creator'
              totalStorageMinutes:
                description: The total minutes of video content stored in the account.
                type: integer
              totalStorageMinutesLimit:
                description: The storage capacity alloted for the account.
                type: integer
              videoCount:
                description: The total count of videos associated with the account.
                type: integer
    stream_maxDurationSeconds:
      description: The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of `-1` means the value is unknown.
      maximum: 21600
      minimum: 1
      type: integer
    stream_api-response-single:
      allOf:
      - $ref: '#/components/schemas/stream_api-response-common'
      type: object
    stream_media_metadata:
      description: A user modifiable key-value store used to reference other systems of record for managing videos.
      example:
        name: video12345.mp4
      type: object
    stream_size:
      description: The size of the media item in bytes.
      example: 4190963.0
      type: number
    stream_accessRules:
      description: Defines rules for fine-grained control over content than signed URL tokens alone. Access rules primarily make tokens conditionally valid based on user information. Access Rules are specified on token payloads as the `accessRules` property containing an array of Rule objects.
      properties:
        action:
          description: The action to take when a request matches a rule. If the action is `block`, the signed token blocks views for viewers matching the rule.
          enum:
          - allow
          - block
          example: allow
          type: string
        country:
          description: An array of 2-letter country codes in ISO 3166-1 Alpha-2 format used to match requests.
          items:
            type: string
          type: array
        ip:
          description: An array of IPv4 or IPV6 addresses or CIDRs used to match requests.
          items:
            type: string
          type: array
        type:
          description: Lists available rule types to match for requests. An `any` type matches all requests and can be used as a wildcard to apply default actions after other rules.
          enum:
          - any
          - ip.src
          - ip.geoip.country
          example: ip.src
          type: string
      type: object
    stream_thumbnailTimestampPct:
      default: 0
      description: The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video.  If this value is not set, the default thumbnail image is taken from 0s of the video.
      example: 0.529241
      maximum: 1
      minimum: 0
      type: number
    stream_account_identifier:
      description: The account identifier tag.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    stream_duration:
      description: The duration of the video in seconds. A value of `-1` means the duration is unknown. The duration becomes available after the upload and before the video is ready.
      type: number
    stream_name:
      default: ''
      description: A short description of the watermark profile.
      example: Marketing Videos
      type: string
    stream_watermark_created:
      description: The date and a time a watermark profile was created.
      example: '2014-01-02T02:20:00Z'
      format: date-time
      type: string
    stream_opacity:
      default: 1
      description: The translucency of the image. A value of `0.0` makes the image completely transparent, and `1.0` makes the image completely opaque. Note that if the image is already semi-transparent, setting this to `1.0` will not make the image completely opaque.
      example: 0.75
      maximum: 1
      minimum: 0
      type: number
    stream_modified:
      description: The date and time the media item was last modified.
      example: '2014-01-02T02:20:00Z'
      format: date-time
      type: string
    stream_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/stream_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/stream_messages'
          example: []
        result:
          enum:
          - null
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    stream_uploaded:
      description: The date and time the media item was uploaded.
      example: '2014-01-02T02:20:00Z'
      format: date-time
      type: string
    stream_media_status:
      description: Specifies a detailed status for a video. If the `state` is `inprogress` or `error`, the `step` field returns `encoding` or `manifest`. If the `state` is `inprogress`, `pctComplete` returns a number between 0 and 100 to indicate the approximate percent of completion. If the `state` is `error`, `errorReasonCode` and `errorReasonText` provide additional details.
      properties:
        errorReasonCode:
          $ref: '#/components/schemas/stream_errorReasonCode'
        errorReasonText:
          $ref: '#/components/schemas/stream_errorReasonText'
        pctComplete:
          $ref: '#/components/schemas/stream_pctComplete'
        state:
          $ref: '#/components/schemas/stream_media_state'
    stream_watermarks:
      properties:
        created:
          $ref: '#/components/schemas/stream_watermark_created'
        downloadedFrom:
          $ref: '#/components/schemas/stream_downloadedFrom'
        height:
          $ref: '#/components/schemas/stream_height'
        name:
          $ref: '#/components/schemas/stream_name'
        opacity:
          $ref: '#/components/schemas/stream_opacity'
        padding:
          $ref: '#/components/schemas/stream_padding'
        position:
          $ref: '#/components/schemas/stream_position'
        scale:
          $ref: '#/components/schemas/stream_scale'
        size:
          $ref: '#/components/schemas/stream_watermark_size'
        uid:
          $ref: '#/components/schemas/stream_watermark_identifier'
        width:
          $ref: '#/components/schemas/stream_width'
      type: object
    stream_start:
      description: Lists videos created after the specified date.
      example: '2014-01-02T02:20:00Z'
      format: date-time
      type: string
    stream_signed_token_request:
      properties:
        accessRules:
          description: The optional list of access rule constraints on the token. Access can be blocked or allowed based on an IP, IP range, or by country. Access rules are evaluated from first to last. If a rule matches, the associated action is applied and no further rules are evaluated.
          example:
          - action: block
            country:
            - US
            - MX
            type: ip.geoip.country
          - action: allow
            ip:
            - 93.184.216.0/24
            - 2400:cb00::/32
            type: ip.src
          - action: block
            type: any
          items:
            $ref: '#/components/schemas/stream_accessRules'
          type: array
        downloadable:
          default: false
          description: The optional boolean value that enables using signed tokens to access MP4 download links for a video.
          type: boolean
        exp:
          description: The optional unix epoch timestamp that specficies the time after a token is not accepted. The maximum time specification is 24 hours from issuing time. If this field is not set, the default is one hour after issuing.
          type: integer
        id:
          description: The optional ID of a Stream signing key. If present, the `pem` field is also required.
          example: ab0d4ef71g4425f8dcba9041231813000
          type: string
        nbf:
          description: The optional unix epoch timestamp that specifies the time before a the token is not accepted. If this field is not set, the default is one hour before issuing.
          type: integer
        pem:
          description: The optional base64 encoded private key in PEM format associated with a Stream signing key. If present, the `id` field is also required.
          example: LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcEFJQkFBS0NBUUVBc284dnBvOFpEWXRkOUgzbWlPaW1qYXAzVXlVM0oyZ3kwTUYvN1R4blJuRnkwRHpDCkxqUk9naFZsQ0hPQmxsd3NVaE9GU0lyYnN4K05tUTdBeS90TFpXSGxuVGF3UWJ5WGZGOStJeDhVSnNlSHBGV1oKNVF5Z1JYd2liSjh1MVVsZ2xlcmZHMkpueldjVXpZTzEySktZN3doSkw1ajROMWgxZFJNUXQ5Q1pkZFlCQWRzOQpCdk02cjRFMDcxQkhQekhWeDMrUTI1VWtubGdUNXIwS3FiM1E1Y0dlTlBXY1JreW1ybkJEWWR0OXR4eFFMb1dPCllzNXdsMnVYWFVYL0VGcDMwajU0Nmp6czllWExLYlNDbjJjTDZFVE96Y2x3aG9DRGx2a2VQT05rUE9LMDVKNUMKTm1TdFdhMG9hV1VGRzM0MFl3cVVrWGt4OU9tNndXd1JldU1uU1FJREFRQUJBb0lCQUFJOHo1ck5kOEdtOGJBMgo1S3pxQjI1R2lOVENwbUNJeW53NXRJWHZTQmNHcEdydUcvdlN2WG9kVlFVSVY0TWdHQkVXUEFrVzdsNWVBcHI4CnA1ZFd5SkRXYTNkdklFSE9vSEpYU3dBYksxZzZEMTNVa2NkZ1EyRGpoNVhuWDhHZCtBY2c2SmRTQWgxOWtYSHEKMk54RUtBVDB6Ri83a1g2MkRkREFBcWxmQkpGSXJodVIvZUdEVWh4L2piTTRhQ2JCcFdiM0pnRE9OYm5tS1ZoMwpxS2ZwZmRZZENZU1lzWUxrNTlxRDF2VFNwUVFUQ0VadW9VKzNzRVNhdkJzaUs1bU0vTzY5ZkRMRXNURG1MeTVQCmhEK3BMQXI0SlhNNjFwRGVBS0l3cUVqWWJybXlDRHRXTUdJNnZzZ0E1eXQzUUJaME9vV2w5QUkwdWxoZ3p4dXQKZ2ZFNTRRRUNnWUVBN0F3a0lhVEEzYmQ4Nk9jSVZnNFlrWGk1cm5aNDdsM1k4V24zcjIzUmVISXhLdkllRUtSbgp5bUlFNDFtRVBBSmlGWFpLK1VPTXdkeS9EcnFJUithT1JiT2NiV01jWUg2QzgvbG1wdVJFaXE3SW1Ub3VWcnA4CnlnUkprMWprVDA4cTIvNmg4eTBEdjJqMitsaHFXNzRNOUt0cmwxcTRlWmZRUFREL01tR1NnTWtDZ1lFQXdhY04KaSttN1p6dnJtL3NuekF2VlZ5SEtwZHVUUjNERk1naC9maC9tZ0ZHZ1RwZWtUOVV5b3FleGNYQXdwMVlhL01iQQoyNTVJVDZRbXZZTm5yNXp6Wmxic2tMV0hsYllvbWhmWnVXTHhXR3hRaEFORWdaMFVVdUVTRGMvbWx2UXZHbEtSCkZoaGhBUWlVSmdDamhPaHk1SlBiNGFldGRKd0UxK09lVWRFaE1vRUNnWUVBNG8yZ25CM1o4ck5xa3NzemlBek4KYmNuMlJVbDJOaW9pejBwS3JMaDFaT29NNE5BekpQdjJsaHRQMzdtS0htS1hLMHczRjFqTEgwSTBxZmxFVmVZbQpSU1huakdHazJjUnpBYUVzOGgrQzNheDE0Z01pZUtGU3BqNUpNOEFNbVVZOXQ1cUVhN2FYc3o0V1ZoOUlMYmVTCkRiNzlhKzVwd21LQVBrcnBsTHhyZFdrQ2dZQlNNSHVBWVdBbmJYZ1BDS2FZWklGVWJNUWNacmY0ZnpWQ2lmYksKYWZHampvRlNPZXdEOGdGK3BWdWJRTGwxbkFieU44ek1xVDRaaHhybUhpcFlqMjJDaHV2NmN3RXJtbGRiSnpwQwpBMnRaVXdkTk1ESFlMUG5lUHlZeGRJWnlsUXFVeW14SGkydElUQUxNcWtLOGV3ZWdXZHpkeGhQSlJScU5JazhrCmZIVHhnUUtCZ1FEUFc2UXIxY3F3QjNUdnVWdWR4WGRqUTdIcDFodXhrNEVWaEFJZllKNFhSTW1NUE5YS28wdHUKdUt6LzE0QW14R0dvSWJxYVc1bDMzeFNteUxhem84clNUN0tSTjVKME9JSHcrZkR5SFgxdHpVSjZCTldDcEFTcwpjbWdNK0htSzVON0w2bkNaZFJQY2IwU1hGaVRQUGhCUG1PVWFDUnpER0ZMK2JYM1VwajJKbWc9PQotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=
          type: string
      type: object
    stream_video_update:
      properties:
        allowedOrigins:
          $ref: '#/components/schemas/stream_allowedOrigins'
        creator:
          $ref: '#/components/schemas/stream_creator'
        maxDurationSeconds:
          $ref: '#/components/schemas/stream_maxDurationSeconds'
        meta:
          $ref: '#/components/schemas/stream_media_metadata'
        requireSignedURLs:
          $ref: '#/components/schemas/stream_requireSignedURLs'
        scheduledDeletion:
          $ref: '#/components/schemas/stream_scheduledDeletion'
        thumbnailTimestampPct:
          $ref: '#/components/schemas/stream_thumbnailTimestampPct'
        uploadExpiry:
          $ref: '#/components/schemas/stream_oneTimeUploadExpiry'
      type: object
    stream_created:
      description: The date and time the media item was created.
      example: '2014-01-02T02:20:00Z'
      format: date-time
      type: string
    stream_watermark_at_upload:
      properties:
        uid:
          description: The unique identifier for the watermark profile.
          example: ea95132c15732412d22c1476fa83f27a
          maxLength: 32
          type: string
      type: object
    stream_oneTimeUploadExpiry:
      description: The date and time when the video upload URL is no longer valid for direct user uploads.
      example: '2014-01-02T02:20:00Z'
      format: date-time
      type: string
    stream_downloadedFrom:
      description: The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.
      example: https://company.com/logo.png
      type: string
    stream_requireSignedURLs:
      default: false
      description: Indicates whether the video can be a accessed using the UID. When set to `true`, a signed token must be generated with a signing key to view the video.
      example: true
      type: boolean
    stream_include_counts:
      default: false
      description: Includes the total number of videos associated with the submitted query parameters.
      example: true
      type: boolean
    stream_readyToStream:
      description: Indicates whether the video is playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
      example: true
      type: boolean
    stream_direct_upload_request:
      properties:
        allowedOrigins:
          $ref: '#/components/schemas/stream_allowedOrigins'
        creator:
          $ref: '#/components/schemas/stream_creator'
        expiry:
          default: Now + 30 minutes
          description: The date and time after upload when videos will not be accepted.
          example: '2021-01-02T02:20:00Z'
          format: date-time
          type: string
        maxDurationSeconds:
          $ref: '#/components/schemas/stream_maxDurationSeconds'
        meta:
          $ref: '#/components/schemas/stream_media_metadata'
        requireSignedURLs:
          $ref: '#/components/schemas/stream_requireSignedURLs'
        scheduledDeletion:
          $ref: '#/components/schemas/stream_scheduledDeletion'
        thumbnailTimestampPct:
          $ref: '#/components/schemas/stream_thumbnailTimestampPct'
        watermark:
          $ref: '#/components/schemas/stream_watermark_at_upload'
      required:
      - maxDurationSeconds
      type: object
    stream_scale:
      default: 0.15
      description: The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. `0.0` indicates no scaling (use the size of the image as-is), and `1.0 `fills the entire video.
      example: 0.1
      maximum: 1
      minimum: 0
      type: number
    stream_upload_metadata:
      description: 'Comma-separated key-value pairs following the TUS protocol specification. Values are Base-64 encoded.

        Supported keys: `name`, `requiresignedurls`, `allowedorigins`, `thumbnailtimestamppct`, `watermark`, `scheduleddeletion`.'
      example: name aGVsbG8gd29ybGQ=, requiresignedurls, allowedorigins ZXhhbXBsZS5jb20sdGVzdC5jb20=
      type: string
    stream_input:
      properties:
        height:
          description: The video height in pixels. A value of `-1` means the height is unknown. The value becomes available after the upload and before the video is ready.
          type: integer
        width:
          description: The video width in pixels. A value of `-1` means the width is unknown. The value becomes available after the upload and before the video is ready.
          type: integer
      type: object
    stream_watermark_identifier:
      description: The unique identifier for a watermark profile.
      example: ea95132c15732412d22c1476fa83f27a
      maxLength: 32
      type: string
    stream_media_state:
      description: Specifies the processing status for all quality levels for a video.
      enum:
      - pendingupload
      - downloading
      - queued
      - inprogress
      - ready
      - error
      example: inprogress
      type: string
    stream_video_response_single:
      allOf:
      - $ref: '#/components/schemas/stream_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/stream_videos'
    stream_liveInput:
      description: The live input ID used to upload a video with Stream Live.
      example: fc0a8dc887b16759bfd9ad922230a014
      maxLength: 32
      type: string
    stream_end:
      description: Lists videos created before the specified date.
      example: '2014-01-02T02:20:00Z'
      format: date-time
      type: string
    stream_direct_upload_response:
      allOf:
      - $ref: '#/components/schemas/stream_api-response-single'
      - properties:
          result:
            properties:
              scheduledDeletion:
                $ref: '#/components/schemas/stream_scheduledDeletion'
              uid:
                $ref: '#/components/schemas/stream_identifier'
              uploadURL:
                description: The URL an unauthenticated upload can use for a single `HTTP POST multipart/form-data` request.
                example: www.example.com/samplepath
                type: string
              watermark:
                $ref: '#/components/schemas/stream_watermarks'
    stream_height:
      description: The height of the image in pixels.
      type: integer
    stream_videos:
      properties:
        allowedOrigins:
          $ref: '#/components/schemas/stream_allowedOrigins'
        created:
          $ref: '#/components/schemas/stream_created'
        creator:
          $ref: '#/components/schemas/stream_creator'
        duration:
          $ref: '#/components/schemas/stream_duration'
        input:
          $ref: '#/components/schemas/stream_input'
        liveInput:
          $ref: '#/components/schemas/stream_liveInput'
        maxDurationSeconds:
          $ref: '#/components/schemas/stream_maxDurationSeconds'
        meta:
          $ref: '#/components/schemas/stream_media_metadata'
        modified:
          $ref: '#/components/schemas/stream_modified'
        playback:
          $ref: '#/components/schemas/stream_playback'
        preview:
          $ref: '#/components/schemas/stream_preview'
        readyToStream:
          $ref: '#/components/schemas/stream_readyToStream'
        readyToStreamAt:
          $ref: '#/components/schemas/stream_readyToStreamAt'
        requireSignedURLs:
          $ref: '#/components/schemas/stream_requireSignedURLs'
        scheduledDeletion:
          $ref: '#/components/schemas/stream_scheduledDeletion'
        size:
          $ref: '#/components/schemas/stream_size'
        status:
          $ref: '#/components/schemas/stream_media_status'
        thumbnail:
          $ref: '#/components/schemas/stream_thumbnail_url'
        thumbnailTimestampPct:
          $ref: '#/components/schemas/stream_thumbnailTimestampPct'
        uid:
          $ref: '#/components/schemas/stream_identifier'
        uploadExpiry:
          $ref: '#/components/schemas/stream_oneTimeUploadExpiry'
        uploaded:
          $ref: '#/components/schemas/stream_uploaded'
        watermark:
          $ref: '#/components/schemas/stream_watermarks'
      type: object
    stream_thumbnail_url:
      description: The media item's thumbnail URI. This field is omitted until encoding is complete.
      example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg
      format: uri
      type: string
  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/apigateway/
x-hasEquivalentPaths: true