Class: Aws::MediaConvert::Types::ListJobsRequest

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

Overview

Note:

When making an API call, you may pass ListJobsRequest data as a hash:

{
  max_results: 1,
  next_token: "__string",
  order: "ASCENDING", # accepts ASCENDING, DESCENDING
  queue: "__string",
  status: "SUBMITTED", # accepts SUBMITTED, PROGRESSING, COMPLETE, CANCELED, ERROR
}

You can send list jobs requests with an empty body. Optionally, you can filter the response by queue and/or job status by specifying them in your request body. You can also optionally specify the maximum number, up to twenty, of jobs to be returned.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

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

Returns:

  • (Integer)


12465
12466
12467
12468
12469
12470
12471
12472
12473
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12465

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

#next_tokenString

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

Returns:

  • (String)


12465
12466
12467
12468
12469
12470
12471
12472
12473
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12465

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

#orderString

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)


12465
12466
12467
12468
12469
12470
12471
12472
12473
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12465

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

#queueString

Optional. Provide a queue name to get back only jobs from that queue.

Returns:

  • (String)


12465
12466
12467
12468
12469
12470
12471
12472
12473
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12465

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

#statusString

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

Returns:

  • (String)


12465
12466
12467
12468
12469
12470
12471
12472
12473
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12465

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