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

Class: Aws::MediaPackageVod::Client

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

Overview

An API client for AWS Elemental MediaPackage VOD. To construct a client, you need to configure a :region and :credentials.

mediapackagevod = Aws::MediaPackageVod::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::MediaPackageVod::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::MediaPackageVod::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String) —

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

  • :active_endpoint_cache (Boolean) —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery 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.
  • :disable_host_prefix_injection (Boolean) —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String) —

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

  • :endpoint_cache_max_entries (Integer) —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer) —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer) —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean) —

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery 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

#create_asset(options = {}) ⇒ Types::CreateAssetResponse

Creates a new MediaPackage VOD Asset resource.

Examples:

Request syntax with placeholder values


resp = client.create_asset({
  id: "__string", # required
  packaging_group_id: "__string", # required
  resource_id: "__string",
  source_arn: "__string", # required
  source_role_arn: "__string", # required
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.arn #=> String
resp.created_at #=> String
resp.egress_endpoints #=> Array
resp.egress_endpoints[0].packaging_configuration_id #=> String
resp.egress_endpoints[0].url #=> String
resp.id #=> String
resp.packaging_group_id #=> String
resp.resource_id #=> String
resp.source_arn #=> String
resp.source_role_arn #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Options Hash (options):

  • :id (required, String)
  • :packaging_group_id (required, String)
  • :resource_id (String)
  • :source_arn (required, String)
  • :source_role_arn (required, String)
  • :tags (Hash<String,String>) —

    A collection of tags associated with a resource

Returns:

See Also:

#create_packaging_configuration(options = {}) ⇒ Types::CreatePackagingConfigurationResponse

Creates a new MediaPackage VOD PackagingConfiguration resource.

Examples:

Request syntax with placeholder values


resp = client.create_packaging_configuration({
  cmaf_package: {
    encryption: {
      speke_key_provider: { # required
        role_arn: "__string", # required
        system_ids: ["__string"], # required
        url: "__string", # required
      },
    },
    hls_manifests: [ # required
      {
        ad_markers: "NONE", # accepts NONE, SCTE35_ENHANCED, PASSTHROUGH
        include_iframe_only_stream: false,
        manifest_name: "__string",
        program_date_time_interval_seconds: 1,
        repeat_ext_x_key: false,
        stream_selection: {
          max_video_bits_per_second: 1,
          min_video_bits_per_second: 1,
          stream_order: "ORIGINAL", # accepts ORIGINAL, VIDEO_BITRATE_ASCENDING, VIDEO_BITRATE_DESCENDING
        },
      },
    ],
    segment_duration_seconds: 1,
  },
  dash_package: {
    dash_manifests: [ # required
      {
        manifest_layout: "FULL", # accepts FULL, COMPACT
        manifest_name: "__string",
        min_buffer_time_seconds: 1,
        profile: "NONE", # accepts NONE, HBBTV_1_5
        stream_selection: {
          max_video_bits_per_second: 1,
          min_video_bits_per_second: 1,
          stream_order: "ORIGINAL", # accepts ORIGINAL, VIDEO_BITRATE_ASCENDING, VIDEO_BITRATE_DESCENDING
        },
      },
    ],
    encryption: {
      speke_key_provider: { # required
        role_arn: "__string", # required
        system_ids: ["__string"], # required
        url: "__string", # required
      },
    },
    period_triggers: ["ADS"], # accepts ADS
    segment_duration_seconds: 1,
    segment_template_format: "NUMBER_WITH_TIMELINE", # accepts NUMBER_WITH_TIMELINE, TIME_WITH_TIMELINE, NUMBER_WITH_DURATION
  },
  hls_package: {
    encryption: {
      constant_initialization_vector: "__string",
      encryption_method: "AES_128", # accepts AES_128, SAMPLE_AES
      speke_key_provider: { # required
        role_arn: "__string", # required
        system_ids: ["__string"], # required
        url: "__string", # required
      },
    },
    hls_manifests: [ # required
      {
        ad_markers: "NONE", # accepts NONE, SCTE35_ENHANCED, PASSTHROUGH
        include_iframe_only_stream: false,
        manifest_name: "__string",
        program_date_time_interval_seconds: 1,
        repeat_ext_x_key: false,
        stream_selection: {
          max_video_bits_per_second: 1,
          min_video_bits_per_second: 1,
          stream_order: "ORIGINAL", # accepts ORIGINAL, VIDEO_BITRATE_ASCENDING, VIDEO_BITRATE_DESCENDING
        },
      },
    ],
    segment_duration_seconds: 1,
    use_audio_rendition_group: false,
  },
  id: "__string", # required
  mss_package: {
    encryption: {
      speke_key_provider: { # required
        role_arn: "__string", # required
        system_ids: ["__string"], # required
        url: "__string", # required
      },
    },
    mss_manifests: [ # required
      {
        manifest_name: "__string",
        stream_selection: {
          max_video_bits_per_second: 1,
          min_video_bits_per_second: 1,
          stream_order: "ORIGINAL", # accepts ORIGINAL, VIDEO_BITRATE_ASCENDING, VIDEO_BITRATE_DESCENDING
        },
      },
    ],
    segment_duration_seconds: 1,
  },
  packaging_group_id: "__string", # required
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.arn #=> String
resp.cmaf_package.encryption.speke_key_provider.role_arn #=> String
resp.cmaf_package.encryption.speke_key_provider.system_ids #=> Array
resp.cmaf_package.encryption.speke_key_provider.system_ids[0] #=> String
resp.cmaf_package.encryption.speke_key_provider.url #=> String
resp.cmaf_package.hls_manifests #=> Array
resp.cmaf_package.hls_manifests[0].ad_markers #=> String, one of "NONE", "SCTE35_ENHANCED", "PASSTHROUGH"
resp.cmaf_package.hls_manifests[0].include_iframe_only_stream #=> true/false
resp.cmaf_package.hls_manifests[0].manifest_name #=> String
resp.cmaf_package.hls_manifests[0].program_date_time_interval_seconds #=> Integer
resp.cmaf_package.hls_manifests[0].repeat_ext_x_key #=> true/false
resp.cmaf_package.hls_manifests[0].stream_selection.max_video_bits_per_second #=> Integer
resp.cmaf_package.hls_manifests[0].stream_selection.min_video_bits_per_second #=> Integer
resp.cmaf_package.hls_manifests[0].stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.cmaf_package.segment_duration_seconds #=> Integer
resp.dash_package.dash_manifests #=> Array
resp.dash_package.dash_manifests[0].manifest_layout #=> String, one of "FULL", "COMPACT"
resp.dash_package.dash_manifests[0].manifest_name #=> String
resp.dash_package.dash_manifests[0].min_buffer_time_seconds #=> Integer
resp.dash_package.dash_manifests[0].profile #=> String, one of "NONE", "HBBTV_1_5"
resp.dash_package.dash_manifests[0].stream_selection.max_video_bits_per_second #=> Integer
resp.dash_package.dash_manifests[0].stream_selection.min_video_bits_per_second #=> Integer
resp.dash_package.dash_manifests[0].stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.dash_package.encryption.speke_key_provider.role_arn #=> String
resp.dash_package.encryption.speke_key_provider.system_ids #=> Array
resp.dash_package.encryption.speke_key_provider.system_ids[0] #=> String
resp.dash_package.encryption.speke_key_provider.url #=> String
resp.dash_package.period_triggers #=> Array
resp.dash_package.period_triggers[0] #=> String, one of "ADS"
resp.dash_package.segment_duration_seconds #=> Integer
resp.dash_package.segment_template_format #=> String, one of "NUMBER_WITH_TIMELINE", "TIME_WITH_TIMELINE", "NUMBER_WITH_DURATION"
resp.hls_package.encryption.constant_initialization_vector #=> String
resp.hls_package.encryption.encryption_method #=> String, one of "AES_128", "SAMPLE_AES"
resp.hls_package.encryption.speke_key_provider.role_arn #=> String
resp.hls_package.encryption.speke_key_provider.system_ids #=> Array
resp.hls_package.encryption.speke_key_provider.system_ids[0] #=> String
resp.hls_package.encryption.speke_key_provider.url #=> String
resp.hls_package.hls_manifests #=> Array
resp.hls_package.hls_manifests[0].ad_markers #=> String, one of "NONE", "SCTE35_ENHANCED", "PASSTHROUGH"
resp.hls_package.hls_manifests[0].include_iframe_only_stream #=> true/false
resp.hls_package.hls_manifests[0].manifest_name #=> String
resp.hls_package.hls_manifests[0].program_date_time_interval_seconds #=> Integer
resp.hls_package.hls_manifests[0].repeat_ext_x_key #=> true/false
resp.hls_package.hls_manifests[0].stream_selection.max_video_bits_per_second #=> Integer
resp.hls_package.hls_manifests[0].stream_selection.min_video_bits_per_second #=> Integer
resp.hls_package.hls_manifests[0].stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.hls_package.segment_duration_seconds #=> Integer
resp.hls_package.use_audio_rendition_group #=> true/false
resp.id #=> String
resp.mss_package.encryption.speke_key_provider.role_arn #=> String
resp.mss_package.encryption.speke_key_provider.system_ids #=> Array
resp.mss_package.encryption.speke_key_provider.system_ids[0] #=> String
resp.mss_package.encryption.speke_key_provider.url #=> String
resp.mss_package.mss_manifests #=> Array
resp.mss_package.mss_manifests[0].manifest_name #=> String
resp.mss_package.mss_manifests[0].stream_selection.max_video_bits_per_second #=> Integer
resp.mss_package.mss_manifests[0].stream_selection.min_video_bits_per_second #=> Integer
resp.mss_package.mss_manifests[0].stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.mss_package.segment_duration_seconds #=> Integer
resp.packaging_group_id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Options Hash (options):

  • :cmaf_package (Types::CmafPackage) —

    A CMAF packaging configuration.

  • :dash_package (Types::DashPackage) —

    A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.

  • :hls_package (Types::HlsPackage) —

    An HTTP Live Streaming (HLS) packaging configuration.

  • :id (required, String)
  • :mss_package (Types::MssPackage) —

    A Microsoft Smooth Streaming (MSS) PackagingConfiguration.

  • :packaging_group_id (required, String)
  • :tags (Hash<String,String>) —

    A collection of tags associated with a resource

Returns:

See Also:

#create_packaging_group(options = {}) ⇒ Types::CreatePackagingGroupResponse

Creates a new MediaPackage VOD PackagingGroup resource.

Examples:

Request syntax with placeholder values


resp = client.create_packaging_group({
  authorization: {
    cdn_identifier_secret: "__string", # required
    secrets_role_arn: "__string", # required
  },
  id: "__string", # required
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.arn #=> String
resp.authorization.cdn_identifier_secret #=> String
resp.authorization.secrets_role_arn #=> String
resp.domain_name #=> String
resp.id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Options Hash (options):

  • :authorization (Types::Authorization) —

    CDN Authorization credentials

  • :id (required, String)
  • :tags (Hash<String,String>) —

    A collection of tags associated with a resource

Returns:

See Also:

#delete_asset(options = {}) ⇒ Struct

Deletes an existing MediaPackage VOD Asset resource.

Examples:

Request syntax with placeholder values


resp = client.delete_asset({
  id: "__string", # required
})

Options Hash (options):

  • :id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_packaging_configuration(options = {}) ⇒ Struct

Deletes a MediaPackage VOD PackagingConfiguration resource.

Examples:

Request syntax with placeholder values


resp = client.delete_packaging_configuration({
  id: "__string", # required
})

Options Hash (options):

  • :id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_packaging_group(options = {}) ⇒ Struct

Deletes a MediaPackage VOD PackagingGroup resource.

Examples:

Request syntax with placeholder values


resp = client.delete_packaging_group({
  id: "__string", # required
})

Options Hash (options):

  • :id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#describe_asset(options = {}) ⇒ Types::DescribeAssetResponse

Returns a description of a MediaPackage VOD Asset resource.

Examples:

Request syntax with placeholder values


resp = client.describe_asset({
  id: "__string", # required
})

Response structure


resp.arn #=> String
resp.created_at #=> String
resp.egress_endpoints #=> Array
resp.egress_endpoints[0].packaging_configuration_id #=> String
resp.egress_endpoints[0].url #=> String
resp.id #=> String
resp.packaging_group_id #=> String
resp.resource_id #=> String
resp.source_arn #=> String
resp.source_role_arn #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Options Hash (options):

  • :id (required, String)

Returns:

See Also:

#describe_packaging_configuration(options = {}) ⇒ Types::DescribePackagingConfigurationResponse

Returns a description of a MediaPackage VOD PackagingConfiguration resource.

Examples:

Request syntax with placeholder values


resp = client.describe_packaging_configuration({
  id: "__string", # required
})

Response structure


resp.arn #=> String
resp.cmaf_package.encryption.speke_key_provider.role_arn #=> String
resp.cmaf_package.encryption.speke_key_provider.system_ids #=> Array
resp.cmaf_package.encryption.speke_key_provider.system_ids[0] #=> String
resp.cmaf_package.encryption.speke_key_provider.url #=> String
resp.cmaf_package.hls_manifests #=> Array
resp.cmaf_package.hls_manifests[0].ad_markers #=> String, one of "NONE", "SCTE35_ENHANCED", "PASSTHROUGH"
resp.cmaf_package.hls_manifests[0].include_iframe_only_stream #=> true/false
resp.cmaf_package.hls_manifests[0].manifest_name #=> String
resp.cmaf_package.hls_manifests[0].program_date_time_interval_seconds #=> Integer
resp.cmaf_package.hls_manifests[0].repeat_ext_x_key #=> true/false
resp.cmaf_package.hls_manifests[0].stream_selection.max_video_bits_per_second #=> Integer
resp.cmaf_package.hls_manifests[0].stream_selection.min_video_bits_per_second #=> Integer
resp.cmaf_package.hls_manifests[0].stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.cmaf_package.segment_duration_seconds #=> Integer
resp.dash_package.dash_manifests #=> Array
resp.dash_package.dash_manifests[0].manifest_layout #=> String, one of "FULL", "COMPACT"
resp.dash_package.dash_manifests[0].manifest_name #=> String
resp.dash_package.dash_manifests[0].min_buffer_time_seconds #=> Integer
resp.dash_package.dash_manifests[0].profile #=> String, one of "NONE", "HBBTV_1_5"
resp.dash_package.dash_manifests[0].stream_selection.max_video_bits_per_second #=> Integer
resp.dash_package.dash_manifests[0].stream_selection.min_video_bits_per_second #=> Integer
resp.dash_package.dash_manifests[0].stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.dash_package.encryption.speke_key_provider.role_arn #=> String
resp.dash_package.encryption.speke_key_provider.system_ids #=> Array
resp.dash_package.encryption.speke_key_provider.system_ids[0] #=> String
resp.dash_package.encryption.speke_key_provider.url #=> String
resp.dash_package.period_triggers #=> Array
resp.dash_package.period_triggers[0] #=> String, one of "ADS"
resp.dash_package.segment_duration_seconds #=> Integer
resp.dash_package.segment_template_format #=> String, one of "NUMBER_WITH_TIMELINE", "TIME_WITH_TIMELINE", "NUMBER_WITH_DURATION"
resp.hls_package.encryption.constant_initialization_vector #=> String
resp.hls_package.encryption.encryption_method #=> String, one of "AES_128", "SAMPLE_AES"
resp.hls_package.encryption.speke_key_provider.role_arn #=> String
resp.hls_package.encryption.speke_key_provider.system_ids #=> Array
resp.hls_package.encryption.speke_key_provider.system_ids[0] #=> String
resp.hls_package.encryption.speke_key_provider.url #=> String
resp.hls_package.hls_manifests #=> Array
resp.hls_package.hls_manifests[0].ad_markers #=> String, one of "NONE", "SCTE35_ENHANCED", "PASSTHROUGH"
resp.hls_package.hls_manifests[0].include_iframe_only_stream #=> true/false
resp.hls_package.hls_manifests[0].manifest_name #=> String
resp.hls_package.hls_manifests[0].program_date_time_interval_seconds #=> Integer
resp.hls_package.hls_manifests[0].repeat_ext_x_key #=> true/false
resp.hls_package.hls_manifests[0].stream_selection.max_video_bits_per_second #=> Integer
resp.hls_package.hls_manifests[0].stream_selection.min_video_bits_per_second #=> Integer
resp.hls_package.hls_manifests[0].stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.hls_package.segment_duration_seconds #=> Integer
resp.hls_package.use_audio_rendition_group #=> true/false
resp.id #=> String
resp.mss_package.encryption.speke_key_provider.role_arn #=> String
resp.mss_package.encryption.speke_key_provider.system_ids #=> Array
resp.mss_package.encryption.speke_key_provider.system_ids[0] #=> String
resp.mss_package.encryption.speke_key_provider.url #=> String
resp.mss_package.mss_manifests #=> Array
resp.mss_package.mss_manifests[0].manifest_name #=> String
resp.mss_package.mss_manifests[0].stream_selection.max_video_bits_per_second #=> Integer
resp.mss_package.mss_manifests[0].stream_selection.min_video_bits_per_second #=> Integer
resp.mss_package.mss_manifests[0].stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.mss_package.segment_duration_seconds #=> Integer
resp.packaging_group_id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Options Hash (options):

  • :id (required, String)

Returns:

See Also:

#describe_packaging_group(options = {}) ⇒ Types::DescribePackagingGroupResponse

Returns a description of a MediaPackage VOD PackagingGroup resource.

Examples:

Request syntax with placeholder values


resp = client.describe_packaging_group({
  id: "__string", # required
})

Response structure


resp.arn #=> String
resp.authorization.cdn_identifier_secret #=> String
resp.authorization.secrets_role_arn #=> String
resp.domain_name #=> String
resp.id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Options Hash (options):

  • :id (required, String)

Returns:

See Also:

#list_assets(options = {}) ⇒ Types::ListAssetsResponse

Returns a collection of MediaPackage VOD Asset resources.

Examples:

Request syntax with placeholder values


resp = client.list_assets({
  max_results: 1,
  next_token: "__string",
  packaging_group_id: "__string",
})

Response structure


resp.assets #=> Array
resp.assets[0].arn #=> String
resp.assets[0].created_at #=> String
resp.assets[0].id #=> String
resp.assets[0].packaging_group_id #=> String
resp.assets[0].resource_id #=> String
resp.assets[0].source_arn #=> String
resp.assets[0].source_role_arn #=> String
resp.assets[0].tags #=> Hash
resp.assets[0].tags["__string"] #=> String
resp.next_token #=> String

Options Hash (options):

  • :max_results (Integer)
  • :next_token (String)
  • :packaging_group_id (String)

Returns:

See Also:

#list_packaging_configurations(options = {}) ⇒ Types::ListPackagingConfigurationsResponse

Returns a collection of MediaPackage VOD PackagingConfiguration resources.

Examples:

Request syntax with placeholder values


resp = client.list_packaging_configurations({
  max_results: 1,
  next_token: "__string",
  packaging_group_id: "__string",
})

Response structure


resp.next_token #=> String
resp.packaging_configurations #=> Array
resp.packaging_configurations[0].arn #=> String
resp.packaging_configurations[0].cmaf_package.encryption.speke_key_provider.role_arn #=> String
resp.packaging_configurations[0].cmaf_package.encryption.speke_key_provider.system_ids #=> Array
resp.packaging_configurations[0].cmaf_package.encryption.speke_key_provider.system_ids[0] #=> String
resp.packaging_configurations[0].cmaf_package.encryption.speke_key_provider.url #=> String
resp.packaging_configurations[0].cmaf_package.hls_manifests #=> Array
resp.packaging_configurations[0].cmaf_package.hls_manifests[0].ad_markers #=> String, one of "NONE", "SCTE35_ENHANCED", "PASSTHROUGH"
resp.packaging_configurations[0].cmaf_package.hls_manifests[0].include_iframe_only_stream #=> true/false
resp.packaging_configurations[0].cmaf_package.hls_manifests[0].manifest_name #=> String
resp.packaging_configurations[0].cmaf_package.hls_manifests[0].program_date_time_interval_seconds #=> Integer
resp.packaging_configurations[0].cmaf_package.hls_manifests[0].repeat_ext_x_key #=> true/false
resp.packaging_configurations[0].cmaf_package.hls_manifests[0].stream_selection.max_video_bits_per_second #=> Integer
resp.packaging_configurations[0].cmaf_package.hls_manifests[0].stream_selection.min_video_bits_per_second #=> Integer
resp.packaging_configurations[0].cmaf_package.hls_manifests[0].stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.packaging_configurations[0].cmaf_package.segment_duration_seconds #=> Integer
resp.packaging_configurations[0].dash_package.dash_manifests #=> Array
resp.packaging_configurations[0].dash_package.dash_manifests[0].manifest_layout #=> String, one of "FULL", "COMPACT"
resp.packaging_configurations[0].dash_package.dash_manifests[0].manifest_name #=> String
resp.packaging_configurations[0].dash_package.dash_manifests[0].min_buffer_time_seconds #=> Integer
resp.packaging_configurations[0].dash_package.dash_manifests[0].profile #=> String, one of "NONE", "HBBTV_1_5"
resp.packaging_configurations[0].dash_package.dash_manifests[0].stream_selection.max_video_bits_per_second #=> Integer
resp.packaging_configurations[0].dash_package.dash_manifests[0].stream_selection.min_video_bits_per_second #=> Integer
resp.packaging_configurations[0].dash_package.dash_manifests[0].stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.packaging_configurations[0].dash_package.encryption.speke_key_provider.role_arn #=> String
resp.packaging_configurations[0].dash_package.encryption.speke_key_provider.system_ids #=> Array
resp.packaging_configurations[0].dash_package.encryption.speke_key_provider.system_ids[0] #=> String
resp.packaging_configurations[0].dash_package.encryption.speke_key_provider.url #=> String
resp.packaging_configurations[0].dash_package.period_triggers #=> Array
resp.packaging_configurations[0].dash_package.period_triggers[0] #=> String, one of "ADS"
resp.packaging_configurations[0].dash_package.segment_duration_seconds #=> Integer
resp.packaging_configurations[0].dash_package.segment_template_format #=> String, one of "NUMBER_WITH_TIMELINE", "TIME_WITH_TIMELINE", "NUMBER_WITH_DURATION"
resp.packaging_configurations[0].hls_package.encryption.constant_initialization_vector #=> String
resp.packaging_configurations[0].hls_package.encryption.encryption_method #=> String, one of "AES_128", "SAMPLE_AES"
resp.packaging_configurations[0].hls_package.encryption.speke_key_provider.role_arn #=> String
resp.packaging_configurations[0].hls_package.encryption.speke_key_provider.system_ids #=> Array
resp.packaging_configurations[0].hls_package.encryption.speke_key_provider.system_ids[0] #=> String
resp.packaging_configurations[0].hls_package.encryption.speke_key_provider.url #=> String
resp.packaging_configurations[0].hls_package.hls_manifests #=> Array
resp.packaging_configurations[0].hls_package.hls_manifests[0].ad_markers #=> String, one of "NONE", "SCTE35_ENHANCED", "PASSTHROUGH"
resp.packaging_configurations[0].hls_package.hls_manifests[0].include_iframe_only_stream #=> true/false
resp.packaging_configurations[0].hls_package.hls_manifests[0].manifest_name #=> String
resp.packaging_configurations[0].hls_package.hls_manifests[0].program_date_time_interval_seconds #=> Integer
resp.packaging_configurations[0].hls_package.hls_manifests[0].repeat_ext_x_key #=> true/false
resp.packaging_configurations[0].hls_package.hls_manifests[0].stream_selection.max_video_bits_per_second #=> Integer
resp.packaging_configurations[0].hls_package.hls_manifests[0].stream_selection.min_video_bits_per_second #=> Integer
resp.packaging_configurations[0].hls_package.hls_manifests[0].stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.packaging_configurations[0].hls_package.segment_duration_seconds #=> Integer
resp.packaging_configurations[0].hls_package.use_audio_rendition_group #=> true/false
resp.packaging_configurations[0].id #=> String
resp.packaging_configurations[0].mss_package.encryption.speke_key_provider.role_arn #=> String
resp.packaging_configurations[0].mss_package.encryption.speke_key_provider.system_ids #=> Array
resp.packaging_configurations[0].mss_package.encryption.speke_key_provider.system_ids[0] #=> String
resp.packaging_configurations[0].mss_package.encryption.speke_key_provider.url #=> String
resp.packaging_configurations[0].mss_package.mss_manifests #=> Array
resp.packaging_configurations[0].mss_package.mss_manifests[0].manifest_name #=> String
resp.packaging_configurations[0].mss_package.mss_manifests[0].stream_selection.max_video_bits_per_second #=> Integer
resp.packaging_configurations[0].mss_package.mss_manifests[0].stream_selection.min_video_bits_per_second #=> Integer
resp.packaging_configurations[0].mss_package.mss_manifests[0].stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.packaging_configurations[0].mss_package.segment_duration_seconds #=> Integer
resp.packaging_configurations[0].packaging_group_id #=> String
resp.packaging_configurations[0].tags #=> Hash
resp.packaging_configurations[0].tags["__string"] #=> String

Options Hash (options):

  • :max_results (Integer)
  • :next_token (String)
  • :packaging_group_id (String)

Returns:

See Also:

#list_packaging_groups(options = {}) ⇒ Types::ListPackagingGroupsResponse

Returns a collection of MediaPackage VOD PackagingGroup resources.

Examples:

Request syntax with placeholder values


resp = client.list_packaging_groups({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.packaging_groups #=> Array
resp.packaging_groups[0].arn #=> String
resp.packaging_groups[0].authorization.cdn_identifier_secret #=> String
resp.packaging_groups[0].authorization.secrets_role_arn #=> String
resp.packaging_groups[0].domain_name #=> String
resp.packaging_groups[0].id #=> String
resp.packaging_groups[0].tags #=> Hash
resp.packaging_groups[0].tags["__string"] #=> String

Options Hash (options):

  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:

#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse

Returns a list of the tags assigned to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "__string", # required
})

Response structure


resp.tags #=> Hash
resp.tags["__string"] #=> String

Options Hash (options):

  • :resource_arn (required, String)

Returns:

See Also:

#tag_resource(options = {}) ⇒ Struct

Adds tags to the specified resource. You can specify one or more tags to add.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "__string", # required
  tags: { # required
    "__string" => "__string",
  },
})

Options Hash (options):

  • :resource_arn (required, String)
  • :tags (required, Hash<String,String>)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#untag_resource(options = {}) ⇒ Struct

Removes tags from the specified resource. You can specify one or more tags to remove.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "__string", # required
  tag_keys: ["__string"], # required
})

Options Hash (options):

  • :resource_arn (required, String)
  • :tag_keys (required, Array<String>)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#update_packaging_group(options = {}) ⇒ Types::UpdatePackagingGroupResponse

Updates a specific packaging group. You can't change the id attribute or any other system-generated attributes.

Examples:

Request syntax with placeholder values


resp = client.update_packaging_group({
  authorization: {
    cdn_identifier_secret: "__string", # required
    secrets_role_arn: "__string", # required
  },
  id: "__string", # required
})

Response structure


resp.arn #=> String
resp.authorization.cdn_identifier_secret #=> String
resp.authorization.secrets_role_arn #=> String
resp.domain_name #=> String
resp.id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Options Hash (options):

Returns:

See Also:

#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_names ⇒ Array<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:

Returns:

  • (Array<Symbol>) —

    the list of supported waiters.