GuardDuty / Client / get_administrator_account

get_administrator_account

GuardDuty.Client.get_administrator_account(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_administrator_account(
    DetectorId='string'
)
Parameters:

DetectorId (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'Administrator': {
        'AccountId': 'string',
        'InvitationId': 'string',
        'RelationshipStatus': 'string',
        'InvitedAt': 'string'
    }
}

Response Structure

  • (dict) –

    • Administrator (dict) –

      The administrator account details.

      • AccountId (string) –

        The ID of the account used as the administrator account.

      • InvitationId (string) –

        The value that is used to validate the administrator account to the member account.

      • RelationshipStatus (string) –

        The status of the relationship between the administrator and member accounts.

      • InvitedAt (string) –

        The timestamp when the invitation was sent.

Exceptions

  • GuardDuty.Client.exceptions.BadRequestException

  • GuardDuty.Client.exceptions.InternalServerErrorException