invitations

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

Overview

Name	invitations
Type	Resource
Id	aws.macie2.invitations

Fields

The following fields are returned by SELECT queries:

list_invitations

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
list_invitations	select	region	maxResults, nextToken	Retrieves information about Amazon Macie membership invitations that were received by an account.
create_invitations	insert	region, accountIds		Sends an Amazon Macie membership invitation to one or more accounts.
delete_invitations	delete	region		Deletes Amazon Macie membership invitations that were received from specific accounts.
accept_invitation	exec	region, invitationId		Accepts an Amazon Macie membership invitation that was received from a specific account.
decline_invitations	exec	region, accountIds		Declines Amazon Macie membership invitations that were received from specific 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)
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_invitations

Retrieves information about Amazon Macie membership invitations that were received by an account.

SELECT
account_id,
invitation_id,
invited_at,
relationship_status
FROM aws.macie2.invitations
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_invitations

Sends an Amazon Macie membership invitation to one or more accounts.

INSERT INTO aws.macie2.invitations (
accountIds,
disableEmailNotification,
message,
region
)
SELECT 
'{{ accountIds }}' /* required */,
{{ disableEmailNotification }},
'{{ message }}',
'{{ region }}'
RETURNING
unprocessed_accounts
;

Manifest

# Description fields are for documentation purposes
- name: invitations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the invitations resource.
  - name: accountIds
    value:
      - "{{ accountIds }}"
  - name: disableEmailNotification
    value: {{ disableEmailNotification }}
  - name: message
    value: "{{ message }}"

DELETE examples

delete_invitations

Deletes Amazon Macie membership invitations that were received from specific accounts.

DELETE FROM aws.macie2.invitations
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

accept_invitation

Accepts an Amazon Macie membership invitation that was received from a specific account.

EXEC aws.macie2.invitations.accept_invitation 
@region='{{ region }}' --required 
@@json=
'{
"administratorAccountId": "{{ administratorAccountId }}", 
"invitationId": "{{ invitationId }}", 
"masterAccount": "{{ masterAccount }}"
}'
;

decline_invitations

Declines Amazon Macie membership invitations that were received from specific accounts.

EXEC aws.macie2.invitations.decline_invitations 
@region='{{ region }}' --required 
@@json=
'{
"accountIds": "{{ accountIds }}"
}'
;