APIs.io Engineering Platform Access Tags API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Access Tags 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: Access Tags
paths:
  /accounts/{account_id}/access/tags:
    get:
      description: List tags
      operationId: access-tags-list-tags
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List tags response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_tags_components-schemas-response_collection'
          description: List tags response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List tags
      tags:
      - Access Tags
      x-api-token-group:
      - 'Access: Apps and Policies Revoke'
      - 'Access: Apps and Policies Write'
      - 'Access: Apps and Policies Read'
    post:
      description: Create a tag
      operationId: access-tags-create-tag
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_tags_components-schemas-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Create a tag response failure
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_tags_components-schemas-single_response'
          description: Create a tag response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a tag
      tags:
      - Access Tags
      x-api-token-group:
      - 'Access: Apps and Policies Write'
  /accounts/{account_id}/access/tags/{tag_name}:
    delete:
      description: Delete a tag
      operationId: access-tags-delete-a-tag
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      - in: path
        name: tag_name
        required: true
        schema:
          $ref: '#/components/schemas/access_tags_components-schemas-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Delete a tag response failure
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_name_response'
          description: Delete a tag response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete a tag
      tags:
      - Access Tags
      x-api-token-group:
      - 'Access: Apps and Policies Write'
    get:
      description: Get a tag
      operationId: access-tags-get-a-tag
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      - in: path
        name: tag_name
        required: true
        schema:
          $ref: '#/components/schemas/access_tags_components-schemas-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get a tag response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_tags_components-schemas-single_response'
          description: Get a tag response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get a tag
      tags:
      - Access Tags
      x-api-token-group:
      - 'Access: Apps and Policies Write'
      - 'Access: Apps and Policies Read'
    put:
      description: Update a tag
      operationId: access-tags-update-a-tag
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      - in: path
        name: tag_name
        required: true
        schema:
          $ref: '#/components/schemas/access_tags_components-schemas-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_tag_without_app_count'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update a tag response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_tags_components-schemas-single_response'
          description: Update a tag response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update a tag
      tags:
      - Access Tags
      x-api-token-group:
      - 'Access: Apps and Policies Write'
components:
  schemas:
    access_tag_without_app_count:
      description: A tag
      properties:
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        name:
          $ref: '#/components/schemas/access_tags_components-schemas-name'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      required:
      - name
      type: object
    access_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/access_messages'
        messages:
          $ref: '#/components/schemas/access_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    access_tags_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/access_tag'
        type: object
    access_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    access_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/access_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/access_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
    access_name_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            properties:
              name:
                $ref: '#/components/schemas/access_tags_components-schemas-name'
            type: object
        type: object
    access_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    access_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/access_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/access_result_info'
      type: object
    access_tags_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/access_tag'
            type: array
        type: object
    access_tag:
      description: A tag
      properties:
        app_count:
          description: The number of applications that have this tag
          example: 1
          type: integer
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        name:
          $ref: '#/components/schemas/access_tags_components-schemas-name'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      required:
      - name
      type: object
    access_timestamp:
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type: string
    access_api-response-single:
      allOf:
      - $ref: '#/components/schemas/access_api-response-common'
      type: object
    access_tags_components-schemas-name:
      description: The name of the tag
      example: engineers
      type: string
    access_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      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