List Medical Scribe Jobs

transcribeservice_list_medical_scribe_jobs

R Documentation

Provides a list of Medical Scribe jobs that match the specified criteria¶

Description¶

Provides a list of Medical Scribe jobs that match the specified criteria. If no criteria are specified, all Medical Scribe jobs are returned.

To get detailed information about a specific Medical Scribe job, use the operation.

Usage¶

transcribeservice_list_medical_scribe_jobs(Status, JobNameContains,
  NextToken, MaxResults)

Arguments¶

Status

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 Status, all Medical Scribe jobs are returned.

JobNameContains

Returns only the Medical Scribe jobs that contain the specified string. The search is not case sensitive.

NextToken

If your list_medical_scribe_jobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

MaxResults

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.

Value¶

A list with the following syntax:

list(
  Status = "QUEUED"|"IN_PROGRESS"|"FAILED"|"COMPLETED",
  NextToken = "string",
  MedicalScribeJobSummaries = list(
    list(
      MedicalScribeJobName = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      CompletionTime = as.POSIXct(
        "2015-01-01"
      ),
      LanguageCode = "en-US",
      MedicalScribeJobStatus = "QUEUED"|"IN_PROGRESS"|"FAILED"|"COMPLETED",
      FailureReason = "string"
    )
  )
)

Request syntax¶

svc$list_medical_scribe_jobs(
  Status = "QUEUED"|"IN_PROGRESS"|"FAILED"|"COMPLETED",
  JobNameContains = "string",
  NextToken = "string",
  MaxResults = 123
)