Class: AWS::ElasticTranscoder::Client

Inherits:
Core::RESTJSONClient show all
Defined in:
lib/aws/elastic_transcoder/client.rb

Instance Attribute Summary

Attributes inherited from Core::Client

#config, #http_read_timeout

Instance Method Summary collapse

Methods inherited from Core::Client

#initialize, #log_warning, #operations, operations, #with_http_handler, #with_options

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#cancel_job(options = {}) ⇒ Core::Response

Calls the DELETE CancelJob API operation.

  • :id - required - (String) The identifier of the job that you want to delete. To get a list of the jobs (including their jobId) that have a status of Submitted, use the ListJobsByStatus API action.

Parameters:

  • options (Hash) (defaults to: {})

Returns:




# File 'lib/aws/elastic_transcoder/client.rb', line 38

#create_job(options = {}) ⇒ Core::Response

Calls the POST CreateJob API operation.

  • :pipeline_id - required - (String) The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

  • :input - required - (Hash) A section of the request body that provides information about the file that is being transcoded.

    • :key - (String) The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The InputBucket object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from. If the file name includes a prefix, such as cooking/lasagna.mpg, include the prefix in the key. If the file isn’t in the specified bucket, Elastic Transcoder returns an error.

    • :frame_rate - (String) The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify auto. If you want to specify the frame rate for the input file, enter one of the following values: 10, 15, 23.97, 24, 25, 29.97, 30, 60 If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame rate.

    • :resolution - (String) The resolution, in pixels, of the input file. If you want Elastic Transcoder to automatically detect the resolution of the input file, specify auto. If you want to specify the resolution for the input file, enter values in the format width in pixels by height in pixels. If you specify a value other than auto, Elastic Transcoder disables automatic detection of the resolution.

    • :aspect_ratio - (String) The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify auto. If you want to specify the aspect ratio for the output file, enter one of the following values: 1:1, 4:3, 3:2, 16:9 If you specify a value other than auto, Elastic Transcoder disables automatic detection of the aspect ratio.

    • :interlaced - (String) Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify auto. If you want to specify whether the input file is interlaced, enter one of the following values: true , false If you specify a value other than auto, Elastic Transcoder disables automatic detection of interlacing.

    • :container - (String) The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify auto. If you want to specify the container type for the input file, enter one of the following values: 3gp, asf, avi, divx, flv, mkv, mov, mp4, mpeg, mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm

  • :output - required - (Hash) A section of the request body that provides information about the transcoded (target) file.

    • :key - (String) The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails.

    • :thumbnail_pattern - (String) Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files. If you don’t want Elastic Transcoder to create thumbnails, specify “”. If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence: count (Required): If you want to create thumbnails, you must include count in the ThumbnailPattern object. Wherever you specify count, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. If you specify a literal value and/or resolution but you omit count, Elastic Transcoder returns a validation error and does not create the job. Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between resolution and count. resolution (Optional): If you want Elastic Transcoder to include the resolution in the file name, include resolution in the ThumbnailPattern object. When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.

    • :rotate - (String) The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: auto, 0, 90, 180, 270 The value auto generally works only if the file that you’re transcoding contains rotation metadata.

    • :preset_id - (String) The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :job - (Hash)

      • :id - (String)

      • :pipeline_id - (String)

      • :input - (Hash)

        • :key - (String)

        • :frame_rate - (String)

        • :resolution - (String)

        • :aspect_ratio - (String)

        • :interlaced - (String)

        • :container - (String)

      • :output - (Hash)

        • :key - (String)

        • :thumbnail_pattern - (String)

        • :rotate - (String)

        • :preset_id - (String)

        • :status - (String)

        • :status_detail - (String)




# File 'lib/aws/elastic_transcoder/client.rb', line 46

#create_pipeline(options = {}) ⇒ Core::Response

Calls the POST CreatePipeline API operation.

  • :name - required - (String) The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced. Constraints: Maximum 40 characters.

  • :input_bucket - required - (String) The Amazon S3 bucket in which you saved the media files that you want to transcode.

  • :output_bucket - required - (String) The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files.

  • :role - required - (String) The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.

  • :notifications - required - (Hash) The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console. Progressing: The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job. Completed: The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job. Warning: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. Error: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

    • :progressing - (String) The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

    • :completed - (String) The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

    • :warning - (String) The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

    • :error - (String) The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :pipeline - (Hash)

      • :id - (String)

      • :name - (String)

      • :status - (String)

      • :input_bucket - (String)

      • :output_bucket - (String)

      • :role - (String)

      • :notifications - (Hash)

        • :progressing - (String)

        • :completed - (String)

        • :warning - (String)

        • :error - (String)




# File 'lib/aws/elastic_transcoder/client.rb', line 157

#create_preset(options = {}) ⇒ Core::Response

Calls the POST CreatePreset API operation.

  • :name - required - (String) The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

  • :description - (String) A description of the preset.

  • :container - required - (String) The container type for the output file. This value must be mp4.

  • :video - required - (Hash) A section of the request body that specifies the video parameters.

    • :codec - (String) The video codec for the output file. This value must be H.264.

    • :codec_options - (Hash) Profile The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles: baseline: The profile most commonly used for videoconferencing and for mobile applications. main: The profile used for standard-definition digital TV broadcasts. high: The profile used for high-definition digital TV broadcasts and for Blu-ray discs. Level The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels: 1, 1b, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2, 4, 4.1 MaxReferenceFrames The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following: Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels * Height in pixels)), 16) where Width in pixels and Height in pixels represent the resolution of the output video and Maximum decoded picture buffer in macroblocks depends on the value of the Level object. (A macroblock is a block of pixels measuring 16x16.) Note that the calculation for maximum decoded picture buffer, which is similar to the calculation for maximum reference frames, uses macroblocks instead of pixels for the width and height of the video. To determine the value of maximum decoded picture buffer in macroblocks, see the following list (Level - Maximum decoded picture buffer): 1 - 396 1b - 396 1.1 - 900 1.2 - 2376 1.3 - 2376 2

      • 2376 2.1 - 4752 2.2 - 8100 3 - 8100 3.1 - 18000 3.2 - 20480 4 -

      32768 4.1 - 32768

    • :keyframes_max_dist - (String) The maximum number of frames between key frames. Key frames are fully encoded frames; the frames between key frames are encoded based, in part, on the content of the key frames. The value is an integer formatted as a string; valid values are between 1 and 100000, inclusive. A higher value results in higher compression but may also discernibly decrease video quality.

    • :fixed_gop - (String) Whether to use a fixed value for FixedGOP. Valid values are true and false : true : Elastic Transcoder uses the value of KeyframesMaxDist for the distance between key frames (the number of frames in a group of pictures, or GOP). false : The distance between key frames can vary.

    • :bit_rate - (String) The bit rate of the video stream in the output file, in kilobits/second. Valid values depend on the values of Level and Profile. We recommend that you specify a value less than or equal to the maximum H.264-compliant value listed in the following list for your level and profile: Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile) 1 - 64 : 80 1b - 128 : 160 1.1 - 192 : 240 1.2 - 384 : 480 1.3 - 768 : 960 2 - 2000 : 2500 3 - 10000 : 12500 3.1 - 14000 : 17500 3.2 - 20000 : 25000 4

      • 20000 : 25000 4.1 - 50000 : 62500

    • :frame_rate - (String) The frames per second for the video stream in the output file. Valid values include: auto, 10, 15, 23.97, 24, 25, 29.97, 30, 60 If you specify auto, Elastic Transcoder uses the detected frame rate of the input source. If you specify a frame rate, we recommend that you perform the following calculation: Frame rate = maximum recommended decoding speed in luma samples/second / (width in pixels * height in pixels) where: width in pixels and height in pixels represent the Resolution of the output video. maximum recommended decoding speed in Luma samples/second is less than or equal to the maximum value listed in the following table, based on the value that you specified for Level. The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (Level - Decoding speed): 1 - 380160 1b - 380160 1.1 - 76800 1.2 - 1536000 1.3 - 3041280 2 - 3041280 2.1 - 5068800 2.2 - 5184000 3 - 10368000 3.1 - 27648000 3.2 - 55296000 4 - 62914560 4.1 - 62914560

    • :resolution - (String) The width and height of the video in the output file, in pixels. Valid values are auto and width x height: auto: Elastic Transcoder attempts to preserve the width and height of the input file, subject to the following rules. width x height: The width and height of the output video in pixels. Note the following about specifying the width and height: The width must be an even integer between 128 and 4096, inclusive. The height must be an even integer between 96 and 3072, inclusive. If you specify a resolution that is less than the resolution of the input file, Elastic Transcoder rescales the output file to the lower resolution. If you specify a resolution that is greater than the resolution of the input file, Elastic Transcoder rescales the output to the higher resolution. We recommend that you specify a resolution for which the product of width and height is less than or equal to the applicable value in the following list (List - Max width x height value): 1 - 25344 1b - 25344 1.1 - 101376 1.2 - 101376 1.3 - 101376 2 - 101376 2.1 - 202752 2.2 - 404720 3 - 404720 3.1 - 921600 3.2 - 1310720 4 - 2097152 4.1 - 2097152

    • :aspect_ratio - (String) The display aspect ratio of the video in the output file. Valid values include: auto, 1:1, 4:3, 3:2, 16:9 If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the input file. If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to maintain the aspect ratio of the active region of the video.

  • :audio - required - (Hash) A section of the request body that specifies the audio parameters

    • :codec - (String) The audio codec for the output file. This value must be AAC.

    • :sample_rate - (String) The sample rate of the audio stream in the output file, in Hertz. Valid values include: auto, 22050, 32000, 44100, 48000, 96000 If you specify auto, Elastic Transcoder automatically detects the sample rate.

    • :bit_rate - (String) The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 8 and 320, inclusive.

    • :channels - (String) The number of audio channels in the output file. Valid values include: auto, 0, 1, 2 If you specify auto, Elastic Transcoder automatically detects the number of channels in the input file.

  • :thumbnails - required - (Hash) A section of the request body that specifies the thumbnail parameters, if any.

    • :format - (String) The format of thumbnails, if any. Valid values are jpg and png. You specify whether you want Elastic Transcoder to create thumbnails when you create a job.

    • :interval - (String) The number of seconds between thumbnails. Specify an integer value.

    • :resolution - (String) The width and height of thumbnail files in pixels. Specify a value in the format width x height where both values are even integers. The values cannot exceed the width and height that you specified in the Video:Resolution object.

    • :aspect_ratio - (String) The aspect ratio of thumbnails. Valid values include: auto, 1:1, 4:3, 3:2, 16:9 If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :preset - (Hash)

      • :id - (String)

      • :name - (String)

      • :description - (String)

      • :container - (String)

      • :audio - (Hash)

        • :codec - (String)

        • :sample_rate - (String)

        • :bit_rate - (String)

        • :channels - (String)

      • :video - (Hash)

        • :codec - (String)

        • :codec_options - (Hash<String,String>)

        • :keyframes_max_dist - (String)

        • :fixed_gop - (String)

        • :bit_rate - (String)

        • :frame_rate - (String)

        • :resolution - (String)

        • :aspect_ratio - (String)

      • :thumbnails - (Hash)

        • :format - (String)

        • :interval - (String)

        • :resolution - (String)

        • :aspect_ratio - (String)

      • :type - (String)

    • :warning - (String)




# File 'lib/aws/elastic_transcoder/client.rb', line 206

#delete_pipeline(options = {}) ⇒ Core::Response

Calls the DELETE DeletePipeline API operation.

  • :id - required - (String) The identifier of the pipeline that you want to delete.

Parameters:

  • options (Hash) (defaults to: {})

Returns:




# File 'lib/aws/elastic_transcoder/client.rb', line 369

#delete_preset(options = {}) ⇒ Core::Response

Calls the DELETE DeletePreset API operation.

  • :id - required - (String) The identifier of the preset for which you want to get detailed information.

Parameters:

  • options (Hash) (defaults to: {})

Returns:




# File 'lib/aws/elastic_transcoder/client.rb', line 376

#list_jobs_by_pipeline(options = {}) ⇒ Core::Response

Calls the GET ListJobsByPipeline API operation.

  • :pipeline_id - required - (String) The ID of the pipeline for which you want to get job information.

  • :ascending - (String) 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 .

  • :page_token - (String) When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :jobs - (Array<Hash>)

      • :id - (String)

      • :pipeline_id - (String)

      • :input - (Hash)

        • :key - (String)

        • :frame_rate - (String)

        • :resolution - (String)

        • :aspect_ratio - (String)

        • :interlaced - (String)

        • :container - (String)

      • :output - (Hash)

        • :key - (String)

        • :thumbnail_pattern - (String)

        • :rotate - (String)

        • :preset_id - (String)

        • :status - (String)

        • :status_detail - (String)

    • :next_page_token - (String)




# File 'lib/aws/elastic_transcoder/client.rb', line 383

#list_jobs_by_status(options = {}) ⇒ Core::Response

Calls the GET ListJobsByStatus API operation.

  • :status - required - (String) To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Completed, Canceled, or Error.

  • :ascending - (String) 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 .

  • :page_token - (String) When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :jobs - (Array<Hash>)

      • :id - (String)

      • :pipeline_id - (String)

      • :input - (Hash)

        • :key - (String)

        • :frame_rate - (String)

        • :resolution - (String)

        • :aspect_ratio - (String)

        • :interlaced - (String)

        • :container - (String)

      • :output - (Hash)

        • :key - (String)

        • :thumbnail_pattern - (String)

        • :rotate - (String)

        • :preset_id - (String)

        • :status - (String)

        • :status_detail - (String)

    • :next_page_token - (String)




# File 'lib/aws/elastic_transcoder/client.rb', line 416

#list_pipelines(options = {}) ⇒ Core::Response

Calls the GET ListPipelines API operation.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :pipelines - (Array<Hash>)

      • :id - (String)

      • :name - (String)

      • :status - (String)

      • :input_bucket - (String)

      • :output_bucket - (String)

      • :role - (String)

      • :notifications - (Hash)

        • :progressing - (String)

        • :completed - (String)

        • :warning - (String)

        • :error - (String)




# File 'lib/aws/elastic_transcoder/client.rb', line 451

#list_presets(options = {}) ⇒ Core::Response

Calls the GET ListPresets API operation.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :presets - (Array<Hash>)

      • :id - (String)

      • :name - (String)

      • :description - (String)

      • :container - (String)

      • :audio - (Hash)

        • :codec - (String)

        • :sample_rate - (String)

        • :bit_rate - (String)

        • :channels - (String)

      • :video - (Hash)

        • :codec - (String)

        • :codec_options - (Hash<String,String>)

        • :keyframes_max_dist - (String)

        • :fixed_gop - (String)

        • :bit_rate - (String)

        • :frame_rate - (String)

        • :resolution - (String)

        • :aspect_ratio - (String)

      • :thumbnails - (Hash)

        • :format - (String)

        • :interval - (String)

        • :resolution - (String)

        • :aspect_ratio - (String)

      • :type - (String)




# File 'lib/aws/elastic_transcoder/client.rb', line 470

#read_job(options = {}) ⇒ Core::Response

Calls the GET ReadJob API operation.

  • :id - required - (String) The identifier of the job for which you want to get detailed information.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :job - (Hash)

      • :id - (String)

      • :pipeline_id - (String)

      • :input - (Hash)

        • :key - (String)

        • :frame_rate - (String)

        • :resolution - (String)

        • :aspect_ratio - (String)

        • :interlaced - (String)

        • :container - (String)

      • :output - (Hash)

        • :key - (String)

        • :thumbnail_pattern - (String)

        • :rotate - (String)

        • :preset_id - (String)

        • :status - (String)

        • :status_detail - (String)




# File 'lib/aws/elastic_transcoder/client.rb', line 502

#read_pipeline(options = {}) ⇒ Core::Response

Calls the GET ReadPipeline API operation.

  • :id - required - (String) The identifier of the pipeline to read.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :pipeline - (Hash)

      • :id - (String)

      • :name - (String)

      • :status - (String)

      • :input_bucket - (String)

      • :output_bucket - (String)

      • :role - (String)

      • :notifications - (Hash)

        • :progressing - (String)

        • :completed - (String)

        • :warning - (String)

        • :error - (String)




# File 'lib/aws/elastic_transcoder/client.rb', line 528

#read_preset(options = {}) ⇒ Core::Response

Calls the GET ReadPreset API operation.

  • :id - required - (String) The identifier of the preset for which you want to get detailed information.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :preset - (Hash)

      • :id - (String)

      • :name - (String)

      • :description - (String)

      • :container - (String)

      • :audio - (Hash)

        • :codec - (String)

        • :sample_rate - (String)

        • :bit_rate - (String)

        • :channels - (String)

      • :video - (Hash)

        • :codec - (String)

        • :codec_options - (Hash<String,String>)

        • :keyframes_max_dist - (String)

        • :fixed_gop - (String)

        • :bit_rate - (String)

        • :frame_rate - (String)

        • :resolution - (String)

        • :aspect_ratio - (String)

      • :thumbnails - (Hash)

        • :format - (String)

        • :interval - (String)

        • :resolution - (String)

        • :aspect_ratio - (String)

      • :type - (String)




# File 'lib/aws/elastic_transcoder/client.rb', line 548

#test_role(options = {}) ⇒ Core::Response

Calls the POST TestRole API operation.

  • :role - required - (String) The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.

  • :input_bucket - required - (String) The Amazon S3 bucket in which you saved the media files that you want to transcode.

  • :output_bucket - required - (String) The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files.

  • :topics - required - (Array<String>) The Amazon Simple Notification Service (Amazon SNS) topics that you want to notify to report job status.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :success - (String)

    • :messages - (Array<String>)




# File 'lib/aws/elastic_transcoder/client.rb', line 582

#update_pipeline_notifications(options = {}) ⇒ Core::Response

Calls the POST UpdatePipelineNotifications API operation.

  • :id - required - (String) The identifier of the pipeline for which you want to change notification settings.

  • :notifications - required - (Hash) The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console. Progressing: The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job. Completed: The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job. Warning: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. Error: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

    • :progressing - (String) The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

    • :completed - (String) The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

    • :warning - (String) The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

    • :error - (String) The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :pipeline - (Hash)

      • :id - (String)

      • :name - (String)

      • :status - (String)

      • :input_bucket - (String)

      • :output_bucket - (String)

      • :role - (String)

      • :notifications - (Hash)

        • :progressing - (String)

        • :completed - (String)

        • :warning - (String)

        • :error - (String)




# File 'lib/aws/elastic_transcoder/client.rb', line 601

#update_pipeline_status(options = {}) ⇒ Core::Response

Calls the POST UpdatePipelineStatus API operation.

  • :id - required - (String) The identifier of the pipeline to update.

  • :status - required - (String) The new status of the pipeline: active: Enable the pipeline, so it starts processing jobs. paused: Disable the pipeline, so it stops processing jobs.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :pipeline - (Hash)

      • :id - (String)

      • :name - (String)

      • :status - (String)

      • :input_bucket - (String)

      • :output_bucket - (String)

      • :role - (String)

      • :notifications - (Hash)

        • :progressing - (String)

        • :completed - (String)

        • :warning - (String)

        • :error - (String)




# File 'lib/aws/elastic_transcoder/client.rb', line 642