You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElasticTranscoder::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Amazon Elastic Transcoder. To construct a client, you need to configure a :region and :credentials.

elastictranscoder = Aws::ElasticTranscoder::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::ElasticTranscoder::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::ElasticTranscoder::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#cancel_job(options = {}) ⇒ Struct

The CancelJob operation cancels an unfinished job.

You can only cancel a job that has a status of Submitted. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline.

Examples:

Request syntax with placeholder values


resp = client.cancel_job({
  id: "Id", # required
})

Options Hash (options):

  • :id (required, String)

    The identifier of the job that you want to cancel.

    To get a list of the jobs (including their jobId) that have a status of Submitted, use the ListJobsByStatus API action.

Returns:

  • (Struct)

    Returns an empty response.

#create_job(options = {}) ⇒ Types::CreateJobResponse

When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created.

If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console).

Examples:

Request syntax with placeholder values


resp = client.create_job({
  pipeline_id: "Id", # required
  input: {
    key: "LongKey",
    frame_rate: "FrameRate",
    resolution: "Resolution",
    aspect_ratio: "AspectRatio",
    interlaced: "Interlaced",
    container: "JobContainer",
    encryption: {
      mode: "EncryptionMode",
      key: "Base64EncodedString",
      key_md_5: "Base64EncodedString",
      initialization_vector: "ZeroTo255String",
    },
    time_span: {
      start_time: "Time",
      duration: "Time",
    },
    input_captions: {
      merge_policy: "CaptionMergePolicy",
      caption_sources: [
        {
          key: "LongKey",
          language: "Key",
          time_offset: "TimeOffset",
          label: "Name",
          encryption: {
            mode: "EncryptionMode",
            key: "Base64EncodedString",
            key_md_5: "Base64EncodedString",
            initialization_vector: "ZeroTo255String",
          },
        },
      ],
    },
    detected_properties: {
      width: 1,
      height: 1,
      frame_rate: "FloatString",
      file_size: 1,
      duration_millis: 1,
    },
  },
  inputs: [
    {
      key: "LongKey",
      frame_rate: "FrameRate",
      resolution: "Resolution",
      aspect_ratio: "AspectRatio",
      interlaced: "Interlaced",
      container: "JobContainer",
      encryption: {
        mode: "EncryptionMode",
        key: "Base64EncodedString",
        key_md_5: "Base64EncodedString",
        initialization_vector: "ZeroTo255String",
      },
      time_span: {
        start_time: "Time",
        duration: "Time",
      },
      input_captions: {
        merge_policy: "CaptionMergePolicy",
        caption_sources: [
          {
            key: "LongKey",
            language: "Key",
            time_offset: "TimeOffset",
            label: "Name",
            encryption: {
              mode: "EncryptionMode",
              key: "Base64EncodedString",
              key_md_5: "Base64EncodedString",
              initialization_vector: "ZeroTo255String",
            },
          },
        ],
      },
      detected_properties: {
        width: 1,
        height: 1,
        frame_rate: "FloatString",
        file_size: 1,
        duration_millis: 1,
      },
    },
  ],
  output: {
    key: "Key",
    thumbnail_pattern: "ThumbnailPattern",
    thumbnail_encryption: {
      mode: "EncryptionMode",
      key: "Base64EncodedString",
      key_md_5: "Base64EncodedString",
      initialization_vector: "ZeroTo255String",
    },
    rotate: "Rotate",
    preset_id: "Id",
    segment_duration: "FloatString",
    watermarks: [
      {
        preset_watermark_id: "PresetWatermarkId",
        input_key: "WatermarkKey",
        encryption: {
          mode: "EncryptionMode",
          key: "Base64EncodedString",
          key_md_5: "Base64EncodedString",
          initialization_vector: "ZeroTo255String",
        },
      },
    ],
    album_art: {
      merge_policy: "MergePolicy",
      artwork: [
        {
          input_key: "WatermarkKey",
          max_width: "DigitsOrAuto",
          max_height: "DigitsOrAuto",
          sizing_policy: "SizingPolicy",
          padding_policy: "PaddingPolicy",
          album_art_format: "JpgOrPng",
          encryption: {
            mode: "EncryptionMode",
            key: "Base64EncodedString",
            key_md_5: "Base64EncodedString",
            initialization_vector: "ZeroTo255String",
          },
        },
      ],
    },
    composition: [
      {
        time_span: {
          start_time: "Time",
          duration: "Time",
        },
      },
    ],
    captions: {
      merge_policy: "CaptionMergePolicy",
      caption_sources: [
        {
          key: "LongKey",
          language: "Key",
          time_offset: "TimeOffset",
          label: "Name",
          encryption: {
            mode: "EncryptionMode",
            key: "Base64EncodedString",
            key_md_5: "Base64EncodedString",
            initialization_vector: "ZeroTo255String",
          },
        },
      ],
      caption_formats: [
        {
          format: "CaptionFormatFormat",
          pattern: "CaptionFormatPattern",
          encryption: {
            mode: "EncryptionMode",
            key: "Base64EncodedString",
            key_md_5: "Base64EncodedString",
            initialization_vector: "ZeroTo255String",
          },
        },
      ],
    },
    encryption: {
      mode: "EncryptionMode",
      key: "Base64EncodedString",
      key_md_5: "Base64EncodedString",
      initialization_vector: "ZeroTo255String",
    },
  },
  outputs: [
    {
      key: "Key",
      thumbnail_pattern: "ThumbnailPattern",
      thumbnail_encryption: {
        mode: "EncryptionMode",
        key: "Base64EncodedString",
        key_md_5: "Base64EncodedString",
        initialization_vector: "ZeroTo255String",
      },
      rotate: "Rotate",
      preset_id: "Id",
      segment_duration: "FloatString",
      watermarks: [
        {
          preset_watermark_id: "PresetWatermarkId",
          input_key: "WatermarkKey",
          encryption: {
            mode: "EncryptionMode",
            key: "Base64EncodedString",
            key_md_5: "Base64EncodedString",
            initialization_vector: "ZeroTo255String",
          },
        },
      ],
      album_art: {
        merge_policy: "MergePolicy",
        artwork: [
          {
            input_key: "WatermarkKey",
            max_width: "DigitsOrAuto",
            max_height: "DigitsOrAuto",
            sizing_policy: "SizingPolicy",
            padding_policy: "PaddingPolicy",
            album_art_format: "JpgOrPng",
            encryption: {
              mode: "EncryptionMode",
              key: "Base64EncodedString",
              key_md_5: "Base64EncodedString",
              initialization_vector: "ZeroTo255String",
            },
          },
        ],
      },
      composition: [
        {
          time_span: {
            start_time: "Time",
            duration: "Time",
          },
        },
      ],
      captions: {
        merge_policy: "CaptionMergePolicy",
        caption_sources: [
          {
            key: "LongKey",
            language: "Key",
            time_offset: "TimeOffset",
            label: "Name",
            encryption: {
              mode: "EncryptionMode",
              key: "Base64EncodedString",
              key_md_5: "Base64EncodedString",
              initialization_vector: "ZeroTo255String",
            },
          },
        ],
        caption_formats: [
          {
            format: "CaptionFormatFormat",
            pattern: "CaptionFormatPattern",
            encryption: {
              mode: "EncryptionMode",
              key: "Base64EncodedString",
              key_md_5: "Base64EncodedString",
              initialization_vector: "ZeroTo255String",
            },
          },
        ],
      },
      encryption: {
        mode: "EncryptionMode",
        key: "Base64EncodedString",
        key_md_5: "Base64EncodedString",
        initialization_vector: "ZeroTo255String",
      },
    },
  ],
  output_key_prefix: "Key",
  playlists: [
    {
      name: "Filename",
      format: "PlaylistFormat",
      output_keys: ["Key"],
      hls_content_protection: {
        method: "HlsContentProtectionMethod",
        key: "Base64EncodedString",
        key_md_5: "Base64EncodedString",
        initialization_vector: "ZeroTo255String",
        license_acquisition_url: "ZeroTo512String",
        key_storage_policy: "KeyStoragePolicy",
      },
      play_ready_drm: {
        format: "PlayReadyDrmFormatString",
        key: "NonEmptyBase64EncodedString",
        key_md_5: "NonEmptyBase64EncodedString",
        key_id: "KeyIdGuid",
        initialization_vector: "ZeroTo255String",
        license_acquisition_url: "OneTo512String",
      },
    },
  ],
  user_metadata: {
    "String" => "String",
  },
})

Response structure


resp.job.id #=> String
resp.job.arn #=> String
resp.job.pipeline_id #=> String
resp.job.input.key #=> String
resp.job.input.frame_rate #=> String
resp.job.input.resolution #=> String
resp.job.input.aspect_ratio #=> String
resp.job.input.interlaced #=> String
resp.job.input.container #=> String
resp.job.input.encryption.mode #=> String
resp.job.input.encryption.key #=> String
resp.job.input.encryption.key_md_5 #=> String
resp.job.input.encryption.initialization_vector #=> String
resp.job.input.time_span.start_time #=> String
resp.job.input.time_span.duration #=> String
resp.job.input.input_captions.merge_policy #=> String
resp.job.input.input_captions.caption_sources #=> Array
resp.job.input.input_captions.caption_sources[0].key #=> String
resp.job.input.input_captions.caption_sources[0].language #=> String
resp.job.input.input_captions.caption_sources[0].time_offset #=> String
resp.job.input.input_captions.caption_sources[0].label #=> String
resp.job.input.input_captions.caption_sources[0].encryption.mode #=> String
resp.job.input.input_captions.caption_sources[0].encryption.key #=> String
resp.job.input.input_captions.caption_sources[0].encryption.key_md_5 #=> String
resp.job.input.input_captions.caption_sources[0].encryption.initialization_vector #=> String
resp.job.input.detected_properties.width #=> Integer
resp.job.input.detected_properties.height #=> Integer
resp.job.input.detected_properties.frame_rate #=> String
resp.job.input.detected_properties.file_size #=> Integer
resp.job.input.detected_properties.duration_millis #=> Integer
resp.job.inputs #=> Array
resp.job.inputs[0].key #=> String
resp.job.inputs[0].frame_rate #=> String
resp.job.inputs[0].resolution #=> String
resp.job.inputs[0].aspect_ratio #=> String
resp.job.inputs[0].interlaced #=> String
resp.job.inputs[0].container #=> String
resp.job.inputs[0].encryption.mode #=> String
resp.job.inputs[0].encryption.key #=> String
resp.job.inputs[0].encryption.key_md_5 #=> String
resp.job.inputs[0].encryption.initialization_vector #=> String
resp.job.inputs[0].time_span.start_time #=> String
resp.job.inputs[0].time_span.duration #=> String
resp.job.inputs[0].input_captions.merge_policy #=> String
resp.job.inputs[0].input_captions.caption_sources #=> Array
resp.job.inputs[0].input_captions.caption_sources[0].key #=> String
resp.job.inputs[0].input_captions.caption_sources[0].language #=> String
resp.job.inputs[0].input_captions.caption_sources[0].time_offset #=> String
resp.job.inputs[0].input_captions.caption_sources[0].label #=> String
resp.job.inputs[0].input_captions.caption_sources[0].encryption.mode #=> String
resp.job.inputs[0].input_captions.caption_sources[0].encryption.key #=> String
resp.job.inputs[0].input_captions.caption_sources[0].encryption.key_md_5 #=> String
resp.job.inputs[0].input_captions.caption_sources[0].encryption.initialization_vector #=> String
resp.job.inputs[0].detected_properties.width #=> Integer
resp.job.inputs[0].detected_properties.height #=> Integer
resp.job.inputs[0].detected_properties.frame_rate #=> String
resp.job.inputs[0].detected_properties.file_size #=> Integer
resp.job.inputs[0].detected_properties.duration_millis #=> Integer
resp.job.output.id #=> String
resp.job.output.key #=> String
resp.job.output.thumbnail_pattern #=> String
resp.job.output.thumbnail_encryption.mode #=> String
resp.job.output.thumbnail_encryption.key #=> String
resp.job.output.thumbnail_encryption.key_md_5 #=> String
resp.job.output.thumbnail_encryption.initialization_vector #=> String
resp.job.output.rotate #=> String
resp.job.output.preset_id #=> String
resp.job.output.segment_duration #=> String
resp.job.output.status #=> String
resp.job.output.status_detail #=> String
resp.job.output.duration #=> Integer
resp.job.output.width #=> Integer
resp.job.output.height #=> Integer
resp.job.output.frame_rate #=> String
resp.job.output.file_size #=> Integer
resp.job.output.duration_millis #=> Integer
resp.job.output.watermarks #=> Array
resp.job.output.watermarks[0].preset_watermark_id #=> String
resp.job.output.watermarks[0].input_key #=> String
resp.job.output.watermarks[0].encryption.mode #=> String
resp.job.output.watermarks[0].encryption.key #=> String
resp.job.output.watermarks[0].encryption.key_md_5 #=> String
resp.job.output.watermarks[0].encryption.initialization_vector #=> String
resp.job.output.album_art.merge_policy #=> String
resp.job.output.album_art.artwork #=> Array
resp.job.output.album_art.artwork[0].input_key #=> String
resp.job.output.album_art.artwork[0].max_width #=> String
resp.job.output.album_art.artwork[0].max_height #=> String
resp.job.output.album_art.artwork[0].sizing_policy #=> String
resp.job.output.album_art.artwork[0].padding_policy #=> String
resp.job.output.album_art.artwork[0].album_art_format #=> String
resp.job.output.album_art.artwork[0].encryption.mode #=> String
resp.job.output.album_art.artwork[0].encryption.key #=> String
resp.job.output.album_art.artwork[0].encryption.key_md_5 #=> String
resp.job.output.album_art.artwork[0].encryption.initialization_vector #=> String
resp.job.output.composition #=> Array
resp.job.output.composition[0].time_span.start_time #=> String
resp.job.output.composition[0].time_span.duration #=> String
resp.job.output.captions.merge_policy #=> String
resp.job.output.captions.caption_sources #=> Array
resp.job.output.captions.caption_sources[0].key #=> String
resp.job.output.captions.caption_sources[0].language #=> String
resp.job.output.captions.caption_sources[0].time_offset #=> String
resp.job.output.captions.caption_sources[0].label #=> String
resp.job.output.captions.caption_sources[0].encryption.mode #=> String
resp.job.output.captions.caption_sources[0].encryption.key #=> String
resp.job.output.captions.caption_sources[0].encryption.key_md_5 #=> String
resp.job.output.captions.caption_sources[0].encryption.initialization_vector #=> String
resp.job.output.captions.caption_formats #=> Array
resp.job.output.captions.caption_formats[0].format #=> String
resp.job.output.captions.caption_formats[0].pattern #=> String
resp.job.output.captions.caption_formats[0].encryption.mode #=> String
resp.job.output.captions.caption_formats[0].encryption.key #=> String
resp.job.output.captions.caption_formats[0].encryption.key_md_5 #=> String
resp.job.output.captions.caption_formats[0].encryption.initialization_vector #=> String
resp.job.output.encryption.mode #=> String
resp.job.output.encryption.key #=> String
resp.job.output.encryption.key_md_5 #=> String
resp.job.output.encryption.initialization_vector #=> String
resp.job.output.applied_color_space_conversion #=> String
resp.job.outputs #=> Array
resp.job.outputs[0].id #=> String
resp.job.outputs[0].key #=> String
resp.job.outputs[0].thumbnail_pattern #=> String
resp.job.outputs[0].thumbnail_encryption.mode #=> String
resp.job.outputs[0].thumbnail_encryption.key #=> String
resp.job.outputs[0].thumbnail_encryption.key_md_5 #=> String
resp.job.outputs[0].thumbnail_encryption.initialization_vector #=> String
resp.job.outputs[0].rotate #=> String
resp.job.outputs[0].preset_id #=> String
resp.job.outputs[0].segment_duration #=> String
resp.job.outputs[0].status #=> String
resp.job.outputs[0].status_detail #=> String
resp.job.outputs[0].duration #=> Integer
resp.job.outputs[0].width #=> Integer
resp.job.outputs[0].height #=> Integer
resp.job.outputs[0].frame_rate #=> String
resp.job.outputs[0].file_size #=> Integer
resp.job.outputs[0].duration_millis #=> Integer
resp.job.outputs[0].watermarks #=> Array
resp.job.outputs[0].watermarks[0].preset_watermark_id #=> String
resp.job.outputs[0].watermarks[0].input_key #=> String
resp.job.outputs[0].watermarks[0].encryption.mode #=> String
resp.job.outputs[0].watermarks[0].encryption.key #=> String
resp.job.outputs[0].watermarks[0].encryption.key_md_5 #=> String
resp.job.outputs[0].watermarks[0].encryption.initialization_vector #=> String
resp.job.outputs[0].album_art.merge_policy #=> String
resp.job.outputs[0].album_art.artwork #=> Array
resp.job.outputs[0].album_art.artwork[0].input_key #=> String
resp.job.outputs[0].album_art.artwork[0].max_width #=> String
resp.job.outputs[0].album_art.artwork[0].max_height #=> String
resp.job.outputs[0].album_art.artwork[0].sizing_policy #=> String
resp.job.outputs[0].album_art.artwork[0].padding_policy #=> String
resp.job.outputs[0].album_art.artwork[0].album_art_format #=> String
resp.job.outputs[0].album_art.artwork[0].encryption.mode #=> String
resp.job.outputs[0].album_art.artwork[0].encryption.key #=> String
resp.job.outputs[0].album_art.artwork[0].encryption.key_md_5 #=> String
resp.job.outputs[0].album_art.artwork[0].encryption.initialization_vector #=> String
resp.job.outputs[0].composition #=> Array
resp.job.outputs[0].composition[0].time_span.start_time #=> String
resp.job.outputs[0].composition[0].time_span.duration #=> String
resp.job.outputs[0].captions.merge_policy #=> String
resp.job.outputs[0].captions.caption_sources #=> Array
resp.job.outputs[0].captions.caption_sources[0].key #=> String
resp.job.outputs[0].captions.caption_sources[0].language #=> String
resp.job.outputs[0].captions.caption_sources[0].time_offset #=> String
resp.job.outputs[0].captions.caption_sources[0].label #=> String
resp.job.outputs[0].captions.caption_sources[0].encryption.mode #=> String
resp.job.outputs[0].captions.caption_sources[0].encryption.key #=> String
resp.job.outputs[0].captions.caption_sources[0].encryption.key_md_5 #=> String
resp.job.outputs[0].captions.caption_sources[0].encryption.initialization_vector #=> String
resp.job.outputs[0].captions.caption_formats #=> Array
resp.job.outputs[0].captions.caption_formats[0].format #=> String
resp.job.outputs[0].captions.caption_formats[0].pattern #=> String
resp.job.outputs[0].captions.caption_formats[0].encryption.mode #=> String
resp.job.outputs[0].captions.caption_formats[0].encryption.key #=> String
resp.job.outputs[0].captions.caption_formats[0].encryption.key_md_5 #=> String
resp.job.outputs[0].captions.caption_formats[0].encryption.initialization_vector #=> String
resp.job.outputs[0].encryption.mode #=> String
resp.job.outputs[0].encryption.key #=> String
resp.job.outputs[0].encryption.key_md_5 #=> String
resp.job.outputs[0].encryption.initialization_vector #=> String
resp.job.outputs[0].applied_color_space_conversion #=> String
resp.job.output_key_prefix #=> String
resp.job.playlists #=> Array
resp.job.playlists[0].name #=> String
resp.job.playlists[0].format #=> String
resp.job.playlists[0].output_keys #=> Array
resp.job.playlists[0].output_keys[0] #=> String
resp.job.playlists[0].hls_content_protection.method #=> String
resp.job.playlists[0].hls_content_protection.key #=> String
resp.job.playlists[0].hls_content_protection.key_md_5 #=> String
resp.job.playlists[0].hls_content_protection.initialization_vector #=> String
resp.job.playlists[0].hls_content_protection.license_acquisition_url #=> String
resp.job.playlists[0].hls_content_protection.key_storage_policy #=> String
resp.job.playlists[0].play_ready_drm.format #=> String
resp.job.playlists[0].play_ready_drm.key #=> String
resp.job.playlists[0].play_ready_drm.key_md_5 #=> String
resp.job.playlists[0].play_ready_drm.key_id #=> String
resp.job.playlists[0].play_ready_drm.initialization_vector #=> String
resp.job.playlists[0].play_ready_drm.license_acquisition_url #=> String
resp.job.playlists[0].status #=> String
resp.job.playlists[0].status_detail #=> String
resp.job.status #=> String
resp.job. #=> Hash
resp.job.["String"] #=> String
resp.job.timing.submit_time_millis #=> Integer
resp.job.timing.start_time_millis #=> Integer
resp.job.timing.finish_time_millis #=> Integer

Options Hash (options):

  • :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 (Types::JobInput)

    A section of the request body that provides information about the file that is being transcoded.

  • :inputs (Array<Types::JobInput>)

    A section of the request body that provides information about the files that are being transcoded.

  • :output (Types::CreateJobOutput)

    A section of the request body that provides information about the transcoded (target) file. We strongly recommend that you use the Outputs syntax instead of the Output syntax.

  • :outputs (Array<Types::CreateJobOutput>)

    A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.

  • :output_key_prefix (String)

    The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.

  • :playlists (Array<Types::CreateJobPlaylist>)

    If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

    The maximum number of master playlists in a job is 30.

  • :user_metadata (Hash<String,String>)

    User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder does not guarantee that key/value pairs are returned in the same order in which you specify them.

Returns:

#create_pipeline(options = {}) ⇒ Types::CreatePipelineResponse

The CreatePipeline operation creates a pipeline with settings that you specify.

Examples:

Request syntax with placeholder values


resp = client.create_pipeline({
  name: "Name", # required
  input_bucket: "BucketName", # required
  output_bucket: "BucketName",
  role: "Role", # required
  aws_kms_key_arn: "KeyArn",
  notifications: {
    progressing: "SnsTopic",
    completed: "SnsTopic",
    warning: "SnsTopic",
    error: "SnsTopic",
  },
  content_config: {
    bucket: "BucketName",
    storage_class: "StorageClass",
    permissions: [
      {
        grantee_type: "GranteeType",
        grantee: "Grantee",
        access: ["AccessControl"],
      },
    ],
  },
  thumbnail_config: {
    bucket: "BucketName",
    storage_class: "StorageClass",
    permissions: [
      {
        grantee_type: "GranteeType",
        grantee: "Grantee",
        access: ["AccessControl"],
      },
    ],
  },
})

Response structure


resp.pipeline.id #=> String
resp.pipeline.arn #=> String
resp.pipeline.name #=> String
resp.pipeline.status #=> String
resp.pipeline.input_bucket #=> String
resp.pipeline.output_bucket #=> String
resp.pipeline.role #=> String
resp.pipeline.aws_kms_key_arn #=> String
resp.pipeline.notifications.progressing #=> String
resp.pipeline.notifications.completed #=> String
resp.pipeline.notifications.warning #=> String
resp.pipeline.notifications.error #=> String
resp.pipeline.content_config.bucket #=> String
resp.pipeline.content_config.storage_class #=> String
resp.pipeline.content_config.permissions #=> Array
resp.pipeline.content_config.permissions[0].grantee_type #=> String
resp.pipeline.content_config.permissions[0].grantee #=> String
resp.pipeline.content_config.permissions[0].access #=> Array
resp.pipeline.content_config.permissions[0].access[0] #=> String
resp.pipeline.thumbnail_config.bucket #=> String
resp.pipeline.thumbnail_config.storage_class #=> String
resp.pipeline.thumbnail_config.permissions #=> Array
resp.pipeline.thumbnail_config.permissions[0].grantee_type #=> String
resp.pipeline.thumbnail_config.permissions[0].grantee #=> String
resp.pipeline.thumbnail_config.permissions[0].access #=> Array
resp.pipeline.thumbnail_config.permissions[0].access[0] #=> String
resp.warnings #=> Array
resp.warnings[0].code #=> String
resp.warnings[0].message #=> String

Options Hash (options):

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

    The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)

    Specify this value when all of the following are true:

    • You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.

    • You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.

    • You do not want to specify the permissions that Elastic Transcoder grants to the files.

      When Elastic Transcoder saves files in OutputBucket, it grants full control over the files only to the AWS account that owns the role that is specified by Role.

    • You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.

    If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead.

  • :role (required, String)

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

  • :aws_kms_key_arn (String)

    The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

    If you use either S3 or S3-AWS-KMS as your Encryption:Mode, you don\'t need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of AES-PKCS7, AES-CTR, or AES-GCM.

  • :notifications (Types::Notifications)

    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 topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.

    • Completed: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

    • Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

    • Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

  • :content_config (Types::PipelineOutputConfig)

    The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

    If you specify values for ContentConfig, you must also specify values for ThumbnailConfig.

    If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

    • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

    • Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

    • Grantee Type: Specify the type of value that appears in the Grantee object:

      • Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content.

        A canonical user ID is not the same as an AWS account number.

      • Email: The value in the Grantee object is the registered email address of an AWS account.

      • Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group

    • Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include:

      • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

  • :thumbnail_config (Types::PipelineOutputConfig)

    The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

    If you specify values for ContentConfig, you must also specify values for ThumbnailConfig even if you don\'t want to create thumbnails.

    If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

    • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

    • Permissions (Optional): The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

    • GranteeType: Specify the type of value that appears in the Grantee object:

      • Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

        A canonical user ID is not the same as an AWS account number.

      • Email: The value in the Grantee object is the registered email address of an AWS account.

      • Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.

    • Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include:

      • READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

    • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

Returns:

#create_preset(options = {}) ⇒ Types::CreatePresetResponse

The CreatePreset operation creates a preset with settings that you specify.

Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (ValidationException) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces.

Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services.

Examples:

Request syntax with placeholder values


resp = client.create_preset({
  name: "Name", # required
  description: "Description",
  container: "PresetContainer", # required
  video: {
    codec: "VideoCodec",
    codec_options: {
      "CodecOption" => "CodecOption",
    },
    keyframes_max_dist: "KeyframesMaxDist",
    fixed_gop: "FixedGOP",
    bit_rate: "VideoBitRate",
    frame_rate: "FrameRate",
    max_frame_rate: "MaxFrameRate",
    resolution: "Resolution",
    aspect_ratio: "AspectRatio",
    max_width: "DigitsOrAuto",
    max_height: "DigitsOrAuto",
    display_aspect_ratio: "AspectRatio",
    sizing_policy: "SizingPolicy",
    padding_policy: "PaddingPolicy",
    watermarks: [
      {
        id: "PresetWatermarkId",
        max_width: "PixelsOrPercent",
        max_height: "PixelsOrPercent",
        sizing_policy: "WatermarkSizingPolicy",
        horizontal_align: "HorizontalAlign",
        horizontal_offset: "PixelsOrPercent",
        vertical_align: "VerticalAlign",
        vertical_offset: "PixelsOrPercent",
        opacity: "Opacity",
        target: "Target",
      },
    ],
  },
  audio: {
    codec: "AudioCodec",
    sample_rate: "AudioSampleRate",
    bit_rate: "AudioBitRate",
    channels: "AudioChannels",
    audio_packing_mode: "AudioPackingMode",
    codec_options: {
      profile: "AudioCodecProfile",
      bit_depth: "AudioBitDepth",
      bit_order: "AudioBitOrder",
      signed: "AudioSigned",
    },
  },
  thumbnails: {
    format: "JpgOrPng",
    interval: "Digits",
    resolution: "ThumbnailResolution",
    aspect_ratio: "AspectRatio",
    max_width: "DigitsOrAuto",
    max_height: "DigitsOrAuto",
    sizing_policy: "SizingPolicy",
    padding_policy: "PaddingPolicy",
  },
})

Response structure


resp.preset.id #=> String
resp.preset.arn #=> String
resp.preset.name #=> String
resp.preset.description #=> String
resp.preset.container #=> String
resp.preset.audio.codec #=> String
resp.preset.audio.sample_rate #=> String
resp.preset.audio.bit_rate #=> String
resp.preset.audio.channels #=> String
resp.preset.audio.audio_packing_mode #=> String
resp.preset.audio.codec_options.profile #=> String
resp.preset.audio.codec_options.bit_depth #=> String
resp.preset.audio.codec_options.bit_order #=> String
resp.preset.audio.codec_options.signed #=> String
resp.preset.video.codec #=> String
resp.preset.video.codec_options #=> Hash
resp.preset.video.codec_options["CodecOption"] #=> String
resp.preset.video.keyframes_max_dist #=> String
resp.preset.video.fixed_gop #=> String
resp.preset.video.bit_rate #=> String
resp.preset.video.frame_rate #=> String
resp.preset.video.max_frame_rate #=> String
resp.preset.video.resolution #=> String
resp.preset.video.aspect_ratio #=> String
resp.preset.video.max_width #=> String
resp.preset.video.max_height #=> String
resp.preset.video.display_aspect_ratio #=> String
resp.preset.video.sizing_policy #=> String
resp.preset.video.padding_policy #=> String
resp.preset.video.watermarks #=> Array
resp.preset.video.watermarks[0].id #=> String
resp.preset.video.watermarks[0].max_width #=> String
resp.preset.video.watermarks[0].max_height #=> String
resp.preset.video.watermarks[0].sizing_policy #=> String
resp.preset.video.watermarks[0].horizontal_align #=> String
resp.preset.video.watermarks[0].horizontal_offset #=> String
resp.preset.video.watermarks[0].vertical_align #=> String
resp.preset.video.watermarks[0].vertical_offset #=> String
resp.preset.video.watermarks[0].opacity #=> String
resp.preset.video.watermarks[0].target #=> String
resp.preset.thumbnails.format #=> String
resp.preset.thumbnails.interval #=> String
resp.preset.thumbnails.resolution #=> String
resp.preset.thumbnails.aspect_ratio #=> String
resp.preset.thumbnails.max_width #=> String
resp.preset.thumbnails.max_height #=> String
resp.preset.thumbnails.sizing_policy #=> String
resp.preset.thumbnails.padding_policy #=> String
resp.preset.type #=> String
resp.warning #=> String

Options Hash (options):

  • :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. Valid values include flac, flv, fmp4, gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm.

  • :video (Types::VideoParameters)

    A section of the request body that specifies the video parameters.

  • :audio (Types::AudioParameters)

    A section of the request body that specifies the audio parameters.

  • :thumbnails (Types::Thumbnails)

    A section of the request body that specifies the thumbnail parameters, if any.

Returns:

#delete_pipeline(options = {}) ⇒ Struct

The DeletePipeline operation removes a pipeline.

You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use, DeletePipeline returns an error.

Examples:

Request syntax with placeholder values


resp = client.delete_pipeline({
  id: "Id", # required
})

Options Hash (options):

  • :id (required, String)

    The identifier of the pipeline that you want to delete.

Returns:

  • (Struct)

    Returns an empty response.

#delete_preset(options = {}) ⇒ Struct

The DeletePreset operation removes a preset that you've added in an AWS region.

You can't delete the default presets that are included with Elastic Transcoder.

Examples:

Request syntax with placeholder values


resp = client.delete_preset({
  id: "Id", # required
})

Options Hash (options):

  • :id (required, String)

    The identifier of the preset for which you want to get detailed information.

Returns:

  • (Struct)

    Returns an empty response.

#list_jobs_by_pipeline(options = {}) ⇒ Types::ListJobsByPipelineResponse

The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.

Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria.

Examples:

Request syntax with placeholder values


resp = client.list_jobs_by_pipeline({
  pipeline_id: "Id", # required
  ascending: "Ascending",
  page_token: "Id",
})

Response structure


resp.jobs #=> Array
resp.jobs[0].id #=> String
resp.jobs[0].arn #=> String
resp.jobs[0].pipeline_id #=> String
resp.jobs[0].input.key #=> String
resp.jobs[0].input.frame_rate #=> String
resp.jobs[0].input.resolution #=> String
resp.jobs[0].input.aspect_ratio #=> String
resp.jobs[0].input.interlaced #=> String
resp.jobs[0].input.container #=> String
resp.jobs[0].input.encryption.mode #=> String
resp.jobs[0].input.encryption.key #=> String
resp.jobs[0].input.encryption.key_md_5 #=> String
resp.jobs[0].input.encryption.initialization_vector #=> String
resp.jobs[0].input.time_span.start_time #=> String
resp.jobs[0].input.time_span.duration #=> String
resp.jobs[0].input.input_captions.merge_policy #=> String
resp.jobs[0].input.input_captions.caption_sources #=> Array
resp.jobs[0].input.input_captions.caption_sources[0].key #=> String
resp.jobs[0].input.input_captions.caption_sources[0].language #=> String
resp.jobs[0].input.input_captions.caption_sources[0].time_offset #=> String
resp.jobs[0].input.input_captions.caption_sources[0].label #=> String
resp.jobs[0].input.input_captions.caption_sources[0].encryption.mode #=> String
resp.jobs[0].input.input_captions.caption_sources[0].encryption.key #=> String
resp.jobs[0].input.input_captions.caption_sources[0].encryption.key_md_5 #=> String
resp.jobs[0].input.input_captions.caption_sources[0].encryption.initialization_vector #=> String
resp.jobs[0].input.detected_properties.width #=> Integer
resp.jobs[0].input.detected_properties.height #=> Integer
resp.jobs[0].input.detected_properties.frame_rate #=> String
resp.jobs[0].input.detected_properties.file_size #=> Integer
resp.jobs[0].input.detected_properties.duration_millis #=> Integer
resp.jobs[0].inputs #=> Array
resp.jobs[0].inputs[0].key #=> String
resp.jobs[0].inputs[0].frame_rate #=> String
resp.jobs[0].inputs[0].resolution #=> String
resp.jobs[0].inputs[0].aspect_ratio #=> String
resp.jobs[0].inputs[0].interlaced #=> String
resp.jobs[0].inputs[0].container #=> String
resp.jobs[0].inputs[0].encryption.mode #=> String
resp.jobs[0].inputs[0].encryption.key #=> String
resp.jobs[0].inputs[0].encryption.key_md_5 #=> String
resp.jobs[0].inputs[0].encryption.initialization_vector #=> String
resp.jobs[0].inputs[0].time_span.start_time #=> String
resp.jobs[0].inputs[0].time_span.duration #=> String
resp.jobs[0].inputs[0].input_captions.merge_policy #=> String
resp.jobs[0].inputs[0].input_captions.caption_sources #=> Array
resp.jobs[0].inputs[0].input_captions.caption_sources[0].key #=> String
resp.jobs[0].inputs[0].input_captions.caption_sources[0].language #=> String
resp.jobs[0].inputs[0].input_captions.caption_sources[0].time_offset #=> String
resp.jobs[0].inputs[0].input_captions.caption_sources[0].label #=> String
resp.jobs[0].inputs[0].input_captions.caption_sources[0].encryption.mode #=> String
resp.jobs[0].inputs[0].input_captions.caption_sources[0].encryption.key #=> String
resp.jobs[0].inputs[0].input_captions.caption_sources[0].encryption.key_md_5 #=> String
resp.jobs[0].inputs[0].input_captions.caption_sources[0].encryption.initialization_vector #=> String
resp.jobs[0].inputs[0].detected_properties.width #=> Integer
resp.jobs[0].inputs[0].detected_properties.height #=> Integer
resp.jobs[0].inputs[0].detected_properties.frame_rate #=> String
resp.jobs[0].inputs[0].detected_properties.file_size #=> Integer
resp.jobs[0].inputs[0].detected_properties.duration_millis #=> Integer
resp.jobs[0].output.id #=> String
resp.jobs[0].output.key #=> String
resp.jobs[0].output.thumbnail_pattern #=> String
resp.jobs[0].output.thumbnail_encryption.mode #=> String
resp.jobs[0].output.thumbnail_encryption.key #=> String
resp.jobs[0].output.thumbnail_encryption.key_md_5 #=> String
resp.jobs[0].output.thumbnail_encryption.initialization_vector #=> String
resp.jobs[0].output.rotate #=> String
resp.jobs[0].output.preset_id #=> String
resp.jobs[0].output.segment_duration #=> String
resp.jobs[0].output.status #=> String
resp.jobs[0].output.status_detail #=> String
resp.jobs[0].output.duration #=> Integer
resp.jobs[0].output.width #=> Integer
resp.jobs[0].output.height #=> Integer
resp.jobs[0].output.frame_rate #=> String
resp.jobs[0].output.file_size #=> Integer
resp.jobs[0].output.duration_millis #=> Integer
resp.jobs[0].output.watermarks #=> Array
resp.jobs[0].output.watermarks[0].preset_watermark_id #=> String
resp.jobs[0].output.watermarks[0].input_key #=> String
resp.jobs[0].output.watermarks[0].encryption.mode #=> String
resp.jobs[0].output.watermarks[0].encryption.key #=> String
resp.jobs[0].output.watermarks[0].encryption.key_md_5 #=> String
resp.jobs[0].output.watermarks[0].encryption.initialization_vector #=> String
resp.jobs[0].output.album_art.merge_policy #=> String
resp.jobs[0].output.album_art.artwork #=> Array
resp.jobs[0].output.album_art.artwork[0].input_key #=> String
resp.jobs[0].output.album_art.artwork[0].max_width #=> String
resp.jobs[0].output.album_art.artwork[0].max_height #=> String
resp.jobs[0].output.album_art.artwork[0].sizing_policy #=> String
resp.jobs[0].output.album_art.artwork[0].padding_policy #=> String
resp.jobs[0].output.album_art.artwork[0].album_art_format #=> String
resp.jobs[0].output.album_art.artwork[0].encryption.mode #=> String
resp.jobs[0].output.album_art.artwork[0].encryption.key #=> String
resp.jobs[0].output.album_art.artwork[0].encryption.key_md_5 #=> String
resp.jobs[0].output.album_art.artwork[0].encryption.initialization_vector #=> String
resp.jobs[0].output.composition #=> Array
resp.jobs[0].output.composition[0].time_span.start_time #=> String
resp.jobs[0].output.composition[0].time_span.duration #=> String
resp.jobs[0].output.captions.merge_policy #=> String
resp.jobs[0].output.captions.caption_sources #=> Array
resp.jobs[0].output.captions.caption_sources[0].key #=> String
resp.jobs[0].output.captions.caption_sources[0].language #=> String
resp.jobs[0].output.captions.caption_sources[0].time_offset #=> String
resp.jobs[0].output.captions.caption_sources[0].label #=> String
resp.jobs[0].output.captions.caption_sources[0].encryption.mode #=> String
resp.jobs[0].output.captions.caption_sources[0].encryption.key #=> String
resp.jobs[0].output.captions.caption_sources[0].encryption.key_md_5 #=> String
resp.jobs[0].output.captions.caption_sources[0].encryption.initialization_vector #=> String
resp.jobs[0].output.captions.caption_formats #=> Array
resp.jobs[0].output.captions.caption_formats[0].format #=> String
resp.jobs[0].output.captions.caption_formats[0].pattern #=> String
resp.jobs[0].output.captions.caption_formats[0].encryption.mode #=> String
resp.jobs[0].output.captions.caption_formats[0].encryption.key #=> String
resp.jobs[0].output.captions.caption_formats[0].encryption.key_md_5 #=> String
resp.jobs[0].output.captions.caption_formats[0].encryption.initialization_vector #=> String
resp.jobs[0].output.encryption.mode #=> String
resp.jobs[0].output.encryption.key #=> String
resp.jobs[0].output.encryption.key_md_5 #=> String
resp.jobs[0].output.encryption.initialization_vector #=> String
resp.jobs[0].output.applied_color_space_conversion #=> String
resp.jobs[0].outputs #=> Array
resp.jobs[0].outputs[0].id #=> String
resp.jobs[0].outputs[0].key #=> String
resp.jobs[0].outputs[0].thumbnail_pattern #=> String
resp.jobs[0].outputs[0].thumbnail_encryption.mode #=> String
resp.jobs[0].outputs[0].thumbnail_encryption.key #=> String
resp.jobs[0].outputs[0].thumbnail_encryption.key_md_5 #=> String
resp.jobs[0].outputs[0].thumbnail_encryption.initialization_vector #=> String
resp.jobs[0].outputs[0].rotate #=> String
resp.jobs[0].outputs[0].preset_id #=> String
resp.jobs[0].outputs[0].segment_duration #=> String
resp.jobs[0].outputs[0].status #=> String
resp.jobs[0].outputs[0].status_detail #=> String
resp.jobs[0].outputs[0].duration #=> Integer
resp.jobs[0].outputs[0].width #=> Integer
resp.jobs[0].outputs[0].height #=> Integer
resp.jobs[0].outputs[0].frame_rate #=> String
resp.jobs[0].outputs[0].file_size #=> Integer
resp.jobs[0].outputs[0].duration_millis #=> Integer
resp.jobs[0].outputs[0].watermarks #=> Array
resp.jobs[0].outputs[0].watermarks[0].preset_watermark_id #=> String
resp.jobs[0].outputs[0].watermarks[0].input_key #=> String
resp.jobs[0].outputs[0].watermarks[0].encryption.mode #=> String
resp.jobs[0].outputs[0].watermarks[0].encryption.key #=> String
resp.jobs[0].outputs[0].watermarks[0].encryption.key_md_5 #=> String
resp.jobs[0].outputs[0].watermarks[0].encryption.initialization_vector #=> String
resp.jobs[0].outputs[0].album_art.merge_policy #=> String
resp.jobs[0].outputs[0].album_art.artwork #=> Array
resp.jobs[0].outputs[0].album_art.artwork[0].input_key #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].max_width #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].max_height #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].sizing_policy #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].padding_policy #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].album_art_format #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].encryption.mode #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].encryption.key #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].encryption.key_md_5 #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].encryption.initialization_vector #=> String
resp.jobs[0].outputs[0].composition #=> Array
resp.jobs[0].outputs[0].composition[0].time_span.start_time #=> String
resp.jobs[0].outputs[0].composition[0].time_span.duration #=> String
resp.jobs[0].outputs[0].captions.merge_policy #=> String
resp.jobs[0].outputs[0].captions.caption_sources #=> Array
resp.jobs[0].outputs[0].captions.caption_sources[0].key #=> String
resp.jobs[0].outputs[0].captions.caption_sources[0].language #=> String
resp.jobs[0].outputs[0].captions.caption_sources[0].time_offset #=> String
resp.jobs[0].outputs[0].captions.caption_sources[0].label #=> String
resp.jobs[0].outputs[0].captions.caption_sources[0].encryption.mode #=> String
resp.jobs[0].outputs[0].captions.caption_sources[0].encryption.key #=> String
resp.jobs[0].outputs[0].captions.caption_sources[0].encryption.key_md_5 #=> String
resp.jobs[0].outputs[0].captions.caption_sources[0].encryption.initialization_vector #=> String
resp.jobs[0].outputs[0].captions.caption_formats #=> Array
resp.jobs[0].outputs[0].captions.caption_formats[0].format #=> String
resp.jobs[0].outputs[0].captions.caption_formats[0].pattern #=> String
resp.jobs[0].outputs[0].captions.caption_formats[0].encryption.mode #=> String
resp.jobs[0].outputs[0].captions.caption_formats[0].encryption.key #=> String
resp.jobs[0].outputs[0].captions.caption_formats[0].encryption.key_md_5 #=> String
resp.jobs[0].outputs[0].captions.caption_formats[0].encryption.initialization_vector #=> String
resp.jobs[0].outputs[0].encryption.mode #=> String
resp.jobs[0].outputs[0].encryption.key #=> String
resp.jobs[0].outputs[0].encryption.key_md_5 #=> String
resp.jobs[0].outputs[0].encryption.initialization_vector #=> String
resp.jobs[0].outputs[0].applied_color_space_conversion #=> String
resp.jobs[0].output_key_prefix #=> String
resp.jobs[0].playlists #=> Array
resp.jobs[0].playlists[0].name #=> String
resp.jobs[0].playlists[0].format #=> String
resp.jobs[0].playlists[0].output_keys #=> Array
resp.jobs[0].playlists[0].output_keys[0] #=> String
resp.jobs[0].playlists[0].hls_content_protection.method #=> String
resp.jobs[0].playlists[0].hls_content_protection.key #=> String
resp.jobs[0].playlists[0].hls_content_protection.key_md_5 #=> String
resp.jobs[0].playlists[0].hls_content_protection.initialization_vector #=> String
resp.jobs[0].playlists[0].hls_content_protection.license_acquisition_url #=> String
resp.jobs[0].playlists[0].hls_content_protection.key_storage_policy #=> String
resp.jobs[0].playlists[0].play_ready_drm.format #=> String
resp.jobs[0].playlists[0].play_ready_drm.key #=> String
resp.jobs[0].playlists[0].play_ready_drm.key_md_5 #=> String
resp.jobs[0].playlists[0].play_ready_drm.key_id #=> String
resp.jobs[0].playlists[0].play_ready_drm.initialization_vector #=> String
resp.jobs[0].playlists[0].play_ready_drm.license_acquisition_url #=> String
resp.jobs[0].playlists[0].status #=> String
resp.jobs[0].playlists[0].status_detail #=> String
resp.jobs[0].status #=> String
resp.jobs[0]. #=> Hash
resp.jobs[0].["String"] #=> String
resp.jobs[0].timing.submit_time_millis #=> Integer
resp.jobs[0].timing.start_time_millis #=> Integer
resp.jobs[0].timing.finish_time_millis #=> Integer
resp.next_page_token #=> String

Options Hash (options):

  • :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.

Returns:

#list_jobs_by_status(options = {}) ⇒ Types::ListJobsByStatusResponse

The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria.

Examples:

Request syntax with placeholder values


resp = client.list_jobs_by_status({
  status: "JobStatus", # required
  ascending: "Ascending",
  page_token: "Id",
})

Response structure


resp.jobs #=> Array
resp.jobs[0].id #=> String
resp.jobs[0].arn #=> String
resp.jobs[0].pipeline_id #=> String
resp.jobs[0].input.key #=> String
resp.jobs[0].input.frame_rate #=> String
resp.jobs[0].input.resolution #=> String
resp.jobs[0].input.aspect_ratio #=> String
resp.jobs[0].input.interlaced #=> String
resp.jobs[0].input.container #=> String
resp.jobs[0].input.encryption.mode #=> String
resp.jobs[0].input.encryption.key #=> String
resp.jobs[0].input.encryption.key_md_5 #=> String
resp.jobs[0].input.encryption.initialization_vector #=> String
resp.jobs[0].input.time_span.start_time #=> String
resp.jobs[0].input.time_span.duration #=> String
resp.jobs[0].input.input_captions.merge_policy #=> String
resp.jobs[0].input.input_captions.caption_sources #=> Array
resp.jobs[0].input.input_captions.caption_sources[0].key #=> String
resp.jobs[0].input.input_captions.caption_sources[0].language #=> String
resp.jobs[0].input.input_captions.caption_sources[0].time_offset #=> String
resp.jobs[0].input.input_captions.caption_sources[0].label #=> String
resp.jobs[0].input.input_captions.caption_sources[0].encryption.mode #=> String
resp.jobs[0].input.input_captions.caption_sources[0].encryption.key #=> String
resp.jobs[0].input.input_captions.caption_sources[0].encryption.key_md_5 #=> String
resp.jobs[0].input.input_captions.caption_sources[0].encryption.initialization_vector #=> String
resp.jobs[0].input.detected_properties.width #=> Integer
resp.jobs[0].input.detected_properties.height #=> Integer
resp.jobs[0].input.detected_properties.frame_rate #=> String
resp.jobs[0].input.detected_properties.file_size #=> Integer
resp.jobs[0].input.detected_properties.duration_millis #=> Integer
resp.jobs[0].inputs #=> Array
resp.jobs[0].inputs[0].key #=> String
resp.jobs[0].inputs[0].frame_rate #=> String
resp.jobs[0].inputs[0].resolution #=> String
resp.jobs[0].inputs[0].aspect_ratio #=> String
resp.jobs[0].inputs[0].interlaced #=> String
resp.jobs[0].inputs[0].container #=> String
resp.jobs[0].inputs[0].encryption.mode #=> String
resp.jobs[0].inputs[0].encryption.key #=> String
resp.jobs[0].inputs[0].encryption.key_md_5 #=> String
resp.jobs[0].inputs[0].encryption.initialization_vector #=> String
resp.jobs[0].inputs[0].time_span.start_time #=> String
resp.jobs[0].inputs[0].time_span.duration #=> String
resp.jobs[0].inputs[0].input_captions.merge_policy #=> String
resp.jobs[0].inputs[0].input_captions.caption_sources #=> Array
resp.jobs[0].inputs[0].input_captions.caption_sources[0].key #=> String
resp.jobs[0].inputs[0].input_captions.caption_sources[0].language #=> String
resp.jobs[0].inputs[0].input_captions.caption_sources[0].time_offset #=> String
resp.jobs[0].inputs[0].input_captions.caption_sources[0].label #=> String
resp.jobs[0].inputs[0].input_captions.caption_sources[0].encryption.mode #=> String
resp.jobs[0].inputs[0].input_captions.caption_sources[0].encryption.key #=> String
resp.jobs[0].inputs[0].input_captions.caption_sources[0].encryption.key_md_5 #=> String
resp.jobs[0].inputs[0].input_captions.caption_sources[0].encryption.initialization_vector #=> String
resp.jobs[0].inputs[0].detected_properties.width #=> Integer
resp.jobs[0].inputs[0].detected_properties.height #=> Integer
resp.jobs[0].inputs[0].detected_properties.frame_rate #=> String
resp.jobs[0].inputs[0].detected_properties.file_size #=> Integer
resp.jobs[0].inputs[0].detected_properties.duration_millis #=> Integer
resp.jobs[0].output.id #=> String
resp.jobs[0].output.key #=> String
resp.jobs[0].output.thumbnail_pattern #=> String
resp.jobs[0].output.thumbnail_encryption.mode #=> String
resp.jobs[0].output.thumbnail_encryption.key #=> String
resp.jobs[0].output.thumbnail_encryption.key_md_5 #=> String
resp.jobs[0].output.thumbnail_encryption.initialization_vector #=> String
resp.jobs[0].output.rotate #=> String
resp.jobs[0].output.preset_id #=> String
resp.jobs[0].output.segment_duration #=> String
resp.jobs[0].output.status #=> String
resp.jobs[0].output.status_detail #=> String
resp.jobs[0].output.duration #=> Integer
resp.jobs[0].output.width #=> Integer
resp.jobs[0].output.height #=> Integer
resp.jobs[0].output.frame_rate #=> String
resp.jobs[0].output.file_size #=> Integer
resp.jobs[0].output.duration_millis #=> Integer
resp.jobs[0].output.watermarks #=> Array
resp.jobs[0].output.watermarks[0].preset_watermark_id #=> String
resp.jobs[0].output.watermarks[0].input_key #=> String
resp.jobs[0].output.watermarks[0].encryption.mode #=> String
resp.jobs[0].output.watermarks[0].encryption.key #=> String
resp.jobs[0].output.watermarks[0].encryption.key_md_5 #=> String
resp.jobs[0].output.watermarks[0].encryption.initialization_vector #=> String
resp.jobs[0].output.album_art.merge_policy #=> String
resp.jobs[0].output.album_art.artwork #=> Array
resp.jobs[0].output.album_art.artwork[0].input_key #=> String
resp.jobs[0].output.album_art.artwork[0].max_width #=> String
resp.jobs[0].output.album_art.artwork[0].max_height #=> String
resp.jobs[0].output.album_art.artwork[0].sizing_policy #=> String
resp.jobs[0].output.album_art.artwork[0].padding_policy #=> String
resp.jobs[0].output.album_art.artwork[0].album_art_format #=> String
resp.jobs[0].output.album_art.artwork[0].encryption.mode #=> String
resp.jobs[0].output.album_art.artwork[0].encryption.key #=> String
resp.jobs[0].output.album_art.artwork[0].encryption.key_md_5 #=> String
resp.jobs[0].output.album_art.artwork[0].encryption.initialization_vector #=> String
resp.jobs[0].output.composition #=> Array
resp.jobs[0].output.composition[0].time_span.start_time #=> String
resp.jobs[0].output.composition[0].time_span.duration #=> String
resp.jobs[0].output.captions.merge_policy #=> String
resp.jobs[0].output.captions.caption_sources #=> Array
resp.jobs[0].output.captions.caption_sources[0].key #=> String
resp.jobs[0].output.captions.caption_sources[0].language #=> String
resp.jobs[0].output.captions.caption_sources[0].time_offset #=> String
resp.jobs[0].output.captions.caption_sources[0].label #=> String
resp.jobs[0].output.captions.caption_sources[0].encryption.mode #=> String
resp.jobs[0].output.captions.caption_sources[0].encryption.key #=> String
resp.jobs[0].output.captions.caption_sources[0].encryption.key_md_5 #=> String
resp.jobs[0].output.captions.caption_sources[0].encryption.initialization_vector #=> String
resp.jobs[0].output.captions.caption_formats #=> Array
resp.jobs[0].output.captions.caption_formats[0].format #=> String
resp.jobs[0].output.captions.caption_formats[0].pattern #=> String
resp.jobs[0].output.captions.caption_formats[0].encryption.mode #=> String
resp.jobs[0].output.captions.caption_formats[0].encryption.key #=> String
resp.jobs[0].output.captions.caption_formats[0].encryption.key_md_5 #=> String
resp.jobs[0].output.captions.caption_formats[0].encryption.initialization_vector #=> String
resp.jobs[0].output.encryption.mode #=> String
resp.jobs[0].output.encryption.key #=> String
resp.jobs[0].output.encryption.key_md_5 #=> String
resp.jobs[0].output.encryption.initialization_vector #=> String
resp.jobs[0].output.applied_color_space_conversion #=> String
resp.jobs[0].outputs #=> Array
resp.jobs[0].outputs[0].id #=> String
resp.jobs[0].outputs[0].key #=> String
resp.jobs[0].outputs[0].thumbnail_pattern #=> String
resp.jobs[0].outputs[0].thumbnail_encryption.mode #=> String
resp.jobs[0].outputs[0].thumbnail_encryption.key #=> String
resp.jobs[0].outputs[0].thumbnail_encryption.key_md_5 #=> String
resp.jobs[0].outputs[0].thumbnail_encryption.initialization_vector #=> String
resp.jobs[0].outputs[0].rotate #=> String
resp.jobs[0].outputs[0].preset_id #=> String
resp.jobs[0].outputs[0].segment_duration #=> String
resp.jobs[0].outputs[0].status #=> String
resp.jobs[0].outputs[0].status_detail #=> String
resp.jobs[0].outputs[0].duration #=> Integer
resp.jobs[0].outputs[0].width #=> Integer
resp.jobs[0].outputs[0].height #=> Integer
resp.jobs[0].outputs[0].frame_rate #=> String
resp.jobs[0].outputs[0].file_size #=> Integer
resp.jobs[0].outputs[0].duration_millis #=> Integer
resp.jobs[0].outputs[0].watermarks #=> Array
resp.jobs[0].outputs[0].watermarks[0].preset_watermark_id #=> String
resp.jobs[0].outputs[0].watermarks[0].input_key #=> String
resp.jobs[0].outputs[0].watermarks[0].encryption.mode #=> String
resp.jobs[0].outputs[0].watermarks[0].encryption.key #=> String
resp.jobs[0].outputs[0].watermarks[0].encryption.key_md_5 #=> String
resp.jobs[0].outputs[0].watermarks[0].encryption.initialization_vector #=> String
resp.jobs[0].outputs[0].album_art.merge_policy #=> String
resp.jobs[0].outputs[0].album_art.artwork #=> Array
resp.jobs[0].outputs[0].album_art.artwork[0].input_key #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].max_width #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].max_height #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].sizing_policy #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].padding_policy #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].album_art_format #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].encryption.mode #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].encryption.key #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].encryption.key_md_5 #=> String
resp.jobs[0].outputs[0].album_art.artwork[0].encryption.initialization_vector #=> String
resp.jobs[0].outputs[0].composition #=> Array
resp.jobs[0].outputs[0].composition[0].time_span.start_time #=> String
resp.jobs[0].outputs[0].composition[0].time_span.duration #=> String
resp.jobs[0].outputs[0].captions.merge_policy #=> String
resp.jobs[0].outputs[0].captions.caption_sources #=> Array
resp.jobs[0].outputs[0].captions.caption_sources[0].key #=> String
resp.jobs[0].outputs[0].captions.caption_sources[0].language #=> String
resp.jobs[0].outputs[0].captions.caption_sources[0].time_offset #=> String
resp.jobs[0].outputs[0].captions.caption_sources[0].label #=> String
resp.jobs[0].outputs[0].captions.caption_sources[0].encryption.mode #=> String
resp.jobs[0].outputs[0].captions.caption_sources[0].encryption.key #=> String
resp.jobs[0].outputs[0].captions.caption_sources[0].encryption.key_md_5 #=> String
resp.jobs[0].outputs[0].captions.caption_sources[0].encryption.initialization_vector #=> String
resp.jobs[0].outputs[0].captions.caption_formats #=> Array
resp.jobs[0].outputs[0].captions.caption_formats[0].format #=> String
resp.jobs[0].outputs[0].captions.caption_formats[0].pattern #=> String
resp.jobs[0].outputs[0].captions.caption_formats[0].encryption.mode #=> String
resp.jobs[0].outputs[0].captions.caption_formats[0].encryption.key #=> String
resp.jobs[0].outputs[0].captions.caption_formats[0].encryption.key_md_5 #=> String
resp.jobs[0].outputs[0].captions.caption_formats[0].encryption.initialization_vector #=> String
resp.jobs[0].outputs[0].encryption.mode #=> String
resp.jobs[0].outputs[0].encryption.key #=> String
resp.jobs[0].outputs[0].encryption.key_md_5 #=> String
resp.jobs[0].outputs[0].encryption.initialization_vector #=> String
resp.jobs[0].outputs[0].applied_color_space_conversion #=> String
resp.jobs[0].output_key_prefix #=> String
resp.jobs[0].playlists #=> Array
resp.jobs[0].playlists[0].name #=> String
resp.jobs[0].playlists[0].format #=> String
resp.jobs[0].playlists[0].output_keys #=> Array
resp.jobs[0].playlists[0].output_keys[0] #=> String
resp.jobs[0].playlists[0].hls_content_protection.method #=> String
resp.jobs[0].playlists[0].hls_content_protection.key #=> String
resp.jobs[0].playlists[0].hls_content_protection.key_md_5 #=> String
resp.jobs[0].playlists[0].hls_content_protection.initialization_vector #=> String
resp.jobs[0].playlists[0].hls_content_protection.license_acquisition_url #=> String
resp.jobs[0].playlists[0].hls_content_protection.key_storage_policy #=> String
resp.jobs[0].playlists[0].play_ready_drm.format #=> String
resp.jobs[0].playlists[0].play_ready_drm.key #=> String
resp.jobs[0].playlists[0].play_ready_drm.key_md_5 #=> String
resp.jobs[0].playlists[0].play_ready_drm.key_id #=> String
resp.jobs[0].playlists[0].play_ready_drm.initialization_vector #=> String
resp.jobs[0].playlists[0].play_ready_drm.license_acquisition_url #=> String
resp.jobs[0].playlists[0].status #=> String
resp.jobs[0].playlists[0].status_detail #=> String
resp.jobs[0].status #=> String
resp.jobs[0]. #=> Hash
resp.jobs[0].["String"] #=> String
resp.jobs[0].timing.submit_time_millis #=> Integer
resp.jobs[0].timing.start_time_millis #=> Integer
resp.jobs[0].timing.finish_time_millis #=> Integer
resp.next_page_token #=> String

Options Hash (options):

  • :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, Complete, 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.

Returns:

#list_pipelines(options = {}) ⇒ Types::ListPipelinesResponse

The ListPipelines operation gets a list of the pipelines associated with the current AWS account.

Examples:

Request syntax with placeholder values


resp = client.list_pipelines({
  ascending: "Ascending",
  page_token: "Id",
})

Response structure


resp.pipelines #=> Array
resp.pipelines[0].id #=> String
resp.pipelines[0].arn #=> String
resp.pipelines[0].name #=> String
resp.pipelines[0].status #=> String
resp.pipelines[0].input_bucket #=> String
resp.pipelines[0].output_bucket #=> String
resp.pipelines[0].role #=> String
resp.pipelines[0].aws_kms_key_arn #=> String
resp.pipelines[0].notifications.progressing #=> String
resp.pipelines[0].notifications.completed #=> String
resp.pipelines[0].notifications.warning #=> String
resp.pipelines[0].notifications.error #=> String
resp.pipelines[0].content_config.bucket #=> String
resp.pipelines[0].content_config.storage_class #=> String
resp.pipelines[0].content_config.permissions #=> Array
resp.pipelines[0].content_config.permissions[0].grantee_type #=> String
resp.pipelines[0].content_config.permissions[0].grantee #=> String
resp.pipelines[0].content_config.permissions[0].access #=> Array
resp.pipelines[0].content_config.permissions[0].access[0] #=> String
resp.pipelines[0].thumbnail_config.bucket #=> String
resp.pipelines[0].thumbnail_config.storage_class #=> String
resp.pipelines[0].thumbnail_config.permissions #=> Array
resp.pipelines[0].thumbnail_config.permissions[0].grantee_type #=> String
resp.pipelines[0].thumbnail_config.permissions[0].grantee #=> String
resp.pipelines[0].thumbnail_config.permissions[0].access #=> Array
resp.pipelines[0].thumbnail_config.permissions[0].access[0] #=> String
resp.next_page_token #=> String

Options Hash (options):

  • :ascending (String)

    To list pipelines in chronological order by the date and time that they were created, enter true. To list pipelines 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.

Returns:

#list_presets(options = {}) ⇒ Types::ListPresetsResponse

The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region.

Examples:

Request syntax with placeholder values


resp = client.list_presets({
  ascending: "Ascending",
  page_token: "Id",
})

Response structure


resp.presets #=> Array
resp.presets[0].id #=> String
resp.presets[0].arn #=> String
resp.presets[0].name #=> String
resp.presets[0].description #=> String
resp.presets[0].container #=> String
resp.presets[0].audio.codec #=> String
resp.presets[0].audio.sample_rate #=> String
resp.presets[0].audio.bit_rate #=> String
resp.presets[0].audio.channels #=> String
resp.presets[0].audio.audio_packing_mode #=> String
resp.presets[0].audio.codec_options.profile #=> String
resp.presets[0].audio.codec_options.bit_depth #=> String
resp.presets[0].audio.codec_options.bit_order #=> String
resp.presets[0].audio.codec_options.signed #=> String
resp.presets[0].video.codec #=> String
resp.presets[0].video.codec_options #=> Hash
resp.presets[0].video.codec_options["CodecOption"] #=> String
resp.presets[0].video.keyframes_max_dist #=> String
resp.presets[0].video.fixed_gop #=> String
resp.presets[0].video.bit_rate #=> String
resp.presets[0].video.frame_rate #=> String
resp.presets[0].video.max_frame_rate #=> String
resp.presets[0].video.resolution #=> String
resp.presets[0].video.aspect_ratio #=> String
resp.presets[0].video.max_width #=> String
resp.presets[0].video.max_height #=> String
resp.presets[0].video.display_aspect_ratio #=> String
resp.presets[0].video.sizing_policy #=> String
resp.presets[0].video.padding_policy #=> String
resp.presets[0].video.watermarks #=> Array
resp.presets[0].video.watermarks[0].id #=> String
resp.presets[0].video.watermarks[0].max_width #=> String
resp.presets[0].video.watermarks[0].max_height #=> String
resp.presets[0].video.watermarks[0].sizing_policy #=> String
resp.presets[0].video.watermarks[0].horizontal_align #=> String
resp.presets[0].video.watermarks[0].horizontal_offset #=> String
resp.presets[0].video.watermarks[0].vertical_align #=> String
resp.presets[0].video.watermarks[0].vertical_offset #=> String
resp.presets[0].video.watermarks[0].opacity #=> String
resp.presets[0].video.watermarks[0].target #=> String
resp.presets[0].thumbnails.format #=> String
resp.presets[0].thumbnails.interval #=> String
resp.presets[0].thumbnails.resolution #=> String
resp.presets[0].thumbnails.aspect_ratio #=> String
resp.presets[0].thumbnails.max_width #=> String
resp.presets[0].thumbnails.max_height #=> String
resp.presets[0].thumbnails.sizing_policy #=> String
resp.presets[0].thumbnails.padding_policy #=> String
resp.presets[0].type #=> String
resp.next_page_token #=> String

Options Hash (options):

  • :ascending (String)

    To list presets in chronological order by the date and time that they were created, enter true. To list presets 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.

Returns:

#read_job(options = {}) ⇒ Types::ReadJobResponse

The ReadJob operation returns detailed information about a job.

Examples:

Request syntax with placeholder values


resp = client.read_job({
  id: "Id", # required
})

Response structure


resp.job.id #=> String
resp.job.arn #=> String
resp.job.pipeline_id #=> String
resp.job.input.key #=> String
resp.job.input.frame_rate #=> String
resp.job.input.resolution #=> String
resp.job.input.aspect_ratio #=> String
resp.job.input.interlaced #=> String
resp.job.input.container #=> String
resp.job.input.encryption.mode #=> String
resp.job.input.encryption.key #=> String
resp.job.input.encryption.key_md_5 #=> String
resp.job.input.encryption.initialization_vector #=> String
resp.job.input.time_span.start_time #=> String
resp.job.input.time_span.duration #=> String
resp.job.input.input_captions.merge_policy #=> String
resp.job.input.input_captions.caption_sources #=> Array
resp.job.input.input_captions.caption_sources[0].key #=> String
resp.job.input.input_captions.caption_sources[0].language #=> String
resp.job.input.input_captions.caption_sources[0].time_offset #=> String
resp.job.input.input_captions.caption_sources[0].label #=> String
resp.job.input.input_captions.caption_sources[0].encryption.mode #=> String
resp.job.input.input_captions.caption_sources[0].encryption.key #=> String
resp.job.input.input_captions.caption_sources[0].encryption.key_md_5 #=> String
resp.job.input.input_captions.caption_sources[0].encryption.initialization_vector #=> String
resp.job.input.detected_properties.width #=> Integer
resp.job.input.detected_properties.height #=> Integer
resp.job.input.detected_properties.frame_rate #=> String
resp.job.input.detected_properties.file_size #=> Integer
resp.job.input.detected_properties.duration_millis #=> Integer
resp.job.inputs #=> Array
resp.job.inputs[0].key #=> String
resp.job.inputs[0].frame_rate #=> String
resp.job.inputs[0].resolution #=> String
resp.job.inputs[0].aspect_ratio #=> String
resp.job.inputs[0].interlaced #=> String
resp.job.inputs[0].container #=> String
resp.job.inputs[0].encryption.mode #=> String
resp.job.inputs[0].encryption.key #=> String
resp.job.inputs[0].encryption.key_md_5 #=> String
resp.job.inputs[0].encryption.initialization_vector #=> String
resp.job.inputs[0].time_span.start_time #=> String
resp.job.inputs[0].time_span.duration #=> String
resp.job.inputs[0].input_captions.merge_policy #=> String
resp.job.inputs[0].input_captions.caption_sources #=> Array
resp.job.inputs[0].input_captions.caption_sources[0].key #=> String
resp.job.inputs[0].input_captions.caption_sources[0].language #=> String
resp.job.inputs[0].input_captions.caption_sources[0].time_offset #=> String
resp.job.inputs[0].input_captions.caption_sources[0].label #=> String
resp.job.inputs[0].input_captions.caption_sources[0].encryption.mode #=> String
resp.job.inputs[0].input_captions.caption_sources[0].encryption.key #=> String
resp.job.inputs[0].input_captions.caption_sources[0].encryption.key_md_5 #=> String
resp.job.inputs[0].input_captions.caption_sources[0].encryption.initialization_vector #=> String
resp.job.inputs[0].detected_properties.width #=> Integer
resp.job.inputs[0].detected_properties.height #=> Integer
resp.job.inputs[0].detected_properties.frame_rate #=> String
resp.job.inputs[0].detected_properties.file_size #=> Integer
resp.job.inputs[0].detected_properties.duration_millis #=> Integer
resp.job.output.id #=> String
resp.job.output.key #=> String
resp.job.output.thumbnail_pattern #=> String
resp.job.output.thumbnail_encryption.mode #=> String
resp.job.output.thumbnail_encryption.key #=> String
resp.job.output.thumbnail_encryption.key_md_5 #=> String
resp.job.output.thumbnail_encryption.initialization_vector #=> String
resp.job.output.rotate #=> String
resp.job.output.preset_id #=> String
resp.job.output.segment_duration #=> String
resp.job.output.status #=> String
resp.job.output.status_detail #=> String
resp.job.output.duration #=> Integer
resp.job.output.width #=> Integer
resp.job.output.height #=> Integer
resp.job.output.frame_rate #=> String
resp.job.output.file_size #=> Integer
resp.job.output.duration_millis #=> Integer
resp.job.output.watermarks #=> Array
resp.job.output.watermarks[0].preset_watermark_id #=> String
resp.job.output.watermarks[0].input_key #=> String
resp.job.output.watermarks[0].encryption.mode #=> String
resp.job.output.watermarks[0].encryption.key #=> String
resp.job.output.watermarks[0].encryption.key_md_5 #=> String
resp.job.output.watermarks[0].encryption.initialization_vector #=> String
resp.job.output.album_art.merge_policy #=> String
resp.job.output.album_art.artwork #=> Array
resp.job.output.album_art.artwork[0].input_key #=> String
resp.job.output.album_art.artwork[0].max_width #=> String
resp.job.output.album_art.artwork[0].max_height #=> String
resp.job.output.album_art.artwork[0].sizing_policy #=> String
resp.job.output.album_art.artwork[0].padding_policy #=> String
resp.job.output.album_art.artwork[0].album_art_format #=> String
resp.job.output.album_art.artwork[0].encryption.mode #=> String
resp.job.output.album_art.artwork[0].encryption.key #=> String
resp.job.output.album_art.artwork[0].encryption.key_md_5 #=> String
resp.job.output.album_art.artwork[0].encryption.initialization_vector #=> String
resp.job.output.composition #=> Array
resp.job.output.composition[0].time_span.start_time #=> String
resp.job.output.composition[0].time_span.duration #=> String
resp.job.output.captions.merge_policy #=> String
resp.job.output.captions.caption_sources #=> Array
resp.job.output.captions.caption_sources[0].key #=> String
resp.job.output.captions.caption_sources[0].language #=> String
resp.job.output.captions.caption_sources[0].time_offset #=> String
resp.job.output.captions.caption_sources[0].label #=> String
resp.job.output.captions.caption_sources[0].encryption.mode #=> String
resp.job.output.captions.caption_sources[0].encryption.key #=> String
resp.job.output.captions.caption_sources[0].encryption.key_md_5 #=> String
resp.job.output.captions.caption_sources[0].encryption.initialization_vector #=> String
resp.job.output.captions.caption_formats #=> Array
resp.job.output.captions.caption_formats[0].format #=> String
resp.job.output.captions.caption_formats[0].pattern #=> String
resp.job.output.captions.caption_formats[0].encryption.mode #=> String
resp.job.output.captions.caption_formats[0].encryption.key #=> String
resp.job.output.captions.caption_formats[0].encryption.key_md_5 #=> String
resp.job.output.captions.caption_formats[0].encryption.initialization_vector #=> String
resp.job.output.encryption.mode #=> String
resp.job.output.encryption.key #=> String
resp.job.output.encryption.key_md_5 #=> String
resp.job.output.encryption.initialization_vector #=> String
resp.job.output.applied_color_space_conversion #=> String
resp.job.outputs #=> Array
resp.job.outputs[0].id #=> String
resp.job.outputs[0].key #=> String
resp.job.outputs[0].thumbnail_pattern #=> String
resp.job.outputs[0].thumbnail_encryption.mode #=> String
resp.job.outputs[0].thumbnail_encryption.key #=> String
resp.job.outputs[0].thumbnail_encryption.key_md_5 #=> String
resp.job.outputs[0].thumbnail_encryption.initialization_vector #=> String
resp.job.outputs[0].rotate #=> String
resp.job.outputs[0].preset_id #=> String
resp.job.outputs[0].segment_duration #=> String
resp.job.outputs[0].status #=> String
resp.job.outputs[0].status_detail #=> String
resp.job.outputs[0].duration #=> Integer
resp.job.outputs[0].width #=> Integer
resp.job.outputs[0].height #=> Integer
resp.job.outputs[0].frame_rate #=> String
resp.job.outputs[0].file_size #=> Integer
resp.job.outputs[0].duration_millis #=> Integer
resp.job.outputs[0].watermarks #=> Array
resp.job.outputs[0].watermarks[0].preset_watermark_id #=> String
resp.job.outputs[0].watermarks[0].input_key #=> String
resp.job.outputs[0].watermarks[0].encryption.mode #=> String
resp.job.outputs[0].watermarks[0].encryption.key #=> String
resp.job.outputs[0].watermarks[0].encryption.key_md_5 #=> String
resp.job.outputs[0].watermarks[0].encryption.initialization_vector #=> String
resp.job.outputs[0].album_art.merge_policy #=> String
resp.job.outputs[0].album_art.artwork #=> Array
resp.job.outputs[0].album_art.artwork[0].input_key #=> String
resp.job.outputs[0].album_art.artwork[0].max_width #=> String
resp.job.outputs[0].album_art.artwork[0].max_height #=> String
resp.job.outputs[0].album_art.artwork[0].sizing_policy #=> String
resp.job.outputs[0].album_art.artwork[0].padding_policy #=> String
resp.job.outputs[0].album_art.artwork[0].album_art_format #=> String
resp.job.outputs[0].album_art.artwork[0].encryption.mode #=> String
resp.job.outputs[0].album_art.artwork[0].encryption.key #=> String
resp.job.outputs[0].album_art.artwork[0].encryption.key_md_5 #=> String
resp.job.outputs[0].album_art.artwork[0].encryption.initialization_vector #=> String
resp.job.outputs[0].composition #=> Array
resp.job.outputs[0].composition[0].time_span.start_time #=> String
resp.job.outputs[0].composition[0].time_span.duration #=> String
resp.job.outputs[0].captions.merge_policy #=> String
resp.job.outputs[0].captions.caption_sources #=> Array
resp.job.outputs[0].captions.caption_sources[0].key #=> String
resp.job.outputs[0].captions.caption_sources[0].language #=> String
resp.job.outputs[0].captions.caption_sources[0].time_offset #=> String
resp.job.outputs[0].captions.caption_sources[0].label #=> String
resp.job.outputs[0].captions.caption_sources[0].encryption.mode #=> String
resp.job.outputs[0].captions.caption_sources[0].encryption.key #=> String
resp.job.outputs[0].captions.caption_sources[0].encryption.key_md_5 #=> String
resp.job.outputs[0].captions.caption_sources[0].encryption.initialization_vector #=> String
resp.job.outputs[0].captions.caption_formats #=> Array
resp.job.outputs[0].captions.caption_formats[0].format #=> String
resp.job.outputs[0].captions.caption_formats[0].pattern #=> String
resp.job.outputs[0].captions.caption_formats[0].encryption.mode #=> String
resp.job.outputs[0].captions.caption_formats[0].encryption.key #=> String
resp.job.outputs[0].captions.caption_formats[0].encryption.key_md_5 #=> String
resp.job.outputs[0].captions.caption_formats[0].encryption.initialization_vector #=> String
resp.job.outputs[0].encryption.mode #=> String
resp.job.outputs[0].encryption.key #=> String
resp.job.outputs[0].encryption.key_md_5 #=> String
resp.job.outputs[0].encryption.initialization_vector #=> String
resp.job.outputs[0].applied_color_space_conversion #=> String
resp.job.output_key_prefix #=> String
resp.job.playlists #=> Array
resp.job.playlists[0].name #=> String
resp.job.playlists[0].format #=> String
resp.job.playlists[0].output_keys #=> Array
resp.job.playlists[0].output_keys[0] #=> String
resp.job.playlists[0].hls_content_protection.method #=> String
resp.job.playlists[0].hls_content_protection.key #=> String
resp.job.playlists[0].hls_content_protection.key_md_5 #=> String
resp.job.playlists[0].hls_content_protection.initialization_vector #=> String
resp.job.playlists[0].hls_content_protection.license_acquisition_url #=> String
resp.job.playlists[0].hls_content_protection.key_storage_policy #=> String
resp.job.playlists[0].play_ready_drm.format #=> String
resp.job.playlists[0].play_ready_drm.key #=> String
resp.job.playlists[0].play_ready_drm.key_md_5 #=> String
resp.job.playlists[0].play_ready_drm.key_id #=> String
resp.job.playlists[0].play_ready_drm.initialization_vector #=> String
resp.job.playlists[0].play_ready_drm.license_acquisition_url #=> String
resp.job.playlists[0].status #=> String
resp.job.playlists[0].status_detail #=> String
resp.job.status #=> String
resp.job. #=> Hash
resp.job.["String"] #=> String
resp.job.timing.submit_time_millis #=> Integer
resp.job.timing.start_time_millis #=> Integer
resp.job.timing.finish_time_millis #=> Integer

Options Hash (options):

  • :id (required, String)

    The identifier of the job for which you want to get detailed information.

Returns:

#read_pipeline(options = {}) ⇒ Types::ReadPipelineResponse

The ReadPipeline operation gets detailed information about a pipeline.

Examples:

Request syntax with placeholder values


resp = client.read_pipeline({
  id: "Id", # required
})

Response structure


resp.pipeline.id #=> String
resp.pipeline.arn #=> String
resp.pipeline.name #=> String
resp.pipeline.status #=> String
resp.pipeline.input_bucket #=> String
resp.pipeline.output_bucket #=> String
resp.pipeline.role #=> String
resp.pipeline.aws_kms_key_arn #=> String
resp.pipeline.notifications.progressing #=> String
resp.pipeline.notifications.completed #=> String
resp.pipeline.notifications.warning #=> String
resp.pipeline.notifications.error #=> String
resp.pipeline.content_config.bucket #=> String
resp.pipeline.content_config.storage_class #=> String
resp.pipeline.content_config.permissions #=> Array
resp.pipeline.content_config.permissions[0].grantee_type #=> String
resp.pipeline.content_config.permissions[0].grantee #=> String
resp.pipeline.content_config.permissions[0].access #=> Array
resp.pipeline.content_config.permissions[0].access[0] #=> String
resp.pipeline.thumbnail_config.bucket #=> String
resp.pipeline.thumbnail_config.storage_class #=> String
resp.pipeline.thumbnail_config.permissions #=> Array
resp.pipeline.thumbnail_config.permissions[0].grantee_type #=> String
resp.pipeline.thumbnail_config.permissions[0].grantee #=> String
resp.pipeline.thumbnail_config.permissions[0].access #=> Array
resp.pipeline.thumbnail_config.permissions[0].access[0] #=> String
resp.warnings #=> Array
resp.warnings[0].code #=> String
resp.warnings[0].message #=> String

Options Hash (options):

  • :id (required, String)

    The identifier of the pipeline to read.

Returns:

#read_preset(options = {}) ⇒ Types::ReadPresetResponse

The ReadPreset operation gets detailed information about a preset.

Examples:

Request syntax with placeholder values


resp = client.read_preset({
  id: "Id", # required
})

Response structure


resp.preset.id #=> String
resp.preset.arn #=> String
resp.preset.name #=> String
resp.preset.description #=> String
resp.preset.container #=> String
resp.preset.audio.codec #=> String
resp.preset.audio.sample_rate #=> String
resp.preset.audio.bit_rate #=> String
resp.preset.audio.channels #=> String
resp.preset.audio.audio_packing_mode #=> String
resp.preset.audio.codec_options.profile #=> String
resp.preset.audio.codec_options.bit_depth #=> String
resp.preset.audio.codec_options.bit_order #=> String
resp.preset.audio.codec_options.signed #=> String
resp.preset.video.codec #=> String
resp.preset.video.codec_options #=> Hash
resp.preset.video.codec_options["CodecOption"] #=> String
resp.preset.video.keyframes_max_dist #=> String
resp.preset.video.fixed_gop #=> String
resp.preset.video.bit_rate #=> String
resp.preset.video.frame_rate #=> String
resp.preset.video.max_frame_rate #=> String
resp.preset.video.resolution #=> String
resp.preset.video.aspect_ratio #=> String
resp.preset.video.max_width #=> String
resp.preset.video.max_height #=> String
resp.preset.video.display_aspect_ratio #=> String
resp.preset.video.sizing_policy #=> String
resp.preset.video.padding_policy #=> String
resp.preset.video.watermarks #=> Array
resp.preset.video.watermarks[0].id #=> String
resp.preset.video.watermarks[0].max_width #=> String
resp.preset.video.watermarks[0].max_height #=> String
resp.preset.video.watermarks[0].sizing_policy #=> String
resp.preset.video.watermarks[0].horizontal_align #=> String
resp.preset.video.watermarks[0].horizontal_offset #=> String
resp.preset.video.watermarks[0].vertical_align #=> String
resp.preset.video.watermarks[0].vertical_offset #=> String
resp.preset.video.watermarks[0].opacity #=> String
resp.preset.video.watermarks[0].target #=> String
resp.preset.thumbnails.format #=> String
resp.preset.thumbnails.interval #=> String
resp.preset.thumbnails.resolution #=> String
resp.preset.thumbnails.aspect_ratio #=> String
resp.preset.thumbnails.max_width #=> String
resp.preset.thumbnails.max_height #=> String
resp.preset.thumbnails.sizing_policy #=> String
resp.preset.thumbnails.padding_policy #=> String
resp.preset.type #=> String

Options Hash (options):

  • :id (required, String)

    The identifier of the preset for which you want to get detailed information.

Returns:

#test_role(options = {}) ⇒ Types::TestRoleResponse

The TestRole operation tests the IAM role used to create the pipeline.

The TestRole action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify.

Examples:

Request syntax with placeholder values


resp = client.test_role({
  role: "Role", # required
  input_bucket: "BucketName", # required
  output_bucket: "BucketName", # required
  topics: ["SnsTopic"], # required
})

Response structure


resp.success #=> String
resp.messages #=> Array
resp.messages[0] #=> String

Options Hash (options):

  • :role (required, String)

    The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.

  • :input_bucket (required, String)

    The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.

  • :output_bucket (required, String)

    The Amazon S3 bucket that Elastic Transcoder writes transcoded media files to. The action attempts to read from this bucket.

  • :topics (required, Array<String>)

    The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.

Returns:

#update_pipeline(options = {}) ⇒ Types::UpdatePipelineResponse

Use the UpdatePipeline operation to update settings for a pipeline.

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.

Examples:

Request syntax with placeholder values


resp = client.update_pipeline({
  id: "Id", # required
  name: "Name",
  input_bucket: "BucketName",
  role: "Role",
  aws_kms_key_arn: "KeyArn",
  notifications: {
    progressing: "SnsTopic",
    completed: "SnsTopic",
    warning: "SnsTopic",
    error: "SnsTopic",
  },
  content_config: {
    bucket: "BucketName",
    storage_class: "StorageClass",
    permissions: [
      {
        grantee_type: "GranteeType",
        grantee: "Grantee",
        access: ["AccessControl"],
      },
    ],
  },
  thumbnail_config: {
    bucket: "BucketName",
    storage_class: "StorageClass",
    permissions: [
      {
        grantee_type: "GranteeType",
        grantee: "Grantee",
        access: ["AccessControl"],
      },
    ],
  },
})

Response structure


resp.pipeline.id #=> String
resp.pipeline.arn #=> String
resp.pipeline.name #=> String
resp.pipeline.status #=> String
resp.pipeline.input_bucket #=> String
resp.pipeline.output_bucket #=> String
resp.pipeline.role #=> String
resp.pipeline.aws_kms_key_arn #=> String
resp.pipeline.notifications.progressing #=> String
resp.pipeline.notifications.completed #=> String
resp.pipeline.notifications.warning #=> String
resp.pipeline.notifications.error #=> String
resp.pipeline.content_config.bucket #=> String
resp.pipeline.content_config.storage_class #=> String
resp.pipeline.content_config.permissions #=> Array
resp.pipeline.content_config.permissions[0].grantee_type #=> String
resp.pipeline.content_config.permissions[0].grantee #=> String
resp.pipeline.content_config.permissions[0].access #=> Array
resp.pipeline.content_config.permissions[0].access[0] #=> String
resp.pipeline.thumbnail_config.bucket #=> String
resp.pipeline.thumbnail_config.storage_class #=> String
resp.pipeline.thumbnail_config.permissions #=> Array
resp.pipeline.thumbnail_config.permissions[0].grantee_type #=> String
resp.pipeline.thumbnail_config.permissions[0].grantee #=> String
resp.pipeline.thumbnail_config.permissions[0].access #=> Array
resp.pipeline.thumbnail_config.permissions[0].access[0] #=> String
resp.warnings #=> Array
resp.warnings[0].code #=> String
resp.warnings[0].message #=> String

Options Hash (options):

  • :id (required, String)

    The ID of the pipeline that you want to update.

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

    The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want to use as watermarks.

  • :role (String)

    The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for this pipeline.

  • :aws_kms_key_arn (String)

    The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

    If you use either S3 or S3-AWS-KMS as your Encryption:Mode, you don\'t need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of AES-PKCS7, AES-CTR, or AES-GCM.

  • :notifications (Types::Notifications)

    The topic ARN for 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 topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

    • Completed: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.

    • Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.

    • Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.

  • :content_config (Types::PipelineOutputConfig)

    The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

    If you specify values for ContentConfig, you must also specify values for ThumbnailConfig.

    If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

    • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

    • Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

    • Grantee Type: Specify the type of value that appears in the Grantee object:

      • Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content.

        A canonical user ID is not the same as an AWS account number.

      • Email: The value in the Grantee object is the registered email address of an AWS account.

      • Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group

    • Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include:

      • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

  • :thumbnail_config (Types::PipelineOutputConfig)

    The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

    If you specify values for ContentConfig, you must also specify values for ThumbnailConfig even if you don\'t want to create thumbnails.

    If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

    • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

    • Permissions (Optional): The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

    • GranteeType: Specify the type of value that appears in the Grantee object:

      • Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

        A canonical user ID is not the same as an AWS account number.

      • Email: The value in the Grantee object is the registered email address of an AWS account.

      • Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.

    • Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include:

      • READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

    • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

Returns:

#update_pipeline_notifications(options = {}) ⇒ Types::UpdatePipelineNotificationsResponse

With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline.

When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request.

Examples:

Request syntax with placeholder values


resp = client.update_pipeline_notifications({
  id: "Id", # required
  notifications: { # required
    progressing: "SnsTopic",
    completed: "SnsTopic",
    warning: "SnsTopic",
    error: "SnsTopic",
  },
})

Response structure


resp.pipeline.id #=> String
resp.pipeline.arn #=> String
resp.pipeline.name #=> String
resp.pipeline.status #=> String
resp.pipeline.input_bucket #=> String
resp.pipeline.output_bucket #=> String
resp.pipeline.role #=> String
resp.pipeline.aws_kms_key_arn #=> String
resp.pipeline.notifications.progressing #=> String
resp.pipeline.notifications.completed #=> String
resp.pipeline.notifications.warning #=> String
resp.pipeline.notifications.error #=> String
resp.pipeline.content_config.bucket #=> String
resp.pipeline.content_config.storage_class #=> String
resp.pipeline.content_config.permissions #=> Array
resp.pipeline.content_config.permissions[0].grantee_type #=> String
resp.pipeline.content_config.permissions[0].grantee #=> String
resp.pipeline.content_config.permissions[0].access #=> Array
resp.pipeline.content_config.permissions[0].access[0] #=> String
resp.pipeline.thumbnail_config.bucket #=> String
resp.pipeline.thumbnail_config.storage_class #=> String
resp.pipeline.thumbnail_config.permissions #=> Array
resp.pipeline.thumbnail_config.permissions[0].grantee_type #=> String
resp.pipeline.thumbnail_config.permissions[0].grantee #=> String
resp.pipeline.thumbnail_config.permissions[0].access #=> Array
resp.pipeline.thumbnail_config.permissions[0].access[0] #=> String

Options Hash (options):

  • :id (required, String)

    The identifier of the pipeline for which you want to change notification settings.

  • :notifications (required, Types::Notifications)

    The topic ARN for 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 topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

    • Completed: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.

    • Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.

    • Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.

Returns:

#update_pipeline_status(options = {}) ⇒ Types::UpdatePipelineStatusResponse

The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs.

Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request.

Examples:

Request syntax with placeholder values


resp = client.update_pipeline_status({
  id: "Id", # required
  status: "PipelineStatus", # required
})

Response structure


resp.pipeline.id #=> String
resp.pipeline.arn #=> String
resp.pipeline.name #=> String
resp.pipeline.status #=> String
resp.pipeline.input_bucket #=> String
resp.pipeline.output_bucket #=> String
resp.pipeline.role #=> String
resp.pipeline.aws_kms_key_arn #=> String
resp.pipeline.notifications.progressing #=> String
resp.pipeline.notifications.completed #=> String
resp.pipeline.notifications.warning #=> String
resp.pipeline.notifications.error #=> String
resp.pipeline.content_config.bucket #=> String
resp.pipeline.content_config.storage_class #=> String
resp.pipeline.content_config.permissions #=> Array
resp.pipeline.content_config.permissions[0].grantee_type #=> String
resp.pipeline.content_config.permissions[0].grantee #=> String
resp.pipeline.content_config.permissions[0].access #=> Array
resp.pipeline.content_config.permissions[0].access[0] #=> String
resp.pipeline.thumbnail_config.bucket #=> String
resp.pipeline.thumbnail_config.storage_class #=> String
resp.pipeline.thumbnail_config.permissions #=> Array
resp.pipeline.thumbnail_config.permissions[0].grantee_type #=> String
resp.pipeline.thumbnail_config.permissions[0].grantee #=> String
resp.pipeline.thumbnail_config.permissions[0].access #=> Array
resp.pipeline.thumbnail_config.permissions[0].access[0] #=> String

Options Hash (options):

  • :id (required, String)

    The identifier of the pipeline to update.

  • :status (required, String)

    The desired status of the pipeline:

    • Active: The pipeline is processing jobs.

    • Paused: The pipeline is not currently processing jobs.

Returns:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:
:job_complete#read_job30120

Returns:

  • (Array<Symbol>)

    the list of supported waiters.