quicksight.d.ts
39.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class QuickSight extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: QuickSight.Types.ClientConfiguration)
config: Config & QuickSight.Types.ClientConfiguration;
/**
* Creates an Amazon QuickSight group. The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> . The response is a group object. CLI Sample: aws quicksight create-group --aws-account-id=111122223333 --namespace=default --group-name="Sales-Management" --description="Sales Management - Forecasting"
*/
createGroup(params: QuickSight.Types.CreateGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateGroupResponse) => void): Request<QuickSight.Types.CreateGroupResponse, AWSError>;
/**
* Creates an Amazon QuickSight group. The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> . The response is a group object. CLI Sample: aws quicksight create-group --aws-account-id=111122223333 --namespace=default --group-name="Sales-Management" --description="Sales Management - Forecasting"
*/
createGroup(callback?: (err: AWSError, data: QuickSight.Types.CreateGroupResponse) => void): Request<QuickSight.Types.CreateGroupResponse, AWSError>;
/**
* Adds an Amazon QuickSight user to an Amazon QuickSight group. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . The condition resource is the user name. The condition key is quicksight:UserName. The response is the group member object. CLI Sample: aws quicksight create-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales --member-name=Pat
*/
createGroupMembership(params: QuickSight.Types.CreateGroupMembershipRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateGroupMembershipResponse) => void): Request<QuickSight.Types.CreateGroupMembershipResponse, AWSError>;
/**
* Adds an Amazon QuickSight user to an Amazon QuickSight group. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . The condition resource is the user name. The condition key is quicksight:UserName. The response is the group member object. CLI Sample: aws quicksight create-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales --member-name=Pat
*/
createGroupMembership(callback?: (err: AWSError, data: QuickSight.Types.CreateGroupMembershipResponse) => void): Request<QuickSight.Types.CreateGroupMembershipResponse, AWSError>;
/**
* Removes a user group from Amazon QuickSight. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . CLI Sample: aws quicksight delete-group -\-aws-account-id=111122223333 -\-namespace=default -\-group-name=Sales-Management
*/
deleteGroup(params: QuickSight.Types.DeleteGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupResponse) => void): Request<QuickSight.Types.DeleteGroupResponse, AWSError>;
/**
* Removes a user group from Amazon QuickSight. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . CLI Sample: aws quicksight delete-group -\-aws-account-id=111122223333 -\-namespace=default -\-group-name=Sales-Management
*/
deleteGroup(callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupResponse) => void): Request<QuickSight.Types.DeleteGroupResponse, AWSError>;
/**
* Removes a user from a group so that the user is no longer a member of the group. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . The condition resource is the user name. The condition key is quicksight:UserName. CLI Sample: aws quicksight delete-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales-Management --member-name=Charlie
*/
deleteGroupMembership(params: QuickSight.Types.DeleteGroupMembershipRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupMembershipResponse) => void): Request<QuickSight.Types.DeleteGroupMembershipResponse, AWSError>;
/**
* Removes a user from a group so that the user is no longer a member of the group. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . The condition resource is the user name. The condition key is quicksight:UserName. CLI Sample: aws quicksight delete-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales-Management --member-name=Charlie
*/
deleteGroupMembership(callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupMembershipResponse) => void): Request<QuickSight.Types.DeleteGroupMembershipResponse, AWSError>;
/**
* Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . CLI Sample: aws quicksight delete-user --aws-account-id=111122223333 --namespace=default --user-name=Pat
*/
deleteUser(params: QuickSight.Types.DeleteUserRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteUserResponse) => void): Request<QuickSight.Types.DeleteUserResponse, AWSError>;
/**
* Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . CLI Sample: aws quicksight delete-user --aws-account-id=111122223333 --namespace=default --user-name=Pat
*/
deleteUser(callback?: (err: AWSError, data: QuickSight.Types.DeleteUserResponse) => void): Request<QuickSight.Types.DeleteUserResponse, AWSError>;
/**
* Deletes a user identified by its principal ID. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . CLI Sample: aws quicksight delete-user-by-principal-id --aws-account-id=111122223333 --namespace=default --principal-id=ABCDEFJA26JLI7EUUOEHS
*/
deleteUserByPrincipalId(params: QuickSight.Types.DeleteUserByPrincipalIdRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteUserByPrincipalIdResponse) => void): Request<QuickSight.Types.DeleteUserByPrincipalIdResponse, AWSError>;
/**
* Deletes a user identified by its principal ID. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . CLI Sample: aws quicksight delete-user-by-principal-id --aws-account-id=111122223333 --namespace=default --principal-id=ABCDEFJA26JLI7EUUOEHS
*/
deleteUserByPrincipalId(callback?: (err: AWSError, data: QuickSight.Types.DeleteUserByPrincipalIdResponse) => void): Request<QuickSight.Types.DeleteUserByPrincipalIdResponse, AWSError>;
/**
* Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN). The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> . The response is the group object. CLI Sample: aws quicksight describe-group -\-aws-account-id=11112222333 -\-namespace=default -\-group-name=Sales
*/
describeGroup(params: QuickSight.Types.DescribeGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeGroupResponse) => void): Request<QuickSight.Types.DescribeGroupResponse, AWSError>;
/**
* Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN). The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> . The response is the group object. CLI Sample: aws quicksight describe-group -\-aws-account-id=11112222333 -\-namespace=default -\-group-name=Sales
*/
describeGroup(callback?: (err: AWSError, data: QuickSight.Types.DescribeGroupResponse) => void): Request<QuickSight.Types.DescribeGroupResponse, AWSError>;
/**
* Returns information about a user, given the user name. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . The response is a user object that contains the user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address. CLI Sample: aws quicksight describe-user --aws-account-id=111122223333 --namespace=default --user-name=Pat
*/
describeUser(params: QuickSight.Types.DescribeUserRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeUserResponse) => void): Request<QuickSight.Types.DescribeUserResponse, AWSError>;
/**
* Returns information about a user, given the user name. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . The response is a user object that contains the user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address. CLI Sample: aws quicksight describe-user --aws-account-id=111122223333 --namespace=default --user-name=Pat
*/
describeUser(callback?: (err: AWSError, data: QuickSight.Types.DescribeUserResponse) => void): Request<QuickSight.Types.DescribeUserResponse, AWSError>;
/**
* Generates a server-side embeddable URL and authorization code. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards. Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser. CLI Sample: Assume the role with permissions enabled for actions: quickSight:RegisterUser and quicksight:GetDashboardEmbedURL. You can use assume-role, assume-role-with-web-identity, or assume-role-with-saml. aws sts assume-role --role-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --role-session-name embeddingsession If the user does not exist in QuickSight, register the user: aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --user-role READER --session-name "embeddingsession" --email user123@example.com --region us-east-1 Get the URL for the embedded dashboard aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type IAM
*/
getDashboardEmbedUrl(params: QuickSight.Types.GetDashboardEmbedUrlRequest, callback?: (err: AWSError, data: QuickSight.Types.GetDashboardEmbedUrlResponse) => void): Request<QuickSight.Types.GetDashboardEmbedUrlResponse, AWSError>;
/**
* Generates a server-side embeddable URL and authorization code. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards. Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser. CLI Sample: Assume the role with permissions enabled for actions: quickSight:RegisterUser and quicksight:GetDashboardEmbedURL. You can use assume-role, assume-role-with-web-identity, or assume-role-with-saml. aws sts assume-role --role-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --role-session-name embeddingsession If the user does not exist in QuickSight, register the user: aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --user-role READER --session-name "embeddingsession" --email user123@example.com --region us-east-1 Get the URL for the embedded dashboard aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type IAM
*/
getDashboardEmbedUrl(callback?: (err: AWSError, data: QuickSight.Types.GetDashboardEmbedUrlResponse) => void): Request<QuickSight.Types.GetDashboardEmbedUrlResponse, AWSError>;
/**
* Lists member users in a group. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . The response is a list of group member objects. CLI Sample: aws quicksight list-group-memberships -\-aws-account-id=111122223333 -\-namespace=default
*/
listGroupMemberships(params: QuickSight.Types.ListGroupMembershipsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListGroupMembershipsResponse) => void): Request<QuickSight.Types.ListGroupMembershipsResponse, AWSError>;
/**
* Lists member users in a group. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . The response is a list of group member objects. CLI Sample: aws quicksight list-group-memberships -\-aws-account-id=111122223333 -\-namespace=default
*/
listGroupMemberships(callback?: (err: AWSError, data: QuickSight.Types.ListGroupMembershipsResponse) => void): Request<QuickSight.Types.ListGroupMembershipsResponse, AWSError>;
/**
* Lists all user groups in Amazon QuickSight. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/*. The response is a list of group objects. CLI Sample: aws quicksight list-groups -\-aws-account-id=111122223333 -\-namespace=default
*/
listGroups(params: QuickSight.Types.ListGroupsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListGroupsResponse) => void): Request<QuickSight.Types.ListGroupsResponse, AWSError>;
/**
* Lists all user groups in Amazon QuickSight. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/*. The response is a list of group objects. CLI Sample: aws quicksight list-groups -\-aws-account-id=111122223333 -\-namespace=default
*/
listGroups(callback?: (err: AWSError, data: QuickSight.Types.ListGroupsResponse) => void): Request<QuickSight.Types.ListGroupsResponse, AWSError>;
/**
* Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . The response is a one or more group objects. CLI Sample: aws quicksight list-user-groups -\-user-name=Pat -\-aws-account-id=111122223333 -\-namespace=default -\-region=us-east-1
*/
listUserGroups(params: QuickSight.Types.ListUserGroupsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListUserGroupsResponse) => void): Request<QuickSight.Types.ListUserGroupsResponse, AWSError>;
/**
* Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . The response is a one or more group objects. CLI Sample: aws quicksight list-user-groups -\-user-name=Pat -\-aws-account-id=111122223333 -\-namespace=default -\-region=us-east-1
*/
listUserGroups(callback?: (err: AWSError, data: QuickSight.Types.ListUserGroupsResponse) => void): Request<QuickSight.Types.ListUserGroupsResponse, AWSError>;
/**
* Returns a list of all of the Amazon QuickSight users belonging to this account. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/* . The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address. CLI Sample: aws quicksight list-users --aws-account-id=111122223333 --namespace=default
*/
listUsers(params: QuickSight.Types.ListUsersRequest, callback?: (err: AWSError, data: QuickSight.Types.ListUsersResponse) => void): Request<QuickSight.Types.ListUsersResponse, AWSError>;
/**
* Returns a list of all of the Amazon QuickSight users belonging to this account. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/* . The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address. CLI Sample: aws quicksight list-users --aws-account-id=111122223333 --namespace=default
*/
listUsers(callback?: (err: AWSError, data: QuickSight.Types.ListUsersResponse) => void): Request<QuickSight.Types.ListUsersResponse, AWSError>;
/**
* Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name. The condition keys are quicksight:IamArn and quicksight:SessionName. CLI Sample: aws quicksight register-user -\-aws-account-id=111122223333 -\-namespace=default -\-email=pat@example.com -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat
*/
registerUser(params: QuickSight.Types.RegisterUserRequest, callback?: (err: AWSError, data: QuickSight.Types.RegisterUserResponse) => void): Request<QuickSight.Types.RegisterUserResponse, AWSError>;
/**
* Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name. The condition keys are quicksight:IamArn and quicksight:SessionName. CLI Sample: aws quicksight register-user -\-aws-account-id=111122223333 -\-namespace=default -\-email=pat@example.com -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat
*/
registerUser(callback?: (err: AWSError, data: QuickSight.Types.RegisterUserResponse) => void): Request<QuickSight.Types.RegisterUserResponse, AWSError>;
/**
* Changes a group description. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . The response is a group object. CLI Sample: aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description="Sales BI Dashboards"
*/
updateGroup(params: QuickSight.Types.UpdateGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateGroupResponse) => void): Request<QuickSight.Types.UpdateGroupResponse, AWSError>;
/**
* Changes a group description. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . The response is a group object. CLI Sample: aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description="Sales BI Dashboards"
*/
updateGroup(callback?: (err: AWSError, data: QuickSight.Types.UpdateGroupResponse) => void): Request<QuickSight.Types.UpdateGroupResponse, AWSError>;
/**
* Updates an Amazon QuickSight user. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN). CLI Sample: aws quicksight update-user --user-name=Pat --role=ADMIN --email=new_address@amazon.com --aws-account-id=111122223333 --namespace=default --region=us-east-1
*/
updateUser(params: QuickSight.Types.UpdateUserRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateUserResponse) => void): Request<QuickSight.Types.UpdateUserResponse, AWSError>;
/**
* Updates an Amazon QuickSight user. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN). CLI Sample: aws quicksight update-user --user-name=Pat --role=ADMIN --email=new_address@amazon.com --aws-account-id=111122223333 --namespace=default --region=us-east-1
*/
updateUser(callback?: (err: AWSError, data: QuickSight.Types.UpdateUserResponse) => void): Request<QuickSight.Types.UpdateUserResponse, AWSError>;
}
declare namespace QuickSight {
export type Arn = string;
export type AwsAccountId = string;
export type Boolean = boolean;
export interface CreateGroupMembershipRequest {
/**
* The name of the user that you want to add to the group membership.
*/
MemberName: GroupMemberName;
/**
* The name of the group that you want to add the user to.
*/
GroupName: GroupName;
/**
* The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface CreateGroupMembershipResponse {
/**
* The group member.
*/
GroupMember?: GroupMember;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The http status of the request.
*/
Status?: StatusCode;
}
export interface CreateGroupRequest {
/**
* A name for the group that you want to create.
*/
GroupName: GroupName;
/**
* A description for the group that you want to create.
*/
Description?: GroupDescription;
/**
* The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface CreateGroupResponse {
/**
* The name of the group.
*/
Group?: Group;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The http status of the request.
*/
Status?: StatusCode;
}
export interface DeleteGroupMembershipRequest {
/**
* The name of the user that you want to delete from the group membership.
*/
MemberName: GroupMemberName;
/**
* The name of the group that you want to delete the user from.
*/
GroupName: GroupName;
/**
* The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface DeleteGroupMembershipResponse {
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The http status of the request.
*/
Status?: StatusCode;
}
export interface DeleteGroupRequest {
/**
* The name of the group that you want to delete.
*/
GroupName: GroupName;
/**
* The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface DeleteGroupResponse {
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The http status of the request.
*/
Status?: StatusCode;
}
export interface DeleteUserByPrincipalIdRequest {
/**
* The principal ID of the user.
*/
PrincipalId: String;
/**
* The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface DeleteUserByPrincipalIdResponse {
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The http status of the request.
*/
Status?: StatusCode;
}
export interface DeleteUserRequest {
/**
* The name of the user that you want to delete.
*/
UserName: UserName;
/**
* The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface DeleteUserResponse {
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The http status of the request.
*/
Status?: StatusCode;
}
export interface DescribeGroupRequest {
/**
* The name of the group that you want to describe.
*/
GroupName: GroupName;
/**
* The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface DescribeGroupResponse {
/**
* The name of the group.
*/
Group?: Group;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The http status of the request.
*/
Status?: StatusCode;
}
export interface DescribeUserRequest {
/**
* The name of the user that you want to describe.
*/
UserName: UserName;
/**
* The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface DescribeUserResponse {
/**
* The user name.
*/
User?: User;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The http status of the request.
*/
Status?: StatusCode;
}
export type EmbeddingUrl = string;
export interface GetDashboardEmbedUrlRequest {
/**
* AWS account ID that contains the dashboard you are embedding.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the dashboard, also added to IAM policy
*/
DashboardId: String;
/**
* The authentication method the user uses to sign in (IAM only).
*/
IdentityType: IdentityType;
/**
* How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.
*/
SessionLifetimeInMinutes?: SessionLifetimeInMinutes;
/**
* Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo button.
*/
UndoRedoDisabled?: boolean;
/**
* Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.
*/
ResetDisabled?: boolean;
/**
* The Amazon QuickSight user's ARN, for use with QUICKSIGHT identity type. You can use this for any of the following: Amazon QuickSight users in your account (readers, authors, or admins) AD users Invited non-federated users Federated IAM users Federated IAM role-based sessions
*/
UserArn?: Arn;
}
export interface GetDashboardEmbedUrlResponse {
/**
* URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes, and the resulting session is valid for 10 hours. The API provides the URL with an auth_code that enables a single-signon session.
*/
EmbedUrl?: EmbeddingUrl;
/**
* The http status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface Group {
/**
* The Amazon Resource Name (ARN) for the group.
*/
Arn?: Arn;
/**
* The name of the group.
*/
GroupName?: GroupName;
/**
* The group description.
*/
Description?: GroupDescription;
/**
* The principal ID of the group.
*/
PrincipalId?: String;
}
export type GroupDescription = string;
export type GroupList = Group[];
export interface GroupMember {
/**
* The Amazon Resource Name (ARN) for the group member (user).
*/
Arn?: Arn;
/**
* The name of the group member (user).
*/
MemberName?: GroupMemberName;
}
export type GroupMemberList = GroupMember[];
export type GroupMemberName = string;
export type GroupName = string;
export type IdentityType = "IAM"|"QUICKSIGHT"|string;
export interface ListGroupMembershipsRequest {
/**
* The name of the group that you want to see a membership list of.
*/
GroupName: GroupName;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The maximum number of results to return from this request.
*/
MaxResults?: MaxResults;
/**
* The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface ListGroupMembershipsResponse {
/**
* The list of the members of the group.
*/
GroupMemberList?: GroupMemberList;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The http status of the request.
*/
Status?: StatusCode;
}
export interface ListGroupsRequest {
/**
* The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The maximum number of results to return.
*/
MaxResults?: MaxResults;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface ListGroupsResponse {
/**
* The list of the groups.
*/
GroupList?: GroupList;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The http status of the request.
*/
Status?: StatusCode;
}
export interface ListUserGroupsRequest {
/**
* The Amazon QuickSight user name that you want to list group memberships for.
*/
UserName: UserName;
/**
* The AWS Account ID that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The maximum number of results to return from this request.
*/
MaxResults?: MaxResults;
}
export interface ListUserGroupsResponse {
/**
* The list of groups the user is a member of.
*/
GroupList?: GroupList;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface ListUsersRequest {
/**
* The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The maximum number of results to return from this request.
*/
MaxResults?: MaxResults;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface ListUsersResponse {
/**
* The list of users.
*/
UserList?: UserList;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The http status of the request.
*/
Status?: StatusCode;
}
export type MaxResults = number;
export type Namespace = string;
export interface RegisterUserRequest {
/**
* Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values: IAM: A user whose identity maps to an existing IAM user or role. QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.
*/
IdentityType: IdentityType;
/**
* The email address of the user that you want to register.
*/
Email: String;
/**
* The Amazon QuickSight role of the user. The user role can be one of the following: READER: A user who has read-only access to dashboards. AUTHOR: A user who can create data sources, data sets, analyses, and dashboards. ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
*/
UserRole: UserRole;
/**
* The ARN of the IAM user or role that you are registering with Amazon QuickSight.
*/
IamArn?: String;
/**
* You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the AWS CLI Reference.
*/
SessionName?: RoleSessionName;
/**
* The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
/**
* The Amazon QuickSight user name that you want to create for the user you are registering.
*/
UserName?: UserName;
}
export interface RegisterUserResponse {
/**
* The user name.
*/
User?: User;
/**
* The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT.
*/
UserInvitationUrl?: String;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The http status of the request.
*/
Status?: StatusCode;
}
export type RoleSessionName = string;
export type SessionLifetimeInMinutes = number;
export type StatusCode = number;
export type String = string;
export interface UpdateGroupRequest {
/**
* The name of the group that you want to update.
*/
GroupName: GroupName;
/**
* The description for the group that you want to update.
*/
Description?: GroupDescription;
/**
* The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface UpdateGroupResponse {
/**
* The name of the group.
*/
Group?: Group;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The http status of the request.
*/
Status?: StatusCode;
}
export interface UpdateUserRequest {
/**
* The Amazon QuickSight user name that you want to update.
*/
UserName: UserName;
/**
* The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
/**
* The email address of the user that you want to update.
*/
Email: String;
/**
* The Amazon QuickSight role of the user. The user role can be one of the following: READER: A user who has read-only access to dashboards. AUTHOR: A user who can create data sources, data sets, analyses, and dashboards. ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
*/
Role: UserRole;
}
export interface UpdateUserResponse {
/**
* The Amazon QuickSight user.
*/
User?: User;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The http status of the request.
*/
Status?: StatusCode;
}
export interface User {
/**
* The Amazon Resource Name (ARN) for the user.
*/
Arn?: Arn;
/**
* The user's user name.
*/
UserName?: UserName;
/**
* The user's email address.
*/
Email?: String;
/**
* The Amazon QuickSight role for the user.
*/
Role?: UserRole;
/**
* The type of identity authentication used by the user.
*/
IdentityType?: IdentityType;
/**
* Active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an AD user, that user is inactive until they sign in and provide a password
*/
Active?: Boolean;
/**
* The principal ID of the user.
*/
PrincipalId?: String;
}
export type UserList = User[];
export type UserName = string;
export type UserRole = "ADMIN"|"AUTHOR"|"READER"|"RESTRICTED_AUTHOR"|"RESTRICTED_READER"|string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2018-04-01"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the QuickSight client.
*/
export import Types = QuickSight;
}
export = QuickSight;