AWS cli documentation change
Summary
Updated filter criteria structure, added error reporting fields, and reorganized parameters for findings report status. Changes include renaming fields, modifying filter descriptions, adding new output fields (reportId, status, errorCode, errorMessage), and restructuring vulnerability filtering parameters.
Security assessment
The changes enhance documentation for security findings filtering capabilities (e.g., adding EPSS score, exploit availability, and vulnerability detection filters) but do not address a specific security vulnerability. The modifications improve security feature documentation by providing more granular control over security findings analysis.
Diff
diff --git a/cli/latest/reference/inspector2/get-findings-report-status.md b/cli/latest/reference/inspector2/get-findings-report-status.md index 933802309..2eb612cb5 100644 --- a//cli/latest/reference/inspector2/get-findings-report-status.md +++ b//cli/latest/reference/inspector2/get-findings-report-status.md @@ -15 +15 @@ - * [AWS CLI 2.27.63 Command Reference](../../index.html) » + * [AWS CLI 2.28.0 Command Reference](../../index.html) » @@ -194,0 +195,16 @@ Disable automatically prompt for CLI input parameters. +reportId -> (string) + +> The ID of the report. + +status -> (string) + +> The status of the report. + +errorCode -> (string) + +> The error code of the report. + +errorMessage -> (string) + +> The error message of the report. + @@ -211,8 +226,0 @@ destination -> (structure) -errorCode -> (string) - -> The error code of the report. - -errorMessage -> (string) - -> The error message of the report. - @@ -223 +231 @@ filterCriteria -> (structure) -> awsAccountId -> (list) +> findingArn -> (list) @@ -225 +233 @@ filterCriteria -> (structure) ->> Details of the Amazon Web Services account IDs used to filter findings. +>> Details on the finding ARNs used to filter findings. @@ -239 +247 @@ filterCriteria -> (structure) -> codeRepositoryProjectName -> (list) +> awsAccountId -> (list) @@ -241 +249 @@ filterCriteria -> (structure) ->> Filter criteria for findings based on the project name in a code repository. +>> Details of the Amazon Web Services account IDs used to filter findings. @@ -255 +263 @@ filterCriteria -> (structure) -> codeRepositoryProviderType -> (list) +> findingType -> (list) @@ -257 +265 @@ filterCriteria -> (structure) ->> Filter criteria for findings based on the repository provider type (such as GitHub, GitLab, etc.). +>> Details on the finding types used to filter findings. @@ -271 +279 @@ filterCriteria -> (structure) -> codeVulnerabilityDetectorName -> (list) +> severity -> (list) @@ -273 +281 @@ filterCriteria -> (structure) ->> The name of the detector used to identify a code vulnerability in a Lambda function used to filter findings. +>> Details on the severity used to filter findings. @@ -287 +295 @@ filterCriteria -> (structure) -> codeVulnerabilityDetectorTags -> (list) +> firstObservedAt -> (list) @@ -289 +297 @@ filterCriteria -> (structure) ->> 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](https://docs.aws.amazon.com/codeguru/detector-library/java/tags/) , or [Python tags](https://docs.aws.amazon.com/codeguru/detector-library/python/tags/) . +>> Details on the date and time a finding was first seen used to filter findings. @@ -293 +301 @@ filterCriteria -> (structure) ->>> An object that describes the details of a string filter. +>>> Contains details on the time range used to filter findings. @@ -295 +303 @@ filterCriteria -> (structure) ->>> comparison -> (string) +>>> startInclusive -> (timestamp) @@ -297 +305 @@ filterCriteria -> (structure) ->>>> The operator to use when comparing values in the filter. +>>>> A timestamp representing the start of the time period filtered on. @@ -299 +307 @@ filterCriteria -> (structure) ->>> value -> (string) +>>> endInclusive -> (timestamp) @@ -301 +309 @@ filterCriteria -> (structure) ->>>> The value to filter on. +>>>> A timestamp representing the end of the time period filtered on. @@ -303 +311 @@ filterCriteria -> (structure) -> codeVulnerabilityFilePath -> (list) +> lastObservedAt -> (list) @@ -305 +313 @@ filterCriteria -> (structure) ->> The file path to the file in a Lambda function that contains a code vulnerability used to filter findings. +>> Details on the date and time a finding was last seen used to filter findings. @@ -309 +317 @@ filterCriteria -> (structure) ->>> An object that describes the details of a string filter. +>>> Contains details on the time range used to filter findings. @@ -311 +319 @@ filterCriteria -> (structure) ->>> comparison -> (string) +>>> startInclusive -> (timestamp) @@ -313 +321 @@ filterCriteria -> (structure) ->>>> The operator to use when comparing values in the filter. +>>>> A timestamp representing the start of the time period filtered on. @@ -315 +323 @@ filterCriteria -> (structure) ->>> value -> (string) +>>> endInclusive -> (timestamp) @@ -317 +325 @@ filterCriteria -> (structure) ->>>> The value to filter on. +>>>> A timestamp representing the end of the time period filtered on. @@ -319 +327 @@ filterCriteria -> (structure) -> componentId -> (list) +> updatedAt -> (list) @@ -321 +329,17 @@ filterCriteria -> (structure) ->> Details of the component IDs used to filter findings. +>> 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. +>>> +>>> startInclusive -> (timestamp) +>>> +>>>> A timestamp representing the start of the time period filtered on. +>>> +>>> endInclusive -> (timestamp) +>>> +>>>> A timestamp representing the end of the time period filtered on. +> +> findingStatus -> (list) +> +>> Details on the finding status types used to filter findings. @@ -335 +359 @@ filterCriteria -> (structure) -> componentType -> (list) +> title -> (list) @@ -337 +361 @@ filterCriteria -> (structure) ->> Details of the component types used to filter findings. +>> Details on the finding title used to filter findings. @@ -351 +375 @@ filterCriteria -> (structure) -> ec2InstanceImageId -> (list) +> inspectorScore -> (list) @@ -353 +377,17 @@ filterCriteria -> (structure) ->> Details of the Amazon EC2 instance image IDs used to filter findings. +>> The Amazon Inspector score to filter on. +>> +>> (structure) +>> +>>> An object that describes the details of a number filter. +>>> +>>> upperInclusive -> (double) +>>> +>>>> The highest number to be included in the filter. +>>> +>>> lowerInclusive -> (double) +>>> +>>>> The lowest number to be included in the filter. +> +> resourceType -> (list) +> +>> Details on the resource types used to filter findings. @@ -367 +407 @@ filterCriteria -> (structure) -> ec2InstanceSubnetId -> (list) +> resourceId -> (list) @@ -369 +409 @@ filterCriteria -> (structure) ->> Details of the Amazon EC2 instance subnet IDs used to filter findings. +>> Details on the resource IDs used to filter findings. @@ -383 +423 @@ filterCriteria -> (structure) -> ec2InstanceVpcId -> (list) +> resourceTags -> (list) @@ -385 +425 @@ filterCriteria -> (structure) ->> Details of the Amazon EC2 instance VPC IDs used to filter findings. +>> Details on the resource tags used to filter findings. @@ -389 +429 @@ filterCriteria -> (structure) ->>> An object that describes the details of a string filter. +>>> An object that describes details of a map filter. @@ -394,0 +435,4 @@ filterCriteria -> (structure) +>>> key -> (string) +>>> +>>>> The tag key used in the filter. +>>> @@ -397 +441 @@ filterCriteria -> (structure) ->>>> The value to filter on. +>>>> The tag value used in the filter. @@ -399 +443 @@ filterCriteria -> (structure) -> ecrImageArchitecture -> (list) +> ec2InstanceImageId -> (list) @@ -401 +445 @@ filterCriteria -> (structure) ->> Details of the Amazon ECR image architecture types used to filter findings. +>> Details of the Amazon EC2 instance image IDs used to filter findings. @@ -415 +459 @@ filterCriteria -> (structure) -> ecrImageHash -> (list) +> ec2InstanceVpcId -> (list) @@ -417 +461 @@ filterCriteria -> (structure) ->> Details of the Amazon ECR image hashes used to filter findings. +>> Details of the Amazon EC2 instance VPC IDs used to filter findings. @@ -431 +475 @@ filterCriteria -> (structure) -> ecrImageInUseCount -> (list) +> ec2InstanceSubnetId -> (list) @@ -433 +477 @@ filterCriteria -> (structure) ->> Filter criteria indicating when details for an Amazon ECR image include when an Amazon ECR image is in use. +>> Details of the Amazon EC2 instance subnet IDs used to filter findings. @@ -437 +481 @@ filterCriteria -> (structure) ->>> An object that describes the details of a number filter. +>>> An object that describes the details of a string filter. @@ -439 +483 @@ filterCriteria -> (structure) ->>> lowerInclusive -> (double) +>>> comparison -> (string) @@ -441 +485 @@ filterCriteria -> (structure) ->>>> The lowest number to be included in the filter. +>>>> The operator to use when comparing values in the filter. @@ -443 +487 @@ filterCriteria -> (structure)