You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::TranscribeService::Types::ListTranscriptionJobsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListTranscriptionJobsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  status: "IN_PROGRESS", # accepts IN_PROGRESS, FAILED, COMPLETED
  job_name_contains: "TranscriptionJobName",
  next_token: "NextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#job_name_containsString

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

Returns:

  • (String)

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

#max_resultsInteger

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.

Returns:

  • (Integer)

    The maximum number of jobs to return in the response.

#next_tokenString

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

Returns:

  • (String)

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

#statusString

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.

Possible values:

  • IN_PROGRESS
  • FAILED
  • COMPLETED

Returns:

  • (String)

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