Class: Aws::MediaPackageVod::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-mediapackagevod/client.rb

Overview

An API client for MediaPackageVod. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::MediaPackageVod::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

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

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::MediaPackageVod::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::MediaPackageVod::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



467
468
469
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 467

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1528
1529
1530
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 1528

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1531
1532
1533
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 1531

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 1501

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::MediaPackageVod')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-mediapackagevod'
  context[:gem_version] = '1.66.0'
  Seahorse::Client::Request.new(handlers, context)
end

#configure_logs(params = {}) ⇒ Types::ConfigureLogsResponse

Changes the packaging group’s properities to configure log subscription

Examples:

Request syntax with placeholder values


resp = client.configure_logs({
  egress_access_logs: {
    log_group_name: "__string",
  },
  id: "__string", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



516
517
518
519
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 516

def configure_logs(params = {}, options = {})
  req = build_request(:configure_logs, params)
  req.send_request(options)
end

#create_asset(params = {}) ⇒ 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].status #=> 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

Parameters:

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

    ({})

Options Hash (params):

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



581
582
583
584
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 581

def create_asset(params = {}, options = {})
  req = build_request(:create_asset, params)
  req.send_request(options)
end

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

Creates a new MediaPackage VOD PackagingConfiguration resource.

Examples:

Request syntax with placeholder values


resp = client.create_packaging_configuration({
  cmaf_package: {
    encryption: {
      constant_initialization_vector: "__string",
      speke_key_provider: { # required
        encryption_contract_configuration: {
          preset_speke_20_audio: "PRESET-AUDIO-1", # required, accepts PRESET-AUDIO-1, PRESET-AUDIO-2, PRESET-AUDIO-3, SHARED, UNENCRYPTED
          preset_speke_20_video: "PRESET-VIDEO-1", # required, accepts PRESET-VIDEO-1, PRESET-VIDEO-2, PRESET-VIDEO-3, PRESET-VIDEO-4, PRESET-VIDEO-5, PRESET-VIDEO-6, PRESET-VIDEO-7, PRESET-VIDEO-8, SHARED, UNENCRYPTED
        },
        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
        },
      },
    ],
    include_encoder_configuration_in_segments: false,
    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
        scte_markers_source: "SEGMENTS", # accepts SEGMENTS, MANIFEST
        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
        encryption_contract_configuration: {
          preset_speke_20_audio: "PRESET-AUDIO-1", # required, accepts PRESET-AUDIO-1, PRESET-AUDIO-2, PRESET-AUDIO-3, SHARED, UNENCRYPTED
          preset_speke_20_video: "PRESET-VIDEO-1", # required, accepts PRESET-VIDEO-1, PRESET-VIDEO-2, PRESET-VIDEO-3, PRESET-VIDEO-4, PRESET-VIDEO-5, PRESET-VIDEO-6, PRESET-VIDEO-7, PRESET-VIDEO-8, SHARED, UNENCRYPTED
        },
        role_arn: "__string", # required
        system_ids: ["__string"], # required
        url: "__string", # required
      },
    },
    include_encoder_configuration_in_segments: false,
    include_iframe_only_stream: false,
    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
        encryption_contract_configuration: {
          preset_speke_20_audio: "PRESET-AUDIO-1", # required, accepts PRESET-AUDIO-1, PRESET-AUDIO-2, PRESET-AUDIO-3, SHARED, UNENCRYPTED
          preset_speke_20_video: "PRESET-VIDEO-1", # required, accepts PRESET-VIDEO-1, PRESET-VIDEO-2, PRESET-VIDEO-3, PRESET-VIDEO-4, PRESET-VIDEO-5, PRESET-VIDEO-6, PRESET-VIDEO-7, PRESET-VIDEO-8, SHARED, UNENCRYPTED
        },
        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
        },
      },
    ],
    include_dvb_subtitles: false,
    segment_duration_seconds: 1,
    use_audio_rendition_group: false,
  },
  id: "__string", # required
  mss_package: {
    encryption: {
      speke_key_provider: { # required
        encryption_contract_configuration: {
          preset_speke_20_audio: "PRESET-AUDIO-1", # required, accepts PRESET-AUDIO-1, PRESET-AUDIO-2, PRESET-AUDIO-3, SHARED, UNENCRYPTED
          preset_speke_20_video: "PRESET-VIDEO-1", # required, accepts PRESET-VIDEO-1, PRESET-VIDEO-2, PRESET-VIDEO-3, PRESET-VIDEO-4, PRESET-VIDEO-5, PRESET-VIDEO-6, PRESET-VIDEO-7, PRESET-VIDEO-8, SHARED, UNENCRYPTED
        },
        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.constant_initialization_vector #=> String
resp.cmaf_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_audio #=> String, one of "PRESET-AUDIO-1", "PRESET-AUDIO-2", "PRESET-AUDIO-3", "SHARED", "UNENCRYPTED"
resp.cmaf_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_video #=> String, one of "PRESET-VIDEO-1", "PRESET-VIDEO-2", "PRESET-VIDEO-3", "PRESET-VIDEO-4", "PRESET-VIDEO-5", "PRESET-VIDEO-6", "PRESET-VIDEO-7", "PRESET-VIDEO-8", "SHARED", "UNENCRYPTED"
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 #=> Boolean
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 #=> Boolean
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.include_encoder_configuration_in_segments #=> Boolean
resp.cmaf_package.segment_duration_seconds #=> Integer
resp.created_at #=> String
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].scte_markers_source #=> String, one of "SEGMENTS", "MANIFEST"
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.encryption_contract_configuration.preset_speke_20_audio #=> String, one of "PRESET-AUDIO-1", "PRESET-AUDIO-2", "PRESET-AUDIO-3", "SHARED", "UNENCRYPTED"
resp.dash_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_video #=> String, one of "PRESET-VIDEO-1", "PRESET-VIDEO-2", "PRESET-VIDEO-3", "PRESET-VIDEO-4", "PRESET-VIDEO-5", "PRESET-VIDEO-6", "PRESET-VIDEO-7", "PRESET-VIDEO-8", "SHARED", "UNENCRYPTED"
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.include_encoder_configuration_in_segments #=> Boolean
resp.dash_package.include_iframe_only_stream #=> Boolean
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.encryption_contract_configuration.preset_speke_20_audio #=> String, one of "PRESET-AUDIO-1", "PRESET-AUDIO-2", "PRESET-AUDIO-3", "SHARED", "UNENCRYPTED"
resp.hls_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_video #=> String, one of "PRESET-VIDEO-1", "PRESET-VIDEO-2", "PRESET-VIDEO-3", "PRESET-VIDEO-4", "PRESET-VIDEO-5", "PRESET-VIDEO-6", "PRESET-VIDEO-7", "PRESET-VIDEO-8", "SHARED", "UNENCRYPTED"
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 #=> Boolean
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 #=> Boolean
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.include_dvb_subtitles #=> Boolean
resp.hls_package.segment_duration_seconds #=> Integer
resp.hls_package.use_audio_rendition_group #=> Boolean
resp.id #=> String
resp.mss_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_audio #=> String, one of "PRESET-AUDIO-1", "PRESET-AUDIO-2", "PRESET-AUDIO-3", "SHARED", "UNENCRYPTED"
resp.mss_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_video #=> String, one of "PRESET-VIDEO-1", "PRESET-VIDEO-2", "PRESET-VIDEO-3", "PRESET-VIDEO-4", "PRESET-VIDEO-5", "PRESET-VIDEO-6", "PRESET-VIDEO-7", "PRESET-VIDEO-8", "SHARED", "UNENCRYPTED"
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

Parameters:

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

    ({})

Options Hash (params):

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



831
832
833
834
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 831

def create_packaging_configuration(params = {}, options = {})
  req = build_request(:create_packaging_configuration, params)
  req.send_request(options)
end

#create_packaging_group(params = {}) ⇒ 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
  },
  egress_access_logs: {
    log_group_name: "__string",
  },
  id: "__string", # required
  tags: {
    "__string" => "__string",
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :authorization (Types::Authorization) —

    CDN Authorization credentials

  • :egress_access_logs (Types::EgressAccessLogs) —

    Configure egress access logging.

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

    A collection of tags associated with a resource

Returns:

See Also:



891
892
893
894
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 891

def create_packaging_group(params = {}, options = {})
  req = build_request(:create_packaging_group, params)
  req.send_request(options)
end

#delete_asset(params = {}) ⇒ Struct

Deletes an existing MediaPackage VOD Asset resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



912
913
914
915
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 912

def delete_asset(params = {}, options = {})
  req = build_request(:delete_asset, params)
  req.send_request(options)
end

#delete_packaging_configuration(params = {}) ⇒ Struct

Deletes a MediaPackage VOD PackagingConfiguration resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



933
934
935
936
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 933

def delete_packaging_configuration(params = {}, options = {})
  req = build_request(:delete_packaging_configuration, params)
  req.send_request(options)
end

#delete_packaging_group(params = {}) ⇒ Struct

Deletes a MediaPackage VOD PackagingGroup resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



954
955
956
957
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 954

def delete_packaging_group(params = {}, options = {})
  req = build_request(:delete_packaging_group, params)
  req.send_request(options)
end

#describe_asset(params = {}) ⇒ 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].status #=> 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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

Returns:

See Also:



1001
1002
1003
1004
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 1001

def describe_asset(params = {}, options = {})
  req = build_request(:describe_asset, params)
  req.send_request(options)
end

#describe_packaging_configuration(params = {}) ⇒ 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.constant_initialization_vector #=> String
resp.cmaf_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_audio #=> String, one of "PRESET-AUDIO-1", "PRESET-AUDIO-2", "PRESET-AUDIO-3", "SHARED", "UNENCRYPTED"
resp.cmaf_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_video #=> String, one of "PRESET-VIDEO-1", "PRESET-VIDEO-2", "PRESET-VIDEO-3", "PRESET-VIDEO-4", "PRESET-VIDEO-5", "PRESET-VIDEO-6", "PRESET-VIDEO-7", "PRESET-VIDEO-8", "SHARED", "UNENCRYPTED"
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 #=> Boolean
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 #=> Boolean
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.include_encoder_configuration_in_segments #=> Boolean
resp.cmaf_package.segment_duration_seconds #=> Integer
resp.created_at #=> String
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].scte_markers_source #=> String, one of "SEGMENTS", "MANIFEST"
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.encryption_contract_configuration.preset_speke_20_audio #=> String, one of "PRESET-AUDIO-1", "PRESET-AUDIO-2", "PRESET-AUDIO-3", "SHARED", "UNENCRYPTED"
resp.dash_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_video #=> String, one of "PRESET-VIDEO-1", "PRESET-VIDEO-2", "PRESET-VIDEO-3", "PRESET-VIDEO-4", "PRESET-VIDEO-5", "PRESET-VIDEO-6", "PRESET-VIDEO-7", "PRESET-VIDEO-8", "SHARED", "UNENCRYPTED"
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.include_encoder_configuration_in_segments #=> Boolean
resp.dash_package.include_iframe_only_stream #=> Boolean
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.encryption_contract_configuration.preset_speke_20_audio #=> String, one of "PRESET-AUDIO-1", "PRESET-AUDIO-2", "PRESET-AUDIO-3", "SHARED", "UNENCRYPTED"
resp.hls_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_video #=> String, one of "PRESET-VIDEO-1", "PRESET-VIDEO-2", "PRESET-VIDEO-3", "PRESET-VIDEO-4", "PRESET-VIDEO-5", "PRESET-VIDEO-6", "PRESET-VIDEO-7", "PRESET-VIDEO-8", "SHARED", "UNENCRYPTED"
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 #=> Boolean
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 #=> Boolean
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.include_dvb_subtitles #=> Boolean
resp.hls_package.segment_duration_seconds #=> Integer
resp.hls_package.use_audio_rendition_group #=> Boolean
resp.id #=> String
resp.mss_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_audio #=> String, one of "PRESET-AUDIO-1", "PRESET-AUDIO-2", "PRESET-AUDIO-3", "SHARED", "UNENCRYPTED"
resp.mss_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_video #=> String, one of "PRESET-VIDEO-1", "PRESET-VIDEO-2", "PRESET-VIDEO-3", "PRESET-VIDEO-4", "PRESET-VIDEO-5", "PRESET-VIDEO-6", "PRESET-VIDEO-7", "PRESET-VIDEO-8", "SHARED", "UNENCRYPTED"
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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

Returns:

See Also:



1113
1114
1115
1116
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 1113

def describe_packaging_configuration(params = {}, options = {})
  req = build_request(:describe_packaging_configuration, params)
  req.send_request(options)
end

#describe_packaging_group(params = {}) ⇒ 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.approximate_asset_count #=> Integer
resp.arn #=> String
resp.authorization.cdn_identifier_secret #=> String
resp.authorization.secrets_role_arn #=> String
resp.created_at #=> String
resp.domain_name #=> String
resp.egress_access_logs.log_group_name #=> String
resp.id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

Returns:

See Also:



1156
1157
1158
1159
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 1156

def describe_packaging_group(params = {}, options = {})
  req = build_request(:describe_packaging_group, params)
  req.send_request(options)
end

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

Returns a collection of MediaPackage VOD Asset resources.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



1202
1203
1204
1205
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 1202

def list_assets(params = {}, options = {})
  req = build_request(:list_assets, params)
  req.send_request(options)
end

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

Returns a collection of MediaPackage VOD PackagingConfiguration resources.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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.constant_initialization_vector #=> String
resp.packaging_configurations[0].cmaf_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_audio #=> String, one of "PRESET-AUDIO-1", "PRESET-AUDIO-2", "PRESET-AUDIO-3", "SHARED", "UNENCRYPTED"
resp.packaging_configurations[0].cmaf_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_video #=> String, one of "PRESET-VIDEO-1", "PRESET-VIDEO-2", "PRESET-VIDEO-3", "PRESET-VIDEO-4", "PRESET-VIDEO-5", "PRESET-VIDEO-6", "PRESET-VIDEO-7", "PRESET-VIDEO-8", "SHARED", "UNENCRYPTED"
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 #=> Boolean
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 #=> Boolean
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.include_encoder_configuration_in_segments #=> Boolean
resp.packaging_configurations[0].cmaf_package.segment_duration_seconds #=> Integer
resp.packaging_configurations[0].created_at #=> String
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].scte_markers_source #=> String, one of "SEGMENTS", "MANIFEST"
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.encryption_contract_configuration.preset_speke_20_audio #=> String, one of "PRESET-AUDIO-1", "PRESET-AUDIO-2", "PRESET-AUDIO-3", "SHARED", "UNENCRYPTED"
resp.packaging_configurations[0].dash_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_video #=> String, one of "PRESET-VIDEO-1", "PRESET-VIDEO-2", "PRESET-VIDEO-3", "PRESET-VIDEO-4", "PRESET-VIDEO-5", "PRESET-VIDEO-6", "PRESET-VIDEO-7", "PRESET-VIDEO-8", "SHARED", "UNENCRYPTED"
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.include_encoder_configuration_in_segments #=> Boolean
resp.packaging_configurations[0].dash_package.include_iframe_only_stream #=> Boolean
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.encryption_contract_configuration.preset_speke_20_audio #=> String, one of "PRESET-AUDIO-1", "PRESET-AUDIO-2", "PRESET-AUDIO-3", "SHARED", "UNENCRYPTED"
resp.packaging_configurations[0].hls_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_video #=> String, one of "PRESET-VIDEO-1", "PRESET-VIDEO-2", "PRESET-VIDEO-3", "PRESET-VIDEO-4", "PRESET-VIDEO-5", "PRESET-VIDEO-6", "PRESET-VIDEO-7", "PRESET-VIDEO-8", "SHARED", "UNENCRYPTED"
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 #=> Boolean
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 #=> Boolean
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.include_dvb_subtitles #=> Boolean
resp.packaging_configurations[0].hls_package.segment_duration_seconds #=> Integer
resp.packaging_configurations[0].hls_package.use_audio_rendition_group #=> Boolean
resp.packaging_configurations[0].id #=> String
resp.packaging_configurations[0].mss_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_audio #=> String, one of "PRESET-AUDIO-1", "PRESET-AUDIO-2", "PRESET-AUDIO-3", "SHARED", "UNENCRYPTED"
resp.packaging_configurations[0].mss_package.encryption.speke_key_provider.encryption_contract_configuration.preset_speke_20_video #=> String, one of "PRESET-VIDEO-1", "PRESET-VIDEO-2", "PRESET-VIDEO-3", "PRESET-VIDEO-4", "PRESET-VIDEO-5", "PRESET-VIDEO-6", "PRESET-VIDEO-7", "PRESET-VIDEO-8", "SHARED", "UNENCRYPTED"
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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



1317
1318
1319
1320
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 1317

def list_packaging_configurations(params = {}, options = {})
  req = build_request(:list_packaging_configurations, params)
  req.send_request(options)
end

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

Returns a collection of MediaPackage VOD PackagingGroup resources.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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].approximate_asset_count #=> Integer
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].created_at #=> String
resp.packaging_groups[0].domain_name #=> String
resp.packaging_groups[0].egress_access_logs.log_group_name #=> String
resp.packaging_groups[0].id #=> String
resp.packaging_groups[0].tags #=> Hash
resp.packaging_groups[0].tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



1361
1362
1363
1364
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 1361

def list_packaging_groups(params = {}, options = {})
  req = build_request(:list_packaging_groups, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

Returns:

See Also:



1389
1390
1391
1392
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 1389

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ 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",
  },
})

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1416
1417
1418
1419
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 1416

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1441
1442
1443
1444
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 1441

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_packaging_group(params = {}) ⇒ 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.approximate_asset_count #=> Integer
resp.arn #=> String
resp.authorization.cdn_identifier_secret #=> String
resp.authorization.secrets_role_arn #=> String
resp.created_at #=> String
resp.domain_name #=> String
resp.egress_access_logs.log_group_name #=> String
resp.id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1492
1493
1494
1495
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 1492

def update_packaging_group(params = {}, options = {})
  req = build_request(:update_packaging_group, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1521
1522
1523
 
# File 'lib/aws-sdk-mediapackagevod/client.rb', line 1521

def waiter_names
  []
end