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

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

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

Overview

Note:

When passing ListJobsRequest as input to an Aws::Client method, you can use a vanilla 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.

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)

    Optional.

#next_tokenString

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

Returns:

  • (String)

    Optional.

#orderString

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

Possible values:

  • ASCENDING
  • DESCENDING

Returns:

  • (String)

    Optional.

#queueString

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

Returns:

  • (String)

    Optional.

#statusString

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

Possible values:

  • SUBMITTED
  • PROGRESSING
  • COMPLETE
  • CANCELED
  • ERROR

Returns:

  • (String)

    Optional.