Skip to content

AdminAccountSummary

Source code in docs_src/capo_fms/types/admin_account_summary.py 
13
14
15
16
17
18
19
class AdminAccountSummary(TypedDict, closed=True):
    admin_account: NotRequired["capo_fms.types.aws_account_id.AWSAccountId"]
    """<p>The Amazon Web Services account ID of the Firewall Manager administrator's account.</p>"""
    default_admin: "capo_fms.types.boolean.Boolean"
    """<p>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 <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-administrators.html">Managing Firewall Manager administrators</a> in the <i>Firewall Manager Developer Guide</i>.</p>"""
    status: NotRequired["capo_fms.types.organization_status.OrganizationStatus"]
    """<p>The current status of the request to onboard a member account as an Firewall Manager administrator.</p> <ul> <li> <p> <code>ONBOARDING</code> - The account is onboarding to Firewall Manager as an administrator.</p> </li> <li> <p> <code>ONBOARDING_COMPLETE</code> - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their <a>AdminScope</a>.</p> </li> <li> <p> <code>OFFBOARDING</code> - The account is being removed as an Firewall Manager administrator.</p> </li> <li> <p> <code>OFFBOARDING_COMPLETE</code> - The account has been removed as an Firewall Manager administrator.</p> </li> </ul>"""

admin_account instance-attribute 

admin_account: NotRequired[AWSAccountId]

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

default_admin instance-attribute 

default_admin: 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 instance-attribute 

status: NotRequired[OrganizationStatus]

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

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