amazonka-transcribe-1.6.0: Amazon Transcribe Service SDK.

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

Network.AWS.Transcribe.ListTranscriptionJobs

Contents

Description

Lists transcription jobs with the specified status.

Synopsis

Creating a Request

listTranscriptionJobs :: ListTranscriptionJobs Source #

Creates a value of ListTranscriptionJobs with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ltjStatus - When specified, returns only transcription jobs with the specified status.
  • ltjNextToken - If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.
  • ltjJobNameContains - When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
  • ltjMaxResults - The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

data ListTranscriptionJobs Source #

See: listTranscriptionJobs smart constructor.

Instances

Eq ListTranscriptionJobs Source # 
Data ListTranscriptionJobs Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListTranscriptionJobs -> c ListTranscriptionJobs #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListTranscriptionJobs #

toConstr :: ListTranscriptionJobs -> Constr #

dataTypeOf :: ListTranscriptionJobs -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListTranscriptionJobs) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListTranscriptionJobs) #

gmapT :: (forall b. Data b => b -> b) -> ListTranscriptionJobs -> ListTranscriptionJobs #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListTranscriptionJobs -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListTranscriptionJobs -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListTranscriptionJobs -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListTranscriptionJobs -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListTranscriptionJobs -> m ListTranscriptionJobs #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTranscriptionJobs -> m ListTranscriptionJobs #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTranscriptionJobs -> m ListTranscriptionJobs #

Read ListTranscriptionJobs Source # 
Show ListTranscriptionJobs Source # 
Generic ListTranscriptionJobs Source # 
Hashable ListTranscriptionJobs Source # 
ToJSON ListTranscriptionJobs Source # 
NFData ListTranscriptionJobs Source # 

Methods

rnf :: ListTranscriptionJobs -> () #

AWSRequest ListTranscriptionJobs Source # 
ToHeaders ListTranscriptionJobs Source # 
ToPath ListTranscriptionJobs Source # 
ToQuery ListTranscriptionJobs Source # 
type Rep ListTranscriptionJobs Source # 
type Rep ListTranscriptionJobs = D1 * (MetaData "ListTranscriptionJobs" "Network.AWS.Transcribe.ListTranscriptionJobs" "amazonka-transcribe-1.6.0-EAJHmFqYXYhFnJ8LH2D7KC" False) (C1 * (MetaCons "ListTranscriptionJobs'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ltjStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe TranscriptionJobStatus))) (S1 * (MetaSel (Just Symbol "_ltjNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ltjJobNameContains") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ltjMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))
type Rs ListTranscriptionJobs Source # 

Request Lenses

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

When specified, returns only transcription jobs with the specified status.

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

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

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

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

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

The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Destructuring the Response

listTranscriptionJobsResponse Source #

Creates a value of ListTranscriptionJobsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ltjrsStatus - The requested status of the jobs returned.
  • ltjrsNextToken - 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.
  • ltjrsTranscriptionJobSummaries - A list of objects containing summary information for a transcription job.
  • ltjrsResponseStatus - -- | The response status code.

data ListTranscriptionJobsResponse Source #

See: listTranscriptionJobsResponse smart constructor.

Instances

Eq ListTranscriptionJobsResponse Source # 
Data ListTranscriptionJobsResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListTranscriptionJobsResponse -> c ListTranscriptionJobsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListTranscriptionJobsResponse #

toConstr :: ListTranscriptionJobsResponse -> Constr #

dataTypeOf :: ListTranscriptionJobsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListTranscriptionJobsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListTranscriptionJobsResponse) #

gmapT :: (forall b. Data b => b -> b) -> ListTranscriptionJobsResponse -> ListTranscriptionJobsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListTranscriptionJobsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListTranscriptionJobsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListTranscriptionJobsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListTranscriptionJobsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListTranscriptionJobsResponse -> m ListTranscriptionJobsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTranscriptionJobsResponse -> m ListTranscriptionJobsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTranscriptionJobsResponse -> m ListTranscriptionJobsResponse #

Read ListTranscriptionJobsResponse Source # 
Show ListTranscriptionJobsResponse Source # 
Generic ListTranscriptionJobsResponse Source # 
NFData ListTranscriptionJobsResponse Source # 
type Rep ListTranscriptionJobsResponse Source # 
type Rep ListTranscriptionJobsResponse = D1 * (MetaData "ListTranscriptionJobsResponse" "Network.AWS.Transcribe.ListTranscriptionJobs" "amazonka-transcribe-1.6.0-EAJHmFqYXYhFnJ8LH2D7KC" False) (C1 * (MetaCons "ListTranscriptionJobsResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ltjrsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe TranscriptionJobStatus))) (S1 * (MetaSel (Just Symbol "_ltjrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ltjrsTranscriptionJobSummaries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [TranscriptionJobSummary]))) (S1 * (MetaSel (Just Symbol "_ltjrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

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

The requested status of the jobs returned.

ltjrsNextToken :: 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.

ltjrsTranscriptionJobSummaries :: Lens' ListTranscriptionJobsResponse [TranscriptionJobSummary] Source #

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