APIs.io Engineering Platform 2020 04 22 API

openapi: 3.2.0
info:
  version: 2015-03-31
  x-release: v4
  title: APIs.io Engineering Platform AWS Lambda 2020 04 22 API
  description: '<fullname>Lambda</fullname> <p> <b>Overview</b> </p> <p>Lambda is a compute service that lets you run code without provisioning or managing servers. Lambda runs your code on a high-availability compute infrastructure and performs all of the administration of the compute resources, including server and operating system maintenance, capacity provisioning and automatic scaling, code monitoring and logging. With Lambda, you can run code for virtually any type of application or backend service. For more information about the Lambda service, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/welcome.html">What is Lambda</a> in the <b>Lambda Developer Guide</b>.</p> <p>The <i>Lambda API Reference</i> provides information about each of the API methods, including details about the parameters in each API request and response. </p> <p/> <p>You can use Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools to access the API. For installation instructions, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>. </p> <p>For a list of Region-specific endpoints that Lambda supports, see <a href="https://docs.aws.amazon.com/general/latest/gr/lambda-service.html/">Lambda endpoints and quotas </a> in the <i>Amazon Web Services General Reference.</i>. </p> <p>When making the API calls, you will need to authenticate your request by providing a signature. Lambda supports signature version 4. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 signing process</a> in the <i>Amazon Web Services General Reference.</i>. </p> <p> <b>CA certificates</b> </p> <p>Because Amazon Web Services SDKs use the CA certificates from your computer, changes to the certificates on the Amazon Web Services servers can cause connection failures when you attempt to use an SDK. You can prevent these failures by keeping your computer''s CA certificates and operating system up-to-date. If you encounter this issue in a corporate environment and do not manage your own computer, you might need to ask an administrator to assist with the update process. The following list shows minimum operating system and Java versions:</p> <ul> <li> <p>Microsoft Windows versions that have updates from January 2005 or later installed contain at least one of the required CAs in their trust list. </p> </li> <li> <p>Mac OS X 10.4 with Java for Mac OS X 10.4 Release 5 (February 2007), Mac OS X 10.5 (October 2007), and later versions contain at least one of the required CAs in their trust list. </p> </li> <li> <p>Red Hat Enterprise Linux 5 (March 2007), 6, and 7 and CentOS 5, 6, and 7 all contain at least one of the required CAs in their default trusted CA list. </p> </li> <li> <p>Java 1.4.2_12 (May 2006), 5 Update 2 (March 2005), and all later versions, including Java 6 (December 2006), 7, and 8, contain at least one of the required CAs in their default trusted CA list. </p> </li> </ul> <p>When accessing the Lambda management console or Lambda API endpoints, whether through browsers or programmatically, you will need to ensure your client machines support any of the following CAs: </p> <ul> <li> <p>Amazon Root CA 1</p> </li> <li> <p>Starfield Services Root Certificate Authority - G2</p> </li> <li> <p>Starfield Class 2 Certification Authority</p> </li> </ul> <p>Root certificates from the first two authorities are available from <a href="https://www.amazontrust.com/repository/">Amazon trust services</a>, but keeping your computer up-to-date is the more straightforward solution. To learn more about ACM-provided certificates, see <a href="http://aws.amazon.com/certificate-manager/faqs/#certificates">Amazon Web Services Certificate Manager FAQs.</a> </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: lambda
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/lambda-2015-03-31.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://lambda.{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 AWS Lambda multi-region endpoint
- url: https://lambda.{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 AWS Lambda multi-region endpoint
- url: http://lambda.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Lambda endpoint for China (Beijing) and China (Ningxia)
- url: https://lambda.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Lambda 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:
  schemas:
    CodeSigningConfigList:
      type: array
      items:
        $ref: '#/components/schemas/CodeSigningConfig'
    SigningProfileVersionArns:
      type: array
      items:
        $ref: '#/components/schemas/Arn'
      minItems: 1
      maxItems: 20
    GetCodeSigningConfigResponse:
      type: object
      required:
      - CodeSigningConfig
      properties:
        CodeSigningConfig:
          allOf:
          - $ref: '#/components/schemas/CodeSigningConfig'
          - description: The code signing configuration
    ResourceConflictException: {}
    ResourceNotFoundException: {}
    InvalidParameterValueException: {}
    CodeSigningPolicy:
      type: string
      enum:
      - Warn
      - Enforce
    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
    Arn:
      type: string
      pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)
    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-_]+))?
    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.
    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>. '
    Timestamp:
      type: string
    ServiceException: {}
    Description:
      type: string
      minLength: 0
      maxLength: 256
    DeleteCodeSigningConfigResponse:
      type: object
      properties: {}
    String:
      type: string
    FunctionArnList:
      type: array
      items:
        $ref: '#/components/schemas/FunctionArn'
    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. '
    UpdateCodeSigningConfigResponse:
      type: object
      required:
      - CodeSigningConfig
      properties:
        CodeSigningConfig:
          allOf:
          - $ref: '#/components/schemas/CodeSigningConfig'
          - description: The code signing configuration
    CreateCodeSigningConfigResponse:
      type: object
      required:
      - CodeSigningConfig
      properties:
        CodeSigningConfig:
          allOf:
          - $ref: '#/components/schemas/CodeSigningConfig'
          - description: The code signing configuration.
    CodeSigningConfigId:
      type: string
      pattern: csc-[a-zA-Z0-9-_\.]{17}
    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
    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. '
  parameters:
    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
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    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
  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/lambda/
x-hasEquivalentPaths: true