Elastic Transcoder examples using Amazon CLI - Amazon Command Line Interface
Actions
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This documentation is for Version 1 of the Amazon CLI only. For documentation related to Version 2 of the Amazon CLI, see the Version 2 User Guide.

Elastic Transcoder examples using Amazon CLI

The following code examples show you how to perform actions and implement common scenarios by using the Amazon Command Line Interface with Elastic Transcoder.

Actions are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.

Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.

Topics

Actions

The following code example shows how to use cancel-job.

Amazon CLI

To cancel a job for ElasticTranscoder

This cancels the specified job for ElasticTranscoder.

Command:

aws elastictranscoder cancel-job --id 3333333333333-abcde3

  • For API details, see CancelJob in Amazon CLI Command Reference.

The following code example shows how to use create-job.

Amazon CLI

To create a job for ElasticTranscoder

The following create-job example creates a job for ElasticTranscoder.

aws elastictranscoder create-job \
    --pipeline-id 1111111111111-abcde1 \
    --inputs file://inputs.json \
    --outputs file://outputs.json \
    --output-key-prefix "recipes/" \
    --user-metadata file://user-metadata.json

Contents of inputs.json:

[{
    "Key":"ETS_example_file.mp4",
    "FrameRate":"auto",
    "Resolution":"auto",
    "AspectRatio":"auto",
    "Interlaced":"auto",
    "Container":"mp4"
}]

Contents of outputs.json:

[
    {
        "Key":"webm/ETS_example_file-kindlefirehd.webm",
        "Rotate":"0",
        "PresetId":"1351620000001-100250"
    }
]

Contents of user-metadata.json:

{
    "Food type":"Italian",
    "Cook book":"recipe notebook"
}

Output:

{
    "Job": {
        "Status": "Submitted",
        "Inputs": [
            {
                "Container": "mp4",
                "FrameRate": "auto",
                "Key": "ETS_example_file.mp4",
                "AspectRatio": "auto",
                "Resolution": "auto",
                "Interlaced": "auto"
            }
        ],
        "Playlists": [],
        "Outputs": [
            {
                "Status": "Submitted",
                "Rotate": "0",
                "PresetId": "1351620000001-100250",
                "Watermarks": [],
                "Key": "webm/ETS_example_file-kindlefirehd.webm",
                "Id": "1"
            }
        ],
        "PipelineId": "3333333333333-abcde3",
        "OutputKeyPrefix": "recipes/",
        "UserMetadata": {
            "Cook book": "recipe notebook",
            "Food type": "Italian"
        },
        "Output": {
            "Status": "Submitted",
            "Rotate": "0",
            "PresetId": "1351620000001-100250",
            "Watermarks": [],
            "Key": "webm/ETS_example_file-kindlefirehd.webm",
            "Id": "1"
        },
        "Timing": {
            "SubmitTimeMillis": 1533838012298
        },
        "Input": {
            "Container": "mp4",
            "FrameRate": "auto",
            "Key": "ETS_example_file.mp4",
            "AspectRatio": "auto",
            "Resolution": "auto",
            "Interlaced": "auto"
        },
        "Id": "1533838012294-example",
        "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:job/1533838012294-example"
    }
}

  • For API details, see CreateJob in Amazon CLI Command Reference.

The following code example shows how to use create-pipeline.

Amazon CLI

To create a pipeline for ElasticTranscoder

The following create-pipeline example creates a pipeline for ElasticTranscoder.

aws elastictranscoder create-pipeline \
    --name Default \
    --input-bucket salesoffice.example.com-source \
    --role arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role \
    --notifications Progressing="",Completed="",Warning="",Error=arn:aws:sns:us-east-1:111222333444:ETS_Errors \
    --content-config file://content-config.json \
    --thumbnail-config file://thumbnail-config.json

Contents of content-config.json:

{
    "Bucket":"salesoffice.example.com-public-promos",
    "Permissions":[
        {
            "GranteeType":"Email",
            "Grantee":"marketing-promos@example.com",
            "Access":[
            "FullControl"
            ]
        }
    ],
    "StorageClass":"Standard"
}

Contents of thumbnail-config.json:

{
    "Bucket":"salesoffice.example.com-public-promos-thumbnails",
    "Permissions":[
        {
            "GranteeType":"Email",
            "Grantee":"marketing-promos@example.com",
            "Access":[
                "FullControl"
            ]
        }
    ],
    "StorageClass":"ReducedRedundancy"
}

Output:

{
    "Pipeline": {
        "Status": "Active",
        "ContentConfig": {
            "Bucket": "salesoffice.example.com-public-promos",
            "StorageClass": "Standard",
            "Permissions": [
                {
                    "Access": [
                        "FullControl"
                    ],
                    "Grantee": "marketing-promos@example.com",
                    "GranteeType": "Email"
                }
            ]
        },
        "Name": "Default",
        "ThumbnailConfig": {
            "Bucket": "salesoffice.example.com-public-promos-thumbnails",
            "StorageClass": "ReducedRedundancy",
            "Permissions": [
                {
                    "Access": [
                        "FullControl"
                    ],
                    "Grantee": "marketing-promos@example.com",
                    "GranteeType": "Email"
                }
            ]
        },
        "Notifications": {
            "Completed": "",
            "Warning": "",
            "Progressing": "",
            "Error": "arn:aws:sns:us-east-1:123456789012:ETS_Errors"
        },
        "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role",
        "InputBucket": "salesoffice.example.com-source",
        "Id": "1533765810590-example",
        "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/1533765810590-example"
    },
    "Warnings": [
        {
            "Message": "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.",
            "Code": "6006"
        }
    ]
}

  • For API details, see CreatePipeline in Amazon CLI Command Reference.

The following code example shows how to use create-preset.

Amazon CLI

To create a preset for ElasticTranscoder

The following create-preset example creates a preset for ElasticTranscoder.

aws elastictranscoder create-preset \
    --name DefaultPreset \
    --description "Use for published videos" \
    --container mp4 \
    --video file://video.json \
    --audio file://audio.json \
    --thumbnails file://thumbnails.json

Contents of video.json:

{
    "Codec":"H.264",
    "CodecOptions":{
        "Profile":"main",
        "Level":"2.2",
        "MaxReferenceFrames":"3",
        "MaxBitRate":"",
        "BufferSize":"",
        "InterlacedMode":"Progressive",
        "ColorSpaceConversionMode":"None"
    },
    "KeyframesMaxDist":"240",
    "FixedGOP":"false",
    "BitRate":"1600",
    "FrameRate":"auto",
    "MaxFrameRate":"30",
    "MaxWidth":"auto",
    "MaxHeight":"auto",
    "SizingPolicy":"Fit",
    "PaddingPolicy":"Pad",
    "DisplayAspectRatio":"auto",
    "Watermarks":[
        {
            "Id":"company logo",
            "MaxWidth":"20%",
            "MaxHeight":"20%",
            "SizingPolicy":"ShrinkToFit",
            "HorizontalAlign":"Right",
            "HorizontalOffset":"10px",
            "VerticalAlign":"Bottom",
            "VerticalOffset":"10px",
            "Opacity":"55.5",
            "Target":"Content"
        }
    ]
}

Contents of audio.json:

{
    "Codec":"AAC",
    "CodecOptions":{
        "Profile":"AAC-LC"
    },
    "SampleRate":"44100",
    "BitRate":"96",
    "Channels":"2"
}

Contents of thumbnails.json:

{
    "Format":"png",
    "Interval":"120",
    "MaxWidth":"auto",
    "MaxHeight":"auto",
    "SizingPolicy":"Fit",
    "PaddingPolicy":"Pad"
}

Output:

{
    "Preset": {
        "Thumbnails": {
            "SizingPolicy": "Fit",
            "MaxWidth": "auto",
            "Format": "png",
            "PaddingPolicy": "Pad",
            "Interval": "120",
            "MaxHeight": "auto"
        },
        "Container": "mp4",
        "Description": "Use for published videos",
        "Video": {
            "SizingPolicy": "Fit",
            "MaxWidth": "auto",
            "PaddingPolicy": "Pad",
            "MaxFrameRate": "30",
            "FrameRate": "auto",
            "MaxHeight": "auto",
            "KeyframesMaxDist": "240",
            "FixedGOP": "false",
            "Codec": "H.264",
            "Watermarks": [
                {
                    "SizingPolicy": "ShrinkToFit",
                    "VerticalOffset": "10px",
                    "VerticalAlign": "Bottom",
                    "Target": "Content",
                    "MaxWidth": "20%",
                    "MaxHeight": "20%",
                    "HorizontalAlign": "Right",
                    "HorizontalOffset": "10px",
                    "Opacity": "55.5",
                    "Id": "company logo"
                }
            ],
            "CodecOptions": {
                "Profile": "main",
                "MaxBitRate": "32",
                "InterlacedMode": "Progressive",
                "Level": "2.2",
                "ColorSpaceConversionMode": "None",
                "MaxReferenceFrames": "3",
                "BufferSize": "5"
            },
            "BitRate": "1600",
            "DisplayAspectRatio": "auto"
        },
        "Audio": {
            "Channels": "2",
            "CodecOptions": {
                "Profile": "AAC-LC"
            },
            "SampleRate": "44100",
            "Codec": "AAC",
            "BitRate": "96"
        },
        "Type": "Custom",
        "Id": "1533765290724-example"
        "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:preset/1533765290724-example",
        "Name": "DefaultPreset"
    },
    "Warning": ""
}

  • For API details, see CreatePreset in Amazon CLI Command Reference.

The following code example shows how to use delete-pipeline.

Amazon CLI

To delete the specified ElasticTranscoder pipeline

This deletes the specified ElasticTranscoder pipeline.

Command:

aws elastictranscoder delete-pipeline --id 1111111111111-abcde1

Output:

{
 "Success":"true"
}

  • For API details, see DeletePipeline in Amazon CLI Command Reference.

The following code example shows how to use delete-preset.

Amazon CLI

To delete the specified ElasticTranscoder preset

This deletes the specified ElasticTranscoder preset.

Command:

aws elastictranscoder delete-preset --id 5555555555555-abcde5

  • For API details, see DeletePreset in Amazon CLI Command Reference.

The following code example shows how to use list-jobs-by-pipeline.

Amazon CLI

To retrieve a list of ElasticTranscoder jobs in the specified pipeline

This example retrieves a list of ElasticTranscoder jobs in the specified pipeline.

Command:

aws elastictranscoder list-jobs-by-pipeline --pipeline-id 1111111111111-abcde1

Output:

{
   "Jobs": []
}

The following code example shows how to use list-jobs-by-status.

Amazon CLI

To retrieve a list of ElasticTranscoder jobs with a status of Complete

This example retrieves a list of ElasticTranscoder jobs with a status of Complete.

Command:

aws elastictranscoder list-jobs-by-status --status Complete

Output:

{
   "Jobs": []
}

The following code example shows how to use list-pipelines.

Amazon CLI

To retrieve a list of ElasticTranscoder pipelines

This example retrieves a list of ElasticTranscoder pipelines.

Command:

aws elastictranscoder list-pipelines

Output:

{
   "Pipelines": [
       {
           "Status": "Active",
           "ContentConfig": {
               "Bucket": "ets-example",
               "Permissions": []
           },
           "Name": "example-pipeline",
           "ThumbnailConfig": {
               "Bucket": "ets-example",
               "Permissions": []
           },
           "Notifications": {
               "Completed": "arn:aws:sns:us-west-2:123456789012:ets_example",
               "Warning": "",
               "Progressing": "",
               "Error": ""
           },
           "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role",
           "InputBucket": "ets-example",
           "OutputBucket": "ets-example",
           "Id": "3333333333333-abcde3",
           "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/3333333333333-abcde3"
       },
       {
           "Status": "Paused",
           "ContentConfig": {
               "Bucket": "ets-example",
               "Permissions": []
           },
           "Name": "example-php-test",
           "ThumbnailConfig": {
               "Bucket": "ets-example",
               "Permissions": []
           },
           "Notifications": {
               "Completed": "",
               "Warning": "",
               "Progressing": "",
               "Error": ""
           },
           "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role",
           "InputBucket": "ets-example",
           "OutputBucket": "ets-example",
           "Id": "3333333333333-abcde2",
           "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/3333333333333-abcde2"
       },
       {
           "Status": "Active",
           "ContentConfig": {
               "Bucket": "ets-west-output",
               "Permissions": []
           },
           "Name": "pipeline-west",
           "ThumbnailConfig": {
               "Bucket": "ets-west-output",
               "Permissions": []
           },
           "Notifications": {
               "Completed": "arn:aws:sns:us-west-2:123456789012:ets-notifications",
               "Warning": "",
               "Progressing": "",
               "Error": ""
           },
           "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role",
           "InputBucket": "ets-west-input",
           "OutputBucket": "ets-west-output",
           "Id": "3333333333333-abcde1",
           "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/3333333333333-abcde1"
       }
   ]
}

  • For API details, see ListPipelines in Amazon CLI Command Reference.

The following code example shows how to use list-presets.

Amazon CLI

To retrieve a list of ElasticTranscoder presets

This example retrieves a list of ElasticTranscoder presets.

Command:

aws elastictranscoder list-presets --max-items 2

Output:

{
  "Presets": [
      {
          "Container": "mp4",
          "Name": "KindleFireHD-preset",
          "Video": {
              "Resolution": "1280x720",
              "FrameRate": "30",
              "KeyframesMaxDist": "90",
              "FixedGOP": "false",
              "Codec": "H.264",
              "Watermarks": [],
              "CodecOptions": {
                  "Profile": "main",
                  "MaxReferenceFrames": "3",
                  "ColorSpaceConversionMode": "None",
                  "InterlacedMode": "Progressive",
                  "Level": "4"
              },
              "AspectRatio": "16:9",
              "BitRate": "2200"
          },
          "Audio": {
              "Channels": "2",
              "CodecOptions": {
                  "Profile": "AAC-LC"
              },
              "SampleRate": "48000",
              "Codec": "AAC",
              "BitRate": "160"
          },
          "Type": "Custom",
          "Id": "3333333333333-abcde2",
          "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:preset/3333333333333-abcde2",
          "Thumbnails": {
              "AspectRatio": "16:9",
              "Interval": "60",
              "Resolution": "192x108",
              "Format": "png"
          }
      },
      {
          "Thumbnails": {
              "AspectRatio": "16:9",
              "Interval": "60",
              "Resolution": "192x108",
              "Format": "png"
          },
          "Container": "mp4",
          "Description": "Custom preset for transcoding jobs",
          "Video": {
              "Resolution": "1280x720",
              "FrameRate": "30",
              "KeyframesMaxDist": "90",
              "FixedGOP": "false",
              "Codec": "H.264",
              "Watermarks": [],
              "CodecOptions": {
                  "Profile": "main",
                  "MaxReferenceFrames": "3",
                  "ColorSpaceConversionMode": "None",
                  "InterlacedMode": "Progressive",
                  "Level": "3.1"
              },
              "AspectRatio": "16:9",
              "BitRate": "2200"
          },
          "Audio": {
              "Channels": "2",
              "CodecOptions": {
                  "Profile": "AAC-LC"
              },
              "SampleRate": "44100",
              "Codec": "AAC",
              "BitRate": "160"
          },
          "Type": "Custom",
          "Id": "3333333333333-abcde3",
          "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:preset/3333333333333-abcde3",
          "Name": "Roman's Preset"
      }
  ],
  "NextToken": "eyJQYWdlVG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ=="
}

  • For API details, see ListPresets in Amazon CLI Command Reference.

The following code example shows how to use read-job.

Amazon CLI

To retrieve an ElasticTranscoder job

This example retrieves the specified ElasticTranscoder job.

Command:

aws elastictranscoder read-job --id 1533838012294-example

Output:

{
   "Job": {
       "Status": "Progressing",
       "Inputs": [
           {
               "Container": "mp4",
               "FrameRate": "auto",
               "Key": "ETS_example_file.mp4",
               "AspectRatio": "auto",
               "Resolution": "auto",
               "Interlaced": "auto"
           }
       ],
       "Playlists": [],
       "Outputs": [
           {
               "Status": "Progressing",
               "Rotate": "0",
               "PresetId": "1351620000001-100250",
               "Watermarks": [],
               "Key": "webm/ETS_example_file-kindlefirehd.webm",
               "Id": "1"
           }
       ],
       "PipelineId": "3333333333333-abcde3",
       "OutputKeyPrefix": "recipes/",
       "UserMetadata": {
           "Cook book": "recipe notebook",
           "Food type": "Italian"
       },
       "Output": {
           "Status": "Progressing",
           "Rotate": "0",
           "PresetId": "1351620000001-100250",
           "Watermarks": [],
           "Key": "webm/ETS_example_file-kindlefirehd.webm",
           "Id": "1"
       },
       "Timing": {
           "SubmitTimeMillis": 1533838012298,
           "StartTimeMillis": 1533838013786
       },
       "Input": {
           "Container": "mp4",
           "FrameRate": "auto",
           "Key": "ETS_example_file.mp4",
           "AspectRatio": "auto",
           "Resolution": "auto",
           "Interlaced": "auto"
       },
       "Id": "1533838012294-example",
       "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:job/1533838012294-example"
   }
}

  • For API details, see ReadJob in Amazon CLI Command Reference.

The following code example shows how to use read-pipeline.

Amazon CLI

To retrieve an ElasticTranscoder pipeline

This example retrieves the specified ElasticTranscoder pipeline.

Command:

aws elastictranscoder read-pipeline --id 3333333333333-abcde3

Output:

{
   "Pipeline": {
       "Status": "Active",
       "ContentConfig": {
           "Bucket": "ets-example",
           "StorageClass": "Standard",
           "Permissions": [
               {
                   "Access": [
                       "FullControl"
                   ],
                   "Grantee": "marketing-promos@example.com",
                   "GranteeType": "Email"
               }
           ]
       },
       "Name": "Default",
       "ThumbnailConfig": {
           "Bucket": "ets-example",
           "StorageClass": "ReducedRedundancy",
           "Permissions": [
               {
                   "Access": [
                       "FullControl"
                   ],
                   "Grantee": "marketing-promos@example.com",
                   "GranteeType": "Email"
               }
           ]
       },
       "Notifications": {
           "Completed": "",
           "Warning": "",
           "Progressing": "",
           "Error": "arn:aws:sns:us-east-1:123456789012:ETS_Errors"
       },
       "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role",
       "InputBucket": "ets-example",
       "Id": "3333333333333-abcde3",
       "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/3333333333333-abcde3"
   },
   "Warnings": [
       {
           "Message": "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.",
           "Code": "6006"
       }
   ]
}

  • For API details, see ReadPipeline in Amazon CLI Command Reference.

The following code example shows how to use read-preset.

Amazon CLI

To retrieve an ElasticTranscoder preset

This example retrieves the specified ElasticTranscoder preset.

Command:

aws elastictranscoder read-preset --id 1351620000001-500020

Output:

{
   "Preset": {
       "Thumbnails": {
           "SizingPolicy": "ShrinkToFit",
           "MaxWidth": "192",
           "Format": "png",
           "PaddingPolicy": "NoPad",
           "Interval": "300",
           "MaxHeight": "108"
       },
       "Container": "fmp4",
       "Description": "System preset: MPEG-Dash Video - 4.8M",
       "Video": {
           "SizingPolicy": "ShrinkToFit",
           "MaxWidth": "1280",
           "PaddingPolicy": "NoPad",
           "FrameRate": "30",
           "MaxHeight": "720",
           "KeyframesMaxDist": "60",
           "FixedGOP": "true",
           "Codec": "H.264",
           "Watermarks": [
               {
                   "SizingPolicy": "ShrinkToFit",
                   "VerticalOffset": "10%",
                   "VerticalAlign": "Top",
                   "Target": "Content",
                   "MaxWidth": "10%",
                   "MaxHeight": "10%",
                   "HorizontalAlign": "Left",
                   "HorizontalOffset": "10%",
                   "Opacity": "100",
                   "Id": "TopLeft"
               },
               {
                   "SizingPolicy": "ShrinkToFit",
                   "VerticalOffset": "10%",
                   "VerticalAlign": "Top",
                   "Target": "Content",
                   "MaxWidth": "10%",
                   "MaxHeight": "10%",
                   "HorizontalAlign": "Right",
                   "HorizontalOffset": "10%",
                   "Opacity": "100",
                   "Id": "TopRight"
               },
               {
                   "SizingPolicy": "ShrinkToFit",
                   "VerticalOffset": "10%",
                   "VerticalAlign": "Bottom",
                   "Target": "Content",
                   "MaxWidth": "10%",
                   "MaxHeight": "10%",
                   "HorizontalAlign": "Left",
                   "HorizontalOffset": "10%",
                   "Opacity": "100",
                   "Id": "BottomLeft"
               },
               {
                   "SizingPolicy": "ShrinkToFit",
                   "VerticalOffset": "10%",
                   "VerticalAlign": "Bottom",
                   "Target": "Content",
                   "MaxWidth": "10%",
                   "MaxHeight": "10%",
                   "HorizontalAlign": "Right",
                   "HorizontalOffset": "10%",
                   "Opacity": "100",
                   "Id": "BottomRight"
               }
           ],
           "CodecOptions": {
               "Profile": "main",
               "MaxBitRate": "4800",
               "InterlacedMode": "Progressive",
               "Level": "3.1",
               "ColorSpaceConversionMode": "None",
               "MaxReferenceFrames": "3",
               "BufferSize": "9600"
           },
           "BitRate": "4800",
           "DisplayAspectRatio": "auto"
       },
       "Type": "System",
       "Id": "1351620000001-500020",
       "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:preset/1351620000001-500020",
       "Name": "System preset: MPEG-Dash Video - 4.8M"
   }
}

  • For API details, see ReadPreset in Amazon CLI Command Reference.

The following code example shows how to use update-pipeline-notifications.

Amazon CLI

To update the notifications of an ElasticTranscoder pipeline

This example updates the notifications of the specified ElasticTranscoder pipeline.

Command:

aws elastictranscoder update-pipeline-notifications --id 1111111111111-abcde1 --notifications Progressing=arn:aws:sns:us-west-2:0123456789012:my-topic,Completed=arn:aws:sns:us-west-2:0123456789012:my-topic,Warning=arn:aws:sns:us-west-2:0123456789012:my-topic,Error=arn:aws:sns:us-east-1:111222333444:ETS_Errors

Output:

{
   "Pipeline": {
       "Status": "Active",
       "ContentConfig": {
           "Bucket": "ets-example",
           "StorageClass": "Standard",
           "Permissions": [
               {
                   "Access": [
                       "FullControl"
                   ],
                   "Grantee": "marketing-promos@example.com",
                   "GranteeType": "Email"
               }
           ]
       },
       "Name": "Default",
       "ThumbnailConfig": {
           "Bucket": "ets-example",
           "StorageClass": "ReducedRedundancy",
           "Permissions": [
               {
                   "Access": [
                       "FullControl"
                   ],
                   "Grantee": "marketing-promos@example.com",
                   "GranteeType": "Email"
               }
           ]
       },
       "Notifications": {
           "Completed": "arn:aws:sns:us-west-2:0123456789012:my-topic",
           "Warning": "arn:aws:sns:us-west-2:0123456789012:my-topic",
           "Progressing": "arn:aws:sns:us-west-2:0123456789012:my-topic",
           "Error": "arn:aws:sns:us-east-1:111222333444:ETS_Errors"
       },
       "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role",
       "InputBucket": "ets-example",
       "Id": "1111111111111-abcde1",
       "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/1111111111111-abcde1"
   }
}

The following code example shows how to use update-pipeline-status.

Amazon CLI

To update the status of an ElasticTranscoder pipeline

This example updates the status of the specified ElasticTranscoder pipeline.

Command:

aws elastictranscoder update-pipeline-status --id 1111111111111-abcde1 --status Paused

Output:

{
   "Pipeline": {
       "Status": "Paused",
       "ContentConfig": {
           "Bucket": "ets-example",
           "StorageClass": "Standard",
           "Permissions": [
               {
                   "Access": [
                       "FullControl"
                   ],
                   "Grantee": "marketing-promos@example.com",
                   "GranteeType": "Email"
               }
           ]
       },
       "Name": "Default",
       "ThumbnailConfig": {
           "Bucket": "ets-example",
           "StorageClass": "ReducedRedundancy",
           "Permissions": [
               {
                   "Access": [
                       "FullControl"
                   ],
                   "Grantee": "marketing-promos@example.com",
                   "GranteeType": "Email"
               }
           ]
       },
       "Notifications": {
           "Completed": "",
           "Warning": "",
           "Progressing": "",
           "Error": "arn:aws:sns:us-east-1:803981987763:ETS_Errors"
       },
       "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role",
       "InputBucket": "ets-example",
       "Id": "1111111111111-abcde1",
       "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/1111111111111-abcde1"
   }
}

The following code example shows how to use update-pipeline.

Amazon CLI

To update an ElasticTranscoder pipeline

The following update-pipeline example updates the specified ElasticTranscoder pipeline.

aws elastictranscoder update-pipeline \
    --id 1111111111111-abcde1
    --name DefaultExample \
    --input-bucket salesoffice.example.com-source \
    --role arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role \
    --notifications Progressing="",Completed="",Warning="",Error=arn:aws:sns:us-east-1:111222333444:ETS_Errors \
    --content-config file://content-config.json \
    --thumbnail-config file://thumbnail-config.json

Contents of content-config.json:

{
    "Bucket":"salesoffice.example.com-public-promos",
    "Permissions":[
        {
            "GranteeType":"Email",
            "Grantee":"marketing-promos@example.com",
            "Access":[
                "FullControl"
            ]
        }
    ],
    "StorageClass":"Standard"
}

Contents of thumbnail-config.json:

{
    "Bucket":"salesoffice.example.com-public-promos-thumbnails",
    "Permissions":[
        {
            "GranteeType":"Email",
            "Grantee":"marketing-promos@example.com",
            "Access":[
                "FullControl"
            ]
        }
    ],
    "StorageClass":"ReducedRedundancy"
}

Output:

{
    "Pipeline": {
        "Status": "Active",
        "ContentConfig": {
            "Bucket": "ets-example",
            "StorageClass": "Standard",
            "Permissions": [
                {
                    "Access": [
                        "FullControl"
                    ],
                    "Grantee": "marketing-promos@example.com",
                    "GranteeType": "Email"
                }
            ]
        },
        "Name": "DefaultExample",
        "ThumbnailConfig": {
            "Bucket": "ets-example",
            "StorageClass": "ReducedRedundancy",
            "Permissions": [
                {
                    "Access": [
                        "FullControl"
                    ],
                    "Grantee": "marketing-promos@example.com",
                    "GranteeType": "Email"
                }
            ]
        },
        "Notifications": {
            "Completed": "",
            "Warning": "",
            "Progressing": "",
            "Error": "arn:aws:sns:us-east-1:111222333444:ETS_Errors"
        },
        "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role",
        "InputBucket": "ets-example",
        "Id": "3333333333333-abcde3",
        "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/3333333333333-abcde3"
    },
    "Warnings": [
        {
            "Message": "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.",
            "Code": "6006"
        }
    ]
}

  • For API details, see UpdatePipeline in Amazon CLI Command Reference.