Skip to content

get_administrator_account

Operation

get_administrator_account

get_administrator_account(request: GetAdministratorAccountInput | GetAdministratorAccountInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAdministratorAccountInputDict]) -> GetAdministratorAccountOutput

Provides the details of the GuardDuty administrator account associated with the current GuardDuty member account.

Based on the type of account that runs this API, the following list shows how the API behavior varies:

  • When the GuardDuty administrator account runs this API, it will return success (HTTP 200) but no content.

  • When a member account runs this API, it will return the details of the GuardDuty administrator account that is associated with this calling member account.

  • When an individual account (not associated with an organization) runs this API, it will return success (HTTP 200) but no content.

Parameters:

Name Type Description Default
request GetAdministratorAccountInput | GetAdministratorAccountInputDict | 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[GetAdministratorAccountInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAdministratorAccountOutput

An instance of GetAdministratorAccountOutput.

get_administrator_account async

get_administrator_account(request: GetAdministratorAccountInput | GetAdministratorAccountInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAdministratorAccountInputDict]) -> GetAdministratorAccountOutput

Provides the details of the GuardDuty administrator account associated with the current GuardDuty member account.

Based on the type of account that runs this API, the following list shows how the API behavior varies:

  • When the GuardDuty administrator account runs this API, it will return success (HTTP 200) but no content.

  • When a member account runs this API, it will return the details of the GuardDuty administrator account that is associated with this calling member account.

  • When an individual account (not associated with an organization) runs this API, it will return success (HTTP 200) but no content.

Parameters:

Name Type Description Default
request GetAdministratorAccountInput | GetAdministratorAccountInputDict | 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[GetAdministratorAccountInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAdministratorAccountOutput

An instance of GetAdministratorAccountOutput.

Input

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

GetAdministratorAccountInputDict

Bases: TypedDict

Dictionary form of GetAdministratorAccountInput.

Attributes

detector_id instance-attribute
detector_id: Required[str]

The unique ID of the detector of the GuardDuty member account.

GetAdministratorAccountInput dataclass

Bases: _SerdeShape

Dataclass for GetAdministratorAccountInput structure.

Attributes

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

The unique ID of the detector of the GuardDuty member account.

Output

GetAdministratorAccountOutput dataclass

Bases: _SerdeShape

Dataclass for GetAdministratorAccountOutput structure.

Attributes

administrator class-attribute instance-attribute
administrator: Administrator | None = ...

The administrator account details.

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.