[ aws . inspector2 ]
create-findings-report¶
Synopsis¶
create-findings-report
[--filter-criteria <value>]
--report-format <value>
--s3-destination <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
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.
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.
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.
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 the ingress source addresses 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.
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.
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"
}
...
],
"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"
}
...
],
"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
}
...
],
"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
},
"name": {
"comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
"value": "string"
},
"release": {
"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:
CSV
JSON
--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 of the KMS key used to export findings.
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 | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
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.
--output (string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--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.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.