aws-sdk-quicksight 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 7ed332e50752563b68f182b2a692ec1f99e6382e
4
+ data.tar.gz: c8d94bb8a25be8d56e64be37a8363489022eb4ce
5
+ SHA512:
6
+ metadata.gz: 7113fe7c8c34043b3f5aa7e8eb938054cff4756f4ade37849fa5d2ea925421cd3a236ea64d5ea4c2d7121a503313b5122e7e80f925fa196005524ab01cf5cf49
7
+ data.tar.gz: 3444f4c3f5dedd68923e74e4cd146696fbc78706661b9199de91cfd8c205af1b42d549a3a48d622479cbc1f95ec8f6885caf3b1006dd1deb42aa1d5cfcf432b0
@@ -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-quicksight/types'
12
+ require_relative 'aws-sdk-quicksight/client_api'
13
+ require_relative 'aws-sdk-quicksight/client'
14
+ require_relative 'aws-sdk-quicksight/errors'
15
+ require_relative 'aws-sdk-quicksight/resource'
16
+ require_relative 'aws-sdk-quicksight/customizations'
17
+
18
+ # This module provides support for Amazon QuickSight. This module is available in the
19
+ # `aws-sdk-quicksight` 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 QuickSight all
32
+ # extend {Errors::ServiceError}.
33
+ #
34
+ # begin
35
+ # # do stuff
36
+ # rescue Aws::QuickSight::Errors::ServiceError
37
+ # # rescues all service API errors
38
+ # end
39
+ #
40
+ # See {Errors} for more information.
41
+ #
42
+ # @service
43
+ module Aws::QuickSight
44
+
45
+ GEM_VERSION = '1.0.0'
46
+
47
+ end
@@ -0,0 +1,1112 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'seahorse/client/plugins/content_length.rb'
9
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
10
+ require 'aws-sdk-core/plugins/logging.rb'
11
+ require 'aws-sdk-core/plugins/param_converter.rb'
12
+ require 'aws-sdk-core/plugins/param_validator.rb'
13
+ require 'aws-sdk-core/plugins/user_agent.rb'
14
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
15
+ require 'aws-sdk-core/plugins/retry_errors.rb'
16
+ require 'aws-sdk-core/plugins/global_configuration.rb'
17
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
19
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
20
+ require 'aws-sdk-core/plugins/response_paging.rb'
21
+ require 'aws-sdk-core/plugins/stub_responses.rb'
22
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
23
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
+ require 'aws-sdk-core/plugins/signature_v4.rb'
27
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
28
+
29
+ Aws::Plugins::GlobalConfiguration.add_identifier(:quicksight)
30
+
31
+ module Aws::QuickSight
32
+ class Client < Seahorse::Client::Base
33
+
34
+ include Aws::ClientStubs
35
+
36
+ @identifier = :quicksight
37
+
38
+ set_api(ClientApi::API)
39
+
40
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
41
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
42
+ add_plugin(Aws::Plugins::Logging)
43
+ add_plugin(Aws::Plugins::ParamConverter)
44
+ add_plugin(Aws::Plugins::ParamValidator)
45
+ add_plugin(Aws::Plugins::UserAgent)
46
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
47
+ add_plugin(Aws::Plugins::RetryErrors)
48
+ add_plugin(Aws::Plugins::GlobalConfiguration)
49
+ add_plugin(Aws::Plugins::RegionalEndpoint)
50
+ add_plugin(Aws::Plugins::EndpointDiscovery)
51
+ add_plugin(Aws::Plugins::EndpointPattern)
52
+ add_plugin(Aws::Plugins::ResponsePaging)
53
+ add_plugin(Aws::Plugins::StubResponses)
54
+ add_plugin(Aws::Plugins::IdempotencyToken)
55
+ add_plugin(Aws::Plugins::JsonvalueConverter)
56
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
57
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
58
+ add_plugin(Aws::Plugins::SignatureV4)
59
+ add_plugin(Aws::Plugins::Protocols::RestJson)
60
+
61
+ # @overload initialize(options)
62
+ # @param [Hash] options
63
+ # @option options [required, Aws::CredentialProvider] :credentials
64
+ # Your AWS credentials. This can be an instance of any one of the
65
+ # following classes:
66
+ #
67
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
68
+ # credentials.
69
+ #
70
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
71
+ # from an EC2 IMDS on an EC2 instance.
72
+ #
73
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
74
+ # shared file, such as `~/.aws/config`.
75
+ #
76
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
77
+ #
78
+ # When `:credentials` are not configured directly, the following
79
+ # locations will be searched for credentials:
80
+ #
81
+ # * `Aws.config[:credentials]`
82
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
83
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
84
+ # * `~/.aws/credentials`
85
+ # * `~/.aws/config`
86
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
87
+ # very aggressive. Construct and pass an instance of
88
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
89
+ # timeouts.
90
+ #
91
+ # @option options [required, String] :region
92
+ # The AWS region to connect to. The configured `:region` is
93
+ # used to determine the service `:endpoint`. When not passed,
94
+ # a default `:region` is search for in the following locations:
95
+ #
96
+ # * `Aws.config[:region]`
97
+ # * `ENV['AWS_REGION']`
98
+ # * `ENV['AMAZON_REGION']`
99
+ # * `ENV['AWS_DEFAULT_REGION']`
100
+ # * `~/.aws/credentials`
101
+ # * `~/.aws/config`
102
+ #
103
+ # @option options [String] :access_key_id
104
+ #
105
+ # @option options [Boolean] :active_endpoint_cache (false)
106
+ # When set to `true`, a thread polling for endpoints will be running in
107
+ # the background every 60 secs (default). Defaults to `false`.
108
+ #
109
+ # @option options [Boolean] :client_side_monitoring (false)
110
+ # When `true`, client-side metrics will be collected for all API requests from
111
+ # this client.
112
+ #
113
+ # @option options [String] :client_side_monitoring_client_id ("")
114
+ # Allows you to provide an identifier for this client which will be attached to
115
+ # all generated client side metrics. Defaults to an empty string.
116
+ #
117
+ # @option options [Integer] :client_side_monitoring_port (31000)
118
+ # Required for publishing client metrics. The port that the client side monitoring
119
+ # agent is running on, where client metrics will be published via UDP.
120
+ #
121
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
122
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
123
+ # will use the Client Side Monitoring Agent Publisher.
124
+ #
125
+ # @option options [Boolean] :convert_params (true)
126
+ # When `true`, an attempt is made to coerce request parameters into
127
+ # the required types.
128
+ #
129
+ # @option options [Boolean] :disable_host_prefix_injection (false)
130
+ # Set to true to disable SDK automatically adding host prefix
131
+ # to default service endpoint when available.
132
+ #
133
+ # @option options [String] :endpoint
134
+ # The client endpoint is normally constructed from the `:region`
135
+ # option. You should only configure an `:endpoint` when connecting
136
+ # to test endpoints. This should be avalid HTTP(S) URI.
137
+ #
138
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
139
+ # Used for the maximum size limit of the LRU cache storing endpoints data
140
+ # for endpoint discovery enabled operations. Defaults to 1000.
141
+ #
142
+ # @option options [Integer] :endpoint_cache_max_threads (10)
143
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
144
+ #
145
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
146
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
147
+ # Use this option to config the time interval in seconds for making
148
+ # requests fetching endpoints information. Defaults to 60 sec.
149
+ #
150
+ # @option options [Boolean] :endpoint_discovery (false)
151
+ # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
152
+ #
153
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
154
+ # The log formatter.
155
+ #
156
+ # @option options [Symbol] :log_level (:info)
157
+ # The log level to send messages to the `:logger` at.
158
+ #
159
+ # @option options [Logger] :logger
160
+ # The Logger instance to send log messages to. If this option
161
+ # is not set, logging will be disabled.
162
+ #
163
+ # @option options [String] :profile ("default")
164
+ # Used when loading credentials from the shared credentials file
165
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
166
+ #
167
+ # @option options [Float] :retry_base_delay (0.3)
168
+ # The base delay in seconds used by the default backoff function.
169
+ #
170
+ # @option options [Symbol] :retry_jitter (:none)
171
+ # 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.
172
+ #
173
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
174
+ #
175
+ # @option options [Integer] :retry_limit (3)
176
+ # The maximum number of times to retry failed requests. Only
177
+ # ~ 500 level server errors and certain ~ 400 level client errors
178
+ # are retried. Generally, these are throttling errors, data
179
+ # checksum errors, networking errors, timeout errors and auth
180
+ # errors from expired credentials.
181
+ #
182
+ # @option options [Integer] :retry_max_delay (0)
183
+ # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
184
+ #
185
+ # @option options [String] :secret_access_key
186
+ #
187
+ # @option options [String] :session_token
188
+ #
189
+ # @option options [Boolean] :stub_responses (false)
190
+ # Causes the client to return stubbed responses. By default
191
+ # fake responses are generated and returned. You can specify
192
+ # the response data to return or errors to raise by calling
193
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
194
+ #
195
+ # ** Please note ** When response stubbing is enabled, no HTTP
196
+ # requests are made, and retries are disabled.
197
+ #
198
+ # @option options [Boolean] :validate_params (true)
199
+ # When `true`, request parameters are validated before
200
+ # sending the request.
201
+ #
202
+ def initialize(*args)
203
+ super
204
+ end
205
+
206
+ # @!group API Operations
207
+
208
+ # Creates an Amazon QuickSight group.
209
+ #
210
+ # The permissions resource is
211
+ # `arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name>
212
+ # `.
213
+ #
214
+ # The response is a group object.
215
+ #
216
+ # @option params [required, String] :group_name
217
+ # A name for the group that you want to create.
218
+ #
219
+ # @option params [String] :description
220
+ # A description for the group that you want to create.
221
+ #
222
+ # @option params [required, String] :aws_account_id
223
+ # The ID for the AWS account that the group is in. Currently, you use
224
+ # the ID for the AWS account that contains your Amazon QuickSight
225
+ # account.
226
+ #
227
+ # @option params [required, String] :namespace
228
+ # The namespace. Currently, you should set this to `default`.
229
+ #
230
+ # @return [Types::CreateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
231
+ #
232
+ # * {Types::CreateGroupResponse#group #group} => Types::Group
233
+ # * {Types::CreateGroupResponse#request_id #request_id} => String
234
+ # * {Types::CreateGroupResponse#status #status} => Integer
235
+ #
236
+ # @example Request syntax with placeholder values
237
+ #
238
+ # resp = client.create_group({
239
+ # group_name: "GroupName", # required
240
+ # description: "GroupDescription",
241
+ # aws_account_id: "AwsAccountId", # required
242
+ # namespace: "Namespace", # required
243
+ # })
244
+ #
245
+ # @example Response structure
246
+ #
247
+ # resp.group.arn #=> String
248
+ # resp.group.group_name #=> String
249
+ # resp.group.description #=> String
250
+ # resp.request_id #=> String
251
+ # resp.status #=> Integer
252
+ #
253
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroup AWS API Documentation
254
+ #
255
+ # @overload create_group(params = {})
256
+ # @param [Hash] params ({})
257
+ def create_group(params = {}, options = {})
258
+ req = build_request(:create_group, params)
259
+ req.send_request(options)
260
+ end
261
+
262
+ # Adds an Amazon QuickSight user to an Amazon QuickSight group.
263
+ #
264
+ # The permissions resource is
265
+ # `arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name>
266
+ # `.
267
+ #
268
+ # The condition resource is the user name.
269
+ #
270
+ # The condition key is `quicksight:UserName`.
271
+ #
272
+ # The response is the group member object.
273
+ #
274
+ # @option params [required, String] :member_name
275
+ # The name of the user that you want to add to the group membership.
276
+ #
277
+ # @option params [required, String] :group_name
278
+ # The name of the group that you want to add the user to.
279
+ #
280
+ # @option params [required, String] :aws_account_id
281
+ # The ID for the AWS account that the group is in. Currently, you use
282
+ # the ID for the AWS account that contains your Amazon QuickSight
283
+ # account.
284
+ #
285
+ # @option params [required, String] :namespace
286
+ # The namespace. Currently, you should set this to `default`.
287
+ #
288
+ # @return [Types::CreateGroupMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
289
+ #
290
+ # * {Types::CreateGroupMembershipResponse#group_member #group_member} => Types::GroupMember
291
+ # * {Types::CreateGroupMembershipResponse#request_id #request_id} => String
292
+ # * {Types::CreateGroupMembershipResponse#status #status} => Integer
293
+ #
294
+ # @example Request syntax with placeholder values
295
+ #
296
+ # resp = client.create_group_membership({
297
+ # member_name: "GroupMemberName", # required
298
+ # group_name: "GroupName", # required
299
+ # aws_account_id: "AwsAccountId", # required
300
+ # namespace: "Namespace", # required
301
+ # })
302
+ #
303
+ # @example Response structure
304
+ #
305
+ # resp.group_member.arn #=> String
306
+ # resp.group_member.member_name #=> String
307
+ # resp.request_id #=> String
308
+ # resp.status #=> Integer
309
+ #
310
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupMembership AWS API Documentation
311
+ #
312
+ # @overload create_group_membership(params = {})
313
+ # @param [Hash] params ({})
314
+ def create_group_membership(params = {}, options = {})
315
+ req = build_request(:create_group_membership, params)
316
+ req.send_request(options)
317
+ end
318
+
319
+ # Removes a user group from Amazon QuickSight.
320
+ #
321
+ # The permissions resource is
322
+ # `arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name>
323
+ # `.
324
+ #
325
+ # @option params [required, String] :group_name
326
+ # The name of the group that you want to delete.
327
+ #
328
+ # @option params [required, String] :aws_account_id
329
+ # The ID for the AWS account that the group is in. Currently, you use
330
+ # the ID for the AWS account that contains your Amazon QuickSight
331
+ # account.
332
+ #
333
+ # @option params [required, String] :namespace
334
+ # The namespace. Currently, you should set this to `default`.
335
+ #
336
+ # @return [Types::DeleteGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
337
+ #
338
+ # * {Types::DeleteGroupResponse#request_id #request_id} => String
339
+ # * {Types::DeleteGroupResponse#status #status} => Integer
340
+ #
341
+ # @example Request syntax with placeholder values
342
+ #
343
+ # resp = client.delete_group({
344
+ # group_name: "GroupName", # required
345
+ # aws_account_id: "AwsAccountId", # required
346
+ # namespace: "Namespace", # required
347
+ # })
348
+ #
349
+ # @example Response structure
350
+ #
351
+ # resp.request_id #=> String
352
+ # resp.status #=> Integer
353
+ #
354
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroup AWS API Documentation
355
+ #
356
+ # @overload delete_group(params = {})
357
+ # @param [Hash] params ({})
358
+ def delete_group(params = {}, options = {})
359
+ req = build_request(:delete_group, params)
360
+ req.send_request(options)
361
+ end
362
+
363
+ # Removes a user from a group so that the user is no longer a member of
364
+ # the group.
365
+ #
366
+ # The permissions resource is
367
+ # `arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name>
368
+ # `.
369
+ #
370
+ # The condition resource is the user name.
371
+ #
372
+ # The condition key is `quicksight:UserName`.
373
+ #
374
+ # @option params [required, String] :member_name
375
+ # The name of the user that you want to delete from the group
376
+ # membership.
377
+ #
378
+ # @option params [required, String] :group_name
379
+ # The name of the group that you want to delete the user from.
380
+ #
381
+ # @option params [required, String] :aws_account_id
382
+ # The ID for the AWS account that the group is in. Currently, you use
383
+ # the ID for the AWS account that contains your Amazon QuickSight
384
+ # account.
385
+ #
386
+ # @option params [required, String] :namespace
387
+ # The namespace. Currently, you should set this to `default`.
388
+ #
389
+ # @return [Types::DeleteGroupMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
390
+ #
391
+ # * {Types::DeleteGroupMembershipResponse#request_id #request_id} => String
392
+ # * {Types::DeleteGroupMembershipResponse#status #status} => Integer
393
+ #
394
+ # @example Request syntax with placeholder values
395
+ #
396
+ # resp = client.delete_group_membership({
397
+ # member_name: "GroupMemberName", # required
398
+ # group_name: "GroupName", # required
399
+ # aws_account_id: "AwsAccountId", # required
400
+ # namespace: "Namespace", # required
401
+ # })
402
+ #
403
+ # @example Response structure
404
+ #
405
+ # resp.request_id #=> String
406
+ # resp.status #=> Integer
407
+ #
408
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroupMembership AWS API Documentation
409
+ #
410
+ # @overload delete_group_membership(params = {})
411
+ # @param [Hash] params ({})
412
+ def delete_group_membership(params = {}, options = {})
413
+ req = build_request(:delete_group_membership, params)
414
+ req.send_request(options)
415
+ end
416
+
417
+ # Deletes the Amazon QuickSight user that is associated with the
418
+ # identity of the AWS Identity and Access Management (IAM) user or role
419
+ # that's making the call. The IAM user isn't deleted as a result of
420
+ # this call.
421
+ #
422
+ # The permission resource is
423
+ # `arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name>
424
+ # `.
425
+ #
426
+ # @option params [required, String] :user_name
427
+ # The name of the user that you want to delete.
428
+ #
429
+ # @option params [required, String] :aws_account_id
430
+ # The ID for the AWS account that the user is in. Currently, you use the
431
+ # ID for the AWS account that contains your Amazon QuickSight account.
432
+ #
433
+ # @option params [required, String] :namespace
434
+ # The namespace. Currently, you should set this to `default`.
435
+ #
436
+ # @return [Types::DeleteUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
437
+ #
438
+ # * {Types::DeleteUserResponse#request_id #request_id} => String
439
+ # * {Types::DeleteUserResponse#status #status} => Integer
440
+ #
441
+ # @example Request syntax with placeholder values
442
+ #
443
+ # resp = client.delete_user({
444
+ # user_name: "UserName", # required
445
+ # aws_account_id: "AwsAccountId", # required
446
+ # namespace: "Namespace", # required
447
+ # })
448
+ #
449
+ # @example Response structure
450
+ #
451
+ # resp.request_id #=> String
452
+ # resp.status #=> Integer
453
+ #
454
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteUser AWS API Documentation
455
+ #
456
+ # @overload delete_user(params = {})
457
+ # @param [Hash] params ({})
458
+ def delete_user(params = {}, options = {})
459
+ req = build_request(:delete_user, params)
460
+ req.send_request(options)
461
+ end
462
+
463
+ # Returns an Amazon QuickSight group's description and Amazon Resource
464
+ # Name (ARN).
465
+ #
466
+ # The permissions resource is
467
+ # `arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name>
468
+ # `.
469
+ #
470
+ # The response is the group object.
471
+ #
472
+ # @option params [required, String] :group_name
473
+ # The name of the group that you want to describe.
474
+ #
475
+ # @option params [required, String] :aws_account_id
476
+ # The ID for the AWS account that the group is in. Currently, you use
477
+ # the ID for the AWS account that contains your Amazon QuickSight
478
+ # account.
479
+ #
480
+ # @option params [required, String] :namespace
481
+ # The namespace. Currently, you should set this to `default`.
482
+ #
483
+ # @return [Types::DescribeGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
484
+ #
485
+ # * {Types::DescribeGroupResponse#group #group} => Types::Group
486
+ # * {Types::DescribeGroupResponse#request_id #request_id} => String
487
+ # * {Types::DescribeGroupResponse#status #status} => Integer
488
+ #
489
+ # @example Request syntax with placeholder values
490
+ #
491
+ # resp = client.describe_group({
492
+ # group_name: "GroupName", # required
493
+ # aws_account_id: "AwsAccountId", # required
494
+ # namespace: "Namespace", # required
495
+ # })
496
+ #
497
+ # @example Response structure
498
+ #
499
+ # resp.group.arn #=> String
500
+ # resp.group.group_name #=> String
501
+ # resp.group.description #=> String
502
+ # resp.request_id #=> String
503
+ # resp.status #=> Integer
504
+ #
505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeGroup AWS API Documentation
506
+ #
507
+ # @overload describe_group(params = {})
508
+ # @param [Hash] params ({})
509
+ def describe_group(params = {}, options = {})
510
+ req = build_request(:describe_group, params)
511
+ req.send_request(options)
512
+ end
513
+
514
+ # Returns information about a user, given the user name.
515
+ #
516
+ # The permission resource is
517
+ # `arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name>
518
+ # `.
519
+ #
520
+ # The response is a user object that contains the user's Amazon
521
+ # Resource Name (ARN), AWS Identity and Access Management (IAM) role,
522
+ # and email address.
523
+ #
524
+ # @option params [required, String] :user_name
525
+ # The name of the user that you want to describe.
526
+ #
527
+ # @option params [required, String] :aws_account_id
528
+ # The ID for the AWS account that the user is in. Currently, you use the
529
+ # ID for the AWS account that contains your Amazon QuickSight account.
530
+ #
531
+ # @option params [required, String] :namespace
532
+ # The namespace. Currently, you should set this to `default`.
533
+ #
534
+ # @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
535
+ #
536
+ # * {Types::DescribeUserResponse#user #user} => Types::User
537
+ # * {Types::DescribeUserResponse#request_id #request_id} => String
538
+ # * {Types::DescribeUserResponse#status #status} => Integer
539
+ #
540
+ # @example Request syntax with placeholder values
541
+ #
542
+ # resp = client.describe_user({
543
+ # user_name: "UserName", # required
544
+ # aws_account_id: "AwsAccountId", # required
545
+ # namespace: "Namespace", # required
546
+ # })
547
+ #
548
+ # @example Response structure
549
+ #
550
+ # resp.user.arn #=> String
551
+ # resp.user.user_name #=> String
552
+ # resp.user.email #=> String
553
+ # resp.user.role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"
554
+ # resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
555
+ # resp.user.active #=> Boolean
556
+ # resp.request_id #=> String
557
+ # resp.status #=> Integer
558
+ #
559
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeUser AWS API Documentation
560
+ #
561
+ # @overload describe_user(params = {})
562
+ # @param [Hash] params ({})
563
+ def describe_user(params = {}, options = {})
564
+ req = build_request(:describe_user, params)
565
+ req.send_request(options)
566
+ end
567
+
568
+ # Generates an embedded URL and authorization code. Before this can work
569
+ # properly, you need to configure the dashboards and user permissions
570
+ # first.
571
+ #
572
+ # @option params [required, String] :aws_account_id
573
+ # AWS account ID that contains the dashboard you are embedding.
574
+ #
575
+ # @option params [required, String] :dashboard_id
576
+ # The ID for the dashboard, also added to IAM policy
577
+ #
578
+ # @option params [required, String] :identity_type
579
+ # The authentication method the user uses to sign in (IAM or
580
+ # QUICKSIGHT).
581
+ #
582
+ # @option params [Integer] :session_lifetime_in_minutes
583
+ # How many minutes the session is valid. The session lifetime must be
584
+ # between 15 and 600 minutes.
585
+ #
586
+ # @option params [Boolean] :undo_redo_disabled
587
+ # Remove the undo/redo button on embedded dashboard. The default is
588
+ # FALSE, which enables the undo/redo button.
589
+ #
590
+ # @option params [Boolean] :reset_disabled
591
+ # Remove the reset button on embedded dashboard. The default is FALSE,
592
+ # which allows the reset button.
593
+ #
594
+ # @return [Types::GetDashboardEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
595
+ #
596
+ # * {Types::GetDashboardEmbedUrlResponse#embed_url #embed_url} => String
597
+ # * {Types::GetDashboardEmbedUrlResponse#status #status} => Integer
598
+ # * {Types::GetDashboardEmbedUrlResponse#request_id #request_id} => String
599
+ #
600
+ # @example Request syntax with placeholder values
601
+ #
602
+ # resp = client.get_dashboard_embed_url({
603
+ # aws_account_id: "AwsAccountId", # required
604
+ # dashboard_id: "String", # required
605
+ # identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
606
+ # session_lifetime_in_minutes: 1,
607
+ # undo_redo_disabled: false,
608
+ # reset_disabled: false,
609
+ # })
610
+ #
611
+ # @example Response structure
612
+ #
613
+ # resp.embed_url #=> String
614
+ # resp.status #=> Integer
615
+ # resp.request_id #=> String
616
+ #
617
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrl AWS API Documentation
618
+ #
619
+ # @overload get_dashboard_embed_url(params = {})
620
+ # @param [Hash] params ({})
621
+ def get_dashboard_embed_url(params = {}, options = {})
622
+ req = build_request(:get_dashboard_embed_url, params)
623
+ req.send_request(options)
624
+ end
625
+
626
+ # Lists member users in a group.
627
+ #
628
+ # The permissions resource is
629
+ # `arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name>
630
+ # `.
631
+ #
632
+ # The response is a list of group member objects.
633
+ #
634
+ # @option params [required, String] :group_name
635
+ # The name of the group that you want to see a membership list of.
636
+ #
637
+ # @option params [String] :next_token
638
+ # A pagination token that can be used in a subsequent request.
639
+ #
640
+ # @option params [Integer] :max_results
641
+ # The maximum number of results to return from this request.
642
+ #
643
+ # @option params [required, String] :aws_account_id
644
+ # The ID for the AWS account that the group is in. Currently, you use
645
+ # the ID for the AWS account that contains your Amazon QuickSight
646
+ # account.
647
+ #
648
+ # @option params [required, String] :namespace
649
+ # The namespace. Currently, you should set this to `default`.
650
+ #
651
+ # @return [Types::ListGroupMembershipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
652
+ #
653
+ # * {Types::ListGroupMembershipsResponse#group_member_list #group_member_list} => Array&lt;Types::GroupMember&gt;
654
+ # * {Types::ListGroupMembershipsResponse#next_token #next_token} => String
655
+ # * {Types::ListGroupMembershipsResponse#request_id #request_id} => String
656
+ # * {Types::ListGroupMembershipsResponse#status #status} => Integer
657
+ #
658
+ # @example Request syntax with placeholder values
659
+ #
660
+ # resp = client.list_group_memberships({
661
+ # group_name: "GroupName", # required
662
+ # next_token: "String",
663
+ # max_results: 1,
664
+ # aws_account_id: "AwsAccountId", # required
665
+ # namespace: "Namespace", # required
666
+ # })
667
+ #
668
+ # @example Response structure
669
+ #
670
+ # resp.group_member_list #=> Array
671
+ # resp.group_member_list[0].arn #=> String
672
+ # resp.group_member_list[0].member_name #=> String
673
+ # resp.next_token #=> String
674
+ # resp.request_id #=> String
675
+ # resp.status #=> Integer
676
+ #
677
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroupMemberships AWS API Documentation
678
+ #
679
+ # @overload list_group_memberships(params = {})
680
+ # @param [Hash] params ({})
681
+ def list_group_memberships(params = {}, options = {})
682
+ req = build_request(:list_group_memberships, params)
683
+ req.send_request(options)
684
+ end
685
+
686
+ # Lists all user groups in Amazon QuickSight.
687
+ #
688
+ # The permissions resource is
689
+ # `arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/*`.
690
+ #
691
+ # The response is a list of group objects.
692
+ #
693
+ # @option params [required, String] :aws_account_id
694
+ # The ID for the AWS account that the group is in. Currently, you use
695
+ # the ID for the AWS account that contains your Amazon QuickSight
696
+ # account.
697
+ #
698
+ # @option params [String] :next_token
699
+ # A pagination token that can be used in a subsequent request.
700
+ #
701
+ # @option params [Integer] :max_results
702
+ # The maximum number of results to return.
703
+ #
704
+ # @option params [required, String] :namespace
705
+ # The namespace. Currently, you should set this to `default`.
706
+ #
707
+ # @return [Types::ListGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
708
+ #
709
+ # * {Types::ListGroupsResponse#group_list #group_list} => Array&lt;Types::Group&gt;
710
+ # * {Types::ListGroupsResponse#next_token #next_token} => String
711
+ # * {Types::ListGroupsResponse#request_id #request_id} => String
712
+ # * {Types::ListGroupsResponse#status #status} => Integer
713
+ #
714
+ # @example Request syntax with placeholder values
715
+ #
716
+ # resp = client.list_groups({
717
+ # aws_account_id: "AwsAccountId", # required
718
+ # next_token: "String",
719
+ # max_results: 1,
720
+ # namespace: "Namespace", # required
721
+ # })
722
+ #
723
+ # @example Response structure
724
+ #
725
+ # resp.group_list #=> Array
726
+ # resp.group_list[0].arn #=> String
727
+ # resp.group_list[0].group_name #=> String
728
+ # resp.group_list[0].description #=> String
729
+ # resp.next_token #=> String
730
+ # resp.request_id #=> String
731
+ # resp.status #=> Integer
732
+ #
733
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroups AWS API Documentation
734
+ #
735
+ # @overload list_groups(params = {})
736
+ # @param [Hash] params ({})
737
+ def list_groups(params = {}, options = {})
738
+ req = build_request(:list_groups, params)
739
+ req.send_request(options)
740
+ end
741
+
742
+ # Lists the Amazon QuickSight groups that a user is part of.
743
+ #
744
+ # @option params [required, String] :user_name
745
+ # The name of the user that you want to list groups for.
746
+ #
747
+ # @option params [required, String] :aws_account_id
748
+ # The AWS Account ID that the user is in. Currently, use the AWS Account
749
+ # ID which contains your Amazon QuickSight account.
750
+ #
751
+ # @option params [required, String] :namespace
752
+ # The namespace. Currently, you should set this to `default`.
753
+ #
754
+ # @option params [String] :next_token
755
+ # A pagination token that can be used in a subsequent request.
756
+ #
757
+ # @option params [Integer] :max_results
758
+ # The maximum number of results to return from this request.
759
+ #
760
+ # @return [Types::ListUserGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
761
+ #
762
+ # * {Types::ListUserGroupsResponse#group_list #group_list} => Array&lt;Types::Group&gt;
763
+ # * {Types::ListUserGroupsResponse#next_token #next_token} => String
764
+ # * {Types::ListUserGroupsResponse#request_id #request_id} => String
765
+ # * {Types::ListUserGroupsResponse#status #status} => Integer
766
+ #
767
+ # @example Request syntax with placeholder values
768
+ #
769
+ # resp = client.list_user_groups({
770
+ # user_name: "UserName", # required
771
+ # aws_account_id: "AwsAccountId", # required
772
+ # namespace: "Namespace", # required
773
+ # next_token: "String",
774
+ # max_results: 1,
775
+ # })
776
+ #
777
+ # @example Response structure
778
+ #
779
+ # resp.group_list #=> Array
780
+ # resp.group_list[0].arn #=> String
781
+ # resp.group_list[0].group_name #=> String
782
+ # resp.group_list[0].description #=> String
783
+ # resp.next_token #=> String
784
+ # resp.request_id #=> String
785
+ # resp.status #=> Integer
786
+ #
787
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUserGroups AWS API Documentation
788
+ #
789
+ # @overload list_user_groups(params = {})
790
+ # @param [Hash] params ({})
791
+ def list_user_groups(params = {}, options = {})
792
+ req = build_request(:list_user_groups, params)
793
+ req.send_request(options)
794
+ end
795
+
796
+ # Returns a list of all of the Amazon QuickSight users belonging to this
797
+ # account.
798
+ #
799
+ # The permission resource is
800
+ # `arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/* `.
801
+ #
802
+ # The response is a list of user objects, containing each user's Amazon
803
+ # Resource Name (ARN), AWS Identity and Access Management (IAM) role,
804
+ # and email address.
805
+ #
806
+ # @option params [required, String] :aws_account_id
807
+ # The ID for the AWS account that the user is in. Currently, you use the
808
+ # ID for the AWS account that contains your Amazon QuickSight account.
809
+ #
810
+ # @option params [String] :next_token
811
+ # A pagination token that can be used in a subsequent request.
812
+ #
813
+ # @option params [Integer] :max_results
814
+ # The maximum number of results to return from this request.
815
+ #
816
+ # @option params [required, String] :namespace
817
+ # The namespace. Currently, you should set this to `default`.
818
+ #
819
+ # @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
820
+ #
821
+ # * {Types::ListUsersResponse#user_list #user_list} => Array&lt;Types::User&gt;
822
+ # * {Types::ListUsersResponse#next_token #next_token} => String
823
+ # * {Types::ListUsersResponse#request_id #request_id} => String
824
+ # * {Types::ListUsersResponse#status #status} => Integer
825
+ #
826
+ # @example Request syntax with placeholder values
827
+ #
828
+ # resp = client.list_users({
829
+ # aws_account_id: "AwsAccountId", # required
830
+ # next_token: "String",
831
+ # max_results: 1,
832
+ # namespace: "Namespace", # required
833
+ # })
834
+ #
835
+ # @example Response structure
836
+ #
837
+ # resp.user_list #=> Array
838
+ # resp.user_list[0].arn #=> String
839
+ # resp.user_list[0].user_name #=> String
840
+ # resp.user_list[0].email #=> String
841
+ # resp.user_list[0].role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"
842
+ # resp.user_list[0].identity_type #=> String, one of "IAM", "QUICKSIGHT"
843
+ # resp.user_list[0].active #=> Boolean
844
+ # resp.next_token #=> String
845
+ # resp.request_id #=> String
846
+ # resp.status #=> Integer
847
+ #
848
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUsers AWS API Documentation
849
+ #
850
+ # @overload list_users(params = {})
851
+ # @param [Hash] params ({})
852
+ def list_users(params = {}, options = {})
853
+ req = build_request(:list_users, params)
854
+ req.send_request(options)
855
+ end
856
+
857
+ # Creates an Amazon QuickSight user, whose identity is associated with
858
+ # the AWS Identity and Access Management (IAM) identity or role
859
+ # specified in the request.
860
+ #
861
+ # The permission resource is
862
+ # `arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name>
863
+ # `.
864
+ #
865
+ # The condition resource is the Amazon Resource Name (ARN) for the IAM
866
+ # user or role, and the session name.
867
+ #
868
+ # The condition keys are `quicksight:IamArn` and
869
+ # `quicksight:SessionName`.
870
+ #
871
+ # @option params [required, String] :identity_type
872
+ # Amazon QuickSight supports several ways of managing the identity of
873
+ # users. This parameter accepts two values:
874
+ #
875
+ # * `IAM`\: A user whose identity maps to an existing IAM user or role.
876
+ #
877
+ # * `QUICKSIGHT`\: A user whose identity is owned and managed internally
878
+ # by Amazon QuickSight.
879
+ #
880
+ # @option params [required, String] :email
881
+ # The email address of the user that you want to register.
882
+ #
883
+ # @option params [required, String] :user_role
884
+ # The Amazon QuickSight role of the user. The user role can be one of
885
+ # the following:
886
+ #
887
+ # * `READER`\: A user who has read-only access to dashboards.
888
+ #
889
+ # * `AUTHOR`\: A user who can create data sources, data sets, analyses,
890
+ # and dashboards.
891
+ #
892
+ # * `ADMIN`\: A user who is an author, who can also manage Amazon
893
+ # QuickSight settings.
894
+ #
895
+ # @option params [String] :iam_arn
896
+ # The ARN of the IAM user or role that you are registering with Amazon
897
+ # QuickSight.
898
+ #
899
+ # @option params [String] :session_name
900
+ # The name of the session with the assumed IAM role. By using this
901
+ # parameter, you can register multiple users with the same IAM role,
902
+ # provided that each has a different session name. For more information
903
+ # on assuming IAM roles, see [ `assume-role` ][1] in the *AWS CLI
904
+ # Reference.*
905
+ #
906
+ #
907
+ #
908
+ # [1]: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html
909
+ #
910
+ # @option params [required, String] :aws_account_id
911
+ # The ID for the AWS account that the user is in. Currently, you use the
912
+ # ID for the AWS account that contains your Amazon QuickSight account.
913
+ #
914
+ # @option params [required, String] :namespace
915
+ # The namespace. Currently, you should set this to `default`.
916
+ #
917
+ # @option params [String] :user_name
918
+ # The Amazon QuickSight user name that you want to create for the user
919
+ # you are registering.
920
+ #
921
+ # @return [Types::RegisterUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
922
+ #
923
+ # * {Types::RegisterUserResponse#user #user} => Types::User
924
+ # * {Types::RegisterUserResponse#request_id #request_id} => String
925
+ # * {Types::RegisterUserResponse#status #status} => Integer
926
+ #
927
+ # @example Request syntax with placeholder values
928
+ #
929
+ # resp = client.register_user({
930
+ # identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
931
+ # email: "String", # required
932
+ # user_role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
933
+ # iam_arn: "String",
934
+ # session_name: "String",
935
+ # aws_account_id: "AwsAccountId", # required
936
+ # namespace: "Namespace", # required
937
+ # user_name: "UserName",
938
+ # })
939
+ #
940
+ # @example Response structure
941
+ #
942
+ # resp.user.arn #=> String
943
+ # resp.user.user_name #=> String
944
+ # resp.user.email #=> String
945
+ # resp.user.role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"
946
+ # resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
947
+ # resp.user.active #=> Boolean
948
+ # resp.request_id #=> String
949
+ # resp.status #=> Integer
950
+ #
951
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisterUser AWS API Documentation
952
+ #
953
+ # @overload register_user(params = {})
954
+ # @param [Hash] params ({})
955
+ def register_user(params = {}, options = {})
956
+ req = build_request(:register_user, params)
957
+ req.send_request(options)
958
+ end
959
+
960
+ # Changes a group description.
961
+ #
962
+ # The permissions resource is
963
+ # `arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name>
964
+ # `.
965
+ #
966
+ # The response is a group object.
967
+ #
968
+ # @option params [required, String] :group_name
969
+ # The name of the group that you want to update.
970
+ #
971
+ # @option params [String] :description
972
+ # The description for the group that you want to update.
973
+ #
974
+ # @option params [required, String] :aws_account_id
975
+ # The ID for the AWS account that the group is in. Currently, you use
976
+ # the ID for the AWS account that contains your Amazon QuickSight
977
+ # account.
978
+ #
979
+ # @option params [required, String] :namespace
980
+ # The namespace. Currently, you should set this to `default`.
981
+ #
982
+ # @return [Types::UpdateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
983
+ #
984
+ # * {Types::UpdateGroupResponse#group #group} => Types::Group
985
+ # * {Types::UpdateGroupResponse#request_id #request_id} => String
986
+ # * {Types::UpdateGroupResponse#status #status} => Integer
987
+ #
988
+ # @example Request syntax with placeholder values
989
+ #
990
+ # resp = client.update_group({
991
+ # group_name: "GroupName", # required
992
+ # description: "GroupDescription",
993
+ # aws_account_id: "AwsAccountId", # required
994
+ # namespace: "Namespace", # required
995
+ # })
996
+ #
997
+ # @example Response structure
998
+ #
999
+ # resp.group.arn #=> String
1000
+ # resp.group.group_name #=> String
1001
+ # resp.group.description #=> String
1002
+ # resp.request_id #=> String
1003
+ # resp.status #=> Integer
1004
+ #
1005
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateGroup AWS API Documentation
1006
+ #
1007
+ # @overload update_group(params = {})
1008
+ # @param [Hash] params ({})
1009
+ def update_group(params = {}, options = {})
1010
+ req = build_request(:update_group, params)
1011
+ req.send_request(options)
1012
+ end
1013
+
1014
+ # Updates an Amazon QuickSight user.
1015
+ #
1016
+ # @option params [required, String] :user_name
1017
+ # The Amazon QuickSight user name that you want to update.
1018
+ #
1019
+ # @option params [required, String] :aws_account_id
1020
+ # The ID for the AWS account that the user is in. Currently, you use the
1021
+ # ID for the AWS account that contains your Amazon QuickSight account.
1022
+ #
1023
+ # @option params [required, String] :namespace
1024
+ # The namespace. Currently, you should set this to `default`.
1025
+ #
1026
+ # @option params [required, String] :email
1027
+ # The email address of the user that you want to update.
1028
+ #
1029
+ # @option params [required, String] :role
1030
+ # The Amazon QuickSight role of the user. The user role can be one of
1031
+ # the following:
1032
+ #
1033
+ # * `READER`\: A user who has read-only access to dashboards.
1034
+ #
1035
+ # * `AUTHOR`\: A user who can create data sources, data sets, analyses,
1036
+ # and dashboards.
1037
+ #
1038
+ # * `ADMIN`\: A user who is an author, who can also manage Amazon
1039
+ # QuickSight settings.
1040
+ #
1041
+ # @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1042
+ #
1043
+ # * {Types::UpdateUserResponse#user #user} => Types::User
1044
+ # * {Types::UpdateUserResponse#request_id #request_id} => String
1045
+ # * {Types::UpdateUserResponse#status #status} => Integer
1046
+ #
1047
+ # @example Request syntax with placeholder values
1048
+ #
1049
+ # resp = client.update_user({
1050
+ # user_name: "UserName", # required
1051
+ # aws_account_id: "AwsAccountId", # required
1052
+ # namespace: "Namespace", # required
1053
+ # email: "String", # required
1054
+ # role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
1055
+ # })
1056
+ #
1057
+ # @example Response structure
1058
+ #
1059
+ # resp.user.arn #=> String
1060
+ # resp.user.user_name #=> String
1061
+ # resp.user.email #=> String
1062
+ # resp.user.role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"
1063
+ # resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
1064
+ # resp.user.active #=> Boolean
1065
+ # resp.request_id #=> String
1066
+ # resp.status #=> Integer
1067
+ #
1068
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateUser AWS API Documentation
1069
+ #
1070
+ # @overload update_user(params = {})
1071
+ # @param [Hash] params ({})
1072
+ def update_user(params = {}, options = {})
1073
+ req = build_request(:update_user, params)
1074
+ req.send_request(options)
1075
+ end
1076
+
1077
+ # @!endgroup
1078
+
1079
+ # @param params ({})
1080
+ # @api private
1081
+ def build_request(operation_name, params = {})
1082
+ handlers = @handlers.for(operation_name)
1083
+ context = Seahorse::Client::RequestContext.new(
1084
+ operation_name: operation_name,
1085
+ operation: config.api.operation(operation_name),
1086
+ client: self,
1087
+ params: params,
1088
+ config: config)
1089
+ context[:gem_name] = 'aws-sdk-quicksight'
1090
+ context[:gem_version] = '1.0.0'
1091
+ Seahorse::Client::Request.new(handlers, context)
1092
+ end
1093
+
1094
+ # @api private
1095
+ # @deprecated
1096
+ def waiter_names
1097
+ []
1098
+ end
1099
+
1100
+ class << self
1101
+
1102
+ # @api private
1103
+ attr_reader :identifier
1104
+
1105
+ # @api private
1106
+ def errors_module
1107
+ Errors
1108
+ end
1109
+
1110
+ end
1111
+ end
1112
+ end