Class: Aws::MediaConvert::Types::SearchJobsRequest

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

Overview

Retrieve a JSON array that includes job details for up to twenty of your most recent jobs. Optionally filter results further according to input file, queue, or status. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array. Note that SearchJobs has been deprecated. We recommend that you instead use the StartJobsQuery and GetJobsQueryResults APIs to query your job history.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#input_file ⇒ String

Optional. Provide your input file URL or your partial input file name. The maximum length for an input file is 300 characters.

Returns:

  • (String)


14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 14594

class SearchJobsRequest < Struct.new(
  :input_file,
  :max_results,
  :next_token,
  :order,
  :queue,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

Optional. Number of jobs, up to twenty, that will be returned at one time.

Returns:

  • (Integer)


14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 14594

class SearchJobsRequest < Struct.new(
  :input_file,
  :max_results,
  :next_token,
  :order,
  :queue,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.

Returns:

  • (String)


14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 14594

class SearchJobsRequest < Struct.new(
  :input_file,
  :max_results,
  :next_token,
  :order,
  :queue,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#order ⇒ String

Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

Returns:

  • (String)


14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 14594

class SearchJobsRequest < Struct.new(
  :input_file,
  :max_results,
  :next_token,
  :order,
  :queue,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#queue ⇒ String

Optional. Provide a queue name, or a queue ARN, to return only jobs from that queue.

Returns:

  • (String)


14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 14594

class SearchJobsRequest < Struct.new(
  :input_file,
  :max_results,
  :next_token,
  :order,
  :queue,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

Returns:

  • (String)


14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 14594

class SearchJobsRequest < Struct.new(
  :input_file,
  :max_results,
  :next_token,
  :order,
  :queue,
  :status)
  SENSITIVE = []
  include Aws::Structure
end