classification_scopes

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

Overview

Name	classification_scopes
Type	Resource
Id	aws.macie2.classification_scopes

Fields

The following fields are returned by SELECT queries:

get_classification_scope

Name	Datatype	Description
id	string	The unique identifier for the classification scope. (pattern: <code>^[0-9a-z]*$</code>)
name	string	The name of the classification scope: automated-sensitive-data-discovery. (pattern: <code>^[0-9a-zA-Z_\-]*$</code>)
s_3	object	The S3 buckets that are excluded from automated sensitive data discovery.

list_classification_scopes

Name	Datatype	Description
id	string	The unique identifier for the classification scope. (pattern: <code>^[0-9a-z]*$</code>)
name	string	The name of the classification scope: automated-sensitive-data-discovery. (pattern: <code>^[0-9a-zA-Z_\-]*$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_classification_scope	select	id, region		Retrieves the classification scope settings for an account.
list_classification_scopes	select	region	name, nextToken	Retrieves a subset of information about the classification scope for an account.
update_classification_scope	update	id, region		Updates the classification scope settings 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)
name	string	The name of the classification scope to retrieve the unique identifier for.
nextToken	string	The nextToken string that specifies which page of results to return in a paginated response.

SELECT examples

get_classification_scope

Retrieves the classification scope settings for an account.

SELECT
id,
name,
s_3
FROM aws.macie2.classification_scopes
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_classification_scopes

Retrieves a subset of information about the classification scope for an account.

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

UPDATE examples

update_classification_scope

Updates the classification scope settings for an account.

UPDATE aws.macie2.classification_scopes
SET 
s3 = '{{ s3 }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required;