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_edge_configuration(params = {}) ⇒ Types::DescribeEdgeConfigurationOutput
Describes a stream’s edge configuration that was set using the
StartEdgeConfigurationUpdate
API. -
#describe_image_generation_configuration(params = {}) ⇒ Types::DescribeImageGenerationConfigurationOutput
Gets the
ImageGenerationConfiguration
for a given Kinesis video stream. -
#describe_mapped_resource_configuration(params = {}) ⇒ Types::DescribeMappedResourceConfigurationOutput
Returns the most current information about the stream.
-
#describe_media_storage_configuration(params = {}) ⇒ Types::DescribeMediaStorageConfigurationOutput
Returns the most current information about the channel.
-
#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.
-
#start_edge_configuration_update(params = {}) ⇒ Types::StartEdgeConfigurationUpdateOutput
An asynchronous API that updates a stream’s existing edge configuration.
-
#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_media_storage_configuration(params = {}) ⇒ Struct
Associates a
SignalingChannel
to a stream to store the media. -
#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.
365 366 367 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 365 def initialize(*args) super end |
Instance Method Details
#create_signaling_channel(params = {}) ⇒ Types::CreateSignalingChannelOutput
Creates a signaling channel.
CreateSignalingChannel
is an asynchronous operation.
420 421 422 423 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 420 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.
528 529 530 531 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 528 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.
559 560 561 562 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 559 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.
606 607 608 609 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 606 def delete_stream(params = {}, = {}) req = build_request(:delete_stream, params) req.send_request() end |
#describe_edge_configuration(params = {}) ⇒ Types::DescribeEdgeConfigurationOutput
Describes a stream’s edge configuration that was set using the
StartEdgeConfigurationUpdate
API. Use this API to get the status of
the configuration if the configuration is in sync with the Edge Agent.
664 665 666 667 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 664 def describe_edge_configuration(params = {}, = {}) req = build_request(:describe_edge_configuration, params) req.send_request() end |
#describe_image_generation_configuration(params = {}) ⇒ Types::DescribeImageGenerationConfigurationOutput
Gets the ImageGenerationConfiguration
for a given Kinesis video
stream.
710 711 712 713 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 710 def describe_image_generation_configuration(params = {}, = {}) req = build_request(:describe_image_generation_configuration, params) req.send_request() end |
#describe_mapped_resource_configuration(params = {}) ⇒ Types::DescribeMappedResourceConfigurationOutput
Returns the most current information about the stream. Either streamName or streamARN should be provided in the input.
Returns the most current information about the stream. The
streamName
or streamARN
should be provided in the input.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
761 762 763 764 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 761 def describe_mapped_resource_configuration(params = {}, = {}) req = build_request(:describe_mapped_resource_configuration, params) req.send_request() end |
#describe_media_storage_configuration(params = {}) ⇒ Types::DescribeMediaStorageConfigurationOutput
Returns the most current information about the channel. Specify the
ChannelName
or ChannelARN
in the input.
795 796 797 798 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 795 def describe_media_storage_configuration(params = {}, = {}) req = build_request(:describe_media_storage_configuration, params) req.send_request() end |
#describe_notification_configuration(params = {}) ⇒ Types::DescribeNotificationConfigurationOutput
Gets the NotificationConfiguration
for a given Kinesis video stream.
832 833 834 835 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 832 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.
872 873 874 875 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 872 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
.
913 914 915 916 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 913 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
.
963 964 965 966 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 963 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
.
1016 1017 1018 1019 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1016 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.
1072 1073 1074 1075 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1072 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.
1132 1133 1134 1135 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1132 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.
1171 1172 1173 1174 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1171 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
.
1216 1217 1218 1219 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1216 def (params = {}, = {}) req = build_request(:list_tags_for_stream, params) req.send_request() end |
#start_edge_configuration_update(params = {}) ⇒ Types::StartEdgeConfigurationUpdateOutput
An asynchronous API that updates a stream’s existing edge
configuration. The Kinesis Video Stream will sync the stream’s edge
configuration with the Edge Agent IoT Greengrass component that runs
on an IoT Hub Device, setup at your premise. The time to sync can vary
and depends on the connectivity of the Hub Device. The SyncStatus
will be updated as the edge configuration is acknowledged, and synced
with the Edge Agent.
If this API is invoked for the first time, a new edge configuration
will be created for the stream, and the sync status will be set to
SYNCING
. You will have to wait for the sync status to reach a
terminal state such as: IN_SYNC
, or SYNC_FAILED
, before using this
API again. If you invoke this API during the syncing process, a
ResourceInUseException
will be thrown. The connectivity of the
stream’s edge configuration and the Edge Agent will be retried for 15
minutes. After 15 minutes, the status will transition into the
SYNC_FAILED
state.
1318 1319 1320 1321 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1318 def start_edge_configuration_update(params = {}, = {}) req = build_request(:start_edge_configuration_update, 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.
1360 1361 1362 1363 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1360 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.
1410 1411 1412 1413 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1410 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.
1439 1440 1441 1442 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1439 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
.
1474 1475 1476 1477 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1474 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.
1543 1544 1545 1546 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1543 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.
1593 1594 1595 1596 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1593 def update_image_generation_configuration(params = {}, = {}) req = build_request(:update_image_generation_configuration, params) req.send_request() end |
#update_media_storage_configuration(params = {}) ⇒ Struct
Associates a SignalingChannel
to a stream to store the media. There
are two signaling modes that can specified :
If the
StorageStatus
is disabled, no data will be stored, and theStreamARN
parameter will not be needed.If the
StorageStatus
is enabled, the data will be stored in theStreamARN
provided.
1630 1631 1632 1633 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1630 def update_media_storage_configuration(params = {}, = {}) req = build_request(:update_media_storage_configuration, params) req.send_request() end |
#update_notification_configuration(params = {}) ⇒ Struct
Updates the notification information for a stream.
1671 1672 1673 1674 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1671 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.
1711 1712 1713 1714 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1711 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.
1781 1782 1783 1784 |
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/client.rb', line 1781 def update_stream(params = {}, = {}) req = build_request(:update_stream, params) req.send_request() end |