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

Class: Aws::MediaPackage::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



153
154
155
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 153

def initialize(*args)
  super
end

Instance Method Details

#create_channel(params = {}) ⇒ Types::CreateChannelResponse

Creates a new Channel.

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.description #=> String
resp.hls_ingest.ingest_endpoints #=> Array
resp.hls_ingest.ingest_endpoints[0].password #=> String
resp.hls_ingest.ingest_endpoints[0].url #=> String
resp.hls_ingest.ingest_endpoints[0].username #=> String
resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :description (String)
  • :id (required, String)

Returns:

See Also:



193
194
195
196
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 193

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

#create_origin_endpoint(params = {}) ⇒ Types::CreateOriginEndpointResponse

Creates a new OriginEndpoint record.

Examples:

Request syntax with placeholder values


resp = client.create_origin_endpoint({
  channel_id: "__string", # required
  cmaf_package: {
    encryption: {
      key_rotation_interval_seconds: 1,
      speke_key_provider: { # required
        resource_id: "__string", # required
        role_arn: "__string", # required
        system_ids: ["__string"], # required
        url: "__string", # required
      },
    },
    hls_manifests: [
      {
        ad_markers: "NONE", # accepts NONE, SCTE35_ENHANCED, PASSTHROUGH
        id: "__string", # required
        include_iframe_only_stream: false,
        manifest_name: "__string",
        playlist_type: "NONE", # accepts NONE, EVENT, VOD
        playlist_window_seconds: 1,
        program_date_time_interval_seconds: 1,
      },
    ],
    segment_duration_seconds: 1,
    segment_prefix: "__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
    },
  },
  dash_package: {
    encryption: {
      key_rotation_interval_seconds: 1,
      speke_key_provider: { # required
        resource_id: "__string", # required
        role_arn: "__string", # required
        system_ids: ["__string"], # required
        url: "__string", # required
      },
    },
    manifest_window_seconds: 1,
    min_buffer_time_seconds: 1,
    min_update_period_seconds: 1,
    profile: "NONE", # accepts NONE, HBBTV_1_5
    segment_duration_seconds: 1,
    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
    },
    suggested_presentation_delay_seconds: 1,
  },
  description: "__string",
  hls_package: {
    ad_markers: "NONE", # accepts NONE, SCTE35_ENHANCED, PASSTHROUGH
    encryption: {
      constant_initialization_vector: "__string",
      encryption_method: "AES_128", # accepts AES_128, SAMPLE_AES
      key_rotation_interval_seconds: 1,
      repeat_ext_x_key: false,
      speke_key_provider: { # required
        resource_id: "__string", # required
        role_arn: "__string", # required
        system_ids: ["__string"], # required
        url: "__string", # required
      },
    },
    include_iframe_only_stream: false,
    playlist_type: "NONE", # accepts NONE, EVENT, VOD
    playlist_window_seconds: 1,
    program_date_time_interval_seconds: 1,
    segment_duration_seconds: 1,
    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
    },
    use_audio_rendition_group: false,
  },
  id: "__string", # required
  manifest_name: "__string",
  mss_package: {
    encryption: {
      speke_key_provider: { # required
        resource_id: "__string", # required
        role_arn: "__string", # required
        system_ids: ["__string"], # required
        url: "__string", # required
      },
    },
    manifest_window_seconds: 1,
    segment_duration_seconds: 1,
    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
    },
  },
  startover_window_seconds: 1,
  time_delay_seconds: 1,
  whitelist: ["__string"],
})

Response structure


resp.arn #=> String
resp.channel_id #=> String
resp.cmaf_package.encryption.key_rotation_interval_seconds #=> Integer
resp.cmaf_package.encryption.speke_key_provider.resource_id #=> 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].id #=> String
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].playlist_type #=> String, one of "NONE", "EVENT", "VOD"
resp.cmaf_package.hls_manifests[0].playlist_window_seconds #=> Integer
resp.cmaf_package.hls_manifests[0].program_date_time_interval_seconds #=> Integer
resp.cmaf_package.hls_manifests[0].url #=> String
resp.cmaf_package.segment_duration_seconds #=> Integer
resp.cmaf_package.segment_prefix #=> String
resp.cmaf_package.stream_selection.max_video_bits_per_second #=> Integer
resp.cmaf_package.stream_selection.min_video_bits_per_second #=> Integer
resp.cmaf_package.stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.dash_package.encryption.key_rotation_interval_seconds #=> Integer
resp.dash_package.encryption.speke_key_provider.resource_id #=> String
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.manifest_window_seconds #=> Integer
resp.dash_package.min_buffer_time_seconds #=> Integer
resp.dash_package.min_update_period_seconds #=> Integer
resp.dash_package.profile #=> String, one of "NONE", "HBBTV_1_5"
resp.dash_package.segment_duration_seconds #=> Integer
resp.dash_package.stream_selection.max_video_bits_per_second #=> Integer
resp.dash_package.stream_selection.min_video_bits_per_second #=> Integer
resp.dash_package.stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.dash_package.suggested_presentation_delay_seconds #=> Integer
resp.description #=> String
resp.hls_package.ad_markers #=> String, one of "NONE", "SCTE35_ENHANCED", "PASSTHROUGH"
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.key_rotation_interval_seconds #=> Integer
resp.hls_package.encryption.repeat_ext_x_key #=> Boolean
resp.hls_package.encryption.speke_key_provider.resource_id #=> String
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.include_iframe_only_stream #=> Boolean
resp.hls_package.playlist_type #=> String, one of "NONE", "EVENT", "VOD"
resp.hls_package.playlist_window_seconds #=> Integer
resp.hls_package.program_date_time_interval_seconds #=> Integer
resp.hls_package.segment_duration_seconds #=> Integer
resp.hls_package.stream_selection.max_video_bits_per_second #=> Integer
resp.hls_package.stream_selection.min_video_bits_per_second #=> Integer
resp.hls_package.stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.hls_package.use_audio_rendition_group #=> Boolean
resp.id #=> String
resp.manifest_name #=> String
resp.mss_package.encryption.speke_key_provider.resource_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.manifest_window_seconds #=> Integer
resp.mss_package.segment_duration_seconds #=> Integer
resp.mss_package.stream_selection.max_video_bits_per_second #=> Integer
resp.mss_package.stream_selection.min_video_bits_per_second #=> Integer
resp.mss_package.stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.startover_window_seconds #=> Integer
resp.time_delay_seconds #=> Integer
resp.url #=> String
resp.whitelist #=> Array
resp.whitelist[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_id (required, String)
  • :cmaf_package (Types::CmafPackageCreateOrUpdateParameters)

    A Common Media Application Format (CMAF) packaging configuration.

  • :dash_package (Types::DashPackage)

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

  • :description (String)
  • :hls_package (Types::HlsPackage)

    An HTTP Live Streaming (HLS) packaging configuration.

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

    A Microsoft Smooth Streaming (MSS) packaging configuration.

  • :startover_window_seconds (Integer)
  • :time_delay_seconds (Integer)
  • :whitelist (Array<String>)

Returns:

See Also:



429
430
431
432
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 429

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

#delete_channel(params = {}) ⇒ Struct

Deletes an existing Channel.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



450
451
452
453
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 450

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

#delete_origin_endpoint(params = {}) ⇒ Struct

Deletes an existing OriginEndpoint.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



471
472
473
474
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 471

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

#describe_channel(params = {}) ⇒ Types::DescribeChannelResponse

Gets details about a Channel.

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.description #=> String
resp.hls_ingest.ingest_endpoints #=> Array
resp.hls_ingest.ingest_endpoints[0].password #=> String
resp.hls_ingest.ingest_endpoints[0].url #=> String
resp.hls_ingest.ingest_endpoints[0].username #=> String
resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

Returns:

See Also:



507
508
509
510
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 507

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

#describe_origin_endpoint(params = {}) ⇒ Types::DescribeOriginEndpointResponse

Gets details about an existing OriginEndpoint.

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.channel_id #=> String
resp.cmaf_package.encryption.key_rotation_interval_seconds #=> Integer
resp.cmaf_package.encryption.speke_key_provider.resource_id #=> 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].id #=> String
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].playlist_type #=> String, one of "NONE", "EVENT", "VOD"
resp.cmaf_package.hls_manifests[0].playlist_window_seconds #=> Integer
resp.cmaf_package.hls_manifests[0].program_date_time_interval_seconds #=> Integer
resp.cmaf_package.hls_manifests[0].url #=> String
resp.cmaf_package.segment_duration_seconds #=> Integer
resp.cmaf_package.segment_prefix #=> String
resp.cmaf_package.stream_selection.max_video_bits_per_second #=> Integer
resp.cmaf_package.stream_selection.min_video_bits_per_second #=> Integer
resp.cmaf_package.stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.dash_package.encryption.key_rotation_interval_seconds #=> Integer
resp.dash_package.encryption.speke_key_provider.resource_id #=> String
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.manifest_window_seconds #=> Integer
resp.dash_package.min_buffer_time_seconds #=> Integer
resp.dash_package.min_update_period_seconds #=> Integer
resp.dash_package.profile #=> String, one of "NONE", "HBBTV_1_5"
resp.dash_package.segment_duration_seconds #=> Integer
resp.dash_package.stream_selection.max_video_bits_per_second #=> Integer
resp.dash_package.stream_selection.min_video_bits_per_second #=> Integer
resp.dash_package.stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.dash_package.suggested_presentation_delay_seconds #=> Integer
resp.description #=> String
resp.hls_package.ad_markers #=> String, one of "NONE", "SCTE35_ENHANCED", "PASSTHROUGH"
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.key_rotation_interval_seconds #=> Integer
resp.hls_package.encryption.repeat_ext_x_key #=> Boolean
resp.hls_package.encryption.speke_key_provider.resource_id #=> String
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.include_iframe_only_stream #=> Boolean
resp.hls_package.playlist_type #=> String, one of "NONE", "EVENT", "VOD"
resp.hls_package.playlist_window_seconds #=> Integer
resp.hls_package.program_date_time_interval_seconds #=> Integer
resp.hls_package.segment_duration_seconds #=> Integer
resp.hls_package.stream_selection.max_video_bits_per_second #=> Integer
resp.hls_package.stream_selection.min_video_bits_per_second #=> Integer
resp.hls_package.stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.hls_package.use_audio_rendition_group #=> Boolean
resp.id #=> String
resp.manifest_name #=> String
resp.mss_package.encryption.speke_key_provider.resource_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.manifest_window_seconds #=> Integer
resp.mss_package.segment_duration_seconds #=> Integer
resp.mss_package.stream_selection.max_video_bits_per_second #=> Integer
resp.mss_package.stream_selection.min_video_bits_per_second #=> Integer
resp.mss_package.stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.startover_window_seconds #=> Integer
resp.time_delay_seconds #=> Integer
resp.url #=> String
resp.whitelist #=> Array
resp.whitelist[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

Returns:

See Also:



619
620
621
622
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 619

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

#list_channels(params = {}) ⇒ Types::ListChannelsResponse

Returns a collection of Channels.

Examples:

Request syntax with placeholder values


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

Response structure


resp.channels #=> Array
resp.channels[0].arn #=> String
resp.channels[0].description #=> String
resp.channels[0].hls_ingest.ingest_endpoints #=> Array
resp.channels[0].hls_ingest.ingest_endpoints[0].password #=> String
resp.channels[0].hls_ingest.ingest_endpoints[0].url #=> String
resp.channels[0].hls_ingest.ingest_endpoints[0].username #=> String
resp.channels[0].id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



658
659
660
661
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 658

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

#list_origin_endpoints(params = {}) ⇒ Types::ListOriginEndpointsResponse

Returns a collection of OriginEndpoint records.

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.origin_endpoints #=> Array
resp.origin_endpoints[0].arn #=> String
resp.origin_endpoints[0].channel_id #=> String
resp.origin_endpoints[0].cmaf_package.encryption.key_rotation_interval_seconds #=> Integer
resp.origin_endpoints[0].cmaf_package.encryption.speke_key_provider.resource_id #=> String
resp.origin_endpoints[0].cmaf_package.encryption.speke_key_provider.role_arn #=> String
resp.origin_endpoints[0].cmaf_package.encryption.speke_key_provider.system_ids #=> Array
resp.origin_endpoints[0].cmaf_package.encryption.speke_key_provider.system_ids[0] #=> String
resp.origin_endpoints[0].cmaf_package.encryption.speke_key_provider.url #=> String
resp.origin_endpoints[0].cmaf_package.hls_manifests #=> Array
resp.origin_endpoints[0].cmaf_package.hls_manifests[0].ad_markers #=> String, one of "NONE", "SCTE35_ENHANCED", "PASSTHROUGH"
resp.origin_endpoints[0].cmaf_package.hls_manifests[0].id #=> String
resp.origin_endpoints[0].cmaf_package.hls_manifests[0].include_iframe_only_stream #=> Boolean
resp.origin_endpoints[0].cmaf_package.hls_manifests[0].manifest_name #=> String
resp.origin_endpoints[0].cmaf_package.hls_manifests[0].playlist_type #=> String, one of "NONE", "EVENT", "VOD"
resp.origin_endpoints[0].cmaf_package.hls_manifests[0].playlist_window_seconds #=> Integer
resp.origin_endpoints[0].cmaf_package.hls_manifests[0].program_date_time_interval_seconds #=> Integer
resp.origin_endpoints[0].cmaf_package.hls_manifests[0].url #=> String
resp.origin_endpoints[0].cmaf_package.segment_duration_seconds #=> Integer
resp.origin_endpoints[0].cmaf_package.segment_prefix #=> String
resp.origin_endpoints[0].cmaf_package.stream_selection.max_video_bits_per_second #=> Integer
resp.origin_endpoints[0].cmaf_package.stream_selection.min_video_bits_per_second #=> Integer
resp.origin_endpoints[0].cmaf_package.stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.origin_endpoints[0].dash_package.encryption.key_rotation_interval_seconds #=> Integer
resp.origin_endpoints[0].dash_package.encryption.speke_key_provider.resource_id #=> String
resp.origin_endpoints[0].dash_package.encryption.speke_key_provider.role_arn #=> String
resp.origin_endpoints[0].dash_package.encryption.speke_key_provider.system_ids #=> Array
resp.origin_endpoints[0].dash_package.encryption.speke_key_provider.system_ids[0] #=> String
resp.origin_endpoints[0].dash_package.encryption.speke_key_provider.url #=> String
resp.origin_endpoints[0].dash_package.manifest_window_seconds #=> Integer
resp.origin_endpoints[0].dash_package.min_buffer_time_seconds #=> Integer
resp.origin_endpoints[0].dash_package.min_update_period_seconds #=> Integer
resp.origin_endpoints[0].dash_package.profile #=> String, one of "NONE", "HBBTV_1_5"
resp.origin_endpoints[0].dash_package.segment_duration_seconds #=> Integer
resp.origin_endpoints[0].dash_package.stream_selection.max_video_bits_per_second #=> Integer
resp.origin_endpoints[0].dash_package.stream_selection.min_video_bits_per_second #=> Integer
resp.origin_endpoints[0].dash_package.stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.origin_endpoints[0].dash_package.suggested_presentation_delay_seconds #=> Integer
resp.origin_endpoints[0].description #=> String
resp.origin_endpoints[0].hls_package.ad_markers #=> String, one of "NONE", "SCTE35_ENHANCED", "PASSTHROUGH"
resp.origin_endpoints[0].hls_package.encryption.constant_initialization_vector #=> String
resp.origin_endpoints[0].hls_package.encryption.encryption_method #=> String, one of "AES_128", "SAMPLE_AES"
resp.origin_endpoints[0].hls_package.encryption.key_rotation_interval_seconds #=> Integer
resp.origin_endpoints[0].hls_package.encryption.repeat_ext_x_key #=> Boolean
resp.origin_endpoints[0].hls_package.encryption.speke_key_provider.resource_id #=> String
resp.origin_endpoints[0].hls_package.encryption.speke_key_provider.role_arn #=> String
resp.origin_endpoints[0].hls_package.encryption.speke_key_provider.system_ids #=> Array
resp.origin_endpoints[0].hls_package.encryption.speke_key_provider.system_ids[0] #=> String
resp.origin_endpoints[0].hls_package.encryption.speke_key_provider.url #=> String
resp.origin_endpoints[0].hls_package.include_iframe_only_stream #=> Boolean
resp.origin_endpoints[0].hls_package.playlist_type #=> String, one of "NONE", "EVENT", "VOD"
resp.origin_endpoints[0].hls_package.playlist_window_seconds #=> Integer
resp.origin_endpoints[0].hls_package.program_date_time_interval_seconds #=> Integer
resp.origin_endpoints[0].hls_package.segment_duration_seconds #=> Integer
resp.origin_endpoints[0].hls_package.stream_selection.max_video_bits_per_second #=> Integer
resp.origin_endpoints[0].hls_package.stream_selection.min_video_bits_per_second #=> Integer
resp.origin_endpoints[0].hls_package.stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.origin_endpoints[0].hls_package.use_audio_rendition_group #=> Boolean
resp.origin_endpoints[0].id #=> String
resp.origin_endpoints[0].manifest_name #=> String
resp.origin_endpoints[0].mss_package.encryption.speke_key_provider.resource_id #=> String
resp.origin_endpoints[0].mss_package.encryption.speke_key_provider.role_arn #=> String
resp.origin_endpoints[0].mss_package.encryption.speke_key_provider.system_ids #=> Array
resp.origin_endpoints[0].mss_package.encryption.speke_key_provider.system_ids[0] #=> String
resp.origin_endpoints[0].mss_package.encryption.speke_key_provider.url #=> String
resp.origin_endpoints[0].mss_package.manifest_window_seconds #=> Integer
resp.origin_endpoints[0].mss_package.segment_duration_seconds #=> Integer
resp.origin_endpoints[0].mss_package.stream_selection.max_video_bits_per_second #=> Integer
resp.origin_endpoints[0].mss_package.stream_selection.min_video_bits_per_second #=> Integer
resp.origin_endpoints[0].mss_package.stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.origin_endpoints[0].startover_window_seconds #=> Integer
resp.origin_endpoints[0].time_delay_seconds #=> Integer
resp.origin_endpoints[0].url #=> String
resp.origin_endpoints[0].whitelist #=> Array
resp.origin_endpoints[0].whitelist[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



767
768
769
770
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 767

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

#rotate_channel_credentials(params = {}) ⇒ Types::RotateChannelCredentialsResponse

Changes the Channel ingest username and password.

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.description #=> String
resp.hls_ingest.ingest_endpoints #=> Array
resp.hls_ingest.ingest_endpoints[0].password #=> String
resp.hls_ingest.ingest_endpoints[0].url #=> String
resp.hls_ingest.ingest_endpoints[0].username #=> String
resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

Returns:

See Also:



803
804
805
806
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 803

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

#update_channel(params = {}) ⇒ Types::UpdateChannelResponse

Updates an existing Channel.

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.description #=> String
resp.hls_ingest.ingest_endpoints #=> Array
resp.hls_ingest.ingest_endpoints[0].password #=> String
resp.hls_ingest.ingest_endpoints[0].url #=> String
resp.hls_ingest.ingest_endpoints[0].username #=> String
resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :description (String)
  • :id (required, String)

Returns:

See Also:



842
843
844
845
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 842

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

#update_origin_endpoint(params = {}) ⇒ Types::UpdateOriginEndpointResponse

Updates an existing OriginEndpoint.

Examples:

Request syntax with placeholder values


resp = client.update_origin_endpoint({
  cmaf_package: {
    encryption: {
      key_rotation_interval_seconds: 1,
      speke_key_provider: { # required
        resource_id: "__string", # required
        role_arn: "__string", # required
        system_ids: ["__string"], # required
        url: "__string", # required
      },
    },
    hls_manifests: [
      {
        ad_markers: "NONE", # accepts NONE, SCTE35_ENHANCED, PASSTHROUGH
        id: "__string", # required
        include_iframe_only_stream: false,
        manifest_name: "__string",
        playlist_type: "NONE", # accepts NONE, EVENT, VOD
        playlist_window_seconds: 1,
        program_date_time_interval_seconds: 1,
      },
    ],
    segment_duration_seconds: 1,
    segment_prefix: "__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
    },
  },
  dash_package: {
    encryption: {
      key_rotation_interval_seconds: 1,
      speke_key_provider: { # required
        resource_id: "__string", # required
        role_arn: "__string", # required
        system_ids: ["__string"], # required
        url: "__string", # required
      },
    },
    manifest_window_seconds: 1,
    min_buffer_time_seconds: 1,
    min_update_period_seconds: 1,
    profile: "NONE", # accepts NONE, HBBTV_1_5
    segment_duration_seconds: 1,
    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
    },
    suggested_presentation_delay_seconds: 1,
  },
  description: "__string",
  hls_package: {
    ad_markers: "NONE", # accepts NONE, SCTE35_ENHANCED, PASSTHROUGH
    encryption: {
      constant_initialization_vector: "__string",
      encryption_method: "AES_128", # accepts AES_128, SAMPLE_AES
      key_rotation_interval_seconds: 1,
      repeat_ext_x_key: false,
      speke_key_provider: { # required
        resource_id: "__string", # required
        role_arn: "__string", # required
        system_ids: ["__string"], # required
        url: "__string", # required
      },
    },
    include_iframe_only_stream: false,
    playlist_type: "NONE", # accepts NONE, EVENT, VOD
    playlist_window_seconds: 1,
    program_date_time_interval_seconds: 1,
    segment_duration_seconds: 1,
    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
    },
    use_audio_rendition_group: false,
  },
  id: "__string", # required
  manifest_name: "__string",
  mss_package: {
    encryption: {
      speke_key_provider: { # required
        resource_id: "__string", # required
        role_arn: "__string", # required
        system_ids: ["__string"], # required
        url: "__string", # required
      },
    },
    manifest_window_seconds: 1,
    segment_duration_seconds: 1,
    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
    },
  },
  startover_window_seconds: 1,
  time_delay_seconds: 1,
  whitelist: ["__string"],
})

Response structure


resp.arn #=> String
resp.channel_id #=> String
resp.cmaf_package.encryption.key_rotation_interval_seconds #=> Integer
resp.cmaf_package.encryption.speke_key_provider.resource_id #=> 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].id #=> String
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].playlist_type #=> String, one of "NONE", "EVENT", "VOD"
resp.cmaf_package.hls_manifests[0].playlist_window_seconds #=> Integer
resp.cmaf_package.hls_manifests[0].program_date_time_interval_seconds #=> Integer
resp.cmaf_package.hls_manifests[0].url #=> String
resp.cmaf_package.segment_duration_seconds #=> Integer
resp.cmaf_package.segment_prefix #=> String
resp.cmaf_package.stream_selection.max_video_bits_per_second #=> Integer
resp.cmaf_package.stream_selection.min_video_bits_per_second #=> Integer
resp.cmaf_package.stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.dash_package.encryption.key_rotation_interval_seconds #=> Integer
resp.dash_package.encryption.speke_key_provider.resource_id #=> String
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.manifest_window_seconds #=> Integer
resp.dash_package.min_buffer_time_seconds #=> Integer
resp.dash_package.min_update_period_seconds #=> Integer
resp.dash_package.profile #=> String, one of "NONE", "HBBTV_1_5"
resp.dash_package.segment_duration_seconds #=> Integer
resp.dash_package.stream_selection.max_video_bits_per_second #=> Integer
resp.dash_package.stream_selection.min_video_bits_per_second #=> Integer
resp.dash_package.stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.dash_package.suggested_presentation_delay_seconds #=> Integer
resp.description #=> String
resp.hls_package.ad_markers #=> String, one of "NONE", "SCTE35_ENHANCED", "PASSTHROUGH"
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.key_rotation_interval_seconds #=> Integer
resp.hls_package.encryption.repeat_ext_x_key #=> Boolean
resp.hls_package.encryption.speke_key_provider.resource_id #=> String
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.include_iframe_only_stream #=> Boolean
resp.hls_package.playlist_type #=> String, one of "NONE", "EVENT", "VOD"
resp.hls_package.playlist_window_seconds #=> Integer
resp.hls_package.program_date_time_interval_seconds #=> Integer
resp.hls_package.segment_duration_seconds #=> Integer
resp.hls_package.stream_selection.max_video_bits_per_second #=> Integer
resp.hls_package.stream_selection.min_video_bits_per_second #=> Integer
resp.hls_package.stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.hls_package.use_audio_rendition_group #=> Boolean
resp.id #=> String
resp.manifest_name #=> String
resp.mss_package.encryption.speke_key_provider.resource_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.manifest_window_seconds #=> Integer
resp.mss_package.segment_duration_seconds #=> Integer
resp.mss_package.stream_selection.max_video_bits_per_second #=> Integer
resp.mss_package.stream_selection.min_video_bits_per_second #=> Integer
resp.mss_package.stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING"
resp.startover_window_seconds #=> Integer
resp.time_delay_seconds #=> Integer
resp.url #=> String
resp.whitelist #=> Array
resp.whitelist[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cmaf_package (Types::CmafPackageCreateOrUpdateParameters)

    A Common Media Application Format (CMAF) packaging configuration.

  • :dash_package (Types::DashPackage)

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

  • :description (String)
  • :hls_package (Types::HlsPackage)

    An HTTP Live Streaming (HLS) packaging configuration.

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

    A Microsoft Smooth Streaming (MSS) packaging configuration.

  • :startover_window_seconds (Integer)
  • :time_delay_seconds (Integer)
  • :whitelist (Array<String>)

Returns:

See Also:



1075
1076
1077
1078
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 1075

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