Skip to content

list_assessments

list_assessments(
    *,
    config_overrides: Optional[AuditManagerClientConfig] = None,
    status: Optional[AssessmentStatus] = None,
    next_token: Optional[Token] = None,
    max_results: Optional[MaxResults] = None,
) -> ListAssessmentsResponse

Returns a list of current and past assessments from Audit Manager.

Parameters:

  • status (Optional[AssessmentStatus], default: None ) –

    The current status of the 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.

  • 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_assessments(
    self,
    *,
    config_overrides: Optional[AuditManagerClientConfig] = None,
    status: Optional[
        "capo_auditmanager.types.assessment_status.AssessmentStatus"
    ] = None,
    next_token: Optional["capo_auditmanager.types.token.Token"] = None,
    max_results: Optional["capo_auditmanager.types.max_results.MaxResults"] = None,
) -> "capo_auditmanager.types.list_assessments_response.ListAssessmentsResponse":
    """<p> Returns a list of current and past assessments from Audit Manager. </p>

    Args:
        status: <p> The current status of the 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.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_assessments_request.ListAssessmentsRequest]",
    ) -> OperationResponse[
        "capo_auditmanager.types.list_assessments_response.ListAssessmentsResponse"
    ]:
        import capo_auditmanager._operations.bedrock_assessment_manager_lambda.list_assessments

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

    def _redact_output(
        output: "capo_auditmanager.types.list_assessments_response.ListAssessmentsResponse",
    ) -> dict[str, Any]:
        import capo_auditmanager.types.list_assessments_response

        return capo_auditmanager.types.list_assessments_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListAssessments", redact_output=_redact_output),
    )
    input_: capo_auditmanager.types.list_assessments_request.ListAssessmentsRequest = {}
    if status is not None:
        input_["status"] = status
    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