@aws-sdk/client-quicksight 3.42.0 → 3.43.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.
Files changed (28) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist-cjs/models/models_0.js +21 -18
  3. package/dist-cjs/models/models_1.js +17 -3
  4. package/dist-cjs/protocols/Aws_restJson1.js +80 -0
  5. package/dist-es/models/models_0.js +13 -12
  6. package/dist-es/models/models_1.js +12 -0
  7. package/dist-es/protocols/Aws_restJson1.js +189 -115
  8. package/dist-types/QuickSight.d.ts +40 -33
  9. package/dist-types/commands/CreateAccountCustomizationCommand.d.ts +7 -5
  10. package/dist-types/commands/CreateDashboardCommand.d.ts +5 -3
  11. package/dist-types/commands/CreateIAMPolicyAssignmentCommand.d.ts +1 -1
  12. package/dist-types/commands/DeleteIAMPolicyAssignmentCommand.d.ts +1 -1
  13. package/dist-types/commands/DescribeAccountCustomizationCommand.d.ts +4 -4
  14. package/dist-types/commands/DescribeIAMPolicyAssignmentCommand.d.ts +1 -1
  15. package/dist-types/commands/DescribeIpRestrictionCommand.d.ts +1 -1
  16. package/dist-types/commands/GetSessionEmbedUrlCommand.d.ts +4 -3
  17. package/dist-types/commands/ListIAMPolicyAssignmentsCommand.d.ts +1 -1
  18. package/dist-types/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +1 -1
  19. package/dist-types/commands/RegisterUserCommand.d.ts +1 -2
  20. package/dist-types/commands/TagResourceCommand.d.ts +8 -7
  21. package/dist-types/commands/UpdateDashboardCommand.d.ts +3 -1
  22. package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
  23. package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +1 -1
  24. package/dist-types/models/models_0.d.ts +189 -176
  25. package/dist-types/models/models_1.d.ts +213 -83
  26. package/dist-types/ts3.4/models/models_0.d.ts +78 -37
  27. package/dist-types/ts3.4/models/models_1.d.ts +43 -1
  28. package/package.json +2 -2
@@ -1,5 +1,109 @@
1
1
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
- import { _Parameters, AccountCustomization, ActiveIAMPolicyAssignment, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssignmentStatus, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSearchFilter, DashboardSourceEntity, DashboardSummary, DashboardVersionSummary, DataSetImportMode, DataSetSummary, DataSetUsageConfiguration, DataSource, DataSourceCredentials, DataSourceParameters, FieldFolder, FilterOperator, FolderType, Group, GroupMember, IdentityType, Ingestion, LogicalTable, NamespaceInfoV2, PhysicalTable, ResourcePermission, ResourceStatus, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SslProperties, Tag, TemplateAlias, TemplateSourceEntity, ThemeAlias, ThemeConfiguration, ThemeType, User, UserRole, VpcConnectionProperties } from "./models_0";
2
+ import { _Parameters, AccountCustomization, ActiveIAMPolicyAssignment, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssignmentStatus, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSearchFilter, DashboardSourceEntity, DashboardSummary, DashboardVersionSummary, DataSetImportMode, DataSetSummary, DataSetUsageConfiguration, DataSource, DataSourceCredentials, DataSourceParameters, FieldFolder, FilterOperator, FolderType, Group, GroupMember, IdentityType, Ingestion, LinkSharingConfiguration, LogicalTable, NamespaceInfoV2, PhysicalTable, ResourcePermission, ResourceStatus, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SslProperties, Tag, TemplateAlias, TemplateSourceEntity, ThemeAlias, ThemeConfiguration, ThemeType, VpcConnectionProperties } from "./models_0";
3
+ export declare enum UserRole {
4
+ ADMIN = "ADMIN",
5
+ AUTHOR = "AUTHOR",
6
+ READER = "READER",
7
+ RESTRICTED_AUTHOR = "RESTRICTED_AUTHOR",
8
+ RESTRICTED_READER = "RESTRICTED_READER"
9
+ }
10
+ /**
11
+ * <p>A registered user of Amazon QuickSight. </p>
12
+ */
13
+ export interface User {
14
+ /**
15
+ * <p>The Amazon Resource Name (ARN) for the user.</p>
16
+ */
17
+ Arn?: string;
18
+ /**
19
+ * <p>The user's user name. In the output, the value for <code>UserName</code> is
20
+ * <code>N/A</code> when the value for <code>IdentityType</code> is <code>IAM</code>
21
+ * and the corresponding IAM user is deleted.</p>
22
+ */
23
+ UserName?: string;
24
+ /**
25
+ * <p>The user's email address.</p>
26
+ */
27
+ Email?: string;
28
+ /**
29
+ * <p>The Amazon QuickSight role for the user. The user role can be one of the
30
+ * following:.</p>
31
+ * <ul>
32
+ * <li>
33
+ * <p>
34
+ * <code>READER</code>: A user who has read-only access to dashboards.</p>
35
+ * </li>
36
+ * <li>
37
+ * <p>
38
+ * <code>AUTHOR</code>: A user who can create data sources, datasets, analyses,
39
+ * and dashboards.</p>
40
+ * </li>
41
+ * <li>
42
+ * <p>
43
+ * <code>ADMIN</code>: A user who is an author, who can also manage Amazon
44
+ * Amazon QuickSight settings.</p>
45
+ * </li>
46
+ * <li>
47
+ * <p>
48
+ * <code>RESTRICTED_READER</code>: This role isn't currently available for
49
+ * use.</p>
50
+ * </li>
51
+ * <li>
52
+ * <p>
53
+ * <code>RESTRICTED_AUTHOR</code>: This role isn't currently available for
54
+ * use.</p>
55
+ * </li>
56
+ * </ul>
57
+ */
58
+ Role?: UserRole | string;
59
+ /**
60
+ * <p>The type of identity authentication used by the user.</p>
61
+ */
62
+ IdentityType?: IdentityType | string;
63
+ /**
64
+ * <p>The active status of user. When you create an Amazon QuickSight user that’s not an IAM
65
+ * user or an Active Directory user, that user is inactive until they sign in and provide a
66
+ * password.</p>
67
+ */
68
+ Active?: boolean;
69
+ /**
70
+ * <p>The principal ID of the user.</p>
71
+ */
72
+ PrincipalId?: string;
73
+ /**
74
+ * <p>The custom permissions profile associated with this user.</p>
75
+ */
76
+ CustomPermissionsName?: string;
77
+ /**
78
+ * <p>The type of supported external login provider that provides identity to let the user
79
+ * federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.</p>
80
+ * <ul>
81
+ * <li>
82
+ * <p>
83
+ * <code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.</p>
84
+ * </li>
85
+ * <li>
86
+ * <p>
87
+ * <code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider.</p>
88
+ * </li>
89
+ * </ul>
90
+ */
91
+ ExternalLoginFederationProviderType?: string;
92
+ /**
93
+ * <p>The URL of the external login provider.</p>
94
+ */
95
+ ExternalLoginFederationProviderUrl?: string;
96
+ /**
97
+ * <p>The identity ID for the user in the external login provider.</p>
98
+ */
99
+ ExternalLoginId?: string;
100
+ }
101
+ export declare namespace User {
102
+ /**
103
+ * @internal
104
+ */
105
+ const filterSensitiveLog: (obj: User) => any;
106
+ }
3
107
  export interface DescribeUserResponse {
4
108
  /**
5
109
  * <p>The user name.</p>
@@ -48,7 +152,7 @@ export declare enum FolderFilterAttribute {
48
152
  PARENT_FOLDER_ARN = "PARENT_FOLDER_ARN"
49
153
  }
50
154
  /**
51
- * <p>An object that consists of the member Amazon Resource Name (ARN) and member ID.</p>
155
+ * <p>An object that consists of a member Amazon Resource Name (ARN) and a member ID.</p>
52
156
  */
53
157
  export interface MemberIdArnPair {
54
158
  /**
@@ -67,15 +171,15 @@ export declare namespace MemberIdArnPair {
67
171
  const filterSensitiveLog: (obj: MemberIdArnPair) => any;
68
172
  }
69
173
  /**
70
- * <p>Searches a folder by a filter.</p>
174
+ * <p>A filter to use to search a Amazon QuickSight folder.</p>
71
175
  */
72
176
  export interface FolderSearchFilter {
73
177
  /**
74
- * <p>The comparison operator that you want to use as a filter. For example, <code>"Operator": "StringEquals"</code>.</p>
178
+ * <p>The comparison operator that you want to use in the filter. For example, <code>"Operator": "StringEquals"</code>.</p>
75
179
  */
76
180
  Operator?: FilterOperator | string;
77
181
  /**
78
- * <p>The name of the value that you want to use as a filter. For example, <code>"Name": "PARENT_FOLDER_ARN"</code>.</p>
182
+ * <p>The name of a value that you want to use in the filter. For example, <code>"Name": "PARENT_FOLDER_ARN"</code>.</p>
79
183
  */
80
184
  Name?: FolderFilterAttribute | string;
81
185
  /**
@@ -90,15 +194,15 @@ export declare namespace FolderSearchFilter {
90
194
  const filterSensitiveLog: (obj: FolderSearchFilter) => any;
91
195
  }
92
196
  /**
93
- * <p>A summary of the folder. </p>
197
+ * <p>A summary of information about an existing Amazon QuickSight folder. </p>
94
198
  */
95
199
  export interface FolderSummary {
96
200
  /**
97
- * <p>The Amazon Resource Name (ARN).</p>
201
+ * <p>The Amazon Resource Name (ARN) of the folder.</p>
98
202
  */
99
203
  Arn?: string;
100
204
  /**
101
- * <p>The folder ID.</p>
205
+ * <p>The ID of the folder.</p>
102
206
  */
103
207
  FolderId?: string;
104
208
  /**
@@ -219,10 +323,12 @@ export declare namespace SessionLifetimeInMinutesInvalidException {
219
323
  /**
220
324
  * <p>This error indicates that you are calling an embedding operation in Amazon QuickSight
221
325
  * without the required pricing plan on your Amazon Web Services account. Before you can use embedding
222
- * for anonymous users, a Amazon QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You
326
+ * for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You
223
327
  * can do this on the <b>Manage Amazon QuickSight</b> page. </p>
224
328
  * <p>After capacity pricing is added, you can use the
225
- * <a>GetDashboardEmbedUrl</a> API operation with the
329
+ * <code>
330
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetDashboardEmbedUrl.html">GetDashboardEmbedUrl</a>
331
+ * </code> API operation with the
226
332
  * <code>--identity-type ANONYMOUS</code> option.</p>
227
333
  */
228
334
  export interface UnsupportedPricingPlanException extends __SmithyException, $MetadataBearer {
@@ -261,8 +367,12 @@ export declare namespace RegisteredUserDashboardEmbeddingConfiguration {
261
367
  */
262
368
  export interface RegisteredUserQSearchBarEmbeddingConfiguration {
263
369
  /**
264
- * <p>The ID of the Q topic that you want to make the starting topic in the Q search bar. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening a topic. The ID is in the URL for the topic that you open.</p>
265
- * <p>If you don't specify an initial topic, a list of all shared topics is shown in the Q bar for your readers. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the available ones in the list.</p>
370
+ * <p>The ID of the Q topic that you want to make the starting topic in the Q search bar.
371
+ * You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening
372
+ * a topic. The ID is in the URL for the topic that you open.</p>
373
+ * <p>If you don't specify an initial topic, a list of all shared topics is shown in the Q bar
374
+ * for your readers. When you select an initial topic, you can specify whether or not readers
375
+ * are allowed to select other topics from the available ones in the list.</p>
266
376
  */
267
377
  InitialTopicId?: string;
268
378
  }
@@ -319,9 +429,11 @@ export declare namespace RegisteredUserQuickSightConsoleEmbeddingConfiguration {
319
429
  const filterSensitiveLog: (obj: RegisteredUserQuickSightConsoleEmbeddingConfiguration) => any;
320
430
  }
321
431
  /**
322
- * <p>The type of experience you want to embed. For registered users, you can embed an Amazon QuickSight dashboard or the Amazon QuickSight console.</p>
432
+ * <p>The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.</p>
323
433
  * <note>
324
- * <p>Exactly one of the experience configurations is required. You can choose <code>Dashboard</code> or <code>QuickSightConsole</code>. You cannot choose more than one experience configuraton.</p>
434
+ * <p>Exactly one of the experience configurations is required. You can choose
435
+ * <code>Dashboard</code> or <code>QuickSightConsole</code>. You cannot choose more
436
+ * than one experience configuration.</p>
325
437
  * </note>
326
438
  */
327
439
  export interface RegisteredUserEmbeddingExperienceConfiguration {
@@ -330,17 +442,20 @@ export interface RegisteredUserEmbeddingExperienceConfiguration {
330
442
  */
331
443
  Dashboard?: RegisteredUserDashboardEmbeddingConfiguration;
332
444
  /**
333
- * <p>The configuration details for providing an Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html">Customizing Access to the Amazon QuickSight Console</a> in the <i>Amazon QuickSight User
445
+ * <p>The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html">Customizing Access to the Amazon QuickSight Console</a> in the <i>Amazon QuickSight User
334
446
  * Guide</i>.</p>
335
- * <p>Use <code>GenerateEmbedUrlForRegisteredUser</code> where
447
+ * <p>Use <code>
448
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html">GenerateEmbedUrlForRegisteredUser</a>
449
+ * </code>
450
+ * where
336
451
  * you want to provide an authoring portal that allows users to create data sources,
337
452
  * datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console
338
453
  * needs to belong to the author or admin security cohort. If you want to restrict permissions
339
454
  * to some of these features, add a custom permissions profile to the user with the
340
455
  * <code>
341
- * <a>UpdateUser</a>
342
- * </code> API operation. Use <code>
343
- * <a>RegisterUser</a>
456
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a>
457
+ * </code> API operation. Use the <code>
458
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html">RegisterUser</a>
344
459
  * </code> API operation to add a new user with a custom permission profile attached. For more
345
460
  * information, see the following sections in the <i>Amazon QuickSight User
346
461
  * Guide</i>:</p>
@@ -361,7 +476,8 @@ export interface RegisteredUserEmbeddingExperienceConfiguration {
361
476
  QuickSightConsole?: RegisteredUserQuickSightConsoleEmbeddingConfiguration;
362
477
  /**
363
478
  * <p>The configuration details for embedding the Q search bar.</p>
364
- * <p>For more information about embedding the Q search bar, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html">Embedding Overview</a>.</p>
479
+ * <p>For more information about embedding the Q search bar, see
480
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html">Embedding Overview</a>.</p>
365
481
  */
366
482
  QSearchBar?: RegisteredUserQSearchBarEmbeddingConfiguration;
367
483
  }
@@ -385,7 +501,7 @@ export interface GenerateEmbedUrlForRegisteredUserRequest {
385
501
  */
386
502
  UserArn: string | undefined;
387
503
  /**
388
- * <p>The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, the entire Amazon QuickSight console, or the Amazon QuickSight Q search bar.</p>
504
+ * <p>The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards or the entire Amazon QuickSight console.</p>
389
505
  */
390
506
  ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfiguration | undefined;
391
507
  }
@@ -397,7 +513,7 @@ export declare namespace GenerateEmbedUrlForRegisteredUserRequest {
397
513
  }
398
514
  export interface GenerateEmbedUrlForRegisteredUserResponse {
399
515
  /**
400
- * <p>The embed URL for the Amazon QuickSight dashboard, console, or Q search bar.</p>
516
+ * <p>The embed URL for the Amazon QuickSight dashboard or console.</p>
401
517
  */
402
518
  EmbedUrl: string | undefined;
403
519
  /**
@@ -485,11 +601,11 @@ export interface GetDashboardEmbedUrlRequest {
485
601
  * <p>Invited nonfederated users</p>
486
602
  * </li>
487
603
  * <li>
488
- * <p>IAMusers and IAMrole-based sessions authenticated through Federated Single Sign-On using
489
- * SAML, OpenID Connect, or IAMfederation.</p>
604
+ * <p>IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using
605
+ * SAML, OpenID Connect, or IAM federation.</p>
490
606
  * </li>
491
607
  * </ul>
492
- * <p>Omit this parameter for users in the third group – IAMusers and IAM
608
+ * <p>Omit this parameter for users in the third group – IAM users and IAM
493
609
  * role-based sessions.</p>
494
610
  */
495
611
  UserArn?: string;
@@ -502,7 +618,7 @@ export interface GetDashboardEmbedUrlRequest {
502
618
  * <p>A list of one or more dashboard IDs that you want to add to a session that includes
503
619
  * anonymous users. The <code>IdentityType</code> parameter must be set to
504
620
  * <code>ANONYMOUS</code> for this to work, because other identity types authenticate
505
- * as Amazon QuickSight or IAMusers. For example, if you set "<code>--dashboard-id dash_id1
621
+ * as Amazon QuickSight or IAM users. For example, if you set "<code>--dashboard-id dash_id1
506
622
  * --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the session
507
623
  * can access all three dashboards. </p>
508
624
  */
@@ -657,7 +773,7 @@ export declare namespace GetSessionEmbedUrlResponse {
657
773
  const filterSensitiveLog: (obj: GetSessionEmbedUrlResponse) => any;
658
774
  }
659
775
  /**
660
- * <p>IAMpolicy assignment summary.</p>
776
+ * <p>IAM policy assignment summary.</p>
661
777
  */
662
778
  export interface IAMPolicyAssignmentSummary {
663
779
  /**
@@ -904,11 +1020,11 @@ export declare namespace ListDataSourcesResponse {
904
1020
  }
905
1021
  export interface ListFolderMembersRequest {
906
1022
  /**
907
- * <p>The AWS account ID.</p>
1023
+ * <p>The ID for the Amazon Web Services account that contains the folder.</p>
908
1024
  */
909
1025
  AwsAccountId: string | undefined;
910
1026
  /**
911
- * <p>The folder ID.</p>
1027
+ * <p>The ID of the folder.</p>
912
1028
  */
913
1029
  FolderId: string | undefined;
914
1030
  /**
@@ -928,8 +1044,7 @@ export declare namespace ListFolderMembersRequest {
928
1044
  }
929
1045
  export interface ListFolderMembersResponse {
930
1046
  /**
931
- * <p>The status. If succeeded, the status is <code>SC_OK</code>
932
- * </p>
1047
+ * <p>The HTTP status of the request.</p>
933
1048
  */
934
1049
  Status?: number;
935
1050
  /**
@@ -941,7 +1056,7 @@ export interface ListFolderMembersResponse {
941
1056
  */
942
1057
  NextToken?: string;
943
1058
  /**
944
- * <p>The request ID.</p>
1059
+ * <p>The Amazon Web Services request ID for this operation.</p>
945
1060
  */
946
1061
  RequestId?: string;
947
1062
  }
@@ -953,7 +1068,7 @@ export declare namespace ListFolderMembersResponse {
953
1068
  }
954
1069
  export interface ListFoldersRequest {
955
1070
  /**
956
- * <p>The AWS account ID.</p>
1071
+ * <p>The ID for the Amazon Web Services account that contains the folder.</p>
957
1072
  */
958
1073
  AwsAccountId: string | undefined;
959
1074
  /**
@@ -973,12 +1088,11 @@ export declare namespace ListFoldersRequest {
973
1088
  }
974
1089
  export interface ListFoldersResponse {
975
1090
  /**
976
- * <p>The status. If succeeded, the status is <code>SC_OK</code>
977
- * </p>
1091
+ * <p>The HTTP status of the request.</p>
978
1092
  */
979
1093
  Status?: number;
980
1094
  /**
981
- * <p>A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.</p>
1095
+ * <p>A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.</p>
982
1096
  */
983
1097
  FolderSummaryList?: FolderSummary[];
984
1098
  /**
@@ -986,7 +1100,7 @@ export interface ListFoldersResponse {
986
1100
  */
987
1101
  NextToken?: string;
988
1102
  /**
989
- * <p>The request ID.</p>
1103
+ * <p>The Amazon Web Services request ID for this operation.</p>
990
1104
  */
991
1105
  RequestId?: string;
992
1106
  }
@@ -1100,7 +1214,7 @@ export declare namespace ListGroupsResponse {
1100
1214
  }
1101
1215
  export interface ListIAMPolicyAssignmentsRequest {
1102
1216
  /**
1103
- * <p>The ID of the Amazon Web Services account that contains these IAMpolicy assignments.</p>
1217
+ * <p>The ID of the Amazon Web Services account that contains these IAM policy assignments.</p>
1104
1218
  */
1105
1219
  AwsAccountId: string | undefined;
1106
1220
  /**
@@ -1128,7 +1242,7 @@ export declare namespace ListIAMPolicyAssignmentsRequest {
1128
1242
  }
1129
1243
  export interface ListIAMPolicyAssignmentsResponse {
1130
1244
  /**
1131
- * <p>Information describing the IAMpolicy assignments.</p>
1245
+ * <p>Information describing the IAM policy assignments.</p>
1132
1246
  */
1133
1247
  IAMPolicyAssignments?: IAMPolicyAssignmentSummary[];
1134
1248
  /**
@@ -1868,7 +1982,7 @@ export interface RegisterUserRequest {
1868
1982
  * <ul>
1869
1983
  * <li>
1870
1984
  * <p>
1871
- * <code>IAM</code>: A user whose identity maps to an existing IAMuser or role.
1985
+ * <code>IAM</code>: A user whose identity maps to an existing IAM user or role.
1872
1986
  * </p>
1873
1987
  * </li>
1874
1988
  * <li>
@@ -1915,17 +2029,17 @@ export interface RegisterUserRequest {
1915
2029
  */
1916
2030
  UserRole: UserRole | string | undefined;
1917
2031
  /**
1918
- * <p>The ARN of the IAMuser or role that you are registering with Amazon QuickSight. </p>
2032
+ * <p>The ARN of the IAM user or role that you are registering with Amazon QuickSight. </p>
1919
2033
  */
1920
2034
  IamArn?: string;
1921
2035
  /**
1922
2036
  * <p>You need to use this parameter only when you register one or more users using an assumed
1923
- * IAMrole. You don't need to provide the session name for other scenarios, for example when
1924
- * you are registering an IAMuser or an Amazon QuickSight user. You can register multiple
1925
- * users using the same IAMrole if each user has a different session name. For more
1926
- * information on assuming IAMroles, see <a href="https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html">
2037
+ * IAM role. You don't need to provide the session name for other scenarios, for example when
2038
+ * you are registering an IAM user or an Amazon QuickSight user. You can register multiple
2039
+ * users using the same IAM role if each user has a different session name. For more
2040
+ * information on assuming IAM roles, see <a href="https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html">
1927
2041
  * <code>assume-role</code>
1928
- * </a> in the <i>AWS CLI Reference.</i>
2042
+ * </a> in the <i>CLI Reference.</i>
1929
2043
  * </p>
1930
2044
  */
1931
2045
  SessionName?: string;
@@ -1962,13 +2076,13 @@ export interface RegisterUserRequest {
1962
2076
  * </li>
1963
2077
  * </ul>
1964
2078
  * <p>To add custom permissions to an existing user, use <code>
1965
- * <a>UpdateUser</a>
2079
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a>
1966
2080
  * </code> instead.</p>
1967
2081
  * <p>A set of custom permissions includes any combination of these restrictions. Currently,
1968
2082
  * you need to create the profile names for custom permission sets by using the Amazon QuickSight
1969
2083
  * console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of
1970
- * permissions to a Amazon QuickSight user. </p>
1971
- * <p>Amazon QuickSight custom permissions are applied through IAMpolicies. Therefore, they
2084
+ * permissions to a QuickSight user. </p>
2085
+ * <p>Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they
1972
2086
  * override the permissions typically granted by assigning Amazon QuickSight users to one of the
1973
2087
  * default security cohorts in Amazon QuickSight (admin, author, reader).</p>
1974
2088
  * <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>
@@ -2176,7 +2290,7 @@ export declare namespace SearchDashboardsResponse {
2176
2290
  }
2177
2291
  export interface SearchFoldersRequest {
2178
2292
  /**
2179
- * <p>The AWS account ID.</p>
2293
+ * <p>The ID for the Amazon Web Services account that contains the folder.</p>
2180
2294
  */
2181
2295
  AwsAccountId: string | undefined;
2182
2296
  /**
@@ -2200,11 +2314,11 @@ export declare namespace SearchFoldersRequest {
2200
2314
  }
2201
2315
  export interface SearchFoldersResponse {
2202
2316
  /**
2203
- * <p>The status. If succeeded, the status is <code>SC_OK</code>.</p>
2317
+ * <p>The HTTP status of the request.</p>
2204
2318
  */
2205
2319
  Status?: number;
2206
2320
  /**
2207
- * <p>A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.</p>
2321
+ * <p>A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.</p>
2208
2322
  */
2209
2323
  FolderSummaryList?: FolderSummary[];
2210
2324
  /**
@@ -2212,7 +2326,7 @@ export interface SearchFoldersResponse {
2212
2326
  */
2213
2327
  NextToken?: string;
2214
2328
  /**
2215
- * <p>The request ID.</p>
2329
+ * <p>The Amazon Web Services request ID for this operation.</p>
2216
2330
  */
2217
2331
  RequestId?: string;
2218
2332
  }
@@ -2523,7 +2637,9 @@ export interface UpdateDashboardRequest {
2523
2637
  * <code>SourceEntity</code>, you specify the type of object you're using as source. You
2524
2638
  * can only update a dashboard from a template, so you use a <code>SourceTemplate</code>
2525
2639
  * entity. If you need to update a dashboard from an analysis, first convert the analysis
2526
- * to a template by using the <a>CreateTemplate</a> API operation. For
2640
+ * to a template by using the <code>
2641
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>
2642
+ * </code> API operation. For
2527
2643
  * <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source
2528
2644
  * template. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any
2529
2645
  * Amazon QuickSight-supported Amazon Web Services Region. </p>
@@ -2633,6 +2749,14 @@ export interface UpdateDashboardPermissionsRequest {
2633
2749
  * <p>The permissions that you want to revoke from this resource.</p>
2634
2750
  */
2635
2751
  RevokePermissions?: ResourcePermission[];
2752
+ /**
2753
+ * <p>Grants link permissions to all users in a defined namespace.</p>
2754
+ */
2755
+ GrantLinkPermissions?: ResourcePermission[];
2756
+ /**
2757
+ * <p>Revokes link permissions from all users in a defined namespace.</p>
2758
+ */
2759
+ RevokeLinkPermissions?: ResourcePermission[];
2636
2760
  }
2637
2761
  export declare namespace UpdateDashboardPermissionsRequest {
2638
2762
  /**
@@ -2661,6 +2785,10 @@ export interface UpdateDashboardPermissionsResponse {
2661
2785
  * <p>The HTTP status of the request.</p>
2662
2786
  */
2663
2787
  Status?: number;
2788
+ /**
2789
+ * <p>Updates the permissions of a shared link to an Amazon QuickSight dashboard.</p>
2790
+ */
2791
+ LinkSharingConfiguration?: LinkSharingConfiguration;
2664
2792
  }
2665
2793
  export declare namespace UpdateDashboardPermissionsResponse {
2666
2794
  /**
@@ -2763,7 +2891,7 @@ export interface UpdateDataSetRequest {
2763
2891
  RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration;
2764
2892
  /**
2765
2893
  * <p>A set of one or more definitions of a <code>
2766
- * <a>ColumnLevelPermissionRule</a>
2894
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html">ColumnLevelPermissionRule</a>
2767
2895
  * </code>.</p>
2768
2896
  */
2769
2897
  ColumnLevelPermissionRules?: ColumnLevelPermissionRule[];
@@ -2979,11 +3107,11 @@ export declare namespace UpdateDataSourcePermissionsResponse {
2979
3107
  }
2980
3108
  export interface UpdateFolderRequest {
2981
3109
  /**
2982
- * <p>The AWS account ID.</p>
3110
+ * <p>The ID for the Amazon Web Services account that contains the folder to update.</p>
2983
3111
  */
2984
3112
  AwsAccountId: string | undefined;
2985
3113
  /**
2986
- * <p>The folder ID.</p>
3114
+ * <p>The ID of the folder.</p>
2987
3115
  */
2988
3116
  FolderId: string | undefined;
2989
3117
  /**
@@ -2999,19 +3127,19 @@ export declare namespace UpdateFolderRequest {
2999
3127
  }
3000
3128
  export interface UpdateFolderResponse {
3001
3129
  /**
3002
- * <p>The status. If succeeded, the status is <code>SC_OK</code>.</p>
3130
+ * <p>The HTTP status of the request.</p>
3003
3131
  */
3004
3132
  Status?: number;
3005
3133
  /**
3006
- * <p>The Amazon Resource Name (ARN).</p>
3134
+ * <p>The Amazon Resource Name (ARN) of the folder.</p>
3007
3135
  */
3008
3136
  Arn?: string;
3009
3137
  /**
3010
- * <p>The folder ID.</p>
3138
+ * <p>The ID of the folder.</p>
3011
3139
  */
3012
3140
  FolderId?: string;
3013
3141
  /**
3014
- * <p>The request ID.</p>
3142
+ * <p>The Amazon Web Services request ID for this operation.</p>
3015
3143
  */
3016
3144
  RequestId?: string;
3017
3145
  }
@@ -3023,11 +3151,11 @@ export declare namespace UpdateFolderResponse {
3023
3151
  }
3024
3152
  export interface UpdateFolderPermissionsRequest {
3025
3153
  /**
3026
- * <p>The AWS account ID.</p>
3154
+ * <p>The ID for the Amazon Web Services account that contains the folder to update.</p>
3027
3155
  */
3028
3156
  AwsAccountId: string | undefined;
3029
3157
  /**
3030
- * <p>The folder ID.</p>
3158
+ * <p>The ID of the folder.</p>
3031
3159
  */
3032
3160
  FolderId: string | undefined;
3033
3161
  /**
@@ -3047,23 +3175,23 @@ export declare namespace UpdateFolderPermissionsRequest {
3047
3175
  }
3048
3176
  export interface UpdateFolderPermissionsResponse {
3049
3177
  /**
3050
- * <p>The status. If succeeded, the status is <code>SC_OK</code>.</p>
3178
+ * <p>The HTTP status of the request.</p>
3051
3179
  */
3052
3180
  Status?: number;
3053
3181
  /**
3054
- * <p>The Amazon Resource Name (ARN).</p>
3182
+ * <p>The Amazon Resource Name (ARN) of the folder.</p>
3055
3183
  */
3056
3184
  Arn?: string;
3057
3185
  /**
3058
- * <p>The folder ID.</p>
3186
+ * <p>The ID of the folder.</p>
3059
3187
  */
3060
3188
  FolderId?: string;
3061
3189
  /**
3062
- * <p>Information about the permissions on the dashboard.</p>
3190
+ * <p>Information about the permissions for the folder.</p>
3063
3191
  */
3064
3192
  Permissions?: ResourcePermission[];
3065
3193
  /**
3066
- * <p>The request ID.</p>
3194
+ * <p>The Amazon Web Services request ID for this operation.</p>
3067
3195
  */
3068
3196
  RequestId?: string;
3069
3197
  }
@@ -3120,7 +3248,7 @@ export declare namespace UpdateGroupResponse {
3120
3248
  }
3121
3249
  export interface UpdateIAMPolicyAssignmentRequest {
3122
3250
  /**
3123
- * <p>The ID of the Amazon Web Services account that contains the IAMpolicy assignment. </p>
3251
+ * <p>The ID of the Amazon Web Services account that contains the IAM policy assignment. </p>
3124
3252
  */
3125
3253
  AwsAccountId: string | undefined;
3126
3254
  /**
@@ -3152,7 +3280,7 @@ export interface UpdateIAMPolicyAssignmentRequest {
3152
3280
  */
3153
3281
  AssignmentStatus?: AssignmentStatus | string;
3154
3282
  /**
3155
- * <p>The ARN for the IAMpolicy to apply to the Amazon QuickSight users and groups
3283
+ * <p>The ARN for the IAM policy to apply to the Amazon QuickSight users and groups
3156
3284
  * specified in this assignment.</p>
3157
3285
  */
3158
3286
  PolicyArn?: string;
@@ -3179,12 +3307,12 @@ export interface UpdateIAMPolicyAssignmentResponse {
3179
3307
  */
3180
3308
  AssignmentId?: string;
3181
3309
  /**
3182
- * <p>The ARN for the IAMpolicy applied to the Amazon QuickSight users and groups specified in this
3310
+ * <p>The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this
3183
3311
  * assignment.</p>
3184
3312
  */
3185
3313
  PolicyArn?: string;
3186
3314
  /**
3187
- * <p>The Amazon QuickSight users, groups, or both that the IAMpolicy is assigned to.</p>
3315
+ * <p>The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.</p>
3188
3316
  */
3189
3317
  Identities?: {
3190
3318
  [key: string]: string[];
@@ -3226,17 +3354,17 @@ export declare namespace UpdateIAMPolicyAssignmentResponse {
3226
3354
  }
3227
3355
  export interface UpdateIpRestrictionRequest {
3228
3356
  /**
3229
- * <p>Your AWS account ID.</p>
3357
+ * <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
3230
3358
  */
3231
3359
  AwsAccountId: string | undefined;
3232
3360
  /**
3233
- * <p>Describes updated IP rules.</p>
3361
+ * <p>A map that describes the updated IP rules with CIDR ranges and descriptions.</p>
3234
3362
  */
3235
3363
  IpRestrictionRuleMap?: {
3236
3364
  [key: string]: string;
3237
3365
  };
3238
3366
  /**
3239
- * <p>Whether or not IP rules are enabled.</p>
3367
+ * <p>A value that specifies whether IP rules are turned on.</p>
3240
3368
  */
3241
3369
  Enabled?: boolean;
3242
3370
  }
@@ -3248,15 +3376,15 @@ export declare namespace UpdateIpRestrictionRequest {
3248
3376
  }
3249
3377
  export interface UpdateIpRestrictionResponse {
3250
3378
  /**
3251
- * <p>Your AWS account ID.</p>
3379
+ * <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
3252
3380
  */
3253
3381
  AwsAccountId?: string;
3254
3382
  /**
3255
- * <p>The ID of the update request.</p>
3383
+ * <p>The Amazon Web Services request ID for this operation.</p>
3256
3384
  */
3257
3385
  RequestId?: string;
3258
3386
  /**
3259
- * <p>The status of the updated IP rules. A successful request returns a 200 code.</p>
3387
+ * <p>The HTTP status of the request. </p>
3260
3388
  */
3261
3389
  Status?: number;
3262
3390
  }
@@ -3662,8 +3790,8 @@ export interface UpdateUserRequest {
3662
3790
  * <p>A set of custom permissions includes any combination of these restrictions. Currently,
3663
3791
  * you need to create the profile names for custom permission sets by using the Amazon QuickSight
3664
3792
  * console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of
3665
- * permissions to a Amazon QuickSight user. </p>
3666
- * <p>Amazon QuickSight custom permissions are applied through IAMpolicies. Therefore, they
3793
+ * permissions to a QuickSight user. </p>
3794
+ * <p>Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they
3667
3795
  * override the permissions typically granted by assigning Amazon QuickSight users to one of the
3668
3796
  * default security cohorts in Amazon QuickSight (admin, author, reader).</p>
3669
3797
  * <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>
@@ -3689,9 +3817,11 @@ export interface UpdateUserRequest {
3689
3817
  * </li>
3690
3818
  * <li>
3691
3819
  * <p>
3692
- * <code>NONE</code>: This clears all the previously saved external login information for a user. Use <code>
3693
- * <a>DescribeUser</a>
3694
- * </code> API to check the external login information.</p>
3820
+ * <code>NONE</code>: This clears all the previously saved external login information for a user. Use the
3821
+ * <code>
3822
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html">DescribeUser</a>
3823
+ * </code>
3824
+ * API operation to check the external login information.</p>
3695
3825
  * </li>
3696
3826
  * </ul>
3697
3827
  */