[ aws . inspector2 ]
get-findings-report-status¶
Description¶
Gets the status of a findings report.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-findings-report-status
[--report-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--report-id (string)
The ID of the report to retrieve the status of.
--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.
See ‘aws help’ for descriptions of global parameters.
Output¶
destination -> (structure)
The destination of 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.
errorCode -> (string)
The error code of the report.
errorMessage -> (string)
The error message of the report.
filterCriteria -> (structure)
The filter criteria associated with the 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.
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.
reportId -> (string)
The ID of the report.
status -> (string)
The status of the report.