Class: Aws::KinesisVideo::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::KinesisVideo::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb
Overview
An API client for KinesisVideo. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::KinesisVideo::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_signaling_channel(params = {}) ⇒ Types::CreateSignalingChannelOutput
Creates a signaling channel.
-
#create_stream(params = {}) ⇒ Types::CreateStreamOutput
Creates a new Kinesis video stream.
-
#delete_signaling_channel(params = {}) ⇒ Struct
Deletes a specified signaling channel.
-
#delete_stream(params = {}) ⇒ Struct
Deletes a Kinesis video stream and the data contained in the stream.
-
#describe_image_generation_configuration(params = {}) ⇒ Types::DescribeImageGenerationConfigurationOutput
Gets the
ImageGenerationConfiguration
for a given Kinesis video stream. -
#describe_notification_configuration(params = {}) ⇒ Types::DescribeNotificationConfigurationOutput
Gets the
NotificationConfiguration
for a given Kinesis video stream. -
#describe_signaling_channel(params = {}) ⇒ Types::DescribeSignalingChannelOutput
Returns the most current information about the signaling channel.
-
#describe_stream(params = {}) ⇒ Types::DescribeStreamOutput
Returns the most current information about the specified stream.
-
#get_data_endpoint(params = {}) ⇒ Types::GetDataEndpointOutput
Gets an endpoint for a specified stream for either reading or writing.
-
#get_signaling_channel_endpoint(params = {}) ⇒ Types::GetSignalingChannelEndpointOutput
Provides an endpoint for the specified signaling channel to send and receive messages.
-
#list_signaling_channels(params = {}) ⇒ Types::ListSignalingChannelsOutput
Returns an array of
ChannelInfo
objects. -
#list_streams(params = {}) ⇒ Types::ListStreamsOutput
Returns an array of
StreamInfo
objects. -
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Returns a list of tags associated with the specified signaling channel.
-
#list_tags_for_stream(params = {}) ⇒ Types::ListTagsForStreamOutput
Returns a list of tags associated with the specified stream.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to a signaling channel.
-
#tag_stream(params = {}) ⇒ Struct
Adds one or more tags to a stream.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a signaling channel.
-
#untag_stream(params = {}) ⇒ Struct
Removes one or more tags from a stream.
-
#update_data_retention(params = {}) ⇒ Struct
Increases or decreases the stream's data retention period by the value that you specify.
-
#update_image_generation_configuration(params = {}) ⇒ Struct
Updates the
StreamInfo
andImageProcessingConfiguration
fields. -
#update_notification_configuration(params = {}) ⇒ Struct
Updates the notification information for a stream.
-
#update_signaling_channel(params = {}) ⇒ Struct
Updates the existing signaling channel.
-
#update_stream(params = {}) ⇒ Struct
Updates stream metadata, such as the device name and media type.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
348 349 350 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 348 def initialize(*args) super end |
Instance Method Details
#create_signaling_channel(params = {}) ⇒ Types::CreateSignalingChannelOutput
Creates a signaling channel.
CreateSignalingChannel
is an asynchronous operation.
403 404 405 406 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 403 def create_signaling_channel(params = {}, = {}) req = build_request(:create_signaling_channel, params) req.send_request() end |
#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.
511 512 513 514 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 511 def create_stream(params = {}, = {}) req = build_request(:create_stream, params) req.send_request() end |
#delete_signaling_channel(params = {}) ⇒ Struct
Deletes a specified signaling channel. DeleteSignalingChannel
is an
asynchronous operation. If you don't specify the channel's current
version, the most recent version is deleted.
542 543 544 545 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 542 def delete_signaling_channel(params = {}, = {}) req = build_request(:delete_signaling_channel, params) req.send_request() 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.
589 590 591 592 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 589 def delete_stream(params = {}, = {}) req = build_request(:delete_stream, params) req.send_request() end |
#describe_image_generation_configuration(params = {}) ⇒ Types::DescribeImageGenerationConfigurationOutput
Gets the ImageGenerationConfiguration
for a given Kinesis video
stream.
635 636 637 638 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 635 def describe_image_generation_configuration(params = {}, = {}) req = build_request(:describe_image_generation_configuration, params) req.send_request() end |
#describe_notification_configuration(params = {}) ⇒ Types::DescribeNotificationConfigurationOutput
Gets the NotificationConfiguration
for a given Kinesis video stream.
672 673 674 675 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 672 def describe_notification_configuration(params = {}, = {}) req = build_request(:describe_notification_configuration, params) req.send_request() end |
#describe_signaling_channel(params = {}) ⇒ Types::DescribeSignalingChannelOutput
Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.
712 713 714 715 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 712 def describe_signaling_channel(params = {}, = {}) req = build_request(:describe_signaling_channel, params) req.send_request() end |
#describe_stream(params = {}) ⇒ Types::DescribeStreamOutput
Returns the most current information about the specified stream. You
must specify either the StreamName
or the StreamARN
.
753 754 755 756 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 753 def describe_stream(params = {}, = {}) req = build_request(:describe_stream, params) req.send_request() 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).
In the request, specify the stream either by StreamName
or
StreamARN
.
803 804 805 806 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 803 def get_data_endpoint(params = {}, = {}) req = build_request(:get_data_endpoint, params) req.send_request() end |
#get_signaling_channel_endpoint(params = {}) ⇒ Types::GetSignalingChannelEndpointOutput
Provides an endpoint for the specified signaling channel to send and
receive messages. This API uses the
SingleMasterChannelEndpointConfiguration
input parameter, which
consists of the Protocols
and Role
properties.
Protocols
is used to determine the communication mechanism. For
example, if you specify WSS
as the protocol, this API produces a
secure websocket endpoint. If you specify HTTPS
as the protocol,
this API generates an HTTPS endpoint.
Role
determines the messaging permissions. A MASTER
role results
in this API generating an endpoint that a client can use to
communicate with any of the viewers on the channel. A VIEWER
role
results in this API generating an endpoint that a client can use to
communicate only with a MASTER
.
856 857 858 859 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 856 def get_signaling_channel_endpoint(params = {}, = {}) req = build_request(:get_signaling_channel_endpoint, params) req.send_request() end |
#list_signaling_channels(params = {}) ⇒ Types::ListSignalingChannelsOutput
Returns an array of ChannelInfo
objects. Each object describes a
signaling channel. To retrieve only those channels that satisfy a
specific condition, you can specify a ChannelNameCondition
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
912 913 914 915 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 912 def list_signaling_channels(params = {}, = {}) req = build_request(:list_signaling_channels, params) req.send_request() 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
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
972 973 974 975 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 972 def list_streams(params = {}, = {}) req = build_request(:list_streams, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Returns a list of tags associated with the specified signaling channel.
1011 1012 1013 1014 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1011 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() 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
.
1056 1057 1058 1059 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1056 def (params = {}, = {}) req = build_request(:list_tags_for_stream, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services 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 Billing and Cost Management and Cost Management User Guide.
1098 1099 1100 1101 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1098 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() 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 Amazon Web Services 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 Billing and Cost Management and Cost Management User Guide.
You must provide either the StreamName
or the StreamARN
.
This operation requires permission for the KinesisVideo:TagStream
action.
A Kinesis video stream can support up to 50 tags.
1148 1149 1150 1151 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1148 def tag_stream(params = {}, = {}) req = build_request(:tag_stream, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a signaling channel. 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.
1177 1178 1179 1180 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1177 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() 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
.
1212 1213 1214 1215 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1212 def untag_stream(params = {}, = {}) req = build_request(:untag_stream, params) req.send_request() 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
.
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.
1281 1282 1283 1284 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1281 def update_data_retention(params = {}, = {}) req = build_request(:update_data_retention, params) req.send_request() end |
#update_image_generation_configuration(params = {}) ⇒ Struct
Updates the StreamInfo
and ImageProcessingConfiguration
fields.
1331 1332 1333 1334 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1331 def update_image_generation_configuration(params = {}, = {}) req = build_request(:update_image_generation_configuration, params) req.send_request() end |
#update_notification_configuration(params = {}) ⇒ Struct
Updates the notification information for a stream.
1372 1373 1374 1375 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1372 def update_notification_configuration(params = {}, = {}) req = build_request(:update_notification_configuration, params) req.send_request() end |
#update_signaling_channel(params = {}) ⇒ Struct
Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.
If the MessageTtlSeconds
value is updated (either increased or
reduced), it only applies to new messages sent via this channel after
it's been updated. Existing messages are still expired as per the
previous MessageTtlSeconds
value.
1412 1413 1414 1415 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1412 def update_signaling_channel(params = {}, = {}) req = build_request(:update_signaling_channel, params) req.send_request() 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.
1482 1483 1484 1485 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1482 def update_stream(params = {}, = {}) req = build_request(:update_stream, params) req.send_request() end |