@aws-sdk/client-quicksight 3.321.1 → 3.326.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 (135) hide show
  1. package/dist-types/commands/CancelIngestionCommand.d.ts +9 -0
  2. package/dist-types/commands/CreateAccountCustomizationCommand.d.ts +14 -0
  3. package/dist-types/commands/CreateAccountSubscriptionCommand.d.ts +13 -0
  4. package/dist-types/commands/CreateAnalysisCommand.d.ts +10 -0
  5. package/dist-types/commands/CreateDashboardCommand.d.ts +11 -0
  6. package/dist-types/commands/CreateDataSetCommand.d.ts +11 -0
  7. package/dist-types/commands/CreateDataSourceCommand.d.ts +10 -0
  8. package/dist-types/commands/CreateFolderCommand.d.ts +9 -0
  9. package/dist-types/commands/CreateFolderMembershipCommand.d.ts +11 -0
  10. package/dist-types/commands/CreateGroupCommand.d.ts +13 -0
  11. package/dist-types/commands/CreateGroupMembershipCommand.d.ts +11 -0
  12. package/dist-types/commands/CreateIAMPolicyAssignmentCommand.d.ts +16 -0
  13. package/dist-types/commands/CreateIngestionCommand.d.ts +10 -0
  14. package/dist-types/commands/CreateNamespaceCommand.d.ts +12 -0
  15. package/dist-types/commands/CreateRefreshScheduleCommand.d.ts +9 -0
  16. package/dist-types/commands/CreateTemplateAliasCommand.d.ts +12 -0
  17. package/dist-types/commands/CreateTemplateCommand.d.ts +11 -0
  18. package/dist-types/commands/CreateThemeAliasCommand.d.ts +12 -0
  19. package/dist-types/commands/CreateThemeCommand.d.ts +11 -0
  20. package/dist-types/commands/DeleteAccountCustomizationCommand.d.ts +7 -0
  21. package/dist-types/commands/DeleteAccountSubscriptionCommand.d.ts +7 -0
  22. package/dist-types/commands/DeleteAnalysisCommand.d.ts +10 -0
  23. package/dist-types/commands/DeleteDashboardCommand.d.ts +9 -0
  24. package/dist-types/commands/DeleteDataSetCommand.d.ts +9 -0
  25. package/dist-types/commands/DeleteDataSetRefreshPropertiesCommand.d.ts +7 -0
  26. package/dist-types/commands/DeleteDataSourceCommand.d.ts +9 -0
  27. package/dist-types/commands/DeleteFolderCommand.d.ts +9 -0
  28. package/dist-types/commands/DeleteFolderMembershipCommand.d.ts +7 -0
  29. package/dist-types/commands/DeleteGroupCommand.d.ts +7 -0
  30. package/dist-types/commands/DeleteGroupMembershipCommand.d.ts +7 -0
  31. package/dist-types/commands/DeleteIAMPolicyAssignmentCommand.d.ts +8 -0
  32. package/dist-types/commands/DeleteNamespaceCommand.d.ts +7 -0
  33. package/dist-types/commands/DeleteRefreshScheduleCommand.d.ts +9 -0
  34. package/dist-types/commands/DeleteTemplateAliasCommand.d.ts +10 -0
  35. package/dist-types/commands/DeleteTemplateCommand.d.ts +9 -0
  36. package/dist-types/commands/DeleteThemeAliasCommand.d.ts +10 -0
  37. package/dist-types/commands/DeleteThemeCommand.d.ts +9 -0
  38. package/dist-types/commands/DeleteUserByPrincipalIdCommand.d.ts +7 -0
  39. package/dist-types/commands/DeleteUserCommand.d.ts +7 -0
  40. package/dist-types/commands/DescribeAccountCustomizationCommand.d.ts +14 -0
  41. package/dist-types/commands/DescribeAccountSettingsCommand.d.ts +15 -0
  42. package/dist-types/commands/DescribeAccountSubscriptionCommand.d.ts +14 -0
  43. package/dist-types/commands/DescribeAnalysisCommand.d.ts +36 -0
  44. package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +4239 -0
  45. package/dist-types/commands/DescribeAnalysisPermissionsCommand.d.ts +17 -0
  46. package/dist-types/commands/DescribeDashboardCommand.d.ts +44 -0
  47. package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +4276 -0
  48. package/dist-types/commands/DescribeDashboardPermissionsCommand.d.ts +27 -0
  49. package/dist-types/commands/DescribeDataSetCommand.d.ts +190 -0
  50. package/dist-types/commands/DescribeDataSetPermissionsCommand.d.ts +17 -0
  51. package/dist-types/commands/DescribeDataSetRefreshPropertiesCommand.d.ts +18 -0
  52. package/dist-types/commands/DescribeDataSourceCommand.d.ts +239 -0
  53. package/dist-types/commands/DescribeDataSourcePermissionsCommand.d.ts +17 -0
  54. package/dist-types/commands/DescribeFolderCommand.d.ts +18 -0
  55. package/dist-types/commands/DescribeFolderPermissionsCommand.d.ts +17 -0
  56. package/dist-types/commands/DescribeFolderResolvedPermissionsCommand.d.ts +17 -0
  57. package/dist-types/commands/DescribeGroupCommand.d.ts +13 -0
  58. package/dist-types/commands/DescribeGroupMembershipCommand.d.ts +11 -0
  59. package/dist-types/commands/DescribeIAMPolicyAssignmentCommand.d.ts +19 -0
  60. package/dist-types/commands/DescribeIngestionCommand.d.ts +30 -0
  61. package/dist-types/commands/DescribeIpRestrictionCommand.d.ts +12 -0
  62. package/dist-types/commands/DescribeNamespaceCommand.d.ts +18 -0
  63. package/dist-types/commands/DescribeRefreshScheduleCommand.d.ts +23 -0
  64. package/dist-types/commands/DescribeTemplateAliasCommand.d.ts +12 -0
  65. package/dist-types/commands/DescribeTemplateCommand.d.ts +63 -0
  66. package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +4257 -0
  67. package/dist-types/commands/DescribeTemplatePermissionsCommand.d.ts +17 -0
  68. package/dist-types/commands/DescribeThemeAliasCommand.d.ts +12 -0
  69. package/dist-types/commands/DescribeThemeCommand.d.ts +80 -0
  70. package/dist-types/commands/DescribeThemePermissionsCommand.d.ts +17 -0
  71. package/dist-types/commands/DescribeUserCommand.d.ts +20 -0
  72. package/dist-types/commands/GenerateEmbedUrlForAnonymousUserCommand.d.ts +9 -0
  73. package/dist-types/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +8 -0
  74. package/dist-types/commands/GetDashboardEmbedUrlCommand.d.ts +8 -0
  75. package/dist-types/commands/GetSessionEmbedUrlCommand.d.ts +8 -0
  76. package/dist-types/commands/ListAnalysesCommand.d.ts +18 -0
  77. package/dist-types/commands/ListDashboardVersionsCommand.d.ts +18 -0
  78. package/dist-types/commands/ListDashboardsCommand.d.ts +19 -0
  79. package/dist-types/commands/ListDataSetsCommand.d.ts +27 -0
  80. package/dist-types/commands/ListDataSourcesCommand.d.ts +242 -0
  81. package/dist-types/commands/ListFolderMembersCommand.d.ts +14 -0
  82. package/dist-types/commands/ListFoldersCommand.d.ts +18 -0
  83. package/dist-types/commands/ListGroupMembershipsCommand.d.ts +14 -0
  84. package/dist-types/commands/ListGroupsCommand.d.ts +16 -0
  85. package/dist-types/commands/ListIAMPolicyAssignmentsCommand.d.ts +14 -0
  86. package/dist-types/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +14 -0
  87. package/dist-types/commands/ListIngestionsCommand.d.ts +33 -0
  88. package/dist-types/commands/ListNamespacesCommand.d.ts +21 -0
  89. package/dist-types/commands/ListRefreshSchedulesCommand.d.ts +24 -0
  90. package/dist-types/commands/ListTagsForResourceCommand.d.ts +13 -0
  91. package/dist-types/commands/ListTemplateAliasesCommand.d.ts +15 -0
  92. package/dist-types/commands/ListTemplateVersionsCommand.d.ts +17 -0
  93. package/dist-types/commands/ListTemplatesCommand.d.ts +18 -0
  94. package/dist-types/commands/ListThemeAliasesCommand.d.ts +15 -0
  95. package/dist-types/commands/ListThemeVersionsCommand.d.ts +17 -0
  96. package/dist-types/commands/ListThemesCommand.d.ts +18 -0
  97. package/dist-types/commands/ListUserGroupsCommand.d.ts +16 -0
  98. package/dist-types/commands/ListUsersCommand.d.ts +23 -0
  99. package/dist-types/commands/PutDataSetRefreshPropertiesCommand.d.ts +7 -0
  100. package/dist-types/commands/RegisterUserCommand.d.ts +21 -0
  101. package/dist-types/commands/RestoreAnalysisCommand.d.ts +9 -0
  102. package/dist-types/commands/SearchAnalysesCommand.d.ts +18 -0
  103. package/dist-types/commands/SearchDashboardsCommand.d.ts +19 -0
  104. package/dist-types/commands/SearchDataSetsCommand.d.ts +27 -0
  105. package/dist-types/commands/SearchDataSourcesCommand.d.ts +18 -0
  106. package/dist-types/commands/SearchFoldersCommand.d.ts +18 -0
  107. package/dist-types/commands/SearchGroupsCommand.d.ts +16 -0
  108. package/dist-types/commands/TagResourceCommand.d.ts +7 -0
  109. package/dist-types/commands/UntagResourceCommand.d.ts +7 -0
  110. package/dist-types/commands/UpdateAccountCustomizationCommand.d.ts +14 -0
  111. package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +7 -0
  112. package/dist-types/commands/UpdateAnalysisCommand.d.ts +10 -0
  113. package/dist-types/commands/UpdateAnalysisPermissionsCommand.d.ts +17 -0
  114. package/dist-types/commands/UpdateDashboardCommand.d.ts +11 -0
  115. package/dist-types/commands/UpdateDashboardPermissionsCommand.d.ts +27 -0
  116. package/dist-types/commands/UpdateDashboardPublishedVersionCommand.d.ts +9 -0
  117. package/dist-types/commands/UpdateDataSetCommand.d.ts +11 -0
  118. package/dist-types/commands/UpdateDataSetPermissionsCommand.d.ts +9 -0
  119. package/dist-types/commands/UpdateDataSourceCommand.d.ts +10 -0
  120. package/dist-types/commands/UpdateDataSourcePermissionsCommand.d.ts +9 -0
  121. package/dist-types/commands/UpdateFolderCommand.d.ts +9 -0
  122. package/dist-types/commands/UpdateFolderPermissionsCommand.d.ts +17 -0
  123. package/dist-types/commands/UpdateGroupCommand.d.ts +13 -0
  124. package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +16 -0
  125. package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +8 -0
  126. package/dist-types/commands/UpdatePublicSharingSettingsCommand.d.ts +7 -0
  127. package/dist-types/commands/UpdateRefreshScheduleCommand.d.ts +9 -0
  128. package/dist-types/commands/UpdateTemplateAliasCommand.d.ts +12 -0
  129. package/dist-types/commands/UpdateTemplateCommand.d.ts +11 -0
  130. package/dist-types/commands/UpdateTemplatePermissionsCommand.d.ts +17 -0
  131. package/dist-types/commands/UpdateThemeAliasCommand.d.ts +12 -0
  132. package/dist-types/commands/UpdateThemeCommand.d.ts +11 -0
  133. package/dist-types/commands/UpdateThemePermissionsCommand.d.ts +17 -0
  134. package/dist-types/commands/UpdateUserCommand.d.ts +20 -0
  135. package/package.json +16 -16
@@ -33,6 +33,22 @@ export interface ListTemplatesCommandOutput extends ListTemplatesResponse, __Met
33
33
  * };
34
34
  * const command = new ListTemplatesCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListTemplatesResponse
37
+ * // TemplateSummaryList: [ // TemplateSummaryList
38
+ * // { // TemplateSummary
39
+ * // Arn: "STRING_VALUE",
40
+ * // TemplateId: "STRING_VALUE",
41
+ * // Name: "STRING_VALUE",
42
+ * // LatestVersionNumber: Number("long"),
43
+ * // CreatedTime: new Date("TIMESTAMP"),
44
+ * // LastUpdatedTime: new Date("TIMESTAMP"),
45
+ * // },
46
+ * // ],
47
+ * // NextToken: "STRING_VALUE",
48
+ * // Status: Number("int"),
49
+ * // RequestId: "STRING_VALUE",
50
+ * // };
51
+ *
36
52
  * ```
37
53
  *
38
54
  * @param ListTemplatesCommandInput - {@link ListTemplatesCommandInput}
@@ -62,6 +78,8 @@ export interface ListTemplatesCommandOutput extends ListTemplatesResponse, __Met
62
78
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
63
79
  * capability is available in every edition.</p>
64
80
  *
81
+ * @throws {@link QuickSightServiceException}
82
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
65
83
  *
66
84
  */
67
85
  export declare class ListTemplatesCommand extends $Command<ListTemplatesCommandInput, ListTemplatesCommandOutput, QuickSightClientResolvedConfig> {
@@ -34,6 +34,19 @@ export interface ListThemeAliasesCommandOutput extends ListThemeAliasesResponse,
34
34
  * };
35
35
  * const command = new ListThemeAliasesCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListThemeAliasesResponse
38
+ * // ThemeAliasList: [ // ThemeAliasList
39
+ * // { // ThemeAlias
40
+ * // Arn: "STRING_VALUE",
41
+ * // AliasName: "STRING_VALUE",
42
+ * // ThemeVersionNumber: Number("long"),
43
+ * // },
44
+ * // ],
45
+ * // Status: Number("int"),
46
+ * // RequestId: "STRING_VALUE",
47
+ * // NextToken: "STRING_VALUE",
48
+ * // };
49
+ *
37
50
  * ```
38
51
  *
39
52
  * @param ListThemeAliasesCommandInput - {@link ListThemeAliasesCommandInput}
@@ -66,6 +79,8 @@ export interface ListThemeAliasesCommandOutput extends ListThemeAliasesResponse,
66
79
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
67
80
  * capability is available in every edition.</p>
68
81
  *
82
+ * @throws {@link QuickSightServiceException}
83
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
69
84
  *
70
85
  */
71
86
  export declare class ListThemeAliasesCommand extends $Command<ListThemeAliasesCommandInput, ListThemeAliasesCommandOutput, QuickSightClientResolvedConfig> {
@@ -34,6 +34,21 @@ export interface ListThemeVersionsCommandOutput extends ListThemeVersionsRespons
34
34
  * };
35
35
  * const command = new ListThemeVersionsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListThemeVersionsResponse
38
+ * // ThemeVersionSummaryList: [ // ThemeVersionSummaryList
39
+ * // { // ThemeVersionSummary
40
+ * // VersionNumber: Number("long"),
41
+ * // Arn: "STRING_VALUE",
42
+ * // Description: "STRING_VALUE",
43
+ * // CreatedTime: new Date("TIMESTAMP"),
44
+ * // Status: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETED",
45
+ * // },
46
+ * // ],
47
+ * // NextToken: "STRING_VALUE",
48
+ * // Status: Number("int"),
49
+ * // RequestId: "STRING_VALUE",
50
+ * // };
51
+ *
37
52
  * ```
38
53
  *
39
54
  * @param ListThemeVersionsCommandInput - {@link ListThemeVersionsCommandInput}
@@ -69,6 +84,8 @@ export interface ListThemeVersionsCommandOutput extends ListThemeVersionsRespons
69
84
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
70
85
  * capability is available in every edition.</p>
71
86
  *
87
+ * @throws {@link QuickSightServiceException}
88
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
72
89
  *
73
90
  */
74
91
  export declare class ListThemeVersionsCommand extends $Command<ListThemeVersionsCommandInput, ListThemeVersionsCommandOutput, QuickSightClientResolvedConfig> {
@@ -34,6 +34,22 @@ export interface ListThemesCommandOutput extends ListThemesResponse, __MetadataB
34
34
  * };
35
35
  * const command = new ListThemesCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListThemesResponse
38
+ * // ThemeSummaryList: [ // ThemeSummaryList
39
+ * // { // ThemeSummary
40
+ * // Arn: "STRING_VALUE",
41
+ * // Name: "STRING_VALUE",
42
+ * // ThemeId: "STRING_VALUE",
43
+ * // LatestVersionNumber: Number("long"),
44
+ * // CreatedTime: new Date("TIMESTAMP"),
45
+ * // LastUpdatedTime: new Date("TIMESTAMP"),
46
+ * // },
47
+ * // ],
48
+ * // NextToken: "STRING_VALUE",
49
+ * // Status: Number("int"),
50
+ * // RequestId: "STRING_VALUE",
51
+ * // };
52
+ *
37
53
  * ```
38
54
  *
39
55
  * @param ListThemesCommandInput - {@link ListThemesCommandInput}
@@ -69,6 +85,8 @@ export interface ListThemesCommandOutput extends ListThemesResponse, __MetadataB
69
85
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
70
86
  * capability is available in every edition.</p>
71
87
  *
88
+ * @throws {@link QuickSightServiceException}
89
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
72
90
  *
73
91
  */
74
92
  export declare class ListThemesCommand extends $Command<ListThemesCommandInput, ListThemesCommandOutput, QuickSightClientResolvedConfig> {
@@ -35,6 +35,20 @@ export interface ListUserGroupsCommandOutput extends ListUserGroupsResponse, __M
35
35
  * };
36
36
  * const command = new ListUserGroupsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListUserGroupsResponse
39
+ * // GroupList: [ // GroupList
40
+ * // { // Group
41
+ * // Arn: "STRING_VALUE",
42
+ * // GroupName: "STRING_VALUE",
43
+ * // Description: "STRING_VALUE",
44
+ * // PrincipalId: "STRING_VALUE",
45
+ * // },
46
+ * // ],
47
+ * // NextToken: "STRING_VALUE",
48
+ * // RequestId: "STRING_VALUE",
49
+ * // Status: Number("int"),
50
+ * // };
51
+ *
38
52
  * ```
39
53
  *
40
54
  * @param ListUserGroupsCommandInput - {@link ListUserGroupsCommandInput}
@@ -67,6 +81,8 @@ export interface ListUserGroupsCommandOutput extends ListUserGroupsResponse, __M
67
81
  * @throws {@link ThrottlingException} (client fault)
68
82
  * <p>Access is throttled.</p>
69
83
  *
84
+ * @throws {@link QuickSightServiceException}
85
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
70
86
  *
71
87
  */
72
88
  export declare class ListUserGroupsCommand extends $Command<ListUserGroupsCommandInput, ListUserGroupsCommandOutput, QuickSightClientResolvedConfig> {
@@ -34,6 +34,27 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
34
34
  * };
35
35
  * const command = new ListUsersCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListUsersResponse
38
+ * // UserList: [ // UserList
39
+ * // { // User
40
+ * // Arn: "STRING_VALUE",
41
+ * // UserName: "STRING_VALUE",
42
+ * // Email: "STRING_VALUE",
43
+ * // Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER",
44
+ * // IdentityType: "IAM" || "QUICKSIGHT",
45
+ * // Active: true || false,
46
+ * // PrincipalId: "STRING_VALUE",
47
+ * // CustomPermissionsName: "STRING_VALUE",
48
+ * // ExternalLoginFederationProviderType: "STRING_VALUE",
49
+ * // ExternalLoginFederationProviderUrl: "STRING_VALUE",
50
+ * // ExternalLoginId: "STRING_VALUE",
51
+ * // },
52
+ * // ],
53
+ * // NextToken: "STRING_VALUE",
54
+ * // RequestId: "STRING_VALUE",
55
+ * // Status: Number("int"),
56
+ * // };
57
+ *
37
58
  * ```
38
59
  *
39
60
  * @param ListUsersCommandInput - {@link ListUsersCommandInput}
@@ -69,6 +90,8 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
69
90
  * @throws {@link ThrottlingException} (client fault)
70
91
  * <p>Access is throttled.</p>
71
92
  *
93
+ * @throws {@link QuickSightServiceException}
94
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
72
95
  *
73
96
  */
74
97
  export declare class ListUsersCommand extends $Command<ListUsersCommandInput, ListUsersCommandOutput, QuickSightClientResolvedConfig> {
@@ -43,6 +43,11 @@ export interface PutDataSetRefreshPropertiesCommandOutput extends PutDataSetRefr
43
43
  * };
44
44
  * const command = new PutDataSetRefreshPropertiesCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // PutDataSetRefreshPropertiesResponse
47
+ * // RequestId: "STRING_VALUE",
48
+ * // Status: Number("int"),
49
+ * // };
50
+ *
46
51
  * ```
47
52
  *
48
53
  * @param PutDataSetRefreshPropertiesCommandInput - {@link PutDataSetRefreshPropertiesCommandInput}
@@ -78,6 +83,8 @@ export interface PutDataSetRefreshPropertiesCommandOutput extends PutDataSetRefr
78
83
  * @throws {@link ThrottlingException} (client fault)
79
84
  * <p>Access is throttled.</p>
80
85
  *
86
+ * @throws {@link QuickSightServiceException}
87
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
81
88
  *
82
89
  */
83
90
  export declare class PutDataSetRefreshPropertiesCommand extends $Command<PutDataSetRefreshPropertiesCommandInput, PutDataSetRefreshPropertiesCommandOutput, QuickSightClientResolvedConfig> {
@@ -42,6 +42,25 @@ export interface RegisterUserCommandOutput extends RegisterUserResponse, __Metad
42
42
  * };
43
43
  * const command = new RegisterUserCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // RegisterUserResponse
46
+ * // User: { // User
47
+ * // Arn: "STRING_VALUE",
48
+ * // UserName: "STRING_VALUE",
49
+ * // Email: "STRING_VALUE",
50
+ * // Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER",
51
+ * // IdentityType: "IAM" || "QUICKSIGHT",
52
+ * // Active: true || false,
53
+ * // PrincipalId: "STRING_VALUE",
54
+ * // CustomPermissionsName: "STRING_VALUE",
55
+ * // ExternalLoginFederationProviderType: "STRING_VALUE",
56
+ * // ExternalLoginFederationProviderUrl: "STRING_VALUE",
57
+ * // ExternalLoginId: "STRING_VALUE",
58
+ * // },
59
+ * // UserInvitationUrl: "STRING_VALUE",
60
+ * // RequestId: "STRING_VALUE",
61
+ * // Status: Number("int"),
62
+ * // };
63
+ *
45
64
  * ```
46
65
  *
47
66
  * @param RegisterUserCommandInput - {@link RegisterUserCommandInput}
@@ -80,6 +99,8 @@ export interface RegisterUserCommandOutput extends RegisterUserResponse, __Metad
80
99
  * @throws {@link ThrottlingException} (client fault)
81
100
  * <p>Access is throttled.</p>
82
101
  *
102
+ * @throws {@link QuickSightServiceException}
103
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
83
104
  *
84
105
  */
85
106
  export declare class RegisterUserCommand extends $Command<RegisterUserCommandInput, RegisterUserCommandOutput, QuickSightClientResolvedConfig> {
@@ -32,6 +32,13 @@ export interface RestoreAnalysisCommandOutput extends RestoreAnalysisResponse, _
32
32
  * };
33
33
  * const command = new RestoreAnalysisCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // RestoreAnalysisResponse
36
+ * // Status: Number("int"),
37
+ * // Arn: "STRING_VALUE",
38
+ * // AnalysisId: "STRING_VALUE",
39
+ * // RequestId: "STRING_VALUE",
40
+ * // };
41
+ *
35
42
  * ```
36
43
  *
37
44
  * @param RestoreAnalysisCommandInput - {@link RestoreAnalysisCommandInput}
@@ -61,6 +68,8 @@ export interface RestoreAnalysisCommandOutput extends RestoreAnalysisResponse, _
61
68
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
62
69
  * capability is available in every edition.</p>
63
70
  *
71
+ * @throws {@link QuickSightServiceException}
72
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
64
73
  *
65
74
  */
66
75
  export declare class RestoreAnalysisCommand extends $Command<RestoreAnalysisCommandInput, RestoreAnalysisCommandOutput, QuickSightClientResolvedConfig> {
@@ -43,6 +43,22 @@ export interface SearchAnalysesCommandOutput extends SearchAnalysesResponse, __M
43
43
  * };
44
44
  * const command = new SearchAnalysesCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // SearchAnalysesResponse
47
+ * // AnalysisSummaryList: [ // AnalysisSummaryList
48
+ * // { // AnalysisSummary
49
+ * // Arn: "STRING_VALUE",
50
+ * // AnalysisId: "STRING_VALUE",
51
+ * // Name: "STRING_VALUE",
52
+ * // Status: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETED",
53
+ * // CreatedTime: new Date("TIMESTAMP"),
54
+ * // LastUpdatedTime: new Date("TIMESTAMP"),
55
+ * // },
56
+ * // ],
57
+ * // NextToken: "STRING_VALUE",
58
+ * // Status: Number("int"),
59
+ * // RequestId: "STRING_VALUE",
60
+ * // };
61
+ *
46
62
  * ```
47
63
  *
48
64
  * @param SearchAnalysesCommandInput - {@link SearchAnalysesCommandInput}
@@ -72,6 +88,8 @@ export interface SearchAnalysesCommandOutput extends SearchAnalysesResponse, __M
72
88
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
73
89
  * capability is available in every edition.</p>
74
90
  *
91
+ * @throws {@link QuickSightServiceException}
92
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
75
93
  *
76
94
  */
77
95
  export declare class SearchAnalysesCommand extends $Command<SearchAnalysesCommandInput, SearchAnalysesCommandOutput, QuickSightClientResolvedConfig> {
@@ -43,6 +43,23 @@ export interface SearchDashboardsCommandOutput extends SearchDashboardsResponse,
43
43
  * };
44
44
  * const command = new SearchDashboardsCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // SearchDashboardsResponse
47
+ * // DashboardSummaryList: [ // DashboardSummaryList
48
+ * // { // DashboardSummary
49
+ * // Arn: "STRING_VALUE",
50
+ * // DashboardId: "STRING_VALUE",
51
+ * // Name: "STRING_VALUE",
52
+ * // CreatedTime: new Date("TIMESTAMP"),
53
+ * // LastUpdatedTime: new Date("TIMESTAMP"),
54
+ * // PublishedVersionNumber: Number("long"),
55
+ * // LastPublishedTime: new Date("TIMESTAMP"),
56
+ * // },
57
+ * // ],
58
+ * // NextToken: "STRING_VALUE",
59
+ * // Status: Number("int"),
60
+ * // RequestId: "STRING_VALUE",
61
+ * // };
62
+ *
46
63
  * ```
47
64
  *
48
65
  * @param SearchDashboardsCommandInput - {@link SearchDashboardsCommandInput}
@@ -72,6 +89,8 @@ export interface SearchDashboardsCommandOutput extends SearchDashboardsResponse,
72
89
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
73
90
  * capability is available in every edition.</p>
74
91
  *
92
+ * @throws {@link QuickSightServiceException}
93
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
75
94
  *
76
95
  */
77
96
  export declare class SearchDashboardsCommand extends $Command<SearchDashboardsCommandInput, SearchDashboardsCommandOutput, QuickSightClientResolvedConfig> {
@@ -40,6 +40,31 @@ export interface SearchDataSetsCommandOutput extends SearchDataSetsResponse, __M
40
40
  * };
41
41
  * const command = new SearchDataSetsCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // SearchDataSetsResponse
44
+ * // DataSetSummaries: [ // DataSetSummaryList
45
+ * // { // DataSetSummary
46
+ * // Arn: "STRING_VALUE",
47
+ * // DataSetId: "STRING_VALUE",
48
+ * // Name: "STRING_VALUE",
49
+ * // CreatedTime: new Date("TIMESTAMP"),
50
+ * // LastUpdatedTime: new Date("TIMESTAMP"),
51
+ * // ImportMode: "SPICE" || "DIRECT_QUERY",
52
+ * // RowLevelPermissionDataSet: { // RowLevelPermissionDataSet
53
+ * // Namespace: "STRING_VALUE",
54
+ * // Arn: "STRING_VALUE", // required
55
+ * // PermissionPolicy: "GRANT_ACCESS" || "DENY_ACCESS", // required
56
+ * // FormatVersion: "VERSION_1" || "VERSION_2",
57
+ * // Status: "ENABLED" || "DISABLED",
58
+ * // },
59
+ * // RowLevelPermissionTagConfigurationApplied: true || false,
60
+ * // ColumnLevelPermissionRulesApplied: true || false,
61
+ * // },
62
+ * // ],
63
+ * // NextToken: "STRING_VALUE",
64
+ * // Status: Number("int"),
65
+ * // RequestId: "STRING_VALUE",
66
+ * // };
67
+ *
43
68
  * ```
44
69
  *
45
70
  * @param SearchDataSetsCommandInput - {@link SearchDataSetsCommandInput}
@@ -69,6 +94,8 @@ export interface SearchDataSetsCommandOutput extends SearchDataSetsResponse, __M
69
94
  * @throws {@link ThrottlingException} (client fault)
70
95
  * <p>Access is throttled.</p>
71
96
  *
97
+ * @throws {@link QuickSightServiceException}
98
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
72
99
  *
73
100
  */
74
101
  export declare class SearchDataSetsCommand extends $Command<SearchDataSetsCommandInput, SearchDataSetsCommandOutput, QuickSightClientResolvedConfig> {
@@ -40,6 +40,22 @@ export interface SearchDataSourcesCommandOutput extends SearchDataSourcesRespons
40
40
  * };
41
41
  * const command = new SearchDataSourcesCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // SearchDataSourcesResponse
44
+ * // DataSourceSummaries: [ // DataSourceSummaryList
45
+ * // { // DataSourceSummary
46
+ * // Arn: "STRING_VALUE",
47
+ * // DataSourceId: "STRING_VALUE",
48
+ * // Name: "STRING_VALUE",
49
+ * // Type: "ADOBE_ANALYTICS" || "AMAZON_ELASTICSEARCH" || "ATHENA" || "AURORA" || "AURORA_POSTGRESQL" || "AWS_IOT_ANALYTICS" || "GITHUB" || "JIRA" || "MARIADB" || "MYSQL" || "ORACLE" || "POSTGRESQL" || "PRESTO" || "REDSHIFT" || "S3" || "SALESFORCE" || "SERVICENOW" || "SNOWFLAKE" || "SPARK" || "SQLSERVER" || "TERADATA" || "TWITTER" || "TIMESTREAM" || "AMAZON_OPENSEARCH" || "EXASOL" || "DATABRICKS",
50
+ * // CreatedTime: new Date("TIMESTAMP"),
51
+ * // LastUpdatedTime: new Date("TIMESTAMP"),
52
+ * // },
53
+ * // ],
54
+ * // NextToken: "STRING_VALUE",
55
+ * // Status: Number("int"),
56
+ * // RequestId: "STRING_VALUE",
57
+ * // };
58
+ *
43
59
  * ```
44
60
  *
45
61
  * @param SearchDataSourcesCommandInput - {@link SearchDataSourcesCommandInput}
@@ -69,6 +85,8 @@ export interface SearchDataSourcesCommandOutput extends SearchDataSourcesRespons
69
85
  * @throws {@link ThrottlingException} (client fault)
70
86
  * <p>Access is throttled.</p>
71
87
  *
88
+ * @throws {@link QuickSightServiceException}
89
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
72
90
  *
73
91
  */
74
92
  export declare class SearchDataSourcesCommand extends $Command<SearchDataSourcesCommandInput, SearchDataSourcesCommandOutput, QuickSightClientResolvedConfig> {
@@ -40,6 +40,22 @@ export interface SearchFoldersCommandOutput extends SearchFoldersResponse, __Met
40
40
  * };
41
41
  * const command = new SearchFoldersCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // SearchFoldersResponse
44
+ * // Status: Number("int"),
45
+ * // FolderSummaryList: [ // FolderSummaryList
46
+ * // { // FolderSummary
47
+ * // Arn: "STRING_VALUE",
48
+ * // FolderId: "STRING_VALUE",
49
+ * // Name: "STRING_VALUE",
50
+ * // FolderType: "SHARED",
51
+ * // CreatedTime: new Date("TIMESTAMP"),
52
+ * // LastUpdatedTime: new Date("TIMESTAMP"),
53
+ * // },
54
+ * // ],
55
+ * // NextToken: "STRING_VALUE",
56
+ * // RequestId: "STRING_VALUE",
57
+ * // };
58
+ *
43
59
  * ```
44
60
  *
45
61
  * @param SearchFoldersCommandInput - {@link SearchFoldersCommandInput}
@@ -78,6 +94,8 @@ export interface SearchFoldersCommandOutput extends SearchFoldersResponse, __Met
78
94
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
79
95
  * capability is available in every edition.</p>
80
96
  *
97
+ * @throws {@link QuickSightServiceException}
98
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
81
99
  *
82
100
  */
83
101
  export declare class SearchFoldersCommand extends $Command<SearchFoldersCommandInput, SearchFoldersCommandOutput, QuickSightClientResolvedConfig> {
@@ -41,6 +41,20 @@ export interface SearchGroupsCommandOutput extends SearchGroupsResponse, __Metad
41
41
  * };
42
42
  * const command = new SearchGroupsCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // SearchGroupsResponse
45
+ * // GroupList: [ // GroupList
46
+ * // { // Group
47
+ * // Arn: "STRING_VALUE",
48
+ * // GroupName: "STRING_VALUE",
49
+ * // Description: "STRING_VALUE",
50
+ * // PrincipalId: "STRING_VALUE",
51
+ * // },
52
+ * // ],
53
+ * // NextToken: "STRING_VALUE",
54
+ * // RequestId: "STRING_VALUE",
55
+ * // Status: Number("int"),
56
+ * // };
57
+ *
44
58
  * ```
45
59
  *
46
60
  * @param SearchGroupsCommandInput - {@link SearchGroupsCommandInput}
@@ -76,6 +90,8 @@ export interface SearchGroupsCommandOutput extends SearchGroupsResponse, __Metad
76
90
  * @throws {@link ThrottlingException} (client fault)
77
91
  * <p>Access is throttled.</p>
78
92
  *
93
+ * @throws {@link QuickSightServiceException}
94
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
79
95
  *
80
96
  */
81
97
  export declare class SearchGroupsCommand extends $Command<SearchGroupsCommandInput, SearchGroupsCommandOutput, QuickSightClientResolvedConfig> {
@@ -59,6 +59,11 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
59
59
  * };
60
60
  * const command = new TagResourceCommand(input);
61
61
  * const response = await client.send(command);
62
+ * // { // TagResourceResponse
63
+ * // RequestId: "STRING_VALUE",
64
+ * // Status: Number("int"),
65
+ * // };
66
+ *
62
67
  * ```
63
68
  *
64
69
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -88,6 +93,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
88
93
  * @throws {@link ThrottlingException} (client fault)
89
94
  * <p>Access is throttled.</p>
90
95
  *
96
+ * @throws {@link QuickSightServiceException}
97
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
91
98
  *
92
99
  */
93
100
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, QuickSightClientResolvedConfig> {
@@ -34,6 +34,11 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // UntagResourceResponse
38
+ * // RequestId: "STRING_VALUE",
39
+ * // Status: Number("int"),
40
+ * // };
41
+ *
37
42
  * ```
38
43
  *
39
44
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -60,6 +65,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
60
65
  * @throws {@link ThrottlingException} (client fault)
61
66
  * <p>Access is throttled.</p>
62
67
  *
68
+ * @throws {@link QuickSightServiceException}
69
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
63
70
  *
64
71
  */
65
72
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, QuickSightClientResolvedConfig> {
@@ -40,6 +40,18 @@ export interface UpdateAccountCustomizationCommandOutput extends UpdateAccountCu
40
40
  * };
41
41
  * const command = new UpdateAccountCustomizationCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // UpdateAccountCustomizationResponse
44
+ * // Arn: "STRING_VALUE",
45
+ * // AwsAccountId: "STRING_VALUE",
46
+ * // Namespace: "STRING_VALUE",
47
+ * // AccountCustomization: { // AccountCustomization
48
+ * // DefaultTheme: "STRING_VALUE",
49
+ * // DefaultEmailCustomizationTemplate: "STRING_VALUE",
50
+ * // },
51
+ * // RequestId: "STRING_VALUE",
52
+ * // Status: Number("int"),
53
+ * // };
54
+ *
43
55
  * ```
44
56
  *
45
57
  * @param UpdateAccountCustomizationCommandInput - {@link UpdateAccountCustomizationCommandInput}
@@ -72,6 +84,8 @@ export interface UpdateAccountCustomizationCommandOutput extends UpdateAccountCu
72
84
  * @throws {@link ThrottlingException} (client fault)
73
85
  * <p>Access is throttled.</p>
74
86
  *
87
+ * @throws {@link QuickSightServiceException}
88
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
75
89
  *
76
90
  */
77
91
  export declare class UpdateAccountCustomizationCommand extends $Command<UpdateAccountCustomizationCommandInput, UpdateAccountCustomizationCommandOutput, QuickSightClientResolvedConfig> {
@@ -34,6 +34,11 @@ export interface UpdateAccountSettingsCommandOutput extends UpdateAccountSetting
34
34
  * };
35
35
  * const command = new UpdateAccountSettingsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // UpdateAccountSettingsResponse
38
+ * // RequestId: "STRING_VALUE",
39
+ * // Status: Number("int"),
40
+ * // };
41
+ *
37
42
  * ```
38
43
  *
39
44
  * @param UpdateAccountSettingsCommandInput - {@link UpdateAccountSettingsCommandInput}
@@ -63,6 +68,8 @@ export interface UpdateAccountSettingsCommandOutput extends UpdateAccountSetting
63
68
  * @throws {@link ThrottlingException} (client fault)
64
69
  * <p>Access is throttled.</p>
65
70
  *
71
+ * @throws {@link QuickSightServiceException}
72
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
66
73
  *
67
74
  */
68
75
  export declare class UpdateAccountSettingsCommand extends $Command<UpdateAccountSettingsCommandInput, UpdateAccountSettingsCommandOutput, QuickSightClientResolvedConfig> {
@@ -4296,6 +4296,14 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M
4296
4296
  * };
4297
4297
  * const command = new UpdateAnalysisCommand(input);
4298
4298
  * const response = await client.send(command);
4299
+ * // { // UpdateAnalysisResponse
4300
+ * // Arn: "STRING_VALUE",
4301
+ * // AnalysisId: "STRING_VALUE",
4302
+ * // UpdateStatus: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETED",
4303
+ * // Status: Number("int"),
4304
+ * // RequestId: "STRING_VALUE",
4305
+ * // };
4306
+ *
4299
4307
  * ```
4300
4308
  *
4301
4309
  * @param UpdateAnalysisCommandInput - {@link UpdateAnalysisCommandInput}
@@ -4328,6 +4336,8 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M
4328
4336
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
4329
4337
  * capability is available in every edition.</p>
4330
4338
  *
4339
+ * @throws {@link QuickSightServiceException}
4340
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
4331
4341
  *
4332
4342
  */
4333
4343
  export declare class UpdateAnalysisCommand extends $Command<UpdateAnalysisCommandInput, UpdateAnalysisCommandOutput, QuickSightClientResolvedConfig> {
@@ -48,6 +48,21 @@ export interface UpdateAnalysisPermissionsCommandOutput extends UpdateAnalysisPe
48
48
  * };
49
49
  * const command = new UpdateAnalysisPermissionsCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // { // UpdateAnalysisPermissionsResponse
52
+ * // AnalysisArn: "STRING_VALUE",
53
+ * // AnalysisId: "STRING_VALUE",
54
+ * // Permissions: [ // ResourcePermissionList
55
+ * // { // ResourcePermission
56
+ * // Principal: "STRING_VALUE", // required
57
+ * // Actions: [ // ActionList // required
58
+ * // "STRING_VALUE",
59
+ * // ],
60
+ * // },
61
+ * // ],
62
+ * // RequestId: "STRING_VALUE",
63
+ * // Status: Number("int"),
64
+ * // };
65
+ *
51
66
  * ```
52
67
  *
53
68
  * @param UpdateAnalysisPermissionsCommandInput - {@link UpdateAnalysisPermissionsCommandInput}
@@ -80,6 +95,8 @@ export interface UpdateAnalysisPermissionsCommandOutput extends UpdateAnalysisPe
80
95
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
81
96
  * capability is available in every edition.</p>
82
97
  *
98
+ * @throws {@link QuickSightServiceException}
99
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
83
100
  *
84
101
  */
85
102
  export declare class UpdateAnalysisPermissionsCommand extends $Command<UpdateAnalysisPermissionsCommandInput, UpdateAnalysisPermissionsCommandOutput, QuickSightClientResolvedConfig> {
@@ -4341,6 +4341,15 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _
4341
4341
  * };
4342
4342
  * const command = new UpdateDashboardCommand(input);
4343
4343
  * const response = await client.send(command);
4344
+ * // { // UpdateDashboardResponse
4345
+ * // Arn: "STRING_VALUE",
4346
+ * // VersionArn: "STRING_VALUE",
4347
+ * // DashboardId: "STRING_VALUE",
4348
+ * // CreationStatus: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETED",
4349
+ * // Status: Number("int"),
4350
+ * // RequestId: "STRING_VALUE",
4351
+ * // };
4352
+ *
4344
4353
  * ```
4345
4354
  *
4346
4355
  * @param UpdateDashboardCommandInput - {@link UpdateDashboardCommandInput}
@@ -4373,6 +4382,8 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _
4373
4382
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
4374
4383
  * capability is available in every edition.</p>
4375
4384
  *
4385
+ * @throws {@link QuickSightServiceException}
4386
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
4376
4387
  *
4377
4388
  */
4378
4389
  export declare class UpdateDashboardCommand extends $Command<UpdateDashboardCommandInput, UpdateDashboardCommandOutput, QuickSightClientResolvedConfig> {