list_control_domain_insights_by_assessment ¶

list_control_domain_insights_by_assessment(
    assessment_id: UUID,
    *,
    config_overrides: Optional[AuditManagerClientConfig] = None,
    next_token: Optional[Token] = None,
    max_results: Optional[MaxResults] = None,
) -> ListControlDomainInsightsByAssessmentResponse

Lists analytics data for control domains within a specified active assessment.

Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference.

A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that domain.

Parameters:

assessment_id (UUID) –

The unique identifier for the active assessment.
next_token (Optional[Token], default: None ) –

The pagination token that's used to fetch the next set of results.
max_results (Optional[MaxResults], default: None ) –

Represents the maximum number of results on a page or for an API request call.

Raises:

AccessDeniedException –

Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again.
InternalServerException –

An internal service error occurred during the processing of your request. Try again later.
ResourceNotFoundException –

The resource that's specified in the request can't be found.
ValidationException –

The request has invalid or missing parameters.
UnknownServiceError –

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

Source code in docs_src/capo_auditmanager/_services/audit_manager.py

def list_control_domain_insights_by_assessment(
    self,
    assessment_id: "capo_auditmanager.types.uuid.UUID",
    *,
    config_overrides: Optional[AuditManagerClientConfig] = None,
    next_token: Optional["capo_auditmanager.types.token.Token"] = None,
    max_results: Optional["capo_auditmanager.types.max_results.MaxResults"] = None,
) -> "capo_auditmanager.types.list_control_domain_insights_by_assessment_response.ListControlDomainInsightsByAssessmentResponse":
    """<p>Lists analytics data for control domains within a specified active assessment.</p> <p>Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html"> <code>ListDomains</code> </a> in the Amazon Web Services Control Catalog API Reference.</p> <note> <p>A control domain is listed only if at least one of the controls within that domain collected evidence on the <code>lastUpdated</code> date of <code>controlDomainInsights</code>. If this condition isn’t met, no data is listed for that domain.</p> </note>

    Args:
        assessment_id: <p>The unique identifier for the active assessment. </p>
        next_token: <p>The pagination token that's used to fetch the next set of results. </p>
        max_results: <p>Represents the maximum number of results on a page or for an API request call. </p>

    Raises:
        capo_auditmanager.errors.access_denied_exception.AccessDeniedException: <p> Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. </p>
        capo_auditmanager.errors.internal_server_exception.InternalServerException: <p> An internal service error occurred during the processing of your request. Try again later. </p>
        capo_auditmanager.errors.resource_not_found_exception.ResourceNotFoundException: <p> The resource that's specified in the request can't be found. </p>
        capo_auditmanager.errors.validation_exception.ValidationException: <p> The request has invalid or missing parameters. </p>
        capo_auditmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_auditmanager.types.list_control_domain_insights_by_assessment_request.ListControlDomainInsightsByAssessmentRequest]",
    ) -> OperationResponse[
        "capo_auditmanager.types.list_control_domain_insights_by_assessment_response.ListControlDomainInsightsByAssessmentResponse"
    ]:
        import capo_auditmanager._operations.bedrock_assessment_manager_lambda.list_control_domain_insights_by_assessment

        output, http_response = (
            capo_auditmanager._operations.bedrock_assessment_manager_lambda.list_control_domain_insights_by_assessment.list_control_domain_insights_by_assessment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListControlDomainInsightsByAssessment")
    )
    input_: capo_auditmanager.types.list_control_domain_insights_by_assessment_request.ListControlDomainInsightsByAssessmentRequest = {
        "assessment_id": assessment_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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