Class: Aws::IVS::Client

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

Overview

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

client = Aws::IVS::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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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 used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

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

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

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

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

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

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

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

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

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

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

    • Aws.config[: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 or Aws::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 to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

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

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

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

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

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

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

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

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

  • :ignore_configured_endpoint_urls (Boolean) —

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

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

    The log formatter.

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

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

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

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

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

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

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

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

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

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

  • :retry_base_delay (Float) — default: 0.3 —

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

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

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

    @see 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 of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

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

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

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

    • 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 a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

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

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

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

  • :use_dualstack_endpoint (Boolean) —

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

  • :use_fips_endpoint (Boolean) —

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

  • :validate_params (Boolean) — default: true —

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

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

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::IVS::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.



473
474
475
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 473

def initialize(*args)
  super
end

Instance Method Details

#batch_get_channel(params = {}) ⇒ Types::BatchGetChannelResponse

Performs GetChannel on multiple ARNs simultaneously.

Examples:

Request syntax with placeholder values


resp = client.batch_get_channel({
  arns: ["ChannelArn"], # required
})

Response structure


resp.access_control_allow_origin #=> String
resp.access_control_expose_headers #=> String
resp.cache_control #=> String
resp.content_security_policy #=> String
resp.strict_transport_security #=> String
resp.x_content_type_options #=> String
resp.x_frame_options #=> String
resp.channels #=> Array
resp.channels[0].arn #=> String
resp.channels[0].name #=> String
resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
resp.channels[0].type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
resp.channels[0].recording_configuration_arn #=> String
resp.channels[0].ingest_endpoint #=> String
resp.channels[0].playback_url #=> String
resp.channels[0].authorized #=> Boolean
resp.channels[0].tags #=> Hash
resp.channels[0].tags["TagKey"] #=> String
resp.channels[0].insecure_ingest #=> Boolean
resp.channels[0].preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
resp.channels[0].srt.endpoint #=> String
resp.channels[0].srt.passphrase #=> String
resp.channels[0].playback_restriction_policy_arn #=> String
resp.channels[0].multitrack_input_configuration.enabled #=> Boolean
resp.channels[0].multitrack_input_configuration.policy #=> String, one of "ALLOW", "REQUIRE"
resp.channels[0].multitrack_input_configuration.maximum_resolution #=> String, one of "SD", "HD", "FULL_HD"
resp.channels[0].container_format #=> String, one of "TS", "FRAGMENTED_MP4"
resp.channels[0].ad_configuration_arn #=> String
resp.errors #=> Array
resp.errors[0].arn #=> String
resp.errors[0].code #=> String
resp.errors[0].message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arns (required, Array<String>) —

    Array of ARNs, one per channel.

Returns:

See Also:



541
542
543
544
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 541

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

#batch_get_stream_key(params = {}) ⇒ Types::BatchGetStreamKeyResponse

Performs GetStreamKey on multiple ARNs simultaneously.

Examples:

Request syntax with placeholder values


resp = client.batch_get_stream_key({
  arns: ["StreamKeyArn"], # required
})

Response structure


resp.access_control_allow_origin #=> String
resp.access_control_expose_headers #=> String
resp.cache_control #=> String
resp.content_security_policy #=> String
resp.strict_transport_security #=> String
resp.x_content_type_options #=> String
resp.x_frame_options #=> String
resp.stream_keys #=> Array
resp.stream_keys[0].arn #=> String
resp.stream_keys[0].value #=> String
resp.stream_keys[0].channel_arn #=> String
resp.stream_keys[0].tags #=> Hash
resp.stream_keys[0].tags["TagKey"] #=> String
resp.errors #=> Array
resp.errors[0].arn #=> String
resp.errors[0].code #=> String
resp.errors[0].message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arns (required, Array<String>) —

    Array of ARNs, one per stream key.

Returns:

See Also:



593
594
595
596
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 593

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

#batch_start_viewer_session_revocation(params = {}) ⇒ Types::BatchStartViewerSessionRevocationResponse

Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.

Examples:

Request syntax with placeholder values


resp = client.batch_start_viewer_session_revocation({
  viewer_sessions: [ # required
    {
      channel_arn: "ChannelArn", # required
      viewer_id: "ViewerId", # required
      viewer_session_versions_less_than_or_equal_to: 1,
    },
  ],
})

Response structure


resp.access_control_allow_origin #=> String
resp.access_control_expose_headers #=> String
resp.cache_control #=> String
resp.content_security_policy #=> String
resp.strict_transport_security #=> String
resp.x_content_type_options #=> String
resp.x_frame_options #=> String
resp.errors #=> Array
resp.errors[0].channel_arn #=> String
resp.errors[0].viewer_id #=> String
resp.errors[0].code #=> String
resp.errors[0].message #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



646
647
648
649
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 646

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

#create_ad_configuration(params = {}) ⇒ Types::CreateAdConfigurationResponse

Creates a new ad configuration to be used for server-side ad insertion.

Examples:

Request syntax with placeholder values


resp = client.create_ad_configuration({
  name: "AdConfigurationName",
  media_tailor_playback_configurations: [ # required
    {
      playback_configuration_arn: "MediaTailorPlaybackConfigurationArn",
    },
  ],
})

Response structure


resp.ad_configuration.arn #=> String
resp.ad_configuration.name #=> String
resp.ad_configuration.media_tailor_playback_configurations #=> Array
resp.ad_configuration.media_tailor_playback_configurations[0].playback_configuration_arn #=> String
resp.ad_configuration.tags #=> Hash
resp.ad_configuration.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    Ad configuration name. Defaults to “”.

  • :media_tailor_playback_configurations (required, Array<Types::MediaTailorPlaybackConfiguration>) —

    List of integration configurations with media tailor resources.

Returns:

See Also:



688
689
690
691
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 688

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

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

Creates a new channel and an associated stream key to start streaming.

Examples:

Request syntax with placeholder values


resp = client.create_channel({
  name: "ChannelName",
  latency_mode: "NORMAL", # accepts NORMAL, LOW
  type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD
  authorized: false,
  recording_configuration_arn: "ChannelRecordingConfigurationArn",
  tags: {
    "TagKey" => "TagValue",
  },
  insecure_ingest: false,
  preset: "HIGHER_BANDWIDTH_DELIVERY", # accepts HIGHER_BANDWIDTH_DELIVERY, CONSTRAINED_BANDWIDTH_DELIVERY
  playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
  multitrack_input_configuration: {
    enabled: false,
    policy: "ALLOW", # accepts ALLOW, REQUIRE
    maximum_resolution: "SD", # accepts SD, HD, FULL_HD
  },
  container_format: "TS", # accepts TS, FRAGMENTED_MP4
  ad_configuration_arn: "ChannelAdConfigurationArn",
})

Response structure


resp.channel.arn #=> String
resp.channel.name #=> String
resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
resp.channel.recording_configuration_arn #=> String
resp.channel.ingest_endpoint #=> String
resp.channel.playback_url #=> String
resp.channel.authorized #=> Boolean
resp.channel.tags #=> Hash
resp.channel.tags["TagKey"] #=> String
resp.channel.insecure_ingest #=> Boolean
resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
resp.channel.srt.endpoint #=> String
resp.channel.srt.passphrase #=> String
resp.channel.playback_restriction_policy_arn #=> String
resp.channel.multitrack_input_configuration.enabled #=> Boolean
resp.channel.multitrack_input_configuration.policy #=> String, one of "ALLOW", "REQUIRE"
resp.channel.multitrack_input_configuration.maximum_resolution #=> String, one of "SD", "HD", "FULL_HD"
resp.channel.container_format #=> String, one of "TS", "FRAGMENTED_MP4"
resp.channel.ad_configuration_arn #=> String
resp.stream_key.arn #=> String
resp.stream_key.value #=> String
resp.stream_key.channel_arn #=> String
resp.stream_key.tags #=> Hash
resp.stream_key.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    Channel name.

  • :latency_mode (String) —

    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.

  • :type (String) —

    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

  • :authorized (Boolean) —

    Whether the channel is private (enabled for playback authorization). Default: false.

  • :recording_configuration_arn (String) —

    Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).

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

    Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

  • :insecure_ingest (Boolean) —

    Whether the channel allows insecure RTMP and SRT ingest. Default: false.

  • :preset (String) —

    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

  • :playback_restriction_policy_arn (String) —

    Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).

  • :multitrack_input_configuration (Types::MultitrackInputConfiguration) —

    Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.

  • :container_format (String) —

    Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.

  • :ad_configuration_arn (String) —

    ARN of the ad configuration associated with the channel.

Returns:

See Also:



823
824
825
826
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 823

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

#create_playback_restriction_policy(params = {}) ⇒ Types::CreatePlaybackRestrictionPolicyResponse

Creates a new playback restriction policy, for constraining playback by countries and/or origins.

Examples:

Request syntax with placeholder values


resp = client.create_playback_restriction_policy({
  allowed_countries: ["PlaybackRestrictionPolicyAllowedCountry"],
  allowed_origins: ["PlaybackRestrictionPolicyAllowedOrigin"],
  enable_strict_origin_enforcement: false,
  name: "PlaybackRestrictionPolicyName",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.playback_restriction_policy.arn #=> String
resp.playback_restriction_policy.allowed_countries #=> Array
resp.playback_restriction_policy.allowed_countries[0] #=> String
resp.playback_restriction_policy.allowed_origins #=> Array
resp.playback_restriction_policy.allowed_origins[0] #=> String
resp.playback_restriction_policy.enable_strict_origin_enforcement #=> Boolean
resp.playback_restriction_policy.name #=> String
resp.playback_restriction_policy.tags #=> Hash
resp.playback_restriction_policy.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :allowed_countries (Array<String>) —

    A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).

  • :allowed_origins (Array<String>) —

    A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).

  • :enable_strict_origin_enforcement (Boolean) —

    Whether channel playback is constrained by origin site. Default: false.

  • :name (String) —

    Playback-restriction-policy name. The value does not need to be unique.

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

    Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Returns:

See Also:



901
902
903
904
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 901

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

#create_recording_configuration(params = {}) ⇒ Types::CreateRecordingConfigurationResponse

Creates a new recording configuration, used to enable recording to Amazon S3.

Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.)

Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.

Examples:

Request syntax with placeholder values


resp = client.create_recording_configuration({
  name: "RecordingConfigurationName",
  destination_configuration: { # required
    s3: {
      bucket_name: "S3DestinationBucketName", # required
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
  thumbnail_configuration: {
    recording_mode: "DISABLED", # accepts DISABLED, INTERVAL
    target_interval_seconds: 1,
    resolution: "SD", # accepts SD, HD, FULL_HD, LOWEST_RESOLUTION
    storage: ["SEQUENTIAL"], # accepts SEQUENTIAL, LATEST
  },
  recording_reconnect_window_seconds: 1,
  rendition_configuration: {
    rendition_selection: "ALL", # accepts ALL, NONE, CUSTOM
    renditions: ["SD"], # accepts SD, HD, FULL_HD, LOWEST_RESOLUTION
  },
})

Response structure


resp.recording_configuration.arn #=> String
resp.recording_configuration.name #=> String
resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
resp.recording_configuration.tags #=> Hash
resp.recording_configuration.tags["TagKey"] #=> String
resp.recording_configuration.thumbnail_configuration.recording_mode #=> String, one of "DISABLED", "INTERVAL"
resp.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer
resp.recording_configuration.thumbnail_configuration.resolution #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
resp.recording_configuration.thumbnail_configuration.storage #=> Array
resp.recording_configuration.thumbnail_configuration.storage[0] #=> String, one of "SEQUENTIAL", "LATEST"
resp.recording_configuration.recording_reconnect_window_seconds #=> Integer
resp.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM"
resp.recording_configuration.rendition_configuration.renditions #=> Array
resp.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    Recording-configuration name. The value does not need to be unique.

  • :destination_configuration (required, Types::DestinationConfiguration) —

    A complex type that contains a destination configuration for where recorded video will be stored.

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

    Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

  • :thumbnail_configuration (Types::ThumbnailConfiguration) —

    A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

  • :recording_reconnect_window_seconds (Integer) —

    If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

  • :rendition_configuration (Types::RenditionConfiguration) —

    Object that describes which renditions should be recorded for a stream.

Returns:

See Also:



1005
1006
1007
1008
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1005

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

#create_stream_key(params = {}) ⇒ Types::CreateStreamKeyResponse

Creates a stream key, used to initiate a stream, for the specified channel ARN.

Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.

Examples:

Request syntax with placeholder values


resp = client.create_stream_key({
  channel_arn: "ChannelArn", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.stream_key.arn #=> String
resp.stream_key.value #=> String
resp.stream_key.channel_arn #=> String
resp.stream_key.tags #=> Hash
resp.stream_key.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    ARN of the channel for which to create the stream key.

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

    Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Returns:

See Also:



1058
1059
1060
1061
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1058

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

#delete_ad_configuration(params = {}) ⇒ Struct

Deletes the specified ad configuration.

Examples:

Request syntax with placeholder values


resp = client.delete_ad_configuration({
  arn: "AdConfigurationArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    ARN of the ad configuration to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1080
1081
1082
1083
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1080

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

#delete_channel(params = {}) ⇒ Struct

Deletes the specified channel and its associated stream keys.

If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state is no longer Live), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)

Examples:

Request syntax with placeholder values


resp = client.delete_channel({
  arn: "ChannelArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    ARN of the channel to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1112
1113
1114
1115
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1112

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

#delete_playback_key_pair(params = {}) ⇒ Struct

Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_playback_key_pair({
  arn: "PlaybackKeyPairArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    ARN of the key pair to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1141
1142
1143
1144
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1141

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

#delete_playback_restriction_policy(params = {}) ⇒ Struct

Deletes the specified playback restriction policy.

Examples:

Request syntax with placeholder values


resp = client.delete_playback_restriction_policy({
  arn: "PlaybackRestrictionPolicyArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    ARN of the playback restriction policy to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1163
1164
1165
1166
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1163

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

#delete_recording_configuration(params = {}) ⇒ Struct

Deletes the recording configuration for the specified ARN.

If you try to delete a recording configuration that is associated with a channel, you will get an error (409 ConflictException). To avoid this, for all channels that reference the recording configuration, first use UpdateChannel to set the recordingConfigurationArn field to an empty string, then use DeleteRecordingConfiguration.

Examples:

Request syntax with placeholder values


resp = client.delete_recording_configuration({
  arn: "RecordingConfigurationArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    ARN of the recording configuration to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1191
1192
1193
1194
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1191

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

#delete_stream_key(params = {}) ⇒ Struct

Deletes the stream key for the specified ARN, so it can no longer be used to stream.

Examples:

Request syntax with placeholder values


resp = client.delete_stream_key({
  arn: "StreamKeyArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    ARN of the stream key to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1214
1215
1216
1217
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1214

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

#get_ad_configuration(params = {}) ⇒ Types::GetAdConfigurationResponse

Gets the ad configuration represented by the specified ARN.

Examples:

Request syntax with placeholder values


resp = client.get_ad_configuration({
  arn: "AdConfigurationArn", # required
})

Response structure


resp.ad_configuration.arn #=> String
resp.ad_configuration.name #=> String
resp.ad_configuration.media_tailor_playback_configurations #=> Array
resp.ad_configuration.media_tailor_playback_configurations[0].playback_configuration_arn #=> String
resp.ad_configuration.tags #=> Hash
resp.ad_configuration.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    ARN of the ad configuration to be retrieved.

Returns:

See Also:



1247
1248
1249
1250
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1247

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

#get_channel(params = {}) ⇒ Types::GetChannelResponse

Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.

Examples:

Request syntax with placeholder values


resp = client.get_channel({
  arn: "ChannelArn", # required
})

Response structure


resp.channel.arn #=> String
resp.channel.name #=> String
resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
resp.channel.recording_configuration_arn #=> String
resp.channel.ingest_endpoint #=> String
resp.channel.playback_url #=> String
resp.channel.authorized #=> Boolean
resp.channel.tags #=> Hash
resp.channel.tags["TagKey"] #=> String
resp.channel.insecure_ingest #=> Boolean
resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
resp.channel.srt.endpoint #=> String
resp.channel.srt.passphrase #=> String
resp.channel.playback_restriction_policy_arn #=> String
resp.channel.multitrack_input_configuration.enabled #=> Boolean
resp.channel.multitrack_input_configuration.policy #=> String, one of "ALLOW", "REQUIRE"
resp.channel.multitrack_input_configuration.maximum_resolution #=> String, one of "SD", "HD", "FULL_HD"
resp.channel.container_format #=> String, one of "TS", "FRAGMENTED_MP4"
resp.channel.ad_configuration_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    ARN of the channel for which the configuration is to be retrieved.

Returns:

See Also:



1295
1296
1297
1298
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1295

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

#get_playback_key_pair(params = {}) ⇒ Types::GetPlaybackKeyPairResponse

Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Examples:

Request syntax with placeholder values


resp = client.get_playback_key_pair({
  arn: "PlaybackKeyPairArn", # required
})

Response structure


resp.key_pair.arn #=> String
resp.key_pair.name #=> String
resp.key_pair.fingerprint #=> String
resp.key_pair.tags #=> Hash
resp.key_pair.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    ARN of the key pair to be returned.

Returns:

See Also:



1335
1336
1337
1338
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1335

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

#get_playback_restriction_policy(params = {}) ⇒ Types::GetPlaybackRestrictionPolicyResponse

Gets the specified playback restriction policy.

Examples:

Request syntax with placeholder values


resp = client.get_playback_restriction_policy({
  arn: "PlaybackRestrictionPolicyArn", # required
})

Response structure


resp.playback_restriction_policy.arn #=> String
resp.playback_restriction_policy.allowed_countries #=> Array
resp.playback_restriction_policy.allowed_countries[0] #=> String
resp.playback_restriction_policy.allowed_origins #=> Array
resp.playback_restriction_policy.allowed_origins[0] #=> String
resp.playback_restriction_policy.enable_strict_origin_enforcement #=> Boolean
resp.playback_restriction_policy.name #=> String
resp.playback_restriction_policy.tags #=> Hash
resp.playback_restriction_policy.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    ARN of the playback restriction policy to be returned.

Returns:

See Also:



1371
1372
1373
1374
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1371

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

#get_recording_configuration(params = {}) ⇒ Types::GetRecordingConfigurationResponse

Gets the recording configuration for the specified ARN.

Examples:

Request syntax with placeholder values


resp = client.get_recording_configuration({
  arn: "RecordingConfigurationArn", # required
})

Response structure


resp.recording_configuration.arn #=> String
resp.recording_configuration.name #=> String
resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
resp.recording_configuration.tags #=> Hash
resp.recording_configuration.tags["TagKey"] #=> String
resp.recording_configuration.thumbnail_configuration.recording_mode #=> String, one of "DISABLED", "INTERVAL"
resp.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer
resp.recording_configuration.thumbnail_configuration.resolution #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
resp.recording_configuration.thumbnail_configuration.storage #=> Array
resp.recording_configuration.thumbnail_configuration.storage[0] #=> String, one of "SEQUENTIAL", "LATEST"
resp.recording_configuration.recording_reconnect_window_seconds #=> Integer
resp.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM"
resp.recording_configuration.rendition_configuration.renditions #=> Array
resp.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    ARN of the recording configuration to be retrieved.

Returns:

See Also:



1413
1414
1415
1416
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1413

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

#get_stream(params = {}) ⇒ Types::GetStreamResponse

Gets information about the active (live) stream on a specified channel.

Examples:

Request syntax with placeholder values


resp = client.get_stream({
  channel_arn: "ChannelArn", # required
})

Response structure


resp.stream.channel_arn #=> String
resp.stream.stream_id #=> String
resp.stream.playback_url #=> String
resp.stream.start_time #=> Time
resp.stream.state #=> String, one of "LIVE", "OFFLINE"
resp.stream.health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
resp.stream.viewer_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    Channel ARN for stream to be accessed.

Returns:

See Also:



1448
1449
1450
1451
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1448

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

#get_stream_key(params = {}) ⇒ Types::GetStreamKeyResponse

Gets stream-key information for a specified ARN.

Examples:

Request syntax with placeholder values


resp = client.get_stream_key({
  arn: "StreamKeyArn", # required
})

Response structure


resp.stream_key.arn #=> String
resp.stream_key.value #=> String
resp.stream_key.channel_arn #=> String
resp.stream_key.tags #=> Hash
resp.stream_key.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    ARN for the stream key to be retrieved.

Returns:

See Also:



1480
1481
1482
1483
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1480

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

#get_stream_session(params = {}) ⇒ Types::GetStreamSessionResponse

Gets metadata on a specified stream.

Examples:

Request syntax with placeholder values


resp = client.get_stream_session({
  channel_arn: "ChannelArn", # required
  stream_id: "StreamId",
})

Response structure


resp.stream_session.stream_id #=> String
resp.stream_session.start_time #=> Time
resp.stream_session.end_time #=> Time
resp.stream_session.channel.arn #=> String
resp.stream_session.channel.name #=> String
resp.stream_session.channel.latency_mode #=> String, one of "NORMAL", "LOW"
resp.stream_session.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
resp.stream_session.channel.recording_configuration_arn #=> String
resp.stream_session.channel.ingest_endpoint #=> String
resp.stream_session.channel.playback_url #=> String
resp.stream_session.channel.authorized #=> Boolean
resp.stream_session.channel.tags #=> Hash
resp.stream_session.channel.tags["TagKey"] #=> String
resp.stream_session.channel.insecure_ingest #=> Boolean
resp.stream_session.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
resp.stream_session.channel.srt.endpoint #=> String
resp.stream_session.channel.srt.passphrase #=> String
resp.stream_session.channel.playback_restriction_policy_arn #=> String
resp.stream_session.channel.multitrack_input_configuration.enabled #=> Boolean
resp.stream_session.channel.multitrack_input_configuration.policy #=> String, one of "ALLOW", "REQUIRE"
resp.stream_session.channel.multitrack_input_configuration.maximum_resolution #=> String, one of "SD", "HD", "FULL_HD"
resp.stream_session.channel.container_format #=> String, one of "TS", "FRAGMENTED_MP4"
resp.stream_session.channel.ad_configuration_arn #=> String
resp.stream_session.ingest_configuration.video.avc_profile #=> String
resp.stream_session.ingest_configuration.video.avc_level #=> String
resp.stream_session.ingest_configuration.video.codec #=> String
resp.stream_session.ingest_configuration.video.encoder #=> String
resp.stream_session.ingest_configuration.video.target_bitrate #=> Integer
resp.stream_session.ingest_configuration.video.target_framerate #=> Integer
resp.stream_session.ingest_configuration.video.video_height #=> Integer
resp.stream_session.ingest_configuration.video.video_width #=> Integer
resp.stream_session.ingest_configuration.video.level #=> String
resp.stream_session.ingest_configuration.video.track #=> String
resp.stream_session.ingest_configuration.video.profile #=> String
resp.stream_session.ingest_configuration.audio.codec #=> String
resp.stream_session.ingest_configuration.audio.target_bitrate #=> Integer
resp.stream_session.ingest_configuration.audio.sample_rate #=> Integer
resp.stream_session.ingest_configuration.audio.channels #=> Integer
resp.stream_session.ingest_configuration.audio.track #=> String
resp.stream_session.ingest_configurations.video_configurations #=> Array
resp.stream_session.ingest_configurations.video_configurations[0].avc_profile #=> String
resp.stream_session.ingest_configurations.video_configurations[0].avc_level #=> String
resp.stream_session.ingest_configurations.video_configurations[0].codec #=> String
resp.stream_session.ingest_configurations.video_configurations[0].encoder #=> String
resp.stream_session.ingest_configurations.video_configurations[0].target_bitrate #=> Integer
resp.stream_session.ingest_configurations.video_configurations[0].target_framerate #=> Integer
resp.stream_session.ingest_configurations.video_configurations[0].video_height #=> Integer
resp.stream_session.ingest_configurations.video_configurations[0].video_width #=> Integer
resp.stream_session.ingest_configurations.video_configurations[0].level #=> String
resp.stream_session.ingest_configurations.video_configurations[0].track #=> String
resp.stream_session.ingest_configurations.video_configurations[0].profile #=> String
resp.stream_session.ingest_configurations.audio_configurations #=> Array
resp.stream_session.ingest_configurations.audio_configurations[0].codec #=> String
resp.stream_session.ingest_configurations.audio_configurations[0].target_bitrate #=> Integer
resp.stream_session.ingest_configurations.audio_configurations[0].sample_rate #=> Integer
resp.stream_session.ingest_configurations.audio_configurations[0].channels #=> Integer
resp.stream_session.ingest_configurations.audio_configurations[0].track #=> String
resp.stream_session.recording_configuration.arn #=> String
resp.stream_session.recording_configuration.name #=> String
resp.stream_session.recording_configuration.destination_configuration.s3.bucket_name #=> String
resp.stream_session.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
resp.stream_session.recording_configuration.tags #=> Hash
resp.stream_session.recording_configuration.tags["TagKey"] #=> String
resp.stream_session.recording_configuration.thumbnail_configuration.recording_mode #=> String, one of "DISABLED", "INTERVAL"
resp.stream_session.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer
resp.stream_session.recording_configuration.thumbnail_configuration.resolution #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
resp.stream_session.recording_configuration.thumbnail_configuration.storage #=> Array
resp.stream_session.recording_configuration.thumbnail_configuration.storage[0] #=> String, one of "SEQUENTIAL", "LATEST"
resp.stream_session.recording_configuration.recording_reconnect_window_seconds #=> Integer
resp.stream_session.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM"
resp.stream_session.recording_configuration.rendition_configuration.renditions #=> Array
resp.stream_session.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
resp.stream_session.truncated_events #=> Array
resp.stream_session.truncated_events[0].name #=> String
resp.stream_session.truncated_events[0].type #=> String
resp.stream_session.truncated_events[0].event_time #=> Time
resp.stream_session.truncated_events[0].code #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    ARN of the channel resource

  • :stream_id (String) —

    Unique identifier for a live or previously live stream in the specified channel. If no streamId is provided, this returns the most recent stream session for the channel, if it exists.

Returns:

See Also:



1590
1591
1592
1593
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1590

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

#import_playback_key_pair(params = {}) ⇒ Types::ImportPlaybackKeyPairResponse

Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Examples:

Request syntax with placeholder values


resp = client.import_playback_key_pair({
  public_key_material: "PlaybackPublicKeyMaterial", # required
  name: "PlaybackKeyPairName",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.key_pair.arn #=> String
resp.key_pair.name #=> String
resp.key_pair.fingerprint #=> String
resp.key_pair.tags #=> Hash
resp.key_pair.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :public_key_material (required, String) —

    The public portion of a customer-generated key pair.

  • :name (String) —

    Playback-key-pair name. The value does not need to be unique.

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

    Any tags provided with the request are added to the playback key pair tags. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Returns:

See Also:



1649
1650
1651
1652
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1649

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

#insert_ad_break(params = {}) ⇒ Types::InsertAdBreakResponse

Inserts an ad marker in the playlist for the specified channel and duration using the ad configuration associated with the channel.

Note: AWS Elemental MediaTailor (EMT), the service that handles ad requests, provides CloudWatch metrics to help you monitor the success or failure of each InsertAdBreak operation. See Monitoring AWS Elemental MediaTailor with Amazon CloudWatch metrics in the AWS Elemental MediaTailor User Guide for details on available metrics.

Examples:

Request syntax with placeholder values


resp = client.insert_ad_break({
  channel_arn: "ChannelArn", # required
  duration_seconds: 1, # required
})

Response structure


resp.ad_break_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    ARN of the channel into which the ad break is inserted.

  • :duration_seconds (required, Integer) —

    Maximum duration of the ad break, in seconds.

Returns:

See Also:



1692
1693
1694
1695
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1692

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

#list_ad_configurations(params = {}) ⇒ Types::ListAdConfigurationsResponse

Gets summary information about all ad configurations in your account, in the AWS region where the API request is processed.

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

Examples:

Request syntax with placeholder values


resp = client.list_ad_configurations({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.ad_configurations #=> Array
resp.ad_configurations[0].arn #=> String
resp.ad_configurations[0].name #=> String
resp.ad_configurations[0].media_tailor_playback_configurations #=> Array
resp.ad_configurations[0].media_tailor_playback_configurations[0].playback_configuration_arn #=> String
resp.ad_configurations[0].tags #=> Hash
resp.ad_configurations[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The first ad configuration to retrieve. This is used for pagination; see the nextToken response field.

  • :max_results (Integer) —

    Maximum number of ad configurations to return. Default: your service quota or 100, whichever is smaller.

Returns:

See Also:



1737
1738
1739
1740
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1737

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

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

Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).

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

Examples:

Request syntax with placeholder values


resp = client.list_channels({
  filter_by_name: "ChannelName",
  filter_by_recording_configuration_arn: "ChannelRecordingConfigurationArn",
  filter_by_playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
  filter_by_ad_configuration_arn: "ChannelAdConfigurationArn",
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.channels #=> Array
resp.channels[0].arn #=> String
resp.channels[0].name #=> String
resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
resp.channels[0].authorized #=> Boolean
resp.channels[0].recording_configuration_arn #=> String
resp.channels[0].tags #=> Hash
resp.channels[0].tags["TagKey"] #=> String
resp.channels[0].insecure_ingest #=> Boolean
resp.channels[0].type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
resp.channels[0].preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
resp.channels[0].playback_restriction_policy_arn #=> String
resp.channels[0].ad_configuration_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filter_by_name (String) —

    Filters the channel list to match the specified name.

  • :filter_by_recording_configuration_arn (String) —

    Filters the channel list to match the specified recording-configuration ARN.

  • :filter_by_playback_restriction_policy_arn (String) —

    Filters the channel list to match the specified policy.

  • :filter_by_ad_configuration_arn (String) —

    Filters the channel list to match the specified ad configuration ARN.

  • :next_token (String) —

    The first channel to retrieve. This is used for pagination; see the nextToken response field.

  • :max_results (Integer) —

    Maximum number of channels to return. Default: 100.

Returns:

See Also:



1808
1809
1810
1811
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1808

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

#list_playback_key_pairs(params = {}) ⇒ Types::ListPlaybackKeyPairsResponse

Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

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

Examples:

Request syntax with placeholder values


resp = client.list_playback_key_pairs({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.key_pairs #=> Array
resp.key_pairs[0].arn #=> String
resp.key_pairs[0].name #=> String
resp.key_pairs[0].tags #=> Hash
resp.key_pairs[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The first key pair to retrieve. This is used for pagination; see the nextToken response field.

  • :max_results (Integer) —

    Maximum number of key pairs to return. Default: your service quota or 100, whichever is smaller.

Returns:

See Also:



1856
1857
1858
1859
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1856

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

#list_playback_restriction_policies(params = {}) ⇒ Types::ListPlaybackRestrictionPoliciesResponse

Gets summary information about playback restriction policies.

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

Examples:

Request syntax with placeholder values


resp = client.list_playback_restriction_policies({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.playback_restriction_policies #=> Array
resp.playback_restriction_policies[0].arn #=> String
resp.playback_restriction_policies[0].allowed_countries #=> Array
resp.playback_restriction_policies[0].allowed_countries[0] #=> String
resp.playback_restriction_policies[0].allowed_origins #=> Array
resp.playback_restriction_policies[0].allowed_origins[0] #=> String
resp.playback_restriction_policies[0].enable_strict_origin_enforcement #=> Boolean
resp.playback_restriction_policies[0].name #=> String
resp.playback_restriction_policies[0].tags #=> Hash
resp.playback_restriction_policies[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The first policy to retrieve. This is used for pagination; see the nextToken response field.

  • :max_results (Integer) —

    Maximum number of policies to return. Default: 1.

Returns:

See Also:



1902
1903
1904
1905
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1902

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

#list_recording_configurations(params = {}) ⇒ Types::ListRecordingConfigurationsResponse

Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.

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

Examples:

Request syntax with placeholder values


resp = client.list_recording_configurations({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.recording_configurations #=> Array
resp.recording_configurations[0].arn #=> String
resp.recording_configurations[0].name #=> String
resp.recording_configurations[0].destination_configuration.s3.bucket_name #=> String
resp.recording_configurations[0].state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
resp.recording_configurations[0].tags #=> Hash
resp.recording_configurations[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The first recording configuration to retrieve. This is used for pagination; see the nextToken response field.

  • :max_results (Integer) —

    Maximum number of recording configurations to return. Default: your service quota or 100, whichever is smaller.

Returns:

See Also:



1948
1949
1950
1951
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1948

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

#list_stream_keys(params = {}) ⇒ Types::ListStreamKeysResponse

Gets summary information about stream keys for the specified channel.

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

Examples:

Request syntax with placeholder values


resp = client.list_stream_keys({
  channel_arn: "ChannelArn", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.stream_keys #=> Array
resp.stream_keys[0].arn #=> String
resp.stream_keys[0].channel_arn #=> String
resp.stream_keys[0].tags #=> Hash
resp.stream_keys[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    Channel ARN used to filter the list.

  • :next_token (String) —

    The first stream key to retrieve. This is used for pagination; see the nextToken response field.

  • :max_results (Integer) —

    Maximum number of streamKeys to return. Default: 1.

Returns:

See Also:



1993
1994
1995
1996
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 1993

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

#list_stream_sessions(params = {}) ⇒ Types::ListStreamSessionsResponse

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

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

Examples:

Request syntax with placeholder values


resp = client.list_stream_sessions({
  channel_arn: "ChannelArn", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.stream_sessions #=> Array
resp.stream_sessions[0].stream_id #=> String
resp.stream_sessions[0].start_time #=> Time
resp.stream_sessions[0].end_time #=> Time
resp.stream_sessions[0].has_error_event #=> Boolean
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    Channel ARN used to filter the list.

  • :next_token (String) —

    The first stream to retrieve. This is used for pagination; see the nextToken response field.

  • :max_results (Integer) —

    Maximum number of streams to return. Default: 100.

Returns:

See Also:



2039
2040
2041
2042
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 2039

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

#list_streams(params = {}) ⇒ Types::ListStreamsResponse

Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.

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

Examples:

Request syntax with placeholder values


resp = client.list_streams({
  filter_by: {
    health: "HEALTHY", # accepts HEALTHY, STARVING, UNKNOWN
  },
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.streams #=> Array
resp.streams[0].channel_arn #=> String
resp.streams[0].stream_id #=> String
resp.streams[0].state #=> String, one of "LIVE", "OFFLINE"
resp.streams[0].health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
resp.streams[0].viewer_count #=> Integer
resp.streams[0].start_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filter_by (Types::StreamFilters) —

    Filters the stream list to match the specified criterion.

  • :next_token (String) —

    The first stream to retrieve. This is used for pagination; see the nextToken response field.

  • :max_results (Integer) —

    Maximum number of streams to return. Default: 100.

Returns:

See Also:



2089
2090
2091
2092
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 2089

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

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

Gets information about Amazon Web Services tags for the specified ARN.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to be retrieved. The ARN must be URL-encoded.

Returns:

See Also:



2118
2119
2120
2121
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 2118

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

#put_metadata(params = {}) ⇒ Struct

Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.

Examples:

Request syntax with placeholder values


resp = client.put_metadata({
  channel_arn: "ChannelArn", # required
  metadata: "StreamMetadata", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    ARN of the channel into which metadata is inserted. This channel must have an active stream.

  • :metadata (required, String) —

    Metadata to insert into the stream. Maximum: 1 KB per request.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2154
2155
2156
2157
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 2154

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

#start_viewer_session_revocation(params = {}) ⇒ Struct

Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version. For instructions on associating a viewer ID with a viewer session, see Setting Up Private Channels.

Examples:

Request syntax with placeholder values


resp = client.start_viewer_session_revocation({
  channel_arn: "ChannelArn", # required
  viewer_id: "ViewerId", # required
  viewer_session_versions_less_than_or_equal_to: 1,
})

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel associated with the viewer session to revoke.

  • :viewer_id (required, String) —

    The ID of the viewer associated with the viewer session to revoke. Do not use this field for personally identifying, confidential, or sensitive information.

  • :viewer_session_versions_less_than_or_equal_to (Integer) —

    An optional filter on which versions of the viewer session to revoke. All versions less than or equal to the specified version will be revoked. Default: 0.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2196
2197
2198
2199
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 2196

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

#stop_stream(params = {}) ⇒ Struct

Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.

Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.

Examples:

Request syntax with placeholder values


resp = client.stop_stream({
  channel_arn: "ChannelArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    ARN of the channel for which the stream is to be stopped.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2226
2227
2228
2229
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 2226

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

#tag_resource(params = {}) ⇒ Struct

Adds or updates tags for the Amazon Web Services resource with the specified ARN.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    ARN of the resource for which tags are to be added or updated. The ARN must be URL-encoded.

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

    Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2265
2266
2267
2268
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 2265

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from the resource with the specified ARN.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    ARN of the resource for which tags are to be removed. The ARN must be URL-encoded.

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

    Array of tag keys (strings) for the tags to be removed. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2300
2301
2302
2303
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 2300

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

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

Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect.

Examples:

Request syntax with placeholder values


resp = client.update_channel({
  arn: "ChannelArn", # required
  name: "ChannelName",
  latency_mode: "NORMAL", # accepts NORMAL, LOW
  type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD
  authorized: false,
  recording_configuration_arn: "ChannelRecordingConfigurationArn",
  insecure_ingest: false,
  preset: "HIGHER_BANDWIDTH_DELIVERY", # accepts HIGHER_BANDWIDTH_DELIVERY, CONSTRAINED_BANDWIDTH_DELIVERY
  playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
  multitrack_input_configuration: {
    enabled: false,
    policy: "ALLOW", # accepts ALLOW, REQUIRE
    maximum_resolution: "SD", # accepts SD, HD, FULL_HD
  },
  container_format: "TS", # accepts TS, FRAGMENTED_MP4
  ad_configuration_arn: "ChannelAdConfigurationArn",
})

Response structure


resp.channel.arn #=> String
resp.channel.name #=> String
resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
resp.channel.recording_configuration_arn #=> String
resp.channel.ingest_endpoint #=> String
resp.channel.playback_url #=> String
resp.channel.authorized #=> Boolean
resp.channel.tags #=> Hash
resp.channel.tags["TagKey"] #=> String
resp.channel.insecure_ingest #=> Boolean
resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
resp.channel.srt.endpoint #=> String
resp.channel.srt.passphrase #=> String
resp.channel.playback_restriction_policy_arn #=> String
resp.channel.multitrack_input_configuration.enabled #=> Boolean
resp.channel.multitrack_input_configuration.policy #=> String, one of "ALLOW", "REQUIRE"
resp.channel.multitrack_input_configuration.maximum_resolution #=> String, one of "SD", "HD", "FULL_HD"
resp.channel.container_format #=> String, one of "TS", "FRAGMENTED_MP4"
resp.channel.ad_configuration_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    ARN of the channel to be updated.

  • :name (String) —

    Channel name.

  • :latency_mode (String) —

    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers.

  • :type (String) —

    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

  • :authorized (Boolean) —

    Whether the channel is private (enabled for playback authorization).

  • :recording_configuration_arn (String) —

    Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.

  • :insecure_ingest (Boolean) —

    Whether the channel allows insecure RTMP and SRT ingest. Default: false.

  • :preset (String) —

    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

  • :playback_restriction_policy_arn (String) —

    Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled.

  • :multitrack_input_configuration (Types::MultitrackInputConfiguration) —

    Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.

  • :container_format (String) —

    Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.

  • :ad_configuration_arn (String) —

    ARN of the ad configuration associated with the channel.

Returns:

See Also:



2419
2420
2421
2422
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 2419

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

#update_playback_restriction_policy(params = {}) ⇒ Types::UpdatePlaybackRestrictionPolicyResponse

Updates a specified playback restriction policy.

Examples:

Request syntax with placeholder values


resp = client.update_playback_restriction_policy({
  arn: "PlaybackRestrictionPolicyArn", # required
  allowed_countries: ["PlaybackRestrictionPolicyAllowedCountry"],
  allowed_origins: ["PlaybackRestrictionPolicyAllowedOrigin"],
  enable_strict_origin_enforcement: false,
  name: "PlaybackRestrictionPolicyName",
})

Response structure


resp.playback_restriction_policy.arn #=> String
resp.playback_restriction_policy.allowed_countries #=> Array
resp.playback_restriction_policy.allowed_countries[0] #=> String
resp.playback_restriction_policy.allowed_origins #=> Array
resp.playback_restriction_policy.allowed_origins[0] #=> String
resp.playback_restriction_policy.enable_strict_origin_enforcement #=> Boolean
resp.playback_restriction_policy.name #=> String
resp.playback_restriction_policy.tags #=> Hash
resp.playback_restriction_policy.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    ARN of the playback-restriction-policy to be updated.

  • :allowed_countries (Array<String>) —

    A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).

  • :allowed_origins (Array<String>) —

    A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).

  • :enable_strict_origin_enforcement (Boolean) —

    Whether channel playback is constrained by origin site. Default: false.

  • :name (String) —

    Playback-restriction-policy name. The value does not need to be unique.

Returns:

See Also:



2486
2487
2488
2489
 
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb', line 2486

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