Skip to content

delete_members

Operation

delete_members

delete_members(request: DeleteMembersInput | DeleteMembersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteMembersInputDict]) -> DeleteMembersOutput

Deletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.

With autoEnableOrganizationMembers configuration for your organization set to ALL, you'll receive an error if you attempt to disable GuardDuty for a member account in your organization.

Parameters:

Name Type Description Default
request DeleteMembersInput | DeleteMembersInputDict | 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[DeleteMembersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteMembersOutput

An instance of DeleteMembersOutput.

delete_members async

delete_members(request: DeleteMembersInput | DeleteMembersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteMembersInputDict]) -> DeleteMembersOutput

Deletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.

With autoEnableOrganizationMembers configuration for your organization set to ALL, you'll receive an error if you attempt to disable GuardDuty for a member account in your organization.

Parameters:

Name Type Description Default
request DeleteMembersInput | DeleteMembersInputDict | 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[DeleteMembersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteMembersOutput

An instance of DeleteMembersOutput.

Input

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

DeleteMembersInputDict

Bases: TypedDict

Dictionary form of DeleteMembersInput.

Attributes

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

A list of account IDs of the GuardDuty member accounts that you want to delete.

detector_id instance-attribute
detector_id: Required[str]

The unique ID of the detector of the GuardDuty account whose members you want to delete.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

DeleteMembersInput dataclass

Bases: _SerdeShape

Dataclass for DeleteMembersInput 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 delete.

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 delete.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

Output

DeleteMembersOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteMembersOutput 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 = ...

The accounts that could not be processed.