create_members¶
Operation¶
async
¶
create_members(input: CreateMembersInput, plugins: list[Plugin] | None = None) -> CreateMembersOutput
Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account IDs. This step is a prerequisite for managing the associated member accounts either by invitation or through an organization.
As a delegated administrator, using CreateMembers will enable
GuardDuty in the added member accounts, with the exception of the
organization delegated administrator account. A delegated administrator
must enable GuardDuty prior to being added as a member.
When you use CreateMembers as an Organizations delegated administrator, GuardDuty applies your organization's auto-enable settings to the member accounts in this request, irrespective of the accounts being new or existing members. For more information about the existing auto-enable settings for your organization, see DescribeOrganizationConfiguration.
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
|
CreateMembersInput
|
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 |
|---|---|
CreateMembersOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateMembersInput structure.
Attributes¶
class-attribute
instance-attribute
¶
account_details: list[AccountDetail] | None = None
A list of account ID and email address pairs of the accounts that you want to associate with the GuardDuty administrator account.
class-attribute
instance-attribute
¶
detector_id: str | None = None
The unique ID of the detector of the GuardDuty account for which you want to associate member accounts.
To find the detectorId in the current Region, see the Settings page in
the GuardDuty console, or run the
ListDetectors
API.
Output¶
dataclass
¶
Dataclass for CreateMembersOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
unprocessed_accounts: list[UnprocessedAccount] | None = None
A list of objects that include the accountIds of the unprocessed
accounts and a result string that explains why each was unprocessed.