Description Requests Responses Errors Examples

List Jobs by Pipeline

Topics

Description
Requests
Responses
Errors
Examples

Description

To get a list of the jobs that you assigned to a pipeline, send a GET request to the /2012-09-25/jobsByPipeline/pipelineId resource. When you list jobs by pipeline, Elastic Transcoder lists the jobs that you've created recently for the specified pipeline.

Requests

Syntax

To get information about the jobs currently in a pipeline, send the following GET request.


GET /2012-09-25/jobsByPipeline/pipeline Id?
Ascending=true|false&
PageToken=value for accessing the next page of results HTTP/1.1
Content-Type: charset=UTF-8
Accept: */*
Host: elastictranscoder.Elastic Transcoder endpoint.amazonaws.com:443
x-amz-date: 20130114T174952Z
Authorization: AWS4-HMAC-SHA256
               Credential=AccessKeyID/request-date/Elastic Transcoder endpoint/elastictranscoder/aws4_request,
               SignedHeaders=host;x-amz-date;x-amz-target,
               Signature=calculated-signature

Request Parameters

This operation takes the following request parameters. Elastic Transcoder returns the last six months worth of jobs in the specified pipeline.

PipelineId: To get information about jobs that you added to a given pipeline, specify the value of the Id object for that pipeline.
Ascending: To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.
PageToken: When Elastic Transcoder returns more than one page of results, use PageToken in subsequent GET requests to get each successive page of results.

Request Headers

This operation uses only request headers that are common to all operations. For information about common request headers, see HTTP Header Contents.

Request Body

This operation does not use a request body.

Responses

Syntax


Status: 200 OK
x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9
Content-Type: application/json
Content-Length: number of characters in the response
Date: Mon, 14 Jan 2013 06:01:47 GMT

{
   "Jobs":[
      {
         "Id":"Id that Elastic Transcoder assigned to the job",
         "Inputs":[{
            "Key":"name of the file to transcode",
            "Encryption":{
               "Mode":"aes-cbc-pkcs7|aes-ctr|aes-gcm",
               "Key":"encrypted and base64-encoded decryption key",
               "KeyMd5":"base64-encoded key digest",
               "InitializationVector":"base64-encoded initialization vector"
            },
            "TimeSpan":{
               "StartTime":"starting place of the clip, in
                  HH:mm:ss.SSS or sssss.SSS",
               "Duration":"duration of the clip, in HH:mm:ss.SSS
                  or sssss.SSS"
            },
            "FrameRate":"auto|10|15|23.97|24|25|29.97|30|50|60",
            "Resolution":"auto|width in pixelsxheight in pixels",
            "AspectRatio":"auto|1:1|4:3|3:2|16:9",
            "Interlaced":"auto|true|false",
            "Container":"auto|aac|asf|avi|divx|flv|m4a|mkv|mov|mp2|mp3|
               mp4|mpeg|mpeg-ps|mpeg-ts|mxf|ogg|vob|wav|webm",
            "DetectedProperties":{
               "Width":"video width in pixels",
               "Height":"video height in pixels",         
               "FrameRate":"video frame rate in fps",
               "FileSize":"file size in bytes",
               "DurationMillis":"file duration in milliseconds"
            },
            "InputCaptions":{
   	       "MergePolicy":"MergeOverride|MergeRetain|Override",
               "CaptionSources":[
                  {
                     "Key":"name of the input caption file",
                     "Language":"language of the input caption file",
                     "TimeOffset":"starting place of the captions, in
                        either [-+]SS.sss or [-+]HH:mm:SS.ss",
                     "Label":"label for the caption"
                     "Encryption":{
                        "Mode":"aes-cbc-pkcs7|aes-ctr|aes-gcm",
                        "Key":"encrypted and base64-encoded decryption key",
                        "KeyMd5":"base64-encoded key digest",
                        "InitializationVector":"base64-encoded initialization 
                           vector"
                     },
                  },
                  {...}
               ]
            }
         },
      {...}],
      "OutputKeyPrefix":"prefix for file names in Amazon S3 bucket",
      "Outputs":[{
            "Id":"sequential counter",
            "Key":"name of the transcoded file",
            "Encryption":{
               "Mode":"s3||aes-cbc-pkcs7|aes-ctr|
                  aes-gcm",
               "Key":"encrypted and base64-encoded encryption key",
               "KeyMd5":"base64-encoded key digest",
               "InitializationVector":"base64-encoded initialization vector"           
            },
            "ThumbnailPattern":""|"pattern",
            "Rotate":"auto|0|90|180|270",
            "PresetId":"preset to use for the job",
            "SegmentDuration":"[1,60]",
            "Watermarks":[
               {
                  "InputKey":"name of the .png or .jpg file",
                  "Encryption":{
                     "Mode":"s3||aes-cbc-pkcs7|
                        aes-ctr|aes-gcm",
                     "Key":"encrypted and base64-encoded encryption key",
                     "KeyMd5":"base64-encoded key digest",
                     "InitializationVector":"base64-encoded initialization 
                        vector"
                  },
                  "PresetWatermarkId":"value of Video:Watermarks:Id in 
                     preset"
               },
               {...}
            ],
            "AlbumArt":[
               {
                  "AlbumArtMerge":"Replace|Prepend|Append|Fallback",
                  "AlbumArtArtwork":"can be empty, but not null":[
                     {
                        "AlbumArtInputKey":"name of the file to use as album 
                           art",
                        "Encryption":{
                           "Mode":"s3||aes-cbc-pkcs7|
                              aes-ctr|aes-gcm",
                           "Key":"encrypted and base64-encoded encryption key",
                           "KeyMd5":"base64-encoded key digest",
                           "InitializationVector":"base64-encoded
                              initialization vector"
                        },
                        "AlbumArtMaxWidth":"maximum width of output album art
                           in pixels",
                        "AlbumArtMaxHeight":"maximum height of output album
                           art in pixels",
                        "AlbumArtSizingPolicy":"Fit|Fill|Stretch|Keep|
                           ShrinkToFit|ShrinkToFill",
                        "AlbumArtPaddingPolicy":"Pad|NoPad",
                        "AlbumArtFormat":"jpg|png"
                     },
                     {...}
                  ]
            },
            {...}], 
            "Duration":"duration in seconds",
            "DurationMillis":"duration in milliseconds",
            "Height":"height in pixels",
            "Width":"width in pixels",
            "FrameRate":"frame rate in fps",
            "FileSize":"file size in bytes",
            "Status":"Submitted|In Progress|Complete|Error",
            "StatusDetail":"detail associated with Status",
            "Captions":{
               "CaptionFormats":[
                  {
                     "Format":"cea-708|dfxp|mov-text|scc|srt|webvtt",
                     "Pattern":"myCaption/file-language",
                     "Encryption":{
                        "Mode":"s3||aes-cbc-pkcs7|
                           aes-ctr|aes-gcm",
                        "Key":"encrypted and base64-encoded encryption key",
                        "KeyMd5":"base64-encoded key digest",
                        "InitializationVector":"base64-encoded 
                           initialization vector"
                     }
                  },
                  {...}
               ]
            },
            "AppliedColorSpaceConversion":"None|Bt601ToBt709|
                  Bt709ToBt601"
         },
         {...}
      ],
      "Playlists":[
         {
            "Format":"HLSv3|HLSv4|MPEG-DASH|Smooth",
            "Name":"name",
            "OutputKeys":[
               "Outputs:Key to include in this playlist",
               {...}
            ],
            "HlsContentProtection":{
                "Method":"aes-128",
                "Key":"encrypted and base64-encoded protection key",
                "KeyMd5":"base64-encoded key digest",
                "InitializationVector":"base64-encoded
                   initialization vector",
                "LicenseAcquisitionUrl":"license acquisition url",
                "KeyStoragePolicy":"NoStore|WithVariantPlaylists"
            },
            "PlayReadyDrm":{
                "Format":"microsoft|discretix-3.0",
                "Key":"encrypted and base64-encoded DRM key",
                "KeyId":"id of the DRM key",
                "KeyMd5":"base64-encoded key digest",
                "InitializationVector":"base64-encoded
                   initialization vector",
                "LicenseAcquisitionUrl":"license acquisition url"
               }
            },
            {...}
         ],
         "UserMetadata":
            {
                "Key":"Value",
                "Second user metadata key":"Second user metadata value"
            },
         "PipelineId":"PipelineId for the job",
         "Status":"Submitted|Progressing|Complete|Canceled|Error",
         "Timing":{
            "SubmitTimeMillis":"job submitted time in epoch milliseconds",
            "StartTimeMillis":"job start time in epoch milliseconds",
            "FinishTimeMillis":"job finish time in epoch milliseconds"
         }
      },
      {...}
   ],
   "NextPageToken":value for accessing the next page of results|null
}

Response Headers

This operation uses only response headers that are common to most responses. For information about common response headers, see HTTP Responses.

Response Body

The response body contains one element for each job that satisfies the search criteria, and each element contains the values that you specified when you created the job. For more information about the job values, see Settings that You Specify When You Create an Elastic Transcoder Job.

In addition, Elastic Transcoder returns the following values.

(Automatic) Id

The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.

(Automatic) Inputs:DetectedProperties

The detected properties of the input file. Elastic Transcoder identifies these values from the input file.

(Automatic) Inputs:Width

The detected width of the input file, in pixels.

(Automatic) Inputs:Height

The detected height of the input file, in pixels.

(Automatic) Inputs:FrameRate

The detected frame rate of the input file, in frames per second.

(Automatic) Inputs:FileSize

The detected file size of the input file, in bytes.

(Automatic) Inputs:DurationMillis

The detected duration of the input file, in milliseconds.

(Automatic) Outputs:Id

A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.

(Automatic) Outputs:Duration

Duration of the output file in seconds, rounded up.

(Automatic) Outputs:DurationMillis

Duration of the output file, in milliseconds.

(Automatic) Outputs:Width

Width of the output file, in pixels.

(Automatic) Outputs:Height

Height of the output file, in pixels.

(Automatic) Outputs:FrameRate

Frame rate of the output file, in frames per second.

(Automatic) Outputs:FileSize

File size of the output file, in bytes.

(Automatic) Outputs:Status

The status of one output in a job. If you specified only one output for the job, Outputs:Status is always the same as Job:Status. If you specified more than one output:

Job:Status and Outputs:Status for all of the outputs is Submitted until Elastic Transcoder starts to process the first output.
When Elastic Transcoder starts to process the first output, Outputs:Status for that output and Job:Status both change to Progressing. For each output, the value of Outputs:Status remains Submitted until Elastic Transcoder starts to process the output.
Job:Status remains Progressing until all of the outputs reach a terminal status, either Complete or Error.
When all of the outputs reach a terminal status, Job:Status changes to Complete only if Outputs:Status for all of the outputs is Complete. If Outputs:Status for one or more outputs is Error, the terminal status for Job:Status is also Error.

The value of Status is one of the following: Submitted, Progressing, Complete, Canceled, or Error.

(Automatic) Outputs:StatusDetail

Information that further explains Outputs:Status.

(Automatic) Outputs:AppliedColorSpaceConversion

If Elastic Transcoder used a preset with a ColorSpaceConversionMode to transcode the output file, the AppliedColorSpaceConversion parameter shows the conversion used. If no ColorSpaceConversionMode was defined in the preset, this parameter will not be included in the job response.

(Automatic) Status

If you specified more than one output for the job, the status of the entire job. When Elastic Transcoder starts processing a job, the value of Job:Status changes to Progressing and doesn't change until Elastic Transcoder has finished processing all outputs. When processing is complete, Job:Status changes either to Complete or, if any of the outputs failed, to Error.

If you specified only one output for the job, Job:Status is the same as Outputs:Status.

The value of Job:Status is one of the following: Submitted, Progressing, Complete, Canceled, or Error.

(Automatic) Timing

The details about the timing of a job.

(Automatic) Timing:SubmitTimeMillis

The time the job was submitted to Elastic Transcoder, in epoch milliseconds.

(Automatic) Timing:StartTimeMillis

The time the job began transcoding, in epoch milliseconds.

(Automatic) Timing:FinishTimeMillis

The time the job finished transcoding, in epoch milliseconds.

To learn more about epoch time, go to the Epoch Computing page on Wikipedia.

(Automatic) NextPageToken

A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken is null.

Errors

For information about Elastic Transcoder exceptions and error messages, see Handling Errors in Elastic Transcoder.

Examples

The following example request creates a job.

Sample Request

The following example request gets a list of all of the jobs from the past six months that you assigned to the pipeline ID 1111111111111-abcde1.


GET /2012-09-25/jobsByPipeline/1111111111111-abcde1?Ascending=true HTTP/1.1
Content-Type: charset=UTF-8
Accept: */*
Host: elastictranscoder.Elastic Transcoder endpoint.amazonaws.com:443
x-amz-date: 20130114T174952Z
Authorization: AWS4-HMAC-SHA256
               Credential=AccessKeyID/request-date/Elastic Transcoder endpoint/elastictranscoder/aws4_request,
               SignedHeaders=host;x-amz-date;x-amz-target,
               Signature=calculated-signature

Sample Response


Status: 200 OK
x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9
Content-Type: application/json
Content-Length: number of characters in the response
Date: Mon, 14 Jan 2013 06:01:47 GMT

{
   "Jobs":[
      {
         "Id":"3333333333333-abcde3",
         "Inputs":[{
            "Key":"cooking/lasagna.mp4",
            "FrameRate":"auto",
            "Resolution":"auto",
            "AspectRatio":"auto",
            "Interlaced":"auto",
            "Container":"mp4",
            "InputCaptions":{
               "MergePolicy":"MergeOverride",
               "CaptionSources":[
                  {
                     "Key":"scc/lasagna-kindlefirehd.scc",
                     "Language":"en",
                     "Label":"English"
                  },
                  {
                     "Key":"srt/lasagna-kindlefirehd.srt",
                     "Language":"fr",
                     "TimeOffset":"1:00:00",
                     "Label":"French"
                  }
               ],
            },
            "DetectedProperties":{
               "Width":"1280",
               "Height":"720",
               "FrameRate":"30.00",
               "FileSize":"5872000",
               "DurationMillis":"1003000"
            }
         }],
         "Outputs":[
            {
               "Id":"1",
               "Key":"cooking/lasagna-KindleFireHD.mp4",
               "ThumbnailPattern":"cooking/lasagna-{count}-KindleFireHD",
               "Rotate":"0",
               "PresetId":"1351620000000-100080",
               "Watermarks":[
                  {
                     "InputKey":"logo/128x64.png",
                     "PresetWatermarkId":"company logo 128x64",
                  }
               ],
               "Duration":"1003",
               "DurationMillis":"1003000",
               "Width":"1280",
               "Height":"720",
               "FrameRate":"30.00",
               "FileSize":"5872000",
               "Status":"Submitted",
               "StatusDetail":"Job has been received.",
               "Captions":{
                  "CaptionFormats":[
                     {
                        "Format":"scc",
                        "Pattern":"scc/lasagna-{language}",
                     },
                     {
                        "Format":"srt",
                        "Pattern":"srt/lasagna-{language}"
                     },
                     {
                        "Format":"mov-text"
                     }
                  ]
               }
            },
            {
               "Id":"2",
               "Key":"cooking/lasagna-iPhone4s.mp4",
               "ThumbnailPattern":"cooking/lasagna-{count}-iPhone4s",
               "Rotate":"0",
               "PresetId":"1351620000000-100020",
               "Watermarks":[
                  {
                     "InputKey":"logo/128x64.png",
                     "PresetWatermarkId":"company logo 128x64"
                  }
               ],
               "Duration":"1003",
               "DurationMillis":"1003000",
               "Width":"1920",
               "Height":"1080",
               "FrameRate":"30.00",
               "FileSize":"4718600",
               "Status":"Submitted",
               "StatusDetail":"Job has been received.",
               "AppliedColorSpaceConversion":"None"
            }
         ],
         "PipelineId":"1111111111111-abcde1",
         "Timing":{
            "SubmitTime":"1427212800000",
            "StartTime":"1427212856000",
            "FinishTime":"1427212875000"
         }
      },
      {
         "Id":"4444444444444-abcde4",
         "Input":{
            "Key":"cooking/baked-ziti.mp4",
            "FrameRate":"auto",
            "Resolution":"auto",
            "AspectRatio":"auto",
            "Interlaced":"auto",
            "Container":"mp4",
            "DetectedProperties":{
               "Width":"1280",
               "Height":"720",
               "FrameRate":"30.00",
               "FileSize":"5872000",
               "DurationMillis":"1003000"
            }
         },
         "Outputs":[
            {
               "Id":"1",
               "Key":"cooking/baked-ziti-KindleFireHD.mp4",
               "ThumbnailPattern":"cooking/baked-ziti-{count}-KindleFireHD",
               "Rotate":"0",
               "PresetId":"1351620000000-100080",
               "Watermarks":[
                  {
                     "InputKey":"logo/128x64.png",
                     "PresetWatermarkId":"company logo 128x64"
                  }
               ],
               "Duration":"596",
               "DurationMillis":"1003000",
               "Width":"1280",
               "Height":"720",
               "FrameRate":"30.00",
               "FileSize":"4718600",
               "Status":"Complete",
               "StatusDetail":""
            }
         ],
         "UserMetadata":
            {
               "Food type":"Italian",
               "Cook book":"recipe notebook"
            },
         "PipelineId":"1111111111111-abcde1",
         "Timing":{
            "SubmitTime":"1427212800000",
            "StartTime":"1427212856000",
            "FinishTime":"1427212875000"
         }
      }
   ],
   "NextPageToken":null
}

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

Create Job

List Jobs by Status