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

Class: Aws::KinesisVideo::Client

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



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

def initialize(*args)
  super
end

Instance Method Details

#create_stream(params = {}) ⇒ 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,
})

Response structure


resp.stream_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    To play video on the console, the media must be H.264 encoded, and you need to specify this video type in this parameter as video/h264.

    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.

Returns:

See Also:



255
256
257
258
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 255

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

#delete_stream(params = {}) ⇒ 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",
})

Parameters:

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

    ({})

Options Hash (params):

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



302
303
304
305
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 302

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

#describe_stream(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (String)

    The name of the stream.

  • :stream_arn (String)

    The Amazon Resource Name (ARN) of the stream.

Returns:

See Also:



343
344
345
346
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 343

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

#get_data_endpoint(params = {}) ⇒ 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
})

Response structure


resp.data_endpoint #=> String

Parameters:

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

    ({})

Options Hash (params):

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



393
394
395
396
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 393

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

#list_streams(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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



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

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

#list_tags_for_stream(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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



496
497
498
499
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 496

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

#tag_stream(params = {}) ⇒ 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",
  },
})

Parameters:

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

    ({})

Options Hash (params):

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



546
547
548
549
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 546

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

#untag_stream(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

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



581
582
583
584
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 581

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

#update_data_retention(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



649
650
651
652
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 649

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

#update_stream(params = {}) ⇒ 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",
})

Parameters:

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

    ({})

Options Hash (params):

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



719
720
721
722
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 719

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