aws-sdk-kinesisvideo 1.21.0 → 1.26.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-kinesisvideo.rb +7 -4
- data/lib/aws-sdk-kinesisvideo/client.rb +101 -36
- data/lib/aws-sdk-kinesisvideo/client_api.rb +2 -0
- data/lib/aws-sdk-kinesisvideo/errors.rb +35 -13
- data/lib/aws-sdk-kinesisvideo/resource.rb +1 -0
- data/lib/aws-sdk-kinesisvideo/types.rb +26 -19
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: e7a10ce05364abf4e4b43eed8eac1dadf657322f5afccb707acab07e6c7f3071
|
4
|
+
data.tar.gz: e84409b079cb7fee57314e7351790c019959a2d91404bce422caaa7e67e16d84
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ced861a4fdd4a09b458842302d5e4f376013fdd94d61dab09bbf4776470d251245ceb84b0570e4dc6b70f43533967ed250793d9cf1d93e1a12c8c8ac1ff0c876
|
7
|
+
data.tar.gz: c9f845af80711127a24764c2f8e2d29792b9efd7cae0cdf9eedea3971e5daa720b08f058b102e7a65fcb132cba3e8e3cf65b021f246e052c05f002914ebb927e
|
data/lib/aws-sdk-kinesisvideo.rb
CHANGED
@@ -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
|
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
|
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.
|
48
|
+
GEM_VERSION = '1.26.1'
|
46
49
|
|
47
50
|
end
|
@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
24
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
25
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
26
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
27
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
28
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
29
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
29
30
|
|
30
31
|
Aws::Plugins::GlobalConfiguration.add_identifier(:kinesisvideo)
|
31
32
|
|
32
33
|
module Aws::KinesisVideo
|
34
|
+
# An API client for KinesisVideo. To construct a client, you need to configure a `:region` and `:credentials`.
|
35
|
+
#
|
36
|
+
# client = Aws::KinesisVideo::Client.new(
|
37
|
+
# region: region_name,
|
38
|
+
# credentials: credentials,
|
39
|
+
# # ...
|
40
|
+
# )
|
41
|
+
#
|
42
|
+
# For details on configuring region and credentials see
|
43
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
44
|
+
#
|
45
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
46
|
class Client < Seahorse::Client::Base
|
34
47
|
|
35
48
|
include Aws::ClientStubs
|
@@ -57,6 +70,7 @@ module Aws::KinesisVideo
|
|
57
70
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
58
71
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
59
72
|
add_plugin(Aws::Plugins::TransferEncoding)
|
73
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
60
74
|
add_plugin(Aws::Plugins::SignatureV4)
|
61
75
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
62
76
|
|
@@ -93,7 +107,7 @@ module Aws::KinesisVideo
|
|
93
107
|
# @option options [required, String] :region
|
94
108
|
# The AWS region to connect to. The configured `:region` is
|
95
109
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
110
|
+
# a default `:region` is searched for in the following locations:
|
97
111
|
#
|
98
112
|
# * `Aws.config[:region]`
|
99
113
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +122,12 @@ module Aws::KinesisVideo
|
|
108
122
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
123
|
# the background every 60 secs (default). Defaults to `false`.
|
110
124
|
#
|
125
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
126
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
127
|
+
# until there is sufficent client side capacity to retry the request.
|
128
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
129
|
+
# not retry instead of sleeping.
|
130
|
+
#
|
111
131
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
132
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
133
|
# this client.
|
@@ -132,6 +152,10 @@ module Aws::KinesisVideo
|
|
132
152
|
# When `true`, an attempt is made to coerce request parameters into
|
133
153
|
# the required types.
|
134
154
|
#
|
155
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
156
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
157
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
158
|
+
#
|
135
159
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
160
|
# Set to true to disable SDK automatically adding host prefix
|
137
161
|
# to default service endpoint when available.
|
@@ -139,7 +163,7 @@ module Aws::KinesisVideo
|
|
139
163
|
# @option options [String] :endpoint
|
140
164
|
# The client endpoint is normally constructed from the `:region`
|
141
165
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
166
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
143
167
|
#
|
144
168
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
169
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +178,7 @@ module Aws::KinesisVideo
|
|
154
178
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
179
|
#
|
156
180
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
181
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
182
|
#
|
159
183
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
184
|
# The log formatter.
|
@@ -166,15 +190,29 @@ module Aws::KinesisVideo
|
|
166
190
|
# The Logger instance to send log messages to. If this option
|
167
191
|
# is not set, logging will be disabled.
|
168
192
|
#
|
193
|
+
# @option options [Integer] :max_attempts (3)
|
194
|
+
# An integer representing the maximum number attempts that will be made for
|
195
|
+
# a single request, including the initial attempt. For example,
|
196
|
+
# setting this value to 5 will result in a request being retried up to
|
197
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
198
|
+
#
|
169
199
|
# @option options [String] :profile ("default")
|
170
200
|
# Used when loading credentials from the shared credentials file
|
171
201
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
202
|
#
|
203
|
+
# @option options [Proc] :retry_backoff
|
204
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
205
|
+
# This option is only used in the `legacy` retry mode.
|
206
|
+
#
|
173
207
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
208
|
+
# The base delay in seconds used by the default backoff function. This option
|
209
|
+
# is only used in the `legacy` retry mode.
|
175
210
|
#
|
176
211
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
212
|
+
# A delay randomiser function used by the default backoff function.
|
213
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
214
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
215
|
+
# in the `legacy` retry mode.
|
178
216
|
#
|
179
217
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
218
|
#
|
@@ -182,11 +220,30 @@ module Aws::KinesisVideo
|
|
182
220
|
# The maximum number of times to retry failed requests. Only
|
183
221
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
222
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
223
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
224
|
+
# endpoint discovery, and errors from expired credentials.
|
225
|
+
# This option is only used in the `legacy` retry mode.
|
187
226
|
#
|
188
227
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
228
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
229
|
+
# used by the default backoff function. This option is only used in the
|
230
|
+
# `legacy` retry mode.
|
231
|
+
#
|
232
|
+
# @option options [String] :retry_mode ("legacy")
|
233
|
+
# Specifies which retry algorithm to use. Values are:
|
234
|
+
#
|
235
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
236
|
+
# no retry mode is provided.
|
237
|
+
#
|
238
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
239
|
+
# This includes support for retry quotas, which limit the number of
|
240
|
+
# unsuccessful retries a client can make.
|
241
|
+
#
|
242
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
243
|
+
# functionality of `standard` mode along with automatic client side
|
244
|
+
# throttling. This is a provisional mode that may change behavior
|
245
|
+
# in the future.
|
246
|
+
#
|
190
247
|
#
|
191
248
|
# @option options [String] :secret_access_key
|
192
249
|
#
|
@@ -209,16 +266,15 @@ module Aws::KinesisVideo
|
|
209
266
|
# requests through. Formatted like 'http://proxy.com:123'.
|
210
267
|
#
|
211
268
|
# @option options [Float] :http_open_timeout (15) The number of
|
212
|
-
# seconds to wait when opening a HTTP session before
|
269
|
+
# seconds to wait when opening a HTTP session before raising a
|
213
270
|
# `Timeout::Error`.
|
214
271
|
#
|
215
272
|
# @option options [Integer] :http_read_timeout (60) The default
|
216
273
|
# 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}.
|
274
|
+
# safely be set per-request on the session.
|
219
275
|
#
|
220
276
|
# @option options [Float] :http_idle_timeout (5) The number of
|
221
|
-
# seconds a connection is allowed to sit
|
277
|
+
# seconds a connection is allowed to sit idle before it is
|
222
278
|
# considered stale. Stale connections are closed and removed
|
223
279
|
# from the pool before making a request.
|
224
280
|
#
|
@@ -227,7 +283,7 @@ module Aws::KinesisVideo
|
|
227
283
|
# request body. This option has no effect unless the request has
|
228
284
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
229
285
|
# disables this behaviour. This value can safely be set per
|
230
|
-
# request on the session
|
286
|
+
# request on the session.
|
231
287
|
#
|
232
288
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
233
289
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -260,7 +316,7 @@ module Aws::KinesisVideo
|
|
260
316
|
#
|
261
317
|
# @option params [required, String] :channel_name
|
262
318
|
# A name for the signaling channel that you are creating. It must be
|
263
|
-
# unique for each account and
|
319
|
+
# unique for each AWS account and AWS Region.
|
264
320
|
#
|
265
321
|
# @option params [String] :channel_type
|
266
322
|
# A type of the signaling channel that you are creating. Currently,
|
@@ -271,7 +327,7 @@ module Aws::KinesisVideo
|
|
271
327
|
# channel type.
|
272
328
|
#
|
273
329
|
# @option params [Array<Types::Tag>] :tags
|
274
|
-
# A set of tags (key
|
330
|
+
# A set of tags (key-value pairs) that you want to associate with this
|
275
331
|
# channel.
|
276
332
|
#
|
277
333
|
# @return [Types::CreateSignalingChannelOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -420,12 +476,13 @@ module Aws::KinesisVideo
|
|
420
476
|
# version, the most recent version is deleted.
|
421
477
|
#
|
422
478
|
# @option params [required, String] :channel_arn
|
423
|
-
# The ARN of the signaling channel that you want
|
479
|
+
# The Amazon Resource Name (ARN) of the signaling channel that you want
|
480
|
+
# to delete.
|
424
481
|
#
|
425
482
|
# @option params [String] :current_version
|
426
483
|
# The current version of the signaling channel that you want to delete.
|
427
484
|
# You can obtain the current version by invoking the
|
428
|
-
# `DescribeSignalingChannel` or `ListSignalingChannels`
|
485
|
+
# `DescribeSignalingChannel` or `ListSignalingChannels` API operations.
|
429
486
|
#
|
430
487
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
431
488
|
#
|
@@ -493,8 +550,8 @@ module Aws::KinesisVideo
|
|
493
550
|
end
|
494
551
|
|
495
552
|
# Returns the most current information about the signaling channel. You
|
496
|
-
# must specify either the name or the ARN of the
|
497
|
-
# to describe.
|
553
|
+
# must specify either the name or the Amazon Resource Name (ARN) of the
|
554
|
+
# channel that you want to describe.
|
498
555
|
#
|
499
556
|
# @option params [String] :channel_name
|
500
557
|
# The name of the signaling channel that you want to describe.
|
@@ -607,7 +664,7 @@ module Aws::KinesisVideo
|
|
607
664
|
# resp = client.get_data_endpoint({
|
608
665
|
# stream_name: "StreamName",
|
609
666
|
# stream_arn: "ResourceARN",
|
610
|
-
# 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
|
667
|
+
# 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
|
611
668
|
# })
|
612
669
|
#
|
613
670
|
# @example Response structure
|
@@ -629,9 +686,9 @@ module Aws::KinesisVideo
|
|
629
686
|
# consists of the `Protocols` and `Role` properties.
|
630
687
|
#
|
631
688
|
# `Protocols` is used to determine the communication mechanism. For
|
632
|
-
# example,
|
633
|
-
#
|
634
|
-
#
|
689
|
+
# example, if you specify `WSS` as the protocol, this API produces a
|
690
|
+
# secure websocket endpoint. If you specify `HTTPS` as the protocol,
|
691
|
+
# this API generates an HTTPS endpoint.
|
635
692
|
#
|
636
693
|
# `Role` determines the messaging permissions. A `MASTER` role results
|
637
694
|
# in this API generating an endpoint that a client can use to
|
@@ -640,8 +697,8 @@ module Aws::KinesisVideo
|
|
640
697
|
# communicate only with a `MASTER`.
|
641
698
|
#
|
642
699
|
# @option params [required, String] :channel_arn
|
643
|
-
# The ARN of the signalling channel for which you
|
644
|
-
# endpoint.
|
700
|
+
# The Amazon Resource Name (ARN) of the signalling channel for which you
|
701
|
+
# want to get an endpoint.
|
645
702
|
#
|
646
703
|
# @option params [Types::SingleMasterChannelEndpointConfiguration] :single_master_channel_endpoint_configuration
|
647
704
|
# A structure containing the endpoint configuration for the
|
@@ -698,6 +755,8 @@ module Aws::KinesisVideo
|
|
698
755
|
# * {Types::ListSignalingChannelsOutput#channel_info_list #channel_info_list} => Array<Types::ChannelInfo>
|
699
756
|
# * {Types::ListSignalingChannelsOutput#next_token #next_token} => String
|
700
757
|
#
|
758
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
759
|
+
#
|
701
760
|
# @example Request syntax with placeholder values
|
702
761
|
#
|
703
762
|
# resp = client.list_signaling_channels({
|
@@ -754,6 +813,8 @@ module Aws::KinesisVideo
|
|
754
813
|
# * {Types::ListStreamsOutput#stream_info_list #stream_info_list} => Array<Types::StreamInfo>
|
755
814
|
# * {Types::ListStreamsOutput#next_token #next_token} => String
|
756
815
|
#
|
816
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
817
|
+
#
|
757
818
|
# @example Request syntax with placeholder values
|
758
819
|
#
|
759
820
|
# resp = client.list_streams({
|
@@ -792,12 +853,13 @@ module Aws::KinesisVideo
|
|
792
853
|
# channel.
|
793
854
|
#
|
794
855
|
# @option params [String] :next_token
|
795
|
-
# If you specify this parameter and the result of a
|
796
|
-
# call is truncated, the response includes a token
|
797
|
-
# the next request to fetch the next batch of tags.
|
856
|
+
# If you specify this parameter and the result of a
|
857
|
+
# `ListTagsForResource` call is truncated, the response includes a token
|
858
|
+
# that you can use in the next request to fetch the next batch of tags.
|
798
859
|
#
|
799
860
|
# @option params [required, String] :resource_arn
|
800
|
-
# The ARN of the signaling channel for which you
|
861
|
+
# The Amazon Resource Name (ARN) of the signaling channel for which you
|
862
|
+
# want to list tags.
|
801
863
|
#
|
802
864
|
# @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
803
865
|
#
|
@@ -883,7 +945,8 @@ module Aws::KinesisVideo
|
|
883
945
|
# [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html
|
884
946
|
#
|
885
947
|
# @option params [required, String] :resource_arn
|
886
|
-
# The ARN of the signaling channel to which you
|
948
|
+
# The Amazon Resource Name (ARN) of the signaling channel to which you
|
949
|
+
# want to add tags.
|
887
950
|
#
|
888
951
|
# @option params [required, Array<Types::Tag>] :tags
|
889
952
|
# A list of tags to associate with the specified signaling channel. Each
|
@@ -967,7 +1030,8 @@ module Aws::KinesisVideo
|
|
967
1030
|
# specify a tag key that does not exist, it's ignored.
|
968
1031
|
#
|
969
1032
|
# @option params [required, String] :resource_arn
|
970
|
-
# The ARN of the signaling channel from which you
|
1033
|
+
# The Amazon Resource Name (ARN) of the signaling channel from which you
|
1034
|
+
# want to remove tags.
|
971
1035
|
#
|
972
1036
|
# @option params [required, Array<String>] :tag_key_list
|
973
1037
|
# A list of the keys of the tags that you want to remove.
|
@@ -1098,12 +1162,13 @@ module Aws::KinesisVideo
|
|
1098
1162
|
# operation and takes time to complete.
|
1099
1163
|
#
|
1100
1164
|
# If the `MessageTtlSeconds` value is updated (either increased or
|
1101
|
-
# reduced),
|
1102
|
-
#
|
1103
|
-
#
|
1165
|
+
# reduced), it only applies to new messages sent via this channel after
|
1166
|
+
# it's been updated. Existing messages are still expired as per the
|
1167
|
+
# previous `MessageTtlSeconds` value.
|
1104
1168
|
#
|
1105
1169
|
# @option params [required, String] :channel_arn
|
1106
|
-
# The ARN of the signaling channel that you want
|
1170
|
+
# The Amazon Resource Name (ARN) of the signaling channel that you want
|
1171
|
+
# to update.
|
1107
1172
|
#
|
1108
1173
|
# @option params [required, String] :current_version
|
1109
1174
|
# The current version of the signaling channel that you want to update.
|
@@ -1216,7 +1281,7 @@ module Aws::KinesisVideo
|
|
1216
1281
|
params: params,
|
1217
1282
|
config: config)
|
1218
1283
|
context[:gem_name] = 'aws-sdk-kinesisvideo'
|
1219
|
-
context[:gem_version] = '1.
|
1284
|
+
context[:gem_version] = '1.26.1'
|
1220
1285
|
Seahorse::Client::Request.new(handlers, context)
|
1221
1286
|
end
|
1222
1287
|
|
@@ -407,6 +407,7 @@ module Aws::KinesisVideo
|
|
407
407
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
408
408
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
409
409
|
o.errors << Shapes::ShapeRef.new(shape: VersionMismatchException)
|
410
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
410
411
|
end)
|
411
412
|
|
412
413
|
api.add_operation(:delete_stream, Seahorse::Model::Operation.new.tap do |o|
|
@@ -420,6 +421,7 @@ module Aws::KinesisVideo
|
|
420
421
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
421
422
|
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
422
423
|
o.errors << Shapes::ShapeRef.new(shape: VersionMismatchException)
|
424
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
423
425
|
end)
|
424
426
|
|
425
427
|
api.add_operation(:describe_signaling_channel, Seahorse::Model::Operation.new.tap do |o|
|
@@ -6,6 +6,41 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::KinesisVideo
|
9
|
+
|
10
|
+
# When KinesisVideo returns an error response, the Ruby SDK constructs and raises an error.
|
11
|
+
# These errors all extend Aws::KinesisVideo::Errors::ServiceError < {Aws::Errors::ServiceError}
|
12
|
+
#
|
13
|
+
# You can rescue all KinesisVideo errors using ServiceError:
|
14
|
+
#
|
15
|
+
# begin
|
16
|
+
# # do stuff
|
17
|
+
# rescue Aws::KinesisVideo::Errors::ServiceError
|
18
|
+
# # rescues all KinesisVideo API errors
|
19
|
+
# end
|
20
|
+
#
|
21
|
+
#
|
22
|
+
# ## Request Context
|
23
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
24
|
+
# information about the request that generated the error.
|
25
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
26
|
+
#
|
27
|
+
# ## Error Classes
|
28
|
+
# * {AccessDeniedException}
|
29
|
+
# * {AccountChannelLimitExceededException}
|
30
|
+
# * {AccountStreamLimitExceededException}
|
31
|
+
# * {ClientLimitExceededException}
|
32
|
+
# * {DeviceStreamLimitExceededException}
|
33
|
+
# * {InvalidArgumentException}
|
34
|
+
# * {InvalidDeviceException}
|
35
|
+
# * {InvalidResourceFormatException}
|
36
|
+
# * {NotAuthorizedException}
|
37
|
+
# * {ResourceInUseException}
|
38
|
+
# * {ResourceNotFoundException}
|
39
|
+
# * {TagsPerResourceExceededLimitException}
|
40
|
+
# * {VersionMismatchException}
|
41
|
+
#
|
42
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
43
|
+
# if they are not defined above.
|
9
44
|
module Errors
|
10
45
|
|
11
46
|
extend Aws::Errors::DynamicErrors
|
@@ -23,7 +58,6 @@ module Aws::KinesisVideo
|
|
23
58
|
def message
|
24
59
|
@message || @data[:message]
|
25
60
|
end
|
26
|
-
|
27
61
|
end
|
28
62
|
|
29
63
|
class AccountChannelLimitExceededException < ServiceError
|
@@ -39,7 +73,6 @@ module Aws::KinesisVideo
|
|
39
73
|
def message
|
40
74
|
@message || @data[:message]
|
41
75
|
end
|
42
|
-
|
43
76
|
end
|
44
77
|
|
45
78
|
class AccountStreamLimitExceededException < ServiceError
|
@@ -55,7 +88,6 @@ module Aws::KinesisVideo
|
|
55
88
|
def message
|
56
89
|
@message || @data[:message]
|
57
90
|
end
|
58
|
-
|
59
91
|
end
|
60
92
|
|
61
93
|
class ClientLimitExceededException < ServiceError
|
@@ -71,7 +103,6 @@ module Aws::KinesisVideo
|
|
71
103
|
def message
|
72
104
|
@message || @data[:message]
|
73
105
|
end
|
74
|
-
|
75
106
|
end
|
76
107
|
|
77
108
|
class DeviceStreamLimitExceededException < ServiceError
|
@@ -87,7 +118,6 @@ module Aws::KinesisVideo
|
|
87
118
|
def message
|
88
119
|
@message || @data[:message]
|
89
120
|
end
|
90
|
-
|
91
121
|
end
|
92
122
|
|
93
123
|
class InvalidArgumentException < ServiceError
|
@@ -103,7 +133,6 @@ module Aws::KinesisVideo
|
|
103
133
|
def message
|
104
134
|
@message || @data[:message]
|
105
135
|
end
|
106
|
-
|
107
136
|
end
|
108
137
|
|
109
138
|
class InvalidDeviceException < ServiceError
|
@@ -119,7 +148,6 @@ module Aws::KinesisVideo
|
|
119
148
|
def message
|
120
149
|
@message || @data[:message]
|
121
150
|
end
|
122
|
-
|
123
151
|
end
|
124
152
|
|
125
153
|
class InvalidResourceFormatException < ServiceError
|
@@ -135,7 +163,6 @@ module Aws::KinesisVideo
|
|
135
163
|
def message
|
136
164
|
@message || @data[:message]
|
137
165
|
end
|
138
|
-
|
139
166
|
end
|
140
167
|
|
141
168
|
class NotAuthorizedException < ServiceError
|
@@ -151,7 +178,6 @@ module Aws::KinesisVideo
|
|
151
178
|
def message
|
152
179
|
@message || @data[:message]
|
153
180
|
end
|
154
|
-
|
155
181
|
end
|
156
182
|
|
157
183
|
class ResourceInUseException < ServiceError
|
@@ -167,7 +193,6 @@ module Aws::KinesisVideo
|
|
167
193
|
def message
|
168
194
|
@message || @data[:message]
|
169
195
|
end
|
170
|
-
|
171
196
|
end
|
172
197
|
|
173
198
|
class ResourceNotFoundException < ServiceError
|
@@ -183,7 +208,6 @@ module Aws::KinesisVideo
|
|
183
208
|
def message
|
184
209
|
@message || @data[:message]
|
185
210
|
end
|
186
|
-
|
187
211
|
end
|
188
212
|
|
189
213
|
class TagsPerResourceExceededLimitException < ServiceError
|
@@ -199,7 +223,6 @@ module Aws::KinesisVideo
|
|
199
223
|
def message
|
200
224
|
@message || @data[:message]
|
201
225
|
end
|
202
|
-
|
203
226
|
end
|
204
227
|
|
205
228
|
class VersionMismatchException < ServiceError
|
@@ -215,7 +238,6 @@ module Aws::KinesisVideo
|
|
215
238
|
def message
|
216
239
|
@message || @data[:message]
|
217
240
|
end
|
218
|
-
|
219
241
|
end
|
220
242
|
|
221
243
|
end
|
@@ -53,7 +53,7 @@ module Aws::KinesisVideo
|
|
53
53
|
# @return [String]
|
54
54
|
#
|
55
55
|
# @!attribute [rw] channel_arn
|
56
|
-
# The ARN of the signaling channel.
|
56
|
+
# The Amazon Resource Name (ARN) of the signaling channel.
|
57
57
|
# @return [String]
|
58
58
|
#
|
59
59
|
# @!attribute [rw] channel_type
|
@@ -153,7 +153,7 @@ module Aws::KinesisVideo
|
|
153
153
|
#
|
154
154
|
# @!attribute [rw] channel_name
|
155
155
|
# A name for the signaling channel that you are creating. It must be
|
156
|
-
# unique for each account and
|
156
|
+
# unique for each AWS account and AWS Region.
|
157
157
|
# @return [String]
|
158
158
|
#
|
159
159
|
# @!attribute [rw] channel_type
|
@@ -167,7 +167,7 @@ module Aws::KinesisVideo
|
|
167
167
|
# @return [Types::SingleMasterConfiguration]
|
168
168
|
#
|
169
169
|
# @!attribute [rw] tags
|
170
|
-
# A set of tags (key
|
170
|
+
# A set of tags (key-value pairs) that you want to associate with this
|
171
171
|
# channel.
|
172
172
|
# @return [Array<Types::Tag>]
|
173
173
|
#
|
@@ -182,7 +182,7 @@ module Aws::KinesisVideo
|
|
182
182
|
end
|
183
183
|
|
184
184
|
# @!attribute [rw] channel_arn
|
185
|
-
# The ARN of the created channel.
|
185
|
+
# The Amazon Resource Name (ARN) of the created channel.
|
186
186
|
# @return [String]
|
187
187
|
#
|
188
188
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/CreateSignalingChannelOutput AWS API Documentation
|
@@ -306,13 +306,15 @@ module Aws::KinesisVideo
|
|
306
306
|
# }
|
307
307
|
#
|
308
308
|
# @!attribute [rw] channel_arn
|
309
|
-
# The ARN of the signaling channel that you
|
309
|
+
# The Amazon Resource Name (ARN) of the signaling channel that you
|
310
|
+
# want to delete.
|
310
311
|
# @return [String]
|
311
312
|
#
|
312
313
|
# @!attribute [rw] current_version
|
313
314
|
# The current version of the signaling channel that you want to
|
314
315
|
# delete. You can obtain the current version by invoking the
|
315
|
-
# `DescribeSignalingChannel` or `ListSignalingChannels`
|
316
|
+
# `DescribeSignalingChannel` or `ListSignalingChannels` API
|
317
|
+
# operations.
|
316
318
|
# @return [String]
|
317
319
|
#
|
318
320
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeleteSignalingChannelInput AWS API Documentation
|
@@ -452,7 +454,7 @@ module Aws::KinesisVideo
|
|
452
454
|
# {
|
453
455
|
# stream_name: "StreamName",
|
454
456
|
# stream_arn: "ResourceARN",
|
455
|
-
# 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
|
457
|
+
# 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
|
456
458
|
# }
|
457
459
|
#
|
458
460
|
# @!attribute [rw] stream_name
|
@@ -503,8 +505,8 @@ module Aws::KinesisVideo
|
|
503
505
|
# }
|
504
506
|
#
|
505
507
|
# @!attribute [rw] channel_arn
|
506
|
-
# The ARN of the signalling channel for which
|
507
|
-
# endpoint.
|
508
|
+
# The Amazon Resource Name (ARN) of the signalling channel for which
|
509
|
+
# you want to get an endpoint.
|
508
510
|
# @return [String]
|
509
511
|
#
|
510
512
|
# @!attribute [rw] single_master_channel_endpoint_configuration
|
@@ -690,13 +692,14 @@ module Aws::KinesisVideo
|
|
690
692
|
#
|
691
693
|
# @!attribute [rw] next_token
|
692
694
|
# If you specify this parameter and the result of a
|
693
|
-
# ListTagsForResource call is truncated, the response includes a
|
694
|
-
# that you can use in the next request to fetch the next batch
|
695
|
-
# tags.
|
695
|
+
# `ListTagsForResource` call is truncated, the response includes a
|
696
|
+
# token that you can use in the next request to fetch the next batch
|
697
|
+
# of tags.
|
696
698
|
# @return [String]
|
697
699
|
#
|
698
700
|
# @!attribute [rw] resource_arn
|
699
|
-
# The ARN of the signaling channel for which
|
701
|
+
# The Amazon Resource Name (ARN) of the signaling channel for which
|
702
|
+
# you want to list tags.
|
700
703
|
# @return [String]
|
701
704
|
#
|
702
705
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListTagsForResourceInput AWS API Documentation
|
@@ -709,8 +712,9 @@ module Aws::KinesisVideo
|
|
709
712
|
|
710
713
|
# @!attribute [rw] next_token
|
711
714
|
# If you specify this parameter and the result of a
|
712
|
-
# ListTagsForResource call is truncated, the response includes a
|
713
|
-
# that you can use in the next request to fetch the next set of
|
715
|
+
# `ListTagsForResource` call is truncated, the response includes a
|
716
|
+
# token that you can use in the next request to fetch the next set of
|
717
|
+
# tags.
|
714
718
|
# @return [String]
|
715
719
|
#
|
716
720
|
# @!attribute [rw] tags
|
@@ -811,7 +815,7 @@ module Aws::KinesisVideo
|
|
811
815
|
include Aws::Structure
|
812
816
|
end
|
813
817
|
|
814
|
-
# The
|
818
|
+
# The signaling channel is currently not available for this operation.
|
815
819
|
#
|
816
820
|
# @!attribute [rw] message
|
817
821
|
# @return [String]
|
@@ -1023,7 +1027,8 @@ module Aws::KinesisVideo
|
|
1023
1027
|
# }
|
1024
1028
|
#
|
1025
1029
|
# @!attribute [rw] resource_arn
|
1026
|
-
# The ARN of the signaling channel to which you
|
1030
|
+
# The Amazon Resource Name (ARN) of the signaling channel to which you
|
1031
|
+
# want to add tags.
|
1027
1032
|
# @return [String]
|
1028
1033
|
#
|
1029
1034
|
# @!attribute [rw] tags
|
@@ -1103,7 +1108,8 @@ module Aws::KinesisVideo
|
|
1103
1108
|
# }
|
1104
1109
|
#
|
1105
1110
|
# @!attribute [rw] resource_arn
|
1106
|
-
# The ARN of the signaling channel from which
|
1111
|
+
# The Amazon Resource Name (ARN) of the signaling channel from which
|
1112
|
+
# you want to remove tags.
|
1107
1113
|
# @return [String]
|
1108
1114
|
#
|
1109
1115
|
# @!attribute [rw] tag_key_list
|
@@ -1221,7 +1227,8 @@ module Aws::KinesisVideo
|
|
1221
1227
|
# }
|
1222
1228
|
#
|
1223
1229
|
# @!attribute [rw] channel_arn
|
1224
|
-
# The ARN of the signaling channel that you
|
1230
|
+
# The Amazon Resource Name (ARN) of the signaling channel that you
|
1231
|
+
# want to update.
|
1225
1232
|
# @return [String]
|
1226
1233
|
#
|
1227
1234
|
# @!attribute [rw] current_version
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-kinesisvideo
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.26.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2020-06-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.99.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.99.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
81
81
|
version: '0'
|
82
82
|
requirements: []
|
83
83
|
rubyforge_project:
|
84
|
-
rubygems_version: 2.
|
84
|
+
rubygems_version: 2.7.6.2
|
85
85
|
signing_key:
|
86
86
|
specification_version: 4
|
87
87
|
summary: AWS SDK for Ruby - Kinesis Video
|