aws-sdk-quicksight 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-quicksight.rb +47 -0
- data/lib/aws-sdk-quicksight/client.rb +1112 -0
- data/lib/aws-sdk-quicksight/client_api.rb +529 -0
- data/lib/aws-sdk-quicksight/customizations.rb +0 -0
- data/lib/aws-sdk-quicksight/errors.rb +14 -0
- data/lib/aws-sdk-quicksight/resource.rb +23 -0
- data/lib/aws-sdk-quicksight/types.rb +1062 -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::QuickSight
|
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::QuickSight
|
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,1062 @@
|
|
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::QuickSight
|
9
|
+
module Types
|
10
|
+
|
11
|
+
# @note When making an API call, you may pass CreateGroupMembershipRequest
|
12
|
+
# data as a hash:
|
13
|
+
#
|
14
|
+
# {
|
15
|
+
# member_name: "GroupMemberName", # required
|
16
|
+
# group_name: "GroupName", # required
|
17
|
+
# aws_account_id: "AwsAccountId", # required
|
18
|
+
# namespace: "Namespace", # required
|
19
|
+
# }
|
20
|
+
#
|
21
|
+
# @!attribute [rw] member_name
|
22
|
+
# The name of the user that you want to add to the group membership.
|
23
|
+
# @return [String]
|
24
|
+
#
|
25
|
+
# @!attribute [rw] group_name
|
26
|
+
# The name of the group that you want to add the user to.
|
27
|
+
# @return [String]
|
28
|
+
#
|
29
|
+
# @!attribute [rw] aws_account_id
|
30
|
+
# The ID for the AWS account that the group is in. Currently, you use
|
31
|
+
# the ID for the AWS account that contains your Amazon QuickSight
|
32
|
+
# account.
|
33
|
+
# @return [String]
|
34
|
+
#
|
35
|
+
# @!attribute [rw] namespace
|
36
|
+
# The namespace. Currently, you should set this to `default`.
|
37
|
+
# @return [String]
|
38
|
+
#
|
39
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupMembershipRequest AWS API Documentation
|
40
|
+
#
|
41
|
+
class CreateGroupMembershipRequest < Struct.new(
|
42
|
+
:member_name,
|
43
|
+
:group_name,
|
44
|
+
:aws_account_id,
|
45
|
+
:namespace)
|
46
|
+
include Aws::Structure
|
47
|
+
end
|
48
|
+
|
49
|
+
# @!attribute [rw] group_member
|
50
|
+
# The group member.
|
51
|
+
# @return [Types::GroupMember]
|
52
|
+
#
|
53
|
+
# @!attribute [rw] request_id
|
54
|
+
# The AWS request ID for this operation.
|
55
|
+
# @return [String]
|
56
|
+
#
|
57
|
+
# @!attribute [rw] status
|
58
|
+
# The http status of the request.
|
59
|
+
# @return [Integer]
|
60
|
+
#
|
61
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupMembershipResponse AWS API Documentation
|
62
|
+
#
|
63
|
+
class CreateGroupMembershipResponse < Struct.new(
|
64
|
+
:group_member,
|
65
|
+
:request_id,
|
66
|
+
:status)
|
67
|
+
include Aws::Structure
|
68
|
+
end
|
69
|
+
|
70
|
+
# The request object for this operation.
|
71
|
+
#
|
72
|
+
# @note When making an API call, you may pass CreateGroupRequest
|
73
|
+
# data as a hash:
|
74
|
+
#
|
75
|
+
# {
|
76
|
+
# group_name: "GroupName", # required
|
77
|
+
# description: "GroupDescription",
|
78
|
+
# aws_account_id: "AwsAccountId", # required
|
79
|
+
# namespace: "Namespace", # required
|
80
|
+
# }
|
81
|
+
#
|
82
|
+
# @!attribute [rw] group_name
|
83
|
+
# A name for the group that you want to create.
|
84
|
+
# @return [String]
|
85
|
+
#
|
86
|
+
# @!attribute [rw] description
|
87
|
+
# A description for the group that you want to create.
|
88
|
+
# @return [String]
|
89
|
+
#
|
90
|
+
# @!attribute [rw] aws_account_id
|
91
|
+
# The ID for the AWS account that the group is in. Currently, you use
|
92
|
+
# the ID for the AWS account that contains your Amazon QuickSight
|
93
|
+
# account.
|
94
|
+
# @return [String]
|
95
|
+
#
|
96
|
+
# @!attribute [rw] namespace
|
97
|
+
# The namespace. Currently, you should set this to `default`.
|
98
|
+
# @return [String]
|
99
|
+
#
|
100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupRequest AWS API Documentation
|
101
|
+
#
|
102
|
+
class CreateGroupRequest < Struct.new(
|
103
|
+
:group_name,
|
104
|
+
:description,
|
105
|
+
:aws_account_id,
|
106
|
+
:namespace)
|
107
|
+
include Aws::Structure
|
108
|
+
end
|
109
|
+
|
110
|
+
# The response object for this operation.
|
111
|
+
#
|
112
|
+
# @!attribute [rw] group
|
113
|
+
# The name of the group.
|
114
|
+
# @return [Types::Group]
|
115
|
+
#
|
116
|
+
# @!attribute [rw] request_id
|
117
|
+
# The AWS request ID for this operation.
|
118
|
+
# @return [String]
|
119
|
+
#
|
120
|
+
# @!attribute [rw] status
|
121
|
+
# The http status of the request.
|
122
|
+
# @return [Integer]
|
123
|
+
#
|
124
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupResponse AWS API Documentation
|
125
|
+
#
|
126
|
+
class CreateGroupResponse < Struct.new(
|
127
|
+
:group,
|
128
|
+
:request_id,
|
129
|
+
:status)
|
130
|
+
include Aws::Structure
|
131
|
+
end
|
132
|
+
|
133
|
+
# @note When making an API call, you may pass DeleteGroupMembershipRequest
|
134
|
+
# data as a hash:
|
135
|
+
#
|
136
|
+
# {
|
137
|
+
# member_name: "GroupMemberName", # required
|
138
|
+
# group_name: "GroupName", # required
|
139
|
+
# aws_account_id: "AwsAccountId", # required
|
140
|
+
# namespace: "Namespace", # required
|
141
|
+
# }
|
142
|
+
#
|
143
|
+
# @!attribute [rw] member_name
|
144
|
+
# The name of the user that you want to delete from the group
|
145
|
+
# membership.
|
146
|
+
# @return [String]
|
147
|
+
#
|
148
|
+
# @!attribute [rw] group_name
|
149
|
+
# The name of the group that you want to delete the user from.
|
150
|
+
# @return [String]
|
151
|
+
#
|
152
|
+
# @!attribute [rw] aws_account_id
|
153
|
+
# The ID for the AWS account that the group is in. Currently, you use
|
154
|
+
# the ID for the AWS account that contains your Amazon QuickSight
|
155
|
+
# account.
|
156
|
+
# @return [String]
|
157
|
+
#
|
158
|
+
# @!attribute [rw] namespace
|
159
|
+
# The namespace. Currently, you should set this to `default`.
|
160
|
+
# @return [String]
|
161
|
+
#
|
162
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroupMembershipRequest AWS API Documentation
|
163
|
+
#
|
164
|
+
class DeleteGroupMembershipRequest < Struct.new(
|
165
|
+
:member_name,
|
166
|
+
:group_name,
|
167
|
+
:aws_account_id,
|
168
|
+
:namespace)
|
169
|
+
include Aws::Structure
|
170
|
+
end
|
171
|
+
|
172
|
+
# @!attribute [rw] request_id
|
173
|
+
# The AWS request ID for this operation.
|
174
|
+
# @return [String]
|
175
|
+
#
|
176
|
+
# @!attribute [rw] status
|
177
|
+
# The http status of the request.
|
178
|
+
# @return [Integer]
|
179
|
+
#
|
180
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroupMembershipResponse AWS API Documentation
|
181
|
+
#
|
182
|
+
class DeleteGroupMembershipResponse < Struct.new(
|
183
|
+
:request_id,
|
184
|
+
:status)
|
185
|
+
include Aws::Structure
|
186
|
+
end
|
187
|
+
|
188
|
+
# @note When making an API call, you may pass DeleteGroupRequest
|
189
|
+
# data as a hash:
|
190
|
+
#
|
191
|
+
# {
|
192
|
+
# group_name: "GroupName", # required
|
193
|
+
# aws_account_id: "AwsAccountId", # required
|
194
|
+
# namespace: "Namespace", # required
|
195
|
+
# }
|
196
|
+
#
|
197
|
+
# @!attribute [rw] group_name
|
198
|
+
# The name of the group that you want to delete.
|
199
|
+
# @return [String]
|
200
|
+
#
|
201
|
+
# @!attribute [rw] aws_account_id
|
202
|
+
# The ID for the AWS account that the group is in. Currently, you use
|
203
|
+
# the ID for the AWS account that contains your Amazon QuickSight
|
204
|
+
# account.
|
205
|
+
# @return [String]
|
206
|
+
#
|
207
|
+
# @!attribute [rw] namespace
|
208
|
+
# The namespace. Currently, you should set this to `default`.
|
209
|
+
# @return [String]
|
210
|
+
#
|
211
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroupRequest AWS API Documentation
|
212
|
+
#
|
213
|
+
class DeleteGroupRequest < Struct.new(
|
214
|
+
:group_name,
|
215
|
+
:aws_account_id,
|
216
|
+
:namespace)
|
217
|
+
include Aws::Structure
|
218
|
+
end
|
219
|
+
|
220
|
+
# @!attribute [rw] request_id
|
221
|
+
# The AWS request ID for this operation.
|
222
|
+
# @return [String]
|
223
|
+
#
|
224
|
+
# @!attribute [rw] status
|
225
|
+
# The http status of the request.
|
226
|
+
# @return [Integer]
|
227
|
+
#
|
228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroupResponse AWS API Documentation
|
229
|
+
#
|
230
|
+
class DeleteGroupResponse < Struct.new(
|
231
|
+
:request_id,
|
232
|
+
:status)
|
233
|
+
include Aws::Structure
|
234
|
+
end
|
235
|
+
|
236
|
+
# @note When making an API call, you may pass DeleteUserRequest
|
237
|
+
# data as a hash:
|
238
|
+
#
|
239
|
+
# {
|
240
|
+
# user_name: "UserName", # required
|
241
|
+
# aws_account_id: "AwsAccountId", # required
|
242
|
+
# namespace: "Namespace", # required
|
243
|
+
# }
|
244
|
+
#
|
245
|
+
# @!attribute [rw] user_name
|
246
|
+
# The name of the user that you want to delete.
|
247
|
+
# @return [String]
|
248
|
+
#
|
249
|
+
# @!attribute [rw] aws_account_id
|
250
|
+
# The ID for the AWS account that the user is in. Currently, you use
|
251
|
+
# the ID for the AWS account that contains your Amazon QuickSight
|
252
|
+
# account.
|
253
|
+
# @return [String]
|
254
|
+
#
|
255
|
+
# @!attribute [rw] namespace
|
256
|
+
# The namespace. Currently, you should set this to `default`.
|
257
|
+
# @return [String]
|
258
|
+
#
|
259
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteUserRequest AWS API Documentation
|
260
|
+
#
|
261
|
+
class DeleteUserRequest < Struct.new(
|
262
|
+
:user_name,
|
263
|
+
:aws_account_id,
|
264
|
+
:namespace)
|
265
|
+
include Aws::Structure
|
266
|
+
end
|
267
|
+
|
268
|
+
# @!attribute [rw] request_id
|
269
|
+
# The AWS request ID for this operation.
|
270
|
+
# @return [String]
|
271
|
+
#
|
272
|
+
# @!attribute [rw] status
|
273
|
+
# The http status of the request.
|
274
|
+
# @return [Integer]
|
275
|
+
#
|
276
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteUserResponse AWS API Documentation
|
277
|
+
#
|
278
|
+
class DeleteUserResponse < Struct.new(
|
279
|
+
:request_id,
|
280
|
+
:status)
|
281
|
+
include Aws::Structure
|
282
|
+
end
|
283
|
+
|
284
|
+
# @note When making an API call, you may pass DescribeGroupRequest
|
285
|
+
# data as a hash:
|
286
|
+
#
|
287
|
+
# {
|
288
|
+
# group_name: "GroupName", # required
|
289
|
+
# aws_account_id: "AwsAccountId", # required
|
290
|
+
# namespace: "Namespace", # required
|
291
|
+
# }
|
292
|
+
#
|
293
|
+
# @!attribute [rw] group_name
|
294
|
+
# The name of the group that you want to describe.
|
295
|
+
# @return [String]
|
296
|
+
#
|
297
|
+
# @!attribute [rw] aws_account_id
|
298
|
+
# The ID for the AWS account that the group is in. Currently, you use
|
299
|
+
# the ID for the AWS account that contains your Amazon QuickSight
|
300
|
+
# account.
|
301
|
+
# @return [String]
|
302
|
+
#
|
303
|
+
# @!attribute [rw] namespace
|
304
|
+
# The namespace. Currently, you should set this to `default`.
|
305
|
+
# @return [String]
|
306
|
+
#
|
307
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeGroupRequest AWS API Documentation
|
308
|
+
#
|
309
|
+
class DescribeGroupRequest < Struct.new(
|
310
|
+
:group_name,
|
311
|
+
:aws_account_id,
|
312
|
+
:namespace)
|
313
|
+
include Aws::Structure
|
314
|
+
end
|
315
|
+
|
316
|
+
# @!attribute [rw] group
|
317
|
+
# The name of the group.
|
318
|
+
# @return [Types::Group]
|
319
|
+
#
|
320
|
+
# @!attribute [rw] request_id
|
321
|
+
# The AWS request ID for this operation.
|
322
|
+
# @return [String]
|
323
|
+
#
|
324
|
+
# @!attribute [rw] status
|
325
|
+
# The http status of the request.
|
326
|
+
# @return [Integer]
|
327
|
+
#
|
328
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeGroupResponse AWS API Documentation
|
329
|
+
#
|
330
|
+
class DescribeGroupResponse < Struct.new(
|
331
|
+
:group,
|
332
|
+
:request_id,
|
333
|
+
:status)
|
334
|
+
include Aws::Structure
|
335
|
+
end
|
336
|
+
|
337
|
+
# @note When making an API call, you may pass DescribeUserRequest
|
338
|
+
# data as a hash:
|
339
|
+
#
|
340
|
+
# {
|
341
|
+
# user_name: "UserName", # required
|
342
|
+
# aws_account_id: "AwsAccountId", # required
|
343
|
+
# namespace: "Namespace", # required
|
344
|
+
# }
|
345
|
+
#
|
346
|
+
# @!attribute [rw] user_name
|
347
|
+
# The name of the user that you want to describe.
|
348
|
+
# @return [String]
|
349
|
+
#
|
350
|
+
# @!attribute [rw] aws_account_id
|
351
|
+
# The ID for the AWS account that the user is in. Currently, you use
|
352
|
+
# the ID for the AWS account that contains your Amazon QuickSight
|
353
|
+
# account.
|
354
|
+
# @return [String]
|
355
|
+
#
|
356
|
+
# @!attribute [rw] namespace
|
357
|
+
# The namespace. Currently, you should set this to `default`.
|
358
|
+
# @return [String]
|
359
|
+
#
|
360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeUserRequest AWS API Documentation
|
361
|
+
#
|
362
|
+
class DescribeUserRequest < Struct.new(
|
363
|
+
:user_name,
|
364
|
+
:aws_account_id,
|
365
|
+
:namespace)
|
366
|
+
include Aws::Structure
|
367
|
+
end
|
368
|
+
|
369
|
+
# @!attribute [rw] user
|
370
|
+
# The user name.
|
371
|
+
# @return [Types::User]
|
372
|
+
#
|
373
|
+
# @!attribute [rw] request_id
|
374
|
+
# The AWS request ID for this operation.
|
375
|
+
# @return [String]
|
376
|
+
#
|
377
|
+
# @!attribute [rw] status
|
378
|
+
# The http status of the request.
|
379
|
+
# @return [Integer]
|
380
|
+
#
|
381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeUserResponse AWS API Documentation
|
382
|
+
#
|
383
|
+
class DescribeUserResponse < Struct.new(
|
384
|
+
:user,
|
385
|
+
:request_id,
|
386
|
+
:status)
|
387
|
+
include Aws::Structure
|
388
|
+
end
|
389
|
+
|
390
|
+
# @note When making an API call, you may pass GetDashboardEmbedUrlRequest
|
391
|
+
# data as a hash:
|
392
|
+
#
|
393
|
+
# {
|
394
|
+
# aws_account_id: "AwsAccountId", # required
|
395
|
+
# dashboard_id: "String", # required
|
396
|
+
# identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
|
397
|
+
# session_lifetime_in_minutes: 1,
|
398
|
+
# undo_redo_disabled: false,
|
399
|
+
# reset_disabled: false,
|
400
|
+
# }
|
401
|
+
#
|
402
|
+
# @!attribute [rw] aws_account_id
|
403
|
+
# AWS account ID that contains the dashboard you are embedding.
|
404
|
+
# @return [String]
|
405
|
+
#
|
406
|
+
# @!attribute [rw] dashboard_id
|
407
|
+
# The ID for the dashboard, also added to IAM policy
|
408
|
+
# @return [String]
|
409
|
+
#
|
410
|
+
# @!attribute [rw] identity_type
|
411
|
+
# The authentication method the user uses to sign in (IAM or
|
412
|
+
# QUICKSIGHT).
|
413
|
+
# @return [String]
|
414
|
+
#
|
415
|
+
# @!attribute [rw] session_lifetime_in_minutes
|
416
|
+
# How many minutes the session is valid. The session lifetime must be
|
417
|
+
# between 15 and 600 minutes.
|
418
|
+
# @return [Integer]
|
419
|
+
#
|
420
|
+
# @!attribute [rw] undo_redo_disabled
|
421
|
+
# Remove the undo/redo button on embedded dashboard. The default is
|
422
|
+
# FALSE, which enables the undo/redo button.
|
423
|
+
# @return [Boolean]
|
424
|
+
#
|
425
|
+
# @!attribute [rw] reset_disabled
|
426
|
+
# Remove the reset button on embedded dashboard. The default is FALSE,
|
427
|
+
# which allows the reset button.
|
428
|
+
# @return [Boolean]
|
429
|
+
#
|
430
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlRequest AWS API Documentation
|
431
|
+
#
|
432
|
+
class GetDashboardEmbedUrlRequest < Struct.new(
|
433
|
+
:aws_account_id,
|
434
|
+
:dashboard_id,
|
435
|
+
:identity_type,
|
436
|
+
:session_lifetime_in_minutes,
|
437
|
+
:undo_redo_disabled,
|
438
|
+
:reset_disabled)
|
439
|
+
include Aws::Structure
|
440
|
+
end
|
441
|
+
|
442
|
+
# @!attribute [rw] embed_url
|
443
|
+
# Call the GetDashboardEmbedUrl API to get the URL that you can embed
|
444
|
+
# in your dashboard. This URL is valid for 5 minutes, and the
|
445
|
+
# resulting session is valid for 10 hours. The API provides the URL
|
446
|
+
# with an auth\_code that enables a single-signon session.
|
447
|
+
# @return [String]
|
448
|
+
#
|
449
|
+
# @!attribute [rw] status
|
450
|
+
# The http status of the request.
|
451
|
+
# @return [Integer]
|
452
|
+
#
|
453
|
+
# @!attribute [rw] request_id
|
454
|
+
# The AWS request ID for this operation.
|
455
|
+
# @return [String]
|
456
|
+
#
|
457
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlResponse AWS API Documentation
|
458
|
+
#
|
459
|
+
class GetDashboardEmbedUrlResponse < Struct.new(
|
460
|
+
:embed_url,
|
461
|
+
:status,
|
462
|
+
:request_id)
|
463
|
+
include Aws::Structure
|
464
|
+
end
|
465
|
+
|
466
|
+
# A *group* in Amazon QuickSight consists of a set of users. You can use
|
467
|
+
# groups to make it easier to manage access and security. Currently, an
|
468
|
+
# Amazon QuickSight subscription can't contain more than 500 Amazon
|
469
|
+
# QuickSight groups.
|
470
|
+
#
|
471
|
+
# @!attribute [rw] arn
|
472
|
+
# The Amazon Resource Name (ARN) for the group.
|
473
|
+
# @return [String]
|
474
|
+
#
|
475
|
+
# @!attribute [rw] group_name
|
476
|
+
# The name of the group.
|
477
|
+
# @return [String]
|
478
|
+
#
|
479
|
+
# @!attribute [rw] description
|
480
|
+
# The group description.
|
481
|
+
# @return [String]
|
482
|
+
#
|
483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Group AWS API Documentation
|
484
|
+
#
|
485
|
+
class Group < Struct.new(
|
486
|
+
:arn,
|
487
|
+
:group_name,
|
488
|
+
:description)
|
489
|
+
include Aws::Structure
|
490
|
+
end
|
491
|
+
|
492
|
+
# A member of an Amazon QuickSight group. Currently, group members must
|
493
|
+
# be users. Groups can't be members of another group.
|
494
|
+
#
|
495
|
+
# @!attribute [rw] arn
|
496
|
+
# The Amazon Resource Name (ARN) for the group member (user).
|
497
|
+
# @return [String]
|
498
|
+
#
|
499
|
+
# @!attribute [rw] member_name
|
500
|
+
# The name of the group member (user).
|
501
|
+
# @return [String]
|
502
|
+
#
|
503
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GroupMember AWS API Documentation
|
504
|
+
#
|
505
|
+
class GroupMember < Struct.new(
|
506
|
+
:arn,
|
507
|
+
:member_name)
|
508
|
+
include Aws::Structure
|
509
|
+
end
|
510
|
+
|
511
|
+
# @note When making an API call, you may pass ListGroupMembershipsRequest
|
512
|
+
# data as a hash:
|
513
|
+
#
|
514
|
+
# {
|
515
|
+
# group_name: "GroupName", # required
|
516
|
+
# next_token: "String",
|
517
|
+
# max_results: 1,
|
518
|
+
# aws_account_id: "AwsAccountId", # required
|
519
|
+
# namespace: "Namespace", # required
|
520
|
+
# }
|
521
|
+
#
|
522
|
+
# @!attribute [rw] group_name
|
523
|
+
# The name of the group that you want to see a membership list of.
|
524
|
+
# @return [String]
|
525
|
+
#
|
526
|
+
# @!attribute [rw] next_token
|
527
|
+
# A pagination token that can be used in a subsequent request.
|
528
|
+
# @return [String]
|
529
|
+
#
|
530
|
+
# @!attribute [rw] max_results
|
531
|
+
# The maximum number of results to return from this request.
|
532
|
+
# @return [Integer]
|
533
|
+
#
|
534
|
+
# @!attribute [rw] aws_account_id
|
535
|
+
# The ID for the AWS account that the group is in. Currently, you use
|
536
|
+
# the ID for the AWS account that contains your Amazon QuickSight
|
537
|
+
# account.
|
538
|
+
# @return [String]
|
539
|
+
#
|
540
|
+
# @!attribute [rw] namespace
|
541
|
+
# The namespace. Currently, you should set this to `default`.
|
542
|
+
# @return [String]
|
543
|
+
#
|
544
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroupMembershipsRequest AWS API Documentation
|
545
|
+
#
|
546
|
+
class ListGroupMembershipsRequest < Struct.new(
|
547
|
+
:group_name,
|
548
|
+
:next_token,
|
549
|
+
:max_results,
|
550
|
+
:aws_account_id,
|
551
|
+
:namespace)
|
552
|
+
include Aws::Structure
|
553
|
+
end
|
554
|
+
|
555
|
+
# @!attribute [rw] group_member_list
|
556
|
+
# The list of the members of the group.
|
557
|
+
# @return [Array<Types::GroupMember>]
|
558
|
+
#
|
559
|
+
# @!attribute [rw] next_token
|
560
|
+
# A pagination token that can be used in a subsequent request.
|
561
|
+
# @return [String]
|
562
|
+
#
|
563
|
+
# @!attribute [rw] request_id
|
564
|
+
# The AWS request ID for this operation.
|
565
|
+
# @return [String]
|
566
|
+
#
|
567
|
+
# @!attribute [rw] status
|
568
|
+
# The http status of the request.
|
569
|
+
# @return [Integer]
|
570
|
+
#
|
571
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroupMembershipsResponse AWS API Documentation
|
572
|
+
#
|
573
|
+
class ListGroupMembershipsResponse < Struct.new(
|
574
|
+
:group_member_list,
|
575
|
+
:next_token,
|
576
|
+
:request_id,
|
577
|
+
:status)
|
578
|
+
include Aws::Structure
|
579
|
+
end
|
580
|
+
|
581
|
+
# @note When making an API call, you may pass ListGroupsRequest
|
582
|
+
# data as a hash:
|
583
|
+
#
|
584
|
+
# {
|
585
|
+
# aws_account_id: "AwsAccountId", # required
|
586
|
+
# next_token: "String",
|
587
|
+
# max_results: 1,
|
588
|
+
# namespace: "Namespace", # required
|
589
|
+
# }
|
590
|
+
#
|
591
|
+
# @!attribute [rw] aws_account_id
|
592
|
+
# The ID for the AWS account that the group is in. Currently, you use
|
593
|
+
# the ID for the AWS account that contains your Amazon QuickSight
|
594
|
+
# account.
|
595
|
+
# @return [String]
|
596
|
+
#
|
597
|
+
# @!attribute [rw] next_token
|
598
|
+
# A pagination token that can be used in a subsequent request.
|
599
|
+
# @return [String]
|
600
|
+
#
|
601
|
+
# @!attribute [rw] max_results
|
602
|
+
# The maximum number of results to return.
|
603
|
+
# @return [Integer]
|
604
|
+
#
|
605
|
+
# @!attribute [rw] namespace
|
606
|
+
# The namespace. Currently, you should set this to `default`.
|
607
|
+
# @return [String]
|
608
|
+
#
|
609
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroupsRequest AWS API Documentation
|
610
|
+
#
|
611
|
+
class ListGroupsRequest < Struct.new(
|
612
|
+
:aws_account_id,
|
613
|
+
:next_token,
|
614
|
+
:max_results,
|
615
|
+
:namespace)
|
616
|
+
include Aws::Structure
|
617
|
+
end
|
618
|
+
|
619
|
+
# @!attribute [rw] group_list
|
620
|
+
# The list of the groups.
|
621
|
+
# @return [Array<Types::Group>]
|
622
|
+
#
|
623
|
+
# @!attribute [rw] next_token
|
624
|
+
# A pagination token that can be used in a subsequent request.
|
625
|
+
# @return [String]
|
626
|
+
#
|
627
|
+
# @!attribute [rw] request_id
|
628
|
+
# The AWS request ID for this operation.
|
629
|
+
# @return [String]
|
630
|
+
#
|
631
|
+
# @!attribute [rw] status
|
632
|
+
# The http status of the request.
|
633
|
+
# @return [Integer]
|
634
|
+
#
|
635
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroupsResponse AWS API Documentation
|
636
|
+
#
|
637
|
+
class ListGroupsResponse < Struct.new(
|
638
|
+
:group_list,
|
639
|
+
:next_token,
|
640
|
+
:request_id,
|
641
|
+
:status)
|
642
|
+
include Aws::Structure
|
643
|
+
end
|
644
|
+
|
645
|
+
# @note When making an API call, you may pass ListUserGroupsRequest
|
646
|
+
# data as a hash:
|
647
|
+
#
|
648
|
+
# {
|
649
|
+
# user_name: "UserName", # required
|
650
|
+
# aws_account_id: "AwsAccountId", # required
|
651
|
+
# namespace: "Namespace", # required
|
652
|
+
# next_token: "String",
|
653
|
+
# max_results: 1,
|
654
|
+
# }
|
655
|
+
#
|
656
|
+
# @!attribute [rw] user_name
|
657
|
+
# The name of the user that you want to list groups for.
|
658
|
+
# @return [String]
|
659
|
+
#
|
660
|
+
# @!attribute [rw] aws_account_id
|
661
|
+
# The AWS Account ID that the user is in. Currently, use the AWS
|
662
|
+
# Account ID which contains your Amazon QuickSight account.
|
663
|
+
# @return [String]
|
664
|
+
#
|
665
|
+
# @!attribute [rw] namespace
|
666
|
+
# The namespace. Currently, you should set this to `default`.
|
667
|
+
# @return [String]
|
668
|
+
#
|
669
|
+
# @!attribute [rw] next_token
|
670
|
+
# A pagination token that can be used in a subsequent request.
|
671
|
+
# @return [String]
|
672
|
+
#
|
673
|
+
# @!attribute [rw] max_results
|
674
|
+
# The maximum number of results to return from this request.
|
675
|
+
# @return [Integer]
|
676
|
+
#
|
677
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUserGroupsRequest AWS API Documentation
|
678
|
+
#
|
679
|
+
class ListUserGroupsRequest < Struct.new(
|
680
|
+
:user_name,
|
681
|
+
:aws_account_id,
|
682
|
+
:namespace,
|
683
|
+
:next_token,
|
684
|
+
:max_results)
|
685
|
+
include Aws::Structure
|
686
|
+
end
|
687
|
+
|
688
|
+
# @!attribute [rw] group_list
|
689
|
+
# The list of groups the user is a member of.
|
690
|
+
# @return [Array<Types::Group>]
|
691
|
+
#
|
692
|
+
# @!attribute [rw] next_token
|
693
|
+
# A pagination token that can be used in a subsequent request.
|
694
|
+
# @return [String]
|
695
|
+
#
|
696
|
+
# @!attribute [rw] request_id
|
697
|
+
# The AWS request ID for this operation.
|
698
|
+
# @return [String]
|
699
|
+
#
|
700
|
+
# @!attribute [rw] status
|
701
|
+
# The http status of the request.
|
702
|
+
# @return [Integer]
|
703
|
+
#
|
704
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUserGroupsResponse AWS API Documentation
|
705
|
+
#
|
706
|
+
class ListUserGroupsResponse < Struct.new(
|
707
|
+
:group_list,
|
708
|
+
:next_token,
|
709
|
+
:request_id,
|
710
|
+
:status)
|
711
|
+
include Aws::Structure
|
712
|
+
end
|
713
|
+
|
714
|
+
# @note When making an API call, you may pass ListUsersRequest
|
715
|
+
# data as a hash:
|
716
|
+
#
|
717
|
+
# {
|
718
|
+
# aws_account_id: "AwsAccountId", # required
|
719
|
+
# next_token: "String",
|
720
|
+
# max_results: 1,
|
721
|
+
# namespace: "Namespace", # required
|
722
|
+
# }
|
723
|
+
#
|
724
|
+
# @!attribute [rw] aws_account_id
|
725
|
+
# The ID for the AWS account that the user is in. Currently, you use
|
726
|
+
# the ID for the AWS account that contains your Amazon QuickSight
|
727
|
+
# account.
|
728
|
+
# @return [String]
|
729
|
+
#
|
730
|
+
# @!attribute [rw] next_token
|
731
|
+
# A pagination token that can be used in a subsequent request.
|
732
|
+
# @return [String]
|
733
|
+
#
|
734
|
+
# @!attribute [rw] max_results
|
735
|
+
# The maximum number of results to return from this request.
|
736
|
+
# @return [Integer]
|
737
|
+
#
|
738
|
+
# @!attribute [rw] namespace
|
739
|
+
# The namespace. Currently, you should set this to `default`.
|
740
|
+
# @return [String]
|
741
|
+
#
|
742
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUsersRequest AWS API Documentation
|
743
|
+
#
|
744
|
+
class ListUsersRequest < Struct.new(
|
745
|
+
:aws_account_id,
|
746
|
+
:next_token,
|
747
|
+
:max_results,
|
748
|
+
:namespace)
|
749
|
+
include Aws::Structure
|
750
|
+
end
|
751
|
+
|
752
|
+
# @!attribute [rw] user_list
|
753
|
+
# The list of users.
|
754
|
+
# @return [Array<Types::User>]
|
755
|
+
#
|
756
|
+
# @!attribute [rw] next_token
|
757
|
+
# A pagination token that can be used in a subsequent request.
|
758
|
+
# @return [String]
|
759
|
+
#
|
760
|
+
# @!attribute [rw] request_id
|
761
|
+
# The AWS request ID for this operation.
|
762
|
+
# @return [String]
|
763
|
+
#
|
764
|
+
# @!attribute [rw] status
|
765
|
+
# The http status of the request.
|
766
|
+
# @return [Integer]
|
767
|
+
#
|
768
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUsersResponse AWS API Documentation
|
769
|
+
#
|
770
|
+
class ListUsersResponse < Struct.new(
|
771
|
+
:user_list,
|
772
|
+
:next_token,
|
773
|
+
:request_id,
|
774
|
+
:status)
|
775
|
+
include Aws::Structure
|
776
|
+
end
|
777
|
+
|
778
|
+
# @note When making an API call, you may pass RegisterUserRequest
|
779
|
+
# data as a hash:
|
780
|
+
#
|
781
|
+
# {
|
782
|
+
# identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
|
783
|
+
# email: "String", # required
|
784
|
+
# user_role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
|
785
|
+
# iam_arn: "String",
|
786
|
+
# session_name: "String",
|
787
|
+
# aws_account_id: "AwsAccountId", # required
|
788
|
+
# namespace: "Namespace", # required
|
789
|
+
# user_name: "UserName",
|
790
|
+
# }
|
791
|
+
#
|
792
|
+
# @!attribute [rw] identity_type
|
793
|
+
# Amazon QuickSight supports several ways of managing the identity of
|
794
|
+
# users. This parameter accepts two values:
|
795
|
+
#
|
796
|
+
# * `IAM`\: A user whose identity maps to an existing IAM user or
|
797
|
+
# role.
|
798
|
+
#
|
799
|
+
# * `QUICKSIGHT`\: A user whose identity is owned and managed
|
800
|
+
# internally by Amazon QuickSight.
|
801
|
+
# @return [String]
|
802
|
+
#
|
803
|
+
# @!attribute [rw] email
|
804
|
+
# The email address of the user that you want to register.
|
805
|
+
# @return [String]
|
806
|
+
#
|
807
|
+
# @!attribute [rw] user_role
|
808
|
+
# The Amazon QuickSight role of the user. The user role can be one of
|
809
|
+
# the following:
|
810
|
+
#
|
811
|
+
# * `READER`\: A user who has read-only access to dashboards.
|
812
|
+
#
|
813
|
+
# * `AUTHOR`\: A user who can create data sources, data sets,
|
814
|
+
# analyses, and dashboards.
|
815
|
+
#
|
816
|
+
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
817
|
+
# QuickSight settings.
|
818
|
+
# @return [String]
|
819
|
+
#
|
820
|
+
# @!attribute [rw] iam_arn
|
821
|
+
# The ARN of the IAM user or role that you are registering with Amazon
|
822
|
+
# QuickSight.
|
823
|
+
# @return [String]
|
824
|
+
#
|
825
|
+
# @!attribute [rw] session_name
|
826
|
+
# The name of the session with the assumed IAM role. By using this
|
827
|
+
# parameter, you can register multiple users with the same IAM role,
|
828
|
+
# provided that each has a different session name. For more
|
829
|
+
# information on assuming IAM roles, see [ `assume-role` ][1] in the
|
830
|
+
# *AWS CLI Reference.*
|
831
|
+
#
|
832
|
+
#
|
833
|
+
#
|
834
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html
|
835
|
+
# @return [String]
|
836
|
+
#
|
837
|
+
# @!attribute [rw] aws_account_id
|
838
|
+
# The ID for the AWS account that the user is in. Currently, you use
|
839
|
+
# the ID for the AWS account that contains your Amazon QuickSight
|
840
|
+
# account.
|
841
|
+
# @return [String]
|
842
|
+
#
|
843
|
+
# @!attribute [rw] namespace
|
844
|
+
# The namespace. Currently, you should set this to `default`.
|
845
|
+
# @return [String]
|
846
|
+
#
|
847
|
+
# @!attribute [rw] user_name
|
848
|
+
# The Amazon QuickSight user name that you want to create for the user
|
849
|
+
# you are registering.
|
850
|
+
# @return [String]
|
851
|
+
#
|
852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisterUserRequest AWS API Documentation
|
853
|
+
#
|
854
|
+
class RegisterUserRequest < Struct.new(
|
855
|
+
:identity_type,
|
856
|
+
:email,
|
857
|
+
:user_role,
|
858
|
+
:iam_arn,
|
859
|
+
:session_name,
|
860
|
+
:aws_account_id,
|
861
|
+
:namespace,
|
862
|
+
:user_name)
|
863
|
+
include Aws::Structure
|
864
|
+
end
|
865
|
+
|
866
|
+
# @!attribute [rw] user
|
867
|
+
# The user name.
|
868
|
+
# @return [Types::User]
|
869
|
+
#
|
870
|
+
# @!attribute [rw] request_id
|
871
|
+
# The AWS request ID for this operation.
|
872
|
+
# @return [String]
|
873
|
+
#
|
874
|
+
# @!attribute [rw] status
|
875
|
+
# The http status of the request.
|
876
|
+
# @return [Integer]
|
877
|
+
#
|
878
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisterUserResponse AWS API Documentation
|
879
|
+
#
|
880
|
+
class RegisterUserResponse < Struct.new(
|
881
|
+
:user,
|
882
|
+
:request_id,
|
883
|
+
:status)
|
884
|
+
include Aws::Structure
|
885
|
+
end
|
886
|
+
|
887
|
+
# @note When making an API call, you may pass UpdateGroupRequest
|
888
|
+
# data as a hash:
|
889
|
+
#
|
890
|
+
# {
|
891
|
+
# group_name: "GroupName", # required
|
892
|
+
# description: "GroupDescription",
|
893
|
+
# aws_account_id: "AwsAccountId", # required
|
894
|
+
# namespace: "Namespace", # required
|
895
|
+
# }
|
896
|
+
#
|
897
|
+
# @!attribute [rw] group_name
|
898
|
+
# The name of the group that you want to update.
|
899
|
+
# @return [String]
|
900
|
+
#
|
901
|
+
# @!attribute [rw] description
|
902
|
+
# The description for the group that you want to update.
|
903
|
+
# @return [String]
|
904
|
+
#
|
905
|
+
# @!attribute [rw] aws_account_id
|
906
|
+
# The ID for the AWS account that the group is in. Currently, you use
|
907
|
+
# the ID for the AWS account that contains your Amazon QuickSight
|
908
|
+
# account.
|
909
|
+
# @return [String]
|
910
|
+
#
|
911
|
+
# @!attribute [rw] namespace
|
912
|
+
# The namespace. Currently, you should set this to `default`.
|
913
|
+
# @return [String]
|
914
|
+
#
|
915
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateGroupRequest AWS API Documentation
|
916
|
+
#
|
917
|
+
class UpdateGroupRequest < Struct.new(
|
918
|
+
:group_name,
|
919
|
+
:description,
|
920
|
+
:aws_account_id,
|
921
|
+
:namespace)
|
922
|
+
include Aws::Structure
|
923
|
+
end
|
924
|
+
|
925
|
+
# @!attribute [rw] group
|
926
|
+
# The name of the group.
|
927
|
+
# @return [Types::Group]
|
928
|
+
#
|
929
|
+
# @!attribute [rw] request_id
|
930
|
+
# The AWS request ID for this operation.
|
931
|
+
# @return [String]
|
932
|
+
#
|
933
|
+
# @!attribute [rw] status
|
934
|
+
# The http status of the request.
|
935
|
+
# @return [Integer]
|
936
|
+
#
|
937
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateGroupResponse AWS API Documentation
|
938
|
+
#
|
939
|
+
class UpdateGroupResponse < Struct.new(
|
940
|
+
:group,
|
941
|
+
:request_id,
|
942
|
+
:status)
|
943
|
+
include Aws::Structure
|
944
|
+
end
|
945
|
+
|
946
|
+
# @note When making an API call, you may pass UpdateUserRequest
|
947
|
+
# data as a hash:
|
948
|
+
#
|
949
|
+
# {
|
950
|
+
# user_name: "UserName", # required
|
951
|
+
# aws_account_id: "AwsAccountId", # required
|
952
|
+
# namespace: "Namespace", # required
|
953
|
+
# email: "String", # required
|
954
|
+
# role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
|
955
|
+
# }
|
956
|
+
#
|
957
|
+
# @!attribute [rw] user_name
|
958
|
+
# The Amazon QuickSight user name that you want to update.
|
959
|
+
# @return [String]
|
960
|
+
#
|
961
|
+
# @!attribute [rw] aws_account_id
|
962
|
+
# The ID for the AWS account that the user is in. Currently, you use
|
963
|
+
# the ID for the AWS account that contains your Amazon QuickSight
|
964
|
+
# account.
|
965
|
+
# @return [String]
|
966
|
+
#
|
967
|
+
# @!attribute [rw] namespace
|
968
|
+
# The namespace. Currently, you should set this to `default`.
|
969
|
+
# @return [String]
|
970
|
+
#
|
971
|
+
# @!attribute [rw] email
|
972
|
+
# The email address of the user that you want to update.
|
973
|
+
# @return [String]
|
974
|
+
#
|
975
|
+
# @!attribute [rw] role
|
976
|
+
# The Amazon QuickSight role of the user. The user role can be one of
|
977
|
+
# the following:
|
978
|
+
#
|
979
|
+
# * `READER`\: A user who has read-only access to dashboards.
|
980
|
+
#
|
981
|
+
# * `AUTHOR`\: A user who can create data sources, data sets,
|
982
|
+
# analyses, and dashboards.
|
983
|
+
#
|
984
|
+
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
985
|
+
# QuickSight settings.
|
986
|
+
# @return [String]
|
987
|
+
#
|
988
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateUserRequest AWS API Documentation
|
989
|
+
#
|
990
|
+
class UpdateUserRequest < Struct.new(
|
991
|
+
:user_name,
|
992
|
+
:aws_account_id,
|
993
|
+
:namespace,
|
994
|
+
:email,
|
995
|
+
:role)
|
996
|
+
include Aws::Structure
|
997
|
+
end
|
998
|
+
|
999
|
+
# @!attribute [rw] user
|
1000
|
+
# The Amazon QuickSight user.
|
1001
|
+
# @return [Types::User]
|
1002
|
+
#
|
1003
|
+
# @!attribute [rw] request_id
|
1004
|
+
# The AWS request ID for this operation.
|
1005
|
+
# @return [String]
|
1006
|
+
#
|
1007
|
+
# @!attribute [rw] status
|
1008
|
+
# The http status of the request.
|
1009
|
+
# @return [Integer]
|
1010
|
+
#
|
1011
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateUserResponse AWS API Documentation
|
1012
|
+
#
|
1013
|
+
class UpdateUserResponse < Struct.new(
|
1014
|
+
:user,
|
1015
|
+
:request_id,
|
1016
|
+
:status)
|
1017
|
+
include Aws::Structure
|
1018
|
+
end
|
1019
|
+
|
1020
|
+
# A registered user of Amazon QuickSight. Currently, an Amazon
|
1021
|
+
# QuickSight subscription can't contain more than 20 million users.
|
1022
|
+
#
|
1023
|
+
# @!attribute [rw] arn
|
1024
|
+
# The Amazon Resource Name (ARN) for the user.
|
1025
|
+
# @return [String]
|
1026
|
+
#
|
1027
|
+
# @!attribute [rw] user_name
|
1028
|
+
# The user's user name.
|
1029
|
+
# @return [String]
|
1030
|
+
#
|
1031
|
+
# @!attribute [rw] email
|
1032
|
+
# The user's email address.
|
1033
|
+
# @return [String]
|
1034
|
+
#
|
1035
|
+
# @!attribute [rw] role
|
1036
|
+
# The Amazon QuickSight role for the user.
|
1037
|
+
# @return [String]
|
1038
|
+
#
|
1039
|
+
# @!attribute [rw] identity_type
|
1040
|
+
# The type of identity authentication used by the user.
|
1041
|
+
# @return [String]
|
1042
|
+
#
|
1043
|
+
# @!attribute [rw] active
|
1044
|
+
# Active status of user. When you create an Amazon QuickSight user
|
1045
|
+
# that’s not an IAM user or an AD user, that user is inactive until
|
1046
|
+
# they sign in and provide a password
|
1047
|
+
# @return [Boolean]
|
1048
|
+
#
|
1049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/User AWS API Documentation
|
1050
|
+
#
|
1051
|
+
class User < Struct.new(
|
1052
|
+
:arn,
|
1053
|
+
:user_name,
|
1054
|
+
:email,
|
1055
|
+
:role,
|
1056
|
+
:identity_type,
|
1057
|
+
:active)
|
1058
|
+
include Aws::Structure
|
1059
|
+
end
|
1060
|
+
|
1061
|
+
end
|
1062
|
+
end
|