Amazon Inspector Codesnippet API

openapi: 3.0.0
info:
  version: '2020-06-08'
  x-release: v4
  title: Inspector2 Accountpermissions Codesnippet API
  description: Amazon Inspector is a vulnerability discovery service that automates continuous scanning for security vulnerabilities within your Amazon EC2 and Amazon ECR environments.
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    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: inspector2
  x-aws-signingName: inspector2
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/inspector2-2020-06-08.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://inspector2.{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 Inspector2 multi-region endpoint
- url: https://inspector2.{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 Inspector2 multi-region endpoint
- url: http://inspector2.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Inspector2 endpoint for China (Beijing) and China (Ningxia)
- url: https://inspector2.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Inspector2 endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Codesnippet
paths:
  /codesnippet/batchget:
    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: BatchGetCodeSnippet
      description: Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchGetCodeSnippetResponse'
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - findingArns
              properties:
                findingArns:
                  description: An array of finding ARNs for the findings you want to retrieve code snippets from.
                  type: array
                  items:
                    $ref: '#/components/schemas/FindingArn'
                  minItems: 1
                  maxItems: 10
      summary: Amazon Inspector Batch Get Code Snippet
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Codesnippet
components:
  schemas:
    SuggestedFixDescriptionString:
      type: string
      minLength: 1
      maxLength: 1000
    NonEmptyString:
      type: string
      minLength: 1
    CodeSnippetErrorList:
      type: array
      items:
        $ref: '#/components/schemas/CodeSnippetError'
    BatchGetCodeSnippetResponse:
      type: object
      properties:
        codeSnippetResults:
          allOf:
          - $ref: '#/components/schemas/CodeSnippetResultList'
          - description: The retrieved code snippets associated with the provided finding ARNs.
        errors:
          allOf:
          - $ref: '#/components/schemas/CodeSnippetErrorList'
          - description: Any errors Amazon Inspector encountered while trying to retrieve the requested code snippets.
    FindingArn:
      type: string
      pattern: ^arn:(aws[a-zA-Z-]*)?:inspector2:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:finding/[a-f0-9]{32}$
      minLength: 1
      maxLength: 100
    Integer:
      type: integer
    AccessDeniedException: {}
    SuggestedFixCodeString:
      type: string
      minLength: 1
      maxLength: 2500
    CodeSnippetErrorCode:
      type: string
      enum:
      - INTERNAL_ERROR
      - ACCESS_DENIED
      - CODE_SNIPPET_NOT_FOUND
      - INVALID_INPUT
    InternalServerException: {}
    SuggestedFix:
      type: object
      properties:
        code:
          allOf:
          - $ref: '#/components/schemas/SuggestedFixCodeString'
          - description: The fix's code.
        description:
          allOf:
          - $ref: '#/components/schemas/SuggestedFixDescriptionString'
          - description: The fix's description.
      description: A suggested fix for a vulnerability in your Lambda function code.
    CodeLineList:
      type: array
      items:
        $ref: '#/components/schemas/CodeLine'
      minItems: 1
      maxItems: 20
    CodeSnippetResultList:
      type: array
      items:
        $ref: '#/components/schemas/CodeSnippetResult'
    CodeSnippetError:
      type: object
      required:
      - errorCode
      - errorMessage
      - findingArn
      properties:
        errorCode:
          allOf:
          - $ref: '#/components/schemas/CodeSnippetErrorCode'
          - description: The error code for the error that prevented a code snippet from being retrieved.
        errorMessage:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: The error message received when Amazon Inspector failed to retrieve a code snippet.
        findingArn:
          allOf:
          - $ref: '#/components/schemas/FindingArn'
          - description: The ARN of the finding that a code snippet couldn't be retrieved for.
      description: Contains information about any errors encountered while trying to retrieve a code snippet.
    SuggestedFixes:
      type: array
      items:
        $ref: '#/components/schemas/SuggestedFix'
      minItems: 1
      maxItems: 5
    CodeLine:
      type: object
      required:
      - content
      - lineNumber
      properties:
        content:
          allOf:
          - $ref: '#/components/schemas/CodeLineContentString'
          - description: The content of a line of code
        lineNumber:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: The line number that a section of code is located at.
      description: Contains information on the lines of code associated with a code snippet.
    CodeSnippetResult:
      type: object
      properties:
        codeSnippet:
          allOf:
          - $ref: '#/components/schemas/CodeLineList'
          - description: Contains information on the retrieved code snippet.
        endLine:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: The line number of the last line of a code snippet.
        findingArn:
          allOf:
          - $ref: '#/components/schemas/FindingArn'
          - description: The ARN of a finding that the code snippet is associated with.
        startLine:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: The line number of the first line of a code snippet.
        suggestedFixes:
          allOf:
          - $ref: '#/components/schemas/SuggestedFixes'
          - description: Details of a suggested code fix.
      description: Contains information on a code snippet retrieved by Amazon Inspector from a code vulnerability finding.
    CodeLineContentString:
      type: string
      minLength: 0
      maxLength: 240
    ThrottlingException: {}
    ValidationException: {}
  parameters:
    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-Credential:
      name: X-Amz-Credential
      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-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      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/inspector2/
x-hasEquivalentPaths: true