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

Class: Aws::KinesisVideo::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Amazon Kinesis Video Streams. To construct a client, you need to configure a :region and :credentials.

kinesisvideo = Aws::KinesisVideo::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

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

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::KinesisVideo::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::KinesisVideo::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    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. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :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 and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :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. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#create_stream(options = {}) ⇒ Types::CreateStreamOutput

Creates a new Kinesis video stream.

When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version.

CreateStream is an asynchronous operation.

For information about how the service works, see How it Works.

You must have permissions for the KinesisVideo:CreateStream action.

Examples:

Request syntax with placeholder values


resp = client.create_stream({
  device_name: "DeviceName",
  stream_name: "StreamName", # required
  media_type: "MediaType",
  kms_key_id: "KmsKeyId",
  data_retention_in_hours: 1,
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.stream_arn #=> String

Options Hash (options):

  • :device_name (String)

    The name of the device that is writing to the stream.

    In the current implementation, Kinesis Video Streams does not use this name.

  • :stream_name (required, String)

    A name for the stream that you are creating.

    The stream name is an identifier for the stream, and must be unique for each account and region.

  • :media_type (String)

    The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.

    This parameter is optional; the default value is null (or empty in JSON).

  • :kms_key_id (String)

    The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

    If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo) is used.

    For more information, see DescribeKey.

  • :data_retention_in_hours (Integer)

    The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

    The default value is 0, indicating that the stream does not persist data.

    When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

  • :tags (Hash<String,String>)

    A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

Returns:

See Also:

#delete_stream(options = {}) ⇒ Struct

Deletes a Kinesis video stream and the data contained in the stream.

This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.

To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

This operation requires permission for the KinesisVideo:DeleteStream action.

Examples:

Request syntax with placeholder values


resp = client.delete_stream({
  stream_arn: "ResourceARN", # required
  current_version: "Version",
})

Options Hash (options):

  • :stream_arn (required, String)

    The Amazon Resource Name (ARN) of the stream that you want to delete.

  • :current_version (String)

    Optional: The version of the stream that you want to delete.

    Specify the version as a safeguard to ensure that your are deleting the correct stream. To get the stream version, use the DescribeStream API.

    If not specified, only the CreationTime is checked before deleting the stream.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#describe_stream(options = {}) ⇒ Types::DescribeStreamOutput

Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.

Examples:

Request syntax with placeholder values


resp = client.describe_stream({
  stream_name: "StreamName",
  stream_arn: "ResourceARN",
})

Response structure


resp.stream_info.device_name #=> String
resp.stream_info.stream_name #=> String
resp.stream_info.stream_arn #=> String
resp.stream_info.media_type #=> String
resp.stream_info.kms_key_id #=> String
resp.stream_info.version #=> String
resp.stream_info.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING"
resp.stream_info.creation_time #=> Time
resp.stream_info.data_retention_in_hours #=> Integer

Options Hash (options):

  • :stream_name (String)

    The name of the stream.

  • :stream_arn (String)

    The Amazon Resource Name (ARN) of the stream.

Returns:

See Also:

#get_data_endpoint(options = {}) ⇒ Types::GetDataEndpointOutput

Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation).

The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint.

In the request, specify the stream either by StreamName or StreamARN.

Examples:

Request syntax with placeholder values


resp = client.get_data_endpoint({
  stream_name: "StreamName",
  stream_arn: "ResourceARN",
  api_name: "PUT_MEDIA", # required, accepts PUT_MEDIA, GET_MEDIA, LIST_FRAGMENTS, GET_MEDIA_FOR_FRAGMENT_LIST, GET_HLS_STREAMING_SESSION_URL, GET_DASH_STREAMING_SESSION_URL
})

Response structure


resp.data_endpoint #=> String

Options Hash (options):

  • :stream_name (String)

    The name of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamARN in the request.

  • :stream_arn (String)

    The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamName in the request.

  • :api_name (required, String)

    The name of the API action for which to get an endpoint.

Returns:

See Also:

#list_streams(options = {}) ⇒ Types::ListStreamsOutput

Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.

Examples:

Request syntax with placeholder values


resp = client.list_streams({
  max_results: 1,
  next_token: "NextToken",
  stream_name_condition: {
    comparison_operator: "BEGINS_WITH", # accepts BEGINS_WITH
    comparison_value: "StreamName",
  },
})

Response structure


resp.stream_info_list #=> Array
resp.stream_info_list[0].device_name #=> String
resp.stream_info_list[0].stream_name #=> String
resp.stream_info_list[0].stream_arn #=> String
resp.stream_info_list[0].media_type #=> String
resp.stream_info_list[0].kms_key_id #=> String
resp.stream_info_list[0].version #=> String
resp.stream_info_list[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING"
resp.stream_info_list[0].creation_time #=> Time
resp.stream_info_list[0].data_retention_in_hours #=> Integer
resp.next_token #=> String

Options Hash (options):

  • :max_results (Integer)

    The maximum number of streams to return in the response. The default is 10,000.

  • :next_token (String)

    If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.

  • :stream_name_condition (Types::StreamNameCondition)

    Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

Returns:

See Also:

#list_tags_for_stream(options = {}) ⇒ Types::ListTagsForStreamOutput

Returns a list of tags associated with the specified stream.

In the request, you must specify either the StreamName or the StreamARN.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_stream({
  next_token: "NextToken",
  stream_arn: "ResourceARN",
  stream_name: "StreamName",
})

Response structure


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

Options Hash (options):

  • :next_token (String)

    If you specify this parameter and the result of a ListTagsForStream call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags.

  • :stream_arn (String)

    The Amazon Resource Name (ARN) of the stream that you want to list tags for.

  • :stream_name (String)

    The name of the stream that you want to list tags for.

Returns:

See Also:

#tag_stream(options = {}) ⇒ Struct

Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

You must provide either the StreamName or the StreamARN.

This operation requires permission for the KinesisVideo:TagStream action.

Kinesis video streams support up to 50 tags.

Examples:

Request syntax with placeholder values


resp = client.tag_stream({
  stream_arn: "ResourceARN",
  stream_name: "StreamName",
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Options Hash (options):

  • :stream_arn (String)

    The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.

  • :stream_name (String)

    The name of the stream that you want to add the tag or tags to.

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

    A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#untag_stream(options = {}) ⇒ Struct

Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.

In the request, you must provide the StreamName or StreamARN.

Examples:

Request syntax with placeholder values


resp = client.untag_stream({
  stream_arn: "ResourceARN",
  stream_name: "StreamName",
  tag_key_list: ["TagKey"], # required
})

Options Hash (options):

  • :stream_arn (String)

    The Amazon Resource Name (ARN) of the stream that you want to remove tags from.

  • :stream_name (String)

    The name of the stream that you want to remove tags from.

  • :tag_key_list (required, Array<String>)

    A list of the keys of the tags that you want to remove.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_data_retention(options = {}) ⇒ Struct

Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the Operation parameter in the request body. In the request, you must specify either the StreamName or the StreamARN.

The retention period that you specify replaces the current value.

This operation requires permission for the KinesisVideo:UpdateDataRetention action.

Changing the data retention period affects the data in the stream as follows:

  • If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.

  • If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.

Examples:

Request syntax with placeholder values


resp = client.update_data_retention({
  stream_name: "StreamName",
  stream_arn: "ResourceARN",
  current_version: "Version", # required
  operation: "INCREASE_DATA_RETENTION", # required, accepts INCREASE_DATA_RETENTION, DECREASE_DATA_RETENTION
  data_retention_change_in_hours: 1, # required
})

Options Hash (options):

  • :stream_name (String)

    The name of the stream whose retention period you want to change.

  • :stream_arn (String)

    The Amazon Resource Name (ARN) of the stream whose retention period you want to change.

  • :current_version (required, String)

    The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.

  • :operation (required, String)

    Indicates whether you want to increase or decrease the retention period.

  • :data_retention_change_in_hours (required, Integer)

    The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years).

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_stream(options = {}) ⇒ Struct

Updates stream metadata, such as the device name and media type.

You must provide the stream name or the Amazon Resource Name (ARN) of the stream.

To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

UpdateStream is an asynchronous operation, and takes time to complete.

Examples:

Request syntax with placeholder values


resp = client.update_stream({
  stream_name: "StreamName",
  stream_arn: "ResourceARN",
  current_version: "Version", # required
  device_name: "DeviceName",
  media_type: "MediaType",
})

Options Hash (options):

  • :stream_name (String)

    The name of the stream whose metadata you want to update.

    The stream name is an identifier for the stream, and must be unique for each account and region.

  • :stream_arn (String)

    The ARN of the stream whose metadata you want to update.

  • :current_version (required, String)

    The version of the stream whose metadata you want to update.

  • :device_name (String)

    The name of the device that is writing to the stream.

    In the current implementation, Kinesis Video Streams does not use this name.

  • :media_type (String)

    The stream\'s media type. Use MediaType to specify the type of content that the stream contains to the consumers of the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements.

    To play video on the console, you must specify the correct video type. For example, if the video in the stream is H.264, specify video/h264 as the MediaType.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.