APIs.io Engineering Platform 2019 09 30 API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 2019 09 30 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: 2019 09 30
paths:
  /2019-09-30/functions/{FunctionName}/provisioned-concurrency#Qualifier:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    delete:
      operationId: DeleteProvisionedConcurrencyConfig
      description: Deletes the provisioned concurrency configuration for a function.
      responses:
        '204':
          description: Success
        '480':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '481':
          description: ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceConflictException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '484':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
      parameters:
      - name: FunctionName
        in: path
        required: true
        description: <p>The name of the Lambda function.</p> <p class="title"> <b>Name formats</b> </p> <ul> <li> <p> <b>Function name</b> – <code>my-function</code>.</p> </li> <li> <p> <b>Function ARN</b> – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p> </li> <li> <p> <b>Partial ARN</b> – <code>123456789012:function:my-function</code>.</p> </li> </ul> <p>The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.</p>
        schema:
          type: string
          pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
          minLength: 1
          maxLength: 140
      - name: Qualifier
        in: query
        required: true
        description: The version number or alias name.
        schema:
          type: string
          pattern: (|[a-zA-Z0-9$_-]+)
          minLength: 1
          maxLength: 128
      tags:
      - 2019 09 30
    get:
      operationId: GetProvisionedConcurrencyConfig
      description: Retrieves the provisioned concurrency configuration for a function's alias or version.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProvisionedConcurrencyConfigResponse'
        '480':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '483':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '484':
          description: ProvisionedConcurrencyConfigNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisionedConcurrencyConfigNotFoundException'
      parameters:
      - name: FunctionName
        in: path
        required: true
        description: <p>The name of the Lambda function.</p> <p class="title"> <b>Name formats</b> </p> <ul> <li> <p> <b>Function name</b> – <code>my-function</code>.</p> </li> <li> <p> <b>Function ARN</b> – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p> </li> <li> <p> <b>Partial ARN</b> – <code>123456789012:function:my-function</code>.</p> </li> </ul> <p>The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.</p>
        schema:
          type: string
          pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
          minLength: 1
          maxLength: 140
      - name: Qualifier
        in: query
        required: true
        description: The version number or alias name.
        schema:
          type: string
          pattern: (|[a-zA-Z0-9$_-]+)
          minLength: 1
          maxLength: 128
      tags:
      - 2019 09 30
    put:
      operationId: PutProvisionedConcurrencyConfig
      description: Adds a provisioned concurrency configuration to a function's alias or version.
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutProvisionedConcurrencyConfigResponse'
        '480':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceConflictException'
        '483':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '484':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
      parameters:
      - name: FunctionName
        in: path
        required: true
        description: <p>The name of the Lambda function.</p> <p class="title"> <b>Name formats</b> </p> <ul> <li> <p> <b>Function name</b> – <code>my-function</code>.</p> </li> <li> <p> <b>Function ARN</b> – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p> </li> <li> <p> <b>Partial ARN</b> – <code>123456789012:function:my-function</code>.</p> </li> </ul> <p>The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.</p>
        schema:
          type: string
          pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
          minLength: 1
          maxLength: 140
      - name: Qualifier
        in: query
        required: true
        description: The version number or alias name.
        schema:
          type: string
          pattern: (|[a-zA-Z0-9$_-]+)
          minLength: 1
          maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - ProvisionedConcurrentExecutions
              properties:
                ProvisionedConcurrentExecutions:
                  description: The amount of provisioned concurrency to allocate for the version or alias.
                  type: integer
                  minimum: 1
      tags:
      - 2019 09 30
  /2019-09-30/functions/{FunctionName}/concurrency:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    get:
      operationId: GetFunctionConcurrency
      description: Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use <a>PutFunctionConcurrency</a>.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFunctionConcurrencyResponse'
        '480':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '483':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
      parameters:
      - name: FunctionName
        in: path
        required: true
        description: <p>The name of the Lambda function.</p> <p class="title"> <b>Name formats</b> </p> <ul> <li> <p> <b>Function name</b> – <code>my-function</code>.</p> </li> <li> <p> <b>Function ARN</b> – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p> </li> <li> <p> <b>Partial ARN</b> – <code>123456789012:function:my-function</code>.</p> </li> </ul> <p>The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.</p>
        schema:
          type: string
          pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
          minLength: 1
          maxLength: 140
      tags:
      - 2019 09 30
  /2019-09-30/functions/{FunctionName}/provisioned-concurrency#List=ALL:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    get:
      operationId: ListProvisionedConcurrencyConfigs
      description: Retrieves a list of provisioned concurrency configurations for a function.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProvisionedConcurrencyConfigsResponse'
        '480':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '483':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
      parameters:
      - name: FunctionName
        in: path
        required: true
        description: <p>The name of the Lambda function.</p> <p class="title"> <b>Name formats</b> </p> <ul> <li> <p> <b>Function name</b> – <code>my-function</code>.</p> </li> <li> <p> <b>Function ARN</b> – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p> </li> <li> <p> <b>Partial ARN</b> – <code>123456789012:function:my-function</code>.</p> </li> </ul> <p>The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.</p>
        schema:
          type: string
          pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
          minLength: 1
          maxLength: 140
      - name: Marker
        in: query
        required: false
        description: Specify the pagination token that's returned by a previous request to retrieve the next page of results.
        schema:
          type: string
      - name: MaxItems
        in: query
        required: false
        description: Specify a number to limit the number of configurations returned.
        schema:
          type: integer
          minimum: 1
          maximum: 50
      - name: List
        in: query
        required: true
        schema:
          type: string
          enum:
          - ALL
      tags:
      - 2019 09 30
components:
  parameters:
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
  schemas:
    TooManyRequestsException: {}
    ReservedConcurrentExecutions:
      type: integer
      minimum: 0
    ProvisionedConcurrencyStatusEnum:
      type: string
      enum:
      - IN_PROGRESS
      - READY
      - FAILED
    PositiveInteger:
      type: integer
      minimum: 1
    FunctionArn:
      type: string
      pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
    ProvisionedConcurrencyConfigNotFoundException: {}
    NonNegativeInteger:
      type: integer
      minimum: 0
    Timestamp:
      type: string
    ListProvisionedConcurrencyConfigsResponse:
      type: object
      properties:
        ProvisionedConcurrencyConfigs:
          allOf:
          - $ref: '#/components/schemas/ProvisionedConcurrencyConfigList'
          - description: A list of provisioned concurrency configurations.
        NextMarker:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The pagination token that's included if more results are available.
    GetProvisionedConcurrencyConfigResponse:
      type: object
      properties:
        RequestedProvisionedConcurrentExecutions:
          allOf:
          - $ref: '#/components/schemas/PositiveInteger'
          - description: The amount of provisioned concurrency requested.
        AvailableProvisionedConcurrentExecutions:
          allOf:
          - $ref: '#/components/schemas/NonNegativeInteger'
          - description: The amount of provisioned concurrency available.
        AllocatedProvisionedConcurrentExecutions:
          allOf:
          - $ref: '#/components/schemas/NonNegativeInteger'
          - description: The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.
        Status:
          allOf:
          - $ref: '#/components/schemas/ProvisionedConcurrencyStatusEnum'
          - description: The status of the allocation process.
        StatusReason:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: For failed allocations, the reason that provisioned concurrency could not be allocated.
        LastModified:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time that a user last updated the configuration, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601 format</a>.
    ResourceConflictException: {}
    InvalidParameterValueException: {}
    GetFunctionConcurrencyResponse:
      type: object
      properties:
        ReservedConcurrentExecutions:
          allOf:
          - $ref: '#/components/schemas/ReservedConcurrentExecutions'
          - description: The number of simultaneous executions that are reserved for the function.
    String:
      type: string
    ServiceException: {}
    ProvisionedConcurrencyConfigListItem:
      type: object
      properties:
        FunctionArn:
          allOf:
          - $ref: '#/components/schemas/FunctionArn'
          - description: The Amazon Resource Name (ARN) of the alias or version.
        RequestedProvisionedConcurrentExecutions:
          allOf:
          - $ref: '#/components/schemas/PositiveInteger'
          - description: The amount of provisioned concurrency requested.
        AvailableProvisionedConcurrentExecutions:
          allOf:
          - $ref: '#/components/schemas/NonNegativeInteger'
          - description: The amount of provisioned concurrency available.
        AllocatedProvisionedConcurrentExecutions:
          allOf:
          - $ref: '#/components/schemas/NonNegativeInteger'
          - description: The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.
        Status:
          allOf:
          - $ref: '#/components/schemas/ProvisionedConcurrencyStatusEnum'
          - description: The status of the allocation process.
        StatusReason:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: For failed allocations, the reason that provisioned concurrency could not be allocated.
        LastModified:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time that a user last updated the configuration, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601 format</a>.
      description: Details about the provisioned concurrency configuration for a function alias or version.
    ResourceNotFoundException: {}
    ProvisionedConcurrencyConfigList:
      type: array
      items:
        $ref: '#/components/schemas/ProvisionedConcurrencyConfigListItem'
    PutProvisionedConcurrencyConfigResponse:
      type: object
      properties:
        RequestedProvisionedConcurrentExecutions:
          allOf:
          - $ref: '#/components/schemas/PositiveInteger'
          - description: The amount of provisioned concurrency requested.
        AvailableProvisionedConcurrentExecutions:
          allOf:
          - $ref: '#/components/schemas/NonNegativeInteger'
          - description: The amount of provisioned concurrency available.
        AllocatedProvisionedConcurrentExecutions:
          allOf:
          - $ref: '#/components/schemas/NonNegativeInteger'
          - description: The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.
        Status:
          allOf:
          - $ref: '#/components/schemas/ProvisionedConcurrencyStatusEnum'
          - description: The status of the allocation process.
        StatusReason:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: For failed allocations, the reason that provisioned concurrency could not be allocated.
        LastModified:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time that a user last updated the configuration, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601 format</a>.
  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