APIs.io Engineering Platform 2020 04 22 API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 2020 04 22 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: 2020 04 22
paths:
  /2020-04-22/code-signing-configs/:
    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'
    post:
      operationId: CreateCodeSigningConfig
      description: 'Creates a code signing configuration. A <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html">code signing configuration</a> defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail). '
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCodeSigningConfigResponse'
        '480':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '481':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - AllowedPublishers
              properties:
                Description:
                  description: Descriptive name for this code signing configuration.
                  type: string
                  minLength: 0
                  maxLength: 256
                AllowedPublishers:
                  description: 'List of signing profiles that can sign a code package. '
                  type: object
                  properties:
                    SigningProfileVersionArns:
                      allOf:
                      - $ref: '#/components/schemas/SigningProfileVersionArns'
                      - description: 'The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package. '
                CodeSigningPolicies:
                  description: Code signing configuration <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html#config-codesigning-policies">policies</a> specify the validation failure action for signature mismatch or expiry.
                  type: object
                  properties:
                    UntrustedArtifactOnDeployment:
                      allOf:
                      - $ref: '#/components/schemas/CodeSigningPolicy'
                      - description: '<p>Code signing configuration policy for deployment validation failure. If you set the policy to <code>Enforce</code>, Lambda blocks the deployment request if signature validation checks fail. If you set the policy to <code>Warn</code>, Lambda allows the deployment and creates a CloudWatch log. </p> <p>Default value: <code>Warn</code> </p>'
      tags:
      - 2020 04 22
    get:
      operationId: ListCodeSigningConfigs
      description: 'Returns a list of <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuring-codesigning.html">code signing configurations</a>. A request returns up to 10,000 configurations per call. You can use the <code>MaxItems</code> parameter to return fewer configurations per call. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCodeSigningConfigsResponse'
        '480':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '481':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
      parameters:
      - 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: Maximum number of items to return.
        schema:
          type: integer
          minimum: 1
          maximum: 10000
      tags:
      - 2020 04 22
  /2020-04-22/code-signing-configs/{CodeSigningConfigArn}:
    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: DeleteCodeSigningConfig
      description: 'Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it. '
      responses:
        '204':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCodeSigningConfigResponse'
        '480':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '481':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceConflictException'
      parameters:
      - name: CodeSigningConfigArn
        in: path
        required: true
        description: The The Amazon Resource Name (ARN) of the code signing configuration.
        schema:
          type: string
          pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17}
          maxLength: 200
      tags:
      - 2020 04 22
    get:
      operationId: GetCodeSigningConfig
      description: Returns information about the specified code signing configuration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCodeSigningConfigResponse'
        '480':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '481':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: CodeSigningConfigArn
        in: path
        required: true
        description: 'The The Amazon Resource Name (ARN) of the code signing configuration. '
        schema:
          type: string
          pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17}
          maxLength: 200
      tags:
      - 2020 04 22
    put:
      operationId: UpdateCodeSigningConfig
      description: 'Update the code signing configuration. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCodeSigningConfigResponse'
        '480':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '481':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: CodeSigningConfigArn
        in: path
        required: true
        description: The The Amazon Resource Name (ARN) of the code signing configuration.
        schema:
          type: string
          pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17}
          maxLength: 200
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                Description:
                  description: Descriptive name for this code signing configuration.
                  type: string
                  minLength: 0
                  maxLength: 256
                AllowedPublishers:
                  description: 'List of signing profiles that can sign a code package. '
                  type: object
                  properties:
                    SigningProfileVersionArns:
                      allOf:
                      - $ref: '#/components/schemas/SigningProfileVersionArns'
                      - description: 'The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package. '
                CodeSigningPolicies:
                  description: Code signing configuration <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html#config-codesigning-policies">policies</a> specify the validation failure action for signature mismatch or expiry.
                  type: object
                  properties:
                    UntrustedArtifactOnDeployment:
                      allOf:
                      - $ref: '#/components/schemas/CodeSigningPolicy'
                      - description: '<p>Code signing configuration policy for deployment validation failure. If you set the policy to <code>Enforce</code>, Lambda blocks the deployment request if signature validation checks fail. If you set the policy to <code>Warn</code>, Lambda allows the deployment and creates a CloudWatch log. </p> <p>Default value: <code>Warn</code> </p>'
      tags:
      - 2020 04 22
  /2020-04-22/code-signing-configs/{CodeSigningConfigArn}/functions:
    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: ListFunctionsByCodeSigningConfig
      description: List the functions that use the specified code signing configuration. You can use this method prior to deleting a code signing configuration, to verify that no functions are using it.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFunctionsByCodeSigningConfigResponse'
        '480':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '481':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: CodeSigningConfigArn
        in: path
        required: true
        description: The The Amazon Resource Name (ARN) of the code signing configuration.
        schema:
          type: string
          pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17}
          maxLength: 200
      - 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: Maximum number of items to return.
        schema:
          type: integer
          minimum: 1
          maximum: 10000
      tags:
      - 2020 04 22
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:
    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-_]+))?
    ListFunctionsByCodeSigningConfigResponse:
      type: object
      properties:
        NextMarker:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The pagination token that's included if more results are available.
        FunctionArns:
          allOf:
          - $ref: '#/components/schemas/FunctionArnList'
          - description: 'The function ARNs. '
    CodeSigningConfig:
      type: object
      required:
      - CodeSigningConfigId
      - CodeSigningConfigArn
      - AllowedPublishers
      - CodeSigningPolicies
      - LastModified
      properties:
        CodeSigningConfigId:
          allOf:
          - $ref: '#/components/schemas/CodeSigningConfigId'
          - description: Unique identifer for the Code signing configuration.
        CodeSigningConfigArn:
          allOf:
          - $ref: '#/components/schemas/CodeSigningConfigArn'
          - description: The Amazon Resource Name (ARN) of the Code signing configuration.
        Description:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: Code signing configuration description.
        AllowedPublishers:
          allOf:
          - $ref: '#/components/schemas/AllowedPublishers'
          - description: List of allowed publishers.
        CodeSigningPolicies:
          allOf:
          - $ref: '#/components/schemas/CodeSigningPolicies'
          - description: The code signing policy controls the validation failure action for signature mismatch or expiry.
        LastModified:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: 'The date and time that the Code signing configuration was last modified, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). '
      description: 'Details about a <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html">Code signing configuration</a>. '
    Arn:
      type: string
      pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)
    GetCodeSigningConfigResponse:
      type: object
      required:
      - CodeSigningConfig
      properties:
        CodeSigningConfig:
          allOf:
          - $ref: '#/components/schemas/CodeSigningConfig'
          - description: The code signing configuration
    Timestamp:
      type: string
    CodeSigningConfigArn:
      type: string
      pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17}
      maxLength: 200
    CreateCodeSigningConfigResponse:
      type: object
      required:
      - CodeSigningConfig
      properties:
        CodeSigningConfig:
          allOf:
          - $ref: '#/components/schemas/CodeSigningConfig'
          - description: The code signing configuration.
    CodeSigningPolicy:
      type: string
      enum:
      - Warn
      - Enforce
    ResourceConflictException: {}
    UpdateCodeSigningConfigResponse:
      type: object
      required:
      - CodeSigningConfig
      properties:
        CodeSigningConfig:
          allOf:
          - $ref: '#/components/schemas/CodeSigningConfig'
          - description: The code signing configuration
    InvalidParameterValueException: {}
    SigningProfileVersionArns:
      type: array
      items:
        $ref: '#/components/schemas/Arn'
      minItems: 1
      maxItems: 20
    String:
      type: string
    DeleteCodeSigningConfigResponse:
      type: object
      properties: {}
    CodeSigningConfigId:
      type: string
      pattern: csc-[a-zA-Z0-9-_\.]{17}
    FunctionArnList:
      type: array
      items:
        $ref: '#/components/schemas/FunctionArn'
    Description:
      type: string
      minLength: 0
      maxLength: 256
    ServiceException: {}
    ResourceNotFoundException: {}
    ListCodeSigningConfigsResponse:
      type: object
      properties:
        NextMarker:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The pagination token that's included if more results are available.
        CodeSigningConfigs:
          allOf:
          - $ref: '#/components/schemas/CodeSigningConfigList'
          - description: The code signing configurations
    CodeSigningPolicies:
      type: object
      properties:
        UntrustedArtifactOnDeployment:
          allOf:
          - $ref: '#/components/schemas/CodeSigningPolicy'
          - description: '<p>Code signing configuration policy for deployment validation failure. If you set the policy to <code>Enforce</code>, Lambda blocks the deployment request if signature validation checks fail. If you set the policy to <code>Warn</code>, Lambda allows the deployment and creates a CloudWatch log. </p> <p>Default value: <code>Warn</code> </p>'
      description: Code signing configuration <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html#config-codesigning-policies">policies</a> specify the validation failure action for signature mismatch or expiry.
    CodeSigningConfigList:
      type: array
      items:
        $ref: '#/components/schemas/CodeSigningConfig'
    AllowedPublishers:
      type: object
      required:
      - SigningProfileVersionArns
      properties:
        SigningProfileVersionArns:
          allOf:
          - $ref: '#/components/schemas/SigningProfileVersionArns'
          - description: 'The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package. '
      description: 'List of signing profiles that can sign a code package. '
  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