list_ad_assessments ¶

def list_ad_assessments(
    self,
    *,
    config_overrides: Optional[DirectoryServiceClientConfig] = None,
    directory_id: Optional[
        "capo_directory_service.types.directory_id.DirectoryId"
    ] = None,
    next_token: Optional[
        "capo_directory_service.types.next_token.NextToken"
    ] = None,
    limit: Optional[
        "capo_directory_service.types.assessment_limit.AssessmentLimit"
    ] = None,
) -> "capo_directory_service.types.list_ad_assessments_result.ListADAssessmentsResult":
    """<p>Retrieves a list of directory assessments for the specified directory or all assessments in your account. Use this operation to monitor assessment status and manage multiple assessments.</p>

    Args:
        directory_id: <p>The identifier of the directory for which to list assessments. If not specified, all assessments in your account are returned.</p>
        next_token: <p>The pagination token from a previous request to <a>ListADAssessments</a>. Pass null if this is the first request.</p>
        limit: <p>The maximum number of assessment summaries to return.</p>

    Raises:
        capo_directory_service.errors.client_exception.ClientException: <p>A client exception has occurred.</p>
        capo_directory_service.errors.directory_does_not_exist_exception.DirectoryDoesNotExistException: <p>The specified directory does not exist in the system.</p>
        capo_directory_service.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid.</p>
        capo_directory_service.errors.service_exception.ServiceException: <p>An exception has occurred in Directory Service.</p>
        capo_directory_service.errors.unsupported_operation_exception.UnsupportedOperationException: <p>The operation is not supported.</p>
        capo_directory_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_directory_service.types.list_ad_assessments_request.ListADAssessmentsRequest]",
    ) -> OperationResponse[
        "capo_directory_service.types.list_ad_assessments_result.ListADAssessmentsResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.list_ad_assessments

        output, http_response = (
            capo_directory_service._operations.directory_service_20150416.list_ad_assessments.list_ad_assessments(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListADAssessments")
    )
    input_: capo_directory_service.types.list_ad_assessments_request.ListADAssessmentsRequest = {}
    if directory_id is not None:
        input_["directory_id"] = directory_id
    if next_token is not None:
        input_["next_token"] = next_token
    if limit is not None:
        input_["limit"] = limit

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