describe_organization_configuration ¶

describe_organization_configuration(
    *, config_overrides: Optional[SecurityHubClientConfig] = None
) -> DescribeOrganizationConfigurationResponse

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

Raises:

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 get information about organization configuration This operation provides information about the way your organization is configured in Security Hub. Only a Security Hub administrator account can invoke this operation.

>>> client.describe_organization_configuration()

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

def describe_organization_configuration(
    self, *, config_overrides: Optional[SecurityHubClientConfig] = None
) -> "capo_securityhub.types.describe_organization_configuration_response.DescribeOrganizationConfigurationResponse":
    """<p>Returns information about the way your organization is configured in Security Hub CSPM. Only the Security Hub CSPM administrator account can invoke this operation.</p>

    Raises:
        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 get information about organization configuration
        This operation provides information about the way your organization is configured in Security Hub. Only a Security Hub administrator account can invoke this operation.

        >>> client.describe_organization_configuration()
    """

    def _handler(
        req: "OperationRequest[capo_securityhub.types.describe_organization_configuration_request.DescribeOrganizationConfigurationRequest]",
    ) -> OperationResponse[
        "capo_securityhub.types.describe_organization_configuration_response.DescribeOrganizationConfigurationResponse"
    ]:
        import capo_securityhub._operations.security_hub_api_service.describe_organization_configuration

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeOrganizationConfiguration")
    )
    input_: capo_securityhub.types.describe_organization_configuration_request.DescribeOrganizationConfigurationRequest = {}

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