findings

Creates, updates, deletes, gets or lists a findings resource.

Overview

Name	findings
Type	Resource
Id	aws.inspector.findings

Fields

The following fields are returned by SELECT queries:

describe_findings

Name	Datatype	Description
failed_items	object	Finding details that cannot be described. An error code is provided for each failed item.
findings	array	Information about the finding.

list_findings

Name	Datatype	Description
finding_arn	string	A list of ARNs that specifies the findings returned by the action.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_findings	select	region		Describes the findings that are specified by the ARNs of the findings.
list_findings	select	region		Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
add_attributes_to_findings	update	region, findingArns, attributes		Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
remove_attributes_from_findings	update	region, findingArns, attributeKeys		Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_findings

Describes the findings that are specified by the ARNs of the findings.

SELECT
failed_items,
findings
FROM aws.inspector.findings
WHERE region = '{{ region }}' -- required
;

list_findings

Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.

SELECT
finding_arn
FROM aws.inspector.findings
WHERE region = '{{ region }}' -- required
;

UPDATE examples

add_attributes_to_findings

Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.

UPDATE aws.inspector.findings
SET 
findingArns = '{{ findingArns }}',
attributes = '{{ attributes }}'
WHERE 
region = '{{ region }}' --required
AND findingArns = '{{ findingArns }}' --required
AND attributes = '{{ attributes }}' --required
RETURNING
failed_items;

remove_attributes_from_findings

Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists.

UPDATE aws.inspector.findings
SET 
findingArns = '{{ findingArns }}',
attributeKeys = '{{ attributeKeys }}'
WHERE 
region = '{{ region }}' --required
AND findingArns = '{{ findingArns }}' --required
AND attributeKeys = '{{ attributeKeys }}' --required
RETURNING
failed_items;