Class: Aws::IVS::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

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

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

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

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

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

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

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

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

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

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

    • ‘Aws.config`

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

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

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

  • :region (required, String) —

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

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

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

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

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

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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

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

  • :endpoint (String) —

    The client endpoint is normally constructed from the ‘:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

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

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

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :token_provider (Aws::TokenProvider) —

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

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

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

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

  • :use_dualstack_endpoint (Boolean) —

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

  • :use_fips_endpoint (Boolean) —

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

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::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_proxy (URI::HTTP, String) —

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

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a ‘Timeout::Error`.

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

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

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



381
382
383
 
# File 'lib/aws-sdk-ivs/client.rb', line 381

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

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



1878
1879
1880
 
# File 'lib/aws-sdk-ivs/client.rb', line 1878

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

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



1881
1882
1883
 
# File 'lib/aws-sdk-ivs/client.rb', line 1881

def errors_module
  Errors
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.channels #=> Array
resp.channels[0].arn #=> String
resp.channels[0].authorized #=> Boolean
resp.channels[0].ingest_endpoint #=> String
resp.channels[0].insecure_ingest #=> Boolean
resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
resp.channels[0].name #=> String
resp.channels[0].playback_url #=> String
resp.channels[0].preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
resp.channels[0].recording_configuration_arn #=> String
resp.channels[0].tags #=> Hash
resp.channels[0].tags["TagKey"] #=> String
resp.channels[0].type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
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:



427
428
429
430
 
# File 'lib/aws-sdk-ivs/client.rb', line 427

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.errors #=> Array
resp.errors[0].arn #=> String
resp.errors[0].code #=> String
resp.errors[0].message #=> String
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.stream_keys[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    Array of ARNs, one per stream key.

Returns:

See Also:



465
466
467
468
 
# File 'lib/aws-sdk-ivs/client.rb', line 465

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.errors #=> Array
resp.errors[0].channel_arn #=> String
resp.errors[0].code #=> String
resp.errors[0].message #=> String
resp.errors[0].viewer_id #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



504
505
506
507
 
# File 'lib/aws-sdk-ivs/client.rb', line 504

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

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

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

Parameters:

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


1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
 
# File 'lib/aws-sdk-ivs/client.rb', line 1856

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-ivs'
  context[:gem_version] = '1.36.0'
  Seahorse::Client::Request.new(handlers, context)
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({
  authorized: false,
  insecure_ingest: false,
  latency_mode: "NORMAL", # accepts NORMAL, LOW
  name: "ChannelName",
  preset: "HIGHER_BANDWIDTH_DELIVERY", # accepts HIGHER_BANDWIDTH_DELIVERY, CONSTRAINED_BANDWIDTH_DELIVERY
  recording_configuration_arn: "ChannelRecordingConfigurationArn",
  tags: {
    "TagKey" => "TagValue",
  },
  type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD
})

Response structure


resp.channel.arn #=> String
resp.channel.authorized #=> Boolean
resp.channel.ingest_endpoint #=> String
resp.channel.insecure_ingest #=> Boolean
resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
resp.channel.name #=> String
resp.channel.playback_url #=> String
resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
resp.channel.recording_configuration_arn #=> String
resp.channel.tags #=> Hash
resp.channel.tags["TagKey"] #=> String
resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
resp.stream_key.arn #=> String
resp.stream_key.channel_arn #=> String
resp.stream_key.tags #=> Hash
resp.stream_key.tags["TagKey"] #=> String
resp.stream_key.value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :authorized (Boolean) —

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

  • :insecure_ingest (Boolean) —

    Whether the channel allows insecure RTMP ingest. Default: ‘false`.

  • :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. (Note: In the Amazon IVS console, `LOW` and `NORMAL` correspond to Ultra-low and Standard, respectively.) Default: `LOW`.

  • :name (String) —

    Channel name.

  • :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 (`“”`).

  • :recording_configuration_arn (String) —

    Recording-configuration ARN. Default: “” (empty string, recording is disabled).

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

    Array of 1-50 maps, each of the form ‘string:string (key:value)`. See

    Tagging Amazon Web Services Resources][1

    for more information,

    including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

    [1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

  • :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.* Some types generate multiple qualities (renditions) from the original input; this automatically gives viewers the best experience for their devices and network conditions. Some types provide transcoded video; transcoding allows higher playback quality across a range of download speeds. Default: ‘STANDARD`. Valid values:

    • ‘BASIC`: Video is transmuxed: Amazon IVS delivers the original input quality to viewers. The viewer’s video-quality choice is limited to the original input. Input resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p. Original audio is passed through.

    • ‘STANDARD`: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default when you create a channel.

    • ‘ADVANCED_SD`: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at SD quality (480p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available.

    • ‘ADVANCED_HD`: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at HD quality (720p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available.

    Optional *transcode presets* (available for the ‘ADVANCED` types) allow you to trade off available download bandwidth and video quality, to optimize the viewing experience. There are two presets:

    • *Constrained bandwidth delivery* uses a lower bitrate for each quality level. Use it if you have low download bandwidth and/or simple video content (e.g., talking heads)

    • *Higher bandwidth delivery* uses a higher bitrate for each quality level. Use it if you have high download bandwidth and/or complex video content (e.g., flashes and quick scene changes).

Returns:

See Also:



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

def create_channel(params = {}, options = {})
  req = build_request(:create_channel, 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({
  destination_configuration: { # required
    s3: {
      bucket_name: "S3DestinationBucketName", # required
    },
  },
  name: "RecordingConfigurationName",
  recording_reconnect_window_seconds: 1,
  tags: {
    "TagKey" => "TagValue",
  },
  thumbnail_configuration: {
    recording_mode: "DISABLED", # accepts DISABLED, INTERVAL
    target_interval_seconds: 1,
  },
})

Response structure


resp.recording_configuration.arn #=> String
resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
resp.recording_configuration.name #=> String
resp.recording_configuration.recording_reconnect_window_seconds #=> Integer
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

Parameters:

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

    ({})

Options Hash (params):

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

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

  • :name (String) —

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

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

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

    Array of 1-50 maps, each of the form ‘string:string (key:value)`. See

    Tagging Amazon Web Services Resources][1

    for more information,

    including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

    [1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

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

Returns:

See Also:



734
735
736
737
 
# File 'lib/aws-sdk-ivs/client.rb', line 734

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.channel_arn #=> String
resp.stream_key.tags #=> Hash
resp.stream_key.tags["TagKey"] #=> String
resp.stream_key.value #=> 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

    Tagging Amazon Web Services Resources][1

    for more information,

    including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

    [1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:

See Also:



787
788
789
790
 
# File 'lib/aws-sdk-ivs/client.rb', line 787

def create_stream_key(params = {}, options = {})
  req = build_request(:create_stream_key, 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].)

[1]: docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html

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:



819
820
821
822
 
# File 'lib/aws-sdk-ivs/client.rb', line 819

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*.

[1]: docs.aws.amazon.com/ivs/latest/userguide/private-channels.html

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:



848
849
850
851
 
# File 'lib/aws-sdk-ivs/client.rb', line 848

def delete_playback_key_pair(params = {}, options = {})
  req = build_request(:delete_playback_key_pair, 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:



876
877
878
879
 
# File 'lib/aws-sdk-ivs/client.rb', line 876

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:



899
900
901
902
 
# File 'lib/aws-sdk-ivs/client.rb', line 899

def delete_stream_key(params = {}, options = {})
  req = build_request(:delete_stream_key, 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.authorized #=> Boolean
resp.channel.ingest_endpoint #=> String
resp.channel.insecure_ingest #=> Boolean
resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
resp.channel.name #=> String
resp.channel.playback_url #=> String
resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
resp.channel.recording_configuration_arn #=> String
resp.channel.tags #=> Hash
resp.channel.tags["TagKey"] #=> String
resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"

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:



939
940
941
942
 
# File 'lib/aws-sdk-ivs/client.rb', line 939

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*.

[1]: docs.aws.amazon.com/ivs/latest/userguide/private-channels.html

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.fingerprint #=> String
resp.key_pair.name #=> 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:



979
980
981
982
 
# File 'lib/aws-sdk-ivs/client.rb', line 979

def get_playback_key_pair(params = {}, options = {})
  req = build_request(:get_playback_key_pair, 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.destination_configuration.s3.bucket_name #=> String
resp.recording_configuration.name #=> String
resp.recording_configuration.recording_reconnect_window_seconds #=> Integer
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

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    ARN of the recording configuration to be retrieved.

Returns:

See Also:



1015
1016
1017
1018
 
# File 'lib/aws-sdk-ivs/client.rb', line 1015

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.health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
resp.stream.playback_url #=> String
resp.stream.start_time #=> Time
resp.stream.state #=> String, one of "LIVE", "OFFLINE"
resp.stream.stream_id #=> String
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:



1050
1051
1052
1053
 
# File 'lib/aws-sdk-ivs/client.rb', line 1050

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.channel_arn #=> String
resp.stream_key.tags #=> Hash
resp.stream_key.tags["TagKey"] #=> String
resp.stream_key.value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    ARN for the stream key to be retrieved.

Returns:

See Also:



1082
1083
1084
1085
 
# File 'lib/aws-sdk-ivs/client.rb', line 1082

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.channel.arn #=> String
resp.stream_session.channel.authorized #=> Boolean
resp.stream_session.channel.ingest_endpoint #=> String
resp.stream_session.channel.insecure_ingest #=> Boolean
resp.stream_session.channel.latency_mode #=> String, one of "NORMAL", "LOW"
resp.stream_session.channel.name #=> String
resp.stream_session.channel.playback_url #=> String
resp.stream_session.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
resp.stream_session.channel.recording_configuration_arn #=> String
resp.stream_session.channel.tags #=> Hash
resp.stream_session.channel.tags["TagKey"] #=> String
resp.stream_session.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
resp.stream_session.end_time #=> Time
resp.stream_session.ingest_configuration.audio.channels #=> Integer
resp.stream_session.ingest_configuration.audio.codec #=> String
resp.stream_session.ingest_configuration.audio.sample_rate #=> Integer
resp.stream_session.ingest_configuration.audio.target_bitrate #=> Integer
resp.stream_session.ingest_configuration.video.avc_level #=> String
resp.stream_session.ingest_configuration.video.avc_profile #=> 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.recording_configuration.arn #=> String
resp.stream_session.recording_configuration.destination_configuration.s3.bucket_name #=> String
resp.stream_session.recording_configuration.name #=> String
resp.stream_session.recording_configuration.recording_reconnect_window_seconds #=> Integer
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.start_time #=> Time
resp.stream_session.stream_id #=> String
resp.stream_session.truncated_events #=> Array
resp.stream_session.truncated_events[0].event_time #=> Time
resp.stream_session.truncated_events[0].name #=> String
resp.stream_session.truncated_events[0].type #=> 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:



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

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*.

[1]: docs.aws.amazon.com/ivs/latest/userguide/private-channels.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

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

  • :public_key_material (required, String) —

    The public portion of a customer-generated key pair.

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

    Any tags provided with the request are added to the playback key pair tags. See [Tagging Amazon Web Services Resources] for more information, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

    [1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:

See Also:



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

def import_playback_key_pair(params = {}, options = {})
  req = build_request(:import_playback_key_pair, 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",
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.channels #=> Array
resp.channels[0].arn #=> String
resp.channels[0].authorized #=> Boolean
resp.channels[0].insecure_ingest #=> Boolean
resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
resp.channels[0].name #=> String
resp.channels[0].preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
resp.channels[0].recording_configuration_arn #=> String
resp.channels[0].tags #=> Hash
resp.channels[0].tags["TagKey"] #=> String
resp.channels[0].type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
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.

  • :max_results (Integer) —

    Maximum number of channels to return. Default: 100.

  • :next_token (String) —

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

Returns:

See Also:



1274
1275
1276
1277
 
# File 'lib/aws-sdk-ivs/client.rb', line 1274

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*.

[1]: docs.aws.amazon.com/ivs/latest/userguide/private-channels.html

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({
  max_results: 1,
  next_token: "PaginationToken",
})

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

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



1322
1323
1324
1325
 
# File 'lib/aws-sdk-ivs/client.rb', line 1322

def list_playback_key_pairs(params = {}, options = {})
  req = build_request(:list_playback_key_pairs, 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({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.next_token #=> String
resp.recording_configurations #=> Array
resp.recording_configurations[0].arn #=> String
resp.recording_configurations[0].destination_configuration.s3.bucket_name #=> String
resp.recording_configurations[0].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

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



1368
1369
1370
1371
 
# File 'lib/aws-sdk-ivs/client.rb', line 1368

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
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.next_token #=> String
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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    Channel ARN used to filter the list.

  • :max_results (Integer) —

    Maximum number of streamKeys to return. Default: 1.

  • :next_token (String) —

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

Returns:

See Also:



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

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
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    Channel ARN used to filter the list.

  • :max_results (Integer) —

    Maximum number of streams to return. Default: 100.

  • :next_token (String) —

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

Returns:

See Also:



1459
1460
1461
1462
 
# File 'lib/aws-sdk-ivs/client.rb', line 1459

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
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :filter_by (Types::StreamFilters) —

    Filters the stream list to match the specified criterion.

  • :max_results (Integer) —

    Maximum number of streams to return. Default: 100.

  • :next_token (String) —

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

Returns:

See Also:



1509
1510
1511
1512
 
# File 'lib/aws-sdk-ivs/client.rb', line 1509

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:



1538
1539
1540
1541
 
# File 'lib/aws-sdk-ivs/client.rb', line 1538

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*.

[1]: docs.aws.amazon.com/ivs/latest/userguide/metadata.html

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:



1574
1575
1576
1577
 
# File 'lib/aws-sdk-ivs/client.rb', line 1574

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].

[1]: docs.aws.amazon.com/ivs/latest/userguide/private-channels.html

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:



1616
1617
1618
1619
 
# File 'lib/aws-sdk-ivs/client.rb', line 1616

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.

<note markdown=“1”> 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.

</note>

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:



1646
1647
1648
1649
 
# File 'lib/aws-sdk-ivs/client.rb', line 1646

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 [Tagging Amazon Web Services Resources] for more information, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

    [1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1684
1685
1686
1687
 
# File 'lib/aws-sdk-ivs/client.rb', line 1684

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 tags to be removed. Array of maps, each of the form s`tring:string (key:value)‘. See [Tagging Amazon Web Services Resources] for more information, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

    [1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1719
1720
1721
1722
 
# File 'lib/aws-sdk-ivs/client.rb', line 1719

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
  authorized: false,
  insecure_ingest: false,
  latency_mode: "NORMAL", # accepts NORMAL, LOW
  name: "ChannelName",
  preset: "HIGHER_BANDWIDTH_DELIVERY", # accepts HIGHER_BANDWIDTH_DELIVERY, CONSTRAINED_BANDWIDTH_DELIVERY
  recording_configuration_arn: "ChannelRecordingConfigurationArn",
  type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD
})

Response structure


resp.channel.arn #=> String
resp.channel.authorized #=> Boolean
resp.channel.ingest_endpoint #=> String
resp.channel.insecure_ingest #=> Boolean
resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
resp.channel.name #=> String
resp.channel.playback_url #=> String
resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
resp.channel.recording_configuration_arn #=> String
resp.channel.tags #=> Hash
resp.channel.tags["TagKey"] #=> String
resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    ARN of the channel to be updated.

  • :authorized (Boolean) —

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

  • :insecure_ingest (Boolean) —

    Whether the channel allows insecure RTMP ingest. Default: ‘false`.

  • :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. (Note: In the Amazon IVS console, `LOW` and `NORMAL` correspond to Ultra-low and Standard, respectively.)

  • :name (String) —

    Channel name.

  • :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 (`“”`).

  • :recording_configuration_arn (String) —

    Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

  • :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.* Some types generate multiple qualities (renditions) from the original input; this automatically gives viewers the best experience for their devices and network conditions. Some types provide transcoded video; transcoding allows higher playback quality across a range of download speeds. Default: ‘STANDARD`. Valid values:

    • ‘BASIC`: Video is transmuxed: Amazon IVS delivers the original input quality to viewers. The viewer’s video-quality choice is limited to the original input. Input resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p. Original audio is passed through.

    • ‘STANDARD`: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default when you create a channel.

    • ‘ADVANCED_SD`: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at SD quality (480p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available.

    • ‘ADVANCED_HD`: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at HD quality (720p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available.

    Optional *transcode presets* (available for the ‘ADVANCED` types) allow you to trade off available download bandwidth and video quality, to optimize the viewing experience. There are two presets:

    • *Constrained bandwidth delivery* uses a lower bitrate for each quality level. Use it if you have low download bandwidth and/or simple video content (e.g., talking heads)

    • *Higher bandwidth delivery* uses a higher bitrate for each quality level. Use it if you have high download bandwidth and/or complex video content (e.g., flashes and quick scene changes).

Returns:

See Also:



1847
1848
1849
1850
 
# File 'lib/aws-sdk-ivs/client.rb', line 1847

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

#waiter_names ⇒ Object

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

Deprecated. 


1871
1872
1873
 
# File 'lib/aws-sdk-ivs/client.rb', line 1871

def waiter_names
  []
end