openapi: 3.0.0 info: version: 2019-12-02 x-release: v4 title: EC2 Image Builder CancelImageCreation ListImageScanFindings 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: ListImageScanFindings paths: /ListImageScanFindings: 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: ListImageScanFindings description: Returns a list of image scan findings for your account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListImageScanFindingsResponse' examples: ListImageScanFindings200Example: summary: Default ListImageScanFindings 200 response x-microcks-default: true value: requestId: example-id-1234 findings: example-string nextToken: example-string '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' examples: ListImageScanFindings480Example: summary: Default ListImageScanFindings 480 response x-microcks-default: true value: {} '481': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' examples: ListImageScanFindings481Example: summary: Default ListImageScanFindings 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: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: filters: description:

An array of name value pairs that you can use to filter your results. You can use the following filters to streamline results:

If you don't request a filter, then all findings in your account are listed.

type: array items: $ref: '#/components/schemas/ImageScanFindingsFilter' minItems: 1 maxItems: 1 maxResults: description: The maximum items to return in a request. type: integer minimum: 1 maximum: 25 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 Findings x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - ListImageScanFindings components: schemas: ImageScanFinding: type: object properties: awsAccountId: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The Amazon Web Services account ID that's associated with the finding. imageBuildVersionArn: allOf: - $ref: '#/components/schemas/ImageBuildVersionArn' - description: The Amazon Resource Name (ARN) of the image build version that's associated with the finding. imagePipelineArn: allOf: - $ref: '#/components/schemas/ImagePipelineArn' - description: The Amazon Resource Name (ARN) of the image pipeline that's associated with the finding. type: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The type of the finding. Image Builder looks for findings of the type PACKAGE_VULNERABILITY that apply to output images, and excludes other types. description: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The description of the finding. title: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The title of the finding. remediation: allOf: - $ref: '#/components/schemas/Remediation' - description: An object that contains the details about how to remediate the finding. severity: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The severity of the finding. firstObservedAt: allOf: - $ref: '#/components/schemas/DateTimeTimestamp' - description: The date and time when the finding was first observed. updatedAt: allOf: - $ref: '#/components/schemas/DateTimeTimestamp' - description: The timestamp when the finding was last updated. inspectorScore: allOf: - $ref: '#/components/schemas/NonNegativeDouble' - description: The score that Amazon Inspector assigned for the finding. inspectorScoreDetails: allOf: - $ref: '#/components/schemas/InspectorScoreDetails' - description: An object that contains details of the Amazon Inspector score. packageVulnerabilityDetails: allOf: - $ref: '#/components/schemas/PackageVulnerabilityDetails' - description: An object that contains the details of a package vulnerability finding. fixAvailable: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: Details about whether a fix is available for any of the packages that are identified in the finding through a version update. description: Contains details about a vulnerability scan finding. NonEmptyStringList: type: array items: $ref: '#/components/schemas/NonEmptyString' minItems: 1 NonEmptyString: type: string minLength: 1 maxLength: 1024 SourceLayerHash: type: string PackageEpoch: type: integer 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]+$ ImageScanFindingsFilterValues: type: array items: $ref: '#/components/schemas/FilterValue' minItems: 1 maxItems: 1 PackageArchitecture: type: string ForbiddenException: {} ListImageScanFindingsResponse: type: object properties: requestId: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The request ID that uniquely identifies this request. findings: allOf: - $ref: '#/components/schemas/ImageScanFindingsList' - description: The image scan findings for your account that meet your request 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. CvssScore: type: object properties: baseScore: allOf: - $ref: '#/components/schemas/NonNegativeDouble' - description: The CVSS base score. scoringVector: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The vector string of the CVSS score. version: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The CVSS version that generated the score. source: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The source of the CVSS score. description: Amazon Inspector generates a risk score for each finding. This score helps you to prioritize findings, to focus on the most critical findings and the most vulnerable resources. The score uses the Common Vulnerability Scoring System (CVSS) format. This format is a modification of the base CVSS score that the National Vulnerability Database (NVD) provides. For more information about severity levels, see Severity levels for Amazon Inspector findings in the Amazon Inspector User Guide. ServiceUnavailableException: {} NonNegativeDouble: type: number format: double minimum: 0 DateTimeTimestamp: type: string format: date-time PackageVulnerabilityDetails: type: object required: - vulnerabilityId properties: vulnerabilityId: allOf: - $ref: '#/components/schemas/VulnerabilityId' - description: A unique identifier for this vulnerability. vulnerablePackages: allOf: - $ref: '#/components/schemas/VulnerablePackageList' - description: The packages that this vulnerability impacts. source: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The source of the vulnerability information. cvss: allOf: - $ref: '#/components/schemas/CvssScoreList' - description: CVSS scores for one or more vulnerabilities that Amazon Inspector identified for a package. relatedVulnerabilities: allOf: - $ref: '#/components/schemas/VulnerabilityIdList' - description: Vulnerabilities that are often related to the findings for the package. sourceUrl: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: A link to the source of the vulnerability information. vendorSeverity: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The severity that the vendor assigned to this vulnerability type. vendorCreatedAt: allOf: - $ref: '#/components/schemas/DateTimeTimestamp' - description: The date and time when this vulnerability was first added to the vendor's database. vendorUpdatedAt: allOf: - $ref: '#/components/schemas/DateTimeTimestamp' - description: The date and time when the vendor last updated this vulnerability in their database. referenceUrls: allOf: - $ref: '#/components/schemas/NonEmptyStringList' - description: Links to web pages that contain details about the vulnerabilities that Amazon Inspector identified for the package. description: Information about package vulnerability findings. PaginationToken: type: string minLength: 1 maxLength: 65535 CvssScoreList: type: array items: $ref: '#/components/schemas/CvssScore' Remediation: type: object properties: recommendation: allOf: - $ref: '#/components/schemas/RemediationRecommendation' - description: An object that contains information about the recommended course of action to remediate the finding. description: Information about how to remediate a finding. VulnerablePackageList: type: array items: $ref: '#/components/schemas/VulnerablePackage' CallRateLimitExceededException: {} VulnerablePackage: type: object properties: name: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The name of the vulnerable package. version: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The version of the vulnerable package. sourceLayerHash: allOf: - $ref: '#/components/schemas/SourceLayerHash' - description: The source layer hash of the vulnerable package. epoch: allOf: - $ref: '#/components/schemas/PackageEpoch' - description: The epoch of the vulnerable package. release: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The release of the vulnerable package. arch: allOf: - $ref: '#/components/schemas/PackageArchitecture' - description: The architecture of the vulnerable package. packageManager: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The package manager of the vulnerable package. filePath: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The file path of the vulnerable package. fixedInVersion: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The version of the package that contains the vulnerability fix. remediation: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The code to run in your environment to update packages with a fix available. description: Information about a vulnerable package that Amazon Inspector identifies in a finding. CvssScoreDetails: type: object properties: scoreSource: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The source for the CVSS score. cvssSource: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The source of the finding. version: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The CVSS version that generated the score. score: allOf: - $ref: '#/components/schemas/NonNegativeDouble' - description: The CVSS score. scoringVector: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: A vector that measures the severity of the vulnerability. adjustments: allOf: - $ref: '#/components/schemas/CvssScoreAdjustmentList' - description: An object that contains details about an adjustment that Amazon Inspector made to the CVSS score for the finding. description: Details about the source of the score, and the factors that determined the adjustments to create the final score. VulnerabilityIdList: type: array items: $ref: '#/components/schemas/VulnerabilityId' ClientException: {} InvalidRequestException: {} ImageScanFindingsFilter: type: object properties: name: allOf: - $ref: '#/components/schemas/FilterName' - description: The name of the image scan finding filter. Filter names are case-sensitive. values: allOf: - $ref: '#/components/schemas/ImageScanFindingsFilterValues' - description: The filter values. Filter values are case-sensitive. description: A name value pair that Image Builder applies to streamline results from the vulnerability scan findings list action. InspectorScoreDetails: type: object properties: adjustedCvss: allOf: - $ref: '#/components/schemas/CvssScoreDetails' - description: An object that contains details about an adjustment that Amazon Inspector made to the CVSS score for the finding. description: Information about the factors that influenced the score that Amazon Inspector assigned for a finding. FilterValue: type: string pattern: ^[0-9a-zA-Z./_ :-]{1,1024}$ CvssScoreAdjustmentList: type: array items: $ref: '#/components/schemas/CvssScoreAdjustment' InvalidPaginationTokenException: {} RemediationRecommendation: type: object properties: text: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The recommended course of action to remediate the finding. url: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: A link to more information about the recommended remediation for this vulnerability. description: Details about the recommended course of action to remediate the finding. VulnerabilityId: type: string ImageScanFindingsList: type: array items: $ref: '#/components/schemas/ImageScanFinding' maxItems: 25 FilterName: type: string pattern: ^[a-zA-Z]{1,1024}$ CvssScoreAdjustment: type: object properties: metric: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The metric that Amazon Inspector used to adjust the CVSS score. reason: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The reason for the CVSS score adjustment. description: Details about an adjustment that Amazon Inspector made to the CVSS score for a finding. 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 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