Amazon EC2 Image Builder ListImageScanFindingAggregations API

openapi: 3.0.0
info:
  version: 2019-12-02
  x-release: v4
  title: EC2 Image Builder CancelImageCreation ListImageScanFindingAggregations API
  description: EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date "golden" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.
  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: imagebuilder
  x-aws-signingName: imagebuilder
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/imagebuilder-2019-12-02.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://imagebuilder.{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 imagebuilder multi-region endpoint
- url: https://imagebuilder.{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 imagebuilder multi-region endpoint
- url: http://imagebuilder.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The imagebuilder endpoint for China (Beijing) and China (Ningxia)
- url: https://imagebuilder.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The imagebuilder endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: ListImageScanFindingAggregations
paths:
  /ListImageScanFindingAggregations:
    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: ListImageScanFindingAggregations
      description: <p>Returns a list of image scan aggregations for your account. You can filter by the type of key that Image Builder uses to group results. For example, if you want to get a list of findings by severity level for one of your pipelines, you might specify your pipeline with the <code>imagePipelineArn</code> filter. If you don't specify a filter, Image Builder returns an aggregation for your account.</p> <p>To streamline results, you can use the following filters in your request:</p> <ul> <li> <p> <code>accountId</code> </p> </li> <li> <p> <code>imageBuildVersionArn</code> </p> </li> <li> <p> <code>imagePipelineArn</code> </p> </li> <li> <p> <code>vulnerabilityId</code> </p> </li> </ul>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListImageScanFindingAggregationsResponse'
              examples:
                ListImageScanFindingAggregations200Example:
                  summary: Default ListImageScanFindingAggregations 200 response
                  x-microcks-default: true
                  value:
                    requestId: example-id-1234
                    aggregationType: example-string
                    responses: example-string
        '480':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
              examples:
                ListImageScanFindingAggregations480Example:
                  summary: Default ListImageScanFindingAggregations 480 response
                  x-microcks-default: true
                  value: {}
        '481':
          description: ClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
              examples:
                ListImageScanFindingAggregations481Example:
                  summary: Default ListImageScanFindingAggregations 481 response
                  x-microcks-default: true
                  value: {}
        '482':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '483':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '484':
          description: InvalidPaginationTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidPaginationTokenException'
        '485':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '486':
          description: CallRateLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallRateLimitExceededException'
      parameters:
      - name: nextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                filter:
                  description: A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
                  type: object
                  properties:
                    name:
                      allOf:
                      - $ref: '#/components/schemas/FilterName'
                      - description: The name of the filter. Filter names are case-sensitive.
                    values:
                      allOf:
                      - $ref: '#/components/schemas/FilterValues'
                      - description: The filter values. Filter values are case-sensitive.
                nextToken:
                  description: A token to specify where to start paginating. This is the NextToken from a previously truncated response.
                  type: string
                  minLength: 1
                  maxLength: 65535
      summary: Amazon EC2 Image Builder List Image Scan Finding Aggregations
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - ListImageScanFindingAggregations
components:
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      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-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-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
  schemas:
    AccountAggregation:
      type: object
      properties:
        accountId:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: Identifies the account that owns the aggregated resource findings.
        severityCounts:
          allOf:
          - $ref: '#/components/schemas/SeverityCounts'
          - description: Counts by severity level for medium severity and higher level findings, plus a total for all of the findings.
      description: Contains counts of vulnerability findings from image scans that run when you create new Image Builder images, or build new versions of existing images. The vulnerability counts are grouped by severity level. The counts are aggregated across resources to create the final tally for the account that owns them.
    SeverityCountNumber:
      type: integer
    FilterName:
      type: string
      pattern: ^[a-zA-Z]{1,1024}$
    NonEmptyString:
      type: string
      minLength: 1
      maxLength: 1024
    ImagePipelineArn:
      type: string
      pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image-pipeline/[a-z0-9-_]+$
    ServiceException: {}
    ImageBuildVersionArn:
      type: string
      pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$
    SeverityCounts:
      type: object
      properties:
        all:
          allOf:
          - $ref: '#/components/schemas/SeverityCountNumber'
          - description: The total number of findings across all severity levels for the specified filter.
        critical:
          allOf:
          - $ref: '#/components/schemas/SeverityCountNumber'
          - description: The number of critical severity findings for the specified filter.
        high:
          allOf:
          - $ref: '#/components/schemas/SeverityCountNumber'
          - description: The number of high severity findings for the specified filter.
        medium:
          allOf:
          - $ref: '#/components/schemas/SeverityCountNumber'
          - description: The number of medium severity findings for the specified filter.
      description: Includes counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified filter.
    ForbiddenException: {}
    ServiceUnavailableException: {}
    PaginationToken:
      type: string
      minLength: 1
      maxLength: 65535
    ImagePipelineAggregation:
      type: object
      properties:
        imagePipelineArn:
          allOf:
          - $ref: '#/components/schemas/ImagePipelineArn'
          - description: The Amazon Resource Name (ARN) that identifies the image pipeline for this aggregation.
        severityCounts:
          allOf:
          - $ref: '#/components/schemas/SeverityCounts'
          - description: Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image pipeline.
      description: Contains vulnerability counts for a specific image pipeline.
    ImageScanFindingAggregationsList:
      type: array
      items:
        $ref: '#/components/schemas/ImageScanFindingAggregation'
    CallRateLimitExceededException: {}
    ListImageScanFindingAggregationsResponse:
      type: object
      properties:
        requestId:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: The request ID that uniquely identifies this request.
        aggregationType:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: <p>The aggregation type specifies what type of key is used to group the image scan findings. Image Builder returns results based on the request filter. If you didn't specify a filter in the request, the type defaults to <code>accountId</code>.</p> <p class="title"> <b>Aggregation types</b> </p> <ul> <li> <p>accountId</p> </li> <li> <p>imageBuildVersionArn</p> </li> <li> <p>imagePipelineArn</p> </li> <li> <p>vulnerabilityId</p> </li> </ul> <p>Each aggregation includes counts by severity level for medium severity and higher level findings, plus a total for all of the findings for each key value.</p>
        responses:
          allOf:
          - $ref: '#/components/schemas/ImageScanFindingAggregationsList'
          - description: An array of image scan finding aggregations that match the filter criteria.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationToken'
          - description: The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
    ClientException: {}
    InvalidRequestException: {}
    FilterValue:
      type: string
      pattern: ^[0-9a-zA-Z./_ :-]{1,1024}$
    VulnerabilityIdAggregation:
      type: object
      properties:
        vulnerabilityId:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: The vulnerability Id for this set of counts.
        severityCounts:
          allOf:
          - $ref: '#/components/schemas/SeverityCounts'
          - description: Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified vulnerability.
      description: Includes counts of image and pipeline resource findings by vulnerability.
    InvalidPaginationTokenException: {}
    ImageAggregation:
      type: object
      properties:
        imageBuildVersionArn:
          allOf:
          - $ref: '#/components/schemas/ImageBuildVersionArn'
          - description: The Amazon Resource Name (ARN) that identifies the image for this aggregation.
        severityCounts:
          allOf:
          - $ref: '#/components/schemas/SeverityCounts'
          - description: Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image.
      description: Contains vulnerability counts for a specific image.
    FilterValues:
      type: array
      items:
        $ref: '#/components/schemas/FilterValue'
      minItems: 1
      maxItems: 10
    ImageScanFindingAggregation:
      type: object
      properties:
        accountAggregation:
          allOf:
          - $ref: '#/components/schemas/AccountAggregation'
          - description: Returns an object that contains severity counts based on an account ID.
        imageAggregation:
          allOf:
          - $ref: '#/components/schemas/ImageAggregation'
          - description: Returns an object that contains severity counts based on the Amazon Resource Name (ARN) for a specific image.
        imagePipelineAggregation:
          allOf:
          - $ref: '#/components/schemas/ImagePipelineAggregation'
          - description: Returns an object that contains severity counts based on an image pipeline ARN.
        vulnerabilityIdAggregation:
          allOf:
          - $ref: '#/components/schemas/VulnerabilityIdAggregation'
          - description: Returns an object that contains severity counts based on vulnerability ID.
      description: This returns exactly one type of aggregation, based on the filter that Image Builder applies in its API action.
  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/imagebuilder/
x-hasEquivalentPaths: true