resource_profile_detections

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

Overview

Name	resource_profile_detections
Type	Resource
Id	aws.macie2.resource_profile_detections

Fields

The following fields are returned by SELECT queries:

list_resource_profile_detections

Name	Datatype	Description
id	string	The unique identifier for the custom data identifier or managed data identifier that detected the sensitive data. For additional details about a specified managed data identifier, see Using managed data identifiers in the Amazon Macie User Guide.
name	string	The name of the custom data identifier or managed data identifier that detected the sensitive data. For a managed data identifier, this value is the same as the unique identifier (id).
arn	string	If the sensitive data was detected by a custom data identifier, the Amazon Resource Name (ARN) of the custom data identifier that detected the data. Otherwise, this value is null.
count	integer (int64)	The total number of occurrences of the sensitive data.
suppressed	boolean	Specifies whether occurrences of this type of sensitive data are excluded (true) or included (false) in the bucket's sensitivity score, if the score is calculated by Amazon Macie.
type_	string	The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier. (CUSTOM, MANAGED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_resource_profile_detections	select	resourceArn, region	maxResults, nextToken	Retrieves information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket.
update_resource_profile_detections	update	resourceArn, region		Updates the sensitivity scoring settings for an S3 bucket.

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)
resourceArn	string	The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.
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

list_resource_profile_detections

Retrieves information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket.

SELECT
id,
name,
arn,
count,
suppressed,
type_
FROM aws.macie2.resource_profile_detections
WHERE resourceArn = '{{ resourceArn }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

update_resource_profile_detections

Updates the sensitivity scoring settings for an S3 bucket.

UPDATE aws.macie2.resource_profile_detections
SET 
suppressDataIdentifiers = '{{ suppressDataIdentifiers }}'
WHERE 
resourceArn = '{{ resourceArn }}' --required
AND region = '{{ region }}' --required;