Save costs and get more features with AWS Elemental MediaConvert
MediaConvert is a newer file-based video transcoding service that provides a comprehensive suite of advanced transcoding features, with on-demand rates starting at $0.0075/minute. Read more
Already using Amazon Elastic Transcoder? It's simple to migrate to MediaConvert. For more information, see this overview
Update Pipeline
Description
To update settings for a pipeline, send a PUT request to the
/2012-09-25/pipelines/
pipelineId
resource.
Important
When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings.
How to Update and Delete Values
To update a value, specify the new value, for example:
"GranteeType":"Canonical"
To leave a value unchanged, do one of the following:
Specify the current value.
Specify a null value. This applies both to individual objects (for example,
"Role":null
) and to arrays (for example,"ContentConfig":null
).Omit the JSON object from the request. This applies both to individual objects, for example,
Role
, and to arrays, for example,ContentConfig
.
To delete the current value, specify an empty value. For example, to delete a notification, specify an empty string:
"Progressing":""
. To delete all of the values in an array, specify an empty array: "Permissions":[]
.
For example, if you no longer want to be notified when Elastic Transcoder encounters a warning while processing a job,
and you don't want to change any of the other notification settings, you would specify the following for Notifications
in the request:
... "Notifications":{ "Warning":"" }, ...
Requests
Syntax
PUT /2012-09-25/pipelines/
pipelineId
HTTP/1.1 Content-Type: application/json; 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
Content-Length:number of characters in the JSON string
{ "Id":"pipelineId
", "Name":"pipeline name
", "InputBucket":"Amazon S3 bucket that contains files to transcode and graphics to use as watermarks
", "OutputBucket":"Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket
", "Role":"IAM role ARN
", "AwsKmsKeyArn":"AWS-KMS key arn of the AWS-KMS key you want to use with this pipeline
", "Notifications":{ "Progressing":"SNS topic to notify when Elastic Transcoder has started to process the job
", "Complete":"SNS topic to notify when Elastic Transcoder has finished processing the job
", "Warning":"SNS topic to notify when Elastic Transcoder encounters a warning condition
" "Error":"SNS topic to notify when Elastic Transcoder encounters an error condition
" }, "ContentConfig":{ "Bucket":"Use this plus ThumbnailConfig:Bucket, or use OutputBucket
", "Permissions":[ { "GranteeType":"Canonical|Email|Group", "Grantee":"AWS user ID or CloudFront origin access identity
"| "registered email address for AWS account
"| AllUsers|AuthenticatedUsers|LogDelivery", "Access":[ "Read|ReadAcp|WriteAcp|FullControl", ... ] }, {...} ], "StorageClass":"Standard|ReducedRedundancy" }, "ThumbnailConfig":{ "Bucket":"Use this plus ContentConfig:Bucket, or use OutputBucket
", "Permissions":[ { "GranteeType":"Canonical|Email|Group", "Grantee":"AWS user ID or CloudFront origin access identity
"| "registered email address for AWS account
"| AllUsers|AuthenticatedUsers|LogDelivery", "Access":[ "Read|ReadAcp|WriteAcp|FullControl", ... ] }, {...} ], "StorageClass":"Standard|ReducedRedundancy" }, "Status":"Active|Paused" }
Request Parameters
This operation does not use request parameters.
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
The JSON string in the request body contains the input objects for the
UpdatePipeline
operation. For more information about the input objects,
see Settings that You Specify When You Create an Elastic Transcoder Pipeline.
- Id
-
Identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, for example, creating a job or a preset.
- Status
-
The current status of the pipeline:
Active
: The pipeline is processing jobs.Paused
: The pipeline is not currently processing jobs.
Responses
Syntax
Status: 202 Accepted 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 { "Id":"Id for the new pipeline
", "Name":"pipeline name
", "InputBucket":"Amazon S3 bucket that contains files to transcode and graphics to use as watermarks
", "OutputBucket":"Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket
", "Role":"IAM role ARN
", "AwsKmsKeyArn":"AWS-KMS key id
", "Notifications":{ "Progressing":"SNS topic to notify when when Elastic Transcoder has started to process the job
", "Complete":"SNS topic to notify when Elastic Transcoder has finished processing the job
", "Warning":"SNS topic to notify when when Elastic Transcoder encounters a warning condition
", "Error":"SNS topic to notify when Elastic Transcoder encounters an error condition
" }, "ContentConfig":{ "Bucket":"Use this plus ThumbnailConfig:Bucket, or use OutputBucket
", "Permissions":[ { "GranteeType":"Canonical|Email|Group", "Grantee":"AWS user ID or CloudFront origin access identity
"| "registered email address for AWS account
| AllUsers|AuthenticatedUsers|LogDelivery", "Access":[ "Read|ReadAcp|WriteAcp|FullControl", ... ] }, {...} ], "StorageClass":"Standard|ReducedRedundancy" }, "ThumbnailConfig":{ "Bucket":"Use this plus ContentConfig:Bucket, or use OutputBucket
", "Permissions":[ { "Access":[ "Read|ReadAcp|WriteAcp|FullControl", ... ], "Grantee":"AWS user ID or CloudFront origin access identity
"| "registered email address for AWS account
| AllUsers|AuthenticatedUsers|LogDelivery", "GranteeType":"Canonical|Email|Group" }, {...} ], "StorageClass":"Standard|ReducedRedundancy" }, "Status":"Active|Paused", "(Automatic) Warnings": [ { "Code": "6000|6001|6002|6003|6004|6005|6006|6007|6008", "Message": "The code message
" }, {...} ] }
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
When you create a pipeline, Elastic Transcoder returns the values that you specified in the request. For more information, see Request Body.
Elastic Transcoder also includes the following warnings, if applicable:
(Automatic) Warnings
When you create a pipeline that uses resources in other regions, Elastic Transcoder returns one or more warnings. Your pipeline is still created, but might have increased processing times and incur cross-regional charges. The warnings are in the following format:
- Code
-
Message — the message associated with the warning code.
The following is a list of valid warning codes and their messages:
- 6000
-
The input bucket and the pipeline are in different regions, which increases processing time for jobs in the pipeline and can incur additional charges. To decrease processing time and prevent cross-regional charges, use the same region for the input bucket and the pipeline.
- 6001
-
The ContentConfig bucket and the pipeline are in different regions, which increases processing time for jobs in the pipeline and can incur additional charges. To decrease processing time and prevent cross-regional charges, use the same region for the ContentConfig bucket and the pipeline.
- 6002
-
The ThumbnailConfig bucket and the pipeline are in different regions, which increases processing time for jobs in the pipeline and can incur additional charges. To decrease processing time and prevent cross-regional charges, use the same region for the ThumbnailConfig bucket and the pipeline.
- 6003
-
The SNS notification topic for progressing events and the pipeline are in different regions, which increases processing time for jobs in the pipeline and can incur additional charges. To decrease processing time and prevent cross-regional charges, use the same region for the SNS notification topic and the pipeline.
- 6004
-
The SNS notification topic for warning events and the pipeline are in different regions, which increases processing time for jobs in the pipeline and can incur additional charges. To decrease processing time and prevent cross-regional charges, use the same region for the SNS notification topic and the pipeline.
- 6005
-
The SNS notification topic for completion events and the pipeline are in different regions, which increases processing time for jobs in the pipeline and can incur additional charges. To decrease processing time and prevent cross-regional charges, use the same region for the SNS notification topic and the pipeline.
- 6006
-
The SNS notification topic for error events and the pipeline are in different regions, which increases processing time for jobs in the pipeline and can incur additional charges. To decrease processing time and prevent cross-regional charges, use the same region for the SNS notification topic and the pipeline.
- 6007
-
The AWS KMS key and ContentConfig bucket specified for this pipeline are in different regions, which causes outputs using s3-aws-kms encryption mode to fail. To use s3-aws-kms encryption mode, use the same region for the KMS key and the ContentConfig bucket.
- 6008
-
The AWS KMS key and ThumbnailConfig bucket specified for this pipeline are in different regions, which causes outputs using s3-aws-kms encryption mode to fail. To use s3-aws-kms encryption mode, use the same region for the KMS key and the ThumbnailConfig bucket.
Errors
For information about Elastic Transcoder exceptions and error messages, see Handling Errors in Elastic Transcoder.
Examples
The following example request updates the pipeline that has the Id 1111111111111-abcde1
.
Sample Request
PUT /2012-09-25/pipelines/1111111111111-abcde1 HTTP/1.1 Content-Type: application/json; 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
Content-Length:number of characters in the JSON string
{ "Id":"1111111111111-abcde1" "Name":"Default", "InputBucket":"salesoffice.example.com-source", "OutputBucket":"salesoffice.example.com-output", "Role":"arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role", "AwsKmsKeyArn":"base64 encoded key from KMS
", "Notifications":{ "Progressing":"", "Complete":"", "Warning":"", "Error":"arn:aws:sns:us-east-1:111222333444:ET_Errors" }, "ContentConfig":{ "Bucket":"salesoffice.example.com-public-promos", "Permissions":[ { "GranteeType":"Email", "Grantee":"marketing-promos@example.com", "Access":[ "FullControl" ] } ], "StorageClass":"Standard" }, "ThumbnailConfig":{ "Bucket":"salesoffice.example.com-public-promos-thumbnails", "Permissions":[ { "GranteeType":"Email", "Grantee":"marketing-promos@example.com", "Access":[ "FullControl" ] } ], "StorageClass":"ReducedRedundancy" }, "Status":"Active" }
Sample Response
Status: 202 Accepted 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 { "Id":"1111111111111-abcde1", "Name":"Default", "InputBucket":"salesoffice.example.com-source", "OutputBucket":"salesoffice.example.com-output", "Role":"arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role", "AwsKmsKeyArn":"base64 encoded key from KMS
", "Notifications":{ "Progressing":"", "Complete":"", "Warning":"", "Error":"arn:aws:sns:us-east-1:111222333444:ET_Errors" }, "ContentConfig":{ "Bucket":"salesoffice.example.com-public-promos", "Permissions":[ { "GranteeType":"Email", "Grantee":"marketing-promos@example.com", "Access":[ "FullControl" ] } ], "StorageClass":"Standard" }, "ThumbnailConfig":{ "Bucket":"salesoffice.example.com-public-promos-thumbnails", "Permissions":[ { "GranteeType":"Email", "Grantee":"marketing-promos@example.com", "Access":[ "FullControl" ] } ], "StorageClass":"ReducedRedundancy" }, "Status":"Active", "Warnings": [ { "Code": "6000", "Message": "The input bucket and the pipeline are in different regions, which increases processing time for jobs in the pipeline and can incur additional charges. To decrease processing time and prevent cross-regional charges, use the same region for the input bucket and the pipeline." }, {...} ] }