Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Transcribe.ListMedicalTranscriptionJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 Methods (==) :: ListMedicalTranscriptionJobs -> ListMedicalTranscriptionJobs -> Bool # (/=) :: ListMedicalTranscriptionJobs -> ListMedicalTranscriptionJobs -> Bool #
Read ListMedicalTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Methods readsPrec :: Int -> ReadS ListMedicalTranscriptionJobs # readList :: ReadS [ListMedicalTranscriptionJobs] # readPrec :: ReadPrec ListMedicalTranscriptionJobs # readListPrec :: ReadPrec [ListMedicalTranscriptionJobs] #
Show ListMedicalTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Methods showsPrec :: Int -> ListMedicalTranscriptionJobs -> ShowS # show :: ListMedicalTranscriptionJobs -> String # showList :: [ListMedicalTranscriptionJobs] -> ShowS #
Generic ListMedicalTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Associated Types type Rep ListMedicalTranscriptionJobs :: Type -> Type # Methods from :: ListMedicalTranscriptionJobs -> Rep ListMedicalTranscriptionJobs x # to :: Rep ListMedicalTranscriptionJobs x -> ListMedicalTranscriptionJobs #
NFData ListMedicalTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Methods rnf :: ListMedicalTranscriptionJobs -> () #
Hashable ListMedicalTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Methods hashWithSalt :: Int -> ListMedicalTranscriptionJobs -> Int # hash :: ListMedicalTranscriptionJobs -> Int #
ToJSON ListMedicalTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Methods toJSON :: ListMedicalTranscriptionJobs -> Value # toEncoding :: ListMedicalTranscriptionJobs -> Encoding # toJSONList :: [ListMedicalTranscriptionJobs] -> Value # toEncodingList :: [ListMedicalTranscriptionJobs] -> Encoding #
AWSRequest ListMedicalTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Associated Types type AWSResponse ListMedicalTranscriptionJobs # Methods request :: ListMedicalTranscriptionJobs -> Request ListMedicalTranscriptionJobs # response :: MonadResource m => Logger -> Service -> Proxy ListMedicalTranscriptionJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListMedicalTranscriptionJobs))) #
ToHeaders ListMedicalTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Methods toHeaders :: ListMedicalTranscriptionJobs -> [Header] #
ToPath ListMedicalTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Methods toPath :: ListMedicalTranscriptionJobs -> ByteString #
ToQuery ListMedicalTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Methods toQuery :: ListMedicalTranscriptionJobs -> QueryString #
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 type AWSResponse ListMedicalTranscriptionJobs = ListMedicalTranscriptionJobsResponse

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 #

See: newListMedicalTranscriptionJobsResponse smart constructor.

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 Methods (==) :: ListMedicalTranscriptionJobsResponse -> ListMedicalTranscriptionJobsResponse -> Bool # (/=) :: ListMedicalTranscriptionJobsResponse -> ListMedicalTranscriptionJobsResponse -> Bool #
Read ListMedicalTranscriptionJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Methods readsPrec :: Int -> ReadS ListMedicalTranscriptionJobsResponse # readList :: ReadS [ListMedicalTranscriptionJobsResponse] # readPrec :: ReadPrec ListMedicalTranscriptionJobsResponse # readListPrec :: ReadPrec [ListMedicalTranscriptionJobsResponse] #
Show ListMedicalTranscriptionJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Methods showsPrec :: Int -> ListMedicalTranscriptionJobsResponse -> ShowS # show :: ListMedicalTranscriptionJobsResponse -> String # showList :: [ListMedicalTranscriptionJobsResponse] -> ShowS #
Generic ListMedicalTranscriptionJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Associated Types type Rep ListMedicalTranscriptionJobsResponse :: Type -> Type # Methods from :: ListMedicalTranscriptionJobsResponse -> Rep ListMedicalTranscriptionJobsResponse x # to :: Rep ListMedicalTranscriptionJobsResponse x -> ListMedicalTranscriptionJobsResponse #
NFData ListMedicalTranscriptionJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Methods rnf :: ListMedicalTranscriptionJobsResponse -> () #
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 #

Arguments

:: Int	`$sel:httpStatus:ListMedicalTranscriptionJobsResponse'`
-> ListMedicalTranscriptionJobsResponse

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_status :: Lens' ListMedicalTranscriptionJobsResponse (Maybe TranscriptionJobStatus) Source #

The requested status of the medical transcription jobs returned.

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.

listMedicalTranscriptionJobsResponse_medicalTranscriptionJobSummaries :: Lens' ListMedicalTranscriptionJobsResponse (Maybe [MedicalTranscriptionJobSummary]) Source #

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

listMedicalTranscriptionJobsResponse_httpStatus :: Lens' ListMedicalTranscriptionJobsResponse Int Source #

The response's http status code.