enable_organization_admin_account ¶

enable_organization_admin_account(
    *,
    config_overrides: Optional[SecurityHubClientConfig] = None,
    admin_account_id: Optional[NonEmptyString] = None,
    feature: Optional[SecurityHubFeature] = None,
) -> EnableOrganizationAdminAccountResponse

Designates the Security Hub CSPM administrator account for an organization. Can only be called by the organization management account.

Parameters:

admin_account_id (Optional[NonEmptyString], default: None ) –

The Amazon Web Services account identifier of the account to designate as the Security Hub CSPM administrator account.
feature (Optional[SecurityHubFeature], default: None ) –

The feature for which the delegated admin account is enabled. Defaults to Security Hub CSPM if not specified.

Raises:

AccessDeniedException –

You don't have permission to perform the action specified in the request.
InternalException –

Internal server error.
InvalidAccessException –

The account doesn't have permission to perform this action.
InvalidInputException –

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
LimitExceededException –

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To designate a Security Hub administrator The following example designates the specified account as the Security Hub administrator account. The requesting account must be the organization management account.

>>> client.enable_organization_admin_account(admin_account_id='123456789012')

Source code in docs_src/capo_securityhub/_services/security_hub.py

def enable_organization_admin_account(
    self,
    *,
    config_overrides: Optional[SecurityHubClientConfig] = None,
    admin_account_id: Optional[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ] = None,
    feature: Optional[
        "capo_securityhub.types.security_hub_feature.SecurityHubFeature"
    ] = None,
) -> "capo_securityhub.types.enable_organization_admin_account_response.EnableOrganizationAdminAccountResponse":
    """<p>Designates the Security Hub CSPM administrator account for an organization. Can only be called by the organization management account.</p>

    Args:
        admin_account_id: <p>The Amazon Web Services account identifier of the account to designate as the Security Hub CSPM administrator account.</p>
        feature: <p>The feature for which the delegated admin account is enabled. Defaults to Security Hub CSPM if not specified.</p>

    Raises:
        capo_securityhub.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action specified in the request.</p>
        capo_securityhub.errors.internal_exception.InternalException: <p>Internal server error.</p>
        capo_securityhub.errors.invalid_access_exception.InvalidAccessException: <p>The account doesn't have permission to perform this action.</p>
        capo_securityhub.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because you supplied an invalid or out-of-range value for an input parameter.</p>
        capo_securityhub.errors.limit_exceeded_exception.LimitExceededException: <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.</p>
        capo_securityhub.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To designate a Security Hub administrator
        The following example designates the specified account as the Security Hub administrator account. The requesting account must be the organization management account.

        >>> client.enable_organization_admin_account(admin_account_id='123456789012')
    """

    def _handler(
        req: "OperationRequest[capo_securityhub.types.enable_organization_admin_account_request.EnableOrganizationAdminAccountRequest]",
    ) -> OperationResponse[
        "capo_securityhub.types.enable_organization_admin_account_response.EnableOrganizationAdminAccountResponse"
    ]:
        import capo_securityhub._operations.security_hub_api_service.enable_organization_admin_account

        output, http_response = (
            capo_securityhub._operations.security_hub_api_service.enable_organization_admin_account.enable_organization_admin_account(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("EnableOrganizationAdminAccount")
    )
    input_: capo_securityhub.types.enable_organization_admin_account_request.EnableOrganizationAdminAccountRequest = {}
    if admin_account_id is not None:
        input_["admin_account_id"] = admin_account_id
    if feature is not None:
        input_["feature"] = feature

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output