findings_filters

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

Overview

Name	findings_filters
Type	Resource
Id	aws.macie2.findings_filters

Fields

The following fields are returned by SELECT queries:

get_findings_filter

Name	Datatype	Description
id	string	The unique identifier for the filter.
name	string	The custom name of the filter.
action	string	The action to perform on findings that match the filter criteria. To suppress (automatically archive) findings that match the criteria, set this value to ARCHIVE. Valid values are: (ARCHIVE, NOOP)
arn	string	The Amazon Resource Name (ARN) of the filter.
description	string	The custom description of the filter.
finding_criteria	object	Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.
position	integer	The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.
tags	object	A map of key-value pairs that specifies which tags (keys and values) are associated with the filter.

list_findings_filters

Name	Datatype	Description
id	string	The unique identifier for the filter.
name	string	The custom name of the filter.
action	string	The action to perform on findings that match the filter criteria. To suppress (automatically archive) findings that match the criteria, set this value to ARCHIVE. Valid values are: (ARCHIVE, NOOP)
arn	string	The Amazon Resource Name (ARN) of the filter.
tags	object	A map of key-value pairs that specifies which tags (keys and values) are associated with the filter.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_findings_filter	select	id, region		Retrieves the criteria and other settings for a findings filter.
list_findings_filters	select	region	maxResults, nextToken	Retrieves a subset of information about all the findings filters for an account.
create_findings_filter	insert	region, action, findingCriteria, name		Creates and defines the criteria and other settings for a findings filter.
update_findings_filter	update	id, region		Updates the criteria and other settings for a findings filter.
delete_findings_filter	delete	id, region		Deletes a findings filter.

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
id	string	The unique identifier for the Amazon Macie resource that the request applies to.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of items to include in each page of a paginated response.
nextToken	string	The nextToken string that specifies which page of results to return in a paginated response.

SELECT examples

get_findings_filter

Retrieves the criteria and other settings for a findings filter.

SELECT
id,
name,
action,
arn,
description,
finding_criteria,
position,
tags
FROM aws.macie2.findings_filters
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_findings_filters

Retrieves a subset of information about all the findings filters for an account.

SELECT
id,
name,
action,
arn,
tags
FROM aws.macie2.findings_filters
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_findings_filter

Creates and defines the criteria and other settings for a findings filter.

INSERT INTO aws.macie2.findings_filters (
action,
clientToken,
description,
findingCriteria,
name,
position,
tags,
region
)
SELECT 
'{{ action }}' /* required */,
'{{ clientToken }}',
'{{ description }}',
'{{ findingCriteria }}' /* required */,
'{{ name }}' /* required */,
{{ position }},
'{{ tags }}',
'{{ region }}'
RETURNING
id,
arn
;

Manifest

# Description fields are for documentation purposes
- name: findings_filters
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the findings_filters resource.
  - name: action
    value: "{{ action }}"
    description: |
      The action to perform on findings that match the filter criteria. To suppress (automatically archive) findings that match the criteria, set this value to ARCHIVE. Valid values are:
    valid_values: ['ARCHIVE', 'NOOP']
  - name: clientToken
    value: "{{ clientToken }}"
  - name: description
    value: "{{ description }}"
  - name: findingCriteria
    description: |
      Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.
    value:
      criterion: "{{ criterion }}"
  - name: name
    value: "{{ name }}"
  - name: position
    value: {{ position }}
  - name: tags
    value: "{{ tags }}"
    description: |
      A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource.

UPDATE examples

update_findings_filter

Updates the criteria and other settings for a findings filter.

UPDATE aws.macie2.findings_filters
SET 
action = '{{ action }}',
clientToken = '{{ clientToken }}',
description = '{{ description }}',
findingCriteria = '{{ findingCriteria }}',
name = '{{ name }}',
position = {{ position }}
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
arn;

DELETE examples

delete_findings_filter

Deletes a findings filter.

DELETE FROM aws.macie2.findings_filters
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;