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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb

Overview

Note:

When making an API call, you may pass ListTranscriptionJobsRequest data as a 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)


214
215
216
217
218
219
220
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 214

class ListTranscriptionJobsRequest < Struct.new(
  :status,
  :job_name_contains,
  :next_token,
  :max_results)
  include Aws::Structure
end

#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)


214
215
216
217
218
219
220
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 214

class ListTranscriptionJobsRequest < Struct.new(
  :status,
  :job_name_contains,
  :next_token,
  :max_results)
  include Aws::Structure
end

#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)


214
215
216
217
218
219
220
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 214

class ListTranscriptionJobsRequest < Struct.new(
  :status,
  :job_name_contains,
  :next_token,
  :max_results)
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


214
215
216
217
218
219
220
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 214

class ListTranscriptionJobsRequest < Struct.new(
  :status,
  :job_name_contains,
  :next_token,
  :max_results)
  include Aws::Structure
end