members

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

Overview

Name	members
Type	Resource
Id	aws.macie2.members

Fields

The following fields are returned by SELECT queries:

get_member

Name	Datatype	Description
account_id	string	The Amazon Web Services account ID for the account.
administrator_account_id	string	The Amazon Web Services account ID for the administrator account.
arn	string	The Amazon Resource Name (ARN) of the account.
email	string	The email address for the account. This value is null if the account is associated with the administrator account through Organizations.
invited_at	string (date-time)	The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie membership invitation hasn't been sent to the account.
master_account_id	string	(Deprecated) The Amazon Web Services account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.
relationship_status	string	The current status of the relationship between the account and the administrator account. (Enabled, Paused, Invited, Created, Removed, Resigned, EmailVerificationInProgress, EmailVerificationFailed, RegionDisabled, AccountSuspended)
tags	object	A map of key-value pairs that specifies which tags (keys and values) are associated with the account in Amazon Macie.
updated_at	string (date-time)	The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.

list_members

Name	Datatype	Description
account_id	string	The Amazon Web Services account ID for the account.
administrator_account_id	string	The Amazon Web Services account ID for the administrator account.
arn	string	The Amazon Resource Name (ARN) of the account.
email	string	The email address for the account. This value is null if the account is associated with the administrator account through Organizations.
invited_at	string (date-time)	The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie membership invitation hasn't been sent to the account.
master_account_id	string	(Deprecated) The Amazon Web Services account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.
relationship_status	string	The current status of the relationship between the account and the administrator account. (Enabled, Paused, Invited, Created, Removed, Resigned, EmailVerificationInProgress, EmailVerificationFailed, RegionDisabled, AccountSuspended)
tags	object	A map of key-value pairs that specifies which tags (keys and values) are associated with the account in Amazon Macie.
updated_at	string (date-time)	The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_member	select	id, region		Retrieves information about an account that's associated with an Amazon Macie administrator account.
list_members	select	region	maxResults, nextToken, onlyAssociated	Retrieves information about the accounts that are associated with an Amazon Macie administrator account.
create_member	insert	region, account		Associates an account with an Amazon Macie administrator account.
update_member_session	update	id, region, status		Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account.
disassociate_member	update	id, region		Disassociates an Amazon Macie administrator account from a member account.
delete_member	delete	id, region		Deletes the association between an Amazon Macie administrator account and 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.
onlyAssociated	string	Specifies which accounts to include in the response, based on the status of an account's relationship with the administrator account. By default, the response includes only current member accounts. To include all accounts, set this value to false.

SELECT examples

get_member

Retrieves information about an account that's associated with an Amazon Macie administrator account.

SELECT
account_id,
administrator_account_id,
arn,
email,
invited_at,
master_account_id,
relationship_status,
tags,
updated_at
FROM aws.macie2.members
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_members

Retrieves information about the accounts that are associated with an Amazon Macie administrator account.

SELECT
account_id,
administrator_account_id,
arn,
email,
invited_at,
master_account_id,
relationship_status,
tags,
updated_at
FROM aws.macie2.members
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND onlyAssociated = '{{ onlyAssociated }}'
;

INSERT examples

create_member

Associates an account with an Amazon Macie administrator account.

INSERT INTO aws.macie2.members (
account,
tags,
region
)
SELECT 
'{{ account }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
arn
;

Manifest

# Description fields are for documentation purposes
- name: members
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the members resource.
  - name: account
    description: |
      Specifies the details of an account to associate with an Amazon Macie administrator account.
    value:
      accountId: "{{ accountId }}"
      email: "{{ email }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource.

UPDATE examples

update_member_session

Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account.

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

disassociate_member

Disassociates an Amazon Macie administrator account from a member account.

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

DELETE examples

delete_member

Deletes the association between an Amazon Macie administrator account and an account.

DELETE FROM aws.macie2.members
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;