Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . inspector2 ]
create-findings-report¶
Description¶
Creates a finding report. By default only ACTIVE findings are returned in the report. To see SUPRESSED or CLOSED findings you must specify a value for the findingStatus filter criteria.
See also: AWS API Documentation
Synopsis¶
create-findings-report
[--filter-criteria <value>]
--report-format <value>
--s3-destination <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--filter-criteria (structure)
The filter criteria to apply to the results of the finding report.
awsAccountId -> (list)
Details of the Amazon Web Services account IDs used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.codeVulnerabilityDetectorName -> (list)
The name of the detector used to identify a code vulnerability in a Lambda function used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.codeVulnerabilityDetectorTags -> (list)
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 Java tags , or Python tags .
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.codeVulnerabilityFilePath -> (list)
The file path to the file in a Lambda function that contains a code vulnerability used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.componentId -> (list)
Details of the component IDs used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.componentType -> (list)
Details of the component types used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.ec2InstanceImageId -> (list)
Details of the Amazon EC2 instance image IDs used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.ec2InstanceSubnetId -> (list)
Details of the Amazon EC2 instance subnet IDs used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.ec2InstanceVpcId -> (list)
Details of the Amazon EC2 instance VPC IDs used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.ecrImageArchitecture -> (list)
Details of the Amazon ECR image architecture types used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.ecrImageHash -> (list)
Details of the Amazon ECR image hashes used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.ecrImagePushedAt -> (list)
Details on the Amazon ECR image push date and time used to filter findings.
(structure)
Contains details on the time range used to filter findings.
endInclusive -> (timestamp)
A timestamp representing the end of the time period filtered on.startInclusive -> (timestamp)
A timestamp representing the start of the time period filtered on.ecrImageRegistry -> (list)
Details on the Amazon ECR registry used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.ecrImageRepositoryName -> (list)
Details on the name of the Amazon ECR repository used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.ecrImageTags -> (list)
The tags attached to the Amazon ECR container image.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.epssScore -> (list)
The EPSS score used to filter findings.
(structure)
An object that describes the details of a number filter.
lowerInclusive -> (double)
The lowest number to be included in the filter.upperInclusive -> (double)
The highest number to be included in the filter.exploitAvailable -> (list)
Filters the list of Amazon Web Services Lambda findings by the availability of exploits.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.findingArn -> (list)
Details on the finding ARNs used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.findingStatus -> (list)
Details on the finding status types used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.findingType -> (list)
Details on the finding types used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.firstObservedAt -> (list)
Details on the date and time a finding was first seen used to filter findings.
(structure)
Contains details on the time range used to filter findings.
endInclusive -> (timestamp)
A timestamp representing the end of the time period filtered on.startInclusive -> (timestamp)
A timestamp representing the start of the time period filtered on.fixAvailable -> (list)
Details on whether a fix is available through a version update. This value can be
YES,NO, orPARTIAL. APARTIALfix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.inspectorScore -> (list)
The Amazon Inspector score to filter on.
(structure)
An object that describes the details of a number filter.
lowerInclusive -> (double)
The lowest number to be included in the filter.upperInclusive -> (double)
The highest number to be included in the filter.lambdaFunctionExecutionRoleArn -> (list)
Filters the list of Amazon Web Services Lambda functions by execution role.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.lambdaFunctionLastModifiedAt -> (list)
Filters the list of Amazon Web Services Lambda functions by the date and time that a user last updated the configuration, in ISO 8601 format
(structure)
Contains details on the time range used to filter findings.
endInclusive -> (timestamp)
A timestamp representing the end of the time period filtered on.startInclusive -> (timestamp)
A timestamp representing the start of the time period filtered on.lambdaFunctionLayers -> (list)
Filters the list of Amazon Web Services Lambda functions by the function's layers . A Lambda function can have up to five layers.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.lambdaFunctionName -> (list)
Filters the list of Amazon Web Services Lambda functions by the name of the function.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.lambdaFunctionRuntime -> (list)
Filters the list of Amazon Web Services Lambda functions by the runtime environment for the Lambda function.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.lastObservedAt -> (list)
Details on the date and time a finding was last seen used to filter findings.
(structure)
Contains details on the time range used to filter findings.
endInclusive -> (timestamp)
A timestamp representing the end of the time period filtered on.startInclusive -> (timestamp)
A timestamp representing the start of the time period filtered on.networkProtocol -> (list)
Details on network protocol used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.portRange -> (list)
Details on the port ranges used to filter findings.
(structure)
An object that describes the details of a port range filter.
beginInclusive -> (integer)
The port number the port range begins at.endInclusive -> (integer)
The port number the port range ends at.relatedVulnerabilities -> (list)
Details on the related vulnerabilities used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.resourceId -> (list)
Details on the resource IDs used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.resourceTags -> (list)
Details on the resource tags used to filter findings.
(structure)
An object that describes details of a map filter.
comparison -> (string)
The operator to use when comparing values in the filter.key -> (string)
The tag key used in the filter.value -> (string)
The tag value used in the filter.resourceType -> (list)
Details on the resource types used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.severity -> (list)
Details on the severity used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.title -> (list)
Details on the finding title used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.updatedAt -> (list)
Details on the date and time a finding was last updated at used to filter findings.
(structure)
Contains details on the time range used to filter findings.
endInclusive -> (timestamp)
A timestamp representing the end of the time period filtered on.startInclusive -> (timestamp)
A timestamp representing the start of the time period filtered on.vendorSeverity -> (list)
Details on the vendor severity used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.vulnerabilityId -> (list)
Details on the vulnerability ID used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.vulnerabilitySource -> (list)
Details on the vulnerability type used to filter findings.
(structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.vulnerablePackages -> (list)
Details on the vulnerable packages used to filter findings.
(structure)
Contains information on the details of a package filter.
architecture -> (structure)
An object that contains details on the package architecture type to filter on.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.epoch -> (structure)
An object that contains details on the package epoch to filter on.
lowerInclusive -> (double)
The lowest number to be included in the filter.upperInclusive -> (double)
The highest number to be included in the filter.filePath -> (structure)
An object that contains details on the package file path to filter on.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.name -> (structure)
An object that contains details on the name of the package to filter on.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.release -> (structure)
An object that contains details on the package release to filter on.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.sourceLambdaLayerArn -> (structure)
An object that describes the details of a string filter.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.sourceLayerHash -> (structure)
An object that contains details on the source layer hash to filter on.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.version -> (structure)
The package version to filter on.
comparison -> (string)
The operator to use when comparing values in the filter.value -> (string)
The value to filter on.
JSON Syntax:
{
"awsAccountId": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"codeVulnerabilityDetectorName": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"codeVulnerabilityDetectorTags": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"codeVulnerabilityFilePath": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"componentId": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"componentType": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"ec2InstanceImageId": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"ec2InstanceSubnetId": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"ec2InstanceVpcId": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"ecrImageArchitecture": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"ecrImageHash": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"ecrImagePushedAt": [
{
"endInclusive": timestamp,
"startInclusive": timestamp
}
...
],
"ecrImageRegistry": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"ecrImageRepositoryName": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"ecrImageTags": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"epssScore": [
{
"lowerInclusive": double,
"upperInclusive": double
}
...
],
"exploitAvailable": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"findingArn": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"findingStatus": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"findingType": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"firstObservedAt": [
{
"endInclusive": timestamp,
"startInclusive": timestamp
}
...
],
"fixAvailable": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"inspectorScore": [
{
"lowerInclusive": double,
"upperInclusive": double
}
...
],
"lambdaFunctionExecutionRoleArn": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"lambdaFunctionLastModifiedAt": [
{
"endInclusive": timestamp,
"startInclusive": timestamp
}
...
],
"lambdaFunctionLayers": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"lambdaFunctionName": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"lambdaFunctionRuntime": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"lastObservedAt": [
{
"endInclusive": timestamp,
"startInclusive": timestamp
}
...
],
"networkProtocol": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"portRange": [
{
"beginInclusive": integer,
"endInclusive": integer
}
...
],
"relatedVulnerabilities": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"resourceId": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"resourceTags": [
{
"comparison": "EQUALS",
"key": "string",
"value": "string"
}
...
],
"resourceType": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"severity": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"title": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"updatedAt": [
{
"endInclusive": timestamp,
"startInclusive": timestamp
}
...
],
"vendorSeverity": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"vulnerabilityId": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"vulnerabilitySource": [
{
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
...
],
"vulnerablePackages": [
{
"architecture": {
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
},
"epoch": {
"lowerInclusive": double,
"upperInclusive": double
},
"filePath": {
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
},
"name": {
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
},
"release": {
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
},
"sourceLambdaLayerArn": {
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
},
"sourceLayerHash": {
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
},
"version": {
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
}
}
...
]
}
--report-format (string)
The format to generate the report in.
Possible values:
CSVJSON
--s3-destination (structure)
The Amazon S3 export destination for the report.
bucketName -> (string)
The name of the Amazon S3 bucket to export findings to.keyPrefix -> (string)
The prefix that the findings will be written under.kmsKeyArn -> (string)
The ARN of the KMS key used to encrypt data when exporting findings.
Shorthand Syntax:
bucketName=string,keyPrefix=string,kmsKeyArn=string
JSON Syntax:
{
"bucketName": "string",
"keyPrefix": "string",
"kmsKeyArn": "string"
}
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command's default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To create a findings report
The following create-findings-report example creates a finding report.
aws inspector2 create-findings-report \
--report-format CSV \
--s3-destination bucketName=inspector-sbom-123456789012,keyPrefix=sbom-key,kmsKeyArn=arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333 \
--filter-criteria '{"ecrImageRepositoryName":[{"comparison":"EQUALS","value":"debian"}]}'
Output:
{
"reportId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333"
}
For more information, see Managing findings in Amazon Inspector in the Amazon Inspector User Guide.