sensitivity_inspection_templates

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

Overview

Name	sensitivity_inspection_templates
Type	Resource
Id	aws.macie2.sensitivity_inspection_templates

Fields

The following fields are returned by SELECT queries:

get_sensitivity_inspection_template

Name	Datatype	Description
name	string	The name of the template: automated-sensitive-data-discovery.
description	string	The custom description of the template.
excludes	object	The managed data identifiers that are explicitly excluded (not used) when performing automated sensitive data discovery.
includes	object	The allow lists, custom data identifiers, and managed data identifiers that are explicitly included (used) when performing automated sensitive data discovery.
sensitivity_inspection_template_id	string	The unique identifier for the template.

list_sensitivity_inspection_templates

Name	Datatype	Description
id	string	The unique identifier for the sensitivity inspection template.
name	string	The name of the sensitivity inspection template: automated-sensitive-data-discovery.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sensitivity_inspection_template	select	id, region		Retrieves the settings for the sensitivity inspection template for an account.
list_sensitivity_inspection_templates	select	region	maxResults, nextToken	Retrieves a subset of information about the sensitivity inspection template for an account.
update_sensitivity_inspection_template	update	id, region		Updates the settings for the sensitivity inspection template for an account.

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_sensitivity_inspection_template

Retrieves the settings for the sensitivity inspection template for an account.

SELECT
name,
description,
excludes,
includes,
sensitivity_inspection_template_id
FROM aws.macie2.sensitivity_inspection_templates
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_sensitivity_inspection_templates

Retrieves a subset of information about the sensitivity inspection template for an account.

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

UPDATE examples

update_sensitivity_inspection_template

Updates the settings for the sensitivity inspection template for an account.

UPDATE aws.macie2.sensitivity_inspection_templates
SET 
description = '{{ description }}',
excludes = '{{ excludes }}',
includes = '{{ includes }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required;