The Filters API from Amazon Inspector — 4 operation(s) for filters.
openapi: 3.0.0
info:
version: '2020-06-08'
x-release: v4
title: Inspector2 Accountpermissions Filters 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: Filters
paths:
/filters/create:
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: CreateFilter
description: Creates a filter resource using specified filter criteria.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFilterResponse'
'480':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'481':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- action
- filterCriteria
- name
properties:
action:
description: Defines the action that is to be applied to the findings that match the filter.
type: string
enum:
- NONE
- SUPPRESS
description:
description: A description of the filter.
type: string
minLength: 1
maxLength: 512
filterCriteria:
description: Details on the criteria used to define the filter.
type: object
properties:
awsAccountId:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details of the Amazon Web Services account IDs used to filter findings.
codeVulnerabilityDetectorName:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: The name of the detector used to identify a code vulnerability in a Lambda function used to filter findings.
codeVulnerabilityDetectorTags:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: 'The detector type tag associated with the vulnerability used to filter findings. Detector tags group related vulnerabilities by common themes or tactics. For a list of available tags by programming language, see <a href="https://docs.aws.amazon.com/codeguru/detector-library/java/tags/">Java tags</a>, or <a href="https://docs.aws.amazon.com/codeguru/detector-library/python/tags/">Python tags</a>. '
codeVulnerabilityFilePath:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: The file path to the file in a Lambda function that contains a code vulnerability used to filter findings.
componentId:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details of the component IDs used to filter findings.
componentType:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details of the component types used to filter findings.
ec2InstanceImageId:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details of the Amazon EC2 instance image IDs used to filter findings.
ec2InstanceSubnetId:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details of the Amazon EC2 instance subnet IDs used to filter findings.
ec2InstanceVpcId:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details of the Amazon EC2 instance VPC IDs used to filter findings.
ecrImageArchitecture:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details of the Amazon ECR image architecture types used to filter findings.
ecrImageHash:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details of the Amazon ECR image hashes used to filter findings.
ecrImagePushedAt:
allOf:
- $ref: '#/components/schemas/DateFilterList'
- description: Details on the Amazon ECR image push date and time used to filter findings.
ecrImageRegistry:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the Amazon ECR registry used to filter findings.
ecrImageRepositoryName:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the name of the Amazon ECR repository used to filter findings.
ecrImageTags:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: The tags attached to the Amazon ECR container image.
epssScore:
allOf:
- $ref: '#/components/schemas/NumberFilterList'
- description: The EPSS score used to filter findings.
exploitAvailable:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Filters the list of AWS Lambda findings by the availability of exploits.
findingArn:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the finding ARNs used to filter findings.
findingStatus:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the finding status types used to filter findings.
findingType:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the finding types used to filter findings.
firstObservedAt:
allOf:
- $ref: '#/components/schemas/DateFilterList'
- description: Details on the date and time a finding was first seen used to filter findings.
fixAvailable:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on whether a fix is available through a version update. This value can be <code>YES</code>, <code>NO</code>, or <code>PARTIAL</code>. A <code>PARTIAL</code> fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.
inspectorScore:
allOf:
- $ref: '#/components/schemas/NumberFilterList'
- description: The Amazon Inspector score to filter on.
lambdaFunctionExecutionRoleArn:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Filters the list of AWS Lambda functions by execution role.
lambdaFunctionLastModifiedAt:
allOf:
- $ref: '#/components/schemas/DateFilterList'
- description: 'Filters the list of AWS Lambda functions by the date and time that a user last updated the configuration, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601 format</a> '
lambdaFunctionLayers:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Filters the list of AWS Lambda functions by the function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html"> layers</a>. A Lambda function can have up to five layers.
lambdaFunctionName:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Filters the list of AWS Lambda functions by the name of the function.
lambdaFunctionRuntime:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Filters the list of AWS Lambda functions by the runtime environment for the Lambda function.
lastObservedAt:
allOf:
- $ref: '#/components/schemas/DateFilterList'
- description: Details on the date and time a finding was last seen used to filter findings.
networkProtocol:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on network protocol used to filter findings.
portRange:
allOf:
- $ref: '#/components/schemas/PortRangeFilterList'
- description: Details on the port ranges used to filter findings.
relatedVulnerabilities:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the related vulnerabilities used to filter findings.
resourceId:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the resource IDs used to filter findings.
resourceTags:
allOf:
- $ref: '#/components/schemas/MapFilterList'
- description: Details on the resource tags used to filter findings.
resourceType:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the resource types used to filter findings.
severity:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the severity used to filter findings.
title:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the finding title used to filter findings.
updatedAt:
allOf:
- $ref: '#/components/schemas/DateFilterList'
- description: Details on the date and time a finding was last updated at used to filter findings.
vendorSeverity:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the vendor severity used to filter findings.
vulnerabilityId:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the vulnerability ID used to filter findings.
vulnerabilitySource:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the vulnerability type used to filter findings.
vulnerablePackages:
allOf:
- $ref: '#/components/schemas/PackageFilterList'
- description: Details on the vulnerable packages used to filter findings.
name:
description: The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not allowed.
type: string
minLength: 1
maxLength: 128
reason:
description: The reason for creating the filter.
type: string
minLength: 1
maxLength: 512
tags:
description: A list of tags for the filter.
type: object
additionalProperties:
$ref: '#/components/schemas/MapValue'
summary: Amazon Inspector Create Filter
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Filters
/filters/delete:
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: DeleteFilter
description: Deletes a filter resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteFilterResponse'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- arn
properties:
arn:
description: The Amazon Resource Number (ARN) of the filter to be deleted.
type: string
minLength: 1
maxLength: 128
summary: Amazon Inspector Delete Filter
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Filters
/filters/list:
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: ListFilters
description: Lists the filters associated with your account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListFiltersResponse'
'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:
- 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:
action:
description: The action the filter applies to matched findings.
type: string
enum:
- NONE
- SUPPRESS
arns:
description: The Amazon resource number (ARN) of the filter.
type: array
items:
$ref: '#/components/schemas/FilterArn'
maxResults:
description: The maximum number of results to return in the response.
type: integer
minimum: 1
maximum: 100
nextToken:
description: A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the <code>NextToken</code> value returned from the previous request to continue listing results after the first page.
type: string
minLength: 0
maxLength: 1000000
summary: Amazon Inspector List Filters
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Filters
/filters/update:
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: UpdateFilter
description: Specifies the action that is to be applied to the findings that match the filter.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFilterResponse'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- filterArn
properties:
action:
description: Specifies the action that is to be applied to the findings that match the filter.
type: string
enum:
- NONE
- SUPPRESS
description:
description: A description of the filter.
type: string
minLength: 1
maxLength: 512
filterArn:
description: The Amazon Resource Number (ARN) of the filter to update.
type: string
minLength: 1
maxLength: 128
filterCriteria:
description: Details on the criteria used to define the filter.
type: object
properties:
awsAccountId:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details of the Amazon Web Services account IDs used to filter findings.
codeVulnerabilityDetectorName:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: The name of the detector used to identify a code vulnerability in a Lambda function used to filter findings.
codeVulnerabilityDetectorTags:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: 'The detector type tag associated with the vulnerability used to filter findings. Detector tags group related vulnerabilities by common themes or tactics. For a list of available tags by programming language, see <a href="https://docs.aws.amazon.com/codeguru/detector-library/java/tags/">Java tags</a>, or <a href="https://docs.aws.amazon.com/codeguru/detector-library/python/tags/">Python tags</a>. '
codeVulnerabilityFilePath:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: The file path to the file in a Lambda function that contains a code vulnerability used to filter findings.
componentId:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details of the component IDs used to filter findings.
componentType:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details of the component types used to filter findings.
ec2InstanceImageId:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details of the Amazon EC2 instance image IDs used to filter findings.
ec2InstanceSubnetId:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details of the Amazon EC2 instance subnet IDs used to filter findings.
ec2InstanceVpcId:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details of the Amazon EC2 instance VPC IDs used to filter findings.
ecrImageArchitecture:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details of the Amazon ECR image architecture types used to filter findings.
ecrImageHash:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details of the Amazon ECR image hashes used to filter findings.
ecrImagePushedAt:
allOf:
- $ref: '#/components/schemas/DateFilterList'
- description: Details on the Amazon ECR image push date and time used to filter findings.
ecrImageRegistry:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the Amazon ECR registry used to filter findings.
ecrImageRepositoryName:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the name of the Amazon ECR repository used to filter findings.
ecrImageTags:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: The tags attached to the Amazon ECR container image.
epssScore:
allOf:
- $ref: '#/components/schemas/NumberFilterList'
- description: The EPSS score used to filter findings.
exploitAvailable:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Filters the list of AWS Lambda findings by the availability of exploits.
findingArn:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the finding ARNs used to filter findings.
findingStatus:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the finding status types used to filter findings.
findingType:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on the finding types used to filter findings.
firstObservedAt:
allOf:
- $ref: '#/components/schemas/DateFilterList'
- description: Details on the date and time a finding was first seen used to filter findings.
fixAvailable:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Details on whether a fix is available through a version update. This value can be <code>YES</code>, <code>NO</code>, or <code>PARTIAL</code>. A <code>PARTIAL</code> fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.
inspectorScore:
allOf:
- $ref: '#/components/schemas/NumberFilterList'
- description: The Amazon Inspector score to filter on.
lambdaFunctionExecutionRoleArn:
allOf:
- $ref: '#/components/schemas/StringFilterList'
- description: Filters the list of AWS Lambda functions by execution role.
lambdaFunctionLastModifiedAt:
allOf:
- $ref: '#/components/schemas/DateFilterList'
- description: 'Filters the list of AWS Lambda functions by the date and time that a user last updated the configuration, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601 format</a> '
lambdaFunctionLayers:
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-inspector/refs/heads/main/openapi/amazon-inspector-filters-api-openapi.yml