GuardDuty / Client / list_organization_admin_accounts

list_organization_admin_accounts#

GuardDuty.Client.list_organization_admin_accounts(**kwargs)#

Lists the accounts designated as GuardDuty delegated administrators. Only the organization’s management account can run this API operation.

See also: AWS API Documentation

Request Syntax

response = client.list_organization_admin_accounts(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – The maximum number of results to return in the response.

  • NextToken (string) – A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Return type:

dict

Returns:

Response Syntax

{
    'AdminAccounts': [
        {
            'AdminAccountId': 'string',
            'AdminStatus': 'ENABLED'|'DISABLE_IN_PROGRESS'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • AdminAccounts (list) –

      A list of accounts configured as GuardDuty delegated administrators.

      • (dict) –

        The account within the organization specified as the GuardDuty delegated administrator.

        • AdminAccountId (string) –

          The Amazon Web Services account ID for the account.

        • AdminStatus (string) –

          Indicates whether the account is enabled as the delegated administrator.

    • NextToken (string) –

      The pagination parameter to be used on the next list operation to retrieve more items.

Exceptions

  • GuardDuty.Client.exceptions.BadRequestException

  • GuardDuty.Client.exceptions.InternalServerErrorException