URI HTTP methods Schemas Properties See also

JobsQueries

URI

/2017-08-29/jobsQueries

HTTP methods

POST

Operation ID: StartJobsQuery

Start an asynchronous jobs query using the provided filters. To receive the list of jobs that match your query, call the GetJobsQueryResults API using the query ID returned by this API.

Responses
Status code	Response model	Description
`201`	`StartJobsQueryResponse`	201 response
`400`	`ExceptionBody`	The service can't process your request because of a problem in the request. Please check your request form and syntax.
`402`	`ExceptionBody`	You attempted to create more resources than the service allows based on service quotas.
`403`	`ExceptionBody`	You don't have permissions for this action with the credentials you sent.
`404`	`ExceptionBody`	The resource you requested does not exist.
`409`	`ExceptionBody`	The service could not complete your request because there is a conflict with the current state of the resource.
`429`	`ExceptionBody`	Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.
`500`	`ExceptionBody`	The service encountered an unexpected condition and cannot fulfill your request.

OPTIONS

Supports CORS preflight requests.

Responses
Status code	Response model	Description
`200`	None	The request completed successfully.

Schemas

Request bodies


{
  "nextToken": "string",
  "order": enum,
  "maxResults": integer,
  "filterList": [
    {
      "key": enum,
      "values": [
        "string"
      ]
    }
  ]
}

Response bodies


{
  "id": "string"
}


{
  "message": "string"
}

Properties

ExceptionBody

Property	Type	Required	Description
`message`	string	False

JobsQueryFilter

Provide one or more JobsQueryFilter objects, each containing a Key with an associated Values array. Note that MediaConvert queries jobs using OR logic.

Property Type Required Description

Property	Type	Required	Description
`key`	JobsQueryFilterKey	False	Specify job details to filter for while performing a jobs query. You specify these filters as part of a key-value pair within the JobsQueryFilter array. The following list describes which keys are available and their possible values: * queue - Your Queue's name or ARN. * status - Your job's status. (SUBMITTED \| PROGRESSING \| COMPLETE \| CANCELED \| ERROR) * fileInput - Your input file URL, or partial input file name. * jobEngineVersionRequested - The Job engine version that you requested for your job. Valid versions are in a YYYY-MM-DD format. * jobEngineVersionUsed - The Job engine version that your job used. This may differ from the version that you requested. Valid versions are in a YYYY-MM-DD format. * audioCodec - Your output's audio codec. (AAC \| MP2 \| MP3 \| WAV \| AIFF \| AC3\| EAC3 \| EAC3_ATMOS \| VORBIS \| OPUS \| PASSTHROUGH \| FLAC) * videoCodec - Your output's video codec. (AV1 \| AVC_INTRA \| FRAME_CAPTURE \| H_264 \| H_265 \| MPEG2 \| PASSTHROUGH \| PRORES \| UNCOMPRESSED \| VC3 \| VP8 \| VP9 \| XAVC)
`values`	Array of type string MaxLength: 100	False	A list of values associated with a JobsQueryFilterKey.

key

JobsQueryFilterKey

False

values

Array of type string

MaxLength: 100

False

A list of values associated with a JobsQueryFilterKey.

JobsQueryFilterKey

queue
status
fileInput
jobEngineVersionRequested
jobEngineVersionUsed
audioCodec
videoCodec

Order

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

ASCENDING
DESCENDING

StartJobsQueryRequest

Start an asynchronous jobs query using the provided filters. To receive the list of jobs that match your query, call the GetJobsQueryResults API using the query ID returned by this API.

Property	Type	Required	Description
`filterList`	Array of type JobsQueryFilter	False	Optional. Provide an array of JobsQueryFilters for your StartJobsQuery request.
`maxResults`	integer Format: int32 Minimum: 1 Maximum: 20	False	Optional. Number of jobs, up to twenty, that will be included in the jobs query.
`nextToken`	string	False	Use this string to request the next batch of jobs matched by a jobs query.
`order`	Order	False	Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

StartJobsQueryResponse

Successful requests return an ID that corresponds to an asynchronous jobs query.

Property	Type	Required	Description
`id`	string	False	The ID of the jobs query.