invitations

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

Overview

Name	invitations
Type	Resource
Id	aws.detective.invitations

Fields

The following fields are returned by SELECT queries:

list_invitations

Name	Datatype	Description
invitations	array	The list of behavior graphs for which the member account has open or accepted invitations.
next_token	string	If there are more behavior graphs remaining in the results, then this is the pagination token to use to request the next page of behavior graphs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_invitations	select	region		Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by an invited member account. Open invitations are invitations that the member account has not responded to. The results do not include behavior graphs for which the member account declined the invitation. The results also do not include behavior graphs that the member account resigned from or was removed from.

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

list_invitations

Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by an invited member account. Open invitations are invitations that the member account has not responded to. The results do not include behavior graphs for which the member account declined the invitation. The results also do not include behavior graphs that the member account resigned from or was removed from.

SELECT
invitations,
next_token
FROM aws.detective.invitations
WHERE region = '{{ region }}' -- required
;