libZSservicesZSamazonka-transcribeZSamazonka-transcribe
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Transcribe.ListMedicalTranscriptionJobs

Description

Lists medical transcription jobs with a specified status or substring that matches their names.

Synopsis

Creating a Request

data ListMedicalTranscriptionJobs Source #

See: newListMedicalTranscriptionJobs smart constructor.

Constructors

ListMedicalTranscriptionJobs' 

Fields

  • status :: Maybe TranscriptionJobStatus

    When specified, returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don't specify a status, Amazon Transcribe Medical returns all transcription jobs ordered by creation date.

  • nextToken :: Maybe Text

    If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs, include NextToken to fetch the next set of jobs.

  • jobNameContains :: Maybe Text

    When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

  • maxResults :: Maybe Natural

    The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Instances

Instances details
Eq ListMedicalTranscriptionJobs Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

Read ListMedicalTranscriptionJobs Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

Show ListMedicalTranscriptionJobs Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

Generic ListMedicalTranscriptionJobs Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

Associated Types

type Rep ListMedicalTranscriptionJobs :: Type -> Type #

NFData ListMedicalTranscriptionJobs Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

Hashable ListMedicalTranscriptionJobs Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

ToJSON ListMedicalTranscriptionJobs Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

AWSRequest ListMedicalTranscriptionJobs Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

ToHeaders ListMedicalTranscriptionJobs Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

ToPath ListMedicalTranscriptionJobs Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

ToQuery ListMedicalTranscriptionJobs Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

type Rep ListMedicalTranscriptionJobs Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

type Rep ListMedicalTranscriptionJobs = D1 ('MetaData "ListMedicalTranscriptionJobs" "Amazonka.Transcribe.ListMedicalTranscriptionJobs" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "ListMedicalTranscriptionJobs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TranscriptionJobStatus)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "jobNameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListMedicalTranscriptionJobs Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

newListMedicalTranscriptionJobs :: ListMedicalTranscriptionJobs Source #

Create a value of ListMedicalTranscriptionJobs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:ListMedicalTranscriptionJobs', listMedicalTranscriptionJobs_status - When specified, returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don't specify a status, Amazon Transcribe Medical returns all transcription jobs ordered by creation date.

$sel:nextToken:ListMedicalTranscriptionJobs', listMedicalTranscriptionJobs_nextToken - If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs, include NextToken to fetch the next set of jobs.

$sel:jobNameContains:ListMedicalTranscriptionJobs', listMedicalTranscriptionJobs_jobNameContains - When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

$sel:maxResults:ListMedicalTranscriptionJobs', listMedicalTranscriptionJobs_maxResults - The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Request Lenses

listMedicalTranscriptionJobs_status :: Lens' ListMedicalTranscriptionJobs (Maybe TranscriptionJobStatus) Source #

When specified, returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don't specify a status, Amazon Transcribe Medical returns all transcription jobs ordered by creation date.

listMedicalTranscriptionJobs_nextToken :: Lens' ListMedicalTranscriptionJobs (Maybe Text) Source #

If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs, include NextToken to fetch the next set of jobs.

listMedicalTranscriptionJobs_jobNameContains :: Lens' ListMedicalTranscriptionJobs (Maybe Text) Source #

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

listMedicalTranscriptionJobs_maxResults :: Lens' ListMedicalTranscriptionJobs (Maybe Natural) Source #

The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Destructuring the Response

data ListMedicalTranscriptionJobsResponse Source #

Constructors

ListMedicalTranscriptionJobsResponse' 

Fields

  • status :: Maybe TranscriptionJobStatus

    The requested status of the medical transcription jobs returned.

  • nextToken :: Maybe Text

    The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the NextPage token. Include the token in the next request to the ListMedicalTranscriptionJobs operation to return in the next page of jobs.

  • medicalTranscriptionJobSummaries :: Maybe [MedicalTranscriptionJobSummary]

    A list of objects containing summary information for a transcription job.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListMedicalTranscriptionJobsResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

Read ListMedicalTranscriptionJobsResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

Show ListMedicalTranscriptionJobsResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

Generic ListMedicalTranscriptionJobsResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

NFData ListMedicalTranscriptionJobsResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

type Rep ListMedicalTranscriptionJobsResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs

type Rep ListMedicalTranscriptionJobsResponse = D1 ('MetaData "ListMedicalTranscriptionJobsResponse" "Amazonka.Transcribe.ListMedicalTranscriptionJobs" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "ListMedicalTranscriptionJobsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TranscriptionJobStatus)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "medicalTranscriptionJobSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MedicalTranscriptionJobSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListMedicalTranscriptionJobsResponse Source #

Create a value of ListMedicalTranscriptionJobsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:ListMedicalTranscriptionJobs', listMedicalTranscriptionJobsResponse_status - The requested status of the medical transcription jobs returned.

$sel:nextToken:ListMedicalTranscriptionJobs', listMedicalTranscriptionJobsResponse_nextToken - The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the NextPage token. Include the token in the next request to the ListMedicalTranscriptionJobs operation to return in the next page of jobs.

$sel:medicalTranscriptionJobSummaries:ListMedicalTranscriptionJobsResponse', listMedicalTranscriptionJobsResponse_medicalTranscriptionJobSummaries - A list of objects containing summary information for a transcription job.

$sel:httpStatus:ListMedicalTranscriptionJobsResponse', listMedicalTranscriptionJobsResponse_httpStatus - The response's http status code.

Response Lenses

listMedicalTranscriptionJobsResponse_nextToken :: Lens' ListMedicalTranscriptionJobsResponse (Maybe Text) Source #

The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the NextPage token. Include the token in the next request to the ListMedicalTranscriptionJobs operation to return in the next page of jobs.