Class: Aws::MediaPackage::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MediaPackage::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb
Overview
An API client for MediaPackage. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::MediaPackage::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#configure_logs(params = {}) ⇒ Types::ConfigureLogsResponse
Changes the Channel's properities to configure log subscription.
-
#create_channel(params = {}) ⇒ Types::CreateChannelResponse
Creates a new Channel.
-
#create_harvest_job(params = {}) ⇒ Types::CreateHarvestJobResponse
Creates a new HarvestJob record.
-
#create_origin_endpoint(params = {}) ⇒ Types::CreateOriginEndpointResponse
Creates a new OriginEndpoint record.
-
#delete_channel(params = {}) ⇒ Struct
Deletes an existing Channel.
-
#delete_origin_endpoint(params = {}) ⇒ Struct
Deletes an existing OriginEndpoint.
-
#describe_channel(params = {}) ⇒ Types::DescribeChannelResponse
Gets details about a Channel.
-
#describe_harvest_job(params = {}) ⇒ Types::DescribeHarvestJobResponse
Gets details about an existing HarvestJob.
-
#describe_origin_endpoint(params = {}) ⇒ Types::DescribeOriginEndpointResponse
Gets details about an existing OriginEndpoint.
-
#list_channels(params = {}) ⇒ Types::ListChannelsResponse
Returns a collection of Channels.
-
#list_harvest_jobs(params = {}) ⇒ Types::ListHarvestJobsResponse
Returns a collection of HarvestJob records.
-
#list_origin_endpoints(params = {}) ⇒ Types::ListOriginEndpointsResponse
Returns a collection of OriginEndpoint records.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a response object which responds to the following methods:.
-
#rotate_channel_credentials(params = {}) ⇒ Types::RotateChannelCredentialsResponse
Changes the Channel's first IngestEndpoint's username and password.
-
#rotate_ingest_endpoint_credentials(params = {}) ⇒ Types::RotateIngestEndpointCredentialsResponse
Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.
-
#tag_resource(params = {}) ⇒ Struct
Returns an empty response.
-
#untag_resource(params = {}) ⇒ Struct
Returns an empty response.
-
#update_channel(params = {}) ⇒ Types::UpdateChannelResponse
Updates an existing Channel.
-
#update_origin_endpoint(params = {}) ⇒ Types::UpdateOriginEndpointResponse
Updates an existing OriginEndpoint.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #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(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 fromaws 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[:credentials]
- The
:access_key_id
,:secret_access_key
,:session_token
, and:account_id
options. - ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
~/.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
orAws::ECSCredentials
to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] 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:Aws.config[:region]
ENV['AWS_REGION']
ENV['AMAZON_REGION']
ENV['AWS_DEFAULT_REGION']
~/.aws/credentials
~/.aws/config
- :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 tofalse
. -
: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 aRetryCapacityNotAvailableError
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
andadaptive
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_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.
-
: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 https://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 ofstandard
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:Aws.config[:sigv4a_signing_region_set]
ENV['AWS_SIGV4A_SIGNING_REGION_SET']
~/.aws/config
-
: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 aAws::Telemetry::OTelProvider
for telemetry provider.
- OpenTelemetry (OTel) - To use the OTel provider, install and require the
-
: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 fromaws login
.
When
:token_provider
is not configured directly, theAws::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 afips
region is used, the region is normalized and this config is set totrue
. -
:validate_params
(Boolean)
— default:
true
—
When
true
, request parameters are validated before sending the request. -
:endpoint_provider
(Aws::MediaPackage::EndpointProvider)
—
The endpoint provider used to resolve endpoints. Any object that responds to
#resolve_endpoint(parameters)
whereparameters
is a Struct similar toAws::MediaPackage::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 'http://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.
444 445 446 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 444 def initialize(*args) super end |
Instance Method Details
#configure_logs(params = {}) ⇒ Types::ConfigureLogsResponse
Changes the Channel's properities to configure log subscription
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.configure_logs({
egress_access_logs: {
log_group_name: "__string",
},
id: "__string", # required
ingress_access_logs: {
log_group_name: "__string",
},
})
Response structure
Response structure
resp.arn #=> String
resp.created_at #=> String
resp.description #=> String
resp.egress_access_logs.log_group_name #=> String
resp.hls_ingest.ingest_endpoints #=> Array
resp.hls_ingest.ingest_endpoints[0].id #=> String
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
resp.ingress_access_logs.log_group_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:egress_access_logs
(Types::EgressAccessLogs)
—
Configure egress access logging.
- :id (required, String)
-
:ingress_access_logs
(Types::IngressAccessLogs)
—
Configure ingress access logging.
Returns:
-
(Types::ConfigureLogsResponse)
—
Returns a response object which responds to the following methods:
- #arn => String
- #created_at => String
- #description => String
- #egress_access_logs => Types::EgressAccessLogs
- #hls_ingest => Types::HlsIngest
- #id => String
- #ingress_access_logs => Types::IngressAccessLogs
- #tags => Hash<String,String>
See Also:
503 504 505 506 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 503 def configure_logs(params = {}, options = {}) req = build_request(:configure_logs, params) req.send_request(options) end |
#create_channel(params = {}) ⇒ Types::CreateChannelResponse
Creates a new Channel.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_channel({
description: "__string",
id: "__string", # required
tags: {
"__string" => "__string",
},
})
Response structure
Response structure
resp.arn #=> String
resp.created_at #=> String
resp.description #=> String
resp.egress_access_logs.log_group_name #=> String
resp.hls_ingest.ingest_endpoints #=> Array
resp.hls_ingest.ingest_endpoints[0].id #=> String
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
resp.ingress_access_logs.log_group_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :description (String)
- :id (required, String)
-
:tags
(Hash<String,String>)
—
A collection of tags associated with a resource
Returns:
-
(Types::CreateChannelResponse)
—
Returns a response object which responds to the following methods:
- #arn => String
- #created_at => String
- #description => String
- #egress_access_logs => Types::EgressAccessLogs
- #hls_ingest => Types::HlsIngest
- #id => String
- #ingress_access_logs => Types::IngressAccessLogs
- #tags => Hash<String,String>
See Also:
558 559 560 561 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 558 def create_channel(params = {}, options = {}) req = build_request(:create_channel, params) req.send_request(options) end |
#create_harvest_job(params = {}) ⇒ Types::CreateHarvestJobResponse
Creates a new HarvestJob record.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_harvest_job({
end_time: "__string", # required
id: "__string", # required
origin_endpoint_id: "__string", # required
s3_destination: { # required
bucket_name: "__string", # required
manifest_key: "__string", # required
role_arn: "__string", # required
},
start_time: "__string", # required
})
Response structure
Response structure
resp.arn #=> String
resp.channel_id #=> String
resp.created_at #=> String
resp.end_time #=> String
resp.id #=> String
resp.origin_endpoint_id #=> String
resp.s3_destination.bucket_name #=> String
resp.s3_destination.manifest_key #=> String
resp.s3_destination.role_arn #=> String
resp.start_time #=> String
resp.status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :end_time (required, String)
- :id (required, String)
- :origin_endpoint_id (required, String)
-
:s3_destination
(required, Types::S3Destination)
—
Configuration parameters for where in an S3 bucket to place the harvested content
- :start_time (required, String)
Returns:
-
(Types::CreateHarvestJobResponse)
—
Returns a response object which responds to the following methods:
- #arn => String
- #channel_id => String
- #created_at => String
- #end_time => String
- #id => String
- #origin_endpoint_id => String
- #s3_destination => Types::S3Destination
- #start_time => String
- #status => String
See Also:
621 622 623 624 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 621 def create_harvest_job(params = {}, options = {}) req = build_request(:create_harvest_job, params) req.send_request(options) end |
#create_origin_endpoint(params = {}) ⇒ Types::CreateOriginEndpointResponse
Creates a new OriginEndpoint record.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_origin_endpoint({
authorization: {
cdn_identifier_secret: "__string", # required
secrets_role_arn: "__string", # required
},
channel_id: "__string", # required
cmaf_package: {
encryption: {
constant_initialization_vector: "__string",
encryption_method: "SAMPLE_AES", # accepts SAMPLE_AES, AES_CTR
key_rotation_interval_seconds: 1,
speke_key_provider: { # required
certificate_arn: "__string",
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
},
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, DATERANGE
ad_triggers: ["SPLICE_INSERT"], # accepts SPLICE_INSERT, BREAK, PROVIDER_ADVERTISEMENT, DISTRIBUTOR_ADVERTISEMENT, PROVIDER_PLACEMENT_OPPORTUNITY, DISTRIBUTOR_PLACEMENT_OPPORTUNITY, PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY, DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY
ads_on_delivery_restrictions: "NONE", # accepts NONE, RESTRICTED, UNRESTRICTED, BOTH
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: {
ad_triggers: ["SPLICE_INSERT"], # accepts SPLICE_INSERT, BREAK, PROVIDER_ADVERTISEMENT, DISTRIBUTOR_ADVERTISEMENT, PROVIDER_PLACEMENT_OPPORTUNITY, DISTRIBUTOR_PLACEMENT_OPPORTUNITY, PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY, DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY
ads_on_delivery_restrictions: "NONE", # accepts NONE, RESTRICTED, UNRESTRICTED, BOTH
encryption: {
key_rotation_interval_seconds: 1,
speke_key_provider: { # required
certificate_arn: "__string",
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
},
resource_id: "__string", # required
role_arn: "__string", # required
system_ids: ["__string"], # required
url: "__string", # required
},
},
include_iframe_only_stream: false,
manifest_layout: "FULL", # accepts FULL, COMPACT, DRM_TOP_LEVEL_COMPACT
manifest_window_seconds: 1,
min_buffer_time_seconds: 1,
min_update_period_seconds: 1,
period_triggers: ["ADS"], # accepts ADS
profile: "NONE", # accepts NONE, HBBTV_1_5, HYBRIDCAST, DVB_DASH_2014
segment_duration_seconds: 1,
segment_template_format: "NUMBER_WITH_TIMELINE", # accepts NUMBER_WITH_TIMELINE, TIME_WITH_TIMELINE, NUMBER_WITH_DURATION
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,
utc_timing: "NONE", # accepts NONE, HTTP-HEAD, HTTP-ISO, HTTP-XSDATE
utc_timing_uri: "__string",
},
description: "__string",
hls_package: {
ad_markers: "NONE", # accepts NONE, SCTE35_ENHANCED, PASSTHROUGH, DATERANGE
ad_triggers: ["SPLICE_INSERT"], # accepts SPLICE_INSERT, BREAK, PROVIDER_ADVERTISEMENT, DISTRIBUTOR_ADVERTISEMENT, PROVIDER_PLACEMENT_OPPORTUNITY, DISTRIBUTOR_PLACEMENT_OPPORTUNITY, PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY, DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY
ads_on_delivery_restrictions: "NONE", # accepts NONE, RESTRICTED, UNRESTRICTED, BOTH
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
certificate_arn: "__string",
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
},
resource_id: "__string", # required
role_arn: "__string", # required
system_ids: ["__string"], # required
url: "__string", # required
},
},
include_dvb_subtitles: false,
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
certificate_arn: "__string",
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
},
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
},
},
origination: "ALLOW", # accepts ALLOW, DENY
startover_window_seconds: 1,
tags: {
"__string" => "__string",
},
time_delay_seconds: 1,
whitelist: ["__string"],
})
Response structure
Response structure
resp.arn #=> String
resp.authorization.cdn_identifier_secret #=> String
resp.authorization.secrets_role_arn #=> String
resp.channel_id #=> String
resp.cmaf_package.encryption.constant_initialization_vector #=> String
resp.cmaf_package.encryption.encryption_method #=> String, one of "SAMPLE_AES", "AES_CTR"
resp.cmaf_package.encryption.key_rotation_interval_seconds #=> Integer
resp.cmaf_package.encryption.speke_key_provider.certificate_arn #=> 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.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", "DATERANGE"
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.created_at #=> String
resp.dash_package.ad_triggers #=> Array
resp.dash_package.ad_triggers[0] #=> String, one of "SPLICE_INSERT", "BREAK", "PROVIDER_ADVERTISEMENT", "DISTRIBUTOR_ADVERTISEMENT", "PROVIDER_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY"
resp.dash_package.ads_on_delivery_restrictions #=> String, one of "NONE", "RESTRICTED", "UNRESTRICTED", "BOTH"
resp.dash_package.encryption.key_rotation_interval_seconds #=> Integer
resp.dash_package.encryption.speke_key_provider.certificate_arn #=> String
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.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.include_iframe_only_stream #=> Boolean
resp.dash_package.manifest_layout #=> String, one of "FULL", "COMPACT", "DRM_TOP_LEVEL_COMPACT"
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.period_triggers #=> Array
resp.dash_package.period_triggers[0] #=> String, one of "ADS"
resp.dash_package.profile #=> String, one of "NONE", "HBBTV_1_5", "HYBRIDCAST", "DVB_DASH_2014"
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.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.dash_package.utc_timing #=> String, one of "NONE", "HTTP-HEAD", "HTTP-ISO", "HTTP-XSDATE"
resp.dash_package.utc_timing_uri #=> String
resp.description #=> String
resp.hls_package.ad_markers #=> String, one of "NONE", "SCTE35_ENHANCED", "PASSTHROUGH", "DATERANGE"
resp.hls_package.ad_triggers #=> Array
resp.hls_package.ad_triggers[0] #=> String, one of "SPLICE_INSERT", "BREAK", "PROVIDER_ADVERTISEMENT", "DISTRIBUTOR_ADVERTISEMENT", "PROVIDER_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY"
resp.hls_package.ads_on_delivery_restrictions #=> String, one of "NONE", "RESTRICTED", "UNRESTRICTED", "BOTH"
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.certificate_arn #=> String
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.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_dvb_subtitles #=> Boolean
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.certificate_arn #=> 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.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.origination #=> String, one of "ALLOW", "DENY"
resp.startover_window_seconds #=> Integer
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.time_delay_seconds #=> Integer
resp.url #=> String
resp.whitelist #=> Array
resp.whitelist[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:authorization
(Types::Authorization)
—
CDN Authorization credentials
- :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.
- :origination (String)
- :startover_window_seconds (Integer)
-
:tags
(Hash<String,String>)
—
A collection of tags associated with a resource
- :time_delay_seconds (Integer)
- :whitelist (Array<String>)
Returns:
-
(Types::CreateOriginEndpointResponse)
—
Returns a response object which responds to the following methods:
- #arn => String
- #authorization => Types::Authorization
- #channel_id => String
- #cmaf_package => Types::CmafPackage
- #created_at => String
- #dash_package => Types::DashPackage
- #description => String
- #hls_package => Types::HlsPackage
- #id => String
- #manifest_name => String
- #mss_package => Types::MssPackage
- #origination => String
- #startover_window_seconds => Integer
- #tags => Hash<String,String>
- #time_delay_seconds => Integer
- #url => String
- #whitelist => Array<String>
See Also:
946 947 948 949 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 946 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
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:
967 968 969 970 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 967 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
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:
988 989 990 991 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 988 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
Request syntax with placeholder values
resp = client.describe_channel({
id: "__string", # required
})
Response structure
Response structure
resp.arn #=> String
resp.created_at #=> String
resp.description #=> String
resp.egress_access_logs.log_group_name #=> String
resp.hls_ingest.ingest_endpoints #=> Array
resp.hls_ingest.ingest_endpoints[0].id #=> String
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
resp.ingress_access_logs.log_group_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :id (required, String)
Returns:
-
(Types::DescribeChannelResponse)
—
Returns a response object which responds to the following methods:
- #arn => String
- #created_at => String
- #description => String
- #egress_access_logs => Types::EgressAccessLogs
- #hls_ingest => Types::HlsIngest
- #id => String
- #ingress_access_logs => Types::IngressAccessLogs
- #tags => Hash<String,String>
See Also:
1034 1035 1036 1037 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 1034 def describe_channel(params = {}, options = {}) req = build_request(:describe_channel, params) req.send_request(options) end |
#describe_harvest_job(params = {}) ⇒ Types::DescribeHarvestJobResponse
Gets details about an existing HarvestJob.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.describe_harvest_job({
id: "__string", # required
})
Response structure
Response structure
resp.arn #=> String
resp.channel_id #=> String
resp.created_at #=> String
resp.end_time #=> String
resp.id #=> String
resp.origin_endpoint_id #=> String
resp.s3_destination.bucket_name #=> String
resp.s3_destination.manifest_key #=> String
resp.s3_destination.role_arn #=> String
resp.start_time #=> String
resp.status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :id (required, String)
Returns:
-
(Types::DescribeHarvestJobResponse)
—
Returns a response object which responds to the following methods:
- #arn => String
- #channel_id => String
- #created_at => String
- #end_time => String
- #id => String
- #origin_endpoint_id => String
- #s3_destination => Types::S3Destination
- #start_time => String
- #status => String
See Also:
1079 1080 1081 1082 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 1079 def describe_harvest_job(params = {}, options = {}) req = build_request(:describe_harvest_job, params) req.send_request(options) end |
#describe_origin_endpoint(params = {}) ⇒ Types::DescribeOriginEndpointResponse
Gets details about an existing OriginEndpoint.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.describe_origin_endpoint({
id: "__string", # required
})
Response structure
Response structure
resp.arn #=> String
resp.authorization.cdn_identifier_secret #=> String
resp.authorization.secrets_role_arn #=> String
resp.channel_id #=> String
resp.cmaf_package.encryption.constant_initialization_vector #=> String
resp.cmaf_package.encryption.encryption_method #=> String, one of "SAMPLE_AES", "AES_CTR"
resp.cmaf_package.encryption.key_rotation_interval_seconds #=> Integer
resp.cmaf_package.encryption.speke_key_provider.certificate_arn #=> 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.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", "DATERANGE"
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.created_at #=> String
resp.dash_package.ad_triggers #=> Array
resp.dash_package.ad_triggers[0] #=> String, one of "SPLICE_INSERT", "BREAK", "PROVIDER_ADVERTISEMENT", "DISTRIBUTOR_ADVERTISEMENT", "PROVIDER_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY"
resp.dash_package.ads_on_delivery_restrictions #=> String, one of "NONE", "RESTRICTED", "UNRESTRICTED", "BOTH"
resp.dash_package.encryption.key_rotation_interval_seconds #=> Integer
resp.dash_package.encryption.speke_key_provider.certificate_arn #=> String
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.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.include_iframe_only_stream #=> Boolean
resp.dash_package.manifest_layout #=> String, one of "FULL", "COMPACT", "DRM_TOP_LEVEL_COMPACT"
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.period_triggers #=> Array
resp.dash_package.period_triggers[0] #=> String, one of "ADS"
resp.dash_package.profile #=> String, one of "NONE", "HBBTV_1_5", "HYBRIDCAST", "DVB_DASH_2014"
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.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.dash_package.utc_timing #=> String, one of "NONE", "HTTP-HEAD", "HTTP-ISO", "HTTP-XSDATE"
resp.dash_package.utc_timing_uri #=> String
resp.description #=> String
resp.hls_package.ad_markers #=> String, one of "NONE", "SCTE35_ENHANCED", "PASSTHROUGH", "DATERANGE"
resp.hls_package.ad_triggers #=> Array
resp.hls_package.ad_triggers[0] #=> String, one of "SPLICE_INSERT", "BREAK", "PROVIDER_ADVERTISEMENT", "DISTRIBUTOR_ADVERTISEMENT", "PROVIDER_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY"
resp.hls_package.ads_on_delivery_restrictions #=> String, one of "NONE", "RESTRICTED", "UNRESTRICTED", "BOTH"
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.certificate_arn #=> String
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.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_dvb_subtitles #=> Boolean
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.certificate_arn #=> 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.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.origination #=> String, one of "ALLOW", "DENY"
resp.startover_window_seconds #=> Integer
resp.tags #=> Hash
resp.tags["__string"] #=> String
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:
-
(Types::DescribeOriginEndpointResponse)
—
Returns a response object which responds to the following methods:
- #arn => String
- #authorization => Types::Authorization
- #channel_id => String
- #cmaf_package => Types::CmafPackage
- #created_at => String
- #dash_package => Types::DashPackage
- #description => String
- #hls_package => Types::HlsPackage
- #id => String
- #manifest_name => String
- #mss_package => Types::MssPackage
- #origination => String
- #startover_window_seconds => Integer
- #tags => Hash<String,String>
- #time_delay_seconds => Integer
- #url => String
- #whitelist => Array<String>
See Also:
1229 1230 1231 1232 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 1229 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_channels({
max_results: 1,
next_token: "__string",
})
Response structure
Response structure
resp.channels #=> Array
resp.channels[0].arn #=> String
resp.channels[0].created_at #=> String
resp.channels[0].description #=> String
resp.channels[0].egress_access_logs.log_group_name #=> String
resp.channels[0].hls_ingest.ingest_endpoints #=> Array
resp.channels[0].hls_ingest.ingest_endpoints[0].id #=> String
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.channels[0].ingress_access_logs.log_group_name #=> String
resp.channels[0].tags #=> Hash
resp.channels[0].tags["__string"] #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :max_results (Integer)
- :next_token (String)
Returns:
-
(Types::ListChannelsResponse)
—
Returns a response object which responds to the following methods:
- #channels => Array<Types::Channel>
- #next_token => String
See Also:
1276 1277 1278 1279 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 1276 def list_channels(params = {}, options = {}) req = build_request(:list_channels, params) req.send_request(options) end |
#list_harvest_jobs(params = {}) ⇒ Types::ListHarvestJobsResponse
Returns a collection of HarvestJob records.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_harvest_jobs({
include_channel_id: "__string",
include_status: "__string",
max_results: 1,
next_token: "__string",
})
Response structure
Response structure
resp.harvest_jobs #=> Array
resp.harvest_jobs[0].arn #=> String
resp.harvest_jobs[0].channel_id #=> String
resp.harvest_jobs[0].created_at #=> String
resp.harvest_jobs[0].end_time #=> String
resp.harvest_jobs[0].id #=> String
resp.harvest_jobs[0].origin_endpoint_id #=> String
resp.harvest_jobs[0].s3_destination.bucket_name #=> String
resp.harvest_jobs[0].s3_destination.manifest_key #=> String
resp.harvest_jobs[0].s3_destination.role_arn #=> String
resp.harvest_jobs[0].start_time #=> String
resp.harvest_jobs[0].status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :include_channel_id (String)
- :include_status (String)
- :max_results (Integer)
- :next_token (String)
Returns:
-
(Types::ListHarvestJobsResponse)
—
Returns a response object which responds to the following methods:
- #harvest_jobs => Array<Types::HarvestJob>
- #next_token => String
See Also:
1327 1328 1329 1330 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 1327 def list_harvest_jobs(params = {}, options = {}) req = build_request(:list_harvest_jobs, params) req.send_request(options) end |
#list_origin_endpoints(params = {}) ⇒ Types::ListOriginEndpointsResponse
Returns a collection of OriginEndpoint records.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_origin_endpoints({
channel_id: "__string",
max_results: 1,
next_token: "__string",
})
Response structure
Response structure
resp.next_token #=> String
resp.origin_endpoints #=> Array
resp.origin_endpoints[0].arn #=> String
resp.origin_endpoints[0].authorization.cdn_identifier_secret #=> String
resp.origin_endpoints[0].authorization.secrets_role_arn #=> String
resp.origin_endpoints[0].channel_id #=> String
resp.origin_endpoints[0].cmaf_package.encryption.constant_initialization_vector #=> String
resp.origin_endpoints[0].cmaf_package.encryption.encryption_method #=> String, one of "SAMPLE_AES", "AES_CTR"
resp.origin_endpoints[0].cmaf_package.encryption.key_rotation_interval_seconds #=> Integer
resp.origin_endpoints[0].cmaf_package.encryption.speke_key_provider.certificate_arn #=> String
resp.origin_endpoints[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.origin_endpoints[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.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", "DATERANGE"
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].created_at #=> String
resp.origin_endpoints[0].dash_package.ad_triggers #=> Array
resp.origin_endpoints[0].dash_package.ad_triggers[0] #=> String, one of "SPLICE_INSERT", "BREAK", "PROVIDER_ADVERTISEMENT", "DISTRIBUTOR_ADVERTISEMENT", "PROVIDER_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY"
resp.origin_endpoints[0].dash_package.ads_on_delivery_restrictions #=> String, one of "NONE", "RESTRICTED", "UNRESTRICTED", "BOTH"
resp.origin_endpoints[0].dash_package.encryption.key_rotation_interval_seconds #=> Integer
resp.origin_endpoints[0].dash_package.encryption.speke_key_provider.certificate_arn #=> String
resp.origin_endpoints[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.origin_endpoints[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.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.include_iframe_only_stream #=> Boolean
resp.origin_endpoints[0].dash_package.manifest_layout #=> String, one of "FULL", "COMPACT", "DRM_TOP_LEVEL_COMPACT"
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.period_triggers #=> Array
resp.origin_endpoints[0].dash_package.period_triggers[0] #=> String, one of "ADS"
resp.origin_endpoints[0].dash_package.profile #=> String, one of "NONE", "HBBTV_1_5", "HYBRIDCAST", "DVB_DASH_2014"
resp.origin_endpoints[0].dash_package.segment_duration_seconds #=> Integer
resp.origin_endpoints[0].dash_package.segment_template_format #=> String, one of "NUMBER_WITH_TIMELINE", "TIME_WITH_TIMELINE", "NUMBER_WITH_DURATION"
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].dash_package.utc_timing #=> String, one of "NONE", "HTTP-HEAD", "HTTP-ISO", "HTTP-XSDATE"
resp.origin_endpoints[0].dash_package.utc_timing_uri #=> String
resp.origin_endpoints[0].description #=> String
resp.origin_endpoints[0].hls_package.ad_markers #=> String, one of "NONE", "SCTE35_ENHANCED", "PASSTHROUGH", "DATERANGE"
resp.origin_endpoints[0].hls_package.ad_triggers #=> Array
resp.origin_endpoints[0].hls_package.ad_triggers[0] #=> String, one of "SPLICE_INSERT", "BREAK", "PROVIDER_ADVERTISEMENT", "DISTRIBUTOR_ADVERTISEMENT", "PROVIDER_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY"
resp.origin_endpoints[0].hls_package.ads_on_delivery_restrictions #=> String, one of "NONE", "RESTRICTED", "UNRESTRICTED", "BOTH"
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.certificate_arn #=> String
resp.origin_endpoints[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.origin_endpoints[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.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_dvb_subtitles #=> Boolean
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.certificate_arn #=> String
resp.origin_endpoints[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.origin_endpoints[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.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].origination #=> String, one of "ALLOW", "DENY"
resp.origin_endpoints[0].startover_window_seconds #=> Integer
resp.origin_endpoints[0].tags #=> Hash
resp.origin_endpoints[0].tags["__string"] #=> String
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:
-
(Types::ListOriginEndpointsResponse)
—
Returns a response object which responds to the following methods:
- #next_token => String
- #origin_endpoints => Array<Types::OriginEndpoint>
See Also:
1472 1473 1474 1475 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 1472 def list_origin_endpoints(params = {}, options = {}) req = build_request(:list_origin_endpoints, params) req.send_request(options) end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_tags_for_resource({
resource_arn: "__string", # required
})
Response structure
Response structure
resp.tags #=> Hash
resp.tags["__string"] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :resource_arn (required, String)
Returns:
See Also:
1498 1499 1500 1501 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 1498 def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end |
#rotate_channel_credentials(params = {}) ⇒ Types::RotateChannelCredentialsResponse
Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.rotate_channel_credentials({
id: "__string", # required
})
Response structure
Response structure
resp.arn #=> String
resp.created_at #=> String
resp.description #=> String
resp.egress_access_logs.log_group_name #=> String
resp.hls_ingest.ingest_endpoints #=> Array
resp.hls_ingest.ingest_endpoints[0].id #=> String
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
resp.ingress_access_logs.log_group_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :id (required, String)
Returns:
-
(Types::RotateChannelCredentialsResponse)
—
Returns a response object which responds to the following methods:
- #arn => String
- #created_at => String
- #description => String
- #egress_access_logs => Types::EgressAccessLogs
- #hls_ingest => Types::HlsIngest
- #id => String
- #ingress_access_logs => Types::IngressAccessLogs
- #tags => Hash<String,String>
See Also:
1546 1547 1548 1549 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 1546 def rotate_channel_credentials(params = {}, options = {}) req = build_request(:rotate_channel_credentials, params) req.send_request(options) end |
#rotate_ingest_endpoint_credentials(params = {}) ⇒ Types::RotateIngestEndpointCredentialsResponse
Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.rotate_ingest_endpoint_credentials({
id: "__string", # required
ingest_endpoint_id: "__string", # required
})
Response structure
Response structure
resp.arn #=> String
resp.created_at #=> String
resp.description #=> String
resp.egress_access_logs.log_group_name #=> String
resp.hls_ingest.ingest_endpoints #=> Array
resp.hls_ingest.ingest_endpoints[0].id #=> String
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
resp.ingress_access_logs.log_group_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :id (required, String)
- :ingest_endpoint_id (required, String)
Returns:
-
(Types::RotateIngestEndpointCredentialsResponse)
—
Returns a response object which responds to the following methods:
- #arn => String
- #created_at => String
- #description => String
- #egress_access_logs => Types::EgressAccessLogs
- #hls_ingest => Types::HlsIngest
- #id => String
- #ingress_access_logs => Types::IngressAccessLogs
- #tags => Hash<String,String>
See Also:
1596 1597 1598 1599 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 1596 def rotate_ingest_endpoint_credentials(params = {}, options = {}) req = build_request(:rotate_ingest_endpoint_credentials, params) req.send_request(options) end |
#tag_resource(params = {}) ⇒ Struct
Returns an empty response.
Examples:
Request syntax with placeholder values
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:
1620 1621 1622 1623 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 1620 def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end |
#untag_resource(params = {}) ⇒ Struct
Returns an empty response.
Examples:
Request syntax with placeholder values
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:
1642 1643 1644 1645 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 1642 def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end |
#update_channel(params = {}) ⇒ Types::UpdateChannelResponse
Updates an existing Channel.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_channel({
description: "__string",
id: "__string", # required
})
Response structure
Response structure
resp.arn #=> String
resp.created_at #=> String
resp.description #=> String
resp.egress_access_logs.log_group_name #=> String
resp.hls_ingest.ingest_endpoints #=> Array
resp.hls_ingest.ingest_endpoints[0].id #=> String
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
resp.ingress_access_logs.log_group_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :description (String)
- :id (required, String)
Returns:
-
(Types::UpdateChannelResponse)
—
Returns a response object which responds to the following methods:
- #arn => String
- #created_at => String
- #description => String
- #egress_access_logs => Types::EgressAccessLogs
- #hls_ingest => Types::HlsIngest
- #id => String
- #ingress_access_logs => Types::IngressAccessLogs
- #tags => Hash<String,String>
See Also:
1691 1692 1693 1694 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 1691 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
Request syntax with placeholder values
resp = client.update_origin_endpoint({
authorization: {
cdn_identifier_secret: "__string", # required
secrets_role_arn: "__string", # required
},
cmaf_package: {
encryption: {
constant_initialization_vector: "__string",
encryption_method: "SAMPLE_AES", # accepts SAMPLE_AES, AES_CTR
key_rotation_interval_seconds: 1,
speke_key_provider: { # required
certificate_arn: "__string",
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
},
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, DATERANGE
ad_triggers: ["SPLICE_INSERT"], # accepts SPLICE_INSERT, BREAK, PROVIDER_ADVERTISEMENT, DISTRIBUTOR_ADVERTISEMENT, PROVIDER_PLACEMENT_OPPORTUNITY, DISTRIBUTOR_PLACEMENT_OPPORTUNITY, PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY, DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY
ads_on_delivery_restrictions: "NONE", # accepts NONE, RESTRICTED, UNRESTRICTED, BOTH
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: {
ad_triggers: ["SPLICE_INSERT"], # accepts SPLICE_INSERT, BREAK, PROVIDER_ADVERTISEMENT, DISTRIBUTOR_ADVERTISEMENT, PROVIDER_PLACEMENT_OPPORTUNITY, DISTRIBUTOR_PLACEMENT_OPPORTUNITY, PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY, DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY
ads_on_delivery_restrictions: "NONE", # accepts NONE, RESTRICTED, UNRESTRICTED, BOTH
encryption: {
key_rotation_interval_seconds: 1,
speke_key_provider: { # required
certificate_arn: "__string",
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
},
resource_id: "__string", # required
role_arn: "__string", # required
system_ids: ["__string"], # required
url: "__string", # required
},
},
include_iframe_only_stream: false,
manifest_layout: "FULL", # accepts FULL, COMPACT, DRM_TOP_LEVEL_COMPACT
manifest_window_seconds: 1,
min_buffer_time_seconds: 1,
min_update_period_seconds: 1,
period_triggers: ["ADS"], # accepts ADS
profile: "NONE", # accepts NONE, HBBTV_1_5, HYBRIDCAST, DVB_DASH_2014
segment_duration_seconds: 1,
segment_template_format: "NUMBER_WITH_TIMELINE", # accepts NUMBER_WITH_TIMELINE, TIME_WITH_TIMELINE, NUMBER_WITH_DURATION
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,
utc_timing: "NONE", # accepts NONE, HTTP-HEAD, HTTP-ISO, HTTP-XSDATE
utc_timing_uri: "__string",
},
description: "__string",
hls_package: {
ad_markers: "NONE", # accepts NONE, SCTE35_ENHANCED, PASSTHROUGH, DATERANGE
ad_triggers: ["SPLICE_INSERT"], # accepts SPLICE_INSERT, BREAK, PROVIDER_ADVERTISEMENT, DISTRIBUTOR_ADVERTISEMENT, PROVIDER_PLACEMENT_OPPORTUNITY, DISTRIBUTOR_PLACEMENT_OPPORTUNITY, PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY, DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY
ads_on_delivery_restrictions: "NONE", # accepts NONE, RESTRICTED, UNRESTRICTED, BOTH
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
certificate_arn: "__string",
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
},
resource_id: "__string", # required
role_arn: "__string", # required
system_ids: ["__string"], # required
url: "__string", # required
},
},
include_dvb_subtitles: false,
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
certificate_arn: "__string",
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
},
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
},
},
origination: "ALLOW", # accepts ALLOW, DENY
startover_window_seconds: 1,
time_delay_seconds: 1,
whitelist: ["__string"],
})
Response structure
Response structure
resp.arn #=> String
resp.authorization.cdn_identifier_secret #=> String
resp.authorization.secrets_role_arn #=> String
resp.channel_id #=> String
resp.cmaf_package.encryption.constant_initialization_vector #=> String
resp.cmaf_package.encryption.encryption_method #=> String, one of "SAMPLE_AES", "AES_CTR"
resp.cmaf_package.encryption.key_rotation_interval_seconds #=> Integer
resp.cmaf_package.encryption.speke_key_provider.certificate_arn #=> 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.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", "DATERANGE"
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.created_at #=> String
resp.dash_package.ad_triggers #=> Array
resp.dash_package.ad_triggers[0] #=> String, one of "SPLICE_INSERT", "BREAK", "PROVIDER_ADVERTISEMENT", "DISTRIBUTOR_ADVERTISEMENT", "PROVIDER_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY"
resp.dash_package.ads_on_delivery_restrictions #=> String, one of "NONE", "RESTRICTED", "UNRESTRICTED", "BOTH"
resp.dash_package.encryption.key_rotation_interval_seconds #=> Integer
resp.dash_package.encryption.speke_key_provider.certificate_arn #=> String
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.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.include_iframe_only_stream #=> Boolean
resp.dash_package.manifest_layout #=> String, one of "FULL", "COMPACT", "DRM_TOP_LEVEL_COMPACT"
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.period_triggers #=> Array
resp.dash_package.period_triggers[0] #=> String, one of "ADS"
resp.dash_package.profile #=> String, one of "NONE", "HBBTV_1_5", "HYBRIDCAST", "DVB_DASH_2014"
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.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.dash_package.utc_timing #=> String, one of "NONE", "HTTP-HEAD", "HTTP-ISO", "HTTP-XSDATE"
resp.dash_package.utc_timing_uri #=> String
resp.description #=> String
resp.hls_package.ad_markers #=> String, one of "NONE", "SCTE35_ENHANCED", "PASSTHROUGH", "DATERANGE"
resp.hls_package.ad_triggers #=> Array
resp.hls_package.ad_triggers[0] #=> String, one of "SPLICE_INSERT", "BREAK", "PROVIDER_ADVERTISEMENT", "DISTRIBUTOR_ADVERTISEMENT", "PROVIDER_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY"
resp.hls_package.ads_on_delivery_restrictions #=> String, one of "NONE", "RESTRICTED", "UNRESTRICTED", "BOTH"
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.certificate_arn #=> String
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.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_dvb_subtitles #=> Boolean
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.certificate_arn #=> 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.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.origination #=> String, one of "ALLOW", "DENY"
resp.startover_window_seconds #=> Integer
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.time_delay_seconds #=> Integer
resp.url #=> String
resp.whitelist #=> Array
resp.whitelist[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:authorization
(Types::Authorization)
—
CDN Authorization credentials
-
: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.
- :origination (String)
- :startover_window_seconds (Integer)
- :time_delay_seconds (Integer)
- :whitelist (Array<String>)
Returns:
-
(Types::UpdateOriginEndpointResponse)
—
Returns a response object which responds to the following methods:
- #arn => String
- #authorization => Types::Authorization
- #channel_id => String
- #cmaf_package => Types::CmafPackage
- #created_at => String
- #dash_package => Types::DashPackage
- #description => String
- #hls_package => Types::HlsPackage
- #id => String
- #manifest_name => String
- #mss_package => Types::MssPackage
- #origination => String
- #startover_window_seconds => Integer
- #tags => Hash<String,String>
- #time_delay_seconds => Integer
- #url => String
- #whitelist => Array<String>
See Also:
2007 2008 2009 2010 |
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/client.rb', line 2007 def update_origin_endpoint(params = {}, options = {}) req = build_request(:update_origin_endpoint, params) req.send_request(options) end |