invite_members¶
Operation¶
async
¶
invite_members(input: InviteMembersInput, plugins: list[Plugin] | None = None) -> InviteMembersOutput
Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account that invokes this API. If you are using Amazon Web Services Organizations to manage your GuardDuty environment, this step is not needed. For more information, see Managing accounts with organizations.
To invite Amazon Web Services accounts, the first step is to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API to add accounts by invitation. The invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each invited Amazon Web Services account can choose to accept the invitation from only one Amazon Web Services account. For more information, see Managing GuardDuty accounts by invitation.
After the invite has been accepted and you choose to disassociate a member account (by using DisassociateMembers) from your account, the details of the member account obtained by invoking CreateMembers, including the associated email addresses, will be retained. This is done so that you can invoke InviteMembers without the need to invoke CreateMembers again. To remove the details associated with a member account, you must also invoke DeleteMembers.
If you disassociate a member account that was added by invitation, the member account details obtained from this API, including the associated email addresses, will be retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API.
When the member accounts added through Organizations are later disassociated, you (administrator) can't invite them by calling the InviteMembers API. You can create an association with these member accounts again only by calling the CreateMembers API.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
InviteMembersInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
InviteMembersOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for InviteMembersInput structure.
Attributes¶
class-attribute
instance-attribute
¶
account_ids: list[str] | None = None
A list of account IDs of the accounts that you want to invite to GuardDuty as members.
class-attribute
instance-attribute
¶
detector_id: str | None = None
The unique ID of the detector of the GuardDuty account with which you want to invite members.
To find the detectorId in the current Region, see the Settings page in
the GuardDuty console, or run the
ListDetectors
API.
class-attribute
instance-attribute
¶
disable_email_notification: bool | None = None
A Boolean value that specifies whether you want to disable email notification to the accounts that you are inviting to GuardDuty as members.
class-attribute
instance-attribute
¶
message: str | None = None
The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.
Output¶
dataclass
¶
Dataclass for InviteMembersOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
unprocessed_accounts: list[UnprocessedAccount] | None = None
A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.