aws-sdk-ivsrealtime 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,810 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
32
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
33
+ require 'aws-sdk-core/plugins/sign.rb'
34
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
35
+
36
+ Aws::Plugins::GlobalConfiguration.add_identifier(:ivsrealtime)
37
+
38
+ module Aws::IVSRealTime
39
+ # An API client for IVSRealTime. To construct a client, you need to configure a `:region` and `:credentials`.
40
+ #
41
+ # client = Aws::IVSRealTime::Client.new(
42
+ # region: region_name,
43
+ # credentials: credentials,
44
+ # # ...
45
+ # )
46
+ #
47
+ # For details on configuring region and credentials see
48
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
49
+ #
50
+ # See {#initialize} for a full list of supported configuration options.
51
+ class Client < Seahorse::Client::Base
52
+
53
+ include Aws::ClientStubs
54
+
55
+ @identifier = :ivsrealtime
56
+
57
+ set_api(ClientApi::API)
58
+
59
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
60
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
61
+ add_plugin(Aws::Plugins::Logging)
62
+ add_plugin(Aws::Plugins::ParamConverter)
63
+ add_plugin(Aws::Plugins::ParamValidator)
64
+ add_plugin(Aws::Plugins::UserAgent)
65
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
66
+ add_plugin(Aws::Plugins::RetryErrors)
67
+ add_plugin(Aws::Plugins::GlobalConfiguration)
68
+ add_plugin(Aws::Plugins::RegionalEndpoint)
69
+ add_plugin(Aws::Plugins::EndpointDiscovery)
70
+ add_plugin(Aws::Plugins::EndpointPattern)
71
+ add_plugin(Aws::Plugins::ResponsePaging)
72
+ add_plugin(Aws::Plugins::StubResponses)
73
+ add_plugin(Aws::Plugins::IdempotencyToken)
74
+ add_plugin(Aws::Plugins::JsonvalueConverter)
75
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
76
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
77
+ add_plugin(Aws::Plugins::TransferEncoding)
78
+ add_plugin(Aws::Plugins::HttpChecksum)
79
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
80
+ add_plugin(Aws::Plugins::DefaultsMode)
81
+ add_plugin(Aws::Plugins::RecursionDetection)
82
+ add_plugin(Aws::Plugins::Sign)
83
+ add_plugin(Aws::Plugins::Protocols::RestJson)
84
+ add_plugin(Aws::IVSRealTime::Plugins::Endpoints)
85
+
86
+ # @overload initialize(options)
87
+ # @param [Hash] options
88
+ # @option options [required, Aws::CredentialProvider] :credentials
89
+ # Your AWS credentials. This can be an instance of any one of the
90
+ # following classes:
91
+ #
92
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
93
+ # credentials.
94
+ #
95
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
96
+ # shared file, such as `~/.aws/config`.
97
+ #
98
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
99
+ #
100
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
101
+ # assume a role after providing credentials via the web.
102
+ #
103
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
104
+ # access token generated from `aws login`.
105
+ #
106
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
107
+ # process that outputs to stdout.
108
+ #
109
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
110
+ # from an EC2 IMDS on an EC2 instance.
111
+ #
112
+ # * `Aws::ECSCredentials` - Used for loading credentials from
113
+ # instances running in ECS.
114
+ #
115
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
116
+ # from the Cognito Identity service.
117
+ #
118
+ # When `:credentials` are not configured directly, the following
119
+ # locations will be searched for credentials:
120
+ #
121
+ # * `Aws.config[:credentials]`
122
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
123
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
124
+ # * `~/.aws/credentials`
125
+ # * `~/.aws/config`
126
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
127
+ # are very aggressive. Construct and pass an instance of
128
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
129
+ # enable retries and extended timeouts. Instance profile credential
130
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
131
+ # to true.
132
+ #
133
+ # @option options [required, String] :region
134
+ # The AWS region to connect to. The configured `:region` is
135
+ # used to determine the service `:endpoint`. When not passed,
136
+ # a default `:region` is searched for in the following locations:
137
+ #
138
+ # * `Aws.config[:region]`
139
+ # * `ENV['AWS_REGION']`
140
+ # * `ENV['AMAZON_REGION']`
141
+ # * `ENV['AWS_DEFAULT_REGION']`
142
+ # * `~/.aws/credentials`
143
+ # * `~/.aws/config`
144
+ #
145
+ # @option options [String] :access_key_id
146
+ #
147
+ # @option options [Boolean] :active_endpoint_cache (false)
148
+ # When set to `true`, a thread polling for endpoints will be running in
149
+ # the background every 60 secs (default). Defaults to `false`.
150
+ #
151
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
152
+ # Used only in `adaptive` retry mode. When true, the request will sleep
153
+ # until there is sufficent client side capacity to retry the request.
154
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
155
+ # not retry instead of sleeping.
156
+ #
157
+ # @option options [Boolean] :client_side_monitoring (false)
158
+ # When `true`, client-side metrics will be collected for all API requests from
159
+ # this client.
160
+ #
161
+ # @option options [String] :client_side_monitoring_client_id ("")
162
+ # Allows you to provide an identifier for this client which will be attached to
163
+ # all generated client side metrics. Defaults to an empty string.
164
+ #
165
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
166
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
167
+ # side monitoring agent is running on, where client metrics will be published via UDP.
168
+ #
169
+ # @option options [Integer] :client_side_monitoring_port (31000)
170
+ # Required for publishing client metrics. The port that the client side monitoring
171
+ # agent is running on, where client metrics will be published via UDP.
172
+ #
173
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
174
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
175
+ # will use the Client Side Monitoring Agent Publisher.
176
+ #
177
+ # @option options [Boolean] :convert_params (true)
178
+ # When `true`, an attempt is made to coerce request parameters into
179
+ # the required types.
180
+ #
181
+ # @option options [Boolean] :correct_clock_skew (true)
182
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
183
+ # a clock skew correction and retry requests with skewed client clocks.
184
+ #
185
+ # @option options [String] :defaults_mode ("legacy")
186
+ # See {Aws::DefaultsModeConfiguration} for a list of the
187
+ # accepted modes and the configuration defaults that are included.
188
+ #
189
+ # @option options [Boolean] :disable_host_prefix_injection (false)
190
+ # Set to true to disable SDK automatically adding host prefix
191
+ # to default service endpoint when available.
192
+ #
193
+ # @option options [String] :endpoint
194
+ # The client endpoint is normally constructed from the `:region`
195
+ # option. You should only configure an `:endpoint` when connecting
196
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
197
+ #
198
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
199
+ # Used for the maximum size limit of the LRU cache storing endpoints data
200
+ # for endpoint discovery enabled operations. Defaults to 1000.
201
+ #
202
+ # @option options [Integer] :endpoint_cache_max_threads (10)
203
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
204
+ #
205
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
206
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
207
+ # Use this option to config the time interval in seconds for making
208
+ # requests fetching endpoints information. Defaults to 60 sec.
209
+ #
210
+ # @option options [Boolean] :endpoint_discovery (false)
211
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
212
+ #
213
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
214
+ # The log formatter.
215
+ #
216
+ # @option options [Symbol] :log_level (:info)
217
+ # The log level to send messages to the `:logger` at.
218
+ #
219
+ # @option options [Logger] :logger
220
+ # The Logger instance to send log messages to. If this option
221
+ # is not set, logging will be disabled.
222
+ #
223
+ # @option options [Integer] :max_attempts (3)
224
+ # An integer representing the maximum number attempts that will be made for
225
+ # a single request, including the initial attempt. For example,
226
+ # setting this value to 5 will result in a request being retried up to
227
+ # 4 times. Used in `standard` and `adaptive` retry modes.
228
+ #
229
+ # @option options [String] :profile ("default")
230
+ # Used when loading credentials from the shared credentials file
231
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
232
+ #
233
+ # @option options [Proc] :retry_backoff
234
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
235
+ # This option is only used in the `legacy` retry mode.
236
+ #
237
+ # @option options [Float] :retry_base_delay (0.3)
238
+ # The base delay in seconds used by the default backoff function. This option
239
+ # is only used in the `legacy` retry mode.
240
+ #
241
+ # @option options [Symbol] :retry_jitter (:none)
242
+ # A delay randomiser function used by the default backoff function.
243
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
244
+ # otherwise a Proc that takes and returns a number. This option is only used
245
+ # in the `legacy` retry mode.
246
+ #
247
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
248
+ #
249
+ # @option options [Integer] :retry_limit (3)
250
+ # The maximum number of times to retry failed requests. Only
251
+ # ~ 500 level server errors and certain ~ 400 level client errors
252
+ # are retried. Generally, these are throttling errors, data
253
+ # checksum errors, networking errors, timeout errors, auth errors,
254
+ # endpoint discovery, and errors from expired credentials.
255
+ # This option is only used in the `legacy` retry mode.
256
+ #
257
+ # @option options [Integer] :retry_max_delay (0)
258
+ # The maximum number of seconds to delay between retries (0 for no limit)
259
+ # used by the default backoff function. This option is only used in the
260
+ # `legacy` retry mode.
261
+ #
262
+ # @option options [String] :retry_mode ("legacy")
263
+ # Specifies which retry algorithm to use. Values are:
264
+ #
265
+ # * `legacy` - The pre-existing retry behavior. This is default value if
266
+ # no retry mode is provided.
267
+ #
268
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
269
+ # This includes support for retry quotas, which limit the number of
270
+ # unsuccessful retries a client can make.
271
+ #
272
+ # * `adaptive` - An experimental retry mode that includes all the
273
+ # functionality of `standard` mode along with automatic client side
274
+ # throttling. This is a provisional mode that may change behavior
275
+ # in the future.
276
+ #
277
+ #
278
+ # @option options [String] :secret_access_key
279
+ #
280
+ # @option options [String] :session_token
281
+ #
282
+ # @option options [Boolean] :stub_responses (false)
283
+ # Causes the client to return stubbed responses. By default
284
+ # fake responses are generated and returned. You can specify
285
+ # the response data to return or errors to raise by calling
286
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
287
+ #
288
+ # ** Please note ** When response stubbing is enabled, no HTTP
289
+ # requests are made, and retries are disabled.
290
+ #
291
+ # @option options [Aws::TokenProvider] :token_provider
292
+ # A Bearer Token Provider. This can be an instance of any one of the
293
+ # following classes:
294
+ #
295
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
296
+ # tokens.
297
+ #
298
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
299
+ # access token generated from `aws login`.
300
+ #
301
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
302
+ # will be used to search for tokens configured for your profile in shared configuration files.
303
+ #
304
+ # @option options [Boolean] :use_dualstack_endpoint
305
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
306
+ # will be used if available.
307
+ #
308
+ # @option options [Boolean] :use_fips_endpoint
309
+ # When set to `true`, fips compatible endpoints will be used if available.
310
+ # When a `fips` region is used, the region is normalized and this config
311
+ # is set to `true`.
312
+ #
313
+ # @option options [Boolean] :validate_params (true)
314
+ # When `true`, request parameters are validated before
315
+ # sending the request.
316
+ #
317
+ # @option options [Aws::IVSRealTime::EndpointProvider] :endpoint_provider
318
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::IVSRealTime::EndpointParameters`
319
+ #
320
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
321
+ # requests through. Formatted like 'http://proxy.com:123'.
322
+ #
323
+ # @option options [Float] :http_open_timeout (15) The number of
324
+ # seconds to wait when opening a HTTP session before raising a
325
+ # `Timeout::Error`.
326
+ #
327
+ # @option options [Float] :http_read_timeout (60) The default
328
+ # number of seconds to wait for response data. This value can
329
+ # safely be set per-request on the session.
330
+ #
331
+ # @option options [Float] :http_idle_timeout (5) The number of
332
+ # seconds a connection is allowed to sit idle before it is
333
+ # considered stale. Stale connections are closed and removed
334
+ # from the pool before making a request.
335
+ #
336
+ # @option options [Float] :http_continue_timeout (1) The number of
337
+ # seconds to wait for a 100-continue response before sending the
338
+ # request body. This option has no effect unless the request has
339
+ # "Expect" header set to "100-continue". Defaults to `nil` which
340
+ # disables this behaviour. This value can safely be set per
341
+ # request on the session.
342
+ #
343
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
344
+ # in seconds.
345
+ #
346
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
347
+ # HTTP debug output will be sent to the `:logger`.
348
+ #
349
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
350
+ # SSL peer certificates are verified when establishing a
351
+ # connection.
352
+ #
353
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
354
+ # certificate authority bundle file that should be used when
355
+ # verifying peer certificates. If you do not pass
356
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
357
+ # will be used if available.
358
+ #
359
+ # @option options [String] :ssl_ca_directory Full path of the
360
+ # directory that contains the unbundled SSL certificate
361
+ # authority files for verifying peer certificates. If you do
362
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
363
+ # system default will be used if available.
364
+ #
365
+ def initialize(*args)
366
+ super
367
+ end
368
+
369
+ # @!group API Operations
370
+
371
+ # Creates an additional token for a specified stage. This can be done
372
+ # after stage creation or when tokens expire. Tokens always are scoped
373
+ # to the stage for which they are created.
374
+ #
375
+ # Encryption keys are owned by Amazon IVS and never used directly by
376
+ # your application.
377
+ #
378
+ # @option params [Hash<String,String>] :attributes
379
+ # Application-provided attributes to encode into the token and attach to
380
+ # a stage. Map keys and values can contain UTF-8 encoded text. The
381
+ # maximum length of this field is 1 KB total. *This field is exposed to
382
+ # all stage participants and should not be used for personally
383
+ # identifying, confidential, or sensitive information.*
384
+ #
385
+ # @option params [Array<String>] :capabilities
386
+ # Set of capabilities that the user is allowed to perform in the stage.
387
+ # Default: `PUBLISH, SUBSCRIBE`.
388
+ #
389
+ # @option params [Integer] :duration
390
+ # Duration (in minutes), after which the token expires. Default: 60 (1
391
+ # hour).
392
+ #
393
+ # @option params [required, String] :stage_arn
394
+ # ARN of the stage to which this token is scoped.
395
+ #
396
+ # @option params [String] :user_id
397
+ # Name that can be specified to help identify the token. This can be any
398
+ # UTF-8 encoded text. *This field is exposed to all stage participants
399
+ # and should not be used for personally identifying, confidential, or
400
+ # sensitive information.*
401
+ #
402
+ # @return [Types::CreateParticipantTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
403
+ #
404
+ # * {Types::CreateParticipantTokenResponse#participant_token #participant_token} => Types::ParticipantToken
405
+ #
406
+ # @example Request syntax with placeholder values
407
+ #
408
+ # resp = client.create_participant_token({
409
+ # attributes: {
410
+ # "String" => "String",
411
+ # },
412
+ # capabilities: ["PUBLISH"], # accepts PUBLISH, SUBSCRIBE
413
+ # duration: 1,
414
+ # stage_arn: "StageArn", # required
415
+ # user_id: "ParticipantTokenUserId",
416
+ # })
417
+ #
418
+ # @example Response structure
419
+ #
420
+ # resp.participant_token.attributes #=> Hash
421
+ # resp.participant_token.attributes["String"] #=> String
422
+ # resp.participant_token.capabilities #=> Array
423
+ # resp.participant_token.capabilities[0] #=> String, one of "PUBLISH", "SUBSCRIBE"
424
+ # resp.participant_token.duration #=> Integer
425
+ # resp.participant_token.expiration_time #=> Time
426
+ # resp.participant_token.participant_id #=> String
427
+ # resp.participant_token.token #=> String
428
+ # resp.participant_token.user_id #=> String
429
+ #
430
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateParticipantToken AWS API Documentation
431
+ #
432
+ # @overload create_participant_token(params = {})
433
+ # @param [Hash] params ({})
434
+ def create_participant_token(params = {}, options = {})
435
+ req = build_request(:create_participant_token, params)
436
+ req.send_request(options)
437
+ end
438
+
439
+ # Creates a new stage (and optionally participant tokens).
440
+ #
441
+ # @option params [String] :name
442
+ # Optional name that can be specified for the stage being created.
443
+ #
444
+ # @option params [Array<Types::ParticipantTokenConfiguration>] :participant_token_configurations
445
+ # Array of participant token configuration objects to attach to the new
446
+ # stage.
447
+ #
448
+ # @option params [Hash<String,String>] :tags
449
+ # Tags attached to the resource. Array of maps, each of the form
450
+ # `string:string (key:value)`. See [Tagging AWS Resources][1] for
451
+ # details, including restrictions that apply to tags and "Tag naming
452
+ # limits and requirements"; Amazon IVS has no constraints on tags
453
+ # beyond what is documented there.
454
+ #
455
+ #
456
+ #
457
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
458
+ #
459
+ # @return [Types::CreateStageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
460
+ #
461
+ # * {Types::CreateStageResponse#participant_tokens #participant_tokens} => Array&lt;Types::ParticipantToken&gt;
462
+ # * {Types::CreateStageResponse#stage #stage} => Types::Stage
463
+ #
464
+ # @example Request syntax with placeholder values
465
+ #
466
+ # resp = client.create_stage({
467
+ # name: "StageName",
468
+ # participant_token_configurations: [
469
+ # {
470
+ # attributes: {
471
+ # "String" => "String",
472
+ # },
473
+ # capabilities: ["PUBLISH"], # accepts PUBLISH, SUBSCRIBE
474
+ # duration: 1,
475
+ # user_id: "ParticipantTokenUserId",
476
+ # },
477
+ # ],
478
+ # tags: {
479
+ # "TagKey" => "TagValue",
480
+ # },
481
+ # })
482
+ #
483
+ # @example Response structure
484
+ #
485
+ # resp.participant_tokens #=> Array
486
+ # resp.participant_tokens[0].attributes #=> Hash
487
+ # resp.participant_tokens[0].attributes["String"] #=> String
488
+ # resp.participant_tokens[0].capabilities #=> Array
489
+ # resp.participant_tokens[0].capabilities[0] #=> String, one of "PUBLISH", "SUBSCRIBE"
490
+ # resp.participant_tokens[0].duration #=> Integer
491
+ # resp.participant_tokens[0].expiration_time #=> Time
492
+ # resp.participant_tokens[0].participant_id #=> String
493
+ # resp.participant_tokens[0].token #=> String
494
+ # resp.participant_tokens[0].user_id #=> String
495
+ # resp.stage.active_session_id #=> String
496
+ # resp.stage.arn #=> String
497
+ # resp.stage.name #=> String
498
+ # resp.stage.tags #=> Hash
499
+ # resp.stage.tags["TagKey"] #=> String
500
+ #
501
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateStage AWS API Documentation
502
+ #
503
+ # @overload create_stage(params = {})
504
+ # @param [Hash] params ({})
505
+ def create_stage(params = {}, options = {})
506
+ req = build_request(:create_stage, params)
507
+ req.send_request(options)
508
+ end
509
+
510
+ # Shuts down and deletes the specified stage (disconnecting all
511
+ # participants).
512
+ #
513
+ # @option params [required, String] :arn
514
+ # ARN of the stage to be deleted.
515
+ #
516
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
517
+ #
518
+ # @example Request syntax with placeholder values
519
+ #
520
+ # resp = client.delete_stage({
521
+ # arn: "StageArn", # required
522
+ # })
523
+ #
524
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DeleteStage AWS API Documentation
525
+ #
526
+ # @overload delete_stage(params = {})
527
+ # @param [Hash] params ({})
528
+ def delete_stage(params = {}, options = {})
529
+ req = build_request(:delete_stage, params)
530
+ req.send_request(options)
531
+ end
532
+
533
+ # Disconnects a specified participant and revokes the participant
534
+ # permanently from a specified stage.
535
+ #
536
+ # @option params [required, String] :participant_id
537
+ # Identifier of the participant to be disconnected. This is returned by
538
+ # CreateParticipantToken.
539
+ #
540
+ # @option params [String] :reason
541
+ # Description of why this participant is being disconnected.
542
+ #
543
+ # @option params [required, String] :stage_arn
544
+ # ARN of the stage to which the participant is attached.
545
+ #
546
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
547
+ #
548
+ # @example Request syntax with placeholder values
549
+ #
550
+ # resp = client.disconnect_participant({
551
+ # participant_id: "ParticipantTokenId", # required
552
+ # reason: "DisconnectParticipantReason",
553
+ # stage_arn: "StageArn", # required
554
+ # })
555
+ #
556
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DisconnectParticipant AWS API Documentation
557
+ #
558
+ # @overload disconnect_participant(params = {})
559
+ # @param [Hash] params ({})
560
+ def disconnect_participant(params = {}, options = {})
561
+ req = build_request(:disconnect_participant, params)
562
+ req.send_request(options)
563
+ end
564
+
565
+ # Gets information for the specified stage.
566
+ #
567
+ # @option params [required, String] :arn
568
+ # ARN of the stage for which the information is to be retrieved.
569
+ #
570
+ # @return [Types::GetStageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
571
+ #
572
+ # * {Types::GetStageResponse#stage #stage} => Types::Stage
573
+ #
574
+ # @example Request syntax with placeholder values
575
+ #
576
+ # resp = client.get_stage({
577
+ # arn: "StageArn", # required
578
+ # })
579
+ #
580
+ # @example Response structure
581
+ #
582
+ # resp.stage.active_session_id #=> String
583
+ # resp.stage.arn #=> String
584
+ # resp.stage.name #=> String
585
+ # resp.stage.tags #=> Hash
586
+ # resp.stage.tags["TagKey"] #=> String
587
+ #
588
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStage AWS API Documentation
589
+ #
590
+ # @overload get_stage(params = {})
591
+ # @param [Hash] params ({})
592
+ def get_stage(params = {}, options = {})
593
+ req = build_request(:get_stage, params)
594
+ req.send_request(options)
595
+ end
596
+
597
+ # Gets summary information about all stages in your account, in the AWS
598
+ # region where the API request is processed.
599
+ #
600
+ # @option params [Integer] :max_results
601
+ # Maximum number of results to return. Default: 50.
602
+ #
603
+ # @option params [String] :next_token
604
+ # The first stage to retrieve. This is used for pagination; see the
605
+ # `nextToken` response field.
606
+ #
607
+ # @return [Types::ListStagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
608
+ #
609
+ # * {Types::ListStagesResponse#next_token #next_token} => String
610
+ # * {Types::ListStagesResponse#stages #stages} => Array&lt;Types::StageSummary&gt;
611
+ #
612
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
613
+ #
614
+ # @example Request syntax with placeholder values
615
+ #
616
+ # resp = client.list_stages({
617
+ # max_results: 1,
618
+ # next_token: "PaginationToken",
619
+ # })
620
+ #
621
+ # @example Response structure
622
+ #
623
+ # resp.next_token #=> String
624
+ # resp.stages #=> Array
625
+ # resp.stages[0].active_session_id #=> String
626
+ # resp.stages[0].arn #=> String
627
+ # resp.stages[0].name #=> String
628
+ # resp.stages[0].tags #=> Hash
629
+ # resp.stages[0].tags["TagKey"] #=> String
630
+ #
631
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStages AWS API Documentation
632
+ #
633
+ # @overload list_stages(params = {})
634
+ # @param [Hash] params ({})
635
+ def list_stages(params = {}, options = {})
636
+ req = build_request(:list_stages, params)
637
+ req.send_request(options)
638
+ end
639
+
640
+ # Gets information about AWS tags for the specified ARN.
641
+ #
642
+ # @option params [required, String] :resource_arn
643
+ # The ARN of the resource to be retrieved. The ARN must be URL-encoded.
644
+ #
645
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
646
+ #
647
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
648
+ #
649
+ # @example Request syntax with placeholder values
650
+ #
651
+ # resp = client.list_tags_for_resource({
652
+ # resource_arn: "ResourceArn", # required
653
+ # })
654
+ #
655
+ # @example Response structure
656
+ #
657
+ # resp.tags #=> Hash
658
+ # resp.tags["TagKey"] #=> String
659
+ #
660
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListTagsForResource AWS API Documentation
661
+ #
662
+ # @overload list_tags_for_resource(params = {})
663
+ # @param [Hash] params ({})
664
+ def list_tags_for_resource(params = {}, options = {})
665
+ req = build_request(:list_tags_for_resource, params)
666
+ req.send_request(options)
667
+ end
668
+
669
+ # Adds or updates tags for the AWS resource with the specified ARN.
670
+ #
671
+ # @option params [required, String] :resource_arn
672
+ # The ARN of the resource to be tagged. The ARN must be URL-encoded.
673
+ #
674
+ # @option params [required, Hash<String,String>] :tags
675
+ # Array of tags to be added or updated. Array of maps, each of the form
676
+ # `string:string (key:value)`. See [Tagging AWS Resources][1] for
677
+ # details, including restrictions that apply to tags and "Tag naming
678
+ # limits and requirements"; Amazon IVS has no constraints beyond what
679
+ # is documented there.
680
+ #
681
+ #
682
+ #
683
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
684
+ #
685
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
686
+ #
687
+ # @example Request syntax with placeholder values
688
+ #
689
+ # resp = client.tag_resource({
690
+ # resource_arn: "ResourceArn", # required
691
+ # tags: { # required
692
+ # "TagKey" => "TagValue",
693
+ # },
694
+ # })
695
+ #
696
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/TagResource AWS API Documentation
697
+ #
698
+ # @overload tag_resource(params = {})
699
+ # @param [Hash] params ({})
700
+ def tag_resource(params = {}, options = {})
701
+ req = build_request(:tag_resource, params)
702
+ req.send_request(options)
703
+ end
704
+
705
+ # Removes tags from the resource with the specified ARN.
706
+ #
707
+ # @option params [required, String] :resource_arn
708
+ # The ARN of the resource to be untagged. The ARN must be URL-encoded.
709
+ #
710
+ # @option params [required, Array<String>] :tag_keys
711
+ # Array of tags to be removed. Array of maps, each of the form
712
+ # `string:string (key:value)`. See [Tagging AWS Resources][1] for
713
+ # details, including restrictions that apply to tags and "Tag naming
714
+ # limits and requirements"; Amazon IVS has no constraints beyond what
715
+ # is documented there.
716
+ #
717
+ #
718
+ #
719
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
720
+ #
721
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
722
+ #
723
+ # @example Request syntax with placeholder values
724
+ #
725
+ # resp = client.untag_resource({
726
+ # resource_arn: "ResourceArn", # required
727
+ # tag_keys: ["TagKey"], # required
728
+ # })
729
+ #
730
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/UntagResource AWS API Documentation
731
+ #
732
+ # @overload untag_resource(params = {})
733
+ # @param [Hash] params ({})
734
+ def untag_resource(params = {}, options = {})
735
+ req = build_request(:untag_resource, params)
736
+ req.send_request(options)
737
+ end
738
+
739
+ # Updates a stage’s configuration.
740
+ #
741
+ # @option params [required, String] :arn
742
+ # ARN of the stage to be updated.
743
+ #
744
+ # @option params [String] :name
745
+ # Name of the stage to be updated.
746
+ #
747
+ # @return [Types::UpdateStageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
748
+ #
749
+ # * {Types::UpdateStageResponse#stage #stage} => Types::Stage
750
+ #
751
+ # @example Request syntax with placeholder values
752
+ #
753
+ # resp = client.update_stage({
754
+ # arn: "StageArn", # required
755
+ # name: "StageName",
756
+ # })
757
+ #
758
+ # @example Response structure
759
+ #
760
+ # resp.stage.active_session_id #=> String
761
+ # resp.stage.arn #=> String
762
+ # resp.stage.name #=> String
763
+ # resp.stage.tags #=> Hash
764
+ # resp.stage.tags["TagKey"] #=> String
765
+ #
766
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/UpdateStage AWS API Documentation
767
+ #
768
+ # @overload update_stage(params = {})
769
+ # @param [Hash] params ({})
770
+ def update_stage(params = {}, options = {})
771
+ req = build_request(:update_stage, params)
772
+ req.send_request(options)
773
+ end
774
+
775
+ # @!endgroup
776
+
777
+ # @param params ({})
778
+ # @api private
779
+ def build_request(operation_name, params = {})
780
+ handlers = @handlers.for(operation_name)
781
+ context = Seahorse::Client::RequestContext.new(
782
+ operation_name: operation_name,
783
+ operation: config.api.operation(operation_name),
784
+ client: self,
785
+ params: params,
786
+ config: config)
787
+ context[:gem_name] = 'aws-sdk-ivsrealtime'
788
+ context[:gem_version] = '1.0.0'
789
+ Seahorse::Client::Request.new(handlers, context)
790
+ end
791
+
792
+ # @api private
793
+ # @deprecated
794
+ def waiter_names
795
+ []
796
+ end
797
+
798
+ class << self
799
+
800
+ # @api private
801
+ attr_reader :identifier
802
+
803
+ # @api private
804
+ def errors_module
805
+ Errors
806
+ end
807
+
808
+ end
809
+ end
810
+ end