@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,13 @@ export interface CancelIngestionCommandOutput extends CancelIngestionResponse, _
33
33
  * };
34
34
  * const command = new CancelIngestionCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // CancelIngestionResponse
37
+ * // Arn: "STRING_VALUE",
38
+ * // IngestionId: "STRING_VALUE",
39
+ * // RequestId: "STRING_VALUE",
40
+ * // Status: Number("int"),
41
+ * // };
42
+ *
36
43
  * ```
37
44
  *
38
45
  * @param CancelIngestionCommandInput - {@link CancelIngestionCommandInput}
@@ -62,6 +69,8 @@ export interface CancelIngestionCommandOutput extends CancelIngestionResponse, _
62
69
  * @throws {@link ThrottlingException} (client fault)
63
70
  * <p>Access is throttled.</p>
64
71
  *
72
+ * @throws {@link QuickSightServiceException}
73
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
65
74
  *
66
75
  */
67
76
  export declare class CancelIngestionCommand extends $Command<CancelIngestionCommandInput, CancelIngestionCommandOutput, QuickSightClientResolvedConfig> {
@@ -64,6 +64,18 @@ export interface CreateAccountCustomizationCommandOutput extends CreateAccountCu
64
64
  * };
65
65
  * const command = new CreateAccountCustomizationCommand(input);
66
66
  * const response = await client.send(command);
67
+ * // { // CreateAccountCustomizationResponse
68
+ * // Arn: "STRING_VALUE",
69
+ * // AwsAccountId: "STRING_VALUE",
70
+ * // Namespace: "STRING_VALUE",
71
+ * // AccountCustomization: { // AccountCustomization
72
+ * // DefaultTheme: "STRING_VALUE",
73
+ * // DefaultEmailCustomizationTemplate: "STRING_VALUE",
74
+ * // },
75
+ * // RequestId: "STRING_VALUE",
76
+ * // Status: Number("int"),
77
+ * // };
78
+ *
67
79
  * ```
68
80
  *
69
81
  * @param CreateAccountCustomizationCommandInput - {@link CreateAccountCustomizationCommandInput}
@@ -99,6 +111,8 @@ export interface CreateAccountCustomizationCommandOutput extends CreateAccountCu
99
111
  * @throws {@link ThrottlingException} (client fault)
100
112
  * <p>Access is throttled.</p>
101
113
  *
114
+ * @throws {@link QuickSightServiceException}
115
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
102
116
  *
103
117
  */
104
118
  export declare class CreateAccountCustomizationCommand extends $Command<CreateAccountCustomizationCommandInput, CreateAccountCustomizationCommandOutput, QuickSightClientResolvedConfig> {
@@ -73,6 +73,17 @@ export interface CreateAccountSubscriptionCommandOutput extends CreateAccountSub
73
73
  * };
74
74
  * const command = new CreateAccountSubscriptionCommand(input);
75
75
  * const response = await client.send(command);
76
+ * // { // CreateAccountSubscriptionResponse
77
+ * // SignupResponse: { // SignupResponse
78
+ * // IAMUser: true || false,
79
+ * // userLoginName: "STRING_VALUE",
80
+ * // accountName: "STRING_VALUE",
81
+ * // directoryType: "STRING_VALUE",
82
+ * // },
83
+ * // Status: Number("int"),
84
+ * // RequestId: "STRING_VALUE",
85
+ * // };
86
+ *
76
87
  * ```
77
88
  *
78
89
  * @param CreateAccountSubscriptionCommandInput - {@link CreateAccountSubscriptionCommandInput}
@@ -111,6 +122,8 @@ export interface CreateAccountSubscriptionCommandOutput extends CreateAccountSub
111
122
  * @throws {@link ThrottlingException} (client fault)
112
123
  * <p>Access is throttled.</p>
113
124
  *
125
+ * @throws {@link QuickSightServiceException}
126
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
114
127
  *
115
128
  */
116
129
  export declare class CreateAccountSubscriptionCommand extends $Command<CreateAccountSubscriptionCommandInput, CreateAccountSubscriptionCommandOutput, QuickSightClientResolvedConfig> {
@@ -4310,6 +4310,14 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M
4310
4310
  * };
4311
4311
  * const command = new CreateAnalysisCommand(input);
4312
4312
  * const response = await client.send(command);
4313
+ * // { // CreateAnalysisResponse
4314
+ * // Arn: "STRING_VALUE",
4315
+ * // AnalysisId: "STRING_VALUE",
4316
+ * // CreationStatus: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETED",
4317
+ * // Status: Number("int"),
4318
+ * // RequestId: "STRING_VALUE",
4319
+ * // };
4320
+ *
4313
4321
  * ```
4314
4322
  *
4315
4323
  * @param CreateAnalysisCommandInput - {@link CreateAnalysisCommandInput}
@@ -4345,6 +4353,8 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M
4345
4353
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
4346
4354
  * capability is available in every edition.</p>
4347
4355
  *
4356
+ * @throws {@link QuickSightServiceException}
4357
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
4348
4358
  *
4349
4359
  */
4350
4360
  export declare class CreateAnalysisCommand extends $Command<CreateAnalysisCommandInput, CreateAnalysisCommandOutput, QuickSightClientResolvedConfig> {
@@ -4356,6 +4356,15 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _
4356
4356
  * };
4357
4357
  * const command = new CreateDashboardCommand(input);
4358
4358
  * const response = await client.send(command);
4359
+ * // { // CreateDashboardResponse
4360
+ * // Arn: "STRING_VALUE",
4361
+ * // VersionArn: "STRING_VALUE",
4362
+ * // DashboardId: "STRING_VALUE",
4363
+ * // CreationStatus: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETED",
4364
+ * // Status: Number("int"),
4365
+ * // RequestId: "STRING_VALUE",
4366
+ * // };
4367
+ *
4359
4368
  * ```
4360
4369
  *
4361
4370
  * @param CreateDashboardCommandInput - {@link CreateDashboardCommandInput}
@@ -4391,6 +4400,8 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _
4391
4400
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
4392
4401
  * capability is available in every edition.</p>
4393
4402
  *
4403
+ * @throws {@link QuickSightServiceException}
4404
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
4394
4405
  *
4395
4406
  */
4396
4407
  export declare class CreateDashboardCommand extends $Command<CreateDashboardCommandInput, CreateDashboardCommandOutput, QuickSightClientResolvedConfig> {
@@ -215,6 +215,15 @@ export interface CreateDataSetCommandOutput extends CreateDataSetResponse, __Met
215
215
  * };
216
216
  * const command = new CreateDataSetCommand(input);
217
217
  * const response = await client.send(command);
218
+ * // { // CreateDataSetResponse
219
+ * // Arn: "STRING_VALUE",
220
+ * // DataSetId: "STRING_VALUE",
221
+ * // IngestionArn: "STRING_VALUE",
222
+ * // IngestionId: "STRING_VALUE",
223
+ * // RequestId: "STRING_VALUE",
224
+ * // Status: Number("int"),
225
+ * // };
226
+ *
218
227
  * ```
219
228
  *
220
229
  * @param CreateDataSetCommandInput - {@link CreateDataSetCommandInput}
@@ -256,6 +265,8 @@ export interface CreateDataSetCommandOutput extends CreateDataSetResponse, __Met
256
265
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
257
266
  * capability is available in every edition.</p>
258
267
  *
268
+ * @throws {@link QuickSightServiceException}
269
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
259
270
  *
260
271
  */
261
272
  export declare class CreateDataSetCommand extends $Command<CreateDataSetCommandInput, CreateDataSetCommandOutput, QuickSightClientResolvedConfig> {
@@ -274,6 +274,14 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
274
274
  * };
275
275
  * const command = new CreateDataSourceCommand(input);
276
276
  * const response = await client.send(command);
277
+ * // { // CreateDataSourceResponse
278
+ * // Arn: "STRING_VALUE",
279
+ * // DataSourceId: "STRING_VALUE",
280
+ * // CreationStatus: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETED",
281
+ * // RequestId: "STRING_VALUE",
282
+ * // Status: Number("int"),
283
+ * // };
284
+ *
277
285
  * ```
278
286
  *
279
287
  * @param CreateDataSourceCommandInput - {@link CreateDataSourceCommandInput}
@@ -309,6 +317,8 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
309
317
  * @throws {@link ThrottlingException} (client fault)
310
318
  * <p>Access is throttled.</p>
311
319
  *
320
+ * @throws {@link QuickSightServiceException}
321
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
312
322
  *
313
323
  */
314
324
  export declare class CreateDataSourceCommand extends $Command<CreateDataSourceCommandInput, CreateDataSourceCommandOutput, QuickSightClientResolvedConfig> {
@@ -49,6 +49,13 @@ export interface CreateFolderCommandOutput extends CreateFolderResponse, __Metad
49
49
  * };
50
50
  * const command = new CreateFolderCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // { // CreateFolderResponse
53
+ * // Status: Number("int"),
54
+ * // Arn: "STRING_VALUE",
55
+ * // FolderId: "STRING_VALUE",
56
+ * // RequestId: "STRING_VALUE",
57
+ * // };
58
+ *
52
59
  * ```
53
60
  *
54
61
  * @param CreateFolderCommandInput - {@link CreateFolderCommandInput}
@@ -90,6 +97,8 @@ export interface CreateFolderCommandOutput extends CreateFolderResponse, __Metad
90
97
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
91
98
  * capability is available in every edition.</p>
92
99
  *
100
+ * @throws {@link QuickSightServiceException}
101
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
93
102
  *
94
103
  */
95
104
  export declare class CreateFolderCommand extends $Command<CreateFolderCommandInput, CreateFolderCommandOutput, QuickSightClientResolvedConfig> {
@@ -34,6 +34,15 @@ export interface CreateFolderMembershipCommandOutput extends CreateFolderMembers
34
34
  * };
35
35
  * const command = new CreateFolderMembershipCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // CreateFolderMembershipResponse
38
+ * // Status: Number("int"),
39
+ * // FolderMember: { // FolderMember
40
+ * // MemberId: "STRING_VALUE",
41
+ * // MemberType: "DASHBOARD" || "ANALYSIS" || "DATASET",
42
+ * // },
43
+ * // RequestId: "STRING_VALUE",
44
+ * // };
45
+ *
37
46
  * ```
38
47
  *
39
48
  * @param CreateFolderMembershipCommandInput - {@link CreateFolderMembershipCommandInput}
@@ -72,6 +81,8 @@ export interface CreateFolderMembershipCommandOutput extends CreateFolderMembers
72
81
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
73
82
  * capability is available in every edition.</p>
74
83
  *
84
+ * @throws {@link QuickSightServiceException}
85
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
75
86
  *
76
87
  */
77
88
  export declare class CreateFolderMembershipCommand extends $Command<CreateFolderMembershipCommandInput, CreateFolderMembershipCommandOutput, QuickSightClientResolvedConfig> {
@@ -38,6 +38,17 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
38
38
  * };
39
39
  * const command = new CreateGroupCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // CreateGroupResponse
42
+ * // Group: { // Group
43
+ * // Arn: "STRING_VALUE",
44
+ * // GroupName: "STRING_VALUE",
45
+ * // Description: "STRING_VALUE",
46
+ * // PrincipalId: "STRING_VALUE",
47
+ * // },
48
+ * // RequestId: "STRING_VALUE",
49
+ * // Status: Number("int"),
50
+ * // };
51
+ *
41
52
  * ```
42
53
  *
43
54
  * @param CreateGroupCommandInput - {@link CreateGroupCommandInput}
@@ -76,6 +87,8 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
76
87
  * @throws {@link ThrottlingException} (client fault)
77
88
  * <p>Access is throttled.</p>
78
89
  *
90
+ * @throws {@link QuickSightServiceException}
91
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
79
92
  *
80
93
  */
81
94
  export declare class CreateGroupCommand extends $Command<CreateGroupCommandInput, CreateGroupCommandOutput, QuickSightClientResolvedConfig> {
@@ -34,6 +34,15 @@ export interface CreateGroupMembershipCommandOutput extends CreateGroupMembershi
34
34
  * };
35
35
  * const command = new CreateGroupMembershipCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // CreateGroupMembershipResponse
38
+ * // GroupMember: { // GroupMember
39
+ * // Arn: "STRING_VALUE",
40
+ * // MemberName: "STRING_VALUE",
41
+ * // },
42
+ * // RequestId: "STRING_VALUE",
43
+ * // Status: Number("int"),
44
+ * // };
45
+ *
37
46
  * ```
38
47
  *
39
48
  * @param CreateGroupMembershipCommandInput - {@link CreateGroupMembershipCommandInput}
@@ -66,6 +75,8 @@ export interface CreateGroupMembershipCommandOutput extends CreateGroupMembershi
66
75
  * @throws {@link ThrottlingException} (client fault)
67
76
  * <p>Access is throttled.</p>
68
77
  *
78
+ * @throws {@link QuickSightServiceException}
79
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
69
80
  *
70
81
  */
71
82
  export declare class CreateGroupMembershipCommand extends $Command<CreateGroupMembershipCommandInput, CreateGroupMembershipCommandOutput, QuickSightClientResolvedConfig> {
@@ -43,6 +43,20 @@ export interface CreateIAMPolicyAssignmentCommandOutput extends CreateIAMPolicyA
43
43
  * };
44
44
  * const command = new CreateIAMPolicyAssignmentCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // CreateIAMPolicyAssignmentResponse
47
+ * // AssignmentName: "STRING_VALUE",
48
+ * // AssignmentId: "STRING_VALUE",
49
+ * // AssignmentStatus: "ENABLED" || "DRAFT" || "DISABLED",
50
+ * // PolicyArn: "STRING_VALUE",
51
+ * // Identities: { // IdentityMap
52
+ * // "<keys>": [ // IdentityNameList
53
+ * // "STRING_VALUE",
54
+ * // ],
55
+ * // },
56
+ * // RequestId: "STRING_VALUE",
57
+ * // Status: Number("int"),
58
+ * // };
59
+ *
46
60
  * ```
47
61
  *
48
62
  * @param CreateIAMPolicyAssignmentCommandInput - {@link CreateIAMPolicyAssignmentCommandInput}
@@ -76,6 +90,8 @@ export interface CreateIAMPolicyAssignmentCommandOutput extends CreateIAMPolicyA
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 CreateIAMPolicyAssignmentCommand extends $Command<CreateIAMPolicyAssignmentCommandInput, CreateIAMPolicyAssignmentCommandOutput, QuickSightClientResolvedConfig> {
@@ -40,6 +40,14 @@ export interface CreateIngestionCommandOutput extends CreateIngestionResponse, _
40
40
  * };
41
41
  * const command = new CreateIngestionCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // CreateIngestionResponse
44
+ * // Arn: "STRING_VALUE",
45
+ * // IngestionId: "STRING_VALUE",
46
+ * // IngestionStatus: "INITIALIZED" || "QUEUED" || "RUNNING" || "FAILED" || "COMPLETED" || "CANCELLED",
47
+ * // RequestId: "STRING_VALUE",
48
+ * // Status: Number("int"),
49
+ * // };
50
+ *
43
51
  * ```
44
52
  *
45
53
  * @param CreateIngestionCommandInput - {@link CreateIngestionCommandInput}
@@ -72,6 +80,8 @@ export interface CreateIngestionCommandOutput extends CreateIngestionResponse, _
72
80
  * @throws {@link ThrottlingException} (client fault)
73
81
  * <p>Access is throttled.</p>
74
82
  *
83
+ * @throws {@link QuickSightServiceException}
84
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
75
85
  *
76
86
  */
77
87
  export declare class CreateIngestionCommand extends $Command<CreateIngestionCommandInput, CreateIngestionCommandOutput, QuickSightClientResolvedConfig> {
@@ -46,6 +46,16 @@ export interface CreateNamespaceCommandOutput extends CreateNamespaceResponse, _
46
46
  * };
47
47
  * const command = new CreateNamespaceCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // { // CreateNamespaceResponse
50
+ * // Arn: "STRING_VALUE",
51
+ * // Name: "STRING_VALUE",
52
+ * // CapacityRegion: "STRING_VALUE",
53
+ * // CreationStatus: "CREATED" || "CREATING" || "DELETING" || "RETRYABLE_FAILURE" || "NON_RETRYABLE_FAILURE",
54
+ * // IdentityStore: "QUICKSIGHT",
55
+ * // RequestId: "STRING_VALUE",
56
+ * // Status: Number("int"),
57
+ * // };
58
+ *
49
59
  * ```
50
60
  *
51
61
  * @param CreateNamespaceCommandInput - {@link CreateNamespaceCommandInput}
@@ -87,6 +97,8 @@ export interface CreateNamespaceCommandOutput extends CreateNamespaceResponse, _
87
97
  * @throws {@link ThrottlingException} (client fault)
88
98
  * <p>Access is throttled.</p>
89
99
  *
100
+ * @throws {@link QuickSightServiceException}
101
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
90
102
  *
91
103
  */
92
104
  export declare class CreateNamespaceCommand extends $Command<CreateNamespaceCommandInput, CreateNamespaceCommandOutput, QuickSightClientResolvedConfig> {
@@ -47,6 +47,13 @@ export interface CreateRefreshScheduleCommandOutput extends CreateRefreshSchedul
47
47
  * };
48
48
  * const command = new CreateRefreshScheduleCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // { // CreateRefreshScheduleResponse
51
+ * // Status: Number("int"),
52
+ * // RequestId: "STRING_VALUE",
53
+ * // ScheduleId: "STRING_VALUE",
54
+ * // Arn: "STRING_VALUE",
55
+ * // };
56
+ *
50
57
  * ```
51
58
  *
52
59
  * @param CreateRefreshScheduleCommandInput - {@link CreateRefreshScheduleCommandInput}
@@ -82,6 +89,8 @@ export interface CreateRefreshScheduleCommandOutput extends CreateRefreshSchedul
82
89
  * @throws {@link ThrottlingException} (client fault)
83
90
  * <p>Access is throttled.</p>
84
91
  *
92
+ * @throws {@link QuickSightServiceException}
93
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
85
94
  *
86
95
  */
87
96
  export declare class CreateRefreshScheduleCommand extends $Command<CreateRefreshScheduleCommandInput, CreateRefreshScheduleCommandOutput, QuickSightClientResolvedConfig> {
@@ -34,6 +34,16 @@ export interface CreateTemplateAliasCommandOutput extends CreateTemplateAliasRes
34
34
  * };
35
35
  * const command = new CreateTemplateAliasCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // CreateTemplateAliasResponse
38
+ * // TemplateAlias: { // TemplateAlias
39
+ * // AliasName: "STRING_VALUE",
40
+ * // Arn: "STRING_VALUE",
41
+ * // TemplateVersionNumber: Number("long"),
42
+ * // },
43
+ * // Status: Number("int"),
44
+ * // RequestId: "STRING_VALUE",
45
+ * // };
46
+ *
37
47
  * ```
38
48
  *
39
49
  * @param CreateTemplateAliasCommandInput - {@link CreateTemplateAliasCommandInput}
@@ -66,6 +76,8 @@ export interface CreateTemplateAliasCommandOutput extends CreateTemplateAliasRes
66
76
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
67
77
  * capability is available in every edition.</p>
68
78
  *
79
+ * @throws {@link QuickSightServiceException}
80
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
69
81
  *
70
82
  */
71
83
  export declare class CreateTemplateAliasCommand extends $Command<CreateTemplateAliasCommandInput, CreateTemplateAliasCommandOutput, QuickSightClientResolvedConfig> {
@@ -4304,6 +4304,15 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M
4304
4304
  * };
4305
4305
  * const command = new CreateTemplateCommand(input);
4306
4306
  * const response = await client.send(command);
4307
+ * // { // CreateTemplateResponse
4308
+ * // Arn: "STRING_VALUE",
4309
+ * // VersionArn: "STRING_VALUE",
4310
+ * // TemplateId: "STRING_VALUE",
4311
+ * // CreationStatus: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETED",
4312
+ * // Status: Number("int"),
4313
+ * // RequestId: "STRING_VALUE",
4314
+ * // };
4315
+ *
4307
4316
  * ```
4308
4317
  *
4309
4318
  * @param CreateTemplateCommandInput - {@link CreateTemplateCommandInput}
@@ -4345,6 +4354,8 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M
4345
4354
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
4346
4355
  * capability is available in every edition.</p>
4347
4356
  *
4357
+ * @throws {@link QuickSightServiceException}
4358
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
4348
4359
  *
4349
4360
  */
4350
4361
  export declare class CreateTemplateCommand extends $Command<CreateTemplateCommandInput, CreateTemplateCommandOutput, QuickSightClientResolvedConfig> {
@@ -34,6 +34,16 @@ export interface CreateThemeAliasCommandOutput extends CreateThemeAliasResponse,
34
34
  * };
35
35
  * const command = new CreateThemeAliasCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // CreateThemeAliasResponse
38
+ * // ThemeAlias: { // ThemeAlias
39
+ * // Arn: "STRING_VALUE",
40
+ * // AliasName: "STRING_VALUE",
41
+ * // ThemeVersionNumber: Number("long"),
42
+ * // },
43
+ * // Status: Number("int"),
44
+ * // RequestId: "STRING_VALUE",
45
+ * // };
46
+ *
37
47
  * ```
38
48
  *
39
49
  * @param CreateThemeAliasCommandInput - {@link CreateThemeAliasCommandInput}
@@ -69,6 +79,8 @@ export interface CreateThemeAliasCommandOutput extends CreateThemeAliasResponse,
69
79
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
70
80
  * capability is available in every edition.</p>
71
81
  *
82
+ * @throws {@link QuickSightServiceException}
83
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
72
84
  *
73
85
  */
74
86
  export declare class CreateThemeAliasCommand extends $Command<CreateThemeAliasCommandInput, CreateThemeAliasCommandOutput, QuickSightClientResolvedConfig> {
@@ -103,6 +103,15 @@ export interface CreateThemeCommandOutput extends CreateThemeResponse, __Metadat
103
103
  * };
104
104
  * const command = new CreateThemeCommand(input);
105
105
  * const response = await client.send(command);
106
+ * // { // CreateThemeResponse
107
+ * // Arn: "STRING_VALUE",
108
+ * // VersionArn: "STRING_VALUE",
109
+ * // ThemeId: "STRING_VALUE",
110
+ * // CreationStatus: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETED",
111
+ * // Status: Number("int"),
112
+ * // RequestId: "STRING_VALUE",
113
+ * // };
114
+ *
106
115
  * ```
107
116
  *
108
117
  * @param CreateThemeCommandInput - {@link CreateThemeCommandInput}
@@ -141,6 +150,8 @@ export interface CreateThemeCommandOutput extends CreateThemeResponse, __Metadat
141
150
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
142
151
  * capability is available in every edition.</p>
143
152
  *
153
+ * @throws {@link QuickSightServiceException}
154
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
144
155
  *
145
156
  */
146
157
  export declare class CreateThemeCommand extends $Command<CreateThemeCommandInput, CreateThemeCommandOutput, QuickSightClientResolvedConfig> {
@@ -33,6 +33,11 @@ export interface DeleteAccountCustomizationCommandOutput extends DeleteAccountCu
33
33
  * };
34
34
  * const command = new DeleteAccountCustomizationCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DeleteAccountCustomizationResponse
37
+ * // RequestId: "STRING_VALUE",
38
+ * // Status: Number("int"),
39
+ * // };
40
+ *
36
41
  * ```
37
42
  *
38
43
  * @param DeleteAccountCustomizationCommandInput - {@link DeleteAccountCustomizationCommandInput}
@@ -65,6 +70,8 @@ export interface DeleteAccountCustomizationCommandOutput extends DeleteAccountCu
65
70
  * @throws {@link ThrottlingException} (client fault)
66
71
  * <p>Access is throttled.</p>
67
72
  *
73
+ * @throws {@link QuickSightServiceException}
74
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
68
75
  *
69
76
  */
70
77
  export declare class DeleteAccountCustomizationCommand extends $Command<DeleteAccountCustomizationCommandInput, DeleteAccountCustomizationCommandOutput, QuickSightClientResolvedConfig> {
@@ -31,6 +31,11 @@ export interface DeleteAccountSubscriptionCommandOutput extends DeleteAccountSub
31
31
  * };
32
32
  * const command = new DeleteAccountSubscriptionCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DeleteAccountSubscriptionResponse
35
+ * // RequestId: "STRING_VALUE",
36
+ * // Status: Number("int"),
37
+ * // };
38
+ *
34
39
  * ```
35
40
  *
36
41
  * @param DeleteAccountSubscriptionCommandInput - {@link DeleteAccountSubscriptionCommandInput}
@@ -63,6 +68,8 @@ export interface DeleteAccountSubscriptionCommandOutput extends DeleteAccountSub
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 DeleteAccountSubscriptionCommand extends $Command<DeleteAccountSubscriptionCommandInput, DeleteAccountSubscriptionCommandOutput, QuickSightClientResolvedConfig> {
@@ -45,6 +45,14 @@ export interface DeleteAnalysisCommandOutput extends DeleteAnalysisResponse, __M
45
45
  * };
46
46
  * const command = new DeleteAnalysisCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // { // DeleteAnalysisResponse
49
+ * // Status: Number("int"),
50
+ * // Arn: "STRING_VALUE",
51
+ * // AnalysisId: "STRING_VALUE",
52
+ * // DeletionTime: new Date("TIMESTAMP"),
53
+ * // RequestId: "STRING_VALUE",
54
+ * // };
55
+ *
48
56
  * ```
49
57
  *
50
58
  * @param DeleteAnalysisCommandInput - {@link DeleteAnalysisCommandInput}
@@ -74,6 +82,8 @@ export interface DeleteAnalysisCommandOutput extends DeleteAnalysisResponse, __M
74
82
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
75
83
  * capability is available in every edition.</p>
76
84
  *
85
+ * @throws {@link QuickSightServiceException}
86
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
77
87
  *
78
88
  */
79
89
  export declare class DeleteAnalysisCommand extends $Command<DeleteAnalysisCommandInput, DeleteAnalysisCommandOutput, QuickSightClientResolvedConfig> {
@@ -33,6 +33,13 @@ export interface DeleteDashboardCommandOutput extends DeleteDashboardResponse, _
33
33
  * };
34
34
  * const command = new DeleteDashboardCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DeleteDashboardResponse
37
+ * // Status: Number("int"),
38
+ * // Arn: "STRING_VALUE",
39
+ * // DashboardId: "STRING_VALUE",
40
+ * // RequestId: "STRING_VALUE",
41
+ * // };
42
+ *
36
43
  * ```
37
44
  *
38
45
  * @param DeleteDashboardCommandInput - {@link DeleteDashboardCommandInput}
@@ -62,6 +69,8 @@ export interface DeleteDashboardCommandOutput extends DeleteDashboardResponse, _
62
69
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
63
70
  * capability is available in every edition.</p>
64
71
  *
72
+ * @throws {@link QuickSightServiceException}
73
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
65
74
  *
66
75
  */
67
76
  export declare class DeleteDashboardCommand extends $Command<DeleteDashboardCommandInput, DeleteDashboardCommandOutput, QuickSightClientResolvedConfig> {
@@ -32,6 +32,13 @@ export interface DeleteDataSetCommandOutput extends DeleteDataSetResponse, __Met
32
32
  * };
33
33
  * const command = new DeleteDataSetCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DeleteDataSetResponse
36
+ * // Arn: "STRING_VALUE",
37
+ * // DataSetId: "STRING_VALUE",
38
+ * // RequestId: "STRING_VALUE",
39
+ * // Status: Number("int"),
40
+ * // };
41
+ *
35
42
  * ```
36
43
  *
37
44
  * @param DeleteDataSetCommandInput - {@link DeleteDataSetCommandInput}
@@ -58,6 +65,8 @@ export interface DeleteDataSetCommandOutput extends DeleteDataSetResponse, __Met
58
65
  * @throws {@link ThrottlingException} (client fault)
59
66
  * <p>Access is throttled.</p>
60
67
  *
68
+ * @throws {@link QuickSightServiceException}
69
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
61
70
  *
62
71
  */
63
72
  export declare class DeleteDataSetCommand extends $Command<DeleteDataSetCommandInput, DeleteDataSetCommandOutput, QuickSightClientResolvedConfig> {
@@ -32,6 +32,11 @@ export interface DeleteDataSetRefreshPropertiesCommandOutput extends DeleteDataS
32
32
  * };
33
33
  * const command = new DeleteDataSetRefreshPropertiesCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DeleteDataSetRefreshPropertiesResponse
36
+ * // RequestId: "STRING_VALUE",
37
+ * // Status: Number("int"),
38
+ * // };
39
+ *
35
40
  * ```
36
41
  *
37
42
  * @param DeleteDataSetRefreshPropertiesCommandInput - {@link DeleteDataSetRefreshPropertiesCommandInput}
@@ -64,6 +69,8 @@ export interface DeleteDataSetRefreshPropertiesCommandOutput extends DeleteDataS
64
69
  * @throws {@link ThrottlingException} (client fault)
65
70
  * <p>Access is throttled.</p>
66
71
  *
72
+ * @throws {@link QuickSightServiceException}
73
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
67
74
  *
68
75
  */
69
76
  export declare class DeleteDataSetRefreshPropertiesCommand extends $Command<DeleteDataSetRefreshPropertiesCommandInput, DeleteDataSetRefreshPropertiesCommandOutput, QuickSightClientResolvedConfig> {
@@ -33,6 +33,13 @@ export interface DeleteDataSourceCommandOutput extends DeleteDataSourceResponse,
33
33
  * };
34
34
  * const command = new DeleteDataSourceCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DeleteDataSourceResponse
37
+ * // Arn: "STRING_VALUE",
38
+ * // DataSourceId: "STRING_VALUE",
39
+ * // RequestId: "STRING_VALUE",
40
+ * // Status: Number("int"),
41
+ * // };
42
+ *
36
43
  * ```
37
44
  *
38
45
  * @param DeleteDataSourceCommandInput - {@link DeleteDataSourceCommandInput}
@@ -59,6 +66,8 @@ export interface DeleteDataSourceCommandOutput extends DeleteDataSourceResponse,
59
66
  * @throws {@link ThrottlingException} (client fault)
60
67
  * <p>Access is throttled.</p>
61
68
  *
69
+ * @throws {@link QuickSightServiceException}
70
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
62
71
  *
63
72
  */
64
73
  export declare class DeleteDataSourceCommand extends $Command<DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput, QuickSightClientResolvedConfig> {