jobs

Creates, updates, deletes, gets or lists a jobs resource.

Overview

Name	jobs
Type	Resource
Id	aws.mediaconvert.jobs

Fields

The following fields are returned by SELECT queries:

get_job

Name	Datatype	Description
acceleration_settings	object	Accelerated transcoding can significantly speed up jobs with long, visually complex content.
acceleration_status	string	Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED. (NOT_APPLICABLE, IN_PROGRESS, ACCELERATED, NOT_ACCELERATED)
arn	string	An identifier for this resource that is unique within all of AWS.
billing_tags_source	string	The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. (QUEUE, PRESET, JOB_TEMPLATE, JOB)
client_request_token	string	Prevent duplicate jobs from being created and ensure idempotency for your requests. A client request token can be any string that includes up to 64 ASCII characters. If you reuse a client request token within one minute of a successful request, the API returns the job details of the original request instead. For more information see https:​//docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html.
created_at	string (date-time)	The time, in Unix epoch format in seconds, when the job got created.
current_phase	string	A job's phase can be PROBING, TRANSCODING OR UPLOADING (PROBING, TRANSCODING, UPLOADING)
elemental_inference_configuration	object	The Elemental Inference configuration used in this job.
error_code	integer	Error code for the job
error_message	string	Error message of Job
hop_destinations	array	Optional list of hop destinations.
id	string	A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources
job_engine_version_requested	string	The Job engine version that you requested for your job. Valid versions are in a YYYY-MM-DD format.
job_engine_version_used	string	The Job engine version that your job used. Job engine versions are in a YYYY-MM-DD format. When you request an expired version, the response for this property will be empty. Requests to create jobs with an expired version result in a regular job, as if no specific Job engine version was requested. When you request an invalid version, the response for this property will be empty. Requests to create jobs with an invalid version result in a 400 error message, and no job is created.
job_percent_complete	integer	An estimate of how far your job has progressed. This estimate is shown as a percentage of the total time from when your job leaves its queue to when your output files appear in your output Amazon S3 bucket. AWS Elemental MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and in the response to GetJob and ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime, Transport Stream, MP4, and MXF. For some jobs, the service can't provide information about job progress. In those cases, jobPercentComplete returns a null value.
job_template	string	The job template that the job is created from, if it is created from a job template.
last_share_details	string	Contains information about the most recent share attempt for the job. For more information, see https:​//docs.aws.amazon.com/mediaconvert/latest/ug/creating-resource-share.html
messages	object	Provides messages from the service about jobs that you have already successfully submitted.
output_group_details	array	List of output group details
priority	integer	Relative priority on the job.
queue	string	When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at https:​//docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
queue_transitions	array	The job's queue hopping history.
retry_count	integer	The number of times that the service automatically attempted to process your job after encountering an error.
role	string	The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at https:​//docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html
settings	object	JobSettings contains all the transcode settings for a job.
share_status	string	A job's share status can be NOT_SHARED, INITIATED, or SHARED (NOT_SHARED, INITIATED, SHARED)
simulate_reserved_queue	string	Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default. (DISABLED, ENABLED)
status	string	A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR. (SUBMITTED, PROGRESSING, COMPLETE, CANCELED, ERROR)
status_update_interval	string	Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error. (SECONDS_10, SECONDS_12, SECONDS_15, SECONDS_20, SECONDS_30, SECONDS_60, SECONDS_120, SECONDS_180, SECONDS_240, SECONDS_300, SECONDS_360, SECONDS_420, SECONDS_480, SECONDS_540, SECONDS_600)
timing	object	Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
user_metadata	object	User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.
warnings	array	Contains any warning messages for the job. Use to help identify potential issues with your input, output, or job. For more information, see https:​//docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html

list_jobs

Name	Datatype	Description
acceleration_settings	object	Accelerated transcoding can significantly speed up jobs with long, visually complex content.
acceleration_status	string	Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED. (NOT_APPLICABLE, IN_PROGRESS, ACCELERATED, NOT_ACCELERATED)
arn	string	An identifier for this resource that is unique within all of AWS.
billing_tags_source	string	The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. (QUEUE, PRESET, JOB_TEMPLATE, JOB)
client_request_token	string	Prevent duplicate jobs from being created and ensure idempotency for your requests. A client request token can be any string that includes up to 64 ASCII characters. If you reuse a client request token within one minute of a successful request, the API returns the job details of the original request instead. For more information see https:​//docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html.
created_at	string (date-time)	The time, in Unix epoch format in seconds, when the job got created.
current_phase	string	A job's phase can be PROBING, TRANSCODING OR UPLOADING (PROBING, TRANSCODING, UPLOADING)
elemental_inference_configuration	object	The Elemental Inference configuration used in this job.
error_code	integer	Error code for the job
error_message	string	Error message of Job
hop_destinations	array	Optional list of hop destinations.
id	string	A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources
job_engine_version_requested	string	The Job engine version that you requested for your job. Valid versions are in a YYYY-MM-DD format.
job_engine_version_used	string	The Job engine version that your job used. Job engine versions are in a YYYY-MM-DD format. When you request an expired version, the response for this property will be empty. Requests to create jobs with an expired version result in a regular job, as if no specific Job engine version was requested. When you request an invalid version, the response for this property will be empty. Requests to create jobs with an invalid version result in a 400 error message, and no job is created.
job_percent_complete	integer	An estimate of how far your job has progressed. This estimate is shown as a percentage of the total time from when your job leaves its queue to when your output files appear in your output Amazon S3 bucket. AWS Elemental MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and in the response to GetJob and ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime, Transport Stream, MP4, and MXF. For some jobs, the service can't provide information about job progress. In those cases, jobPercentComplete returns a null value.
job_template	string	The job template that the job is created from, if it is created from a job template.
last_share_details	string	Contains information about the most recent share attempt for the job. For more information, see https:​//docs.aws.amazon.com/mediaconvert/latest/ug/creating-resource-share.html
messages	object	Provides messages from the service about jobs that you have already successfully submitted.
output_group_details	array	List of output group details
priority	integer	Relative priority on the job.
queue	string	When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at https:​//docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
queue_transitions	array	The job's queue hopping history.
retry_count	integer	The number of times that the service automatically attempted to process your job after encountering an error.
role	string	The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at https:​//docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html
settings	object	JobSettings contains all the transcode settings for a job.
share_status	string	A job's share status can be NOT_SHARED, INITIATED, or SHARED (NOT_SHARED, INITIATED, SHARED)
simulate_reserved_queue	string	Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default. (DISABLED, ENABLED)
status	string	A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR. (SUBMITTED, PROGRESSING, COMPLETE, CANCELED, ERROR)
status_update_interval	string	Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error. (SECONDS_10, SECONDS_12, SECONDS_15, SECONDS_20, SECONDS_30, SECONDS_60, SECONDS_120, SECONDS_180, SECONDS_240, SECONDS_300, SECONDS_360, SECONDS_420, SECONDS_480, SECONDS_540, SECONDS_600)
timing	object	Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
user_metadata	object	User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.
warnings	array	Contains any warning messages for the job. Use to help identify potential issues with your input, output, or job. For more information, see https:​//docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_job	select	id, region		Retrieve the JSON for a specific transcoding job.
list_jobs	select	region	maxResults, nextToken, order, queue, status	Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array.
create_resource_share	insert	region, JobId, SupportCaseId		Create a new resource share request for MediaConvert resources with AWS Support.
create_job	insert	region		Create a new transcoding job. For information about jobs and job settings, see the User Guide at http:​//docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
search_jobs	exec	region	inputFile, maxResults, nextToken, order, queue, status	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.
start_jobs_query	exec	region		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	the job ID of the job.
region	string	AWS region (default: us-east-1)
inputFile	string	Optional. Provide your input file URL or your partial input file name. The maximum length for an input file is 300 characters.
maxResults	integer	Optional. Number of jobs, up to twenty, that will be returned at one time.
nextToken	string	Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.
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.
queue	string	Optional. Provide a queue name, or a queue ARN, to return only jobs from that queue.
status	string	Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

SELECT examples

get_job

Retrieve the JSON for a specific transcoding job.

SELECT
acceleration_settings,
acceleration_status,
arn,
billing_tags_source,
client_request_token,
created_at,
current_phase,
elemental_inference_configuration,
error_code,
error_message,
hop_destinations,
id,
job_engine_version_requested,
job_engine_version_used,
job_percent_complete,
job_template,
last_share_details,
messages,
output_group_details,
priority,
queue,
queue_transitions,
retry_count,
role,
settings,
share_status,
simulate_reserved_queue,
status,
status_update_interval,
timing,
user_metadata,
warnings
FROM aws.mediaconvert.jobs
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_jobs

Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array.

SELECT
acceleration_settings,
acceleration_status,
arn,
billing_tags_source,
client_request_token,
created_at,
current_phase,
elemental_inference_configuration,
error_code,
error_message,
hop_destinations,
id,
job_engine_version_requested,
job_engine_version_used,
job_percent_complete,
job_template,
last_share_details,
messages,
output_group_details,
priority,
queue,
queue_transitions,
retry_count,
role,
settings,
share_status,
simulate_reserved_queue,
status,
status_update_interval,
timing,
user_metadata,
warnings
FROM aws.mediaconvert.jobs
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND order = '{{ order }}'
AND queue = '{{ queue }}'
AND status = '{{ status }}'
;

INSERT examples

create_resource_share

Create a new resource share request for MediaConvert resources with AWS Support.

INSERT INTO aws.mediaconvert.jobs (
JobId,
SupportCaseId,
region
)
SELECT 
'{{ JobId }}' /* required */,
'{{ SupportCaseId }}' /* required */,
'{{ region }}'
;

create_job

Create a new transcoding job. For information about jobs and job settings, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

INSERT INTO aws.mediaconvert.jobs (
AccelerationSettings,
BillingTagsSource,
ClientRequestToken,
HopDestinations,
JobEngineVersion,
JobTemplate,
Priority,
Queue,
Role,
Settings,
SimulateReservedQueue,
StatusUpdateInterval,
Tags,
UserMetadata,
region
)
SELECT 
'{{ AccelerationSettings }}',
'{{ BillingTagsSource }}',
'{{ ClientRequestToken }}',
'{{ HopDestinations }}',
'{{ JobEngineVersion }}',
'{{ JobTemplate }}',
{{ Priority }},
'{{ Queue }}',
'{{ Role }}',
'{{ Settings }}',
'{{ SimulateReservedQueue }}',
'{{ StatusUpdateInterval }}',
'{{ Tags }}',
'{{ UserMetadata }}',
'{{ region }}'
RETURNING
job
;

Manifest

# Description fields are for documentation purposes
- name: jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the jobs resource.
  - name: JobId
    value: "{{ JobId }}"
  - name: SupportCaseId
    value: "{{ SupportCaseId }}"
  - name: AccelerationSettings
    description: |
      Accelerated transcoding can significantly speed up jobs with long, visually complex content.
    value:
      Mode: "{{ Mode }}"
  - name: BillingTagsSource
    value: "{{ BillingTagsSource }}"
    description: |
      The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.
    valid_values: ['QUEUE', 'PRESET', 'JOB_TEMPLATE', 'JOB']
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
  - name: HopDestinations
    value:
      - Priority: {{ Priority }}
        Queue: "{{ Queue }}"
        WaitMinutes: {{ WaitMinutes }}
  - name: JobEngineVersion
    value: "{{ JobEngineVersion }}"
  - name: JobTemplate
    value: "{{ JobTemplate }}"
  - name: Priority
    value: {{ Priority }}
  - name: Queue
    value: "{{ Queue }}"
  - name: Role
    value: "{{ Role }}"
  - name: Settings
    description: |
      JobSettings contains all the transcode settings for a job.
    value:
      AdAvailOffset: {{ AdAvailOffset }}
      AvailBlanking:
        AvailBlankingImage: "{{ AvailBlankingImage }}"
      ColorConversion3DLUTSettings:
        - FileInput: "{{ FileInput }}"
          InputColorSpace: "{{ InputColorSpace }}"
          InputMasteringLuminance: {{ InputMasteringLuminance }}
          OutputColorSpace: "{{ OutputColorSpace }}"
          OutputMasteringLuminance: {{ OutputMasteringLuminance }}
      Esam:
        ManifestConfirmConditionNotification:
          MccXml: "{{ MccXml }}"
        ResponseSignalPreroll: {{ ResponseSignalPreroll }}
        SignalProcessingNotification:
          SccXml: "{{ SccXml }}"
      ExtendedDataServices:
        CopyProtectionAction: "{{ CopyProtectionAction }}"
        VchipAction: "{{ VchipAction }}"
      FollowSource: {{ FollowSource }}
      Inputs:
        - AdvancedInputFilter: "{{ AdvancedInputFilter }}"
          AdvancedInputFilterSettings:
            AddTexture: "{{ AddTexture }}"
            Sharpening: "{{ Sharpening }}"
          AudioSelectorGroups: "{{ AudioSelectorGroups }}"
          AudioSelectors: "{{ AudioSelectors }}"
          CaptionSelectors: "{{ CaptionSelectors }}"
          Crop:
            Height: {{ Height }}
            Width: {{ Width }}
            X: {{ X }}
            Y: {{ Y }}
          DeblockFilter: "{{ DeblockFilter }}"
          DecryptionSettings:
            DecryptionMode: "{{ DecryptionMode }}"
            EncryptedDecryptionKey: "{{ EncryptedDecryptionKey }}"
            InitializationVector: "{{ InitializationVector }}"
            KmsKeyRegion: "{{ KmsKeyRegion }}"
          DenoiseFilter: "{{ DenoiseFilter }}"
          DolbyVisionMetadataXml: "{{ DolbyVisionMetadataXml }}"
          DynamicAudioSelectors: "{{ DynamicAudioSelectors }}"
          FileInput: "{{ FileInput }}"
          FilterEnable: "{{ FilterEnable }}"
          FilterStrength: {{ FilterStrength }}
          ImageInserter:
            InsertableImages:
              - Duration: {{ Duration }}
                FadeIn: {{ FadeIn }}
                FadeOut: {{ FadeOut }}
                Height: {{ Height }}
                ImageInserterInput: "{{ ImageInserterInput }}"
                ImageX: {{ ImageX }}
                ImageY: {{ ImageY }}
                Layer: {{ Layer }}
                Opacity: {{ Opacity }}
                StartTime: "{{ StartTime }}"
                Width: {{ Width }}
            SdrReferenceWhiteLevel: {{ SdrReferenceWhiteLevel }}
          InputClippings: "{{ InputClippings }}"
          InputScanType: "{{ InputScanType }}"
          MultiViewSettings: "{{ MultiViewSettings }}"
          Position:
            Height: {{ Height }}
            Width: {{ Width }}
            X: {{ X }}
            Y: {{ Y }}
          ProgramNumber: {{ ProgramNumber }}
          PsiControl: "{{ PsiControl }}"
          SupplementalImps: "{{ SupplementalImps }}"
          TamsSettings:
            AuthConnectionArn: "{{ AuthConnectionArn }}"
            GapHandling: "{{ GapHandling }}"
            SourceId: "{{ SourceId }}"
            Timerange: "{{ Timerange }}"
          TimecodeSource: "{{ TimecodeSource }}"
          TimecodeStart: "{{ TimecodeStart }}"
          VideoGenerator:
            Channels: {{ Channels }}
            Duration: {{ Duration }}
            FramerateDenominator: {{ FramerateDenominator }}
            FramerateNumerator: {{ FramerateNumerator }}
            Height: {{ Height }}
            ImageInput: "{{ ImageInput }}"
            SampleRate: {{ SampleRate }}
            Width: {{ Width }}
          VideoOverlays: "{{ VideoOverlays }}"
          VideoSelector:
            AlphaBehavior: "{{ AlphaBehavior }}"
            ColorSpace: "{{ ColorSpace }}"
            ColorSpaceUsage: "{{ ColorSpaceUsage }}"
            EmbeddedTimecodeOverride: "{{ EmbeddedTimecodeOverride }}"
            Hdr10Metadata:
              BluePrimaryX: {{ BluePrimaryX }}
              BluePrimaryY: {{ BluePrimaryY }}
              GreenPrimaryX: {{ GreenPrimaryX }}
              GreenPrimaryY: {{ GreenPrimaryY }}
              MaxContentLightLevel: {{ MaxContentLightLevel }}
              MaxFrameAverageLightLevel: {{ MaxFrameAverageLightLevel }}
              MaxLuminance: {{ MaxLuminance }}
              MinLuminance: {{ MinLuminance }}
              RedPrimaryX: {{ RedPrimaryX }}
              RedPrimaryY: {{ RedPrimaryY }}
              WhitePointX: {{ WhitePointX }}
              WhitePointY: {{ WhitePointY }}
            MaxLuminance: {{ MaxLuminance }}
            PadVideo: "{{ PadVideo }}"
            Pid: {{ Pid }}
            ProgramNumber: {{ ProgramNumber }}
            Rotate: "{{ Rotate }}"
            SampleRange: "{{ SampleRange }}"
            SelectorType: "{{ SelectorType }}"
            Streams:
              - {{ Streams }}
      KantarWatermark:
        ChannelName: "{{ ChannelName }}"
        ContentReference: "{{ ContentReference }}"
        CredentialsSecretName: "{{ CredentialsSecretName }}"
        FileOffset: {{ FileOffset }}
        KantarLicenseId: {{ KantarLicenseId }}
        KantarServerUrl: "{{ KantarServerUrl }}"
        LogDestination: "{{ LogDestination }}"
        Metadata3: "{{ Metadata3 }}"
        Metadata4: "{{ Metadata4 }}"
        Metadata5: "{{ Metadata5 }}"
        Metadata6: "{{ Metadata6 }}"
        Metadata7: "{{ Metadata7 }}"
        Metadata8: "{{ Metadata8 }}"
      MotionImageInserter:
        Framerate:
          FramerateDenominator: {{ FramerateDenominator }}
          FramerateNumerator: {{ FramerateNumerator }}
        Input: "{{ Input }}"
        InsertionMode: "{{ InsertionMode }}"
        Offset:
          ImageX: {{ ImageX }}
          ImageY: {{ ImageY }}
        Playback: "{{ Playback }}"
        StartTime: "{{ StartTime }}"
      NielsenConfiguration:
        BreakoutCode: {{ BreakoutCode }}
        DistributorId: "{{ DistributorId }}"
      NielsenNonLinearWatermark:
        ActiveWatermarkProcess: "{{ ActiveWatermarkProcess }}"
        AdiFilename: "{{ AdiFilename }}"
        AssetId: "{{ AssetId }}"
        AssetName: "{{ AssetName }}"
        CbetSourceId: "{{ CbetSourceId }}"
        EpisodeId: "{{ EpisodeId }}"
        MetadataDestination: "{{ MetadataDestination }}"
        SourceId: {{ SourceId }}
        SourceWatermarkStatus: "{{ SourceWatermarkStatus }}"
        TicServerUrl: "{{ TicServerUrl }}"
        UniqueTicPerAudioTrack: "{{ UniqueTicPerAudioTrack }}"
      OutputGroups:
        - AutomatedEncodingSettings:
            AbrSettings:
              MaxAbrBitrate: {{ MaxAbrBitrate }}
              MaxQualityLevel: {{ MaxQualityLevel }}
              MaxRenditions: {{ MaxRenditions }}
              MinAbrBitrate: {{ MinAbrBitrate }}
              Rules:
                - AllowedRenditions: "{{ AllowedRenditions }}"
                  ForceIncludeRenditions: "{{ ForceIncludeRenditions }}"
                  MinBottomRenditionSize:
                    Height: {{ Height }}
                    Width: {{ Width }}
                  MinTopRenditionSize:
                    Height: {{ Height }}
                    Width: {{ Width }}
                  Type: "{{ Type }}"
          CustomName: "{{ CustomName }}"
          Name: "{{ Name }}"
          OutputGroupSettings:
            CmafGroupSettings:
              AdditionalManifests:
                - ManifestNameModifier: "{{ ManifestNameModifier }}"
                  SelectedOutputs: "{{ SelectedOutputs }}"
              BaseUrl: "{{ BaseUrl }}"
              ClientCache: "{{ ClientCache }}"
              CodecSpecification: "{{ CodecSpecification }}"
              DashIFrameTrickPlayNameModifier: "{{ DashIFrameTrickPlayNameModifier }}"
              DashManifestStyle: "{{ DashManifestStyle }}"
              Destination: "{{ Destination }}"
              DestinationSettings:
                S3Settings: "{{ S3Settings }}"
              Encryption:
                ClearLeadSegments: {{ ClearLeadSegments }}
                ConstantInitializationVector: "{{ ConstantInitializationVector }}"
                EncryptionMethod: "{{ EncryptionMethod }}"
                InitializationVectorInManifest: "{{ InitializationVectorInManifest }}"
                SpekeKeyProvider: "{{ SpekeKeyProvider }}"
                StaticKeyProvider: "{{ StaticKeyProvider }}"
                Type: "{{ Type }}"
              FragmentLength: {{ FragmentLength }}
              ImageBasedTrickPlay: "{{ ImageBasedTrickPlay }}"
              ImageBasedTrickPlaySettings:
                IntervalCadence: "{{ IntervalCadence }}"
                ThumbnailHeight: {{ ThumbnailHeight }}
                ThumbnailInterval: {{ ThumbnailInterval }}
                ThumbnailWidth: {{ ThumbnailWidth }}
                TileHeight: {{ TileHeight }}
                TileWidth: {{ TileWidth }}
              ImageBasedTrickPlayVariants:
                - IntervalCadence: "{{ IntervalCadence }}"
                  ThumbnailHeight: {{ ThumbnailHeight }}
                  ThumbnailInterval: {{ ThumbnailInterval }}
                  ThumbnailWidth: {{ ThumbnailWidth }}
                  TileHeight: {{ TileHeight }}
                  TileWidth: {{ TileWidth }}
              ManifestCompression: "{{ ManifestCompression }}"
              ManifestDurationFormat: "{{ ManifestDurationFormat }}"
              MinBufferTime: {{ MinBufferTime }}
              MinFinalSegmentLength: {{ MinFinalSegmentLength }}
              MpdManifestBandwidthType: "{{ MpdManifestBandwidthType }}"
              MpdProfile: "{{ MpdProfile }}"
              PtsOffsetHandlingForBFrames: "{{ PtsOffsetHandlingForBFrames }}"
              SegmentControl: "{{ SegmentControl }}"
              SegmentLength: {{ SegmentLength }}
              SegmentLengthControl: "{{ SegmentLengthControl }}"
              StreamInfResolution: "{{ StreamInfResolution }}"
              TargetDurationCompatibilityMode: "{{ TargetDurationCompatibilityMode }}"
              VideoCompositionOffsets: "{{ VideoCompositionOffsets }}"
              WriteDashManifest: "{{ WriteDashManifest }}"
              WriteHlsManifest: "{{ WriteHlsManifest }}"
              WriteSegmentTimelineInRepresentation: "{{ WriteSegmentTimelineInRepresentation }}"
            DashIsoGroupSettings:
              AdditionalManifests:
                - ManifestNameModifier: "{{ ManifestNameModifier }}"
                  SelectedOutputs: "{{ SelectedOutputs }}"
              AudioChannelConfigSchemeIdUri: "{{ AudioChannelConfigSchemeIdUri }}"
              BaseUrl: "{{ BaseUrl }}"
              DashIFrameTrickPlayNameModifier: "{{ DashIFrameTrickPlayNameModifier }}"
              DashManifestStyle: "{{ DashManifestStyle }}"
              Destination: "{{ Destination }}"
              DestinationSettings:
                S3Settings: "{{ S3Settings }}"
              Encryption:
                PlaybackDeviceCompatibility: "{{ PlaybackDeviceCompatibility }}"
                SpekeKeyProvider: "{{ SpekeKeyProvider }}"
              FragmentLength: {{ FragmentLength }}
              HbbtvCompliance: "{{ HbbtvCompliance }}"
              ImageBasedTrickPlay: "{{ ImageBasedTrickPlay }}"
              ImageBasedTrickPlaySettings:
                IntervalCadence: "{{ IntervalCadence }}"
                ThumbnailHeight: {{ ThumbnailHeight }}
                ThumbnailInterval: {{ ThumbnailInterval }}
                ThumbnailWidth: {{ ThumbnailWidth }}
                TileHeight: {{ TileHeight }}
                TileWidth: {{ TileWidth }}
              ImageBasedTrickPlayVariants:
                - IntervalCadence: "{{ IntervalCadence }}"
                  ThumbnailHeight: {{ ThumbnailHeight }}
                  ThumbnailInterval: {{ ThumbnailInterval }}
                  ThumbnailWidth: {{ ThumbnailWidth }}
                  TileHeight: {{ TileHeight }}
                  TileWidth: {{ TileWidth }}
              MinBufferTime: {{ MinBufferTime }}
              MinFinalSegmentLength: {{ MinFinalSegmentLength }}
              MpdManifestBandwidthType: "{{ MpdManifestBandwidthType }}"
              MpdProfile: "{{ MpdProfile }}"
              PtsOffsetHandlingForBFrames: "{{ PtsOffsetHandlingForBFrames }}"
              SegmentControl: "{{ SegmentControl }}"
              SegmentLength: {{ SegmentLength }}
              SegmentLengthControl: "{{ SegmentLengthControl }}"
              VideoCompositionOffsets: "{{ VideoCompositionOffsets }}"
              WriteSegmentTimelineInRepresentation: "{{ WriteSegmentTimelineInRepresentation }}"
            FileGroupSettings:
              Destination: "{{ Destination }}"
              DestinationSettings:
                S3Settings: "{{ S3Settings }}"
            HlsGroupSettings:
              AdMarkers:
                - "{{ AdMarkers }}"
              AdditionalManifests:
                - ManifestNameModifier: "{{ ManifestNameModifier }}"
                  SelectedOutputs: "{{ SelectedOutputs }}"
              AudioOnlyHeader: "{{ AudioOnlyHeader }}"
              BaseUrl: "{{ BaseUrl }}"
              CaptionLanguageMappings:
                - CaptionChannel: {{ CaptionChannel }}
                  CustomLanguageCode: "{{ CustomLanguageCode }}"
                  LanguageCode: "{{ LanguageCode }}"
                  LanguageDescription: "{{ LanguageDescription }}"
              CaptionLanguageSetting: "{{ CaptionLanguageSetting }}"
              CaptionSegmentLengthControl: "{{ CaptionSegmentLengthControl }}"
              ClientCache: "{{ ClientCache }}"
              CodecSpecification: "{{ CodecSpecification }}"
              Destination: "{{ Destination }}"
              DestinationSettings:
                S3Settings: "{{ S3Settings }}"
              DirectoryStructure: "{{ DirectoryStructure }}"
              Encryption:
                ConstantInitializationVector: "{{ ConstantInitializationVector }}"
                EncryptionMethod: "{{ EncryptionMethod }}"
                InitializationVectorInManifest: "{{ InitializationVectorInManifest }}"
                OfflineEncrypted: "{{ OfflineEncrypted }}"
                SpekeKeyProvider: "{{ SpekeKeyProvider }}"
                StaticKeyProvider: "{{ StaticKeyProvider }}"
                Type: "{{ Type }}"
              ImageBasedTrickPlay: "{{ ImageBasedTrickPlay }}"
              ImageBasedTrickPlaySettings:
                IntervalCadence: "{{ IntervalCadence }}"
                ThumbnailHeight: {{ ThumbnailHeight }}
                ThumbnailInterval: {{ ThumbnailInterval }}
                ThumbnailWidth: {{ ThumbnailWidth }}
                TileHeight: {{ TileHeight }}
                TileWidth: {{ TileWidth }}
              ImageBasedTrickPlayVariants:
                - IntervalCadence: "{{ IntervalCadence }}"
                  ThumbnailHeight: {{ ThumbnailHeight }}
                  ThumbnailInterval: {{ ThumbnailInterval }}
                  ThumbnailWidth: {{ ThumbnailWidth }}
                  TileHeight: {{ TileHeight }}
                  TileWidth: {{ TileWidth }}
              ManifestCompression: "{{ ManifestCompression }}"
              ManifestDurationFormat: "{{ ManifestDurationFormat }}"
              MinFinalSegmentLength: {{ MinFinalSegmentLength }}
              MinSegmentLength: {{ MinSegmentLength }}
              OutputSelection: "{{ OutputSelection }}"
              ProgramDateTime: "{{ ProgramDateTime }}"
              ProgramDateTimePeriod: {{ ProgramDateTimePeriod }}
              ProgressiveWriteHlsManifest: "{{ ProgressiveWriteHlsManifest }}"
              SegmentControl: "{{ SegmentControl }}"
              SegmentLength: {{ SegmentLength }}
              SegmentLengthControl: "{{ SegmentLengthControl }}"
              SegmentsPerSubdirectory: {{ SegmentsPerSubdirectory }}
              StreamInfResolution: "{{ StreamInfResolution }}"
              TargetDurationCompatibilityMode: "{{ TargetDurationCompatibilityMode }}"
              TimedMetadataId3Frame: "{{ TimedMetadataId3Frame }}"
              TimedMetadataId3Period: {{ TimedMetadataId3Period }}
              TimestampDeltaMilliseconds: {{ TimestampDeltaMilliseconds }}
            MsSmoothGroupSettings:
              AdditionalManifests:
                - ManifestNameModifier: "{{ ManifestNameModifier }}"
                  SelectedOutputs: "{{ SelectedOutputs }}"
              AudioDeduplication: "{{ AudioDeduplication }}"
              Destination: "{{ Destination }}"
              DestinationSettings:
                S3Settings: "{{ S3Settings }}"
              Encryption:
                SpekeKeyProvider: "{{ SpekeKeyProvider }}"
              FragmentLength: {{ FragmentLength }}
              FragmentLengthControl: "{{ FragmentLengthControl }}"
              ManifestEncoding: "{{ ManifestEncoding }}"
            PerFrameMetrics:
              - "{{ PerFrameMetrics }}"
            Type: "{{ Type }}"
          Outputs: "{{ Outputs }}"
      TimecodeConfig:
        Anchor: "{{ Anchor }}"
        Source: "{{ Source }}"
        Start: "{{ Start }}"
        TimestampOffset: "{{ TimestampOffset }}"
      TimedMetadataInsertion:
        Id3Insertions:
          - Id3: "{{ Id3 }}"
            Timecode: "{{ Timecode }}"
  - name: SimulateReservedQueue
    value: "{{ SimulateReservedQueue }}"
    description: |
      Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.
    valid_values: ['DISABLED', 'ENABLED']
  - name: StatusUpdateInterval
    value: "{{ StatusUpdateInterval }}"
    description: |
      Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.
    valid_values: ['SECONDS_10', 'SECONDS_12', 'SECONDS_15', 'SECONDS_20', 'SECONDS_30', 'SECONDS_60', 'SECONDS_120', 'SECONDS_180', 'SECONDS_240', 'SECONDS_300', 'SECONDS_360', 'SECONDS_420', 'SECONDS_480', 'SECONDS_540', 'SECONDS_600']
  - name: Tags
    value: "{{ Tags }}"
  - name: UserMetadata
    value: "{{ UserMetadata }}"

Lifecycle Methods

search_jobs

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.

EXEC aws.mediaconvert.jobs.search_jobs 
@region='{{ region }}' --required, 
@inputFile='{{ inputFile }}', 
@maxResults='{{ maxResults }}', 
@nextToken='{{ nextToken }}', 
@order='{{ order }}', 
@queue='{{ queue }}', 
@status='{{ status }}'
;

start_jobs_query

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.

EXEC aws.mediaconvert.jobs.start_jobs_query 
@region='{{ region }}' --required 
@@json=
'{
"FilterList": "{{ FilterList }}", 
"MaxResults": {{ MaxResults }}, 
"NextToken": "{{ NextToken }}", 
"Order": "{{ Order }}"
}'
;