Skip to content

disassociate_members

Operation

disassociate_members

disassociate_members(request: DisassociateMembersInput | DisassociateMembersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DisassociateMembersInputDict]) -> DisassociateMembersOutput

Disassociates GuardDuty member accounts (from the current administrator account) specified by the account IDs.

When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are 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.

With autoEnableOrganizationMembers configuration for your organization set to ALL, you'll receive an error if you attempt to disassociate a member account before removing them from your organization.

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
request DisassociateMembersInput | DisassociateMembersInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DisassociateMembersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DisassociateMembersOutput

An instance of DisassociateMembersOutput.

disassociate_members async

disassociate_members(request: DisassociateMembersInput | DisassociateMembersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DisassociateMembersInputDict]) -> DisassociateMembersOutput

Disassociates GuardDuty member accounts (from the current administrator account) specified by the account IDs.

When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are 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.

With autoEnableOrganizationMembers configuration for your organization set to ALL, you'll receive an error if you attempt to disassociate a member account before removing them from your organization.

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
request DisassociateMembersInput | DisassociateMembersInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DisassociateMembersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DisassociateMembersOutput

An instance of DisassociateMembersOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DisassociateMembersInputDict

Bases: TypedDict

Dictionary form of DisassociateMembersInput.

Attributes

account_ids instance-attribute
account_ids: Required[Sequence[str]]

A list of account IDs of the GuardDuty member accounts that you want to disassociate from the administrator account.

detector_id instance-attribute
detector_id: Required[str]

The unique ID of the detector of the GuardDuty account whose members you want to disassociate from the administrator account.

DisassociateMembersInput dataclass

Bases: _SerdeShape

Dataclass for DisassociateMembersInput structure.

Attributes

account_ids class-attribute instance-attribute
account_ids: list[str] | None = ...

A list of account IDs of the GuardDuty member accounts that you want to disassociate from the administrator account.

detector_id class-attribute instance-attribute
detector_id: str | None = ...

The unique ID of the detector of the GuardDuty account whose members you want to disassociate from the administrator account.

Output

DisassociateMembersOutput dataclass

Bases: _SerdeShape

Dataclass for DisassociateMembersOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

unprocessed_accounts class-attribute instance-attribute
unprocessed_accounts: list[UnprocessedAccount] | None = ...

A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.