list_medical_scribe_jobs ¶

def list_medical_scribe_jobs(
    self,
    *,
    config_overrides: Optional[TranscribeClientConfig] = None,
    status: Optional[
        "capo_transcribe.types.medical_scribe_job_status.MedicalScribeJobStatus"
    ] = None,
    job_name_contains: Optional[
        "capo_transcribe.types.transcription_job_name.TranscriptionJobName"
    ] = None,
    next_token: Optional["capo_transcribe.types.next_token.NextToken"] = None,
    max_results: Optional["capo_transcribe.types.max_results.MaxResults"] = None,
) -> "capo_transcribe.types.list_medical_scribe_jobs_response.ListMedicalScribeJobsResponse":
    """<p>Provides a list of Medical Scribe jobs that match the specified criteria. If no criteria are specified, all Medical Scribe jobs are returned.</p> <p>To get detailed information about a specific Medical Scribe job, use the operation.</p>

    Args:
        status: <p>Returns only Medical Scribe jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include <code>Status</code>, all Medical Scribe jobs are returned.</p>
        job_name_contains: <p>Returns only the Medical Scribe jobs that contain the specified string. The search is not case sensitive.</p>
        next_token: <p>If your <code>ListMedicalScribeJobs</code> request returns more results than can be displayed, <code>NextToken</code> is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including <code>NextToken</code> with the value of the copied string. Repeat as needed to view all your results.</p>
        max_results: <p>The maximum number of Medical Scribe jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.</p>

    Raises:
        capo_transcribe.errors.bad_request_exception.BadRequestException: <p>Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as <code>IN PROGRESS</code>). See the exception message field for more information.</p>
        capo_transcribe.errors.internal_failure_exception.InternalFailureException: <p>There was an internal error. Check the error message, correct the issue, and try your request again.</p>
        capo_transcribe.errors.limit_exceeded_exception.LimitExceededException: <p>You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.</p>
        capo_transcribe.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_transcribe.types.list_medical_scribe_jobs_request.ListMedicalScribeJobsRequest]",
    ) -> OperationResponse[
        "capo_transcribe.types.list_medical_scribe_jobs_response.ListMedicalScribeJobsResponse"
    ]:
        import capo_transcribe._operations.transcribe.list_medical_scribe_jobs

        output, http_response = (
            capo_transcribe._operations.transcribe.list_medical_scribe_jobs.list_medical_scribe_jobs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMedicalScribeJobs")
    )
    input_: capo_transcribe.types.list_medical_scribe_jobs_request.ListMedicalScribeJobsRequest = {}
    if status is not None:
        input_["status"] = status
    if job_name_contains is not None:
        input_["job_name_contains"] = job_name_contains
    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