aws-sdk-chimesdkmeetings 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,893 @@
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/signature_v4.rb'
31
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
+
33
+ Aws::Plugins::GlobalConfiguration.add_identifier(:chimesdkmeetings)
34
+
35
+ module Aws::ChimeSDKMeetings
36
+ # An API client for ChimeSDKMeetings. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::ChimeSDKMeetings::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
48
+ class Client < Seahorse::Client::Base
49
+
50
+ include Aws::ClientStubs
51
+
52
+ @identifier = :chimesdkmeetings
53
+
54
+ set_api(ClientApi::API)
55
+
56
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
57
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
58
+ add_plugin(Aws::Plugins::Logging)
59
+ add_plugin(Aws::Plugins::ParamConverter)
60
+ add_plugin(Aws::Plugins::ParamValidator)
61
+ add_plugin(Aws::Plugins::UserAgent)
62
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
63
+ add_plugin(Aws::Plugins::RetryErrors)
64
+ add_plugin(Aws::Plugins::GlobalConfiguration)
65
+ add_plugin(Aws::Plugins::RegionalEndpoint)
66
+ add_plugin(Aws::Plugins::EndpointDiscovery)
67
+ add_plugin(Aws::Plugins::EndpointPattern)
68
+ add_plugin(Aws::Plugins::ResponsePaging)
69
+ add_plugin(Aws::Plugins::StubResponses)
70
+ add_plugin(Aws::Plugins::IdempotencyToken)
71
+ add_plugin(Aws::Plugins::JsonvalueConverter)
72
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
73
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
+ add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
76
+ add_plugin(Aws::Plugins::SignatureV4)
77
+ add_plugin(Aws::Plugins::Protocols::RestJson)
78
+
79
+ # @overload initialize(options)
80
+ # @param [Hash] options
81
+ # @option options [required, Aws::CredentialProvider] :credentials
82
+ # Your AWS credentials. This can be an instance of any one of the
83
+ # following classes:
84
+ #
85
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
+ # credentials.
87
+ #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
102
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
103
+ # from an EC2 IMDS on an EC2 instance.
104
+ #
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
107
+ #
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
110
+ #
111
+ # When `:credentials` are not configured directly, the following
112
+ # locations will be searched for credentials:
113
+ #
114
+ # * `Aws.config[:credentials]`
115
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
116
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
117
+ # * `~/.aws/credentials`
118
+ # * `~/.aws/config`
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
123
+ #
124
+ # @option options [required, String] :region
125
+ # The AWS region to connect to. The configured `:region` is
126
+ # used to determine the service `:endpoint`. When not passed,
127
+ # a default `:region` is searched for in the following locations:
128
+ #
129
+ # * `Aws.config[:region]`
130
+ # * `ENV['AWS_REGION']`
131
+ # * `ENV['AMAZON_REGION']`
132
+ # * `ENV['AWS_DEFAULT_REGION']`
133
+ # * `~/.aws/credentials`
134
+ # * `~/.aws/config`
135
+ #
136
+ # @option options [String] :access_key_id
137
+ #
138
+ # @option options [Boolean] :active_endpoint_cache (false)
139
+ # When set to `true`, a thread polling for endpoints will be running in
140
+ # the background every 60 secs (default). Defaults to `false`.
141
+ #
142
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
143
+ # Used only in `adaptive` retry mode. When true, the request will sleep
144
+ # until there is sufficent client side capacity to retry the request.
145
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
146
+ # not retry instead of sleeping.
147
+ #
148
+ # @option options [Boolean] :client_side_monitoring (false)
149
+ # When `true`, client-side metrics will be collected for all API requests from
150
+ # this client.
151
+ #
152
+ # @option options [String] :client_side_monitoring_client_id ("")
153
+ # Allows you to provide an identifier for this client which will be attached to
154
+ # all generated client side metrics. Defaults to an empty string.
155
+ #
156
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
157
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
158
+ # side monitoring agent is running on, where client metrics will be published via UDP.
159
+ #
160
+ # @option options [Integer] :client_side_monitoring_port (31000)
161
+ # Required for publishing client metrics. The port that the client side monitoring
162
+ # agent is running on, where client metrics will be published via UDP.
163
+ #
164
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
165
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
166
+ # will use the Client Side Monitoring Agent Publisher.
167
+ #
168
+ # @option options [Boolean] :convert_params (true)
169
+ # When `true`, an attempt is made to coerce request parameters into
170
+ # the required types.
171
+ #
172
+ # @option options [Boolean] :correct_clock_skew (true)
173
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
+ # a clock skew correction and retry requests with skewed client clocks.
175
+ #
176
+ # @option options [Boolean] :disable_host_prefix_injection (false)
177
+ # Set to true to disable SDK automatically adding host prefix
178
+ # to default service endpoint when available.
179
+ #
180
+ # @option options [String] :endpoint
181
+ # The client endpoint is normally constructed from the `:region`
182
+ # option. You should only configure an `:endpoint` when connecting
183
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
184
+ #
185
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
186
+ # Used for the maximum size limit of the LRU cache storing endpoints data
187
+ # for endpoint discovery enabled operations. Defaults to 1000.
188
+ #
189
+ # @option options [Integer] :endpoint_cache_max_threads (10)
190
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
191
+ #
192
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
193
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
194
+ # Use this option to config the time interval in seconds for making
195
+ # requests fetching endpoints information. Defaults to 60 sec.
196
+ #
197
+ # @option options [Boolean] :endpoint_discovery (false)
198
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
199
+ #
200
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
201
+ # The log formatter.
202
+ #
203
+ # @option options [Symbol] :log_level (:info)
204
+ # The log level to send messages to the `:logger` at.
205
+ #
206
+ # @option options [Logger] :logger
207
+ # The Logger instance to send log messages to. If this option
208
+ # is not set, logging will be disabled.
209
+ #
210
+ # @option options [Integer] :max_attempts (3)
211
+ # An integer representing the maximum number attempts that will be made for
212
+ # a single request, including the initial attempt. For example,
213
+ # setting this value to 5 will result in a request being retried up to
214
+ # 4 times. Used in `standard` and `adaptive` retry modes.
215
+ #
216
+ # @option options [String] :profile ("default")
217
+ # Used when loading credentials from the shared credentials file
218
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
219
+ #
220
+ # @option options [Proc] :retry_backoff
221
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
222
+ # This option is only used in the `legacy` retry mode.
223
+ #
224
+ # @option options [Float] :retry_base_delay (0.3)
225
+ # The base delay in seconds used by the default backoff function. This option
226
+ # is only used in the `legacy` retry mode.
227
+ #
228
+ # @option options [Symbol] :retry_jitter (:none)
229
+ # A delay randomiser function used by the default backoff function.
230
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
231
+ # otherwise a Proc that takes and returns a number. This option is only used
232
+ # in the `legacy` retry mode.
233
+ #
234
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
235
+ #
236
+ # @option options [Integer] :retry_limit (3)
237
+ # The maximum number of times to retry failed requests. Only
238
+ # ~ 500 level server errors and certain ~ 400 level client errors
239
+ # are retried. Generally, these are throttling errors, data
240
+ # checksum errors, networking errors, timeout errors, auth errors,
241
+ # endpoint discovery, and errors from expired credentials.
242
+ # This option is only used in the `legacy` retry mode.
243
+ #
244
+ # @option options [Integer] :retry_max_delay (0)
245
+ # The maximum number of seconds to delay between retries (0 for no limit)
246
+ # used by the default backoff function. This option is only used in the
247
+ # `legacy` retry mode.
248
+ #
249
+ # @option options [String] :retry_mode ("legacy")
250
+ # Specifies which retry algorithm to use. Values are:
251
+ #
252
+ # * `legacy` - The pre-existing retry behavior. This is default value if
253
+ # no retry mode is provided.
254
+ #
255
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
256
+ # This includes support for retry quotas, which limit the number of
257
+ # unsuccessful retries a client can make.
258
+ #
259
+ # * `adaptive` - An experimental retry mode that includes all the
260
+ # functionality of `standard` mode along with automatic client side
261
+ # throttling. This is a provisional mode that may change behavior
262
+ # in the future.
263
+ #
264
+ #
265
+ # @option options [String] :secret_access_key
266
+ #
267
+ # @option options [String] :session_token
268
+ #
269
+ # @option options [Boolean] :stub_responses (false)
270
+ # Causes the client to return stubbed responses. By default
271
+ # fake responses are generated and returned. You can specify
272
+ # the response data to return or errors to raise by calling
273
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
274
+ #
275
+ # ** Please note ** When response stubbing is enabled, no HTTP
276
+ # requests are made, and retries are disabled.
277
+ #
278
+ # @option options [Boolean] :use_dualstack_endpoint
279
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
280
+ # will be used if available.
281
+ #
282
+ # @option options [Boolean] :use_fips_endpoint
283
+ # When set to `true`, fips compatible endpoints will be used if available.
284
+ # When a `fips` region is used, the region is normalized and this config
285
+ # is set to `true`.
286
+ #
287
+ # @option options [Boolean] :validate_params (true)
288
+ # When `true`, request parameters are validated before
289
+ # sending the request.
290
+ #
291
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
292
+ # requests through. Formatted like 'http://proxy.com:123'.
293
+ #
294
+ # @option options [Float] :http_open_timeout (15) The number of
295
+ # seconds to wait when opening a HTTP session before raising a
296
+ # `Timeout::Error`.
297
+ #
298
+ # @option options [Integer] :http_read_timeout (60) The default
299
+ # number of seconds to wait for response data. This value can
300
+ # safely be set per-request on the session.
301
+ #
302
+ # @option options [Float] :http_idle_timeout (5) The number of
303
+ # seconds a connection is allowed to sit idle before it is
304
+ # considered stale. Stale connections are closed and removed
305
+ # from the pool before making a request.
306
+ #
307
+ # @option options [Float] :http_continue_timeout (1) The number of
308
+ # seconds to wait for a 100-continue response before sending the
309
+ # request body. This option has no effect unless the request has
310
+ # "Expect" header set to "100-continue". Defaults to `nil` which
311
+ # disables this behaviour. This value can safely be set per
312
+ # request on the session.
313
+ #
314
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
315
+ # HTTP debug output will be sent to the `:logger`.
316
+ #
317
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
318
+ # SSL peer certificates are verified when establishing a
319
+ # connection.
320
+ #
321
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
322
+ # certificate authority bundle file that should be used when
323
+ # verifying peer certificates. If you do not pass
324
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
325
+ # will be used if available.
326
+ #
327
+ # @option options [String] :ssl_ca_directory Full path of the
328
+ # directory that contains the unbundled SSL certificate
329
+ # authority files for verifying peer certificates. If you do
330
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
331
+ # system default will be used if available.
332
+ #
333
+ def initialize(*args)
334
+ super
335
+ end
336
+
337
+ # @!group API Operations
338
+
339
+ # Creates a group of meeting attendees.
340
+ #
341
+ # @option params [required, String] :meeting_id
342
+ # The Amazon Chime SDK ID of the meeting to which you're adding
343
+ # attendees.
344
+ #
345
+ # @option params [required, Array<Types::CreateAttendeeRequestItem>] :attendees
346
+ # The attendee information, including attendees' IDs and join tokens.
347
+ #
348
+ # @return [Types::BatchCreateAttendeeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
349
+ #
350
+ # * {Types::BatchCreateAttendeeResponse#attendees #attendees} => Array&lt;Types::Attendee&gt;
351
+ # * {Types::BatchCreateAttendeeResponse#errors #errors} => Array&lt;Types::CreateAttendeeError&gt;
352
+ #
353
+ # @example Request syntax with placeholder values
354
+ #
355
+ # resp = client.batch_create_attendee({
356
+ # meeting_id: "String", # required
357
+ # attendees: [ # required
358
+ # {
359
+ # external_user_id: "ExternalUserId", # required
360
+ # },
361
+ # ],
362
+ # })
363
+ #
364
+ # @example Response structure
365
+ #
366
+ # resp.attendees #=> Array
367
+ # resp.attendees[0].external_user_id #=> String
368
+ # resp.attendees[0].attendee_id #=> String
369
+ # resp.attendees[0].join_token #=> String
370
+ # resp.errors #=> Array
371
+ # resp.errors[0].external_user_id #=> String
372
+ # resp.errors[0].error_code #=> String
373
+ # resp.errors[0].error_message #=> String
374
+ #
375
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/BatchCreateAttendee AWS API Documentation
376
+ #
377
+ # @overload batch_create_attendee(params = {})
378
+ # @param [Hash] params ({})
379
+ def batch_create_attendee(params = {}, options = {})
380
+ req = build_request(:batch_create_attendee, params)
381
+ req.send_request(options)
382
+ end
383
+
384
+ # Creates a new attendee for an active Amazon Chime SDK meeting. For
385
+ # more information about the Amazon Chime SDK, see [Using the Amazon
386
+ # Chime SDK][1] in the *Amazon Chime Developer Guide*.
387
+ #
388
+ #
389
+ #
390
+ # [1]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html
391
+ #
392
+ # @option params [required, String] :meeting_id
393
+ # The unique ID of the meeting.
394
+ #
395
+ # @option params [required, String] :external_user_id
396
+ # The Amazon Chime SDK external user ID. An idempotency token. Links the
397
+ # attendee to an identity managed by a builder application.
398
+ #
399
+ # @return [Types::CreateAttendeeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
400
+ #
401
+ # * {Types::CreateAttendeeResponse#attendee #attendee} => Types::Attendee
402
+ #
403
+ # @example Request syntax with placeholder values
404
+ #
405
+ # resp = client.create_attendee({
406
+ # meeting_id: "String", # required
407
+ # external_user_id: "ExternalUserId", # required
408
+ # })
409
+ #
410
+ # @example Response structure
411
+ #
412
+ # resp.attendee.external_user_id #=> String
413
+ # resp.attendee.attendee_id #=> String
414
+ # resp.attendee.join_token #=> String
415
+ #
416
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/CreateAttendee AWS API Documentation
417
+ #
418
+ # @overload create_attendee(params = {})
419
+ # @param [Hash] params ({})
420
+ def create_attendee(params = {}, options = {})
421
+ req = build_request(:create_attendee, params)
422
+ req.send_request(options)
423
+ end
424
+
425
+ # Creates a new Amazon Chime SDK meeting in the specified media Region
426
+ # with no initial attendees. For more information about specifying media
427
+ # Regions, see [Amazon Chime SDK Media Regions][1] in the *Amazon Chime
428
+ # Developer Guide*. For more information about the Amazon Chime SDK, see
429
+ # [Using the Amazon Chime SDK][2] in the *Amazon Chime Developer Guide*.
430
+ #
431
+ #
432
+ #
433
+ # [1]: https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html
434
+ # [2]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html
435
+ #
436
+ # @option params [required, String] :client_request_token
437
+ # The unique identifier for the client request. Use a different token
438
+ # for different meetings.
439
+ #
440
+ # **A suitable default value is auto-generated.** You should normally
441
+ # not need to pass this option.**
442
+ #
443
+ # @option params [required, String] :media_region
444
+ # The Region in which to create the meeting. Default: `us-east-1`.
445
+ #
446
+ # Available values: `af-south-1` , `ap-northeast-1` , `ap-northeast-2` ,
447
+ # `ap-south-1` , `ap-southeast-1` , `ap-southeast-2` , `ca-central-1` ,
448
+ # `eu-central-1` , `eu-north-1` , `eu-south-1` , `eu-west-1` ,
449
+ # `eu-west-2` , `eu-west-3` , `sa-east-1` , `us-east-1` , `us-east-2` ,
450
+ # `us-west-1` , `us-west-2` .
451
+ #
452
+ # @option params [String] :meeting_host_id
453
+ # Reserved.
454
+ #
455
+ # @option params [required, String] :external_meeting_id
456
+ # The external meeting ID.
457
+ #
458
+ # @option params [Types::NotificationsConfiguration] :notifications_configuration
459
+ # The configuration for resource targets to receive notifications when
460
+ # meeting and attendee events occur.
461
+ #
462
+ # @return [Types::CreateMeetingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
463
+ #
464
+ # * {Types::CreateMeetingResponse#meeting #meeting} => Types::Meeting
465
+ #
466
+ # @example Request syntax with placeholder values
467
+ #
468
+ # resp = client.create_meeting({
469
+ # client_request_token: "ClientRequestToken", # required
470
+ # media_region: "String", # required
471
+ # meeting_host_id: "ExternalUserId",
472
+ # external_meeting_id: "ExternalMeetingId", # required
473
+ # notifications_configuration: {
474
+ # lambda_function_arn: "Arn",
475
+ # sns_topic_arn: "Arn",
476
+ # sqs_queue_arn: "Arn",
477
+ # },
478
+ # })
479
+ #
480
+ # @example Response structure
481
+ #
482
+ # resp.meeting.meeting_id #=> String
483
+ # resp.meeting.meeting_host_id #=> String
484
+ # resp.meeting.external_meeting_id #=> String
485
+ # resp.meeting.media_region #=> String
486
+ # resp.meeting.media_placement.audio_host_url #=> String
487
+ # resp.meeting.media_placement.audio_fallback_url #=> String
488
+ # resp.meeting.media_placement.signaling_url #=> String
489
+ # resp.meeting.media_placement.turn_control_url #=> String
490
+ # resp.meeting.media_placement.screen_data_url #=> String
491
+ # resp.meeting.media_placement.screen_viewing_url #=> String
492
+ # resp.meeting.media_placement.screen_sharing_url #=> String
493
+ # resp.meeting.media_placement.event_ingestion_url #=> String
494
+ #
495
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/CreateMeeting AWS API Documentation
496
+ #
497
+ # @overload create_meeting(params = {})
498
+ # @param [Hash] params ({})
499
+ def create_meeting(params = {}, options = {})
500
+ req = build_request(:create_meeting, params)
501
+ req.send_request(options)
502
+ end
503
+
504
+ # Creates a new Amazon Chime SDK meeting in the specified media Region,
505
+ # with attendees. For more information about specifying media Regions,
506
+ # see [Amazon Chime SDK Media Regions][1] in the *Amazon Chime Developer
507
+ # Guide*. For more information about the Amazon Chime SDK, see [Using
508
+ # the Amazon Chime SDK][2] in the *Amazon Chime Developer Guide*.
509
+ #
510
+ #
511
+ #
512
+ # [1]: https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html
513
+ # [2]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html
514
+ #
515
+ # @option params [required, String] :client_request_token
516
+ # The unique identifier for the client request. Use a different token
517
+ # for different meetings.
518
+ #
519
+ # **A suitable default value is auto-generated.** You should normally
520
+ # not need to pass this option.**
521
+ #
522
+ # @option params [required, String] :media_region
523
+ # The Region in which to create the meeting. Default: `us-east-1`.
524
+ #
525
+ # @option params [String] :meeting_host_id
526
+ # Reserved.
527
+ #
528
+ # @option params [required, String] :external_meeting_id
529
+ # The external meeting ID.
530
+ #
531
+ # @option params [Types::NotificationsConfiguration] :notifications_configuration
532
+ # The configuration for resource targets to receive notifications when
533
+ # meeting and attendee events occur.
534
+ #
535
+ # @option params [required, Array<Types::CreateAttendeeRequestItem>] :attendees
536
+ # The attendee information, including attendees' IDs and join tokens.
537
+ #
538
+ # @return [Types::CreateMeetingWithAttendeesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
539
+ #
540
+ # * {Types::CreateMeetingWithAttendeesResponse#meeting #meeting} => Types::Meeting
541
+ # * {Types::CreateMeetingWithAttendeesResponse#attendees #attendees} => Array&lt;Types::Attendee&gt;
542
+ # * {Types::CreateMeetingWithAttendeesResponse#errors #errors} => Array&lt;Types::CreateAttendeeError&gt;
543
+ #
544
+ # @example Request syntax with placeholder values
545
+ #
546
+ # resp = client.create_meeting_with_attendees({
547
+ # client_request_token: "ClientRequestToken", # required
548
+ # media_region: "String", # required
549
+ # meeting_host_id: "ExternalUserId",
550
+ # external_meeting_id: "ExternalMeetingId", # required
551
+ # notifications_configuration: {
552
+ # lambda_function_arn: "Arn",
553
+ # sns_topic_arn: "Arn",
554
+ # sqs_queue_arn: "Arn",
555
+ # },
556
+ # attendees: [ # required
557
+ # {
558
+ # external_user_id: "ExternalUserId", # required
559
+ # },
560
+ # ],
561
+ # })
562
+ #
563
+ # @example Response structure
564
+ #
565
+ # resp.meeting.meeting_id #=> String
566
+ # resp.meeting.meeting_host_id #=> String
567
+ # resp.meeting.external_meeting_id #=> String
568
+ # resp.meeting.media_region #=> String
569
+ # resp.meeting.media_placement.audio_host_url #=> String
570
+ # resp.meeting.media_placement.audio_fallback_url #=> String
571
+ # resp.meeting.media_placement.signaling_url #=> String
572
+ # resp.meeting.media_placement.turn_control_url #=> String
573
+ # resp.meeting.media_placement.screen_data_url #=> String
574
+ # resp.meeting.media_placement.screen_viewing_url #=> String
575
+ # resp.meeting.media_placement.screen_sharing_url #=> String
576
+ # resp.meeting.media_placement.event_ingestion_url #=> String
577
+ # resp.attendees #=> Array
578
+ # resp.attendees[0].external_user_id #=> String
579
+ # resp.attendees[0].attendee_id #=> String
580
+ # resp.attendees[0].join_token #=> String
581
+ # resp.errors #=> Array
582
+ # resp.errors[0].external_user_id #=> String
583
+ # resp.errors[0].error_code #=> String
584
+ # resp.errors[0].error_message #=> String
585
+ #
586
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/CreateMeetingWithAttendees AWS API Documentation
587
+ #
588
+ # @overload create_meeting_with_attendees(params = {})
589
+ # @param [Hash] params ({})
590
+ def create_meeting_with_attendees(params = {}, options = {})
591
+ req = build_request(:create_meeting_with_attendees, params)
592
+ req.send_request(options)
593
+ end
594
+
595
+ # Deletes an attendee from the specified Amazon Chime SDK meeting and
596
+ # deletes their `JoinToken`. Attendees are automatically deleted when a
597
+ # Amazon Chime SDK meeting is deleted. For more information about the
598
+ # Amazon Chime SDK, see [Using the Amazon Chime SDK][1] in the *Amazon
599
+ # Chime Developer Guide*.
600
+ #
601
+ #
602
+ #
603
+ # [1]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html
604
+ #
605
+ # @option params [required, String] :meeting_id
606
+ # The Amazon Chime SDK meeting ID.
607
+ #
608
+ # @option params [required, String] :attendee_id
609
+ # The Amazon Chime SDK attendee ID.
610
+ #
611
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
612
+ #
613
+ # @example Request syntax with placeholder values
614
+ #
615
+ # resp = client.delete_attendee({
616
+ # meeting_id: "String", # required
617
+ # attendee_id: "String", # required
618
+ # })
619
+ #
620
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/DeleteAttendee AWS API Documentation
621
+ #
622
+ # @overload delete_attendee(params = {})
623
+ # @param [Hash] params ({})
624
+ def delete_attendee(params = {}, options = {})
625
+ req = build_request(:delete_attendee, params)
626
+ req.send_request(options)
627
+ end
628
+
629
+ # Deletes the specified Amazon Chime SDK meeting. The operation deletes
630
+ # all attendees, disconnects all clients, and prevents new clients from
631
+ # joining the meeting. For more information about the Amazon Chime SDK,
632
+ # see [Using the Amazon Chime SDK][1] in the *Amazon Chime Developer
633
+ # Guide*.
634
+ #
635
+ #
636
+ #
637
+ # [1]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html
638
+ #
639
+ # @option params [required, String] :meeting_id
640
+ # The Amazon Chime SDK meeting ID.
641
+ #
642
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
643
+ #
644
+ # @example Request syntax with placeholder values
645
+ #
646
+ # resp = client.delete_meeting({
647
+ # meeting_id: "String", # required
648
+ # })
649
+ #
650
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/DeleteMeeting AWS API Documentation
651
+ #
652
+ # @overload delete_meeting(params = {})
653
+ # @param [Hash] params ({})
654
+ def delete_meeting(params = {}, options = {})
655
+ req = build_request(:delete_meeting, params)
656
+ req.send_request(options)
657
+ end
658
+
659
+ # Gets the Amazon Chime SDK attendee details for a specified meeting ID
660
+ # and attendee ID. For more information about the Amazon Chime SDK, see
661
+ # [Using the Amazon Chime SDK][1] in the *Amazon Chime Developer Guide*.
662
+ #
663
+ #
664
+ #
665
+ # [1]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html
666
+ #
667
+ # @option params [required, String] :meeting_id
668
+ # The Amazon Chime SDK meeting ID.
669
+ #
670
+ # @option params [required, String] :attendee_id
671
+ # The Amazon Chime SDK attendee ID.
672
+ #
673
+ # @return [Types::GetAttendeeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
674
+ #
675
+ # * {Types::GetAttendeeResponse#attendee #attendee} => Types::Attendee
676
+ #
677
+ # @example Request syntax with placeholder values
678
+ #
679
+ # resp = client.get_attendee({
680
+ # meeting_id: "String", # required
681
+ # attendee_id: "String", # required
682
+ # })
683
+ #
684
+ # @example Response structure
685
+ #
686
+ # resp.attendee.external_user_id #=> String
687
+ # resp.attendee.attendee_id #=> String
688
+ # resp.attendee.join_token #=> String
689
+ #
690
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/GetAttendee AWS API Documentation
691
+ #
692
+ # @overload get_attendee(params = {})
693
+ # @param [Hash] params ({})
694
+ def get_attendee(params = {}, options = {})
695
+ req = build_request(:get_attendee, params)
696
+ req.send_request(options)
697
+ end
698
+
699
+ # Gets the Amazon Chime SDK meeting details for the specified meeting
700
+ # ID. For more information about the Amazon Chime SDK, see [Using the
701
+ # Amazon Chime SDK][1] in the *Amazon Chime Developer Guide*.
702
+ #
703
+ #
704
+ #
705
+ # [1]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html
706
+ #
707
+ # @option params [required, String] :meeting_id
708
+ # The Amazon Chime SDK meeting ID.
709
+ #
710
+ # @return [Types::GetMeetingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
711
+ #
712
+ # * {Types::GetMeetingResponse#meeting #meeting} => Types::Meeting
713
+ #
714
+ # @example Request syntax with placeholder values
715
+ #
716
+ # resp = client.get_meeting({
717
+ # meeting_id: "String", # required
718
+ # })
719
+ #
720
+ # @example Response structure
721
+ #
722
+ # resp.meeting.meeting_id #=> String
723
+ # resp.meeting.meeting_host_id #=> String
724
+ # resp.meeting.external_meeting_id #=> String
725
+ # resp.meeting.media_region #=> String
726
+ # resp.meeting.media_placement.audio_host_url #=> String
727
+ # resp.meeting.media_placement.audio_fallback_url #=> String
728
+ # resp.meeting.media_placement.signaling_url #=> String
729
+ # resp.meeting.media_placement.turn_control_url #=> String
730
+ # resp.meeting.media_placement.screen_data_url #=> String
731
+ # resp.meeting.media_placement.screen_viewing_url #=> String
732
+ # resp.meeting.media_placement.screen_sharing_url #=> String
733
+ # resp.meeting.media_placement.event_ingestion_url #=> String
734
+ #
735
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/GetMeeting AWS API Documentation
736
+ #
737
+ # @overload get_meeting(params = {})
738
+ # @param [Hash] params ({})
739
+ def get_meeting(params = {}, options = {})
740
+ req = build_request(:get_meeting, params)
741
+ req.send_request(options)
742
+ end
743
+
744
+ # Lists the attendees for the specified Amazon Chime SDK meeting. For
745
+ # more information about the Amazon Chime SDK, see [Using the Amazon
746
+ # Chime SDK][1] in the *Amazon Chime Developer Guide*.
747
+ #
748
+ #
749
+ #
750
+ # [1]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html
751
+ #
752
+ # @option params [required, String] :meeting_id
753
+ # The Amazon Chime SDK meeting ID.
754
+ #
755
+ # @option params [String] :next_token
756
+ # The token to use to retrieve the next page of results.
757
+ #
758
+ # @option params [Integer] :max_results
759
+ # The maximum number of results to return in a single call.
760
+ #
761
+ # @return [Types::ListAttendeesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
762
+ #
763
+ # * {Types::ListAttendeesResponse#attendees #attendees} => Array&lt;Types::Attendee&gt;
764
+ # * {Types::ListAttendeesResponse#next_token #next_token} => String
765
+ #
766
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
767
+ #
768
+ # @example Request syntax with placeholder values
769
+ #
770
+ # resp = client.list_attendees({
771
+ # meeting_id: "String", # required
772
+ # next_token: "String",
773
+ # max_results: 1,
774
+ # })
775
+ #
776
+ # @example Response structure
777
+ #
778
+ # resp.attendees #=> Array
779
+ # resp.attendees[0].external_user_id #=> String
780
+ # resp.attendees[0].attendee_id #=> String
781
+ # resp.attendees[0].join_token #=> String
782
+ # resp.next_token #=> String
783
+ #
784
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/ListAttendees AWS API Documentation
785
+ #
786
+ # @overload list_attendees(params = {})
787
+ # @param [Hash] params ({})
788
+ def list_attendees(params = {}, options = {})
789
+ req = build_request(:list_attendees, params)
790
+ req.send_request(options)
791
+ end
792
+
793
+ # Starts transcription for the specified `meetingId`.
794
+ #
795
+ # @option params [required, String] :meeting_id
796
+ # The unique ID of the meeting being transcribed.
797
+ #
798
+ # @option params [required, Types::TranscriptionConfiguration] :transcription_configuration
799
+ # The configuration for the current transcription operation. Must
800
+ # contain `EngineTranscribeSettings` or
801
+ # `EngineTranscribeMedicalSettings`.
802
+ #
803
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
804
+ #
805
+ # @example Request syntax with placeholder values
806
+ #
807
+ # resp = client.start_meeting_transcription({
808
+ # meeting_id: "String", # required
809
+ # transcription_configuration: { # required
810
+ # engine_transcribe_settings: {
811
+ # language_code: "en-US", # required, accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN
812
+ # vocabulary_filter_method: "remove", # accepts remove, mask, tag
813
+ # vocabulary_filter_name: "String",
814
+ # vocabulary_name: "String",
815
+ # region: "us-east-2", # accepts us-east-2, us-east-1, us-west-2, ap-northeast-2, ap-southeast-2, ap-northeast-1, ca-central-1, eu-central-1, eu-west-1, eu-west-2, sa-east-1, auto
816
+ # },
817
+ # engine_transcribe_medical_settings: {
818
+ # language_code: "en-US", # required, accepts en-US
819
+ # specialty: "PRIMARYCARE", # required, accepts PRIMARYCARE, CARDIOLOGY, NEUROLOGY, ONCOLOGY, RADIOLOGY, UROLOGY
820
+ # type: "CONVERSATION", # required, accepts CONVERSATION, DICTATION
821
+ # vocabulary_name: "String",
822
+ # region: "us-east-1", # accepts us-east-1, us-east-2, us-west-2, ap-southeast-2, ca-central-1, eu-west-1, auto
823
+ # },
824
+ # },
825
+ # })
826
+ #
827
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/StartMeetingTranscription AWS API Documentation
828
+ #
829
+ # @overload start_meeting_transcription(params = {})
830
+ # @param [Hash] params ({})
831
+ def start_meeting_transcription(params = {}, options = {})
832
+ req = build_request(:start_meeting_transcription, params)
833
+ req.send_request(options)
834
+ end
835
+
836
+ # Stops transcription for the specified `meetingId`.
837
+ #
838
+ # @option params [required, String] :meeting_id
839
+ # The unique ID of the meeting for which you stop transcription.
840
+ #
841
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
842
+ #
843
+ # @example Request syntax with placeholder values
844
+ #
845
+ # resp = client.stop_meeting_transcription({
846
+ # meeting_id: "String", # required
847
+ # })
848
+ #
849
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/StopMeetingTranscription AWS API Documentation
850
+ #
851
+ # @overload stop_meeting_transcription(params = {})
852
+ # @param [Hash] params ({})
853
+ def stop_meeting_transcription(params = {}, options = {})
854
+ req = build_request(:stop_meeting_transcription, params)
855
+ req.send_request(options)
856
+ end
857
+
858
+ # @!endgroup
859
+
860
+ # @param params ({})
861
+ # @api private
862
+ def build_request(operation_name, params = {})
863
+ handlers = @handlers.for(operation_name)
864
+ context = Seahorse::Client::RequestContext.new(
865
+ operation_name: operation_name,
866
+ operation: config.api.operation(operation_name),
867
+ client: self,
868
+ params: params,
869
+ config: config)
870
+ context[:gem_name] = 'aws-sdk-chimesdkmeetings'
871
+ context[:gem_version] = '1.0.0'
872
+ Seahorse::Client::Request.new(handlers, context)
873
+ end
874
+
875
+ # @api private
876
+ # @deprecated
877
+ def waiter_names
878
+ []
879
+ end
880
+
881
+ class << self
882
+
883
+ # @api private
884
+ attr_reader :identifier
885
+
886
+ # @api private
887
+ def errors_module
888
+ Errors
889
+ end
890
+
891
+ end
892
+ end
893
+ end