SecurityHub / Client / describe_organization_configuration

describe_organization_configuration#

SecurityHub.Client.describe_organization_configuration()#

Returns information about the way your organization is configured in Security Hub. Only the Security Hub administrator account can invoke this operation.

See also: AWS API Documentation

Request Syntax

response = client.describe_organization_configuration()
Return type:

dict

Returns:

Response Syntax

{
    'AutoEnable': True|False,
    'MemberAccountLimitReached': True|False,
    'AutoEnableStandards': 'NONE'|'DEFAULT',
    'OrganizationConfiguration': {
        'ConfigurationType': 'CENTRAL'|'LOCAL',
        'Status': 'PENDING'|'ENABLED'|'FAILED',
        'StatusMessage': 'string'
    }
}

Response Structure

  • (dict) –

    • AutoEnable (boolean) –

      Whether to automatically enable Security Hub in new member accounts when they join the organization.

      If set to true, then Security Hub is automatically enabled in new accounts. If set to false, then Security Hub isn’t enabled in new accounts automatically. The default value is false.

      If the ConfigurationType of your organization is set to CENTRAL, then this field is set to false and can’t be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which Security Hub is enabled and associate the policy with new organization accounts.

    • MemberAccountLimitReached (boolean) –

      Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.

    • AutoEnableStandards (string) –

      Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.

      If equal to DEFAULT, then Security Hub default standards are automatically enabled for new member accounts. If equal to NONE, then default standards are not automatically enabled for new member accounts. The default value of this parameter is equal to DEFAULT.

      If the ConfigurationType of your organization is set to CENTRAL, then this field is set to NONE and can’t be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which specific security standards are enabled and associate the policy with new organization accounts.

    • OrganizationConfiguration (dict) –

      Provides information about the way an organization is configured in Security Hub.

      • ConfigurationType (string) –

        Indicates whether the organization uses local or central configuration.

        If you use local configuration, the Security Hub delegated administrator can set AutoEnable to true and AutoEnableStandards to DEFAULT. This automatically enables Security Hub and default security standards in new organization accounts. These new account settings must be set separately in each Amazon Web Services Region, and settings may be different in each Region.

        If you use central configuration, the delegated administrator can create configuration policies. Configuration policies can be used to configure Security Hub, security standards, and security controls in multiple accounts and Regions. If you want new organization accounts to use a specific configuration, you can create a configuration policy and associate it with the root or specific organizational units (OUs). New accounts will inherit the policy from the root or their assigned OU.

      • Status (string) –

        Describes whether central configuration could be enabled as the ConfigurationType for the organization. If your ConfigurationType is local configuration, then the value of Status is always ENABLED.

      • StatusMessage (string) –

        Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL.

Exceptions

  • SecurityHub.Client.exceptions.InternalException

  • SecurityHub.Client.exceptions.InvalidInputException

  • SecurityHub.Client.exceptions.InvalidAccessException

  • SecurityHub.Client.exceptions.LimitExceededException