AWS Lambda Lambda Code Signing Config API

openapi: 3.2.0
info:
  title: AWS Lambda Code Signing Config API
  version: '2015-03-31'
  description: Generated from AWS's published Smithy model for AWS Lambda. 8 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://lambda.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Code Signing Config
paths:
  /2020-04-22/code-signing-configs/{CodeSigningConfigArn}:
    delete:
      operationId: DeleteCodeSigningConfig
      summary: Delete Code Signing Config
      description: Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCodeSigningConfigResponse'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '409':
          description: ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteCodeSigningConfigRequest'
      tags:
      - Code Signing Config
    get:
      operationId: GetCodeSigningConfig
      summary: Get Code Signing Config
      description: Returns information about the specified code signing configuration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCodeSigningConfigResponse'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetCodeSigningConfigRequest'
      tags:
      - Code Signing Config
    put:
      operationId: UpdateCodeSigningConfig
      summary: Update Code Signing Config
      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'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCodeSigningConfigRequest'
      tags:
      - Code Signing Config
  /2020-04-22/code-signing-configs:
    post:
      operationId: CreateCodeSigningConfig
      summary: Create Code Signing Config
      description: Creates a code signing configuration. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCodeSigningConfigResponse'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCodeSigningConfigRequest'
      tags:
      - Code Signing Config
    get:
      operationId: ListCodeSigningConfigs
      summary: List Code Signing Configs
      description: Returns a list of code signing configurations. A request returns up to 10,000 configurations per call. You can use the MaxItems parameter to return fewer configurations per call.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCodeSigningConfigsResponse'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListCodeSigningConfigsRequest'
      tags:
      - Code Signing Config
  /2020-06-30/functions/{FunctionName}/code-signing-config:
    delete:
      operationId: DeleteFunctionCodeSigningConfig
      summary: Delete Function Code Signing Config
      description: Removes the code signing configuration from the function.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '404':
          description: CodeSigningConfigNotFoundException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodeSigningConfigNotFoundException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '409':
          description: ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceConflictException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteFunctionCodeSigningConfigRequest'
      tags:
      - Code Signing Config
    get:
      operationId: GetFunctionCodeSigningConfig
      summary: Get Function Code Signing Config
      description: Returns the code signing configuration for the specified function.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFunctionCodeSigningConfigResponse'
        '404':
          description: CodeSigningConfigNotFoundException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodeSigningConfigNotFoundException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetFunctionCodeSigningConfigRequest'
      tags:
      - Code Signing Config
    put:
      operationId: PutFunctionCodeSigningConfig
      summary: Put Function Code Signing Config
      description: Update the code signing configuration for the function. 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/PutFunctionCodeSigningConfigResponse'
        '404':
          description: CodeSigningConfigNotFoundException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodeSigningConfigNotFoundException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '409':
          description: ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceConflictException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutFunctionCodeSigningConfigRequest'
      tags:
      - Code Signing Config
components:
  schemas:
    DeleteCodeSigningConfigResponse:
      type: object
      properties: {}
    DeleteFunctionCodeSigningConfigRequest:
      type: object
      properties:
        FunctionName:
          type: string
          description: The name or ARN of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
      required:
      - FunctionName
    InvalidParameterValueException:
      type: object
      properties:
        Type:
          type: string
          description: The exception type.
        message:
          type: string
          description: The exception message.
    UpdateCodeSigningConfigRequest:
      type: object
      properties:
        CodeSigningConfigArn:
          type: string
          description: The The Amazon Resource Name (ARN) of the code signing configuration.
        Description:
          type: string
          description: Descriptive name for this code signing configuration.
        AllowedPublishers:
          $ref: '#/components/schemas/AllowedPublishers'
        CodeSigningPolicies:
          $ref: '#/components/schemas/CodeSigningPolicies'
      required:
      - CodeSigningConfigArn
    GetFunctionCodeSigningConfigResponse:
      type: object
      properties:
        CodeSigningConfigArn:
          type: string
          description: The The Amazon Resource Name (ARN) of the code signing configuration.
        FunctionName:
          type: string
          description: The name or ARN of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
      required:
      - CodeSigningConfigArn
      - FunctionName
    CodeSigningConfig:
      type: object
      properties:
        CodeSigningConfigId:
          type: string
          description: Unique identifer for the Code signing configuration.
        CodeSigningConfigArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Code signing configuration.
        Description:
          type: string
          description: Code signing configuration description.
        AllowedPublishers:
          $ref: '#/components/schemas/AllowedPublishers'
        CodeSigningPolicies:
          $ref: '#/components/schemas/CodeSigningPolicies'
        LastModified:
          type: string
          description: The date and time that the Code signing configuration was last modified, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
      required:
      - CodeSigningConfigId
      - CodeSigningConfigArn
      - AllowedPublishers
      - CodeSigningPolicies
      - LastModified
    GetCodeSigningConfigRequest:
      type: object
      properties:
        CodeSigningConfigArn:
          type: string
          description: The The Amazon Resource Name (ARN) of the code signing configuration.
      required:
      - CodeSigningConfigArn
    ListCodeSigningConfigsRequest:
      type: object
      properties:
        Marker:
          type: string
          description: Specify the pagination token that's returned by a previous request to retrieve the next page of results.
        MaxItems:
          type: integer
          description: Maximum number of items to return.
    CodeSigningPolicies:
      type: object
      properties:
        UntrustedArtifactOnDeployment:
          type: string
          enum:
          - Warn
          - Enforce
          description: 'Code signing configuration policy for deployment validation failure. If you set the policy to Enforce, Lambda blocks the deployment request if signature validation checks fail. If you set the policy to Warn, Lambda allows the deployment and issues a new Amazon CloudWatch metric (SignatureValidationErrors) and also stores the warning in the CloudTrail log. Default value: Warn'
    ListCodeSigningConfigsResponse:
      type: object
      properties:
        NextMarker:
          type: string
          description: The pagination token that's included if more results are available.
        CodeSigningConfigs:
          type: array
          items:
            $ref: '#/components/schemas/CodeSigningConfig'
          description: The code signing configurations
    GetCodeSigningConfigResponse:
      type: object
      properties:
        CodeSigningConfig:
          $ref: '#/components/schemas/CodeSigningConfig'
      required:
      - CodeSigningConfig
    TooManyRequestsException:
      type: object
      properties:
        retryAfterSeconds:
          type: string
          description: The number of seconds the caller should wait before retrying.
        Type:
          type: string
        message:
          type: string
        Reason:
          type: string
          enum:
          - ConcurrentInvocationLimitExceeded
          - FunctionInvocationRateLimitExceeded
          - ReservedFunctionConcurrentInvocationLimitExceeded
          - ReservedFunctionInvocationRateLimitExceeded
          - CallerRateLimitExceeded
          - ConcurrentSnapshotCreateLimitExceeded
    AllowedPublishers:
      type: object
      properties:
        SigningProfileVersionArns:
          type: array
          items:
            type: string
          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.
      required:
      - SigningProfileVersionArns
    UpdateCodeSigningConfigResponse:
      type: object
      properties:
        CodeSigningConfig:
          $ref: '#/components/schemas/CodeSigningConfig'
      required:
      - CodeSigningConfig
    CreateCodeSigningConfigRequest:
      type: object
      properties:
        Description:
          type: string
          description: Descriptive name for this code signing configuration.
        AllowedPublishers:
          $ref: '#/components/schemas/AllowedPublishers'
        CodeSigningPolicies:
          $ref: '#/components/schemas/CodeSigningPolicies'
        Tags:
          type: object
          additionalProperties:
            type: string
          description: A list of tags to add to the code signing configuration.
      required:
      - AllowedPublishers
    PutFunctionCodeSigningConfigResponse:
      type: object
      properties:
        CodeSigningConfigArn:
          type: string
          description: The The Amazon Resource Name (ARN) of the code signing configuration.
        FunctionName:
          type: string
          description: The name or ARN of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
      required:
      - CodeSigningConfigArn
      - FunctionName
    DeleteCodeSigningConfigRequest:
      type: object
      properties:
        CodeSigningConfigArn:
          type: string
          description: The The Amazon Resource Name (ARN) of the code signing configuration.
      required:
      - CodeSigningConfigArn
    PutFunctionCodeSigningConfigRequest:
      type: object
      properties:
        CodeSigningConfigArn:
          type: string
          description: The The Amazon Resource Name (ARN) of the code signing configuration.
        FunctionName:
          type: string
          description: The name or ARN of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
      required:
      - CodeSigningConfigArn
      - FunctionName
    ResourceNotFoundException:
      type: object
      properties:
        Type:
          type: string
        Message:
          type: string
    ServiceException:
      type: object
      properties:
        Type:
          type: string
        Message:
          type: string
    ResourceConflictException:
      type: object
      properties:
        Type:
          type: string
          description: The exception type.
        message:
          type: string
          description: The exception message.
    CreateCodeSigningConfigResponse:
      type: object
      properties:
        CodeSigningConfig:
          $ref: '#/components/schemas/CodeSigningConfig'
      required:
      - CodeSigningConfig
    GetFunctionCodeSigningConfigRequest:
      type: object
      properties:
        FunctionName:
          type: string
          description: The name or ARN of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
      required:
      - FunctionName
    CodeSigningConfigNotFoundException:
      type: object
      properties:
        Type:
          type: string
        Message:
          type: string
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: lambda
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/lambda/service/2015-03-31/lambda-2015-03-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)