Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Transcribe.ListMedicalTranscriptionJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

To get detailed information about a specific medical transcription job, use the operation.

Synopsis

Creating a Request

data ListMedicalTranscriptionJobs Source #

See: newListMedicalTranscriptionJobs smart constructor.

Constructors

ListMedicalTranscriptionJobs'

Fields

jobNameContains :: Maybe Text
Returns only the medical transcription jobs that contain the specified string. The search is not case sensitive.
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 that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
nextToken :: Maybe Text
If your ListMedicalTranscriptionJobs 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.
status :: Maybe TranscriptionJobStatus
Returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all medical transcription jobs are returned.

Instances

Instances details

ToJSON ListMedicalTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Methods toJSON :: ListMedicalTranscriptionJobs -> Value # toEncoding :: ListMedicalTranscriptionJobs -> Encoding # toJSONList :: [ListMedicalTranscriptionJobs] -> Value # toEncodingList :: [ListMedicalTranscriptionJobs] -> Encoding #
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 #
AWSRequest ListMedicalTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Associated Types type AWSResponse ListMedicalTranscriptionJobs # Methods request :: (Service -> Service) -> ListMedicalTranscriptionJobs -> Request ListMedicalTranscriptionJobs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListMedicalTranscriptionJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListMedicalTranscriptionJobs))) #
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 #
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 #
NFData ListMedicalTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Methods rnf :: ListMedicalTranscriptionJobs -> () #
Eq ListMedicalTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Methods (==) :: ListMedicalTranscriptionJobs -> ListMedicalTranscriptionJobs -> Bool # (/=) :: ListMedicalTranscriptionJobs -> ListMedicalTranscriptionJobs -> Bool #
Hashable ListMedicalTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Methods hashWithSalt :: Int -> ListMedicalTranscriptionJobs -> Int # hash :: ListMedicalTranscriptionJobs -> Int #
type AWSResponse ListMedicalTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs type AWSResponse ListMedicalTranscriptionJobs = ListMedicalTranscriptionJobsResponse
type Rep ListMedicalTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs type Rep ListMedicalTranscriptionJobs = D1 ('MetaData "ListMedicalTranscriptionJobs" "Amazonka.Transcribe.ListMedicalTranscriptionJobs" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "ListMedicalTranscriptionJobs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobNameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TranscriptionJobStatus)))))

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:jobNameContains:ListMedicalTranscriptionJobs', listMedicalTranscriptionJobs_jobNameContains - Returns only the medical transcription jobs that contain the specified string. The search is not case sensitive.

$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 that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

ListMedicalTranscriptionJobs, listMedicalTranscriptionJobs_nextToken - If your ListMedicalTranscriptionJobs 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.

ListMedicalTranscriptionJobs, listMedicalTranscriptionJobs_status - Returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all medical transcription jobs are returned.

Request Lenses

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

Returns only the medical transcription jobs that contain the specified string. The search is not case sensitive.

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 that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

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

If your ListMedicalTranscriptionJobs 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.

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

Returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all medical transcription jobs are returned.

Destructuring the Response

data ListMedicalTranscriptionJobsResponse Source #

See: newListMedicalTranscriptionJobsResponse smart constructor.

Constructors

ListMedicalTranscriptionJobsResponse'

Fields

medicalTranscriptionJobSummaries :: Maybe [MedicalTranscriptionJobSummary]
Provides a summary of information about each result.
nextToken :: Maybe Text
If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.
status :: Maybe TranscriptionJobStatus
Lists all medical transcription jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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 #
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 #
NFData ListMedicalTranscriptionJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Methods rnf :: ListMedicalTranscriptionJobsResponse -> () #
Eq ListMedicalTranscriptionJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs Methods (==) :: ListMedicalTranscriptionJobsResponse -> ListMedicalTranscriptionJobsResponse -> Bool # (/=) :: ListMedicalTranscriptionJobsResponse -> ListMedicalTranscriptionJobsResponse -> Bool #
type Rep ListMedicalTranscriptionJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalTranscriptionJobs type Rep ListMedicalTranscriptionJobsResponse = D1 ('MetaData "ListMedicalTranscriptionJobsResponse" "Amazonka.Transcribe.ListMedicalTranscriptionJobs" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "ListMedicalTranscriptionJobsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "medicalTranscriptionJobSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MedicalTranscriptionJobSummary])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TranscriptionJobStatus)) :*: 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:medicalTranscriptionJobSummaries:ListMedicalTranscriptionJobsResponse', listMedicalTranscriptionJobsResponse_medicalTranscriptionJobSummaries - Provides a summary of information about each result.

ListMedicalTranscriptionJobs, listMedicalTranscriptionJobsResponse_nextToken - If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

ListMedicalTranscriptionJobs, listMedicalTranscriptionJobsResponse_status - Lists all medical transcription jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.

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

Response Lenses

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

Provides a summary of information about each result.

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

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

listMedicalTranscriptionJobsResponse_status :: Lens' ListMedicalTranscriptionJobsResponse (Maybe TranscriptionJobStatus) Source #

Lists all medical transcription jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.

listMedicalTranscriptionJobsResponse_httpStatus :: Lens' ListMedicalTranscriptionJobsResponse Int Source #

The response's http status code.