FMS / Paginator / ListAdminAccountsForOrganization

ListAdminAccountsForOrganization

class FMS.Paginator.ListAdminAccountsForOrganization

paginator = client.get_paginator('list_admin_accounts_for_organization')

paginate(**kwargs)

Creates an iterator that will paginate through responses from FMS.Client.list_admin_accounts_for_organization().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'AdminAccounts': [
        {
            'AdminAccount': 'string',
            'DefaultAdmin': True|False,
            'Status': 'ONBOARDING'|'ONBOARDING_COMPLETE'|'OFFBOARDING'|'OFFBOARDING_COMPLETE'
        },
    ],

}

Response Structure

• (dict) –

  • AdminAccounts (list) –

    A list of Firewall Manager administrator accounts within the organization that were onboarded as administrators by AssociateAdminAccount or PutAdminAccount.

    • (dict) –

      Contains high level information about the Firewall Manager administrator account.

      • AdminAccount (string) –

        The Amazon Web Services account ID of the Firewall Manager administrator’s account.

      • DefaultAdmin (boolean) –

        A boolean value that indicates if the administrator is the default administrator. If true, then this is the default administrator account. The default administrator can manage third-party firewalls and has full administrative scope. There is only one default administrator account per organization. For information about Firewall Manager default administrator accounts, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide.

      • Status (string) –

        The current status of the request to onboard a member account as an Firewall Manager administator.

        • ONBOARDING - The account is onboarding to Firewall Manager as an administrator.

        • ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their AdminScope.

        • OFFBOARDING - The account is being removed as an Firewall Manager administrator.

        • OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.