aws-sdk-kinesisvideo 1.20.0 → 1.25.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 4af63b21a4634b7d001d3337789e16a127ff13de
4
- data.tar.gz: 57a1fdf850575f5d7a82beb064b640dd567b06f7
2
+ SHA256:
3
+ metadata.gz: 36bef1b3796fd0239d214ee2152ddff65e1ce7b26734ebc367fb20e71772d85a
4
+ data.tar.gz: 174f5c28f53cfa7b32a8582f26aad49a853c7110fc00bb9fa234eb035a43f6c3
5
5
  SHA512:
6
- metadata.gz: 9fd1e8d6a0389c8ae470b3af446e27518b95c5fa4f6e6806b33a4f677e2fdbeb451c900fc80764474686946838724fa339c4c9c972fdea2735dc110f44bbaca1
7
- data.tar.gz: 58922d4c118303ca2183ec356fddd97b17ad5e9b004fa6e75b0f8da4f0e9fad96dd8862d104887af5a7b197ca9947f98bf80e046a5c35b3268bb18d4798f5c6d
6
+ metadata.gz: e6fdadf11ac56646a3df5d22f071c7b0873c9d0ccc40c3f74a7368ccad52f6443dd0a24bffed3774be489a221794b17b84679f8c030d5b28865df9d685f3e6ec
7
+ data.tar.gz: 94615a7865d22f7d93bca16de3a6f5aaacef0d353cb5f126f231b8de61af762e1216a53cea04ff469199efb89531b399edce339a5baffc6aa8689fef002b19ed
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-kinesisvideo/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # kinesis_video = Aws::KinesisVideo::Client.new
28
+ # resp = kinesis_video.create_signaling_channel(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon Kinesis Video Streams all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon Kinesis Video Streams are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::KinesisVideo::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon Kinesis Video Streams API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-kinesisvideo/customizations'
42
45
  # @service
43
46
  module Aws::KinesisVideo
44
47
 
45
- GEM_VERSION = '1.20.0'
48
+ GEM_VERSION = '1.25.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:kinesisvideo)
31
31
 
32
32
  module Aws::KinesisVideo
33
+ # An API client for KinesisVideo. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::KinesisVideo::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::KinesisVideo
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::KinesisVideo
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::KinesisVideo
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::KinesisVideo
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::KinesisVideo
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::KinesisVideo
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # 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.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::KinesisVideo
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -209,16 +264,15 @@ module Aws::KinesisVideo
209
264
  # requests through. Formatted like 'http://proxy.com:123'.
210
265
  #
211
266
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
267
+ # seconds to wait when opening a HTTP session before raising a
213
268
  # `Timeout::Error`.
214
269
  #
215
270
  # @option options [Integer] :http_read_timeout (60) The default
216
271
  # number of seconds to wait for response data. This value can
217
- # safely be set
218
- # per-request on the session yeidled by {#session_for}.
272
+ # safely be set per-request on the session.
219
273
  #
220
274
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
275
+ # seconds a connection is allowed to sit idle before it is
222
276
  # considered stale. Stale connections are closed and removed
223
277
  # from the pool before making a request.
224
278
  #
@@ -227,7 +281,7 @@ module Aws::KinesisVideo
227
281
  # request body. This option has no effect unless the request has
228
282
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
283
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
284
+ # request on the session.
231
285
  #
232
286
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
287
  # HTTP debug output will be sent to the `:logger`.
@@ -254,6 +308,59 @@ module Aws::KinesisVideo
254
308
 
255
309
  # @!group API Operations
256
310
 
311
+ # Creates a signaling channel.
312
+ #
313
+ # `CreateSignalingChannel` is an asynchronous operation.
314
+ #
315
+ # @option params [required, String] :channel_name
316
+ # A name for the signaling channel that you are creating. It must be
317
+ # unique for each AWS account and AWS Region.
318
+ #
319
+ # @option params [String] :channel_type
320
+ # A type of the signaling channel that you are creating. Currently,
321
+ # `SINGLE_MASTER` is the only supported channel type.
322
+ #
323
+ # @option params [Types::SingleMasterConfiguration] :single_master_configuration
324
+ # A structure containing the configuration for the `SINGLE_MASTER`
325
+ # channel type.
326
+ #
327
+ # @option params [Array<Types::Tag>] :tags
328
+ # A set of tags (key-value pairs) that you want to associate with this
329
+ # channel.
330
+ #
331
+ # @return [Types::CreateSignalingChannelOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
332
+ #
333
+ # * {Types::CreateSignalingChannelOutput#channel_arn #channel_arn} => String
334
+ #
335
+ # @example Request syntax with placeholder values
336
+ #
337
+ # resp = client.create_signaling_channel({
338
+ # channel_name: "ChannelName", # required
339
+ # channel_type: "SINGLE_MASTER", # accepts SINGLE_MASTER
340
+ # single_master_configuration: {
341
+ # message_ttl_seconds: 1,
342
+ # },
343
+ # tags: [
344
+ # {
345
+ # key: "TagKey", # required
346
+ # value: "TagValue", # required
347
+ # },
348
+ # ],
349
+ # })
350
+ #
351
+ # @example Response structure
352
+ #
353
+ # resp.channel_arn #=> String
354
+ #
355
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/CreateSignalingChannel AWS API Documentation
356
+ #
357
+ # @overload create_signaling_channel(params = {})
358
+ # @param [Hash] params ({})
359
+ def create_signaling_channel(params = {}, options = {})
360
+ req = build_request(:create_signaling_channel, params)
361
+ req.send_request(options)
362
+ end
363
+
257
364
  # Creates a new Kinesis video stream.
258
365
  #
259
366
  # When you create a new stream, Kinesis Video Streams assigns it a
@@ -290,6 +397,9 @@ module Aws::KinesisVideo
290
397
  # media types, see [Media Types][1]. If you choose to specify the
291
398
  # `MediaType`, see [Naming Requirements][2] for guidelines.
292
399
  #
400
+ # Example valid values include "video/h264" and
401
+ # "video/h264,audio/aac".
402
+ #
293
403
  # This parameter is optional; the default value is `null` (or empty in
294
404
  # JSON).
295
405
  #
@@ -359,6 +469,37 @@ module Aws::KinesisVideo
359
469
  req.send_request(options)
360
470
  end
361
471
 
472
+ # Deletes a specified signaling channel. `DeleteSignalingChannel` is an
473
+ # asynchronous operation. If you don't specify the channel's current
474
+ # version, the most recent version is deleted.
475
+ #
476
+ # @option params [required, String] :channel_arn
477
+ # The Amazon Resource Name (ARN) of the signaling channel that you want
478
+ # to delete.
479
+ #
480
+ # @option params [String] :current_version
481
+ # The current version of the signaling channel that you want to delete.
482
+ # You can obtain the current version by invoking the
483
+ # `DescribeSignalingChannel` or `ListSignalingChannels` API operations.
484
+ #
485
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
486
+ #
487
+ # @example Request syntax with placeholder values
488
+ #
489
+ # resp = client.delete_signaling_channel({
490
+ # channel_arn: "ResourceARN", # required
491
+ # current_version: "Version",
492
+ # })
493
+ #
494
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeleteSignalingChannel AWS API Documentation
495
+ #
496
+ # @overload delete_signaling_channel(params = {})
497
+ # @param [Hash] params ({})
498
+ def delete_signaling_channel(params = {}, options = {})
499
+ req = build_request(:delete_signaling_channel, params)
500
+ req.send_request(options)
501
+ end
502
+
362
503
  # Deletes a Kinesis video stream and the data contained in the stream.
363
504
  #
364
505
  # This method marks the stream for deletion, and makes the data in the
@@ -406,6 +547,46 @@ module Aws::KinesisVideo
406
547
  req.send_request(options)
407
548
  end
408
549
 
550
+ # Returns the most current information about the signaling channel. You
551
+ # must specify either the name or the Amazon Resource Name (ARN) of the
552
+ # channel that you want to describe.
553
+ #
554
+ # @option params [String] :channel_name
555
+ # The name of the signaling channel that you want to describe.
556
+ #
557
+ # @option params [String] :channel_arn
558
+ # The ARN of the signaling channel that you want to describe.
559
+ #
560
+ # @return [Types::DescribeSignalingChannelOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
561
+ #
562
+ # * {Types::DescribeSignalingChannelOutput#channel_info #channel_info} => Types::ChannelInfo
563
+ #
564
+ # @example Request syntax with placeholder values
565
+ #
566
+ # resp = client.describe_signaling_channel({
567
+ # channel_name: "ChannelName",
568
+ # channel_arn: "ResourceARN",
569
+ # })
570
+ #
571
+ # @example Response structure
572
+ #
573
+ # resp.channel_info.channel_name #=> String
574
+ # resp.channel_info.channel_arn #=> String
575
+ # resp.channel_info.channel_type #=> String, one of "SINGLE_MASTER"
576
+ # resp.channel_info.channel_status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING"
577
+ # resp.channel_info.creation_time #=> Time
578
+ # resp.channel_info.single_master_configuration.message_ttl_seconds #=> Integer
579
+ # resp.channel_info.version #=> String
580
+ #
581
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeSignalingChannel AWS API Documentation
582
+ #
583
+ # @overload describe_signaling_channel(params = {})
584
+ # @param [Hash] params ({})
585
+ def describe_signaling_channel(params = {}, options = {})
586
+ req = build_request(:describe_signaling_channel, params)
587
+ req.send_request(options)
588
+ end
589
+
409
590
  # Returns the most current information about the specified stream. You
410
591
  # must specify either the `StreamName` or the `StreamARN`.
411
592
  #
@@ -481,7 +662,7 @@ module Aws::KinesisVideo
481
662
  # resp = client.get_data_endpoint({
482
663
  # stream_name: "StreamName",
483
664
  # stream_arn: "ResourceARN",
484
- # 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
665
+ # 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, GET_CLIP
485
666
  # })
486
667
  #
487
668
  # @example Response structure
@@ -497,6 +678,115 @@ module Aws::KinesisVideo
497
678
  req.send_request(options)
498
679
  end
499
680
 
681
+ # Provides an endpoint for the specified signaling channel to send and
682
+ # receive messages. This API uses the
683
+ # `SingleMasterChannelEndpointConfiguration` input parameter, which
684
+ # consists of the `Protocols` and `Role` properties.
685
+ #
686
+ # `Protocols` is used to determine the communication mechanism. For
687
+ # example, if you specify `WSS` as the protocol, this API produces a
688
+ # secure websocket endpoint. If you specify `HTTPS` as the protocol,
689
+ # this API generates an HTTPS endpoint.
690
+ #
691
+ # `Role` determines the messaging permissions. A `MASTER` role results
692
+ # in this API generating an endpoint that a client can use to
693
+ # communicate with any of the viewers on the channel. A `VIEWER` role
694
+ # results in this API generating an endpoint that a client can use to
695
+ # communicate only with a `MASTER`.
696
+ #
697
+ # @option params [required, String] :channel_arn
698
+ # The Amazon Resource Name (ARN) of the signalling channel for which you
699
+ # want to get an endpoint.
700
+ #
701
+ # @option params [Types::SingleMasterChannelEndpointConfiguration] :single_master_channel_endpoint_configuration
702
+ # A structure containing the endpoint configuration for the
703
+ # `SINGLE_MASTER` channel type.
704
+ #
705
+ # @return [Types::GetSignalingChannelEndpointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
706
+ #
707
+ # * {Types::GetSignalingChannelEndpointOutput#resource_endpoint_list #resource_endpoint_list} => Array&lt;Types::ResourceEndpointListItem&gt;
708
+ #
709
+ # @example Request syntax with placeholder values
710
+ #
711
+ # resp = client.get_signaling_channel_endpoint({
712
+ # channel_arn: "ResourceARN", # required
713
+ # single_master_channel_endpoint_configuration: {
714
+ # protocols: ["WSS"], # accepts WSS, HTTPS
715
+ # role: "MASTER", # accepts MASTER, VIEWER
716
+ # },
717
+ # })
718
+ #
719
+ # @example Response structure
720
+ #
721
+ # resp.resource_endpoint_list #=> Array
722
+ # resp.resource_endpoint_list[0].protocol #=> String, one of "WSS", "HTTPS"
723
+ # resp.resource_endpoint_list[0].resource_endpoint #=> String
724
+ #
725
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint AWS API Documentation
726
+ #
727
+ # @overload get_signaling_channel_endpoint(params = {})
728
+ # @param [Hash] params ({})
729
+ def get_signaling_channel_endpoint(params = {}, options = {})
730
+ req = build_request(:get_signaling_channel_endpoint, params)
731
+ req.send_request(options)
732
+ end
733
+
734
+ # Returns an array of `ChannelInfo` objects. Each object describes a
735
+ # signaling channel. To retrieve only those channels that satisfy a
736
+ # specific condition, you can specify a `ChannelNameCondition`.
737
+ #
738
+ # @option params [Integer] :max_results
739
+ # The maximum number of channels to return in the response. The default
740
+ # is 500.
741
+ #
742
+ # @option params [String] :next_token
743
+ # If you specify this parameter, when the result of a
744
+ # `ListSignalingChannels` operation is truncated, the call returns the
745
+ # `NextToken` in the response. To get another batch of channels, provide
746
+ # this token in your next request.
747
+ #
748
+ # @option params [Types::ChannelNameCondition] :channel_name_condition
749
+ # Optional: Returns only the channels that satisfy a specific condition.
750
+ #
751
+ # @return [Types::ListSignalingChannelsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
752
+ #
753
+ # * {Types::ListSignalingChannelsOutput#channel_info_list #channel_info_list} => Array&lt;Types::ChannelInfo&gt;
754
+ # * {Types::ListSignalingChannelsOutput#next_token #next_token} => String
755
+ #
756
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
757
+ #
758
+ # @example Request syntax with placeholder values
759
+ #
760
+ # resp = client.list_signaling_channels({
761
+ # max_results: 1,
762
+ # next_token: "NextToken",
763
+ # channel_name_condition: {
764
+ # comparison_operator: "BEGINS_WITH", # accepts BEGINS_WITH
765
+ # comparison_value: "ChannelName",
766
+ # },
767
+ # })
768
+ #
769
+ # @example Response structure
770
+ #
771
+ # resp.channel_info_list #=> Array
772
+ # resp.channel_info_list[0].channel_name #=> String
773
+ # resp.channel_info_list[0].channel_arn #=> String
774
+ # resp.channel_info_list[0].channel_type #=> String, one of "SINGLE_MASTER"
775
+ # resp.channel_info_list[0].channel_status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING"
776
+ # resp.channel_info_list[0].creation_time #=> Time
777
+ # resp.channel_info_list[0].single_master_configuration.message_ttl_seconds #=> Integer
778
+ # resp.channel_info_list[0].version #=> String
779
+ # resp.next_token #=> String
780
+ #
781
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListSignalingChannels AWS API Documentation
782
+ #
783
+ # @overload list_signaling_channels(params = {})
784
+ # @param [Hash] params ({})
785
+ def list_signaling_channels(params = {}, options = {})
786
+ req = build_request(:list_signaling_channels, params)
787
+ req.send_request(options)
788
+ end
789
+
500
790
  # Returns an array of `StreamInfo` objects. Each object describes a
501
791
  # stream. To retrieve only streams that satisfy a specific condition,
502
792
  # you can specify a `StreamNameCondition`.
@@ -521,6 +811,8 @@ module Aws::KinesisVideo
521
811
  # * {Types::ListStreamsOutput#stream_info_list #stream_info_list} => Array&lt;Types::StreamInfo&gt;
522
812
  # * {Types::ListStreamsOutput#next_token #next_token} => String
523
813
  #
814
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
815
+ #
524
816
  # @example Request syntax with placeholder values
525
817
  #
526
818
  # resp = client.list_streams({
@@ -555,6 +847,45 @@ module Aws::KinesisVideo
555
847
  req.send_request(options)
556
848
  end
557
849
 
850
+ # Returns a list of tags associated with the specified signaling
851
+ # channel.
852
+ #
853
+ # @option params [String] :next_token
854
+ # If you specify this parameter and the result of a
855
+ # `ListTagsForResource` call is truncated, the response includes a token
856
+ # that you can use in the next request to fetch the next batch of tags.
857
+ #
858
+ # @option params [required, String] :resource_arn
859
+ # The Amazon Resource Name (ARN) of the signaling channel for which you
860
+ # want to list tags.
861
+ #
862
+ # @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
863
+ #
864
+ # * {Types::ListTagsForResourceOutput#next_token #next_token} => String
865
+ # * {Types::ListTagsForResourceOutput#tags #tags} => Hash&lt;String,String&gt;
866
+ #
867
+ # @example Request syntax with placeholder values
868
+ #
869
+ # resp = client.list_tags_for_resource({
870
+ # next_token: "NextToken",
871
+ # resource_arn: "ResourceARN", # required
872
+ # })
873
+ #
874
+ # @example Response structure
875
+ #
876
+ # resp.next_token #=> String
877
+ # resp.tags #=> Hash
878
+ # resp.tags["TagKey"] #=> String
879
+ #
880
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListTagsForResource AWS API Documentation
881
+ #
882
+ # @overload list_tags_for_resource(params = {})
883
+ # @param [Hash] params ({})
884
+ def list_tags_for_resource(params = {}, options = {})
885
+ req = build_request(:list_tags_for_resource, params)
886
+ req.send_request(options)
887
+ end
888
+
558
889
  # Returns a list of tags associated with the specified stream.
559
890
  #
560
891
  # In the request, you must specify either the `StreamName` or the
@@ -600,6 +931,48 @@ module Aws::KinesisVideo
600
931
  req.send_request(options)
601
932
  end
602
933
 
934
+ # Adds one or more tags to a signaling channel. A *tag* is a key-value
935
+ # pair (the value is optional) that you can define and assign to AWS
936
+ # resources. If you specify a tag that already exists, the tag value is
937
+ # replaced with the value that you specify in the request. For more
938
+ # information, see [Using Cost Allocation Tags][1] in the *AWS Billing
939
+ # and Cost Management User Guide*.
940
+ #
941
+ #
942
+ #
943
+ # [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html
944
+ #
945
+ # @option params [required, String] :resource_arn
946
+ # The Amazon Resource Name (ARN) of the signaling channel to which you
947
+ # want to add tags.
948
+ #
949
+ # @option params [required, Array<Types::Tag>] :tags
950
+ # A list of tags to associate with the specified signaling channel. Each
951
+ # tag is a key-value pair.
952
+ #
953
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
954
+ #
955
+ # @example Request syntax with placeholder values
956
+ #
957
+ # resp = client.tag_resource({
958
+ # resource_arn: "ResourceARN", # required
959
+ # tags: [ # required
960
+ # {
961
+ # key: "TagKey", # required
962
+ # value: "TagValue", # required
963
+ # },
964
+ # ],
965
+ # })
966
+ #
967
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/TagResource AWS API Documentation
968
+ #
969
+ # @overload tag_resource(params = {})
970
+ # @param [Hash] params ({})
971
+ def tag_resource(params = {}, options = {})
972
+ req = build_request(:tag_resource, params)
973
+ req.send_request(options)
974
+ end
975
+
603
976
  # Adds one or more tags to a stream. A *tag* is a key-value pair (the
604
977
  # value is optional) that you can define and assign to AWS resources. If
605
978
  # you specify a tag that already exists, the tag value is replaced with
@@ -650,6 +1023,35 @@ module Aws::KinesisVideo
650
1023
  req.send_request(options)
651
1024
  end
652
1025
 
1026
+ # Removes one or more tags from a signaling channel. In the request,
1027
+ # specify only a tag key or keys; don't specify the value. If you
1028
+ # specify a tag key that does not exist, it's ignored.
1029
+ #
1030
+ # @option params [required, String] :resource_arn
1031
+ # The Amazon Resource Name (ARN) of the signaling channel from which you
1032
+ # want to remove tags.
1033
+ #
1034
+ # @option params [required, Array<String>] :tag_key_list
1035
+ # A list of the keys of the tags that you want to remove.
1036
+ #
1037
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1038
+ #
1039
+ # @example Request syntax with placeholder values
1040
+ #
1041
+ # resp = client.untag_resource({
1042
+ # resource_arn: "ResourceARN", # required
1043
+ # tag_key_list: ["TagKey"], # required
1044
+ # })
1045
+ #
1046
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UntagResource AWS API Documentation
1047
+ #
1048
+ # @overload untag_resource(params = {})
1049
+ # @param [Hash] params ({})
1050
+ def untag_resource(params = {}, options = {})
1051
+ req = build_request(:untag_resource, params)
1052
+ req.send_request(options)
1053
+ end
1054
+
653
1055
  # Removes one or more tags from a stream. In the request, specify only a
654
1056
  # tag key or keys; don't specify the value. If you specify a tag key
655
1057
  # that does not exist, it's ignored.
@@ -754,6 +1156,46 @@ module Aws::KinesisVideo
754
1156
  req.send_request(options)
755
1157
  end
756
1158
 
1159
+ # Updates the existing signaling channel. This is an asynchronous
1160
+ # operation and takes time to complete.
1161
+ #
1162
+ # If the `MessageTtlSeconds` value is updated (either increased or
1163
+ # reduced), it only applies to new messages sent via this channel after
1164
+ # it's been updated. Existing messages are still expired as per the
1165
+ # previous `MessageTtlSeconds` value.
1166
+ #
1167
+ # @option params [required, String] :channel_arn
1168
+ # The Amazon Resource Name (ARN) of the signaling channel that you want
1169
+ # to update.
1170
+ #
1171
+ # @option params [required, String] :current_version
1172
+ # The current version of the signaling channel that you want to update.
1173
+ #
1174
+ # @option params [Types::SingleMasterConfiguration] :single_master_configuration
1175
+ # The structure containing the configuration for the `SINGLE_MASTER`
1176
+ # type of the signaling channel that you want to update.
1177
+ #
1178
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1179
+ #
1180
+ # @example Request syntax with placeholder values
1181
+ #
1182
+ # resp = client.update_signaling_channel({
1183
+ # channel_arn: "ResourceARN", # required
1184
+ # current_version: "Version", # required
1185
+ # single_master_configuration: {
1186
+ # message_ttl_seconds: 1,
1187
+ # },
1188
+ # })
1189
+ #
1190
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateSignalingChannel AWS API Documentation
1191
+ #
1192
+ # @overload update_signaling_channel(params = {})
1193
+ # @param [Hash] params ({})
1194
+ def update_signaling_channel(params = {}, options = {})
1195
+ req = build_request(:update_signaling_channel, params)
1196
+ req.send_request(options)
1197
+ end
1198
+
757
1199
  # Updates stream metadata, such as the device name and media type.
758
1200
  #
759
1201
  # You must provide the stream name or the Amazon Resource Name (ARN) of
@@ -837,7 +1279,7 @@ module Aws::KinesisVideo
837
1279
  params: params,
838
1280
  config: config)
839
1281
  context[:gem_name] = 'aws-sdk-kinesisvideo'
840
- context[:gem_version] = '1.20.0'
1282
+ context[:gem_version] = '1.25.0'
841
1283
  Seahorse::Client::Request.new(handlers, context)
842
1284
  end
843
1285