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.ListTranscriptionJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists transcription jobs with the specified status.

Synopsis

Creating a Request

data ListTranscriptionJobs Source #

See: newListTranscriptionJobs smart constructor.

Constructors

ListTranscriptionJobs'

Fields

status :: Maybe TranscriptionJobStatus
When specified, returns only 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 returns all transcription jobs ordered by creation date.
nextToken :: Maybe Text
If the result of the previous request to ListTranscriptionJobs is truncated, include the 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 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 ListTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs Methods (==) :: ListTranscriptionJobs -> ListTranscriptionJobs -> Bool # (/=) :: ListTranscriptionJobs -> ListTranscriptionJobs -> Bool #
Read ListTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs Methods readsPrec :: Int -> ReadS ListTranscriptionJobs # readList :: ReadS [ListTranscriptionJobs] # readPrec :: ReadPrec ListTranscriptionJobs # readListPrec :: ReadPrec [ListTranscriptionJobs] #
Show ListTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs Methods showsPrec :: Int -> ListTranscriptionJobs -> ShowS # show :: ListTranscriptionJobs -> String # showList :: [ListTranscriptionJobs] -> ShowS #
Generic ListTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs Associated Types type Rep ListTranscriptionJobs :: Type -> Type # Methods from :: ListTranscriptionJobs -> Rep ListTranscriptionJobs x # to :: Rep ListTranscriptionJobs x -> ListTranscriptionJobs #
NFData ListTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs Methods rnf :: ListTranscriptionJobs -> () #
Hashable ListTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs Methods hashWithSalt :: Int -> ListTranscriptionJobs -> Int # hash :: ListTranscriptionJobs -> Int #
ToJSON ListTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs Methods toJSON :: ListTranscriptionJobs -> Value # toEncoding :: ListTranscriptionJobs -> Encoding # toJSONList :: [ListTranscriptionJobs] -> Value # toEncodingList :: [ListTranscriptionJobs] -> Encoding #
AWSRequest ListTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs Associated Types type AWSResponse ListTranscriptionJobs # Methods request :: ListTranscriptionJobs -> Request ListTranscriptionJobs # response :: MonadResource m => Logger -> Service -> Proxy ListTranscriptionJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTranscriptionJobs))) #
ToHeaders ListTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs Methods toHeaders :: ListTranscriptionJobs -> [Header] #
ToPath ListTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs Methods toPath :: ListTranscriptionJobs -> ByteString #
ToQuery ListTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs Methods toQuery :: ListTranscriptionJobs -> QueryString #
type Rep ListTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs type Rep ListTranscriptionJobs = D1 ('MetaData "ListTranscriptionJobs" "Amazonka.Transcribe.ListTranscriptionJobs" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "ListTranscriptionJobs'" '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 ListTranscriptionJobs Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs type AWSResponse ListTranscriptionJobs = ListTranscriptionJobsResponse

newListTranscriptionJobs :: ListTranscriptionJobs Source #

Create a value of ListTranscriptionJobs 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:ListTranscriptionJobs', listTranscriptionJobs_status - When specified, returns only 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 returns all transcription jobs ordered by creation date.

$sel:nextToken:ListTranscriptionJobs', listTranscriptionJobs_nextToken - If the result of the previous request to ListTranscriptionJobs is truncated, include the NextToken to fetch the next set of jobs.

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

$sel:maxResults:ListTranscriptionJobs', listTranscriptionJobs_maxResults - The maximum number of 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

listTranscriptionJobs_status :: Lens' ListTranscriptionJobs (Maybe TranscriptionJobStatus) Source #

When specified, returns only 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 returns all transcription jobs ordered by creation date.

listTranscriptionJobs_nextToken :: Lens' ListTranscriptionJobs (Maybe Text) Source #

If the result of the previous request to ListTranscriptionJobs is truncated, include the NextToken to fetch the next set of jobs.

listTranscriptionJobs_jobNameContains :: Lens' ListTranscriptionJobs (Maybe Text) Source #

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

listTranscriptionJobs_maxResults :: Lens' ListTranscriptionJobs (Maybe Natural) Source #

The maximum number of 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 ListTranscriptionJobsResponse Source #

See: newListTranscriptionJobsResponse smart constructor.

Constructors

ListTranscriptionJobsResponse'

Fields

status :: Maybe TranscriptionJobStatus
The requested status of the jobs returned.
nextToken :: Maybe Text
The ListTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListTranscriptionJobs operation to return in the next page of jobs.
transcriptionJobSummaries :: Maybe [TranscriptionJobSummary]
A list of objects containing summary information for a transcription job.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListTranscriptionJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs Methods (==) :: ListTranscriptionJobsResponse -> ListTranscriptionJobsResponse -> Bool # (/=) :: ListTranscriptionJobsResponse -> ListTranscriptionJobsResponse -> Bool #
Read ListTranscriptionJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs Methods readsPrec :: Int -> ReadS ListTranscriptionJobsResponse # readList :: ReadS [ListTranscriptionJobsResponse] # readPrec :: ReadPrec ListTranscriptionJobsResponse # readListPrec :: ReadPrec [ListTranscriptionJobsResponse] #
Show ListTranscriptionJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs Methods showsPrec :: Int -> ListTranscriptionJobsResponse -> ShowS # show :: ListTranscriptionJobsResponse -> String # showList :: [ListTranscriptionJobsResponse] -> ShowS #
Generic ListTranscriptionJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs Associated Types type Rep ListTranscriptionJobsResponse :: Type -> Type # Methods from :: ListTranscriptionJobsResponse -> Rep ListTranscriptionJobsResponse x # to :: Rep ListTranscriptionJobsResponse x -> ListTranscriptionJobsResponse #
NFData ListTranscriptionJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs Methods rnf :: ListTranscriptionJobsResponse -> () #
type Rep ListTranscriptionJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListTranscriptionJobs type Rep ListTranscriptionJobsResponse = D1 ('MetaData "ListTranscriptionJobsResponse" "Amazonka.Transcribe.ListTranscriptionJobs" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "ListTranscriptionJobsResponse'" '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 "transcriptionJobSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TranscriptionJobSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTranscriptionJobsResponse Source #

Arguments

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

Create a value of ListTranscriptionJobsResponse 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:ListTranscriptionJobs', listTranscriptionJobsResponse_status - The requested status of the jobs returned.

$sel:nextToken:ListTranscriptionJobs', listTranscriptionJobsResponse_nextToken - The ListTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListTranscriptionJobs operation to return in the next page of jobs.

$sel:transcriptionJobSummaries:ListTranscriptionJobsResponse', listTranscriptionJobsResponse_transcriptionJobSummaries - A list of objects containing summary information for a transcription job.

$sel:httpStatus:ListTranscriptionJobsResponse', listTranscriptionJobsResponse_httpStatus - The response's http status code.

Response Lenses

listTranscriptionJobsResponse_status :: Lens' ListTranscriptionJobsResponse (Maybe TranscriptionJobStatus) Source #

The requested status of the jobs returned.

listTranscriptionJobsResponse_nextToken :: Lens' ListTranscriptionJobsResponse (Maybe Text) Source #

The ListTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListTranscriptionJobs operation to return in the next page of jobs.

listTranscriptionJobsResponse_transcriptionJobSummaries :: Lens' ListTranscriptionJobsResponse (Maybe [TranscriptionJobSummary]) Source #

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

listTranscriptionJobsResponse_httpStatus :: Lens' ListTranscriptionJobsResponse Int Source #

The response's http status code.