automated_discovery_accounts

Creates, updates, deletes, gets or lists an automated_discovery_accounts resource.

Overview

Name	automated_discovery_accounts
Type	Resource
Id	aws.macie2.automated_discovery_accounts

Fields

The following fields are returned by SELECT queries:

list_automated_discovery_accounts

Name	Datatype	Description
account_id	string	The Amazon Web Services account ID for the account.
status	string	The current status of automated sensitive data discovery for the account. Possible values are: ENABLED, perform automated sensitive data discovery activities for the account; and, DISABLED, don't perform automated sensitive data discovery activities for the account. (ENABLED, DISABLED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_automated_discovery_accounts	select	region	accountIds, maxResults, nextToken	Retrieves the status of automated sensitive data discovery for one or more accounts.
batch_update_automated_discovery_accounts	exec	region		Changes the status of automated sensitive data discovery for one or more accounts.

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)
accountIds	array	The Amazon Web Services account ID for each account, for as many as 50 accounts. To retrieve the status for multiple accounts, append the accountIds parameter and argument for each account, separated by an ampersand (&). To retrieve the status for all the accounts in an organization, omit this parameter.
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_automated_discovery_accounts

Retrieves the status of automated sensitive data discovery for one or more accounts.

SELECT
account_id,
status
FROM aws.macie2.automated_discovery_accounts
WHERE region = '{{ region }}' -- required
AND accountIds = '{{ accountIds }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

Lifecycle Methods

batch_update_automated_discovery_accounts

Changes the status of automated sensitive data discovery for one or more accounts.

EXEC aws.macie2.automated_discovery_accounts.batch_update_automated_discovery_accounts 
@region='{{ region }}' --required 
@@json=
'{
"accounts": "{{ accounts }}"
}'
;