APIs.io Engineering Platform Stream Watermark Profile API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Stream Watermark Profile 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
    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 Watermark Profile
paths:
  /accounts/{account_id}/stream/watermarks:
    get:
      description: Lists all watermark profiles for an account.
      operationId: stream-watermark-profile-list-watermark-profiles
      parameters:
      - 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: List watermark profiles response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_watermark_response_collection'
          description: List watermark profiles response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List watermark profiles
      tags:
      - Stream Watermark Profile
      x-api-token-group:
      - Stream Write
      - Stream Read
    post:
      description: Creates watermark profiles using a single `HTTP POST multipart/form-data` request.
      operationId: stream-watermark-profile-create-watermark-profiles-via-basic-upload
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_account_identifier'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/stream_watermark_basic_upload'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Create watermark profiles via basic upload response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_watermark_response_single'
          description: Create watermark profiles via basic upload response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Create watermark profiles via basic upload
      tags:
      - Stream Watermark Profile
      x-api-token-group:
      - Stream Write
  /accounts/{account_id}/stream/watermarks/{identifier}:
    delete:
      description: Deletes a watermark profile.
      operationId: stream-watermark-profile-delete-watermark-profiles
      parameters:
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_watermark_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:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Delete watermark profiles response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stream_api-response-single'
                - properties:
                    result:
                      example: ''
                      type: string
          description: Delete watermark profiles response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Delete watermark profiles
      tags:
      - Stream Watermark Profile
      x-api-token-group:
      - Stream Write
    get:
      description: Retrieves details for a single watermark profile.
      operationId: stream-watermark-profile-watermark-profile-details
      parameters:
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_watermark_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: Watermark profile details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_watermark_response_single'
          description: Watermark profile details response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Watermark profile details
      tags:
      - Stream Watermark Profile
      x-api-token-group:
      - Stream Write
      - Stream Read
components:
  schemas:
    stream_watermark_response_collection:
      allOf:
      - $ref: '#/components/schemas/stream_api-response-common'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/stream_watermarks'
            type: array
    stream_watermark_size:
      description: The size of the image in bytes.
      example: 29472
      type: number
    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_watermark_basic_upload:
      properties:
        file:
          description: The image file to upload.
          example: '@/Users/rchen/Downloads/watermark.png'
          type: string
        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'
      required:
      - file
      type: object
    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_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_watermark_response_single:
      allOf:
      - $ref: '#/components/schemas/stream_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/stream_watermarks'
    stream_width:
      description: The width of the image in pixels.
      type: integer
    stream_api-response-single:
      allOf:
      - $ref: '#/components/schemas/stream_api-response-common'
      type: object
    stream_account_identifier:
      description: The account identifier tag.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    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_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_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_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_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_watermark_identifier:
      description: The unique identifier for a watermark profile.
      example: ea95132c15732412d22c1476fa83f27a
      maxLength: 32
      type: string
    stream_height:
      description: The height of the image in pixels.
      type: integer
  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