Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Lists transcription jobs with the specified status.
Synopsis
- listTranscriptionJobs :: ListTranscriptionJobs
- data ListTranscriptionJobs
- ltjStatus :: Lens' ListTranscriptionJobs (Maybe TranscriptionJobStatus)
- ltjNextToken :: Lens' ListTranscriptionJobs (Maybe Text)
- ltjJobNameContains :: Lens' ListTranscriptionJobs (Maybe Text)
- ltjMaxResults :: Lens' ListTranscriptionJobs (Maybe Natural)
- listTranscriptionJobsResponse :: Int -> ListTranscriptionJobsResponse
- data ListTranscriptionJobsResponse
- ltjrsStatus :: Lens' ListTranscriptionJobsResponse (Maybe TranscriptionJobStatus)
- ltjrsNextToken :: Lens' ListTranscriptionJobsResponse (Maybe Text)
- ltjrsTranscriptionJobSummaries :: Lens' ListTranscriptionJobsResponse [TranscriptionJobSummary]
- ltjrsResponseStatus :: Lens' ListTranscriptionJobsResponse Int
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 toListTranscriptionJobs
was truncated, include theNextToken
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
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
- TheListTranscriptionJobs
operation returns a page of jobs at a time. The maximum size of the page is set by theMaxResults
parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns theNextPage
token. Include the token in the next request to theListTranscriptionJobs
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
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.
ltjrsResponseStatus :: Lens' ListTranscriptionJobsResponse Int Source #
- - | The response status code.