MediaConvert / Client / start_jobs_query

start_jobs_query

MediaConvert.Client.start_jobs_query(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.start_jobs_query(
    FilterList=[
        {
            'Key': 'queue'|'status'|'fileInput'|'jobEngineVersionRequested'|'jobEngineVersionUsed'|'audioCodec'|'videoCodec',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    Order='ASCENDING'|'DESCENDING'
)
Parameters:

  • FilterList (list) –

    Optional. Provide an array of JobsQueryFilters for your StartJobsQuery request.

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

      • Key (string) – 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 (list) – A list of values associated with a JobsQueryFilterKey.

        • (string) –

  • MaxResults (integer) – Optional. Number of jobs, up to twenty, that will be included in the jobs query.

  • NextToken (string) – Use this string to request the next batch of jobs matched by a jobs query.

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'Id': 'string'
}

Response Structure

  • (dict) –

    • Id (string) – The ID of the jobs query.

Exceptions