aws-sdk-kinesisvideosignalingchannels 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: c65387ba5e74293fe0b131024af239a9522faea4
4
+ data.tar.gz: f087868a2224e4388569e54d64817a8f69dd2923
5
+ SHA512:
6
+ metadata.gz: 550003dee3485073bdf0945c702c6b68e0d8057a72267c4183171e383ad858262a40e1f738fc554593186bdd8f84cb8652c38ce5129cf61d4e11d44029ba77fe
7
+ data.tar.gz: 6b7c8244b1c994a3460d16a1621cb5e62fe972111613c5193dca8b6dc933e9ed6b5aec95e99dcd5d12d7a55e3f73bf25f5c04da6b88dac42e3cb4f530ab53207
@@ -0,0 +1,47 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'aws-sdk-core'
9
+ require 'aws-sigv4'
10
+
11
+ require_relative 'aws-sdk-kinesisvideosignalingchannels/types'
12
+ require_relative 'aws-sdk-kinesisvideosignalingchannels/client_api'
13
+ require_relative 'aws-sdk-kinesisvideosignalingchannels/client'
14
+ require_relative 'aws-sdk-kinesisvideosignalingchannels/errors'
15
+ require_relative 'aws-sdk-kinesisvideosignalingchannels/resource'
16
+ require_relative 'aws-sdk-kinesisvideosignalingchannels/customizations'
17
+
18
+ # This module provides support for Amazon Kinesis Video Signaling Channels. This module is available in the
19
+ # `aws-sdk-kinesisvideosignalingchannels` gem.
20
+ #
21
+ # # Client
22
+ #
23
+ # The {Client} class provides one method for each API operation. Operation
24
+ # methods each accept a hash of request parameters and return a response
25
+ # structure.
26
+ #
27
+ # See {Client} for more information.
28
+ #
29
+ # # Errors
30
+ #
31
+ # Errors returned from Amazon Kinesis Video Signaling Channels all
32
+ # extend {Errors::ServiceError}.
33
+ #
34
+ # begin
35
+ # # do stuff
36
+ # rescue Aws::KinesisVideoSignalingChannels::Errors::ServiceError
37
+ # # rescues all service API errors
38
+ # end
39
+ #
40
+ # See {Errors} for more information.
41
+ #
42
+ # @service
43
+ module Aws::KinesisVideoSignalingChannels
44
+
45
+ GEM_VERSION = '1.0.0'
46
+
47
+ end
@@ -0,0 +1,403 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'seahorse/client/plugins/content_length.rb'
9
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
10
+ require 'aws-sdk-core/plugins/logging.rb'
11
+ require 'aws-sdk-core/plugins/param_converter.rb'
12
+ require 'aws-sdk-core/plugins/param_validator.rb'
13
+ require 'aws-sdk-core/plugins/user_agent.rb'
14
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
15
+ require 'aws-sdk-core/plugins/retry_errors.rb'
16
+ require 'aws-sdk-core/plugins/global_configuration.rb'
17
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
19
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
20
+ require 'aws-sdk-core/plugins/response_paging.rb'
21
+ require 'aws-sdk-core/plugins/stub_responses.rb'
22
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
23
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
27
+ require 'aws-sdk-core/plugins/signature_v4.rb'
28
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
29
+
30
+ Aws::Plugins::GlobalConfiguration.add_identifier(:kinesisvideosignalingchannels)
31
+
32
+ module Aws::KinesisVideoSignalingChannels
33
+ class Client < Seahorse::Client::Base
34
+
35
+ include Aws::ClientStubs
36
+
37
+ @identifier = :kinesisvideosignalingchannels
38
+
39
+ set_api(ClientApi::API)
40
+
41
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
42
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
43
+ add_plugin(Aws::Plugins::Logging)
44
+ add_plugin(Aws::Plugins::ParamConverter)
45
+ add_plugin(Aws::Plugins::ParamValidator)
46
+ add_plugin(Aws::Plugins::UserAgent)
47
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
48
+ add_plugin(Aws::Plugins::RetryErrors)
49
+ add_plugin(Aws::Plugins::GlobalConfiguration)
50
+ add_plugin(Aws::Plugins::RegionalEndpoint)
51
+ add_plugin(Aws::Plugins::EndpointDiscovery)
52
+ add_plugin(Aws::Plugins::EndpointPattern)
53
+ add_plugin(Aws::Plugins::ResponsePaging)
54
+ add_plugin(Aws::Plugins::StubResponses)
55
+ add_plugin(Aws::Plugins::IdempotencyToken)
56
+ add_plugin(Aws::Plugins::JsonvalueConverter)
57
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
+ add_plugin(Aws::Plugins::TransferEncoding)
60
+ add_plugin(Aws::Plugins::SignatureV4)
61
+ add_plugin(Aws::Plugins::Protocols::RestJson)
62
+
63
+ # @overload initialize(options)
64
+ # @param [Hash] options
65
+ # @option options [required, Aws::CredentialProvider] :credentials
66
+ # Your AWS credentials. This can be an instance of any one of the
67
+ # following classes:
68
+ #
69
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
70
+ # credentials.
71
+ #
72
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
73
+ # from an EC2 IMDS on an EC2 instance.
74
+ #
75
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
76
+ # shared file, such as `~/.aws/config`.
77
+ #
78
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
79
+ #
80
+ # When `:credentials` are not configured directly, the following
81
+ # locations will be searched for credentials:
82
+ #
83
+ # * `Aws.config[:credentials]`
84
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
85
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
86
+ # * `~/.aws/credentials`
87
+ # * `~/.aws/config`
88
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
89
+ # very aggressive. Construct and pass an instance of
90
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
91
+ # timeouts.
92
+ #
93
+ # @option options [required, String] :region
94
+ # The AWS region to connect to. The configured `:region` is
95
+ # used to determine the service `:endpoint`. When not passed,
96
+ # a default `:region` is search for in the following locations:
97
+ #
98
+ # * `Aws.config[:region]`
99
+ # * `ENV['AWS_REGION']`
100
+ # * `ENV['AMAZON_REGION']`
101
+ # * `ENV['AWS_DEFAULT_REGION']`
102
+ # * `~/.aws/credentials`
103
+ # * `~/.aws/config`
104
+ #
105
+ # @option options [String] :access_key_id
106
+ #
107
+ # @option options [Boolean] :active_endpoint_cache (false)
108
+ # When set to `true`, a thread polling for endpoints will be running in
109
+ # the background every 60 secs (default). Defaults to `false`.
110
+ #
111
+ # @option options [Boolean] :client_side_monitoring (false)
112
+ # When `true`, client-side metrics will be collected for all API requests from
113
+ # this client.
114
+ #
115
+ # @option options [String] :client_side_monitoring_client_id ("")
116
+ # Allows you to provide an identifier for this client which will be attached to
117
+ # all generated client side metrics. Defaults to an empty string.
118
+ #
119
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
120
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
121
+ # side monitoring agent is running on, where client metrics will be published via UDP.
122
+ #
123
+ # @option options [Integer] :client_side_monitoring_port (31000)
124
+ # Required for publishing client metrics. The port that the client side monitoring
125
+ # agent is running on, where client metrics will be published via UDP.
126
+ #
127
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
128
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
129
+ # will use the Client Side Monitoring Agent Publisher.
130
+ #
131
+ # @option options [Boolean] :convert_params (true)
132
+ # When `true`, an attempt is made to coerce request parameters into
133
+ # the required types.
134
+ #
135
+ # @option options [Boolean] :disable_host_prefix_injection (false)
136
+ # Set to true to disable SDK automatically adding host prefix
137
+ # to default service endpoint when available.
138
+ #
139
+ # @option options [String] :endpoint
140
+ # The client endpoint is normally constructed from the `:region`
141
+ # option. You should only configure an `:endpoint` when connecting
142
+ # to test endpoints. This should be avalid HTTP(S) URI.
143
+ #
144
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
145
+ # Used for the maximum size limit of the LRU cache storing endpoints data
146
+ # for endpoint discovery enabled operations. Defaults to 1000.
147
+ #
148
+ # @option options [Integer] :endpoint_cache_max_threads (10)
149
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
150
+ #
151
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
152
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
153
+ # Use this option to config the time interval in seconds for making
154
+ # requests fetching endpoints information. Defaults to 60 sec.
155
+ #
156
+ # @option options [Boolean] :endpoint_discovery (false)
157
+ # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
158
+ #
159
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
+ # The log formatter.
161
+ #
162
+ # @option options [Symbol] :log_level (:info)
163
+ # The log level to send messages to the `:logger` at.
164
+ #
165
+ # @option options [Logger] :logger
166
+ # The Logger instance to send log messages to. If this option
167
+ # is not set, logging will be disabled.
168
+ #
169
+ # @option options [String] :profile ("default")
170
+ # Used when loading credentials from the shared credentials file
171
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
172
+ #
173
+ # @option options [Float] :retry_base_delay (0.3)
174
+ # The base delay in seconds used by the default backoff function.
175
+ #
176
+ # @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.
178
+ #
179
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
+ #
181
+ # @option options [Integer] :retry_limit (3)
182
+ # The maximum number of times to retry failed requests. Only
183
+ # ~ 500 level server errors and certain ~ 400 level client errors
184
+ # are retried. Generally, these are throttling errors, data
185
+ # checksum errors, networking errors, timeout errors and auth
186
+ # errors from expired credentials.
187
+ #
188
+ # @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.
190
+ #
191
+ # @option options [String] :secret_access_key
192
+ #
193
+ # @option options [String] :session_token
194
+ #
195
+ # @option options [Boolean] :stub_responses (false)
196
+ # Causes the client to return stubbed responses. By default
197
+ # fake responses are generated and returned. You can specify
198
+ # the response data to return or errors to raise by calling
199
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
200
+ #
201
+ # ** Please note ** When response stubbing is enabled, no HTTP
202
+ # requests are made, and retries are disabled.
203
+ #
204
+ # @option options [Boolean] :validate_params (true)
205
+ # When `true`, request parameters are validated before
206
+ # sending the request.
207
+ #
208
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
209
+ # requests through. Formatted like 'http://proxy.com:123'.
210
+ #
211
+ # @option options [Float] :http_open_timeout (15) The number of
212
+ # seconds to wait when opening a HTTP session before rasing a
213
+ # `Timeout::Error`.
214
+ #
215
+ # @option options [Integer] :http_read_timeout (60) The default
216
+ # 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}.
219
+ #
220
+ # @option options [Float] :http_idle_timeout (5) The number of
221
+ # seconds a connection is allowed to sit idble before it is
222
+ # considered stale. Stale connections are closed and removed
223
+ # from the pool before making a request.
224
+ #
225
+ # @option options [Float] :http_continue_timeout (1) The number of
226
+ # seconds to wait for a 100-continue response before sending the
227
+ # request body. This option has no effect unless the request has
228
+ # "Expect" header set to "100-continue". Defaults to `nil` which
229
+ # disables this behaviour. This value can safely be set per
230
+ # request on the session yeidled by {#session_for}.
231
+ #
232
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
233
+ # HTTP debug output will be sent to the `:logger`.
234
+ #
235
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
236
+ # SSL peer certificates are verified when establishing a
237
+ # connection.
238
+ #
239
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
240
+ # certificate authority bundle file that should be used when
241
+ # verifying peer certificates. If you do not pass
242
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
243
+ # will be used if available.
244
+ #
245
+ # @option options [String] :ssl_ca_directory Full path of the
246
+ # directory that contains the unbundled SSL certificate
247
+ # authority files for verifying peer certificates. If you do
248
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
249
+ # system default will be used if available.
250
+ #
251
+ def initialize(*args)
252
+ super
253
+ end
254
+
255
+ # @!group API Operations
256
+
257
+ # Gets the Interactive Connectivity Establishment (ICE) server
258
+ # configuration information, including URIs, username, and password
259
+ # which can be used to configure the WebRTC connection. The ICE
260
+ # component uses this configuration information to setup the WebRTC
261
+ # connection, including authenticating with the Traversal Using Relays
262
+ # around NAT (TURN) relay server.
263
+ #
264
+ # TURN is a protocol that is used to improve the connectivity of
265
+ # peer-to-peer applications. By providing a cloud-based relay service,
266
+ # TURN ensures that a connection can be established even when one or
267
+ # more peers are incapable of a direct peer-to-peer connection. For more
268
+ # information, see [A REST API For Access To TURN Services][1].
269
+ #
270
+ # You can invoke this API to establish a fallback mechanism in case
271
+ # either of the peers is unable to establish a direct peer-to-peer
272
+ # connection over a signaling channel. You must specify either a
273
+ # signaling channel ARN or the client ID in order to invoke this API.
274
+ #
275
+ #
276
+ #
277
+ # [1]: https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00
278
+ #
279
+ # @option params [required, String] :channel_arn
280
+ # The ARN of the signaling channel to be used for the peer-to-peer
281
+ # connection between configured peers.
282
+ #
283
+ # @option params [String] :client_id
284
+ # Unique identifier for the viewer. Must be unique within the signaling
285
+ # channel.
286
+ #
287
+ # @option params [String] :service
288
+ # Specifies the desired service. Currently, `TURN` is the only valid
289
+ # value.
290
+ #
291
+ # @option params [String] :username
292
+ # An optional user ID to be associated with the credentials.
293
+ #
294
+ # @return [Types::GetIceServerConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
295
+ #
296
+ # * {Types::GetIceServerConfigResponse#ice_server_list #ice_server_list} => Array&lt;Types::IceServer&gt;
297
+ #
298
+ # @example Request syntax with placeholder values
299
+ #
300
+ # resp = client.get_ice_server_config({
301
+ # channel_arn: "ResourceARN", # required
302
+ # client_id: "ClientId",
303
+ # service: "TURN", # accepts TURN
304
+ # username: "Username",
305
+ # })
306
+ #
307
+ # @example Response structure
308
+ #
309
+ # resp.ice_server_list #=> Array
310
+ # resp.ice_server_list[0].uris #=> Array
311
+ # resp.ice_server_list[0].uris[0] #=> String
312
+ # resp.ice_server_list[0].username #=> String
313
+ # resp.ice_server_list[0].password #=> String
314
+ # resp.ice_server_list[0].ttl #=> Integer
315
+ #
316
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/GetIceServerConfig AWS API Documentation
317
+ #
318
+ # @overload get_ice_server_config(params = {})
319
+ # @param [Hash] params ({})
320
+ def get_ice_server_config(params = {}, options = {})
321
+ req = build_request(:get_ice_server_config, params)
322
+ req.send_request(options)
323
+ end
324
+
325
+ # This API allows you to connect WebRTC-enabled devices with Alexa
326
+ # display devices. When invoked, it sends the Alexa Session Description
327
+ # Protocol (SDP) offer to the master peer. The offer is delivered as
328
+ # soon as the master is connected to the specified signaling channel.
329
+ # This API returns the SDP answer from the connected master. If the
330
+ # master is not connected to the signaling channel, redelivery requests
331
+ # are made until the message expires.
332
+ #
333
+ # @option params [required, String] :channel_arn
334
+ # The ARN of the signaling channel by which Alexa and the master peer
335
+ # communicate.
336
+ #
337
+ # @option params [required, String] :sender_client_id
338
+ # The unique identifier for the sender client.
339
+ #
340
+ # @option params [required, String] :message_payload
341
+ # The base64-encoded SDP offer content.
342
+ #
343
+ # @return [Types::SendAlexaOfferToMasterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
344
+ #
345
+ # * {Types::SendAlexaOfferToMasterResponse#answer #answer} => String
346
+ #
347
+ # @example Request syntax with placeholder values
348
+ #
349
+ # resp = client.send_alexa_offer_to_master({
350
+ # channel_arn: "ResourceARN", # required
351
+ # sender_client_id: "ClientId", # required
352
+ # message_payload: "MessagePayload", # required
353
+ # })
354
+ #
355
+ # @example Response structure
356
+ #
357
+ # resp.answer #=> String
358
+ #
359
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster AWS API Documentation
360
+ #
361
+ # @overload send_alexa_offer_to_master(params = {})
362
+ # @param [Hash] params ({})
363
+ def send_alexa_offer_to_master(params = {}, options = {})
364
+ req = build_request(:send_alexa_offer_to_master, params)
365
+ req.send_request(options)
366
+ end
367
+
368
+ # @!endgroup
369
+
370
+ # @param params ({})
371
+ # @api private
372
+ def build_request(operation_name, params = {})
373
+ handlers = @handlers.for(operation_name)
374
+ context = Seahorse::Client::RequestContext.new(
375
+ operation_name: operation_name,
376
+ operation: config.api.operation(operation_name),
377
+ client: self,
378
+ params: params,
379
+ config: config)
380
+ context[:gem_name] = 'aws-sdk-kinesisvideosignalingchannels'
381
+ context[:gem_version] = '1.0.0'
382
+ Seahorse::Client::Request.new(handlers, context)
383
+ end
384
+
385
+ # @api private
386
+ # @deprecated
387
+ def waiter_names
388
+ []
389
+ end
390
+
391
+ class << self
392
+
393
+ # @api private
394
+ attr_reader :identifier
395
+
396
+ # @api private
397
+ def errors_module
398
+ Errors
399
+ end
400
+
401
+ end
402
+ end
403
+ end
@@ -0,0 +1,129 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::KinesisVideoSignalingChannels
9
+ # @api private
10
+ module ClientApi
11
+
12
+ include Seahorse::Model
13
+
14
+ Answer = Shapes::StringShape.new(name: 'Answer')
15
+ ClientId = Shapes::StringShape.new(name: 'ClientId')
16
+ ClientLimitExceededException = Shapes::StructureShape.new(name: 'ClientLimitExceededException')
17
+ ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
18
+ GetIceServerConfigRequest = Shapes::StructureShape.new(name: 'GetIceServerConfigRequest')
19
+ GetIceServerConfigResponse = Shapes::StructureShape.new(name: 'GetIceServerConfigResponse')
20
+ IceServer = Shapes::StructureShape.new(name: 'IceServer')
21
+ IceServerList = Shapes::ListShape.new(name: 'IceServerList')
22
+ InvalidArgumentException = Shapes::StructureShape.new(name: 'InvalidArgumentException')
23
+ InvalidClientException = Shapes::StructureShape.new(name: 'InvalidClientException')
24
+ MessagePayload = Shapes::StringShape.new(name: 'MessagePayload')
25
+ NotAuthorizedException = Shapes::StructureShape.new(name: 'NotAuthorizedException')
26
+ Password = Shapes::StringShape.new(name: 'Password')
27
+ ResourceARN = Shapes::StringShape.new(name: 'ResourceARN')
28
+ ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
29
+ SendAlexaOfferToMasterRequest = Shapes::StructureShape.new(name: 'SendAlexaOfferToMasterRequest')
30
+ SendAlexaOfferToMasterResponse = Shapes::StructureShape.new(name: 'SendAlexaOfferToMasterResponse')
31
+ Service = Shapes::StringShape.new(name: 'Service')
32
+ SessionExpiredException = Shapes::StructureShape.new(name: 'SessionExpiredException')
33
+ Ttl = Shapes::IntegerShape.new(name: 'Ttl')
34
+ Uri = Shapes::StringShape.new(name: 'Uri')
35
+ Uris = Shapes::ListShape.new(name: 'Uris')
36
+ Username = Shapes::StringShape.new(name: 'Username')
37
+ errorMessage = Shapes::StringShape.new(name: 'errorMessage')
38
+
39
+ ClientLimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
40
+ ClientLimitExceededException.struct_class = Types::ClientLimitExceededException
41
+
42
+ GetIceServerConfigRequest.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ResourceARN, required: true, location_name: "ChannelARN"))
43
+ GetIceServerConfigRequest.add_member(:client_id, Shapes::ShapeRef.new(shape: ClientId, location_name: "ClientId"))
44
+ GetIceServerConfigRequest.add_member(:service, Shapes::ShapeRef.new(shape: Service, location_name: "Service"))
45
+ GetIceServerConfigRequest.add_member(:username, Shapes::ShapeRef.new(shape: Username, location_name: "Username"))
46
+ GetIceServerConfigRequest.struct_class = Types::GetIceServerConfigRequest
47
+
48
+ GetIceServerConfigResponse.add_member(:ice_server_list, Shapes::ShapeRef.new(shape: IceServerList, location_name: "IceServerList"))
49
+ GetIceServerConfigResponse.struct_class = Types::GetIceServerConfigResponse
50
+
51
+ IceServer.add_member(:uris, Shapes::ShapeRef.new(shape: Uris, location_name: "Uris"))
52
+ IceServer.add_member(:username, Shapes::ShapeRef.new(shape: Username, location_name: "Username"))
53
+ IceServer.add_member(:password, Shapes::ShapeRef.new(shape: Password, location_name: "Password"))
54
+ IceServer.add_member(:ttl, Shapes::ShapeRef.new(shape: Ttl, location_name: "Ttl"))
55
+ IceServer.struct_class = Types::IceServer
56
+
57
+ IceServerList.member = Shapes::ShapeRef.new(shape: IceServer)
58
+
59
+ InvalidArgumentException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
60
+ InvalidArgumentException.struct_class = Types::InvalidArgumentException
61
+
62
+ InvalidClientException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
63
+ InvalidClientException.struct_class = Types::InvalidClientException
64
+
65
+ NotAuthorizedException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
66
+ NotAuthorizedException.struct_class = Types::NotAuthorizedException
67
+
68
+ ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
69
+ ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
70
+
71
+ SendAlexaOfferToMasterRequest.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ResourceARN, required: true, location_name: "ChannelARN"))
72
+ SendAlexaOfferToMasterRequest.add_member(:sender_client_id, Shapes::ShapeRef.new(shape: ClientId, required: true, location_name: "SenderClientId"))
73
+ SendAlexaOfferToMasterRequest.add_member(:message_payload, Shapes::ShapeRef.new(shape: MessagePayload, required: true, location_name: "MessagePayload"))
74
+ SendAlexaOfferToMasterRequest.struct_class = Types::SendAlexaOfferToMasterRequest
75
+
76
+ SendAlexaOfferToMasterResponse.add_member(:answer, Shapes::ShapeRef.new(shape: Answer, location_name: "Answer"))
77
+ SendAlexaOfferToMasterResponse.struct_class = Types::SendAlexaOfferToMasterResponse
78
+
79
+ SessionExpiredException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
80
+ SessionExpiredException.struct_class = Types::SessionExpiredException
81
+
82
+ Uris.member = Shapes::ShapeRef.new(shape: Uri)
83
+
84
+
85
+ # @api private
86
+ API = Seahorse::Model::Api.new.tap do |api|
87
+
88
+ api.version = "2019-12-04"
89
+
90
+ api.metadata = {
91
+ "apiVersion" => "2019-12-04",
92
+ "endpointPrefix" => "kinesisvideo",
93
+ "protocol" => "rest-json",
94
+ "serviceAbbreviation" => "Amazon Kinesis Video Signaling Channels",
95
+ "serviceFullName" => "Amazon Kinesis Video Signaling Channels",
96
+ "serviceId" => "Kinesis Video Signaling",
97
+ "signatureVersion" => "v4",
98
+ "uid" => "kinesis-video-signaling-2019-12-04",
99
+ }
100
+
101
+ api.add_operation(:get_ice_server_config, Seahorse::Model::Operation.new.tap do |o|
102
+ o.name = "GetIceServerConfig"
103
+ o.http_method = "POST"
104
+ o.http_request_uri = "/v1/get-ice-server-config"
105
+ o.input = Shapes::ShapeRef.new(shape: GetIceServerConfigRequest)
106
+ o.output = Shapes::ShapeRef.new(shape: GetIceServerConfigResponse)
107
+ o.errors << Shapes::ShapeRef.new(shape: InvalidClientException)
108
+ o.errors << Shapes::ShapeRef.new(shape: SessionExpiredException)
109
+ o.errors << Shapes::ShapeRef.new(shape: ClientLimitExceededException)
110
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
111
+ o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
112
+ o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
113
+ end)
114
+
115
+ api.add_operation(:send_alexa_offer_to_master, Seahorse::Model::Operation.new.tap do |o|
116
+ o.name = "SendAlexaOfferToMaster"
117
+ o.http_method = "POST"
118
+ o.http_request_uri = "/v1/send-alexa-offer-to-master"
119
+ o.input = Shapes::ShapeRef.new(shape: SendAlexaOfferToMasterRequest)
120
+ o.output = Shapes::ShapeRef.new(shape: SendAlexaOfferToMasterResponse)
121
+ o.errors << Shapes::ShapeRef.new(shape: ClientLimitExceededException)
122
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
123
+ o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
124
+ o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
125
+ end)
126
+ end
127
+
128
+ end
129
+ end
@@ -0,0 +1,110 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::KinesisVideoSignalingChannels
9
+ module Errors
10
+
11
+ extend Aws::Errors::DynamicErrors
12
+
13
+ class ClientLimitExceededException < ServiceError
14
+
15
+ # @param [Seahorse::Client::RequestContext] context
16
+ # @param [String] message
17
+ # @param [Aws::KinesisVideoSignalingChannels::Types::ClientLimitExceededException] data
18
+ def initialize(context, message, data = Aws::EmptyStructure.new)
19
+ super(context, message, data)
20
+ end
21
+
22
+ # @return [String]
23
+ def message
24
+ @message || @data[:message]
25
+ end
26
+
27
+ end
28
+
29
+ class InvalidArgumentException < ServiceError
30
+
31
+ # @param [Seahorse::Client::RequestContext] context
32
+ # @param [String] message
33
+ # @param [Aws::KinesisVideoSignalingChannels::Types::InvalidArgumentException] data
34
+ def initialize(context, message, data = Aws::EmptyStructure.new)
35
+ super(context, message, data)
36
+ end
37
+
38
+ # @return [String]
39
+ def message
40
+ @message || @data[:message]
41
+ end
42
+
43
+ end
44
+
45
+ class InvalidClientException < ServiceError
46
+
47
+ # @param [Seahorse::Client::RequestContext] context
48
+ # @param [String] message
49
+ # @param [Aws::KinesisVideoSignalingChannels::Types::InvalidClientException] data
50
+ def initialize(context, message, data = Aws::EmptyStructure.new)
51
+ super(context, message, data)
52
+ end
53
+
54
+ # @return [String]
55
+ def message
56
+ @message || @data[:message]
57
+ end
58
+
59
+ end
60
+
61
+ class NotAuthorizedException < ServiceError
62
+
63
+ # @param [Seahorse::Client::RequestContext] context
64
+ # @param [String] message
65
+ # @param [Aws::KinesisVideoSignalingChannels::Types::NotAuthorizedException] data
66
+ def initialize(context, message, data = Aws::EmptyStructure.new)
67
+ super(context, message, data)
68
+ end
69
+
70
+ # @return [String]
71
+ def message
72
+ @message || @data[:message]
73
+ end
74
+
75
+ end
76
+
77
+ class ResourceNotFoundException < ServiceError
78
+
79
+ # @param [Seahorse::Client::RequestContext] context
80
+ # @param [String] message
81
+ # @param [Aws::KinesisVideoSignalingChannels::Types::ResourceNotFoundException] data
82
+ def initialize(context, message, data = Aws::EmptyStructure.new)
83
+ super(context, message, data)
84
+ end
85
+
86
+ # @return [String]
87
+ def message
88
+ @message || @data[:message]
89
+ end
90
+
91
+ end
92
+
93
+ class SessionExpiredException < ServiceError
94
+
95
+ # @param [Seahorse::Client::RequestContext] context
96
+ # @param [String] message
97
+ # @param [Aws::KinesisVideoSignalingChannels::Types::SessionExpiredException] data
98
+ def initialize(context, message, data = Aws::EmptyStructure.new)
99
+ super(context, message, data)
100
+ end
101
+
102
+ # @return [String]
103
+ def message
104
+ @message || @data[:message]
105
+ end
106
+
107
+ end
108
+
109
+ end
110
+ end
@@ -0,0 +1,23 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::KinesisVideoSignalingChannels
9
+ class Resource
10
+
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
16
+
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,215 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::KinesisVideoSignalingChannels
9
+ module Types
10
+
11
+ # Your request was throttled because you have exceeded the limit of
12
+ # allowed client calls. Try making the call later.
13
+ #
14
+ # @!attribute [rw] message
15
+ # @return [String]
16
+ #
17
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/ClientLimitExceededException AWS API Documentation
18
+ #
19
+ class ClientLimitExceededException < Struct.new(
20
+ :message)
21
+ include Aws::Structure
22
+ end
23
+
24
+ # @note When making an API call, you may pass GetIceServerConfigRequest
25
+ # data as a hash:
26
+ #
27
+ # {
28
+ # channel_arn: "ResourceARN", # required
29
+ # client_id: "ClientId",
30
+ # service: "TURN", # accepts TURN
31
+ # username: "Username",
32
+ # }
33
+ #
34
+ # @!attribute [rw] channel_arn
35
+ # The ARN of the signaling channel to be used for the peer-to-peer
36
+ # connection between configured peers.
37
+ # @return [String]
38
+ #
39
+ # @!attribute [rw] client_id
40
+ # Unique identifier for the viewer. Must be unique within the
41
+ # signaling channel.
42
+ # @return [String]
43
+ #
44
+ # @!attribute [rw] service
45
+ # Specifies the desired service. Currently, `TURN` is the only valid
46
+ # value.
47
+ # @return [String]
48
+ #
49
+ # @!attribute [rw] username
50
+ # An optional user ID to be associated with the credentials.
51
+ # @return [String]
52
+ #
53
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/GetIceServerConfigRequest AWS API Documentation
54
+ #
55
+ class GetIceServerConfigRequest < Struct.new(
56
+ :channel_arn,
57
+ :client_id,
58
+ :service,
59
+ :username)
60
+ include Aws::Structure
61
+ end
62
+
63
+ # @!attribute [rw] ice_server_list
64
+ # The list of ICE server information objects.
65
+ # @return [Array<Types::IceServer>]
66
+ #
67
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/GetIceServerConfigResponse AWS API Documentation
68
+ #
69
+ class GetIceServerConfigResponse < Struct.new(
70
+ :ice_server_list)
71
+ include Aws::Structure
72
+ end
73
+
74
+ # A structure for the ICE server connection data.
75
+ #
76
+ # @!attribute [rw] uris
77
+ # An array of URIs, in the form specified in the
78
+ # [I-D.petithuguenin-behave-turn-uris][1] spec. These URIs provide the
79
+ # different addresses and/or protocols that can be used to reach the
80
+ # TURN server.
81
+ #
82
+ #
83
+ #
84
+ # [1]: https://tools.ietf.org/html/draft-petithuguenin-behave-turn-uris-03
85
+ # @return [Array<String>]
86
+ #
87
+ # @!attribute [rw] username
88
+ # A username to login to the ICE server.
89
+ # @return [String]
90
+ #
91
+ # @!attribute [rw] password
92
+ # A password to login to the ICE server.
93
+ # @return [String]
94
+ #
95
+ # @!attribute [rw] ttl
96
+ # The period of time, in seconds, during which the username and
97
+ # password are valid.
98
+ # @return [Integer]
99
+ #
100
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/IceServer AWS API Documentation
101
+ #
102
+ class IceServer < Struct.new(
103
+ :uris,
104
+ :username,
105
+ :password,
106
+ :ttl)
107
+ include Aws::Structure
108
+ end
109
+
110
+ # The value for this input parameter is invalid.
111
+ #
112
+ # @!attribute [rw] message
113
+ # @return [String]
114
+ #
115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/InvalidArgumentException AWS API Documentation
116
+ #
117
+ class InvalidArgumentException < Struct.new(
118
+ :message)
119
+ include Aws::Structure
120
+ end
121
+
122
+ # The specified client is invalid.
123
+ #
124
+ # @!attribute [rw] message
125
+ # @return [String]
126
+ #
127
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/InvalidClientException AWS API Documentation
128
+ #
129
+ class InvalidClientException < Struct.new(
130
+ :message)
131
+ include Aws::Structure
132
+ end
133
+
134
+ # The caller is not authorized to perform this operation.
135
+ #
136
+ # @!attribute [rw] message
137
+ # @return [String]
138
+ #
139
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/NotAuthorizedException AWS API Documentation
140
+ #
141
+ class NotAuthorizedException < Struct.new(
142
+ :message)
143
+ include Aws::Structure
144
+ end
145
+
146
+ # The specified resource is not found.
147
+ #
148
+ # @!attribute [rw] message
149
+ # @return [String]
150
+ #
151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/ResourceNotFoundException AWS API Documentation
152
+ #
153
+ class ResourceNotFoundException < Struct.new(
154
+ :message)
155
+ include Aws::Structure
156
+ end
157
+
158
+ # @note When making an API call, you may pass SendAlexaOfferToMasterRequest
159
+ # data as a hash:
160
+ #
161
+ # {
162
+ # channel_arn: "ResourceARN", # required
163
+ # sender_client_id: "ClientId", # required
164
+ # message_payload: "MessagePayload", # required
165
+ # }
166
+ #
167
+ # @!attribute [rw] channel_arn
168
+ # The ARN of the signaling channel by which Alexa and the master peer
169
+ # communicate.
170
+ # @return [String]
171
+ #
172
+ # @!attribute [rw] sender_client_id
173
+ # The unique identifier for the sender client.
174
+ # @return [String]
175
+ #
176
+ # @!attribute [rw] message_payload
177
+ # The base64-encoded SDP offer content.
178
+ # @return [String]
179
+ #
180
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMasterRequest AWS API Documentation
181
+ #
182
+ class SendAlexaOfferToMasterRequest < Struct.new(
183
+ :channel_arn,
184
+ :sender_client_id,
185
+ :message_payload)
186
+ include Aws::Structure
187
+ end
188
+
189
+ # @!attribute [rw] answer
190
+ # The base64-encoded SDP answer content.
191
+ # @return [String]
192
+ #
193
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMasterResponse AWS API Documentation
194
+ #
195
+ class SendAlexaOfferToMasterResponse < Struct.new(
196
+ :answer)
197
+ include Aws::Structure
198
+ end
199
+
200
+ # If the client session is expired. Once the client is connected, the
201
+ # session is valid for 45 minutes. Client should reconnect to the
202
+ # channel to continue sending/receiving messages.
203
+ #
204
+ # @!attribute [rw] message
205
+ # @return [String]
206
+ #
207
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/SessionExpiredException AWS API Documentation
208
+ #
209
+ class SessionExpiredException < Struct.new(
210
+ :message)
211
+ include Aws::Structure
212
+ end
213
+
214
+ end
215
+ end
metadata ADDED
@@ -0,0 +1,88 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: aws-sdk-kinesisvideosignalingchannels
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Amazon Web Services
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2019-12-05 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: aws-sdk-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '3'
20
+ - - ">="
21
+ - !ruby/object:Gem::Version
22
+ version: 3.71.0
23
+ type: :runtime
24
+ prerelease: false
25
+ version_requirements: !ruby/object:Gem::Requirement
26
+ requirements:
27
+ - - "~>"
28
+ - !ruby/object:Gem::Version
29
+ version: '3'
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: 3.71.0
33
+ - !ruby/object:Gem::Dependency
34
+ name: aws-sigv4
35
+ requirement: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - "~>"
38
+ - !ruby/object:Gem::Version
39
+ version: '1.1'
40
+ type: :runtime
41
+ prerelease: false
42
+ version_requirements: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - "~>"
45
+ - !ruby/object:Gem::Version
46
+ version: '1.1'
47
+ description: Official AWS Ruby gem for Amazon Kinesis Video Signaling Channels. This
48
+ gem is part of the AWS SDK for Ruby.
49
+ email:
50
+ - trevrowe@amazon.com
51
+ executables: []
52
+ extensions: []
53
+ extra_rdoc_files: []
54
+ files:
55
+ - lib/aws-sdk-kinesisvideosignalingchannels.rb
56
+ - lib/aws-sdk-kinesisvideosignalingchannels/client.rb
57
+ - lib/aws-sdk-kinesisvideosignalingchannels/client_api.rb
58
+ - lib/aws-sdk-kinesisvideosignalingchannels/customizations.rb
59
+ - lib/aws-sdk-kinesisvideosignalingchannels/errors.rb
60
+ - lib/aws-sdk-kinesisvideosignalingchannels/resource.rb
61
+ - lib/aws-sdk-kinesisvideosignalingchannels/types.rb
62
+ homepage: https://github.com/aws/aws-sdk-ruby
63
+ licenses:
64
+ - Apache-2.0
65
+ metadata:
66
+ source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-kinesisvideosignalingchannels
67
+ changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-kinesisvideosignalingchannels/CHANGELOG.md
68
+ post_install_message:
69
+ rdoc_options: []
70
+ require_paths:
71
+ - lib
72
+ required_ruby_version: !ruby/object:Gem::Requirement
73
+ requirements:
74
+ - - ">="
75
+ - !ruby/object:Gem::Version
76
+ version: '0'
77
+ required_rubygems_version: !ruby/object:Gem::Requirement
78
+ requirements:
79
+ - - ">="
80
+ - !ruby/object:Gem::Version
81
+ version: '0'
82
+ requirements: []
83
+ rubyforge_project:
84
+ rubygems_version: 2.5.2.3
85
+ signing_key:
86
+ specification_version: 4
87
+ summary: AWS SDK for Ruby - Amazon Kinesis Video Signaling Channels
88
+ test_files: []