aws-sdk-chime 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/aws-sdk-chime.rb +47 -0
- data/lib/aws-sdk-chime/client.rb +886 -0
- data/lib/aws-sdk-chime/client_api.rb +523 -0
- data/lib/aws-sdk-chime/customizations.rb +0 -0
- data/lib/aws-sdk-chime/errors.rb +14 -0
- data/lib/aws-sdk-chime/resource.rb +23 -0
- data/lib/aws-sdk-chime/types.rb +809 -0
- metadata +88 -0
|
File without changes
|
|
@@ -0,0 +1,14 @@
|
|
|
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::Chime
|
|
9
|
+
module Errors
|
|
10
|
+
|
|
11
|
+
extend Aws::Errors::DynamicErrors
|
|
12
|
+
|
|
13
|
+
end
|
|
14
|
+
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::Chime
|
|
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,809 @@
|
|
|
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::Chime
|
|
9
|
+
module Types
|
|
10
|
+
|
|
11
|
+
# The Amazon Chime account details. An AWS account can have multiple
|
|
12
|
+
# Amazon Chime accounts.
|
|
13
|
+
#
|
|
14
|
+
# @!attribute [rw] aws_account_id
|
|
15
|
+
# The AWS account ID.
|
|
16
|
+
# @return [String]
|
|
17
|
+
#
|
|
18
|
+
# @!attribute [rw] account_id
|
|
19
|
+
# The Amazon Chime account ID.
|
|
20
|
+
# @return [String]
|
|
21
|
+
#
|
|
22
|
+
# @!attribute [rw] name
|
|
23
|
+
# The Amazon Chime account name.
|
|
24
|
+
# @return [String]
|
|
25
|
+
#
|
|
26
|
+
# @!attribute [rw] account_type
|
|
27
|
+
# The Amazon Chime account type. For more information about different
|
|
28
|
+
# account types, see [Managing Your Amazon Chime Accounts][1] in the
|
|
29
|
+
# *Amazon Chime Administration Guide*.
|
|
30
|
+
#
|
|
31
|
+
#
|
|
32
|
+
#
|
|
33
|
+
# [1]: http://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html
|
|
34
|
+
# @return [String]
|
|
35
|
+
#
|
|
36
|
+
# @!attribute [rw] created_timestamp
|
|
37
|
+
# The Amazon Chime account creation timestamp, in ISO 8601 format.
|
|
38
|
+
# @return [Time]
|
|
39
|
+
#
|
|
40
|
+
# @!attribute [rw] default_license
|
|
41
|
+
# The default license for the Amazon Chime account.
|
|
42
|
+
# @return [String]
|
|
43
|
+
#
|
|
44
|
+
# @!attribute [rw] supported_licenses
|
|
45
|
+
# Supported licenses for the Amazon Chime account.
|
|
46
|
+
# @return [Array<String>]
|
|
47
|
+
#
|
|
48
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/Account AWS API Documentation
|
|
49
|
+
#
|
|
50
|
+
class Account < Struct.new(
|
|
51
|
+
:aws_account_id,
|
|
52
|
+
:account_id,
|
|
53
|
+
:name,
|
|
54
|
+
:account_type,
|
|
55
|
+
:created_timestamp,
|
|
56
|
+
:default_license,
|
|
57
|
+
:supported_licenses)
|
|
58
|
+
include Aws::Structure
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
# Settings related to the Amazon Chime account. This includes settings
|
|
62
|
+
# that start or stop remote control of shared screens, or start or stop
|
|
63
|
+
# the dial-out option in the Amazon Chime web application. For more
|
|
64
|
+
# information about these settings, see [Use the Policies Page][1] in
|
|
65
|
+
# the *Amazon Chime Administration Guide*.
|
|
66
|
+
#
|
|
67
|
+
#
|
|
68
|
+
#
|
|
69
|
+
# [1]: http://docs.aws.amazon.com/chime/latest/ag/policies.html
|
|
70
|
+
#
|
|
71
|
+
# @note When making an API call, you may pass AccountSettings
|
|
72
|
+
# data as a hash:
|
|
73
|
+
#
|
|
74
|
+
# {
|
|
75
|
+
# disable_remote_control: false,
|
|
76
|
+
# enable_dial_out: false,
|
|
77
|
+
# }
|
|
78
|
+
#
|
|
79
|
+
# @!attribute [rw] disable_remote_control
|
|
80
|
+
# Setting that stops or starts remote control of shared screens during
|
|
81
|
+
# meetings.
|
|
82
|
+
# @return [Boolean]
|
|
83
|
+
#
|
|
84
|
+
# @!attribute [rw] enable_dial_out
|
|
85
|
+
# Setting that allows meeting participants to choose the **Call me at
|
|
86
|
+
# a phone number** option. For more information, see [Join a Meeting
|
|
87
|
+
# without the Amazon Chime App][1].
|
|
88
|
+
#
|
|
89
|
+
#
|
|
90
|
+
#
|
|
91
|
+
# [1]: http://docs.aws.amazon.com/chime/latest/ug/chime-join-meeting.html
|
|
92
|
+
# @return [Boolean]
|
|
93
|
+
#
|
|
94
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/AccountSettings AWS API Documentation
|
|
95
|
+
#
|
|
96
|
+
class AccountSettings < Struct.new(
|
|
97
|
+
:disable_remote_control,
|
|
98
|
+
:enable_dial_out)
|
|
99
|
+
include Aws::Structure
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
# @note When making an API call, you may pass BatchSuspendUserRequest
|
|
103
|
+
# data as a hash:
|
|
104
|
+
#
|
|
105
|
+
# {
|
|
106
|
+
# account_id: "NonEmptyString", # required
|
|
107
|
+
# user_id_list: ["NonEmptyString"], # required
|
|
108
|
+
# }
|
|
109
|
+
#
|
|
110
|
+
# @!attribute [rw] account_id
|
|
111
|
+
# The Amazon Chime account ID.
|
|
112
|
+
# @return [String]
|
|
113
|
+
#
|
|
114
|
+
# @!attribute [rw] user_id_list
|
|
115
|
+
# The request containing the user IDs to suspend.
|
|
116
|
+
# @return [Array<String>]
|
|
117
|
+
#
|
|
118
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchSuspendUserRequest AWS API Documentation
|
|
119
|
+
#
|
|
120
|
+
class BatchSuspendUserRequest < Struct.new(
|
|
121
|
+
:account_id,
|
|
122
|
+
:user_id_list)
|
|
123
|
+
include Aws::Structure
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
# @!attribute [rw] user_errors
|
|
127
|
+
# If the BatchSuspendUser action fails for one or more of the user IDs
|
|
128
|
+
# in the request, a list of the user IDs is returned, along with error
|
|
129
|
+
# codes and error messages.
|
|
130
|
+
# @return [Array<Types::UserError>]
|
|
131
|
+
#
|
|
132
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchSuspendUserResponse AWS API Documentation
|
|
133
|
+
#
|
|
134
|
+
class BatchSuspendUserResponse < Struct.new(
|
|
135
|
+
:user_errors)
|
|
136
|
+
include Aws::Structure
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
# @note When making an API call, you may pass BatchUnsuspendUserRequest
|
|
140
|
+
# data as a hash:
|
|
141
|
+
#
|
|
142
|
+
# {
|
|
143
|
+
# account_id: "NonEmptyString", # required
|
|
144
|
+
# user_id_list: ["NonEmptyString"], # required
|
|
145
|
+
# }
|
|
146
|
+
#
|
|
147
|
+
# @!attribute [rw] account_id
|
|
148
|
+
# The Amazon Chime account ID.
|
|
149
|
+
# @return [String]
|
|
150
|
+
#
|
|
151
|
+
# @!attribute [rw] user_id_list
|
|
152
|
+
# The request containing the user IDs to unsuspend.
|
|
153
|
+
# @return [Array<String>]
|
|
154
|
+
#
|
|
155
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUnsuspendUserRequest AWS API Documentation
|
|
156
|
+
#
|
|
157
|
+
class BatchUnsuspendUserRequest < Struct.new(
|
|
158
|
+
:account_id,
|
|
159
|
+
:user_id_list)
|
|
160
|
+
include Aws::Structure
|
|
161
|
+
end
|
|
162
|
+
|
|
163
|
+
# @!attribute [rw] user_errors
|
|
164
|
+
# If the BatchUnsuspendUser action fails for one or more of the user
|
|
165
|
+
# IDs in the request, a list of the user IDs is returned, along with
|
|
166
|
+
# error codes and error messages.
|
|
167
|
+
# @return [Array<Types::UserError>]
|
|
168
|
+
#
|
|
169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUnsuspendUserResponse AWS API Documentation
|
|
170
|
+
#
|
|
171
|
+
class BatchUnsuspendUserResponse < Struct.new(
|
|
172
|
+
:user_errors)
|
|
173
|
+
include Aws::Structure
|
|
174
|
+
end
|
|
175
|
+
|
|
176
|
+
# @note When making an API call, you may pass BatchUpdateUserRequest
|
|
177
|
+
# data as a hash:
|
|
178
|
+
#
|
|
179
|
+
# {
|
|
180
|
+
# account_id: "NonEmptyString", # required
|
|
181
|
+
# update_user_request_items: [ # required
|
|
182
|
+
# {
|
|
183
|
+
# user_id: "NonEmptyString", # required
|
|
184
|
+
# license_type: "Basic", # accepts Basic, Plus, Pro, ProTrial
|
|
185
|
+
# },
|
|
186
|
+
# ],
|
|
187
|
+
# }
|
|
188
|
+
#
|
|
189
|
+
# @!attribute [rw] account_id
|
|
190
|
+
# The Amazon Chime account ID.
|
|
191
|
+
# @return [String]
|
|
192
|
+
#
|
|
193
|
+
# @!attribute [rw] update_user_request_items
|
|
194
|
+
# The request containing the user IDs and details to update.
|
|
195
|
+
# @return [Array<Types::UpdateUserRequestItem>]
|
|
196
|
+
#
|
|
197
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUpdateUserRequest AWS API Documentation
|
|
198
|
+
#
|
|
199
|
+
class BatchUpdateUserRequest < Struct.new(
|
|
200
|
+
:account_id,
|
|
201
|
+
:update_user_request_items)
|
|
202
|
+
include Aws::Structure
|
|
203
|
+
end
|
|
204
|
+
|
|
205
|
+
# @!attribute [rw] user_errors
|
|
206
|
+
# If the BatchUpdateUser action fails for one or more of the user IDs
|
|
207
|
+
# in the request, a list of the user IDs is returned, along with error
|
|
208
|
+
# codes and error messages.
|
|
209
|
+
# @return [Array<Types::UserError>]
|
|
210
|
+
#
|
|
211
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUpdateUserResponse AWS API Documentation
|
|
212
|
+
#
|
|
213
|
+
class BatchUpdateUserResponse < Struct.new(
|
|
214
|
+
:user_errors)
|
|
215
|
+
include Aws::Structure
|
|
216
|
+
end
|
|
217
|
+
|
|
218
|
+
# @note When making an API call, you may pass CreateAccountRequest
|
|
219
|
+
# data as a hash:
|
|
220
|
+
#
|
|
221
|
+
# {
|
|
222
|
+
# name: "AccountName", # required
|
|
223
|
+
# }
|
|
224
|
+
#
|
|
225
|
+
# @!attribute [rw] name
|
|
226
|
+
# The name of the Amazon Chime account.
|
|
227
|
+
# @return [String]
|
|
228
|
+
#
|
|
229
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAccountRequest AWS API Documentation
|
|
230
|
+
#
|
|
231
|
+
class CreateAccountRequest < Struct.new(
|
|
232
|
+
:name)
|
|
233
|
+
include Aws::Structure
|
|
234
|
+
end
|
|
235
|
+
|
|
236
|
+
# @!attribute [rw] account
|
|
237
|
+
# The Amazon Chime account details.
|
|
238
|
+
# @return [Types::Account]
|
|
239
|
+
#
|
|
240
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAccountResponse AWS API Documentation
|
|
241
|
+
#
|
|
242
|
+
class CreateAccountResponse < Struct.new(
|
|
243
|
+
:account)
|
|
244
|
+
include Aws::Structure
|
|
245
|
+
end
|
|
246
|
+
|
|
247
|
+
# @note When making an API call, you may pass DeleteAccountRequest
|
|
248
|
+
# data as a hash:
|
|
249
|
+
#
|
|
250
|
+
# {
|
|
251
|
+
# account_id: "NonEmptyString", # required
|
|
252
|
+
# }
|
|
253
|
+
#
|
|
254
|
+
# @!attribute [rw] account_id
|
|
255
|
+
# The Amazon Chime account ID.
|
|
256
|
+
# @return [String]
|
|
257
|
+
#
|
|
258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAccountRequest AWS API Documentation
|
|
259
|
+
#
|
|
260
|
+
class DeleteAccountRequest < Struct.new(
|
|
261
|
+
:account_id)
|
|
262
|
+
include Aws::Structure
|
|
263
|
+
end
|
|
264
|
+
|
|
265
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAccountResponse AWS API Documentation
|
|
266
|
+
#
|
|
267
|
+
class DeleteAccountResponse < Aws::EmptyStructure; end
|
|
268
|
+
|
|
269
|
+
# @note When making an API call, you may pass GetAccountRequest
|
|
270
|
+
# data as a hash:
|
|
271
|
+
#
|
|
272
|
+
# {
|
|
273
|
+
# account_id: "NonEmptyString", # required
|
|
274
|
+
# }
|
|
275
|
+
#
|
|
276
|
+
# @!attribute [rw] account_id
|
|
277
|
+
# The Amazon Chime account ID.
|
|
278
|
+
# @return [String]
|
|
279
|
+
#
|
|
280
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccountRequest AWS API Documentation
|
|
281
|
+
#
|
|
282
|
+
class GetAccountRequest < Struct.new(
|
|
283
|
+
:account_id)
|
|
284
|
+
include Aws::Structure
|
|
285
|
+
end
|
|
286
|
+
|
|
287
|
+
# @!attribute [rw] account
|
|
288
|
+
# The Amazon Chime account details.
|
|
289
|
+
# @return [Types::Account]
|
|
290
|
+
#
|
|
291
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccountResponse AWS API Documentation
|
|
292
|
+
#
|
|
293
|
+
class GetAccountResponse < Struct.new(
|
|
294
|
+
:account)
|
|
295
|
+
include Aws::Structure
|
|
296
|
+
end
|
|
297
|
+
|
|
298
|
+
# @note When making an API call, you may pass GetAccountSettingsRequest
|
|
299
|
+
# data as a hash:
|
|
300
|
+
#
|
|
301
|
+
# {
|
|
302
|
+
# account_id: "NonEmptyString", # required
|
|
303
|
+
# }
|
|
304
|
+
#
|
|
305
|
+
# @!attribute [rw] account_id
|
|
306
|
+
# The Amazon Chime account ID.
|
|
307
|
+
# @return [String]
|
|
308
|
+
#
|
|
309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccountSettingsRequest AWS API Documentation
|
|
310
|
+
#
|
|
311
|
+
class GetAccountSettingsRequest < Struct.new(
|
|
312
|
+
:account_id)
|
|
313
|
+
include Aws::Structure
|
|
314
|
+
end
|
|
315
|
+
|
|
316
|
+
# @!attribute [rw] account_settings
|
|
317
|
+
# The Amazon Chime account settings.
|
|
318
|
+
# @return [Types::AccountSettings]
|
|
319
|
+
#
|
|
320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccountSettingsResponse AWS API Documentation
|
|
321
|
+
#
|
|
322
|
+
class GetAccountSettingsResponse < Struct.new(
|
|
323
|
+
:account_settings)
|
|
324
|
+
include Aws::Structure
|
|
325
|
+
end
|
|
326
|
+
|
|
327
|
+
# @note When making an API call, you may pass GetUserRequest
|
|
328
|
+
# data as a hash:
|
|
329
|
+
#
|
|
330
|
+
# {
|
|
331
|
+
# account_id: "NonEmptyString", # required
|
|
332
|
+
# user_id: "NonEmptyString", # required
|
|
333
|
+
# }
|
|
334
|
+
#
|
|
335
|
+
# @!attribute [rw] account_id
|
|
336
|
+
# The Amazon Chime account ID.
|
|
337
|
+
# @return [String]
|
|
338
|
+
#
|
|
339
|
+
# @!attribute [rw] user_id
|
|
340
|
+
# The user ID.
|
|
341
|
+
# @return [String]
|
|
342
|
+
#
|
|
343
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetUserRequest AWS API Documentation
|
|
344
|
+
#
|
|
345
|
+
class GetUserRequest < Struct.new(
|
|
346
|
+
:account_id,
|
|
347
|
+
:user_id)
|
|
348
|
+
include Aws::Structure
|
|
349
|
+
end
|
|
350
|
+
|
|
351
|
+
# @!attribute [rw] user
|
|
352
|
+
# The user details.
|
|
353
|
+
# @return [Types::User]
|
|
354
|
+
#
|
|
355
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetUserResponse AWS API Documentation
|
|
356
|
+
#
|
|
357
|
+
class GetUserResponse < Struct.new(
|
|
358
|
+
:user)
|
|
359
|
+
include Aws::Structure
|
|
360
|
+
end
|
|
361
|
+
|
|
362
|
+
# Invitation object returned after emailing users to invite them to join
|
|
363
|
+
# the Amazon Chime `Team` account.
|
|
364
|
+
#
|
|
365
|
+
# @!attribute [rw] invite_id
|
|
366
|
+
# The invite ID.
|
|
367
|
+
# @return [String]
|
|
368
|
+
#
|
|
369
|
+
# @!attribute [rw] status
|
|
370
|
+
# The status of the invite.
|
|
371
|
+
# @return [String]
|
|
372
|
+
#
|
|
373
|
+
# @!attribute [rw] email_address
|
|
374
|
+
# The email address to which the invite is sent.
|
|
375
|
+
# @return [String]
|
|
376
|
+
#
|
|
377
|
+
# @!attribute [rw] email_status
|
|
378
|
+
# The status of the invite email.
|
|
379
|
+
# @return [String]
|
|
380
|
+
#
|
|
381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/Invite AWS API Documentation
|
|
382
|
+
#
|
|
383
|
+
class Invite < Struct.new(
|
|
384
|
+
:invite_id,
|
|
385
|
+
:status,
|
|
386
|
+
:email_address,
|
|
387
|
+
:email_status)
|
|
388
|
+
include Aws::Structure
|
|
389
|
+
end
|
|
390
|
+
|
|
391
|
+
# @note When making an API call, you may pass InviteUsersRequest
|
|
392
|
+
# data as a hash:
|
|
393
|
+
#
|
|
394
|
+
# {
|
|
395
|
+
# account_id: "NonEmptyString", # required
|
|
396
|
+
# user_email_list: ["EmailAddress"], # required
|
|
397
|
+
# }
|
|
398
|
+
#
|
|
399
|
+
# @!attribute [rw] account_id
|
|
400
|
+
# The Amazon Chime account ID.
|
|
401
|
+
# @return [String]
|
|
402
|
+
#
|
|
403
|
+
# @!attribute [rw] user_email_list
|
|
404
|
+
# The user email addresses to which to send the invite.
|
|
405
|
+
# @return [Array<String>]
|
|
406
|
+
#
|
|
407
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/InviteUsersRequest AWS API Documentation
|
|
408
|
+
#
|
|
409
|
+
class InviteUsersRequest < Struct.new(
|
|
410
|
+
:account_id,
|
|
411
|
+
:user_email_list)
|
|
412
|
+
include Aws::Structure
|
|
413
|
+
end
|
|
414
|
+
|
|
415
|
+
# @!attribute [rw] invites
|
|
416
|
+
# The invite details.
|
|
417
|
+
# @return [Array<Types::Invite>]
|
|
418
|
+
#
|
|
419
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/InviteUsersResponse AWS API Documentation
|
|
420
|
+
#
|
|
421
|
+
class InviteUsersResponse < Struct.new(
|
|
422
|
+
:invites)
|
|
423
|
+
include Aws::Structure
|
|
424
|
+
end
|
|
425
|
+
|
|
426
|
+
# @note When making an API call, you may pass ListAccountsRequest
|
|
427
|
+
# data as a hash:
|
|
428
|
+
#
|
|
429
|
+
# {
|
|
430
|
+
# name: "AccountName",
|
|
431
|
+
# user_email: "EmailAddress",
|
|
432
|
+
# next_token: "String",
|
|
433
|
+
# max_results: 1,
|
|
434
|
+
# }
|
|
435
|
+
#
|
|
436
|
+
# @!attribute [rw] name
|
|
437
|
+
# Amazon Chime account name prefix with which to filter results.
|
|
438
|
+
# @return [String]
|
|
439
|
+
#
|
|
440
|
+
# @!attribute [rw] user_email
|
|
441
|
+
# User email address with which to filter results.
|
|
442
|
+
# @return [String]
|
|
443
|
+
#
|
|
444
|
+
# @!attribute [rw] next_token
|
|
445
|
+
# The token to use to retrieve the next page of results.
|
|
446
|
+
# @return [String]
|
|
447
|
+
#
|
|
448
|
+
# @!attribute [rw] max_results
|
|
449
|
+
# The maximum number of results to return in a single call. Defaults
|
|
450
|
+
# to 100.
|
|
451
|
+
# @return [Integer]
|
|
452
|
+
#
|
|
453
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAccountsRequest AWS API Documentation
|
|
454
|
+
#
|
|
455
|
+
class ListAccountsRequest < Struct.new(
|
|
456
|
+
:name,
|
|
457
|
+
:user_email,
|
|
458
|
+
:next_token,
|
|
459
|
+
:max_results)
|
|
460
|
+
include Aws::Structure
|
|
461
|
+
end
|
|
462
|
+
|
|
463
|
+
# @!attribute [rw] accounts
|
|
464
|
+
# List of Amazon Chime accounts and account details.
|
|
465
|
+
# @return [Array<Types::Account>]
|
|
466
|
+
#
|
|
467
|
+
# @!attribute [rw] next_token
|
|
468
|
+
# The token to use to retrieve the next page of results.
|
|
469
|
+
# @return [String]
|
|
470
|
+
#
|
|
471
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAccountsResponse AWS API Documentation
|
|
472
|
+
#
|
|
473
|
+
class ListAccountsResponse < Struct.new(
|
|
474
|
+
:accounts,
|
|
475
|
+
:next_token)
|
|
476
|
+
include Aws::Structure
|
|
477
|
+
end
|
|
478
|
+
|
|
479
|
+
# @note When making an API call, you may pass ListUsersRequest
|
|
480
|
+
# data as a hash:
|
|
481
|
+
#
|
|
482
|
+
# {
|
|
483
|
+
# account_id: "NonEmptyString", # required
|
|
484
|
+
# max_results: 1,
|
|
485
|
+
# next_token: "String",
|
|
486
|
+
# }
|
|
487
|
+
#
|
|
488
|
+
# @!attribute [rw] account_id
|
|
489
|
+
# The Amazon Chime account ID.
|
|
490
|
+
# @return [String]
|
|
491
|
+
#
|
|
492
|
+
# @!attribute [rw] max_results
|
|
493
|
+
# The maximum number of results to return in a single call. Defaults
|
|
494
|
+
# to 100.
|
|
495
|
+
# @return [Integer]
|
|
496
|
+
#
|
|
497
|
+
# @!attribute [rw] next_token
|
|
498
|
+
# The token to use to retrieve the next page of results.
|
|
499
|
+
# @return [String]
|
|
500
|
+
#
|
|
501
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListUsersRequest AWS API Documentation
|
|
502
|
+
#
|
|
503
|
+
class ListUsersRequest < Struct.new(
|
|
504
|
+
:account_id,
|
|
505
|
+
:max_results,
|
|
506
|
+
:next_token)
|
|
507
|
+
include Aws::Structure
|
|
508
|
+
end
|
|
509
|
+
|
|
510
|
+
# @!attribute [rw] users
|
|
511
|
+
# List of users and user details.
|
|
512
|
+
# @return [Array<Types::User>]
|
|
513
|
+
#
|
|
514
|
+
# @!attribute [rw] next_token
|
|
515
|
+
# The token to use to retrieve the next page of results.
|
|
516
|
+
# @return [String]
|
|
517
|
+
#
|
|
518
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListUsersResponse AWS API Documentation
|
|
519
|
+
#
|
|
520
|
+
class ListUsersResponse < Struct.new(
|
|
521
|
+
:users,
|
|
522
|
+
:next_token)
|
|
523
|
+
include Aws::Structure
|
|
524
|
+
end
|
|
525
|
+
|
|
526
|
+
# @note When making an API call, you may pass LogoutUserRequest
|
|
527
|
+
# data as a hash:
|
|
528
|
+
#
|
|
529
|
+
# {
|
|
530
|
+
# account_id: "NonEmptyString", # required
|
|
531
|
+
# user_id: "NonEmptyString", # required
|
|
532
|
+
# }
|
|
533
|
+
#
|
|
534
|
+
# @!attribute [rw] account_id
|
|
535
|
+
# The Amazon Chime account ID.
|
|
536
|
+
# @return [String]
|
|
537
|
+
#
|
|
538
|
+
# @!attribute [rw] user_id
|
|
539
|
+
# The user ID.
|
|
540
|
+
# @return [String]
|
|
541
|
+
#
|
|
542
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/LogoutUserRequest AWS API Documentation
|
|
543
|
+
#
|
|
544
|
+
class LogoutUserRequest < Struct.new(
|
|
545
|
+
:account_id,
|
|
546
|
+
:user_id)
|
|
547
|
+
include Aws::Structure
|
|
548
|
+
end
|
|
549
|
+
|
|
550
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/LogoutUserResponse AWS API Documentation
|
|
551
|
+
#
|
|
552
|
+
class LogoutUserResponse < Aws::EmptyStructure; end
|
|
553
|
+
|
|
554
|
+
# @note When making an API call, you may pass ResetPersonalPINRequest
|
|
555
|
+
# data as a hash:
|
|
556
|
+
#
|
|
557
|
+
# {
|
|
558
|
+
# account_id: "NonEmptyString", # required
|
|
559
|
+
# user_id: "NonEmptyString", # required
|
|
560
|
+
# }
|
|
561
|
+
#
|
|
562
|
+
# @!attribute [rw] account_id
|
|
563
|
+
# The Amazon Chime account ID.
|
|
564
|
+
# @return [String]
|
|
565
|
+
#
|
|
566
|
+
# @!attribute [rw] user_id
|
|
567
|
+
# The user ID.
|
|
568
|
+
# @return [String]
|
|
569
|
+
#
|
|
570
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ResetPersonalPINRequest AWS API Documentation
|
|
571
|
+
#
|
|
572
|
+
class ResetPersonalPINRequest < Struct.new(
|
|
573
|
+
:account_id,
|
|
574
|
+
:user_id)
|
|
575
|
+
include Aws::Structure
|
|
576
|
+
end
|
|
577
|
+
|
|
578
|
+
# @!attribute [rw] user
|
|
579
|
+
# The user details and new personal meeting PIN.
|
|
580
|
+
# @return [Types::User]
|
|
581
|
+
#
|
|
582
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ResetPersonalPINResponse AWS API Documentation
|
|
583
|
+
#
|
|
584
|
+
class ResetPersonalPINResponse < Struct.new(
|
|
585
|
+
:user)
|
|
586
|
+
include Aws::Structure
|
|
587
|
+
end
|
|
588
|
+
|
|
589
|
+
# @note When making an API call, you may pass UpdateAccountRequest
|
|
590
|
+
# data as a hash:
|
|
591
|
+
#
|
|
592
|
+
# {
|
|
593
|
+
# account_id: "NonEmptyString", # required
|
|
594
|
+
# name: "AccountName",
|
|
595
|
+
# }
|
|
596
|
+
#
|
|
597
|
+
# @!attribute [rw] account_id
|
|
598
|
+
# The Amazon Chime account ID.
|
|
599
|
+
# @return [String]
|
|
600
|
+
#
|
|
601
|
+
# @!attribute [rw] name
|
|
602
|
+
# The new name for the specified Amazon Chime account.
|
|
603
|
+
# @return [String]
|
|
604
|
+
#
|
|
605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAccountRequest AWS API Documentation
|
|
606
|
+
#
|
|
607
|
+
class UpdateAccountRequest < Struct.new(
|
|
608
|
+
:account_id,
|
|
609
|
+
:name)
|
|
610
|
+
include Aws::Structure
|
|
611
|
+
end
|
|
612
|
+
|
|
613
|
+
# @!attribute [rw] account
|
|
614
|
+
# The updated Amazon Chime account details.
|
|
615
|
+
# @return [Types::Account]
|
|
616
|
+
#
|
|
617
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAccountResponse AWS API Documentation
|
|
618
|
+
#
|
|
619
|
+
class UpdateAccountResponse < Struct.new(
|
|
620
|
+
:account)
|
|
621
|
+
include Aws::Structure
|
|
622
|
+
end
|
|
623
|
+
|
|
624
|
+
# @note When making an API call, you may pass UpdateAccountSettingsRequest
|
|
625
|
+
# data as a hash:
|
|
626
|
+
#
|
|
627
|
+
# {
|
|
628
|
+
# account_id: "NonEmptyString", # required
|
|
629
|
+
# account_settings: { # required
|
|
630
|
+
# disable_remote_control: false,
|
|
631
|
+
# enable_dial_out: false,
|
|
632
|
+
# },
|
|
633
|
+
# }
|
|
634
|
+
#
|
|
635
|
+
# @!attribute [rw] account_id
|
|
636
|
+
# The Amazon Chime account ID.
|
|
637
|
+
# @return [String]
|
|
638
|
+
#
|
|
639
|
+
# @!attribute [rw] account_settings
|
|
640
|
+
# The Amazon Chime account settings to update.
|
|
641
|
+
# @return [Types::AccountSettings]
|
|
642
|
+
#
|
|
643
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAccountSettingsRequest AWS API Documentation
|
|
644
|
+
#
|
|
645
|
+
class UpdateAccountSettingsRequest < Struct.new(
|
|
646
|
+
:account_id,
|
|
647
|
+
:account_settings)
|
|
648
|
+
include Aws::Structure
|
|
649
|
+
end
|
|
650
|
+
|
|
651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAccountSettingsResponse AWS API Documentation
|
|
652
|
+
#
|
|
653
|
+
class UpdateAccountSettingsResponse < Aws::EmptyStructure; end
|
|
654
|
+
|
|
655
|
+
# @note When making an API call, you may pass UpdateUserRequest
|
|
656
|
+
# data as a hash:
|
|
657
|
+
#
|
|
658
|
+
# {
|
|
659
|
+
# account_id: "NonEmptyString", # required
|
|
660
|
+
# user_id: "NonEmptyString", # required
|
|
661
|
+
# license_type: "Basic", # accepts Basic, Plus, Pro, ProTrial
|
|
662
|
+
# }
|
|
663
|
+
#
|
|
664
|
+
# @!attribute [rw] account_id
|
|
665
|
+
# The Amazon Chime account ID.
|
|
666
|
+
# @return [String]
|
|
667
|
+
#
|
|
668
|
+
# @!attribute [rw] user_id
|
|
669
|
+
# The user ID.
|
|
670
|
+
# @return [String]
|
|
671
|
+
#
|
|
672
|
+
# @!attribute [rw] license_type
|
|
673
|
+
# The user license type to update. This must be a supported license
|
|
674
|
+
# type for the Amazon Chime account that the user belongs to.
|
|
675
|
+
# @return [String]
|
|
676
|
+
#
|
|
677
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateUserRequest AWS API Documentation
|
|
678
|
+
#
|
|
679
|
+
class UpdateUserRequest < Struct.new(
|
|
680
|
+
:account_id,
|
|
681
|
+
:user_id,
|
|
682
|
+
:license_type)
|
|
683
|
+
include Aws::Structure
|
|
684
|
+
end
|
|
685
|
+
|
|
686
|
+
# The user ID and user fields to update, used with the BatchUpdateUser
|
|
687
|
+
# action.
|
|
688
|
+
#
|
|
689
|
+
# @note When making an API call, you may pass UpdateUserRequestItem
|
|
690
|
+
# data as a hash:
|
|
691
|
+
#
|
|
692
|
+
# {
|
|
693
|
+
# user_id: "NonEmptyString", # required
|
|
694
|
+
# license_type: "Basic", # accepts Basic, Plus, Pro, ProTrial
|
|
695
|
+
# }
|
|
696
|
+
#
|
|
697
|
+
# @!attribute [rw] user_id
|
|
698
|
+
# The user ID.
|
|
699
|
+
# @return [String]
|
|
700
|
+
#
|
|
701
|
+
# @!attribute [rw] license_type
|
|
702
|
+
# The user license type.
|
|
703
|
+
# @return [String]
|
|
704
|
+
#
|
|
705
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateUserRequestItem AWS API Documentation
|
|
706
|
+
#
|
|
707
|
+
class UpdateUserRequestItem < Struct.new(
|
|
708
|
+
:user_id,
|
|
709
|
+
:license_type)
|
|
710
|
+
include Aws::Structure
|
|
711
|
+
end
|
|
712
|
+
|
|
713
|
+
# @!attribute [rw] user
|
|
714
|
+
# The updated user details.
|
|
715
|
+
# @return [Types::User]
|
|
716
|
+
#
|
|
717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateUserResponse AWS API Documentation
|
|
718
|
+
#
|
|
719
|
+
class UpdateUserResponse < Struct.new(
|
|
720
|
+
:user)
|
|
721
|
+
include Aws::Structure
|
|
722
|
+
end
|
|
723
|
+
|
|
724
|
+
# The user on the Amazon Chime account.
|
|
725
|
+
#
|
|
726
|
+
# @!attribute [rw] user_id
|
|
727
|
+
# The user ID.
|
|
728
|
+
# @return [String]
|
|
729
|
+
#
|
|
730
|
+
# @!attribute [rw] account_id
|
|
731
|
+
# The Amazon Chime account ID.
|
|
732
|
+
# @return [String]
|
|
733
|
+
#
|
|
734
|
+
# @!attribute [rw] primary_email
|
|
735
|
+
# The primary email address of the user.
|
|
736
|
+
# @return [String]
|
|
737
|
+
#
|
|
738
|
+
# @!attribute [rw] display_name
|
|
739
|
+
# The display name of the user.
|
|
740
|
+
# @return [String]
|
|
741
|
+
#
|
|
742
|
+
# @!attribute [rw] license_type
|
|
743
|
+
# The license type for the user.
|
|
744
|
+
# @return [String]
|
|
745
|
+
#
|
|
746
|
+
# @!attribute [rw] user_registration_status
|
|
747
|
+
# The user registration status.
|
|
748
|
+
# @return [String]
|
|
749
|
+
#
|
|
750
|
+
# @!attribute [rw] user_invitation_status
|
|
751
|
+
# The user invite status.
|
|
752
|
+
# @return [String]
|
|
753
|
+
#
|
|
754
|
+
# @!attribute [rw] registered_on
|
|
755
|
+
# Date and time when the user is registered, in ISO 8601 format.
|
|
756
|
+
# @return [Time]
|
|
757
|
+
#
|
|
758
|
+
# @!attribute [rw] invited_on
|
|
759
|
+
# Date and time when the user is invited to the Amazon Chime account,
|
|
760
|
+
# in ISO 8601 format.
|
|
761
|
+
# @return [Time]
|
|
762
|
+
#
|
|
763
|
+
# @!attribute [rw] personal_pin
|
|
764
|
+
# The user's personal meeting PIN.
|
|
765
|
+
# @return [String]
|
|
766
|
+
#
|
|
767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/User AWS API Documentation
|
|
768
|
+
#
|
|
769
|
+
class User < Struct.new(
|
|
770
|
+
:user_id,
|
|
771
|
+
:account_id,
|
|
772
|
+
:primary_email,
|
|
773
|
+
:display_name,
|
|
774
|
+
:license_type,
|
|
775
|
+
:user_registration_status,
|
|
776
|
+
:user_invitation_status,
|
|
777
|
+
:registered_on,
|
|
778
|
+
:invited_on,
|
|
779
|
+
:personal_pin)
|
|
780
|
+
include Aws::Structure
|
|
781
|
+
end
|
|
782
|
+
|
|
783
|
+
# The list of errors returned when errors are encountered during the
|
|
784
|
+
# BatchSuspendUser, BatchUnsuspendUser, or BatchUpdateUser actions. This
|
|
785
|
+
# includes user IDs, error codes, and error messages.
|
|
786
|
+
#
|
|
787
|
+
# @!attribute [rw] user_id
|
|
788
|
+
# The user ID for which the action failed.
|
|
789
|
+
# @return [String]
|
|
790
|
+
#
|
|
791
|
+
# @!attribute [rw] error_code
|
|
792
|
+
# The error code.
|
|
793
|
+
# @return [String]
|
|
794
|
+
#
|
|
795
|
+
# @!attribute [rw] error_message
|
|
796
|
+
# The error message.
|
|
797
|
+
# @return [String]
|
|
798
|
+
#
|
|
799
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UserError AWS API Documentation
|
|
800
|
+
#
|
|
801
|
+
class UserError < Struct.new(
|
|
802
|
+
:user_id,
|
|
803
|
+
:error_code,
|
|
804
|
+
:error_message)
|
|
805
|
+
include Aws::Structure
|
|
806
|
+
end
|
|
807
|
+
|
|
808
|
+
end
|
|
809
|
+
end
|