administrator_accounts

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

Overview

Name	administrator_accounts
Type	Resource
Id	aws.macie2.administrator_accounts

Fields

The following fields are returned by SELECT queries:

get_administrator_account

Name	Datatype	Description
account_id	string	The Amazon Web Services account ID for the account that sent the invitation.
invitation_id	string	The unique identifier for the invitation.
invited_at	string (date-time)	The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.
relationship_status	string	The status of the relationship between the account that sent the invitation and the account that received the invitation. (Enabled, Paused, Invited, Created, Removed, Resigned, EmailVerificationInProgress, EmailVerificationFailed, RegionDisabled, AccountSuspended)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_administrator_account	select	region		Retrieves information about the Amazon Macie administrator account for an account.
disassociate_from_administrator_account	update	region		Disassociates a member account from its Amazon Macie administrator 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
region	string	AWS region (default: us-east-1)

SELECT examples

get_administrator_account

Retrieves information about the Amazon Macie administrator account for an account.

SELECT
account_id,
invitation_id,
invited_at,
relationship_status
FROM aws.macie2.administrator_accounts
WHERE region = '{{ region }}' -- required
;

UPDATE examples

disassociate_from_administrator_account

Disassociates a member account from its Amazon Macie administrator account.

UPDATE aws.macie2.administrator_accounts
SET 
-- No updatable properties
WHERE 
region = '{{ region }}' --required;