@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
@@ -32,6 +32,31 @@ export interface DescribeDashboardPermissionsCommandOutput extends DescribeDashb
32
32
  * };
33
33
  * const command = new DescribeDashboardPermissionsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeDashboardPermissionsResponse
36
+ * // DashboardId: "STRING_VALUE",
37
+ * // DashboardArn: "STRING_VALUE",
38
+ * // Permissions: [ // ResourcePermissionList
39
+ * // { // ResourcePermission
40
+ * // Principal: "STRING_VALUE", // required
41
+ * // Actions: [ // ActionList // required
42
+ * // "STRING_VALUE",
43
+ * // ],
44
+ * // },
45
+ * // ],
46
+ * // Status: Number("int"),
47
+ * // RequestId: "STRING_VALUE",
48
+ * // LinkSharingConfiguration: { // LinkSharingConfiguration
49
+ * // Permissions: [
50
+ * // {
51
+ * // Principal: "STRING_VALUE", // required
52
+ * // Actions: [ // required
53
+ * // "STRING_VALUE",
54
+ * // ],
55
+ * // },
56
+ * // ],
57
+ * // },
58
+ * // };
59
+ *
35
60
  * ```
36
61
  *
37
62
  * @param DescribeDashboardPermissionsCommandInput - {@link DescribeDashboardPermissionsCommandInput}
@@ -58,6 +83,8 @@ export interface DescribeDashboardPermissionsCommandOutput extends DescribeDashb
58
83
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
59
84
  * capability is available in every edition.</p>
60
85
  *
86
+ * @throws {@link QuickSightServiceException}
87
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
61
88
  *
62
89
  */
63
90
  export declare class DescribeDashboardPermissionsCommand extends $Command<DescribeDashboardPermissionsCommandInput, DescribeDashboardPermissionsCommandOutput, QuickSightClientResolvedConfig> {
@@ -32,6 +32,194 @@ export interface DescribeDataSetCommandOutput extends DescribeDataSetResponse, _
32
32
  * };
33
33
  * const command = new DescribeDataSetCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeDataSetResponse
36
+ * // DataSet: { // DataSet
37
+ * // Arn: "STRING_VALUE",
38
+ * // DataSetId: "STRING_VALUE",
39
+ * // Name: "STRING_VALUE",
40
+ * // CreatedTime: new Date("TIMESTAMP"),
41
+ * // LastUpdatedTime: new Date("TIMESTAMP"),
42
+ * // PhysicalTableMap: { // PhysicalTableMap
43
+ * // "<keys>": { // PhysicalTable Union: only one key present
44
+ * // RelationalTable: { // RelationalTable
45
+ * // DataSourceArn: "STRING_VALUE", // required
46
+ * // Catalog: "STRING_VALUE",
47
+ * // Schema: "STRING_VALUE",
48
+ * // Name: "STRING_VALUE", // required
49
+ * // InputColumns: [ // InputColumnList // required
50
+ * // { // InputColumn
51
+ * // Name: "STRING_VALUE", // required
52
+ * // Type: "STRING" || "INTEGER" || "DECIMAL" || "DATETIME" || "BIT" || "BOOLEAN" || "JSON", // required
53
+ * // },
54
+ * // ],
55
+ * // },
56
+ * // CustomSql: { // CustomSql
57
+ * // DataSourceArn: "STRING_VALUE", // required
58
+ * // Name: "STRING_VALUE", // required
59
+ * // SqlQuery: "STRING_VALUE", // required
60
+ * // Columns: [
61
+ * // {
62
+ * // Name: "STRING_VALUE", // required
63
+ * // Type: "STRING" || "INTEGER" || "DECIMAL" || "DATETIME" || "BIT" || "BOOLEAN" || "JSON", // required
64
+ * // },
65
+ * // ],
66
+ * // },
67
+ * // S3Source: { // S3Source
68
+ * // DataSourceArn: "STRING_VALUE", // required
69
+ * // UploadSettings: { // UploadSettings
70
+ * // Format: "CSV" || "TSV" || "CLF" || "ELF" || "XLSX" || "JSON",
71
+ * // StartFromRow: Number("int"),
72
+ * // ContainsHeader: true || false,
73
+ * // TextQualifier: "DOUBLE_QUOTE" || "SINGLE_QUOTE",
74
+ * // Delimiter: "STRING_VALUE",
75
+ * // },
76
+ * // InputColumns: [ // required
77
+ * // {
78
+ * // Name: "STRING_VALUE", // required
79
+ * // Type: "STRING" || "INTEGER" || "DECIMAL" || "DATETIME" || "BIT" || "BOOLEAN" || "JSON", // required
80
+ * // },
81
+ * // ],
82
+ * // },
83
+ * // },
84
+ * // },
85
+ * // LogicalTableMap: { // LogicalTableMap
86
+ * // "<keys>": { // LogicalTable
87
+ * // Alias: "STRING_VALUE", // required
88
+ * // DataTransforms: [ // TransformOperationList
89
+ * // { // TransformOperation Union: only one key present
90
+ * // ProjectOperation: { // ProjectOperation
91
+ * // ProjectedColumns: [ // ProjectedColumnList // required
92
+ * // "STRING_VALUE",
93
+ * // ],
94
+ * // },
95
+ * // FilterOperation: { // FilterOperation
96
+ * // ConditionExpression: "STRING_VALUE", // required
97
+ * // },
98
+ * // CreateColumnsOperation: { // CreateColumnsOperation
99
+ * // Columns: [ // CalculatedColumnList // required
100
+ * // { // CalculatedColumn
101
+ * // ColumnName: "STRING_VALUE", // required
102
+ * // ColumnId: "STRING_VALUE", // required
103
+ * // Expression: "STRING_VALUE", // required
104
+ * // },
105
+ * // ],
106
+ * // },
107
+ * // RenameColumnOperation: { // RenameColumnOperation
108
+ * // ColumnName: "STRING_VALUE", // required
109
+ * // NewColumnName: "STRING_VALUE", // required
110
+ * // },
111
+ * // CastColumnTypeOperation: { // CastColumnTypeOperation
112
+ * // ColumnName: "STRING_VALUE", // required
113
+ * // NewColumnType: "STRING" || "INTEGER" || "DECIMAL" || "DATETIME", // required
114
+ * // Format: "STRING_VALUE",
115
+ * // },
116
+ * // TagColumnOperation: { // TagColumnOperation
117
+ * // ColumnName: "STRING_VALUE", // required
118
+ * // Tags: [ // ColumnTagList // required
119
+ * // { // ColumnTag
120
+ * // ColumnGeographicRole: "COUNTRY" || "STATE" || "COUNTY" || "CITY" || "POSTCODE" || "LONGITUDE" || "LATITUDE",
121
+ * // ColumnDescription: { // ColumnDescription
122
+ * // Text: "STRING_VALUE",
123
+ * // },
124
+ * // },
125
+ * // ],
126
+ * // },
127
+ * // UntagColumnOperation: { // UntagColumnOperation
128
+ * // ColumnName: "STRING_VALUE", // required
129
+ * // TagNames: [ // ColumnTagNames // required
130
+ * // "COLUMN_GEOGRAPHIC_ROLE" || "COLUMN_DESCRIPTION",
131
+ * // ],
132
+ * // },
133
+ * // },
134
+ * // ],
135
+ * // Source: { // LogicalTableSource
136
+ * // JoinInstruction: { // JoinInstruction
137
+ * // LeftOperand: "STRING_VALUE", // required
138
+ * // RightOperand: "STRING_VALUE", // required
139
+ * // LeftJoinKeyProperties: { // JoinKeyProperties
140
+ * // UniqueKey: true || false,
141
+ * // },
142
+ * // RightJoinKeyProperties: {
143
+ * // UniqueKey: true || false,
144
+ * // },
145
+ * // Type: "INNER" || "OUTER" || "LEFT" || "RIGHT", // required
146
+ * // OnClause: "STRING_VALUE", // required
147
+ * // },
148
+ * // PhysicalTableId: "STRING_VALUE",
149
+ * // DataSetArn: "STRING_VALUE",
150
+ * // },
151
+ * // },
152
+ * // },
153
+ * // OutputColumns: [ // OutputColumnList
154
+ * // { // OutputColumn
155
+ * // Name: "STRING_VALUE",
156
+ * // Description: "STRING_VALUE",
157
+ * // Type: "STRING" || "INTEGER" || "DECIMAL" || "DATETIME",
158
+ * // },
159
+ * // ],
160
+ * // ImportMode: "SPICE" || "DIRECT_QUERY",
161
+ * // ConsumedSpiceCapacityInBytes: Number("long"),
162
+ * // ColumnGroups: [ // ColumnGroupList
163
+ * // { // ColumnGroup
164
+ * // GeoSpatialColumnGroup: { // GeoSpatialColumnGroup
165
+ * // Name: "STRING_VALUE", // required
166
+ * // CountryCode: "US",
167
+ * // Columns: [ // ColumnList // required
168
+ * // "STRING_VALUE",
169
+ * // ],
170
+ * // },
171
+ * // },
172
+ * // ],
173
+ * // FieldFolders: { // FieldFolderMap
174
+ * // "<keys>": { // FieldFolder
175
+ * // description: "STRING_VALUE",
176
+ * // columns: [ // FolderColumnList
177
+ * // "STRING_VALUE",
178
+ * // ],
179
+ * // },
180
+ * // },
181
+ * // RowLevelPermissionDataSet: { // RowLevelPermissionDataSet
182
+ * // Namespace: "STRING_VALUE",
183
+ * // Arn: "STRING_VALUE", // required
184
+ * // PermissionPolicy: "GRANT_ACCESS" || "DENY_ACCESS", // required
185
+ * // FormatVersion: "VERSION_1" || "VERSION_2",
186
+ * // Status: "ENABLED" || "DISABLED",
187
+ * // },
188
+ * // RowLevelPermissionTagConfiguration: { // RowLevelPermissionTagConfiguration
189
+ * // Status: "ENABLED" || "DISABLED",
190
+ * // TagRules: [ // RowLevelPermissionTagRuleList // required
191
+ * // { // RowLevelPermissionTagRule
192
+ * // TagKey: "STRING_VALUE", // required
193
+ * // ColumnName: "STRING_VALUE", // required
194
+ * // TagMultiValueDelimiter: "STRING_VALUE",
195
+ * // MatchAllValue: "STRING_VALUE",
196
+ * // },
197
+ * // ],
198
+ * // TagRuleConfigurations: [ // RowLevelPermissionTagRuleConfigurationList
199
+ * // [ // RowLevelPermissionTagRuleConfiguration
200
+ * // "STRING_VALUE",
201
+ * // ],
202
+ * // ],
203
+ * // },
204
+ * // ColumnLevelPermissionRules: [ // ColumnLevelPermissionRuleList
205
+ * // { // ColumnLevelPermissionRule
206
+ * // Principals: [ // PrincipalList
207
+ * // "STRING_VALUE",
208
+ * // ],
209
+ * // ColumnNames: [ // ColumnNameList
210
+ * // "STRING_VALUE",
211
+ * // ],
212
+ * // },
213
+ * // ],
214
+ * // DataSetUsageConfiguration: { // DataSetUsageConfiguration
215
+ * // DisableUseAsDirectQuerySource: true || false,
216
+ * // DisableUseAsImportedSource: true || false,
217
+ * // },
218
+ * // },
219
+ * // RequestId: "STRING_VALUE",
220
+ * // Status: Number("int"),
221
+ * // };
222
+ *
35
223
  * ```
36
224
  *
37
225
  * @param DescribeDataSetCommandInput - {@link DescribeDataSetCommandInput}
@@ -58,6 +246,8 @@ export interface DescribeDataSetCommandOutput extends DescribeDataSetResponse, _
58
246
  * @throws {@link ThrottlingException} (client fault)
59
247
  * <p>Access is throttled.</p>
60
248
  *
249
+ * @throws {@link QuickSightServiceException}
250
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
61
251
  *
62
252
  */
63
253
  export declare class DescribeDataSetCommand extends $Command<DescribeDataSetCommandInput, DescribeDataSetCommandOutput, QuickSightClientResolvedConfig> {
@@ -33,6 +33,21 @@ export interface DescribeDataSetPermissionsCommandOutput extends DescribeDataSet
33
33
  * };
34
34
  * const command = new DescribeDataSetPermissionsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeDataSetPermissionsResponse
37
+ * // DataSetArn: "STRING_VALUE",
38
+ * // DataSetId: "STRING_VALUE",
39
+ * // Permissions: [ // ResourcePermissionList
40
+ * // { // ResourcePermission
41
+ * // Principal: "STRING_VALUE", // required
42
+ * // Actions: [ // ActionList // required
43
+ * // "STRING_VALUE",
44
+ * // ],
45
+ * // },
46
+ * // ],
47
+ * // RequestId: "STRING_VALUE",
48
+ * // Status: Number("int"),
49
+ * // };
50
+ *
36
51
  * ```
37
52
  *
38
53
  * @param DescribeDataSetPermissionsCommandInput - {@link DescribeDataSetPermissionsCommandInput}
@@ -59,6 +74,8 @@ export interface DescribeDataSetPermissionsCommandOutput extends DescribeDataSet
59
74
  * @throws {@link ThrottlingException} (client fault)
60
75
  * <p>Access is throttled.</p>
61
76
  *
77
+ * @throws {@link QuickSightServiceException}
78
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
62
79
  *
63
80
  */
64
81
  export declare class DescribeDataSetPermissionsCommand extends $Command<DescribeDataSetPermissionsCommandInput, DescribeDataSetPermissionsCommandOutput, QuickSightClientResolvedConfig> {
@@ -32,6 +32,22 @@ export interface DescribeDataSetRefreshPropertiesCommandOutput extends DescribeD
32
32
  * };
33
33
  * const command = new DescribeDataSetRefreshPropertiesCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeDataSetRefreshPropertiesResponse
36
+ * // RequestId: "STRING_VALUE",
37
+ * // Status: Number("int"),
38
+ * // DataSetRefreshProperties: { // DataSetRefreshProperties
39
+ * // RefreshConfiguration: { // RefreshConfiguration
40
+ * // IncrementalRefresh: { // IncrementalRefresh
41
+ * // LookbackWindow: { // LookbackWindow
42
+ * // ColumnName: "STRING_VALUE", // required
43
+ * // Size: Number("long"), // required
44
+ * // SizeUnit: "HOUR" || "DAY" || "WEEK", // required
45
+ * // },
46
+ * // },
47
+ * // },
48
+ * // },
49
+ * // };
50
+ *
35
51
  * ```
36
52
  *
37
53
  * @param DescribeDataSetRefreshPropertiesCommandInput - {@link DescribeDataSetRefreshPropertiesCommandInput}
@@ -64,6 +80,8 @@ export interface DescribeDataSetRefreshPropertiesCommandOutput extends DescribeD
64
80
  * @throws {@link ThrottlingException} (client fault)
65
81
  * <p>Access is throttled.</p>
66
82
  *
83
+ * @throws {@link QuickSightServiceException}
84
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
67
85
  *
68
86
  */
69
87
  export declare class DescribeDataSetRefreshPropertiesCommand extends $Command<DescribeDataSetRefreshPropertiesCommandInput, DescribeDataSetRefreshPropertiesCommandOutput, QuickSightClientResolvedConfig> {
@@ -32,6 +32,243 @@ export interface DescribeDataSourceCommandOutput extends DescribeDataSourceRespo
32
32
  * };
33
33
  * const command = new DescribeDataSourceCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeDataSourceResponse
36
+ * // DataSource: { // DataSource
37
+ * // Arn: "STRING_VALUE",
38
+ * // DataSourceId: "STRING_VALUE",
39
+ * // Name: "STRING_VALUE",
40
+ * // 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",
41
+ * // Status: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETED",
42
+ * // CreatedTime: new Date("TIMESTAMP"),
43
+ * // LastUpdatedTime: new Date("TIMESTAMP"),
44
+ * // DataSourceParameters: { // DataSourceParameters Union: only one key present
45
+ * // AmazonElasticsearchParameters: { // AmazonElasticsearchParameters
46
+ * // Domain: "STRING_VALUE", // required
47
+ * // },
48
+ * // AthenaParameters: { // AthenaParameters
49
+ * // WorkGroup: "STRING_VALUE",
50
+ * // RoleArn: "STRING_VALUE",
51
+ * // },
52
+ * // AuroraParameters: { // AuroraParameters
53
+ * // Host: "STRING_VALUE", // required
54
+ * // Port: Number("int"), // required
55
+ * // Database: "STRING_VALUE", // required
56
+ * // },
57
+ * // AuroraPostgreSqlParameters: { // AuroraPostgreSqlParameters
58
+ * // Host: "STRING_VALUE", // required
59
+ * // Port: Number("int"), // required
60
+ * // Database: "STRING_VALUE", // required
61
+ * // },
62
+ * // AwsIotAnalyticsParameters: { // AwsIotAnalyticsParameters
63
+ * // DataSetName: "STRING_VALUE", // required
64
+ * // },
65
+ * // JiraParameters: { // JiraParameters
66
+ * // SiteBaseUrl: "STRING_VALUE", // required
67
+ * // },
68
+ * // MariaDbParameters: { // MariaDbParameters
69
+ * // Host: "STRING_VALUE", // required
70
+ * // Port: Number("int"), // required
71
+ * // Database: "STRING_VALUE", // required
72
+ * // },
73
+ * // MySqlParameters: { // MySqlParameters
74
+ * // Host: "STRING_VALUE", // required
75
+ * // Port: Number("int"), // required
76
+ * // Database: "STRING_VALUE", // required
77
+ * // },
78
+ * // OracleParameters: { // OracleParameters
79
+ * // Host: "STRING_VALUE", // required
80
+ * // Port: Number("int"), // required
81
+ * // Database: "STRING_VALUE", // required
82
+ * // },
83
+ * // PostgreSqlParameters: { // PostgreSqlParameters
84
+ * // Host: "STRING_VALUE", // required
85
+ * // Port: Number("int"), // required
86
+ * // Database: "STRING_VALUE", // required
87
+ * // },
88
+ * // PrestoParameters: { // PrestoParameters
89
+ * // Host: "STRING_VALUE", // required
90
+ * // Port: Number("int"), // required
91
+ * // Catalog: "STRING_VALUE", // required
92
+ * // },
93
+ * // RdsParameters: { // RdsParameters
94
+ * // InstanceId: "STRING_VALUE", // required
95
+ * // Database: "STRING_VALUE", // required
96
+ * // },
97
+ * // RedshiftParameters: { // RedshiftParameters
98
+ * // Host: "STRING_VALUE",
99
+ * // Port: Number("int"),
100
+ * // Database: "STRING_VALUE", // required
101
+ * // ClusterId: "STRING_VALUE",
102
+ * // },
103
+ * // S3Parameters: { // S3Parameters
104
+ * // ManifestFileLocation: { // ManifestFileLocation
105
+ * // Bucket: "STRING_VALUE", // required
106
+ * // Key: "STRING_VALUE", // required
107
+ * // },
108
+ * // RoleArn: "STRING_VALUE",
109
+ * // },
110
+ * // ServiceNowParameters: { // ServiceNowParameters
111
+ * // SiteBaseUrl: "STRING_VALUE", // required
112
+ * // },
113
+ * // SnowflakeParameters: { // SnowflakeParameters
114
+ * // Host: "STRING_VALUE", // required
115
+ * // Database: "STRING_VALUE", // required
116
+ * // Warehouse: "STRING_VALUE", // required
117
+ * // },
118
+ * // SparkParameters: { // SparkParameters
119
+ * // Host: "STRING_VALUE", // required
120
+ * // Port: Number("int"), // required
121
+ * // },
122
+ * // SqlServerParameters: { // SqlServerParameters
123
+ * // Host: "STRING_VALUE", // required
124
+ * // Port: Number("int"), // required
125
+ * // Database: "STRING_VALUE", // required
126
+ * // },
127
+ * // TeradataParameters: { // TeradataParameters
128
+ * // Host: "STRING_VALUE", // required
129
+ * // Port: Number("int"), // required
130
+ * // Database: "STRING_VALUE", // required
131
+ * // },
132
+ * // TwitterParameters: { // TwitterParameters
133
+ * // Query: "STRING_VALUE", // required
134
+ * // MaxRows: Number("int"), // required
135
+ * // },
136
+ * // AmazonOpenSearchParameters: { // AmazonOpenSearchParameters
137
+ * // Domain: "STRING_VALUE", // required
138
+ * // },
139
+ * // ExasolParameters: { // ExasolParameters
140
+ * // Host: "STRING_VALUE", // required
141
+ * // Port: Number("int"), // required
142
+ * // },
143
+ * // DatabricksParameters: { // DatabricksParameters
144
+ * // Host: "STRING_VALUE", // required
145
+ * // Port: Number("int"), // required
146
+ * // SqlEndpointPath: "STRING_VALUE", // required
147
+ * // },
148
+ * // },
149
+ * // AlternateDataSourceParameters: [ // DataSourceParametersList
150
+ * // {// Union: only one key present
151
+ * // AmazonElasticsearchParameters: {
152
+ * // Domain: "STRING_VALUE", // required
153
+ * // },
154
+ * // AthenaParameters: {
155
+ * // WorkGroup: "STRING_VALUE",
156
+ * // RoleArn: "STRING_VALUE",
157
+ * // },
158
+ * // AuroraParameters: {
159
+ * // Host: "STRING_VALUE", // required
160
+ * // Port: Number("int"), // required
161
+ * // Database: "STRING_VALUE", // required
162
+ * // },
163
+ * // AuroraPostgreSqlParameters: {
164
+ * // Host: "STRING_VALUE", // required
165
+ * // Port: Number("int"), // required
166
+ * // Database: "STRING_VALUE", // required
167
+ * // },
168
+ * // AwsIotAnalyticsParameters: {
169
+ * // DataSetName: "STRING_VALUE", // required
170
+ * // },
171
+ * // JiraParameters: {
172
+ * // SiteBaseUrl: "STRING_VALUE", // required
173
+ * // },
174
+ * // MariaDbParameters: {
175
+ * // Host: "STRING_VALUE", // required
176
+ * // Port: Number("int"), // required
177
+ * // Database: "STRING_VALUE", // required
178
+ * // },
179
+ * // MySqlParameters: {
180
+ * // Host: "STRING_VALUE", // required
181
+ * // Port: Number("int"), // required
182
+ * // Database: "STRING_VALUE", // required
183
+ * // },
184
+ * // OracleParameters: {
185
+ * // Host: "STRING_VALUE", // required
186
+ * // Port: Number("int"), // required
187
+ * // Database: "STRING_VALUE", // required
188
+ * // },
189
+ * // PostgreSqlParameters: {
190
+ * // Host: "STRING_VALUE", // required
191
+ * // Port: Number("int"), // required
192
+ * // Database: "STRING_VALUE", // required
193
+ * // },
194
+ * // PrestoParameters: {
195
+ * // Host: "STRING_VALUE", // required
196
+ * // Port: Number("int"), // required
197
+ * // Catalog: "STRING_VALUE", // required
198
+ * // },
199
+ * // RdsParameters: {
200
+ * // InstanceId: "STRING_VALUE", // required
201
+ * // Database: "STRING_VALUE", // required
202
+ * // },
203
+ * // RedshiftParameters: {
204
+ * // Host: "STRING_VALUE",
205
+ * // Port: Number("int"),
206
+ * // Database: "STRING_VALUE", // required
207
+ * // ClusterId: "STRING_VALUE",
208
+ * // },
209
+ * // S3Parameters: {
210
+ * // ManifestFileLocation: {
211
+ * // Bucket: "STRING_VALUE", // required
212
+ * // Key: "STRING_VALUE", // required
213
+ * // },
214
+ * // RoleArn: "STRING_VALUE",
215
+ * // },
216
+ * // ServiceNowParameters: {
217
+ * // SiteBaseUrl: "STRING_VALUE", // required
218
+ * // },
219
+ * // SnowflakeParameters: {
220
+ * // Host: "STRING_VALUE", // required
221
+ * // Database: "STRING_VALUE", // required
222
+ * // Warehouse: "STRING_VALUE", // required
223
+ * // },
224
+ * // SparkParameters: {
225
+ * // Host: "STRING_VALUE", // required
226
+ * // Port: Number("int"), // required
227
+ * // },
228
+ * // SqlServerParameters: {
229
+ * // Host: "STRING_VALUE", // required
230
+ * // Port: Number("int"), // required
231
+ * // Database: "STRING_VALUE", // required
232
+ * // },
233
+ * // TeradataParameters: {
234
+ * // Host: "STRING_VALUE", // required
235
+ * // Port: Number("int"), // required
236
+ * // Database: "STRING_VALUE", // required
237
+ * // },
238
+ * // TwitterParameters: {
239
+ * // Query: "STRING_VALUE", // required
240
+ * // MaxRows: Number("int"), // required
241
+ * // },
242
+ * // AmazonOpenSearchParameters: {
243
+ * // Domain: "STRING_VALUE", // required
244
+ * // },
245
+ * // ExasolParameters: {
246
+ * // Host: "STRING_VALUE", // required
247
+ * // Port: Number("int"), // required
248
+ * // },
249
+ * // DatabricksParameters: {
250
+ * // Host: "STRING_VALUE", // required
251
+ * // Port: Number("int"), // required
252
+ * // SqlEndpointPath: "STRING_VALUE", // required
253
+ * // },
254
+ * // },
255
+ * // ],
256
+ * // VpcConnectionProperties: { // VpcConnectionProperties
257
+ * // VpcConnectionArn: "STRING_VALUE", // required
258
+ * // },
259
+ * // SslProperties: { // SslProperties
260
+ * // DisableSsl: true || false,
261
+ * // },
262
+ * // ErrorInfo: { // DataSourceErrorInfo
263
+ * // Type: "ACCESS_DENIED" || "COPY_SOURCE_NOT_FOUND" || "TIMEOUT" || "ENGINE_VERSION_NOT_SUPPORTED" || "UNKNOWN_HOST" || "GENERIC_SQL_FAILURE" || "CONFLICT" || "UNKNOWN",
264
+ * // Message: "STRING_VALUE",
265
+ * // },
266
+ * // SecretArn: "STRING_VALUE",
267
+ * // },
268
+ * // RequestId: "STRING_VALUE",
269
+ * // Status: Number("int"),
270
+ * // };
271
+ *
35
272
  * ```
36
273
  *
37
274
  * @param DescribeDataSourceCommandInput - {@link DescribeDataSourceCommandInput}
@@ -58,6 +295,8 @@ export interface DescribeDataSourceCommandOutput extends DescribeDataSourceRespo
58
295
  * @throws {@link ThrottlingException} (client fault)
59
296
  * <p>Access is throttled.</p>
60
297
  *
298
+ * @throws {@link QuickSightServiceException}
299
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
61
300
  *
62
301
  */
63
302
  export declare class DescribeDataSourceCommand extends $Command<DescribeDataSourceCommandInput, DescribeDataSourceCommandOutput, QuickSightClientResolvedConfig> {
@@ -32,6 +32,21 @@ export interface DescribeDataSourcePermissionsCommandOutput extends DescribeData
32
32
  * };
33
33
  * const command = new DescribeDataSourcePermissionsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeDataSourcePermissionsResponse
36
+ * // DataSourceArn: "STRING_VALUE",
37
+ * // DataSourceId: "STRING_VALUE",
38
+ * // Permissions: [ // ResourcePermissionList
39
+ * // { // ResourcePermission
40
+ * // Principal: "STRING_VALUE", // required
41
+ * // Actions: [ // ActionList // required
42
+ * // "STRING_VALUE",
43
+ * // ],
44
+ * // },
45
+ * // ],
46
+ * // RequestId: "STRING_VALUE",
47
+ * // Status: Number("int"),
48
+ * // };
49
+ *
35
50
  * ```
36
51
  *
37
52
  * @param DescribeDataSourcePermissionsCommandInput - {@link DescribeDataSourcePermissionsCommandInput}
@@ -58,6 +73,8 @@ export interface DescribeDataSourcePermissionsCommandOutput extends DescribeData
58
73
  * @throws {@link ThrottlingException} (client fault)
59
74
  * <p>Access is throttled.</p>
60
75
  *
76
+ * @throws {@link QuickSightServiceException}
77
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
61
78
  *
62
79
  */
63
80
  export declare class DescribeDataSourcePermissionsCommand extends $Command<DescribeDataSourcePermissionsCommandInput, DescribeDataSourcePermissionsCommandOutput, QuickSightClientResolvedConfig> {
@@ -32,6 +32,22 @@ export interface DescribeFolderCommandOutput extends DescribeFolderResponse, __M
32
32
  * };
33
33
  * const command = new DescribeFolderCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeFolderResponse
36
+ * // Status: Number("int"),
37
+ * // Folder: { // Folder
38
+ * // FolderId: "STRING_VALUE",
39
+ * // Arn: "STRING_VALUE",
40
+ * // Name: "STRING_VALUE",
41
+ * // FolderType: "SHARED",
42
+ * // FolderPath: [ // Path
43
+ * // "STRING_VALUE",
44
+ * // ],
45
+ * // CreatedTime: new Date("TIMESTAMP"),
46
+ * // LastUpdatedTime: new Date("TIMESTAMP"),
47
+ * // },
48
+ * // RequestId: "STRING_VALUE",
49
+ * // };
50
+ *
35
51
  * ```
36
52
  *
37
53
  * @param DescribeFolderCommandInput - {@link DescribeFolderCommandInput}
@@ -64,6 +80,8 @@ export interface DescribeFolderCommandOutput extends DescribeFolderResponse, __M
64
80
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
65
81
  * capability is available in every edition.</p>
66
82
  *
83
+ * @throws {@link QuickSightServiceException}
84
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
67
85
  *
68
86
  */
69
87
  export declare class DescribeFolderCommand extends $Command<DescribeFolderCommandInput, DescribeFolderCommandOutput, QuickSightClientResolvedConfig> {
@@ -32,6 +32,21 @@ export interface DescribeFolderPermissionsCommandOutput extends DescribeFolderPe
32
32
  * };
33
33
  * const command = new DescribeFolderPermissionsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeFolderPermissionsResponse
36
+ * // Status: Number("int"),
37
+ * // FolderId: "STRING_VALUE",
38
+ * // Arn: "STRING_VALUE",
39
+ * // Permissions: [ // ResourcePermissionList
40
+ * // { // ResourcePermission
41
+ * // Principal: "STRING_VALUE", // required
42
+ * // Actions: [ // ActionList // required
43
+ * // "STRING_VALUE",
44
+ * // ],
45
+ * // },
46
+ * // ],
47
+ * // RequestId: "STRING_VALUE",
48
+ * // };
49
+ *
35
50
  * ```
36
51
  *
37
52
  * @param DescribeFolderPermissionsCommandInput - {@link DescribeFolderPermissionsCommandInput}
@@ -64,6 +79,8 @@ export interface DescribeFolderPermissionsCommandOutput extends DescribeFolderPe
64
79
  * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
65
80
  * capability is available in every edition.</p>
66
81
  *
82
+ * @throws {@link QuickSightServiceException}
83
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
67
84
  *
68
85
  */
69
86
  export declare class DescribeFolderPermissionsCommand extends $Command<DescribeFolderPermissionsCommandInput, DescribeFolderPermissionsCommandOutput, QuickSightClientResolvedConfig> {