aws-sdk-chime 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- 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
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: fa09ad3cad59400b618d00995e213d383252e184
|
4
|
+
data.tar.gz: 51e073233cfe096cc2db39f1b67615637e5d09db
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 404e997d7cfd65a5ac6a7bbf84ab223c679d44b41185eb9a195be85b46c1055e9765205814fa5d9ad08888e08cdd5437d5d794a2ea18c7cd7e1482ae39d59f3e
|
7
|
+
data.tar.gz: 4abf3ecf6de9935c392f7ddca04ab527978f63d9ef72870f89d42fac3b887c9a197138960aeb10ef5fc21bf45a2aebe5f52d4ac5a2022e074236518180ff2dbb
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-chime/types'
|
12
|
+
require_relative 'aws-sdk-chime/client_api'
|
13
|
+
require_relative 'aws-sdk-chime/client'
|
14
|
+
require_relative 'aws-sdk-chime/errors'
|
15
|
+
require_relative 'aws-sdk-chime/resource'
|
16
|
+
require_relative 'aws-sdk-chime/customizations'
|
17
|
+
|
18
|
+
# This module provides support for Amazon Chime. This module is available in the
|
19
|
+
# `aws-sdk-chime` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from Amazon Chime all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::Chime::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::Chime
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,886 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
22
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
23
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
24
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
25
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
26
|
+
|
27
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:chime)
|
28
|
+
|
29
|
+
module Aws::Chime
|
30
|
+
class Client < Seahorse::Client::Base
|
31
|
+
|
32
|
+
include Aws::ClientStubs
|
33
|
+
|
34
|
+
@identifier = :chime
|
35
|
+
|
36
|
+
set_api(ClientApi::API)
|
37
|
+
|
38
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
39
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
40
|
+
add_plugin(Aws::Plugins::Logging)
|
41
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
42
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
43
|
+
add_plugin(Aws::Plugins::UserAgent)
|
44
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
45
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
46
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
47
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
48
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
49
|
+
add_plugin(Aws::Plugins::StubResponses)
|
50
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
51
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
52
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
53
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
54
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
55
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
56
|
+
|
57
|
+
# @overload initialize(options)
|
58
|
+
# @param [Hash] options
|
59
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
60
|
+
# Your AWS credentials. This can be an instance of any one of the
|
61
|
+
# following classes:
|
62
|
+
#
|
63
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
64
|
+
# credentials.
|
65
|
+
#
|
66
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
67
|
+
# from an EC2 IMDS on an EC2 instance.
|
68
|
+
#
|
69
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
70
|
+
# shared file, such as `~/.aws/config`.
|
71
|
+
#
|
72
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
73
|
+
#
|
74
|
+
# When `:credentials` are not configured directly, the following
|
75
|
+
# locations will be searched for credentials:
|
76
|
+
#
|
77
|
+
# * `Aws.config[:credentials]`
|
78
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
79
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
80
|
+
# * `~/.aws/credentials`
|
81
|
+
# * `~/.aws/config`
|
82
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
83
|
+
# very aggressive. Construct and pass an instance of
|
84
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
85
|
+
# timeouts.
|
86
|
+
#
|
87
|
+
# @option options [required, String] :region
|
88
|
+
# The AWS region to connect to. The configured `:region` is
|
89
|
+
# used to determine the service `:endpoint`. When not passed,
|
90
|
+
# a default `:region` is search for in the following locations:
|
91
|
+
#
|
92
|
+
# * `Aws.config[:region]`
|
93
|
+
# * `ENV['AWS_REGION']`
|
94
|
+
# * `ENV['AMAZON_REGION']`
|
95
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
96
|
+
# * `~/.aws/credentials`
|
97
|
+
# * `~/.aws/config`
|
98
|
+
#
|
99
|
+
# @option options [String] :access_key_id
|
100
|
+
#
|
101
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
102
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
103
|
+
# this client.
|
104
|
+
#
|
105
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
106
|
+
# Allows you to provide an identifier for this client which will be attached to
|
107
|
+
# all generated client side metrics. Defaults to an empty string.
|
108
|
+
#
|
109
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
110
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
111
|
+
# agent is running on, where client metrics will be published via UDP.
|
112
|
+
#
|
113
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
114
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
115
|
+
# will use the Client Side Monitoring Agent Publisher.
|
116
|
+
#
|
117
|
+
# @option options [Boolean] :convert_params (true)
|
118
|
+
# When `true`, an attempt is made to coerce request parameters into
|
119
|
+
# the required types.
|
120
|
+
#
|
121
|
+
# @option options [String] :endpoint
|
122
|
+
# The client endpoint is normally constructed from the `:region`
|
123
|
+
# option. You should only configure an `:endpoint` when connecting
|
124
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
125
|
+
#
|
126
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
127
|
+
# The log formatter.
|
128
|
+
#
|
129
|
+
# @option options [Symbol] :log_level (:info)
|
130
|
+
# The log level to send messages to the `:logger` at.
|
131
|
+
#
|
132
|
+
# @option options [Logger] :logger
|
133
|
+
# The Logger instance to send log messages to. If this option
|
134
|
+
# is not set, logging will be disabled.
|
135
|
+
#
|
136
|
+
# @option options [String] :profile ("default")
|
137
|
+
# Used when loading credentials from the shared credentials file
|
138
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
139
|
+
#
|
140
|
+
# @option options [Float] :retry_base_delay (0.3)
|
141
|
+
# The base delay in seconds used by the default backoff function.
|
142
|
+
#
|
143
|
+
# @option options [Symbol] :retry_jitter (:none)
|
144
|
+
# A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
|
145
|
+
#
|
146
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
147
|
+
#
|
148
|
+
# @option options [Integer] :retry_limit (3)
|
149
|
+
# The maximum number of times to retry failed requests. Only
|
150
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
151
|
+
# are retried. Generally, these are throttling errors, data
|
152
|
+
# checksum errors, networking errors, timeout errors and auth
|
153
|
+
# errors from expired credentials.
|
154
|
+
#
|
155
|
+
# @option options [Integer] :retry_max_delay (0)
|
156
|
+
# The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
|
157
|
+
#
|
158
|
+
# @option options [String] :secret_access_key
|
159
|
+
#
|
160
|
+
# @option options [String] :session_token
|
161
|
+
#
|
162
|
+
# @option options [Boolean] :stub_responses (false)
|
163
|
+
# Causes the client to return stubbed responses. By default
|
164
|
+
# fake responses are generated and returned. You can specify
|
165
|
+
# the response data to return or errors to raise by calling
|
166
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
167
|
+
#
|
168
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
169
|
+
# requests are made, and retries are disabled.
|
170
|
+
#
|
171
|
+
# @option options [Boolean] :validate_params (true)
|
172
|
+
# When `true`, request parameters are validated before
|
173
|
+
# sending the request.
|
174
|
+
#
|
175
|
+
def initialize(*args)
|
176
|
+
super
|
177
|
+
end
|
178
|
+
|
179
|
+
# @!group API Operations
|
180
|
+
|
181
|
+
# Suspends up to 50 users from a `Team` or `EnterpriseLWA` Amazon Chime
|
182
|
+
# account. For more information about different account types, see
|
183
|
+
# [Managing Your Amazon Chime Accounts][1] in the *Amazon Chime
|
184
|
+
# Administration Guide*.
|
185
|
+
#
|
186
|
+
# Users suspended from a `Team` account are dissociated from the
|
187
|
+
# account, but they can continue to use Amazon Chime as free users. To
|
188
|
+
# remove the suspension from suspended `Team` account users, invite them
|
189
|
+
# to the `Team` account again. You can use the InviteUsers action to do
|
190
|
+
# so.
|
191
|
+
#
|
192
|
+
# Users suspended from an `EnterpriseLWA` account are immediately signed
|
193
|
+
# out of Amazon Chime and are no longer able to sign in. To remove the
|
194
|
+
# suspension from suspended `EnterpriseLWA` account users, use the
|
195
|
+
# BatchUnsuspendUser action.
|
196
|
+
#
|
197
|
+
# To sign out users without suspending them, use the LogoutUser action.
|
198
|
+
#
|
199
|
+
#
|
200
|
+
#
|
201
|
+
# [1]: http://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html
|
202
|
+
#
|
203
|
+
# @option params [required, String] :account_id
|
204
|
+
# The Amazon Chime account ID.
|
205
|
+
#
|
206
|
+
# @option params [required, Array<String>] :user_id_list
|
207
|
+
# The request containing the user IDs to suspend.
|
208
|
+
#
|
209
|
+
# @return [Types::BatchSuspendUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
210
|
+
#
|
211
|
+
# * {Types::BatchSuspendUserResponse#user_errors #user_errors} => Array<Types::UserError>
|
212
|
+
#
|
213
|
+
# @example Request syntax with placeholder values
|
214
|
+
#
|
215
|
+
# resp = client.batch_suspend_user({
|
216
|
+
# account_id: "NonEmptyString", # required
|
217
|
+
# user_id_list: ["NonEmptyString"], # required
|
218
|
+
# })
|
219
|
+
#
|
220
|
+
# @example Response structure
|
221
|
+
#
|
222
|
+
# resp.user_errors #=> Array
|
223
|
+
# resp.user_errors[0].user_id #=> String
|
224
|
+
# resp.user_errors[0].error_code #=> String, one of "Unauthorized", "Forbidden", "NotFound", "BadRequest", "Conflict", "ServiceFailure", "ServiceUnavailable", "Unprocessable", "Throttled", "PreconditionFailed"
|
225
|
+
# resp.user_errors[0].error_message #=> String
|
226
|
+
#
|
227
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchSuspendUser AWS API Documentation
|
228
|
+
#
|
229
|
+
# @overload batch_suspend_user(params = {})
|
230
|
+
# @param [Hash] params ({})
|
231
|
+
def batch_suspend_user(params = {}, options = {})
|
232
|
+
req = build_request(:batch_suspend_user, params)
|
233
|
+
req.send_request(options)
|
234
|
+
end
|
235
|
+
|
236
|
+
# Removes the suspension from up to 50 previously suspended users for
|
237
|
+
# the specified Amazon Chime `EnterpriseLWA` account. Only users on
|
238
|
+
# `EnterpriseLWA` accounts can be unsuspended using this action. For
|
239
|
+
# more information about different account types, see [Managing Your
|
240
|
+
# Amazon Chime Accounts][1] in the *Amazon Chime Administration Guide*.
|
241
|
+
#
|
242
|
+
# Previously suspended users who are unsuspended using this action are
|
243
|
+
# returned to `Registered` status. Users who are not previously
|
244
|
+
# suspended are ignored.
|
245
|
+
#
|
246
|
+
#
|
247
|
+
#
|
248
|
+
# [1]: http://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html
|
249
|
+
#
|
250
|
+
# @option params [required, String] :account_id
|
251
|
+
# The Amazon Chime account ID.
|
252
|
+
#
|
253
|
+
# @option params [required, Array<String>] :user_id_list
|
254
|
+
# The request containing the user IDs to unsuspend.
|
255
|
+
#
|
256
|
+
# @return [Types::BatchUnsuspendUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
257
|
+
#
|
258
|
+
# * {Types::BatchUnsuspendUserResponse#user_errors #user_errors} => Array<Types::UserError>
|
259
|
+
#
|
260
|
+
# @example Request syntax with placeholder values
|
261
|
+
#
|
262
|
+
# resp = client.batch_unsuspend_user({
|
263
|
+
# account_id: "NonEmptyString", # required
|
264
|
+
# user_id_list: ["NonEmptyString"], # required
|
265
|
+
# })
|
266
|
+
#
|
267
|
+
# @example Response structure
|
268
|
+
#
|
269
|
+
# resp.user_errors #=> Array
|
270
|
+
# resp.user_errors[0].user_id #=> String
|
271
|
+
# resp.user_errors[0].error_code #=> String, one of "Unauthorized", "Forbidden", "NotFound", "BadRequest", "Conflict", "ServiceFailure", "ServiceUnavailable", "Unprocessable", "Throttled", "PreconditionFailed"
|
272
|
+
# resp.user_errors[0].error_message #=> String
|
273
|
+
#
|
274
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUnsuspendUser AWS API Documentation
|
275
|
+
#
|
276
|
+
# @overload batch_unsuspend_user(params = {})
|
277
|
+
# @param [Hash] params ({})
|
278
|
+
def batch_unsuspend_user(params = {}, options = {})
|
279
|
+
req = build_request(:batch_unsuspend_user, params)
|
280
|
+
req.send_request(options)
|
281
|
+
end
|
282
|
+
|
283
|
+
# Updates user details within the UpdateUserRequestItem object for up to
|
284
|
+
# 20 users for the specified Amazon Chime account. Currently, only
|
285
|
+
# `LicenseType` updates are supported for this action.
|
286
|
+
#
|
287
|
+
# @option params [required, String] :account_id
|
288
|
+
# The Amazon Chime account ID.
|
289
|
+
#
|
290
|
+
# @option params [required, Array<Types::UpdateUserRequestItem>] :update_user_request_items
|
291
|
+
# The request containing the user IDs and details to update.
|
292
|
+
#
|
293
|
+
# @return [Types::BatchUpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
294
|
+
#
|
295
|
+
# * {Types::BatchUpdateUserResponse#user_errors #user_errors} => Array<Types::UserError>
|
296
|
+
#
|
297
|
+
# @example Request syntax with placeholder values
|
298
|
+
#
|
299
|
+
# resp = client.batch_update_user({
|
300
|
+
# account_id: "NonEmptyString", # required
|
301
|
+
# update_user_request_items: [ # required
|
302
|
+
# {
|
303
|
+
# user_id: "NonEmptyString", # required
|
304
|
+
# license_type: "Basic", # accepts Basic, Plus, Pro, ProTrial
|
305
|
+
# },
|
306
|
+
# ],
|
307
|
+
# })
|
308
|
+
#
|
309
|
+
# @example Response structure
|
310
|
+
#
|
311
|
+
# resp.user_errors #=> Array
|
312
|
+
# resp.user_errors[0].user_id #=> String
|
313
|
+
# resp.user_errors[0].error_code #=> String, one of "Unauthorized", "Forbidden", "NotFound", "BadRequest", "Conflict", "ServiceFailure", "ServiceUnavailable", "Unprocessable", "Throttled", "PreconditionFailed"
|
314
|
+
# resp.user_errors[0].error_message #=> String
|
315
|
+
#
|
316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUpdateUser AWS API Documentation
|
317
|
+
#
|
318
|
+
# @overload batch_update_user(params = {})
|
319
|
+
# @param [Hash] params ({})
|
320
|
+
def batch_update_user(params = {}, options = {})
|
321
|
+
req = build_request(:batch_update_user, params)
|
322
|
+
req.send_request(options)
|
323
|
+
end
|
324
|
+
|
325
|
+
# Creates an Amazon Chime account under the administrator's AWS
|
326
|
+
# account. Only `Team` account types are currently supported for this
|
327
|
+
# action. For more information about different account types, see
|
328
|
+
# [Managing Your Amazon Chime Accounts][1] in the *Amazon Chime
|
329
|
+
# Administration Guide*.
|
330
|
+
#
|
331
|
+
#
|
332
|
+
#
|
333
|
+
# [1]: http://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html
|
334
|
+
#
|
335
|
+
# @option params [required, String] :name
|
336
|
+
# The name of the Amazon Chime account.
|
337
|
+
#
|
338
|
+
# @return [Types::CreateAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
339
|
+
#
|
340
|
+
# * {Types::CreateAccountResponse#account #account} => Types::Account
|
341
|
+
#
|
342
|
+
# @example Request syntax with placeholder values
|
343
|
+
#
|
344
|
+
# resp = client.create_account({
|
345
|
+
# name: "AccountName", # required
|
346
|
+
# })
|
347
|
+
#
|
348
|
+
# @example Response structure
|
349
|
+
#
|
350
|
+
# resp.account.aws_account_id #=> String
|
351
|
+
# resp.account.account_id #=> String
|
352
|
+
# resp.account.name #=> String
|
353
|
+
# resp.account.account_type #=> String, one of "Team", "EnterpriseDirectory", "EnterpriseLWA", "EnterpriseOIDC"
|
354
|
+
# resp.account.created_timestamp #=> Time
|
355
|
+
# resp.account.default_license #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
356
|
+
# resp.account.supported_licenses #=> Array
|
357
|
+
# resp.account.supported_licenses[0] #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
358
|
+
#
|
359
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAccount AWS API Documentation
|
360
|
+
#
|
361
|
+
# @overload create_account(params = {})
|
362
|
+
# @param [Hash] params ({})
|
363
|
+
def create_account(params = {}, options = {})
|
364
|
+
req = build_request(:create_account, params)
|
365
|
+
req.send_request(options)
|
366
|
+
end
|
367
|
+
|
368
|
+
# Deletes the specified Amazon Chime account. You must suspend all users
|
369
|
+
# before deleting a `Team` account. You can use the BatchSuspendUser
|
370
|
+
# action to do so.
|
371
|
+
#
|
372
|
+
# For `EnterpriseLWA` and `EnterpriseAD` accounts, you must release the
|
373
|
+
# claimed domains for your Amazon Chime account before deletion. As soon
|
374
|
+
# as you release the domain, all users under that account are suspended.
|
375
|
+
#
|
376
|
+
# Deleted accounts appear in your `Disabled` accounts list for 90 days.
|
377
|
+
# To restore a deleted account from your `Disabled` accounts list, you
|
378
|
+
# must contact AWS Support.
|
379
|
+
#
|
380
|
+
# After 90 days, deleted accounts are permanently removed from your
|
381
|
+
# `Disabled` accounts list.
|
382
|
+
#
|
383
|
+
# @option params [required, String] :account_id
|
384
|
+
# The Amazon Chime account ID.
|
385
|
+
#
|
386
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
387
|
+
#
|
388
|
+
# @example Request syntax with placeholder values
|
389
|
+
#
|
390
|
+
# resp = client.delete_account({
|
391
|
+
# account_id: "NonEmptyString", # required
|
392
|
+
# })
|
393
|
+
#
|
394
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAccount AWS API Documentation
|
395
|
+
#
|
396
|
+
# @overload delete_account(params = {})
|
397
|
+
# @param [Hash] params ({})
|
398
|
+
def delete_account(params = {}, options = {})
|
399
|
+
req = build_request(:delete_account, params)
|
400
|
+
req.send_request(options)
|
401
|
+
end
|
402
|
+
|
403
|
+
# Retrieves details for the specified Amazon Chime account, such as
|
404
|
+
# account type and supported licenses.
|
405
|
+
#
|
406
|
+
# @option params [required, String] :account_id
|
407
|
+
# The Amazon Chime account ID.
|
408
|
+
#
|
409
|
+
# @return [Types::GetAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
410
|
+
#
|
411
|
+
# * {Types::GetAccountResponse#account #account} => Types::Account
|
412
|
+
#
|
413
|
+
# @example Request syntax with placeholder values
|
414
|
+
#
|
415
|
+
# resp = client.get_account({
|
416
|
+
# account_id: "NonEmptyString", # required
|
417
|
+
# })
|
418
|
+
#
|
419
|
+
# @example Response structure
|
420
|
+
#
|
421
|
+
# resp.account.aws_account_id #=> String
|
422
|
+
# resp.account.account_id #=> String
|
423
|
+
# resp.account.name #=> String
|
424
|
+
# resp.account.account_type #=> String, one of "Team", "EnterpriseDirectory", "EnterpriseLWA", "EnterpriseOIDC"
|
425
|
+
# resp.account.created_timestamp #=> Time
|
426
|
+
# resp.account.default_license #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
427
|
+
# resp.account.supported_licenses #=> Array
|
428
|
+
# resp.account.supported_licenses[0] #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
429
|
+
#
|
430
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccount AWS API Documentation
|
431
|
+
#
|
432
|
+
# @overload get_account(params = {})
|
433
|
+
# @param [Hash] params ({})
|
434
|
+
def get_account(params = {}, options = {})
|
435
|
+
req = build_request(:get_account, params)
|
436
|
+
req.send_request(options)
|
437
|
+
end
|
438
|
+
|
439
|
+
# Retrieves account settings for the specified Amazon Chime account ID,
|
440
|
+
# such as remote control and dial out settings. For more information
|
441
|
+
# about these settings, see [Use the Policies Page][1] in the *Amazon
|
442
|
+
# Chime Administration Guide*.
|
443
|
+
#
|
444
|
+
#
|
445
|
+
#
|
446
|
+
# [1]: http://docs.aws.amazon.com/chime/latest/ag/policies.html
|
447
|
+
#
|
448
|
+
# @option params [required, String] :account_id
|
449
|
+
# The Amazon Chime account ID.
|
450
|
+
#
|
451
|
+
# @return [Types::GetAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
452
|
+
#
|
453
|
+
# * {Types::GetAccountSettingsResponse#account_settings #account_settings} => Types::AccountSettings
|
454
|
+
#
|
455
|
+
# @example Request syntax with placeholder values
|
456
|
+
#
|
457
|
+
# resp = client.get_account_settings({
|
458
|
+
# account_id: "NonEmptyString", # required
|
459
|
+
# })
|
460
|
+
#
|
461
|
+
# @example Response structure
|
462
|
+
#
|
463
|
+
# resp.account_settings.disable_remote_control #=> Boolean
|
464
|
+
# resp.account_settings.enable_dial_out #=> Boolean
|
465
|
+
#
|
466
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccountSettings AWS API Documentation
|
467
|
+
#
|
468
|
+
# @overload get_account_settings(params = {})
|
469
|
+
# @param [Hash] params ({})
|
470
|
+
def get_account_settings(params = {}, options = {})
|
471
|
+
req = build_request(:get_account_settings, params)
|
472
|
+
req.send_request(options)
|
473
|
+
end
|
474
|
+
|
475
|
+
# Retrieves details for the specified user ID, such as primary email
|
476
|
+
# address, license type, and personal meeting PIN.
|
477
|
+
#
|
478
|
+
# @option params [required, String] :account_id
|
479
|
+
# The Amazon Chime account ID.
|
480
|
+
#
|
481
|
+
# @option params [required, String] :user_id
|
482
|
+
# The user ID.
|
483
|
+
#
|
484
|
+
# @return [Types::GetUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
485
|
+
#
|
486
|
+
# * {Types::GetUserResponse#user #user} => Types::User
|
487
|
+
#
|
488
|
+
# @example Request syntax with placeholder values
|
489
|
+
#
|
490
|
+
# resp = client.get_user({
|
491
|
+
# account_id: "NonEmptyString", # required
|
492
|
+
# user_id: "NonEmptyString", # required
|
493
|
+
# })
|
494
|
+
#
|
495
|
+
# @example Response structure
|
496
|
+
#
|
497
|
+
# resp.user.user_id #=> String
|
498
|
+
# resp.user.account_id #=> String
|
499
|
+
# resp.user.primary_email #=> String
|
500
|
+
# resp.user.display_name #=> String
|
501
|
+
# resp.user.license_type #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
502
|
+
# resp.user.user_registration_status #=> String, one of "Unregistered", "Registered", "Suspended"
|
503
|
+
# resp.user.user_invitation_status #=> String, one of "Pending", "Accepted", "Failed"
|
504
|
+
# resp.user.registered_on #=> Time
|
505
|
+
# resp.user.invited_on #=> Time
|
506
|
+
# resp.user.personal_pin #=> String
|
507
|
+
#
|
508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetUser AWS API Documentation
|
509
|
+
#
|
510
|
+
# @overload get_user(params = {})
|
511
|
+
# @param [Hash] params ({})
|
512
|
+
def get_user(params = {}, options = {})
|
513
|
+
req = build_request(:get_user, params)
|
514
|
+
req.send_request(options)
|
515
|
+
end
|
516
|
+
|
517
|
+
# Sends email invites to as many as 50 users, inviting them to the
|
518
|
+
# specified Amazon Chime `Team` account. Only `Team` account types are
|
519
|
+
# currently supported for this action.
|
520
|
+
#
|
521
|
+
# @option params [required, String] :account_id
|
522
|
+
# The Amazon Chime account ID.
|
523
|
+
#
|
524
|
+
# @option params [required, Array<String>] :user_email_list
|
525
|
+
# The user email addresses to which to send the invite.
|
526
|
+
#
|
527
|
+
# @return [Types::InviteUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
528
|
+
#
|
529
|
+
# * {Types::InviteUsersResponse#invites #invites} => Array<Types::Invite>
|
530
|
+
#
|
531
|
+
# @example Request syntax with placeholder values
|
532
|
+
#
|
533
|
+
# resp = client.invite_users({
|
534
|
+
# account_id: "NonEmptyString", # required
|
535
|
+
# user_email_list: ["EmailAddress"], # required
|
536
|
+
# })
|
537
|
+
#
|
538
|
+
# @example Response structure
|
539
|
+
#
|
540
|
+
# resp.invites #=> Array
|
541
|
+
# resp.invites[0].invite_id #=> String
|
542
|
+
# resp.invites[0].status #=> String, one of "Pending", "Accepted", "Failed"
|
543
|
+
# resp.invites[0].email_address #=> String
|
544
|
+
# resp.invites[0].email_status #=> String, one of "NotSent", "Sent", "Failed"
|
545
|
+
#
|
546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/InviteUsers AWS API Documentation
|
547
|
+
#
|
548
|
+
# @overload invite_users(params = {})
|
549
|
+
# @param [Hash] params ({})
|
550
|
+
def invite_users(params = {}, options = {})
|
551
|
+
req = build_request(:invite_users, params)
|
552
|
+
req.send_request(options)
|
553
|
+
end
|
554
|
+
|
555
|
+
# Lists the Amazon Chime accounts under the administrator's AWS
|
556
|
+
# account. You can filter accounts by account name prefix. To find out
|
557
|
+
# which Amazon Chime account a user belongs to, you can filter by the
|
558
|
+
# user's email address, which returns one account result.
|
559
|
+
#
|
560
|
+
# @option params [String] :name
|
561
|
+
# Amazon Chime account name prefix with which to filter results.
|
562
|
+
#
|
563
|
+
# @option params [String] :user_email
|
564
|
+
# User email address with which to filter results.
|
565
|
+
#
|
566
|
+
# @option params [String] :next_token
|
567
|
+
# The token to use to retrieve the next page of results.
|
568
|
+
#
|
569
|
+
# @option params [Integer] :max_results
|
570
|
+
# The maximum number of results to return in a single call. Defaults to
|
571
|
+
# 100.
|
572
|
+
#
|
573
|
+
# @return [Types::ListAccountsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
574
|
+
#
|
575
|
+
# * {Types::ListAccountsResponse#accounts #accounts} => Array<Types::Account>
|
576
|
+
# * {Types::ListAccountsResponse#next_token #next_token} => String
|
577
|
+
#
|
578
|
+
# @example Request syntax with placeholder values
|
579
|
+
#
|
580
|
+
# resp = client.list_accounts({
|
581
|
+
# name: "AccountName",
|
582
|
+
# user_email: "EmailAddress",
|
583
|
+
# next_token: "String",
|
584
|
+
# max_results: 1,
|
585
|
+
# })
|
586
|
+
#
|
587
|
+
# @example Response structure
|
588
|
+
#
|
589
|
+
# resp.accounts #=> Array
|
590
|
+
# resp.accounts[0].aws_account_id #=> String
|
591
|
+
# resp.accounts[0].account_id #=> String
|
592
|
+
# resp.accounts[0].name #=> String
|
593
|
+
# resp.accounts[0].account_type #=> String, one of "Team", "EnterpriseDirectory", "EnterpriseLWA", "EnterpriseOIDC"
|
594
|
+
# resp.accounts[0].created_timestamp #=> Time
|
595
|
+
# resp.accounts[0].default_license #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
596
|
+
# resp.accounts[0].supported_licenses #=> Array
|
597
|
+
# resp.accounts[0].supported_licenses[0] #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
598
|
+
# resp.next_token #=> String
|
599
|
+
#
|
600
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAccounts AWS API Documentation
|
601
|
+
#
|
602
|
+
# @overload list_accounts(params = {})
|
603
|
+
# @param [Hash] params ({})
|
604
|
+
def list_accounts(params = {}, options = {})
|
605
|
+
req = build_request(:list_accounts, params)
|
606
|
+
req.send_request(options)
|
607
|
+
end
|
608
|
+
|
609
|
+
# Lists the users that belong to the specified Amazon Chime account.
|
610
|
+
#
|
611
|
+
# @option params [required, String] :account_id
|
612
|
+
# The Amazon Chime account ID.
|
613
|
+
#
|
614
|
+
# @option params [Integer] :max_results
|
615
|
+
# The maximum number of results to return in a single call. Defaults to
|
616
|
+
# 100.
|
617
|
+
#
|
618
|
+
# @option params [String] :next_token
|
619
|
+
# The token to use to retrieve the next page of results.
|
620
|
+
#
|
621
|
+
# @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
622
|
+
#
|
623
|
+
# * {Types::ListUsersResponse#users #users} => Array<Types::User>
|
624
|
+
# * {Types::ListUsersResponse#next_token #next_token} => String
|
625
|
+
#
|
626
|
+
# @example Request syntax with placeholder values
|
627
|
+
#
|
628
|
+
# resp = client.list_users({
|
629
|
+
# account_id: "NonEmptyString", # required
|
630
|
+
# max_results: 1,
|
631
|
+
# next_token: "String",
|
632
|
+
# })
|
633
|
+
#
|
634
|
+
# @example Response structure
|
635
|
+
#
|
636
|
+
# resp.users #=> Array
|
637
|
+
# resp.users[0].user_id #=> String
|
638
|
+
# resp.users[0].account_id #=> String
|
639
|
+
# resp.users[0].primary_email #=> String
|
640
|
+
# resp.users[0].display_name #=> String
|
641
|
+
# resp.users[0].license_type #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
642
|
+
# resp.users[0].user_registration_status #=> String, one of "Unregistered", "Registered", "Suspended"
|
643
|
+
# resp.users[0].user_invitation_status #=> String, one of "Pending", "Accepted", "Failed"
|
644
|
+
# resp.users[0].registered_on #=> Time
|
645
|
+
# resp.users[0].invited_on #=> Time
|
646
|
+
# resp.users[0].personal_pin #=> String
|
647
|
+
# resp.next_token #=> String
|
648
|
+
#
|
649
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListUsers AWS API Documentation
|
650
|
+
#
|
651
|
+
# @overload list_users(params = {})
|
652
|
+
# @param [Hash] params ({})
|
653
|
+
def list_users(params = {}, options = {})
|
654
|
+
req = build_request(:list_users, params)
|
655
|
+
req.send_request(options)
|
656
|
+
end
|
657
|
+
|
658
|
+
# Logs out the specified user from all of the devices they are currently
|
659
|
+
# logged into.
|
660
|
+
#
|
661
|
+
# @option params [required, String] :account_id
|
662
|
+
# The Amazon Chime account ID.
|
663
|
+
#
|
664
|
+
# @option params [required, String] :user_id
|
665
|
+
# The user ID.
|
666
|
+
#
|
667
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
668
|
+
#
|
669
|
+
# @example Request syntax with placeholder values
|
670
|
+
#
|
671
|
+
# resp = client.logout_user({
|
672
|
+
# account_id: "NonEmptyString", # required
|
673
|
+
# user_id: "NonEmptyString", # required
|
674
|
+
# })
|
675
|
+
#
|
676
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/LogoutUser AWS API Documentation
|
677
|
+
#
|
678
|
+
# @overload logout_user(params = {})
|
679
|
+
# @param [Hash] params ({})
|
680
|
+
def logout_user(params = {}, options = {})
|
681
|
+
req = build_request(:logout_user, params)
|
682
|
+
req.send_request(options)
|
683
|
+
end
|
684
|
+
|
685
|
+
# Resets the personal meeting PIN for the specified user on an Amazon
|
686
|
+
# Chime account. Returns the User object with the updated personal
|
687
|
+
# meeting PIN.
|
688
|
+
#
|
689
|
+
# @option params [required, String] :account_id
|
690
|
+
# The Amazon Chime account ID.
|
691
|
+
#
|
692
|
+
# @option params [required, String] :user_id
|
693
|
+
# The user ID.
|
694
|
+
#
|
695
|
+
# @return [Types::ResetPersonalPINResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
696
|
+
#
|
697
|
+
# * {Types::ResetPersonalPINResponse#user #user} => Types::User
|
698
|
+
#
|
699
|
+
# @example Request syntax with placeholder values
|
700
|
+
#
|
701
|
+
# resp = client.reset_personal_pin({
|
702
|
+
# account_id: "NonEmptyString", # required
|
703
|
+
# user_id: "NonEmptyString", # required
|
704
|
+
# })
|
705
|
+
#
|
706
|
+
# @example Response structure
|
707
|
+
#
|
708
|
+
# resp.user.user_id #=> String
|
709
|
+
# resp.user.account_id #=> String
|
710
|
+
# resp.user.primary_email #=> String
|
711
|
+
# resp.user.display_name #=> String
|
712
|
+
# resp.user.license_type #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
713
|
+
# resp.user.user_registration_status #=> String, one of "Unregistered", "Registered", "Suspended"
|
714
|
+
# resp.user.user_invitation_status #=> String, one of "Pending", "Accepted", "Failed"
|
715
|
+
# resp.user.registered_on #=> Time
|
716
|
+
# resp.user.invited_on #=> Time
|
717
|
+
# resp.user.personal_pin #=> String
|
718
|
+
#
|
719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ResetPersonalPIN AWS API Documentation
|
720
|
+
#
|
721
|
+
# @overload reset_personal_pin(params = {})
|
722
|
+
# @param [Hash] params ({})
|
723
|
+
def reset_personal_pin(params = {}, options = {})
|
724
|
+
req = build_request(:reset_personal_pin, params)
|
725
|
+
req.send_request(options)
|
726
|
+
end
|
727
|
+
|
728
|
+
# Updates account details for the specified Amazon Chime account.
|
729
|
+
# Currently, only account name updates are supported for this action.
|
730
|
+
#
|
731
|
+
# @option params [required, String] :account_id
|
732
|
+
# The Amazon Chime account ID.
|
733
|
+
#
|
734
|
+
# @option params [String] :name
|
735
|
+
# The new name for the specified Amazon Chime account.
|
736
|
+
#
|
737
|
+
# @return [Types::UpdateAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
738
|
+
#
|
739
|
+
# * {Types::UpdateAccountResponse#account #account} => Types::Account
|
740
|
+
#
|
741
|
+
# @example Request syntax with placeholder values
|
742
|
+
#
|
743
|
+
# resp = client.update_account({
|
744
|
+
# account_id: "NonEmptyString", # required
|
745
|
+
# name: "AccountName",
|
746
|
+
# })
|
747
|
+
#
|
748
|
+
# @example Response structure
|
749
|
+
#
|
750
|
+
# resp.account.aws_account_id #=> String
|
751
|
+
# resp.account.account_id #=> String
|
752
|
+
# resp.account.name #=> String
|
753
|
+
# resp.account.account_type #=> String, one of "Team", "EnterpriseDirectory", "EnterpriseLWA", "EnterpriseOIDC"
|
754
|
+
# resp.account.created_timestamp #=> Time
|
755
|
+
# resp.account.default_license #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
756
|
+
# resp.account.supported_licenses #=> Array
|
757
|
+
# resp.account.supported_licenses[0] #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
758
|
+
#
|
759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAccount AWS API Documentation
|
760
|
+
#
|
761
|
+
# @overload update_account(params = {})
|
762
|
+
# @param [Hash] params ({})
|
763
|
+
def update_account(params = {}, options = {})
|
764
|
+
req = build_request(:update_account, params)
|
765
|
+
req.send_request(options)
|
766
|
+
end
|
767
|
+
|
768
|
+
# Updates the settings for the specified Amazon Chime account. You can
|
769
|
+
# update settings for remote control of shared screens, or for the
|
770
|
+
# dial-out option. For more information about these settings, see [Use
|
771
|
+
# the Policies Page][1] in the *Amazon Chime Administration Guide*.
|
772
|
+
#
|
773
|
+
#
|
774
|
+
#
|
775
|
+
# [1]: http://docs.aws.amazon.com/chime/latest/ag/policies.html
|
776
|
+
#
|
777
|
+
# @option params [required, String] :account_id
|
778
|
+
# The Amazon Chime account ID.
|
779
|
+
#
|
780
|
+
# @option params [required, Types::AccountSettings] :account_settings
|
781
|
+
# The Amazon Chime account settings to update.
|
782
|
+
#
|
783
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
784
|
+
#
|
785
|
+
# @example Request syntax with placeholder values
|
786
|
+
#
|
787
|
+
# resp = client.update_account_settings({
|
788
|
+
# account_id: "NonEmptyString", # required
|
789
|
+
# account_settings: { # required
|
790
|
+
# disable_remote_control: false,
|
791
|
+
# enable_dial_out: false,
|
792
|
+
# },
|
793
|
+
# })
|
794
|
+
#
|
795
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAccountSettings AWS API Documentation
|
796
|
+
#
|
797
|
+
# @overload update_account_settings(params = {})
|
798
|
+
# @param [Hash] params ({})
|
799
|
+
def update_account_settings(params = {}, options = {})
|
800
|
+
req = build_request(:update_account_settings, params)
|
801
|
+
req.send_request(options)
|
802
|
+
end
|
803
|
+
|
804
|
+
# Updates user details for a specified user ID. Currently, only
|
805
|
+
# `LicenseType` updates are supported for this action.
|
806
|
+
#
|
807
|
+
# @option params [required, String] :account_id
|
808
|
+
# The Amazon Chime account ID.
|
809
|
+
#
|
810
|
+
# @option params [required, String] :user_id
|
811
|
+
# The user ID.
|
812
|
+
#
|
813
|
+
# @option params [String] :license_type
|
814
|
+
# The user license type to update. This must be a supported license type
|
815
|
+
# for the Amazon Chime account that the user belongs to.
|
816
|
+
#
|
817
|
+
# @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
818
|
+
#
|
819
|
+
# * {Types::UpdateUserResponse#user #user} => Types::User
|
820
|
+
#
|
821
|
+
# @example Request syntax with placeholder values
|
822
|
+
#
|
823
|
+
# resp = client.update_user({
|
824
|
+
# account_id: "NonEmptyString", # required
|
825
|
+
# user_id: "NonEmptyString", # required
|
826
|
+
# license_type: "Basic", # accepts Basic, Plus, Pro, ProTrial
|
827
|
+
# })
|
828
|
+
#
|
829
|
+
# @example Response structure
|
830
|
+
#
|
831
|
+
# resp.user.user_id #=> String
|
832
|
+
# resp.user.account_id #=> String
|
833
|
+
# resp.user.primary_email #=> String
|
834
|
+
# resp.user.display_name #=> String
|
835
|
+
# resp.user.license_type #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
836
|
+
# resp.user.user_registration_status #=> String, one of "Unregistered", "Registered", "Suspended"
|
837
|
+
# resp.user.user_invitation_status #=> String, one of "Pending", "Accepted", "Failed"
|
838
|
+
# resp.user.registered_on #=> Time
|
839
|
+
# resp.user.invited_on #=> Time
|
840
|
+
# resp.user.personal_pin #=> String
|
841
|
+
#
|
842
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateUser AWS API Documentation
|
843
|
+
#
|
844
|
+
# @overload update_user(params = {})
|
845
|
+
# @param [Hash] params ({})
|
846
|
+
def update_user(params = {}, options = {})
|
847
|
+
req = build_request(:update_user, params)
|
848
|
+
req.send_request(options)
|
849
|
+
end
|
850
|
+
|
851
|
+
# @!endgroup
|
852
|
+
|
853
|
+
# @param params ({})
|
854
|
+
# @api private
|
855
|
+
def build_request(operation_name, params = {})
|
856
|
+
handlers = @handlers.for(operation_name)
|
857
|
+
context = Seahorse::Client::RequestContext.new(
|
858
|
+
operation_name: operation_name,
|
859
|
+
operation: config.api.operation(operation_name),
|
860
|
+
client: self,
|
861
|
+
params: params,
|
862
|
+
config: config)
|
863
|
+
context[:gem_name] = 'aws-sdk-chime'
|
864
|
+
context[:gem_version] = '1.0.0'
|
865
|
+
Seahorse::Client::Request.new(handlers, context)
|
866
|
+
end
|
867
|
+
|
868
|
+
# @api private
|
869
|
+
# @deprecated
|
870
|
+
def waiter_names
|
871
|
+
[]
|
872
|
+
end
|
873
|
+
|
874
|
+
class << self
|
875
|
+
|
876
|
+
# @api private
|
877
|
+
attr_reader :identifier
|
878
|
+
|
879
|
+
# @api private
|
880
|
+
def errors_module
|
881
|
+
Errors
|
882
|
+
end
|
883
|
+
|
884
|
+
end
|
885
|
+
end
|
886
|
+
end
|