Amazonka.Transcribe.ListTranscriptionJobs

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

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

Creating a Request

data ListTranscriptionJobs

See: newListTranscriptionJobs smart constructor.

Constructors

ListTranscriptionJobs'

Fields

• jobNameContains :: Maybe Text

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

• maxResults :: Maybe Natural

  The maximum number of 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 ListTranscriptionJobs 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 transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all transcription jobs are returned.

Instances

ToJSON ListTranscriptionJobs

Defined in Amazonka.Transcribe.ListTranscriptionJobs

Methods

toJSON :: ListTranscriptionJobs -> Value

toEncoding :: ListTranscriptionJobs -> Encoding

toJSONList :: [ListTranscriptionJobs] -> Value

toEncodingList :: [ListTranscriptionJobs] -> Encoding

ToHeaders ListTranscriptionJobs

Defined in Amazonka.Transcribe.ListTranscriptionJobs

Methods

toHeaders :: ListTranscriptionJobs -> [Header]

ToPath ListTranscriptionJobs

Defined in Amazonka.Transcribe.ListTranscriptionJobs

Methods

toPath :: ListTranscriptionJobs -> ByteString

ToQuery ListTranscriptionJobs

Defined in Amazonka.Transcribe.ListTranscriptionJobs

Methods

toQuery :: ListTranscriptionJobs -> QueryString

AWSRequest ListTranscriptionJobs

Defined in Amazonka.Transcribe.ListTranscriptionJobs

Associated Types

type AWSResponse ListTranscriptionJobs

Methods

request :: (Service -> Service) -> ListTranscriptionJobs -> Request ListTranscriptionJobs

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListTranscriptionJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTranscriptionJobs)))

Generic ListTranscriptionJobs

Defined in Amazonka.Transcribe.ListTranscriptionJobs

Associated Types

type Rep ListTranscriptionJobs :: Type -> Type

Methods

from :: ListTranscriptionJobs -> Rep ListTranscriptionJobs x

to :: Rep ListTranscriptionJobs x -> ListTranscriptionJobs

Read ListTranscriptionJobs

Defined in Amazonka.Transcribe.ListTranscriptionJobs

Methods

readsPrec :: Int -> ReadS ListTranscriptionJobs

readList :: ReadS [ListTranscriptionJobs]

readPrec :: ReadPrec ListTranscriptionJobs

readListPrec :: ReadPrec [ListTranscriptionJobs]

Show ListTranscriptionJobs

Defined in Amazonka.Transcribe.ListTranscriptionJobs

Methods

showsPrec :: Int -> ListTranscriptionJobs -> ShowS

show :: ListTranscriptionJobs -> String

showList :: [ListTranscriptionJobs] -> ShowS

NFData ListTranscriptionJobs

Defined in Amazonka.Transcribe.ListTranscriptionJobs

Methods

rnf :: ListTranscriptionJobs -> ()

Eq ListTranscriptionJobs

Defined in Amazonka.Transcribe.ListTranscriptionJobs

Methods

(==) :: ListTranscriptionJobs -> ListTranscriptionJobs -> Bool

(/=) :: ListTranscriptionJobs -> ListTranscriptionJobs -> Bool

Hashable ListTranscriptionJobs

Defined in Amazonka.Transcribe.ListTranscriptionJobs

Methods

hashWithSalt :: Int -> ListTranscriptionJobs -> Int

hash :: ListTranscriptionJobs -> Int

type AWSResponse ListTranscriptionJobs

Defined in Amazonka.Transcribe.ListTranscriptionJobs

type AWSResponse ListTranscriptionJobs = ListTranscriptionJobsResponse

type Rep ListTranscriptionJobs

Defined in Amazonka.Transcribe.ListTranscriptionJobs

type Rep ListTranscriptionJobs = D1 ('MetaData "ListTranscriptionJobs" "Amazonka.Transcribe.ListTranscriptionJobs" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "ListTranscriptionJobs'" '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)))))

newListTranscriptionJobs :: ListTranscriptionJobs

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

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

ListTranscriptionJobs, listTranscriptionJobs_nextToken - If your ListTranscriptionJobs 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.

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

Request Lenses

listTranscriptionJobs_jobNameContains :: Lens' ListTranscriptionJobs (Maybe Text)

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

listTranscriptionJobs_maxResults :: Lens' ListTranscriptionJobs (Maybe Natural)

The maximum number of 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.

listTranscriptionJobs_nextToken :: Lens' ListTranscriptionJobs (Maybe Text)

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

listTranscriptionJobs_status :: Lens' ListTranscriptionJobs (Maybe TranscriptionJobStatus)

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

Destructuring the Response

data ListTranscriptionJobsResponse

See: newListTranscriptionJobsResponse smart constructor.

Constructors

ListTranscriptionJobsResponse'

Fields

• 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 transcription jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.

• transcriptionJobSummaries :: Maybe [TranscriptionJobSummary]

  Provides a summary of information about each result.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListTranscriptionJobsResponse

Defined in Amazonka.Transcribe.ListTranscriptionJobs

Associated Types

type Rep ListTranscriptionJobsResponse :: Type -> Type

Methods

from :: ListTranscriptionJobsResponse -> Rep ListTranscriptionJobsResponse x

to :: Rep ListTranscriptionJobsResponse x -> ListTranscriptionJobsResponse

Read ListTranscriptionJobsResponse

Defined in Amazonka.Transcribe.ListTranscriptionJobs

Methods

readsPrec :: Int -> ReadS ListTranscriptionJobsResponse

readList :: ReadS [ListTranscriptionJobsResponse]

readPrec :: ReadPrec ListTranscriptionJobsResponse

readListPrec :: ReadPrec [ListTranscriptionJobsResponse]

Show ListTranscriptionJobsResponse

Defined in Amazonka.Transcribe.ListTranscriptionJobs

Methods

showsPrec :: Int -> ListTranscriptionJobsResponse -> ShowS

show :: ListTranscriptionJobsResponse -> String

showList :: [ListTranscriptionJobsResponse] -> ShowS

NFData ListTranscriptionJobsResponse

Defined in Amazonka.Transcribe.ListTranscriptionJobs

Methods

rnf :: ListTranscriptionJobsResponse -> ()

Eq ListTranscriptionJobsResponse

Defined in Amazonka.Transcribe.ListTranscriptionJobs

Methods

(==) :: ListTranscriptionJobsResponse -> ListTranscriptionJobsResponse -> Bool

(/=) :: ListTranscriptionJobsResponse -> ListTranscriptionJobsResponse -> Bool

type Rep ListTranscriptionJobsResponse

Defined in Amazonka.Transcribe.ListTranscriptionJobs

type Rep ListTranscriptionJobsResponse = D1 ('MetaData "ListTranscriptionJobsResponse" "Amazonka.Transcribe.ListTranscriptionJobs" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "ListTranscriptionJobsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TranscriptionJobStatus))) :*: (S1 ('MetaSel ('Just "transcriptionJobSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TranscriptionJobSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTranscriptionJobsResponse

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:

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

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

$sel:transcriptionJobSummaries:ListTranscriptionJobsResponse', listTranscriptionJobsResponse_transcriptionJobSummaries - Provides a summary of information about each result.

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

Response Lenses

listTranscriptionJobsResponse_nextToken :: Lens' ListTranscriptionJobsResponse (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.

listTranscriptionJobsResponse_status :: Lens' ListTranscriptionJobsResponse (Maybe TranscriptionJobStatus)

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

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

Provides a summary of information about each result.

listTranscriptionJobsResponse_httpStatus :: Lens' ListTranscriptionJobsResponse Int

The response's http status code.