@aws-sdk/client-quicksight 3.315.0 → 3.319.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.
- package/dist-cjs/QuickSight.js +138 -1876
- package/dist-es/QuickSight.js +138 -1876
- package/dist-types/QuickSight.d.ts +145 -693
- package/dist-types/ts3.4/QuickSight.d.ts +4 -1
- package/package.json +8 -8
|
@@ -134,1367 +134,819 @@ import { UpdateThemeCommandInput, UpdateThemeCommandOutput } from "./commands/Up
|
|
|
134
134
|
import { UpdateThemePermissionsCommandInput, UpdateThemePermissionsCommandOutput } from "./commands/UpdateThemePermissionsCommand";
|
|
135
135
|
import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
|
|
136
136
|
import { QuickSightClient } from "./QuickSightClient";
|
|
137
|
-
|
|
138
|
-
* @public
|
|
139
|
-
* <fullname>Amazon QuickSight API Reference</fullname>
|
|
140
|
-
* <p>Amazon QuickSight is a fully managed, serverless business intelligence service for the
|
|
141
|
-
* Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your
|
|
142
|
-
* organization. This API reference contains documentation for a programming interface that
|
|
143
|
-
* you can use to manage Amazon QuickSight. </p>
|
|
144
|
-
*/
|
|
145
|
-
export declare class QuickSight extends QuickSightClient {
|
|
137
|
+
export interface QuickSight {
|
|
146
138
|
/**
|
|
147
|
-
* @
|
|
148
|
-
* <p>Cancels an ongoing ingestion of data into SPICE.</p>
|
|
139
|
+
* @see {@link CancelIngestionCommand}
|
|
149
140
|
*/
|
|
150
141
|
cancelIngestion(args: CancelIngestionCommandInput, options?: __HttpHandlerOptions): Promise<CancelIngestionCommandOutput>;
|
|
151
142
|
cancelIngestion(args: CancelIngestionCommandInput, cb: (err: any, data?: CancelIngestionCommandOutput) => void): void;
|
|
152
143
|
cancelIngestion(args: CancelIngestionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelIngestionCommandOutput) => void): void;
|
|
153
144
|
/**
|
|
154
|
-
* @
|
|
155
|
-
* <p>Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the
|
|
156
|
-
* <code>CreateAccountCustomization</code> or <code>UpdateAccountCustomization</code>
|
|
157
|
-
* API operation. To further customize Amazon QuickSight by removing Amazon QuickSight
|
|
158
|
-
* sample assets and videos for all new users, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html">Customizing Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide.</i>
|
|
159
|
-
* </p>
|
|
160
|
-
* <p>You can create customizations for your Amazon Web Services account or, if you specify a namespace, for
|
|
161
|
-
* a QuickSight namespace instead. Customizations that apply to a namespace always override
|
|
162
|
-
* customizations that apply to an Amazon Web Services account. To find out which customizations apply, use
|
|
163
|
-
* the <code>DescribeAccountCustomization</code> API operation.</p>
|
|
164
|
-
* <p>Before you use the <code>CreateAccountCustomization</code> API operation to add a theme
|
|
165
|
-
* as the namespace default, make sure that you first share the theme with the namespace.
|
|
166
|
-
* If you don't share it with the namespace, the theme isn't visible to your users
|
|
167
|
-
* even if you make it the default theme.
|
|
168
|
-
* To check if the theme is shared, view the current permissions by using the
|
|
169
|
-
* <code>
|
|
170
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeThemePermissions.html">DescribeThemePermissions</a>
|
|
171
|
-
* </code>
|
|
172
|
-
* API operation.
|
|
173
|
-
* To share the theme, grant permissions by using the
|
|
174
|
-
* <code>
|
|
175
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateThemePermissions.html">UpdateThemePermissions</a>
|
|
176
|
-
* </code>
|
|
177
|
-
* API operation. </p>
|
|
145
|
+
* @see {@link CreateAccountCustomizationCommand}
|
|
178
146
|
*/
|
|
179
147
|
createAccountCustomization(args: CreateAccountCustomizationCommandInput, options?: __HttpHandlerOptions): Promise<CreateAccountCustomizationCommandOutput>;
|
|
180
148
|
createAccountCustomization(args: CreateAccountCustomizationCommandInput, cb: (err: any, data?: CreateAccountCustomizationCommandOutput) => void): void;
|
|
181
149
|
createAccountCustomization(args: CreateAccountCustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccountCustomizationCommandOutput) => void): void;
|
|
182
150
|
/**
|
|
183
|
-
* @
|
|
184
|
-
* <p>Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.</p>
|
|
185
|
-
* <p>The Amazon Web Services Region for the account is derived from what is configured in the
|
|
186
|
-
* CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia
|
|
187
|
-
* Pacific (Singapore) Region. </p>
|
|
188
|
-
* <p>Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/setting-up-aws-sign-up.html">Sign
|
|
189
|
-
* up for Amazon Web Services</a> in the <i>Amazon QuickSight User
|
|
190
|
-
* Guide</i>. The person who signs up for Amazon QuickSight needs to have the
|
|
191
|
-
* correct Identity and Access Management (IAM) permissions. For more information,
|
|
192
|
-
* see <a href="https://docs.aws.amazon.com/quicksight/latest/user/iam-policy-examples.html">IAM Policy Examples for Amazon QuickSight</a> in the
|
|
193
|
-
* <i>Amazon QuickSight User Guide</i>.</p>
|
|
194
|
-
* <p>If your IAM policy includes both the <code>Subscribe</code> and
|
|
195
|
-
* <code>CreateAccountSubscription</code> actions, make sure that both actions are set
|
|
196
|
-
* to <code>Allow</code>. If either action is set to <code>Deny</code>, the
|
|
197
|
-
* <code>Deny</code> action prevails and your API call fails.</p>
|
|
198
|
-
* <p>You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to
|
|
199
|
-
* Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html#security-create-iam-role">Passing IAM roles to Amazon QuickSight</a> in the
|
|
200
|
-
* <i>Amazon QuickSight User Guide</i>.</p>
|
|
201
|
-
* <p>You can't set default resource access on the new account from the Amazon QuickSight
|
|
202
|
-
* API. Instead, add default resource access from the Amazon QuickSight console. For more
|
|
203
|
-
* information about setting default resource access to Amazon Web Services services, see
|
|
204
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/scoping-policies-defaults.html">Setting default resource
|
|
205
|
-
* access to Amazon Web Services services</a> in the <i>Amazon QuickSight
|
|
206
|
-
* User Guide</i>.</p>
|
|
151
|
+
* @see {@link CreateAccountSubscriptionCommand}
|
|
207
152
|
*/
|
|
208
153
|
createAccountSubscription(args: CreateAccountSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<CreateAccountSubscriptionCommandOutput>;
|
|
209
154
|
createAccountSubscription(args: CreateAccountSubscriptionCommandInput, cb: (err: any, data?: CreateAccountSubscriptionCommandOutput) => void): void;
|
|
210
155
|
createAccountSubscription(args: CreateAccountSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccountSubscriptionCommandOutput) => void): void;
|
|
211
156
|
/**
|
|
212
|
-
* @
|
|
213
|
-
* <p>Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an <code>AnalysisDefinition</code>.</p>
|
|
157
|
+
* @see {@link CreateAnalysisCommand}
|
|
214
158
|
*/
|
|
215
159
|
createAnalysis(args: CreateAnalysisCommandInput, options?: __HttpHandlerOptions): Promise<CreateAnalysisCommandOutput>;
|
|
216
160
|
createAnalysis(args: CreateAnalysisCommandInput, cb: (err: any, data?: CreateAnalysisCommandOutput) => void): void;
|
|
217
161
|
createAnalysis(args: CreateAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAnalysisCommandOutput) => void): void;
|
|
218
162
|
/**
|
|
219
|
-
* @
|
|
220
|
-
* <p>Creates a dashboard from either a template or directly with a <code>DashboardDefinition</code>. To first create a template, see the
|
|
221
|
-
* <code>
|
|
222
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>
|
|
223
|
-
* </code>
|
|
224
|
-
* API operation.</p>
|
|
225
|
-
* <p>A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created
|
|
226
|
-
* from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can
|
|
227
|
-
* create scheduled email reports from them. If you have the correct permissions, you can
|
|
228
|
-
* create a dashboard from a template that exists in a different Amazon Web Services account.</p>
|
|
163
|
+
* @see {@link CreateDashboardCommand}
|
|
229
164
|
*/
|
|
230
165
|
createDashboard(args: CreateDashboardCommandInput, options?: __HttpHandlerOptions): Promise<CreateDashboardCommandOutput>;
|
|
231
166
|
createDashboard(args: CreateDashboardCommandInput, cb: (err: any, data?: CreateDashboardCommandOutput) => void): void;
|
|
232
167
|
createDashboard(args: CreateDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDashboardCommandOutput) => void): void;
|
|
233
168
|
/**
|
|
234
|
-
* @
|
|
235
|
-
* <p>Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.</p>
|
|
169
|
+
* @see {@link CreateDataSetCommand}
|
|
236
170
|
*/
|
|
237
171
|
createDataSet(args: CreateDataSetCommandInput, options?: __HttpHandlerOptions): Promise<CreateDataSetCommandOutput>;
|
|
238
172
|
createDataSet(args: CreateDataSetCommandInput, cb: (err: any, data?: CreateDataSetCommandOutput) => void): void;
|
|
239
173
|
createDataSet(args: CreateDataSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataSetCommandOutput) => void): void;
|
|
240
174
|
/**
|
|
241
|
-
* @
|
|
242
|
-
* <p>Creates a data source.</p>
|
|
175
|
+
* @see {@link CreateDataSourceCommand}
|
|
243
176
|
*/
|
|
244
177
|
createDataSource(args: CreateDataSourceCommandInput, options?: __HttpHandlerOptions): Promise<CreateDataSourceCommandOutput>;
|
|
245
178
|
createDataSource(args: CreateDataSourceCommandInput, cb: (err: any, data?: CreateDataSourceCommandOutput) => void): void;
|
|
246
179
|
createDataSource(args: CreateDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataSourceCommandOutput) => void): void;
|
|
247
180
|
/**
|
|
248
|
-
* @
|
|
249
|
-
* <p>Creates an empty shared folder.</p>
|
|
181
|
+
* @see {@link CreateFolderCommand}
|
|
250
182
|
*/
|
|
251
183
|
createFolder(args: CreateFolderCommandInput, options?: __HttpHandlerOptions): Promise<CreateFolderCommandOutput>;
|
|
252
184
|
createFolder(args: CreateFolderCommandInput, cb: (err: any, data?: CreateFolderCommandOutput) => void): void;
|
|
253
185
|
createFolder(args: CreateFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFolderCommandOutput) => void): void;
|
|
254
186
|
/**
|
|
255
|
-
* @
|
|
256
|
-
* <p>Adds an asset, such as a dashboard, analysis, or dataset into a folder.</p>
|
|
187
|
+
* @see {@link CreateFolderMembershipCommand}
|
|
257
188
|
*/
|
|
258
189
|
createFolderMembership(args: CreateFolderMembershipCommandInput, options?: __HttpHandlerOptions): Promise<CreateFolderMembershipCommandOutput>;
|
|
259
190
|
createFolderMembership(args: CreateFolderMembershipCommandInput, cb: (err: any, data?: CreateFolderMembershipCommandOutput) => void): void;
|
|
260
191
|
createFolderMembership(args: CreateFolderMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFolderMembershipCommandOutput) => void): void;
|
|
261
192
|
/**
|
|
262
|
-
* @
|
|
263
|
-
* <p>Use the <code>CreateGroup</code> operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact AWS Support.</p>
|
|
264
|
-
* <p>The permissions resource is
|
|
265
|
-
* <code>arn:aws:quicksight:<your-region>:<i><relevant-aws-account-id></i>:group/default/<i><group-name></i>
|
|
266
|
-
* </code>.</p>
|
|
267
|
-
* <p>The response is a group object.</p>
|
|
193
|
+
* @see {@link CreateGroupCommand}
|
|
268
194
|
*/
|
|
269
195
|
createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateGroupCommandOutput>;
|
|
270
196
|
createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void;
|
|
271
197
|
createGroup(args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void): void;
|
|
272
198
|
/**
|
|
273
|
-
* @
|
|
274
|
-
* <p>Adds an Amazon QuickSight user to an Amazon QuickSight group. </p>
|
|
199
|
+
* @see {@link CreateGroupMembershipCommand}
|
|
275
200
|
*/
|
|
276
201
|
createGroupMembership(args: CreateGroupMembershipCommandInput, options?: __HttpHandlerOptions): Promise<CreateGroupMembershipCommandOutput>;
|
|
277
202
|
createGroupMembership(args: CreateGroupMembershipCommandInput, cb: (err: any, data?: CreateGroupMembershipCommandOutput) => void): void;
|
|
278
203
|
createGroupMembership(args: CreateGroupMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupMembershipCommandOutput) => void): void;
|
|
279
204
|
/**
|
|
280
|
-
* @
|
|
281
|
-
* <p>Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name
|
|
282
|
-
* (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight.
|
|
283
|
-
* Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces,
|
|
284
|
-
* use assignment names that are unique.</p>
|
|
205
|
+
* @see {@link CreateIAMPolicyAssignmentCommand}
|
|
285
206
|
*/
|
|
286
207
|
createIAMPolicyAssignment(args: CreateIAMPolicyAssignmentCommandInput, options?: __HttpHandlerOptions): Promise<CreateIAMPolicyAssignmentCommandOutput>;
|
|
287
208
|
createIAMPolicyAssignment(args: CreateIAMPolicyAssignmentCommandInput, cb: (err: any, data?: CreateIAMPolicyAssignmentCommandOutput) => void): void;
|
|
288
209
|
createIAMPolicyAssignment(args: CreateIAMPolicyAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIAMPolicyAssignmentCommandOutput) => void): void;
|
|
289
210
|
/**
|
|
290
|
-
* @
|
|
291
|
-
* <p>Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in
|
|
292
|
-
* an Enterprise edition account 32 times in a 24-hour period. You can manually refresh
|
|
293
|
-
* datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period
|
|
294
|
-
* is measured starting 24 hours before the current date and time.</p>
|
|
295
|
-
* <p>Any ingestions operating on tagged datasets inherit the same tags automatically for use in
|
|
296
|
-
* access control. For an example, see <a href="http://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/">How do I create an IAM policy to control access to Amazon EC2 resources using
|
|
297
|
-
* tags?</a> in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.</p>
|
|
211
|
+
* @see {@link CreateIngestionCommand}
|
|
298
212
|
*/
|
|
299
213
|
createIngestion(args: CreateIngestionCommandInput, options?: __HttpHandlerOptions): Promise<CreateIngestionCommandOutput>;
|
|
300
214
|
createIngestion(args: CreateIngestionCommandInput, cb: (err: any, data?: CreateIngestionCommandOutput) => void): void;
|
|
301
215
|
createIngestion(args: CreateIngestionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIngestionCommandOutput) => void): void;
|
|
302
216
|
/**
|
|
303
|
-
* @
|
|
304
|
-
* <p>(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.</p>
|
|
305
|
-
* <p>A namespace allows you to isolate the Amazon QuickSight users and groups that are registered
|
|
306
|
-
* for that namespace. Users that access the namespace can share assets only with other
|
|
307
|
-
* users or groups in the same namespace. They can't see users and groups in other
|
|
308
|
-
* namespaces. You can create a namespace after your Amazon Web Services account is subscribed to
|
|
309
|
-
* Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a
|
|
310
|
-
* limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with
|
|
311
|
-
* Amazon Web Services Support. </p>
|
|
217
|
+
* @see {@link CreateNamespaceCommand}
|
|
312
218
|
*/
|
|
313
219
|
createNamespace(args: CreateNamespaceCommandInput, options?: __HttpHandlerOptions): Promise<CreateNamespaceCommandOutput>;
|
|
314
220
|
createNamespace(args: CreateNamespaceCommandInput, cb: (err: any, data?: CreateNamespaceCommandOutput) => void): void;
|
|
315
221
|
createNamespace(args: CreateNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNamespaceCommandOutput) => void): void;
|
|
316
222
|
/**
|
|
317
|
-
* @
|
|
318
|
-
* <p>Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.</p>
|
|
223
|
+
* @see {@link CreateRefreshScheduleCommand}
|
|
319
224
|
*/
|
|
320
225
|
createRefreshSchedule(args: CreateRefreshScheduleCommandInput, options?: __HttpHandlerOptions): Promise<CreateRefreshScheduleCommandOutput>;
|
|
321
226
|
createRefreshSchedule(args: CreateRefreshScheduleCommandInput, cb: (err: any, data?: CreateRefreshScheduleCommandOutput) => void): void;
|
|
322
227
|
createRefreshSchedule(args: CreateRefreshScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRefreshScheduleCommandOutput) => void): void;
|
|
323
228
|
/**
|
|
324
|
-
* @
|
|
325
|
-
* <p>Creates a template either from a <code>TemplateDefinition</code> or from an existing Amazon QuickSight analysis or template. You can use the resulting
|
|
326
|
-
* template to create additional dashboards, templates, or analyses.</p>
|
|
327
|
-
* <p>A <i>template</i> is an entity in Amazon QuickSight that encapsulates the metadata
|
|
328
|
-
* required to create an analysis and that you can use to create s dashboard. A template adds
|
|
329
|
-
* a layer of abstraction by using placeholders to replace the dataset associated with the
|
|
330
|
-
* analysis. You can use templates to create dashboards by replacing dataset placeholders
|
|
331
|
-
* with datasets that follow the same schema that was used to create the source analysis
|
|
332
|
-
* and template.</p>
|
|
229
|
+
* @see {@link CreateTemplateCommand}
|
|
333
230
|
*/
|
|
334
231
|
createTemplate(args: CreateTemplateCommandInput, options?: __HttpHandlerOptions): Promise<CreateTemplateCommandOutput>;
|
|
335
232
|
createTemplate(args: CreateTemplateCommandInput, cb: (err: any, data?: CreateTemplateCommandOutput) => void): void;
|
|
336
233
|
createTemplate(args: CreateTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTemplateCommandOutput) => void): void;
|
|
337
234
|
/**
|
|
338
|
-
* @
|
|
339
|
-
* <p>Creates a template alias for a template.</p>
|
|
235
|
+
* @see {@link CreateTemplateAliasCommand}
|
|
340
236
|
*/
|
|
341
237
|
createTemplateAlias(args: CreateTemplateAliasCommandInput, options?: __HttpHandlerOptions): Promise<CreateTemplateAliasCommandOutput>;
|
|
342
238
|
createTemplateAlias(args: CreateTemplateAliasCommandInput, cb: (err: any, data?: CreateTemplateAliasCommandOutput) => void): void;
|
|
343
239
|
createTemplateAlias(args: CreateTemplateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTemplateAliasCommandOutput) => void): void;
|
|
344
240
|
/**
|
|
345
|
-
* @
|
|
346
|
-
* <p>Creates a theme.</p>
|
|
347
|
-
* <p>A <i>theme</i> is set of configuration options for color and layout.
|
|
348
|
-
* Themes apply to analyses and dashboards. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html">Using
|
|
349
|
-
* Themes in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
241
|
+
* @see {@link CreateThemeCommand}
|
|
350
242
|
*/
|
|
351
243
|
createTheme(args: CreateThemeCommandInput, options?: __HttpHandlerOptions): Promise<CreateThemeCommandOutput>;
|
|
352
244
|
createTheme(args: CreateThemeCommandInput, cb: (err: any, data?: CreateThemeCommandOutput) => void): void;
|
|
353
245
|
createTheme(args: CreateThemeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateThemeCommandOutput) => void): void;
|
|
354
246
|
/**
|
|
355
|
-
* @
|
|
356
|
-
* <p>Creates a theme alias for a theme.</p>
|
|
247
|
+
* @see {@link CreateThemeAliasCommand}
|
|
357
248
|
*/
|
|
358
249
|
createThemeAlias(args: CreateThemeAliasCommandInput, options?: __HttpHandlerOptions): Promise<CreateThemeAliasCommandOutput>;
|
|
359
250
|
createThemeAlias(args: CreateThemeAliasCommandInput, cb: (err: any, data?: CreateThemeAliasCommandOutput) => void): void;
|
|
360
251
|
createThemeAlias(args: CreateThemeAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateThemeAliasCommandOutput) => void): void;
|
|
361
252
|
/**
|
|
362
|
-
* @
|
|
363
|
-
* <p>Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified
|
|
364
|
-
* Amazon Web Services account and Amazon QuickSight namespace.</p>
|
|
253
|
+
* @see {@link DeleteAccountCustomizationCommand}
|
|
365
254
|
*/
|
|
366
255
|
deleteAccountCustomization(args: DeleteAccountCustomizationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAccountCustomizationCommandOutput>;
|
|
367
256
|
deleteAccountCustomization(args: DeleteAccountCustomizationCommandInput, cb: (err: any, data?: DeleteAccountCustomizationCommandOutput) => void): void;
|
|
368
257
|
deleteAccountCustomization(args: DeleteAccountCustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccountCustomizationCommandOutput) => void): void;
|
|
369
258
|
/**
|
|
370
|
-
* @
|
|
371
|
-
* <p>Use the <code>DeleteAccountSubscription</code> operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to <code>True</code>. To change this setting and delete your account, call the <code>UpdateAccountSettings</code> API and set the value of the <code>TerminationProtectionEnabled</code> parameter to <code>False</code>, then make another call to the <code>DeleteAccountSubscription</code> API.</p>
|
|
259
|
+
* @see {@link DeleteAccountSubscriptionCommand}
|
|
372
260
|
*/
|
|
373
261
|
deleteAccountSubscription(args: DeleteAccountSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAccountSubscriptionCommandOutput>;
|
|
374
262
|
deleteAccountSubscription(args: DeleteAccountSubscriptionCommandInput, cb: (err: any, data?: DeleteAccountSubscriptionCommandOutput) => void): void;
|
|
375
263
|
deleteAccountSubscription(args: DeleteAccountSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccountSubscriptionCommandOutput) => void): void;
|
|
376
264
|
/**
|
|
377
|
-
* @
|
|
378
|
-
* <p>Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during
|
|
379
|
-
* which you can restore the analysis. If you don't specify a recovery window value, the
|
|
380
|
-
* operation defaults to 30 days. Amazon QuickSight attaches a <code>DeletionTime</code> stamp to
|
|
381
|
-
* the response that specifies the end of the recovery window. At the end of the recovery
|
|
382
|
-
* window, Amazon QuickSight deletes the analysis permanently.</p>
|
|
383
|
-
* <p>At any time before recovery window ends, you can use the <code>RestoreAnalysis</code>
|
|
384
|
-
* API operation to remove the <code>DeletionTime</code> stamp and cancel the deletion of
|
|
385
|
-
* the analysis. The analysis remains visible in the API until it's deleted, so you can
|
|
386
|
-
* describe it but you can't make a template from it.</p>
|
|
387
|
-
* <p>An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console.
|
|
388
|
-
* To access it in the console, restore it. Deleting an analysis doesn't delete the
|
|
389
|
-
* dashboards that you publish from it.</p>
|
|
265
|
+
* @see {@link DeleteAnalysisCommand}
|
|
390
266
|
*/
|
|
391
267
|
deleteAnalysis(args: DeleteAnalysisCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAnalysisCommandOutput>;
|
|
392
268
|
deleteAnalysis(args: DeleteAnalysisCommandInput, cb: (err: any, data?: DeleteAnalysisCommandOutput) => void): void;
|
|
393
269
|
deleteAnalysis(args: DeleteAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAnalysisCommandOutput) => void): void;
|
|
394
270
|
/**
|
|
395
|
-
* @
|
|
396
|
-
* <p>Deletes a dashboard.</p>
|
|
271
|
+
* @see {@link DeleteDashboardCommand}
|
|
397
272
|
*/
|
|
398
273
|
deleteDashboard(args: DeleteDashboardCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDashboardCommandOutput>;
|
|
399
274
|
deleteDashboard(args: DeleteDashboardCommandInput, cb: (err: any, data?: DeleteDashboardCommandOutput) => void): void;
|
|
400
275
|
deleteDashboard(args: DeleteDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDashboardCommandOutput) => void): void;
|
|
401
276
|
/**
|
|
402
|
-
* @
|
|
403
|
-
* <p>Deletes a dataset.</p>
|
|
277
|
+
* @see {@link DeleteDataSetCommand}
|
|
404
278
|
*/
|
|
405
279
|
deleteDataSet(args: DeleteDataSetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDataSetCommandOutput>;
|
|
406
280
|
deleteDataSet(args: DeleteDataSetCommandInput, cb: (err: any, data?: DeleteDataSetCommandOutput) => void): void;
|
|
407
281
|
deleteDataSet(args: DeleteDataSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataSetCommandOutput) => void): void;
|
|
408
282
|
/**
|
|
409
|
-
* @
|
|
410
|
-
* <p>Deletes the dataset refresh properties of the dataset.</p>
|
|
283
|
+
* @see {@link DeleteDataSetRefreshPropertiesCommand}
|
|
411
284
|
*/
|
|
412
285
|
deleteDataSetRefreshProperties(args: DeleteDataSetRefreshPropertiesCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDataSetRefreshPropertiesCommandOutput>;
|
|
413
286
|
deleteDataSetRefreshProperties(args: DeleteDataSetRefreshPropertiesCommandInput, cb: (err: any, data?: DeleteDataSetRefreshPropertiesCommandOutput) => void): void;
|
|
414
287
|
deleteDataSetRefreshProperties(args: DeleteDataSetRefreshPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataSetRefreshPropertiesCommandOutput) => void): void;
|
|
415
288
|
/**
|
|
416
|
-
* @
|
|
417
|
-
* <p>Deletes the data source permanently. This operation breaks
|
|
418
|
-
* all the datasets that reference the deleted data source.</p>
|
|
289
|
+
* @see {@link DeleteDataSourceCommand}
|
|
419
290
|
*/
|
|
420
291
|
deleteDataSource(args: DeleteDataSourceCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDataSourceCommandOutput>;
|
|
421
292
|
deleteDataSource(args: DeleteDataSourceCommandInput, cb: (err: any, data?: DeleteDataSourceCommandOutput) => void): void;
|
|
422
293
|
deleteDataSource(args: DeleteDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataSourceCommandOutput) => void): void;
|
|
423
294
|
/**
|
|
424
|
-
* @
|
|
425
|
-
* <p>Deletes an empty folder.</p>
|
|
295
|
+
* @see {@link DeleteFolderCommand}
|
|
426
296
|
*/
|
|
427
297
|
deleteFolder(args: DeleteFolderCommandInput, options?: __HttpHandlerOptions): Promise<DeleteFolderCommandOutput>;
|
|
428
298
|
deleteFolder(args: DeleteFolderCommandInput, cb: (err: any, data?: DeleteFolderCommandOutput) => void): void;
|
|
429
299
|
deleteFolder(args: DeleteFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFolderCommandOutput) => void): void;
|
|
430
300
|
/**
|
|
431
|
-
* @
|
|
432
|
-
* <p>Removes an asset, such as a dashboard, analysis, or dataset, from a folder.</p>
|
|
301
|
+
* @see {@link DeleteFolderMembershipCommand}
|
|
433
302
|
*/
|
|
434
303
|
deleteFolderMembership(args: DeleteFolderMembershipCommandInput, options?: __HttpHandlerOptions): Promise<DeleteFolderMembershipCommandOutput>;
|
|
435
304
|
deleteFolderMembership(args: DeleteFolderMembershipCommandInput, cb: (err: any, data?: DeleteFolderMembershipCommandOutput) => void): void;
|
|
436
305
|
deleteFolderMembership(args: DeleteFolderMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFolderMembershipCommandOutput) => void): void;
|
|
437
306
|
/**
|
|
438
|
-
* @
|
|
439
|
-
* <p>Removes a user group from Amazon QuickSight. </p>
|
|
307
|
+
* @see {@link DeleteGroupCommand}
|
|
440
308
|
*/
|
|
441
309
|
deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGroupCommandOutput>;
|
|
442
310
|
deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
|
|
443
311
|
deleteGroup(args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
|
|
444
312
|
/**
|
|
445
|
-
* @
|
|
446
|
-
* <p>Removes a user from a group so that the user is no longer a member of the group.</p>
|
|
313
|
+
* @see {@link DeleteGroupMembershipCommand}
|
|
447
314
|
*/
|
|
448
315
|
deleteGroupMembership(args: DeleteGroupMembershipCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGroupMembershipCommandOutput>;
|
|
449
316
|
deleteGroupMembership(args: DeleteGroupMembershipCommandInput, cb: (err: any, data?: DeleteGroupMembershipCommandOutput) => void): void;
|
|
450
317
|
deleteGroupMembership(args: DeleteGroupMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupMembershipCommandOutput) => void): void;
|
|
451
318
|
/**
|
|
452
|
-
* @
|
|
453
|
-
* <p>Deletes an existing IAM policy assignment.</p>
|
|
319
|
+
* @see {@link DeleteIAMPolicyAssignmentCommand}
|
|
454
320
|
*/
|
|
455
321
|
deleteIAMPolicyAssignment(args: DeleteIAMPolicyAssignmentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteIAMPolicyAssignmentCommandOutput>;
|
|
456
322
|
deleteIAMPolicyAssignment(args: DeleteIAMPolicyAssignmentCommandInput, cb: (err: any, data?: DeleteIAMPolicyAssignmentCommandOutput) => void): void;
|
|
457
323
|
deleteIAMPolicyAssignment(args: DeleteIAMPolicyAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIAMPolicyAssignmentCommandOutput) => void): void;
|
|
458
324
|
/**
|
|
459
|
-
* @
|
|
460
|
-
* <p>Deletes a namespace and the users and groups that are associated with the namespace.
|
|
461
|
-
* This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not
|
|
462
|
-
* deleted. To delete these assets, you use the API operations for the relevant asset. </p>
|
|
325
|
+
* @see {@link DeleteNamespaceCommand}
|
|
463
326
|
*/
|
|
464
327
|
deleteNamespace(args: DeleteNamespaceCommandInput, options?: __HttpHandlerOptions): Promise<DeleteNamespaceCommandOutput>;
|
|
465
328
|
deleteNamespace(args: DeleteNamespaceCommandInput, cb: (err: any, data?: DeleteNamespaceCommandOutput) => void): void;
|
|
466
329
|
deleteNamespace(args: DeleteNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNamespaceCommandOutput) => void): void;
|
|
467
330
|
/**
|
|
468
|
-
* @
|
|
469
|
-
* <p>Deletes a refresh schedule from a dataset.</p>
|
|
331
|
+
* @see {@link DeleteRefreshScheduleCommand}
|
|
470
332
|
*/
|
|
471
333
|
deleteRefreshSchedule(args: DeleteRefreshScheduleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRefreshScheduleCommandOutput>;
|
|
472
334
|
deleteRefreshSchedule(args: DeleteRefreshScheduleCommandInput, cb: (err: any, data?: DeleteRefreshScheduleCommandOutput) => void): void;
|
|
473
335
|
deleteRefreshSchedule(args: DeleteRefreshScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRefreshScheduleCommandOutput) => void): void;
|
|
474
336
|
/**
|
|
475
|
-
* @
|
|
476
|
-
* <p>Deletes a template.</p>
|
|
337
|
+
* @see {@link DeleteTemplateCommand}
|
|
477
338
|
*/
|
|
478
339
|
deleteTemplate(args: DeleteTemplateCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTemplateCommandOutput>;
|
|
479
340
|
deleteTemplate(args: DeleteTemplateCommandInput, cb: (err: any, data?: DeleteTemplateCommandOutput) => void): void;
|
|
480
341
|
deleteTemplate(args: DeleteTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTemplateCommandOutput) => void): void;
|
|
481
342
|
/**
|
|
482
|
-
* @
|
|
483
|
-
* <p>Deletes the item that the specified template alias points to. If you provide a specific
|
|
484
|
-
* alias, you delete the version of the template that the alias points to.</p>
|
|
343
|
+
* @see {@link DeleteTemplateAliasCommand}
|
|
485
344
|
*/
|
|
486
345
|
deleteTemplateAlias(args: DeleteTemplateAliasCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTemplateAliasCommandOutput>;
|
|
487
346
|
deleteTemplateAlias(args: DeleteTemplateAliasCommandInput, cb: (err: any, data?: DeleteTemplateAliasCommandOutput) => void): void;
|
|
488
347
|
deleteTemplateAlias(args: DeleteTemplateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTemplateAliasCommandOutput) => void): void;
|
|
489
348
|
/**
|
|
490
|
-
* @
|
|
491
|
-
* <p>Deletes a theme.</p>
|
|
349
|
+
* @see {@link DeleteThemeCommand}
|
|
492
350
|
*/
|
|
493
351
|
deleteTheme(args: DeleteThemeCommandInput, options?: __HttpHandlerOptions): Promise<DeleteThemeCommandOutput>;
|
|
494
352
|
deleteTheme(args: DeleteThemeCommandInput, cb: (err: any, data?: DeleteThemeCommandOutput) => void): void;
|
|
495
353
|
deleteTheme(args: DeleteThemeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThemeCommandOutput) => void): void;
|
|
496
354
|
/**
|
|
497
|
-
* @
|
|
498
|
-
* <p>Deletes the version of the theme that the specified theme alias points to.
|
|
499
|
-
* If you provide a specific alias, you delete the version of the theme
|
|
500
|
-
* that the alias points to.</p>
|
|
355
|
+
* @see {@link DeleteThemeAliasCommand}
|
|
501
356
|
*/
|
|
502
357
|
deleteThemeAlias(args: DeleteThemeAliasCommandInput, options?: __HttpHandlerOptions): Promise<DeleteThemeAliasCommandOutput>;
|
|
503
358
|
deleteThemeAlias(args: DeleteThemeAliasCommandInput, cb: (err: any, data?: DeleteThemeAliasCommandOutput) => void): void;
|
|
504
359
|
deleteThemeAlias(args: DeleteThemeAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThemeAliasCommandOutput) => void): void;
|
|
505
360
|
/**
|
|
506
|
-
* @
|
|
507
|
-
* <p>Deletes the Amazon QuickSight user that is associated with the identity of the
|
|
508
|
-
* IAM user or role that's making the call. The IAM user
|
|
509
|
-
* isn't deleted as a result of this call. </p>
|
|
361
|
+
* @see {@link DeleteUserCommand}
|
|
510
362
|
*/
|
|
511
363
|
deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise<DeleteUserCommandOutput>;
|
|
512
364
|
deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
|
|
513
365
|
deleteUser(args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
|
|
514
366
|
/**
|
|
515
|
-
* @
|
|
516
|
-
* <p>Deletes a user identified by its principal ID. </p>
|
|
367
|
+
* @see {@link DeleteUserByPrincipalIdCommand}
|
|
517
368
|
*/
|
|
518
369
|
deleteUserByPrincipalId(args: DeleteUserByPrincipalIdCommandInput, options?: __HttpHandlerOptions): Promise<DeleteUserByPrincipalIdCommandOutput>;
|
|
519
370
|
deleteUserByPrincipalId(args: DeleteUserByPrincipalIdCommandInput, cb: (err: any, data?: DeleteUserByPrincipalIdCommandOutput) => void): void;
|
|
520
371
|
deleteUserByPrincipalId(args: DeleteUserByPrincipalIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserByPrincipalIdCommandOutput) => void): void;
|
|
521
372
|
/**
|
|
522
|
-
* @
|
|
523
|
-
* <p>Describes the customizations associated with the provided Amazon Web Services account and Amazon
|
|
524
|
-
* Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which
|
|
525
|
-
* customizations to apply by running this API operation with the <code>Resolved</code> flag
|
|
526
|
-
* included. </p>
|
|
527
|
-
* <p>To determine what customizations display when you run this command, it can help to
|
|
528
|
-
* visualize the relationship of the entities involved. </p>
|
|
529
|
-
* <ul>
|
|
530
|
-
* <li>
|
|
531
|
-
* <p>
|
|
532
|
-
* <code>Amazon Web Services account</code> - The Amazon Web Services account exists at the top of the hierarchy.
|
|
533
|
-
* It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you
|
|
534
|
-
* subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region.
|
|
535
|
-
* That's where your free SPICE capacity is located. You can use Amazon QuickSight in any
|
|
536
|
-
* supported Amazon Web Services Region. </p>
|
|
537
|
-
* </li>
|
|
538
|
-
* <li>
|
|
539
|
-
* <p>
|
|
540
|
-
* <code>Amazon Web Services Region</code> - In each Amazon Web Services Region where you sign in to Amazon QuickSight
|
|
541
|
-
* at least once, Amazon QuickSight acts as a separate instance of the same service. If
|
|
542
|
-
* you have a user directory, it resides in us-east-1, which is the US East (N.
|
|
543
|
-
* Virginia). Generally speaking, these users have access to Amazon QuickSight in any
|
|
544
|
-
* Amazon Web Services Region, unless they are constrained to a namespace. </p>
|
|
545
|
-
* <p>To run the command in a different Amazon Web Services Region, you change your Region settings.
|
|
546
|
-
* If you're using the CLI, you can use one of the following options:</p>
|
|
547
|
-
* <ul>
|
|
548
|
-
* <li>
|
|
549
|
-
* <p>Use <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html">command line options</a>. </p>
|
|
550
|
-
* </li>
|
|
551
|
-
* <li>
|
|
552
|
-
* <p>Use <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html">named profiles</a>. </p>
|
|
553
|
-
* </li>
|
|
554
|
-
* <li>
|
|
555
|
-
* <p>Run <code>aws configure</code> to change your default Amazon Web Services Region. Use
|
|
556
|
-
* Enter to key the same settings for your keys. For more information, see
|
|
557
|
-
* <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html">Configuring the CLI</a>.</p>
|
|
558
|
-
* </li>
|
|
559
|
-
* </ul>
|
|
560
|
-
* </li>
|
|
561
|
-
* <li>
|
|
562
|
-
* <p>
|
|
563
|
-
* <code>Namespace</code> - A QuickSight namespace is a partition that contains
|
|
564
|
-
* users and assets (data sources, datasets, dashboards, and so on). To access
|
|
565
|
-
* assets that are in a specific namespace, users and groups must also be part of
|
|
566
|
-
* the same namespace. People who share a namespace are completely isolated from
|
|
567
|
-
* users and assets in other namespaces, even if they are in the same Amazon Web Services account
|
|
568
|
-
* and Amazon Web Services Region.</p>
|
|
569
|
-
* </li>
|
|
570
|
-
* <li>
|
|
571
|
-
* <p>
|
|
572
|
-
* <code>Applied customizations</code> - Within an Amazon Web Services Region, a set of
|
|
573
|
-
* Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace.
|
|
574
|
-
* Settings that you apply to a namespace override settings that you apply to an
|
|
575
|
-
* Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in
|
|
576
|
-
* other Amazon Web Services Regions, run the <code>CreateAccountCustomization</code> command in
|
|
577
|
-
* each Amazon Web Services Region where you want to apply the same customizations. </p>
|
|
578
|
-
* </li>
|
|
579
|
-
* </ul>
|
|
373
|
+
* @see {@link DescribeAccountCustomizationCommand}
|
|
580
374
|
*/
|
|
581
375
|
describeAccountCustomization(args: DescribeAccountCustomizationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAccountCustomizationCommandOutput>;
|
|
582
376
|
describeAccountCustomization(args: DescribeAccountCustomizationCommandInput, cb: (err: any, data?: DescribeAccountCustomizationCommandOutput) => void): void;
|
|
583
377
|
describeAccountCustomization(args: DescribeAccountCustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountCustomizationCommandOutput) => void): void;
|
|
584
378
|
/**
|
|
585
|
-
* @
|
|
586
|
-
* <p>Describes the settings that were used when your Amazon QuickSight subscription was first
|
|
587
|
-
* created in this Amazon Web Services account.</p>
|
|
379
|
+
* @see {@link DescribeAccountSettingsCommand}
|
|
588
380
|
*/
|
|
589
381
|
describeAccountSettings(args: DescribeAccountSettingsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAccountSettingsCommandOutput>;
|
|
590
382
|
describeAccountSettings(args: DescribeAccountSettingsCommandInput, cb: (err: any, data?: DescribeAccountSettingsCommandOutput) => void): void;
|
|
591
383
|
describeAccountSettings(args: DescribeAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountSettingsCommandOutput) => void): void;
|
|
592
384
|
/**
|
|
593
|
-
* @
|
|
594
|
-
* <p>Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an <code>AccountInfo</code> object that includes an account's name, subscription status, authentication type, edition, and notification email address.</p>
|
|
385
|
+
* @see {@link DescribeAccountSubscriptionCommand}
|
|
595
386
|
*/
|
|
596
387
|
describeAccountSubscription(args: DescribeAccountSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAccountSubscriptionCommandOutput>;
|
|
597
388
|
describeAccountSubscription(args: DescribeAccountSubscriptionCommandInput, cb: (err: any, data?: DescribeAccountSubscriptionCommandOutput) => void): void;
|
|
598
389
|
describeAccountSubscription(args: DescribeAccountSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountSubscriptionCommandOutput) => void): void;
|
|
599
390
|
/**
|
|
600
|
-
* @
|
|
601
|
-
* <p>Provides a summary of the metadata for an analysis.</p>
|
|
391
|
+
* @see {@link DescribeAnalysisCommand}
|
|
602
392
|
*/
|
|
603
393
|
describeAnalysis(args: DescribeAnalysisCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAnalysisCommandOutput>;
|
|
604
394
|
describeAnalysis(args: DescribeAnalysisCommandInput, cb: (err: any, data?: DescribeAnalysisCommandOutput) => void): void;
|
|
605
395
|
describeAnalysis(args: DescribeAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAnalysisCommandOutput) => void): void;
|
|
606
396
|
/**
|
|
607
|
-
* @
|
|
608
|
-
* <p>Provides a detailed description of the definition of an analysis.</p>
|
|
609
|
-
* <note>
|
|
610
|
-
* <p>If you do not need to know details about the content of an Analysis, for instance if you
|
|
611
|
-
* are trying to check the status of a recently created or updated Analysis, use the
|
|
612
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeAnalysis.html">
|
|
613
|
-
* <code>DescribeAnalysis</code>
|
|
614
|
-
* </a> instead.
|
|
615
|
-
* </p>
|
|
616
|
-
* </note>
|
|
397
|
+
* @see {@link DescribeAnalysisDefinitionCommand}
|
|
617
398
|
*/
|
|
618
399
|
describeAnalysisDefinition(args: DescribeAnalysisDefinitionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAnalysisDefinitionCommandOutput>;
|
|
619
400
|
describeAnalysisDefinition(args: DescribeAnalysisDefinitionCommandInput, cb: (err: any, data?: DescribeAnalysisDefinitionCommandOutput) => void): void;
|
|
620
401
|
describeAnalysisDefinition(args: DescribeAnalysisDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAnalysisDefinitionCommandOutput) => void): void;
|
|
621
402
|
/**
|
|
622
|
-
* @
|
|
623
|
-
* <p>Provides the read and write permissions for an analysis.</p>
|
|
403
|
+
* @see {@link DescribeAnalysisPermissionsCommand}
|
|
624
404
|
*/
|
|
625
405
|
describeAnalysisPermissions(args: DescribeAnalysisPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAnalysisPermissionsCommandOutput>;
|
|
626
406
|
describeAnalysisPermissions(args: DescribeAnalysisPermissionsCommandInput, cb: (err: any, data?: DescribeAnalysisPermissionsCommandOutput) => void): void;
|
|
627
407
|
describeAnalysisPermissions(args: DescribeAnalysisPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAnalysisPermissionsCommandOutput) => void): void;
|
|
628
408
|
/**
|
|
629
|
-
* @
|
|
630
|
-
* <p>Provides a summary for a dashboard.</p>
|
|
409
|
+
* @see {@link DescribeDashboardCommand}
|
|
631
410
|
*/
|
|
632
411
|
describeDashboard(args: DescribeDashboardCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDashboardCommandOutput>;
|
|
633
412
|
describeDashboard(args: DescribeDashboardCommandInput, cb: (err: any, data?: DescribeDashboardCommandOutput) => void): void;
|
|
634
413
|
describeDashboard(args: DescribeDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDashboardCommandOutput) => void): void;
|
|
635
414
|
/**
|
|
636
|
-
* @
|
|
637
|
-
* <p>Provides a detailed description of the definition of a dashboard.</p>
|
|
638
|
-
* <note>
|
|
639
|
-
* <p>If you do not need to know details about the content of a dashboard, for instance if you
|
|
640
|
-
* are trying to check the status of a recently created or updated dashboard, use the
|
|
641
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboard.html">
|
|
642
|
-
* <code>DescribeDashboard</code>
|
|
643
|
-
* </a> instead.
|
|
644
|
-
* </p>
|
|
645
|
-
* </note>
|
|
415
|
+
* @see {@link DescribeDashboardDefinitionCommand}
|
|
646
416
|
*/
|
|
647
417
|
describeDashboardDefinition(args: DescribeDashboardDefinitionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDashboardDefinitionCommandOutput>;
|
|
648
418
|
describeDashboardDefinition(args: DescribeDashboardDefinitionCommandInput, cb: (err: any, data?: DescribeDashboardDefinitionCommandOutput) => void): void;
|
|
649
419
|
describeDashboardDefinition(args: DescribeDashboardDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDashboardDefinitionCommandOutput) => void): void;
|
|
650
420
|
/**
|
|
651
|
-
* @
|
|
652
|
-
* <p>Describes read and write permissions for a dashboard.</p>
|
|
421
|
+
* @see {@link DescribeDashboardPermissionsCommand}
|
|
653
422
|
*/
|
|
654
423
|
describeDashboardPermissions(args: DescribeDashboardPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDashboardPermissionsCommandOutput>;
|
|
655
424
|
describeDashboardPermissions(args: DescribeDashboardPermissionsCommandInput, cb: (err: any, data?: DescribeDashboardPermissionsCommandOutput) => void): void;
|
|
656
425
|
describeDashboardPermissions(args: DescribeDashboardPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDashboardPermissionsCommandOutput) => void): void;
|
|
657
426
|
/**
|
|
658
|
-
* @
|
|
659
|
-
* <p>Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.</p>
|
|
427
|
+
* @see {@link DescribeDataSetCommand}
|
|
660
428
|
*/
|
|
661
429
|
describeDataSet(args: DescribeDataSetCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDataSetCommandOutput>;
|
|
662
430
|
describeDataSet(args: DescribeDataSetCommandInput, cb: (err: any, data?: DescribeDataSetCommandOutput) => void): void;
|
|
663
431
|
describeDataSet(args: DescribeDataSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSetCommandOutput) => void): void;
|
|
664
432
|
/**
|
|
665
|
-
* @
|
|
666
|
-
* <p>Describes the permissions on a dataset.</p>
|
|
667
|
-
* <p>The permissions resource is <code>arn:aws:quicksight:region:aws-account-id:dataset/data-set-id</code>.</p>
|
|
433
|
+
* @see {@link DescribeDataSetPermissionsCommand}
|
|
668
434
|
*/
|
|
669
435
|
describeDataSetPermissions(args: DescribeDataSetPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDataSetPermissionsCommandOutput>;
|
|
670
436
|
describeDataSetPermissions(args: DescribeDataSetPermissionsCommandInput, cb: (err: any, data?: DescribeDataSetPermissionsCommandOutput) => void): void;
|
|
671
437
|
describeDataSetPermissions(args: DescribeDataSetPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSetPermissionsCommandOutput) => void): void;
|
|
672
438
|
/**
|
|
673
|
-
* @
|
|
674
|
-
* <p>Describes the refresh properties of a dataset.</p>
|
|
439
|
+
* @see {@link DescribeDataSetRefreshPropertiesCommand}
|
|
675
440
|
*/
|
|
676
441
|
describeDataSetRefreshProperties(args: DescribeDataSetRefreshPropertiesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDataSetRefreshPropertiesCommandOutput>;
|
|
677
442
|
describeDataSetRefreshProperties(args: DescribeDataSetRefreshPropertiesCommandInput, cb: (err: any, data?: DescribeDataSetRefreshPropertiesCommandOutput) => void): void;
|
|
678
443
|
describeDataSetRefreshProperties(args: DescribeDataSetRefreshPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSetRefreshPropertiesCommandOutput) => void): void;
|
|
679
444
|
/**
|
|
680
|
-
* @
|
|
681
|
-
* <p>Describes a data source.</p>
|
|
445
|
+
* @see {@link DescribeDataSourceCommand}
|
|
682
446
|
*/
|
|
683
447
|
describeDataSource(args: DescribeDataSourceCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDataSourceCommandOutput>;
|
|
684
448
|
describeDataSource(args: DescribeDataSourceCommandInput, cb: (err: any, data?: DescribeDataSourceCommandOutput) => void): void;
|
|
685
449
|
describeDataSource(args: DescribeDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSourceCommandOutput) => void): void;
|
|
686
450
|
/**
|
|
687
|
-
* @
|
|
688
|
-
* <p>Describes the resource permissions for a data source.</p>
|
|
451
|
+
* @see {@link DescribeDataSourcePermissionsCommand}
|
|
689
452
|
*/
|
|
690
453
|
describeDataSourcePermissions(args: DescribeDataSourcePermissionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDataSourcePermissionsCommandOutput>;
|
|
691
454
|
describeDataSourcePermissions(args: DescribeDataSourcePermissionsCommandInput, cb: (err: any, data?: DescribeDataSourcePermissionsCommandOutput) => void): void;
|
|
692
455
|
describeDataSourcePermissions(args: DescribeDataSourcePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSourcePermissionsCommandOutput) => void): void;
|
|
693
456
|
/**
|
|
694
|
-
* @
|
|
695
|
-
* <p>Describes a folder.</p>
|
|
457
|
+
* @see {@link DescribeFolderCommand}
|
|
696
458
|
*/
|
|
697
459
|
describeFolder(args: DescribeFolderCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFolderCommandOutput>;
|
|
698
460
|
describeFolder(args: DescribeFolderCommandInput, cb: (err: any, data?: DescribeFolderCommandOutput) => void): void;
|
|
699
461
|
describeFolder(args: DescribeFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFolderCommandOutput) => void): void;
|
|
700
462
|
/**
|
|
701
|
-
* @
|
|
702
|
-
* <p>Describes permissions for a folder.</p>
|
|
463
|
+
* @see {@link DescribeFolderPermissionsCommand}
|
|
703
464
|
*/
|
|
704
465
|
describeFolderPermissions(args: DescribeFolderPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFolderPermissionsCommandOutput>;
|
|
705
466
|
describeFolderPermissions(args: DescribeFolderPermissionsCommandInput, cb: (err: any, data?: DescribeFolderPermissionsCommandOutput) => void): void;
|
|
706
467
|
describeFolderPermissions(args: DescribeFolderPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFolderPermissionsCommandOutput) => void): void;
|
|
707
468
|
/**
|
|
708
|
-
* @
|
|
709
|
-
* <p>Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.</p>
|
|
469
|
+
* @see {@link DescribeFolderResolvedPermissionsCommand}
|
|
710
470
|
*/
|
|
711
471
|
describeFolderResolvedPermissions(args: DescribeFolderResolvedPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFolderResolvedPermissionsCommandOutput>;
|
|
712
472
|
describeFolderResolvedPermissions(args: DescribeFolderResolvedPermissionsCommandInput, cb: (err: any, data?: DescribeFolderResolvedPermissionsCommandOutput) => void): void;
|
|
713
473
|
describeFolderResolvedPermissions(args: DescribeFolderResolvedPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFolderResolvedPermissionsCommandOutput) => void): void;
|
|
714
474
|
/**
|
|
715
|
-
* @
|
|
716
|
-
* <p>Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN). </p>
|
|
475
|
+
* @see {@link DescribeGroupCommand}
|
|
717
476
|
*/
|
|
718
477
|
describeGroup(args: DescribeGroupCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGroupCommandOutput>;
|
|
719
478
|
describeGroup(args: DescribeGroupCommandInput, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void;
|
|
720
479
|
describeGroup(args: DescribeGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void;
|
|
721
480
|
/**
|
|
722
|
-
* @
|
|
723
|
-
* <p>Use the <code>DescribeGroupMembership</code> operation to determine if a user is a
|
|
724
|
-
* member of the specified group. If the user exists and is a member of the specified
|
|
725
|
-
* group, an associated <code>GroupMember</code> object is returned.</p>
|
|
481
|
+
* @see {@link DescribeGroupMembershipCommand}
|
|
726
482
|
*/
|
|
727
483
|
describeGroupMembership(args: DescribeGroupMembershipCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGroupMembershipCommandOutput>;
|
|
728
484
|
describeGroupMembership(args: DescribeGroupMembershipCommandInput, cb: (err: any, data?: DescribeGroupMembershipCommandOutput) => void): void;
|
|
729
485
|
describeGroupMembership(args: DescribeGroupMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGroupMembershipCommandOutput) => void): void;
|
|
730
486
|
/**
|
|
731
|
-
* @
|
|
732
|
-
* <p>Describes an existing IAM policy assignment, as specified by the assignment name.</p>
|
|
487
|
+
* @see {@link DescribeIAMPolicyAssignmentCommand}
|
|
733
488
|
*/
|
|
734
489
|
describeIAMPolicyAssignment(args: DescribeIAMPolicyAssignmentCommandInput, options?: __HttpHandlerOptions): Promise<DescribeIAMPolicyAssignmentCommandOutput>;
|
|
735
490
|
describeIAMPolicyAssignment(args: DescribeIAMPolicyAssignmentCommandInput, cb: (err: any, data?: DescribeIAMPolicyAssignmentCommandOutput) => void): void;
|
|
736
491
|
describeIAMPolicyAssignment(args: DescribeIAMPolicyAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIAMPolicyAssignmentCommandOutput) => void): void;
|
|
737
492
|
/**
|
|
738
|
-
* @
|
|
739
|
-
* <p>Describes a SPICE ingestion.</p>
|
|
493
|
+
* @see {@link DescribeIngestionCommand}
|
|
740
494
|
*/
|
|
741
495
|
describeIngestion(args: DescribeIngestionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeIngestionCommandOutput>;
|
|
742
496
|
describeIngestion(args: DescribeIngestionCommandInput, cb: (err: any, data?: DescribeIngestionCommandOutput) => void): void;
|
|
743
497
|
describeIngestion(args: DescribeIngestionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIngestionCommandOutput) => void): void;
|
|
744
498
|
/**
|
|
745
|
-
* @
|
|
746
|
-
* <p>Provides a summary and status of IP rules.</p>
|
|
499
|
+
* @see {@link DescribeIpRestrictionCommand}
|
|
747
500
|
*/
|
|
748
501
|
describeIpRestriction(args: DescribeIpRestrictionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeIpRestrictionCommandOutput>;
|
|
749
502
|
describeIpRestriction(args: DescribeIpRestrictionCommandInput, cb: (err: any, data?: DescribeIpRestrictionCommandOutput) => void): void;
|
|
750
503
|
describeIpRestriction(args: DescribeIpRestrictionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIpRestrictionCommandOutput) => void): void;
|
|
751
504
|
/**
|
|
752
|
-
* @
|
|
753
|
-
* <p>Describes the current namespace.</p>
|
|
505
|
+
* @see {@link DescribeNamespaceCommand}
|
|
754
506
|
*/
|
|
755
507
|
describeNamespace(args: DescribeNamespaceCommandInput, options?: __HttpHandlerOptions): Promise<DescribeNamespaceCommandOutput>;
|
|
756
508
|
describeNamespace(args: DescribeNamespaceCommandInput, cb: (err: any, data?: DescribeNamespaceCommandOutput) => void): void;
|
|
757
509
|
describeNamespace(args: DescribeNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNamespaceCommandOutput) => void): void;
|
|
758
510
|
/**
|
|
759
|
-
* @
|
|
760
|
-
* <p>Provides a summary of a refresh schedule.</p>
|
|
511
|
+
* @see {@link DescribeRefreshScheduleCommand}
|
|
761
512
|
*/
|
|
762
513
|
describeRefreshSchedule(args: DescribeRefreshScheduleCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRefreshScheduleCommandOutput>;
|
|
763
514
|
describeRefreshSchedule(args: DescribeRefreshScheduleCommandInput, cb: (err: any, data?: DescribeRefreshScheduleCommandOutput) => void): void;
|
|
764
515
|
describeRefreshSchedule(args: DescribeRefreshScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRefreshScheduleCommandOutput) => void): void;
|
|
765
516
|
/**
|
|
766
|
-
* @
|
|
767
|
-
* <p>Describes a template's metadata.</p>
|
|
517
|
+
* @see {@link DescribeTemplateCommand}
|
|
768
518
|
*/
|
|
769
519
|
describeTemplate(args: DescribeTemplateCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTemplateCommandOutput>;
|
|
770
520
|
describeTemplate(args: DescribeTemplateCommandInput, cb: (err: any, data?: DescribeTemplateCommandOutput) => void): void;
|
|
771
521
|
describeTemplate(args: DescribeTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTemplateCommandOutput) => void): void;
|
|
772
522
|
/**
|
|
773
|
-
* @
|
|
774
|
-
* <p>Describes the template alias for a template.</p>
|
|
523
|
+
* @see {@link DescribeTemplateAliasCommand}
|
|
775
524
|
*/
|
|
776
525
|
describeTemplateAlias(args: DescribeTemplateAliasCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTemplateAliasCommandOutput>;
|
|
777
526
|
describeTemplateAlias(args: DescribeTemplateAliasCommandInput, cb: (err: any, data?: DescribeTemplateAliasCommandOutput) => void): void;
|
|
778
527
|
describeTemplateAlias(args: DescribeTemplateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTemplateAliasCommandOutput) => void): void;
|
|
779
528
|
/**
|
|
780
|
-
* @
|
|
781
|
-
* <p>Provides a detailed description of the definition of a template.</p>
|
|
782
|
-
* <note>
|
|
783
|
-
* <p>If you do not need to know details about the content of a template, for instance if you
|
|
784
|
-
* are trying to check the status of a recently created or updated template, use the
|
|
785
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeTemplate.html">
|
|
786
|
-
* <code>DescribeTemplate</code>
|
|
787
|
-
* </a> instead.
|
|
788
|
-
* </p>
|
|
789
|
-
* </note>
|
|
529
|
+
* @see {@link DescribeTemplateDefinitionCommand}
|
|
790
530
|
*/
|
|
791
531
|
describeTemplateDefinition(args: DescribeTemplateDefinitionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTemplateDefinitionCommandOutput>;
|
|
792
532
|
describeTemplateDefinition(args: DescribeTemplateDefinitionCommandInput, cb: (err: any, data?: DescribeTemplateDefinitionCommandOutput) => void): void;
|
|
793
533
|
describeTemplateDefinition(args: DescribeTemplateDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTemplateDefinitionCommandOutput) => void): void;
|
|
794
534
|
/**
|
|
795
|
-
* @
|
|
796
|
-
* <p>Describes read and write permissions on a template.</p>
|
|
535
|
+
* @see {@link DescribeTemplatePermissionsCommand}
|
|
797
536
|
*/
|
|
798
537
|
describeTemplatePermissions(args: DescribeTemplatePermissionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTemplatePermissionsCommandOutput>;
|
|
799
538
|
describeTemplatePermissions(args: DescribeTemplatePermissionsCommandInput, cb: (err: any, data?: DescribeTemplatePermissionsCommandOutput) => void): void;
|
|
800
539
|
describeTemplatePermissions(args: DescribeTemplatePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTemplatePermissionsCommandOutput) => void): void;
|
|
801
540
|
/**
|
|
802
|
-
* @
|
|
803
|
-
* <p>Describes a theme.</p>
|
|
541
|
+
* @see {@link DescribeThemeCommand}
|
|
804
542
|
*/
|
|
805
543
|
describeTheme(args: DescribeThemeCommandInput, options?: __HttpHandlerOptions): Promise<DescribeThemeCommandOutput>;
|
|
806
544
|
describeTheme(args: DescribeThemeCommandInput, cb: (err: any, data?: DescribeThemeCommandOutput) => void): void;
|
|
807
545
|
describeTheme(args: DescribeThemeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeThemeCommandOutput) => void): void;
|
|
808
546
|
/**
|
|
809
|
-
* @
|
|
810
|
-
* <p>Describes the alias for a theme.</p>
|
|
547
|
+
* @see {@link DescribeThemeAliasCommand}
|
|
811
548
|
*/
|
|
812
549
|
describeThemeAlias(args: DescribeThemeAliasCommandInput, options?: __HttpHandlerOptions): Promise<DescribeThemeAliasCommandOutput>;
|
|
813
550
|
describeThemeAlias(args: DescribeThemeAliasCommandInput, cb: (err: any, data?: DescribeThemeAliasCommandOutput) => void): void;
|
|
814
551
|
describeThemeAlias(args: DescribeThemeAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeThemeAliasCommandOutput) => void): void;
|
|
815
552
|
/**
|
|
816
|
-
* @
|
|
817
|
-
* <p>Describes the read and write permissions for a theme.</p>
|
|
553
|
+
* @see {@link DescribeThemePermissionsCommand}
|
|
818
554
|
*/
|
|
819
555
|
describeThemePermissions(args: DescribeThemePermissionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeThemePermissionsCommandOutput>;
|
|
820
556
|
describeThemePermissions(args: DescribeThemePermissionsCommandInput, cb: (err: any, data?: DescribeThemePermissionsCommandOutput) => void): void;
|
|
821
557
|
describeThemePermissions(args: DescribeThemePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeThemePermissionsCommandOutput) => void): void;
|
|
822
558
|
/**
|
|
823
|
-
* @
|
|
824
|
-
* <p>Returns information about a user, given the user name. </p>
|
|
559
|
+
* @see {@link DescribeUserCommand}
|
|
825
560
|
*/
|
|
826
561
|
describeUser(args: DescribeUserCommandInput, options?: __HttpHandlerOptions): Promise<DescribeUserCommandOutput>;
|
|
827
562
|
describeUser(args: DescribeUserCommandInput, cb: (err: any, data?: DescribeUserCommandOutput) => void): void;
|
|
828
563
|
describeUser(args: DescribeUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserCommandOutput) => void): void;
|
|
829
564
|
/**
|
|
830
|
-
* @
|
|
831
|
-
* <p>Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.</p>
|
|
832
|
-
* <p>The following rules apply to the generated URL:</p>
|
|
833
|
-
* <ul>
|
|
834
|
-
* <li>
|
|
835
|
-
* <p>It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.</p>
|
|
836
|
-
* </li>
|
|
837
|
-
* <li>
|
|
838
|
-
* <p>The URL validity period should not be confused with the actual session lifetime that can be customized using the <code>
|
|
839
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForAnonymousUser.html#QS-GenerateEmbedUrlForAnonymousUser-request-SessionLifetimeInMinutes">SessionLifetimeInMinutes</a>
|
|
840
|
-
* </code> parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.</p>
|
|
841
|
-
* </li>
|
|
842
|
-
* <li>
|
|
843
|
-
* <p>You are charged only when the URL is used or there is interaction with Amazon QuickSight.</p>
|
|
844
|
-
* </li>
|
|
845
|
-
* </ul>
|
|
846
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html">Embedded Analytics</a> in the <i>Amazon QuickSight User
|
|
847
|
-
* Guide</i>.</p>
|
|
848
|
-
* <p>For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html">Amazon QuickSight Developer Portal</a>.</p>
|
|
565
|
+
* @see {@link GenerateEmbedUrlForAnonymousUserCommand}
|
|
849
566
|
*/
|
|
850
567
|
generateEmbedUrlForAnonymousUser(args: GenerateEmbedUrlForAnonymousUserCommandInput, options?: __HttpHandlerOptions): Promise<GenerateEmbedUrlForAnonymousUserCommandOutput>;
|
|
851
568
|
generateEmbedUrlForAnonymousUser(args: GenerateEmbedUrlForAnonymousUserCommandInput, cb: (err: any, data?: GenerateEmbedUrlForAnonymousUserCommandOutput) => void): void;
|
|
852
569
|
generateEmbedUrlForAnonymousUser(args: GenerateEmbedUrlForAnonymousUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateEmbedUrlForAnonymousUserCommandOutput) => void): void;
|
|
853
570
|
/**
|
|
854
|
-
* @
|
|
855
|
-
* <p>Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account.
|
|
856
|
-
* Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.</p>
|
|
857
|
-
* <p>The following rules apply to the generated URL:</p>
|
|
858
|
-
* <ul>
|
|
859
|
-
* <li>
|
|
860
|
-
* <p>It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.</p>
|
|
861
|
-
* </li>
|
|
862
|
-
* <li>
|
|
863
|
-
* <p>The URL validity period should not be confused with the actual session lifetime
|
|
864
|
-
* that can be customized using the <code>
|
|
865
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html#QS-GenerateEmbedUrlForRegisteredUser-request-SessionLifetimeInMinutes">SessionLifetimeInMinutes</a>
|
|
866
|
-
* </code> parameter.</p>
|
|
867
|
-
* <p>The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.</p>
|
|
868
|
-
* </li>
|
|
869
|
-
* <li>
|
|
870
|
-
* <p>You are charged only when the URL is used or there is interaction with Amazon QuickSight.</p>
|
|
871
|
-
* </li>
|
|
872
|
-
* </ul>
|
|
873
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html">Embedded Analytics</a> in the <i>Amazon QuickSight User
|
|
874
|
-
* Guide</i>.</p>
|
|
875
|
-
* <p>For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html">Amazon QuickSight Developer Portal</a>.</p>
|
|
571
|
+
* @see {@link GenerateEmbedUrlForRegisteredUserCommand}
|
|
876
572
|
*/
|
|
877
573
|
generateEmbedUrlForRegisteredUser(args: GenerateEmbedUrlForRegisteredUserCommandInput, options?: __HttpHandlerOptions): Promise<GenerateEmbedUrlForRegisteredUserCommandOutput>;
|
|
878
574
|
generateEmbedUrlForRegisteredUser(args: GenerateEmbedUrlForRegisteredUserCommandInput, cb: (err: any, data?: GenerateEmbedUrlForRegisteredUserCommandOutput) => void): void;
|
|
879
575
|
generateEmbedUrlForRegisteredUser(args: GenerateEmbedUrlForRegisteredUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateEmbedUrlForRegisteredUserCommandOutput) => void): void;
|
|
880
576
|
/**
|
|
881
|
-
* @
|
|
882
|
-
* <p>Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions. </p>
|
|
883
|
-
* <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not from the user's browser. The following rules apply to the generated URL:</p>
|
|
884
|
-
* <ul>
|
|
885
|
-
* <li>
|
|
886
|
-
* <p>They must be used together.</p>
|
|
887
|
-
* </li>
|
|
888
|
-
* <li>
|
|
889
|
-
* <p>They can be used one time only.</p>
|
|
890
|
-
* </li>
|
|
891
|
-
* <li>
|
|
892
|
-
* <p>They are valid for 5 minutes after you run this command.</p>
|
|
893
|
-
* </li>
|
|
894
|
-
* <li>
|
|
895
|
-
* <p>You are charged only when the URL is used or there is interaction with Amazon QuickSight.</p>
|
|
896
|
-
* </li>
|
|
897
|
-
* <li>
|
|
898
|
-
* <p>The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional <code>SessionLifetimeInMinutes</code> parameter to customize session duration.</p>
|
|
899
|
-
* </li>
|
|
900
|
-
* </ul>
|
|
901
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html">Embedding Analytics Using GetDashboardEmbedUrl</a> in the <i>Amazon QuickSight User
|
|
902
|
-
* Guide</i>.</p>
|
|
903
|
-
* <p>For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html">Amazon QuickSight Developer Portal</a>.</p>
|
|
577
|
+
* @see {@link GetDashboardEmbedUrlCommand}
|
|
904
578
|
*/
|
|
905
579
|
getDashboardEmbedUrl(args: GetDashboardEmbedUrlCommandInput, options?: __HttpHandlerOptions): Promise<GetDashboardEmbedUrlCommandOutput>;
|
|
906
580
|
getDashboardEmbedUrl(args: GetDashboardEmbedUrlCommandInput, cb: (err: any, data?: GetDashboardEmbedUrlCommandOutput) => void): void;
|
|
907
581
|
getDashboardEmbedUrl(args: GetDashboardEmbedUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDashboardEmbedUrlCommandOutput) => void): void;
|
|
908
582
|
/**
|
|
909
|
-
* @
|
|
910
|
-
* <p>Generates a session URL and authorization code that you can use to embed the Amazon
|
|
911
|
-
* Amazon QuickSight console in your web server code. Use <code>GetSessionEmbedUrl</code> where
|
|
912
|
-
* you want to provide an authoring portal that allows users to create data sources,
|
|
913
|
-
* datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console
|
|
914
|
-
* need belong to the author or admin security cohort. If you want to restrict permissions
|
|
915
|
-
* to some of these features, add a custom permissions profile to the user with the
|
|
916
|
-
* <code>
|
|
917
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a>
|
|
918
|
-
* </code> API operation. Use <code>
|
|
919
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html">RegisterUser</a>
|
|
920
|
-
* </code>
|
|
921
|
-
* API operation to add a new user with a custom permission profile attached. For more
|
|
922
|
-
* information, see the following sections in the <i>Amazon QuickSight User
|
|
923
|
-
* Guide</i>:</p>
|
|
924
|
-
* <ul>
|
|
925
|
-
* <li>
|
|
926
|
-
* <p>
|
|
927
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html">Embedding Analytics</a>
|
|
928
|
-
* </p>
|
|
929
|
-
* </li>
|
|
930
|
-
* <li>
|
|
931
|
-
* <p>
|
|
932
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html">Customizing Access to the Amazon QuickSight Console</a>
|
|
933
|
-
* </p>
|
|
934
|
-
* </li>
|
|
935
|
-
* </ul>
|
|
583
|
+
* @see {@link GetSessionEmbedUrlCommand}
|
|
936
584
|
*/
|
|
937
585
|
getSessionEmbedUrl(args: GetSessionEmbedUrlCommandInput, options?: __HttpHandlerOptions): Promise<GetSessionEmbedUrlCommandOutput>;
|
|
938
586
|
getSessionEmbedUrl(args: GetSessionEmbedUrlCommandInput, cb: (err: any, data?: GetSessionEmbedUrlCommandOutput) => void): void;
|
|
939
587
|
getSessionEmbedUrl(args: GetSessionEmbedUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSessionEmbedUrlCommandOutput) => void): void;
|
|
940
588
|
/**
|
|
941
|
-
* @
|
|
942
|
-
* <p>Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.</p>
|
|
589
|
+
* @see {@link ListAnalysesCommand}
|
|
943
590
|
*/
|
|
944
591
|
listAnalyses(args: ListAnalysesCommandInput, options?: __HttpHandlerOptions): Promise<ListAnalysesCommandOutput>;
|
|
945
592
|
listAnalyses(args: ListAnalysesCommandInput, cb: (err: any, data?: ListAnalysesCommandOutput) => void): void;
|
|
946
593
|
listAnalyses(args: ListAnalysesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAnalysesCommandOutput) => void): void;
|
|
947
594
|
/**
|
|
948
|
-
* @
|
|
949
|
-
* <p>Lists dashboards in an Amazon Web Services account.</p>
|
|
595
|
+
* @see {@link ListDashboardsCommand}
|
|
950
596
|
*/
|
|
951
597
|
listDashboards(args: ListDashboardsCommandInput, options?: __HttpHandlerOptions): Promise<ListDashboardsCommandOutput>;
|
|
952
598
|
listDashboards(args: ListDashboardsCommandInput, cb: (err: any, data?: ListDashboardsCommandOutput) => void): void;
|
|
953
599
|
listDashboards(args: ListDashboardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDashboardsCommandOutput) => void): void;
|
|
954
600
|
/**
|
|
955
|
-
* @
|
|
956
|
-
* <p>Lists all the versions of the dashboards in the Amazon QuickSight subscription.</p>
|
|
601
|
+
* @see {@link ListDashboardVersionsCommand}
|
|
957
602
|
*/
|
|
958
603
|
listDashboardVersions(args: ListDashboardVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListDashboardVersionsCommandOutput>;
|
|
959
604
|
listDashboardVersions(args: ListDashboardVersionsCommandInput, cb: (err: any, data?: ListDashboardVersionsCommandOutput) => void): void;
|
|
960
605
|
listDashboardVersions(args: ListDashboardVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDashboardVersionsCommandOutput) => void): void;
|
|
961
606
|
/**
|
|
962
|
-
* @
|
|
963
|
-
* <p>Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.</p>
|
|
964
|
-
* <p>The permissions resource is <code>arn:aws:quicksight:region:aws-account-id:dataset/*</code>.</p>
|
|
607
|
+
* @see {@link ListDataSetsCommand}
|
|
965
608
|
*/
|
|
966
609
|
listDataSets(args: ListDataSetsCommandInput, options?: __HttpHandlerOptions): Promise<ListDataSetsCommandOutput>;
|
|
967
610
|
listDataSets(args: ListDataSetsCommandInput, cb: (err: any, data?: ListDataSetsCommandOutput) => void): void;
|
|
968
611
|
listDataSets(args: ListDataSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSetsCommandOutput) => void): void;
|
|
969
612
|
/**
|
|
970
|
-
* @
|
|
971
|
-
* <p>Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.</p>
|
|
613
|
+
* @see {@link ListDataSourcesCommand}
|
|
972
614
|
*/
|
|
973
615
|
listDataSources(args: ListDataSourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListDataSourcesCommandOutput>;
|
|
974
616
|
listDataSources(args: ListDataSourcesCommandInput, cb: (err: any, data?: ListDataSourcesCommandOutput) => void): void;
|
|
975
617
|
listDataSources(args: ListDataSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSourcesCommandOutput) => void): void;
|
|
976
618
|
/**
|
|
977
|
-
* @
|
|
978
|
-
* <p>List all assets (<code>DASHBOARD</code>, <code>ANALYSIS</code>, and <code>DATASET</code>) in a folder. </p>
|
|
619
|
+
* @see {@link ListFolderMembersCommand}
|
|
979
620
|
*/
|
|
980
621
|
listFolderMembers(args: ListFolderMembersCommandInput, options?: __HttpHandlerOptions): Promise<ListFolderMembersCommandOutput>;
|
|
981
622
|
listFolderMembers(args: ListFolderMembersCommandInput, cb: (err: any, data?: ListFolderMembersCommandOutput) => void): void;
|
|
982
623
|
listFolderMembers(args: ListFolderMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFolderMembersCommandOutput) => void): void;
|
|
983
624
|
/**
|
|
984
|
-
* @
|
|
985
|
-
* <p>Lists all folders in an account.</p>
|
|
625
|
+
* @see {@link ListFoldersCommand}
|
|
986
626
|
*/
|
|
987
627
|
listFolders(args: ListFoldersCommandInput, options?: __HttpHandlerOptions): Promise<ListFoldersCommandOutput>;
|
|
988
628
|
listFolders(args: ListFoldersCommandInput, cb: (err: any, data?: ListFoldersCommandOutput) => void): void;
|
|
989
629
|
listFolders(args: ListFoldersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFoldersCommandOutput) => void): void;
|
|
990
630
|
/**
|
|
991
|
-
* @
|
|
992
|
-
* <p>Lists member users in a group.</p>
|
|
631
|
+
* @see {@link ListGroupMembershipsCommand}
|
|
993
632
|
*/
|
|
994
633
|
listGroupMemberships(args: ListGroupMembershipsCommandInput, options?: __HttpHandlerOptions): Promise<ListGroupMembershipsCommandOutput>;
|
|
995
634
|
listGroupMemberships(args: ListGroupMembershipsCommandInput, cb: (err: any, data?: ListGroupMembershipsCommandOutput) => void): void;
|
|
996
635
|
listGroupMemberships(args: ListGroupMembershipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupMembershipsCommandOutput) => void): void;
|
|
997
636
|
/**
|
|
998
|
-
* @
|
|
999
|
-
* <p>Lists all user groups in Amazon QuickSight. </p>
|
|
637
|
+
* @see {@link ListGroupsCommand}
|
|
1000
638
|
*/
|
|
1001
639
|
listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListGroupsCommandOutput>;
|
|
1002
640
|
listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
|
|
1003
641
|
listGroups(args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
|
|
1004
642
|
/**
|
|
1005
|
-
* @
|
|
1006
|
-
* <p>Lists IAM policy assignments in the current Amazon QuickSight account.</p>
|
|
643
|
+
* @see {@link ListIAMPolicyAssignmentsCommand}
|
|
1007
644
|
*/
|
|
1008
645
|
listIAMPolicyAssignments(args: ListIAMPolicyAssignmentsCommandInput, options?: __HttpHandlerOptions): Promise<ListIAMPolicyAssignmentsCommandOutput>;
|
|
1009
646
|
listIAMPolicyAssignments(args: ListIAMPolicyAssignmentsCommandInput, cb: (err: any, data?: ListIAMPolicyAssignmentsCommandOutput) => void): void;
|
|
1010
647
|
listIAMPolicyAssignments(args: ListIAMPolicyAssignmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIAMPolicyAssignmentsCommandOutput) => void): void;
|
|
1011
648
|
/**
|
|
1012
|
-
* @
|
|
1013
|
-
* <p>Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM
|
|
1014
|
-
* policies assigned to the specified user and group or groups that the user belongs
|
|
1015
|
-
* to.</p>
|
|
649
|
+
* @see {@link ListIAMPolicyAssignmentsForUserCommand}
|
|
1016
650
|
*/
|
|
1017
651
|
listIAMPolicyAssignmentsForUser(args: ListIAMPolicyAssignmentsForUserCommandInput, options?: __HttpHandlerOptions): Promise<ListIAMPolicyAssignmentsForUserCommandOutput>;
|
|
1018
652
|
listIAMPolicyAssignmentsForUser(args: ListIAMPolicyAssignmentsForUserCommandInput, cb: (err: any, data?: ListIAMPolicyAssignmentsForUserCommandOutput) => void): void;
|
|
1019
653
|
listIAMPolicyAssignmentsForUser(args: ListIAMPolicyAssignmentsForUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIAMPolicyAssignmentsForUserCommandOutput) => void): void;
|
|
1020
654
|
/**
|
|
1021
|
-
* @
|
|
1022
|
-
* <p>Lists the history of SPICE ingestions for a dataset.</p>
|
|
655
|
+
* @see {@link ListIngestionsCommand}
|
|
1023
656
|
*/
|
|
1024
657
|
listIngestions(args: ListIngestionsCommandInput, options?: __HttpHandlerOptions): Promise<ListIngestionsCommandOutput>;
|
|
1025
658
|
listIngestions(args: ListIngestionsCommandInput, cb: (err: any, data?: ListIngestionsCommandOutput) => void): void;
|
|
1026
659
|
listIngestions(args: ListIngestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIngestionsCommandOutput) => void): void;
|
|
1027
660
|
/**
|
|
1028
|
-
* @
|
|
1029
|
-
* <p>Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.</p>
|
|
661
|
+
* @see {@link ListNamespacesCommand}
|
|
1030
662
|
*/
|
|
1031
663
|
listNamespaces(args: ListNamespacesCommandInput, options?: __HttpHandlerOptions): Promise<ListNamespacesCommandOutput>;
|
|
1032
664
|
listNamespaces(args: ListNamespacesCommandInput, cb: (err: any, data?: ListNamespacesCommandOutput) => void): void;
|
|
1033
665
|
listNamespaces(args: ListNamespacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNamespacesCommandOutput) => void): void;
|
|
1034
666
|
/**
|
|
1035
|
-
* @
|
|
1036
|
-
* <p>Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules. </p>
|
|
667
|
+
* @see {@link ListRefreshSchedulesCommand}
|
|
1037
668
|
*/
|
|
1038
669
|
listRefreshSchedules(args: ListRefreshSchedulesCommandInput, options?: __HttpHandlerOptions): Promise<ListRefreshSchedulesCommandOutput>;
|
|
1039
670
|
listRefreshSchedules(args: ListRefreshSchedulesCommandInput, cb: (err: any, data?: ListRefreshSchedulesCommandOutput) => void): void;
|
|
1040
671
|
listRefreshSchedules(args: ListRefreshSchedulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRefreshSchedulesCommandOutput) => void): void;
|
|
1041
672
|
/**
|
|
1042
|
-
* @
|
|
1043
|
-
* <p>Lists the tags assigned to a resource.</p>
|
|
673
|
+
* @see {@link ListTagsForResourceCommand}
|
|
1044
674
|
*/
|
|
1045
675
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
1046
676
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
1047
677
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
1048
678
|
/**
|
|
1049
|
-
* @
|
|
1050
|
-
* <p>Lists all the aliases of a template.</p>
|
|
679
|
+
* @see {@link ListTemplateAliasesCommand}
|
|
1051
680
|
*/
|
|
1052
681
|
listTemplateAliases(args: ListTemplateAliasesCommandInput, options?: __HttpHandlerOptions): Promise<ListTemplateAliasesCommandOutput>;
|
|
1053
682
|
listTemplateAliases(args: ListTemplateAliasesCommandInput, cb: (err: any, data?: ListTemplateAliasesCommandOutput) => void): void;
|
|
1054
683
|
listTemplateAliases(args: ListTemplateAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTemplateAliasesCommandOutput) => void): void;
|
|
1055
684
|
/**
|
|
1056
|
-
* @
|
|
1057
|
-
* <p>Lists all the templates in the current Amazon QuickSight account.</p>
|
|
685
|
+
* @see {@link ListTemplatesCommand}
|
|
1058
686
|
*/
|
|
1059
687
|
listTemplates(args: ListTemplatesCommandInput, options?: __HttpHandlerOptions): Promise<ListTemplatesCommandOutput>;
|
|
1060
688
|
listTemplates(args: ListTemplatesCommandInput, cb: (err: any, data?: ListTemplatesCommandOutput) => void): void;
|
|
1061
689
|
listTemplates(args: ListTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTemplatesCommandOutput) => void): void;
|
|
1062
690
|
/**
|
|
1063
|
-
* @
|
|
1064
|
-
* <p>Lists all the versions of the templates in the current Amazon QuickSight account.</p>
|
|
691
|
+
* @see {@link ListTemplateVersionsCommand}
|
|
1065
692
|
*/
|
|
1066
693
|
listTemplateVersions(args: ListTemplateVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListTemplateVersionsCommandOutput>;
|
|
1067
694
|
listTemplateVersions(args: ListTemplateVersionsCommandInput, cb: (err: any, data?: ListTemplateVersionsCommandOutput) => void): void;
|
|
1068
695
|
listTemplateVersions(args: ListTemplateVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTemplateVersionsCommandOutput) => void): void;
|
|
1069
696
|
/**
|
|
1070
|
-
* @
|
|
1071
|
-
* <p>Lists all the aliases of a theme.</p>
|
|
697
|
+
* @see {@link ListThemeAliasesCommand}
|
|
1072
698
|
*/
|
|
1073
699
|
listThemeAliases(args: ListThemeAliasesCommandInput, options?: __HttpHandlerOptions): Promise<ListThemeAliasesCommandOutput>;
|
|
1074
700
|
listThemeAliases(args: ListThemeAliasesCommandInput, cb: (err: any, data?: ListThemeAliasesCommandOutput) => void): void;
|
|
1075
701
|
listThemeAliases(args: ListThemeAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThemeAliasesCommandOutput) => void): void;
|
|
1076
702
|
/**
|
|
1077
|
-
* @
|
|
1078
|
-
* <p>Lists all the themes in the current Amazon Web Services account.</p>
|
|
703
|
+
* @see {@link ListThemesCommand}
|
|
1079
704
|
*/
|
|
1080
705
|
listThemes(args: ListThemesCommandInput, options?: __HttpHandlerOptions): Promise<ListThemesCommandOutput>;
|
|
1081
706
|
listThemes(args: ListThemesCommandInput, cb: (err: any, data?: ListThemesCommandOutput) => void): void;
|
|
1082
707
|
listThemes(args: ListThemesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThemesCommandOutput) => void): void;
|
|
1083
708
|
/**
|
|
1084
|
-
* @
|
|
1085
|
-
* <p>Lists all the versions of the themes in the current Amazon Web Services account.</p>
|
|
709
|
+
* @see {@link ListThemeVersionsCommand}
|
|
1086
710
|
*/
|
|
1087
711
|
listThemeVersions(args: ListThemeVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListThemeVersionsCommandOutput>;
|
|
1088
712
|
listThemeVersions(args: ListThemeVersionsCommandInput, cb: (err: any, data?: ListThemeVersionsCommandOutput) => void): void;
|
|
1089
713
|
listThemeVersions(args: ListThemeVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThemeVersionsCommandOutput) => void): void;
|
|
1090
714
|
/**
|
|
1091
|
-
* @
|
|
1092
|
-
* <p>Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.</p>
|
|
715
|
+
* @see {@link ListUserGroupsCommand}
|
|
1093
716
|
*/
|
|
1094
717
|
listUserGroups(args: ListUserGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListUserGroupsCommandOutput>;
|
|
1095
718
|
listUserGroups(args: ListUserGroupsCommandInput, cb: (err: any, data?: ListUserGroupsCommandOutput) => void): void;
|
|
1096
719
|
listUserGroups(args: ListUserGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUserGroupsCommandOutput) => void): void;
|
|
1097
720
|
/**
|
|
1098
|
-
* @
|
|
1099
|
-
* <p>Returns a list of all of the Amazon QuickSight users belonging to this account. </p>
|
|
721
|
+
* @see {@link ListUsersCommand}
|
|
1100
722
|
*/
|
|
1101
723
|
listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise<ListUsersCommandOutput>;
|
|
1102
724
|
listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
|
|
1103
725
|
listUsers(args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
|
|
1104
726
|
/**
|
|
1105
|
-
* @
|
|
1106
|
-
* <p>Creates or updates the dataset refresh properties for the dataset.</p>
|
|
727
|
+
* @see {@link PutDataSetRefreshPropertiesCommand}
|
|
1107
728
|
*/
|
|
1108
729
|
putDataSetRefreshProperties(args: PutDataSetRefreshPropertiesCommandInput, options?: __HttpHandlerOptions): Promise<PutDataSetRefreshPropertiesCommandOutput>;
|
|
1109
730
|
putDataSetRefreshProperties(args: PutDataSetRefreshPropertiesCommandInput, cb: (err: any, data?: PutDataSetRefreshPropertiesCommandOutput) => void): void;
|
|
1110
731
|
putDataSetRefreshProperties(args: PutDataSetRefreshPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDataSetRefreshPropertiesCommandOutput) => void): void;
|
|
1111
732
|
/**
|
|
1112
|
-
* @
|
|
1113
|
-
* <p>Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/managing-users.html#inviting-users"> Inviting users to access Amazon QuickSight</a>.</p>
|
|
733
|
+
* @see {@link RegisterUserCommand}
|
|
1114
734
|
*/
|
|
1115
735
|
registerUser(args: RegisterUserCommandInput, options?: __HttpHandlerOptions): Promise<RegisterUserCommandOutput>;
|
|
1116
736
|
registerUser(args: RegisterUserCommandInput, cb: (err: any, data?: RegisterUserCommandOutput) => void): void;
|
|
1117
737
|
registerUser(args: RegisterUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterUserCommandOutput) => void): void;
|
|
1118
738
|
/**
|
|
1119
|
-
* @
|
|
1120
|
-
* <p>Restores an analysis.</p>
|
|
739
|
+
* @see {@link RestoreAnalysisCommand}
|
|
1121
740
|
*/
|
|
1122
741
|
restoreAnalysis(args: RestoreAnalysisCommandInput, options?: __HttpHandlerOptions): Promise<RestoreAnalysisCommandOutput>;
|
|
1123
742
|
restoreAnalysis(args: RestoreAnalysisCommandInput, cb: (err: any, data?: RestoreAnalysisCommandOutput) => void): void;
|
|
1124
743
|
restoreAnalysis(args: RestoreAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreAnalysisCommandOutput) => void): void;
|
|
1125
744
|
/**
|
|
1126
|
-
* @
|
|
1127
|
-
* <p>Searches for analyses that belong to the user specified in the filter.</p>
|
|
1128
|
-
* <note>
|
|
1129
|
-
* <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
|
|
1130
|
-
* </note>
|
|
745
|
+
* @see {@link SearchAnalysesCommand}
|
|
1131
746
|
*/
|
|
1132
747
|
searchAnalyses(args: SearchAnalysesCommandInput, options?: __HttpHandlerOptions): Promise<SearchAnalysesCommandOutput>;
|
|
1133
748
|
searchAnalyses(args: SearchAnalysesCommandInput, cb: (err: any, data?: SearchAnalysesCommandOutput) => void): void;
|
|
1134
749
|
searchAnalyses(args: SearchAnalysesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchAnalysesCommandOutput) => void): void;
|
|
1135
750
|
/**
|
|
1136
|
-
* @
|
|
1137
|
-
* <p>Searches for dashboards that belong to a user. </p>
|
|
1138
|
-
* <note>
|
|
1139
|
-
* <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
|
|
1140
|
-
* </note>
|
|
751
|
+
* @see {@link SearchDashboardsCommand}
|
|
1141
752
|
*/
|
|
1142
753
|
searchDashboards(args: SearchDashboardsCommandInput, options?: __HttpHandlerOptions): Promise<SearchDashboardsCommandOutput>;
|
|
1143
754
|
searchDashboards(args: SearchDashboardsCommandInput, cb: (err: any, data?: SearchDashboardsCommandOutput) => void): void;
|
|
1144
755
|
searchDashboards(args: SearchDashboardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchDashboardsCommandOutput) => void): void;
|
|
1145
756
|
/**
|
|
1146
|
-
* @
|
|
1147
|
-
* <p>Use the <code>SearchDataSets</code> operation to search for datasets that belong to an account.</p>
|
|
757
|
+
* @see {@link SearchDataSetsCommand}
|
|
1148
758
|
*/
|
|
1149
759
|
searchDataSets(args: SearchDataSetsCommandInput, options?: __HttpHandlerOptions): Promise<SearchDataSetsCommandOutput>;
|
|
1150
760
|
searchDataSets(args: SearchDataSetsCommandInput, cb: (err: any, data?: SearchDataSetsCommandOutput) => void): void;
|
|
1151
761
|
searchDataSets(args: SearchDataSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchDataSetsCommandOutput) => void): void;
|
|
1152
762
|
/**
|
|
1153
|
-
* @
|
|
1154
|
-
* <p>Use the <code>SearchDataSources</code> operation to search for data sources that belong to an account.</p>
|
|
763
|
+
* @see {@link SearchDataSourcesCommand}
|
|
1155
764
|
*/
|
|
1156
765
|
searchDataSources(args: SearchDataSourcesCommandInput, options?: __HttpHandlerOptions): Promise<SearchDataSourcesCommandOutput>;
|
|
1157
766
|
searchDataSources(args: SearchDataSourcesCommandInput, cb: (err: any, data?: SearchDataSourcesCommandOutput) => void): void;
|
|
1158
767
|
searchDataSources(args: SearchDataSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchDataSourcesCommandOutput) => void): void;
|
|
1159
768
|
/**
|
|
1160
|
-
* @
|
|
1161
|
-
* <p>Searches the subfolders in a folder.</p>
|
|
769
|
+
* @see {@link SearchFoldersCommand}
|
|
1162
770
|
*/
|
|
1163
771
|
searchFolders(args: SearchFoldersCommandInput, options?: __HttpHandlerOptions): Promise<SearchFoldersCommandOutput>;
|
|
1164
772
|
searchFolders(args: SearchFoldersCommandInput, cb: (err: any, data?: SearchFoldersCommandOutput) => void): void;
|
|
1165
773
|
searchFolders(args: SearchFoldersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchFoldersCommandOutput) => void): void;
|
|
1166
774
|
/**
|
|
1167
|
-
* @
|
|
1168
|
-
* <p>Use the <code>SearchGroups</code> operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.</p>
|
|
775
|
+
* @see {@link SearchGroupsCommand}
|
|
1169
776
|
*/
|
|
1170
777
|
searchGroups(args: SearchGroupsCommandInput, options?: __HttpHandlerOptions): Promise<SearchGroupsCommandOutput>;
|
|
1171
778
|
searchGroups(args: SearchGroupsCommandInput, cb: (err: any, data?: SearchGroupsCommandOutput) => void): void;
|
|
1172
779
|
searchGroups(args: SearchGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchGroupsCommandOutput) => void): void;
|
|
1173
780
|
/**
|
|
1174
|
-
* @
|
|
1175
|
-
* <p>Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource. </p>
|
|
1176
|
-
* <p>Tags can help you organize and categorize your resources. You can also use them to
|
|
1177
|
-
* scope user permissions, by granting a user permission to access or change only resources
|
|
1178
|
-
* with certain tag values. You can use the <code>TagResource</code> operation with a
|
|
1179
|
-
* resource that already has tags. If you specify a new tag key for the resource, this tag
|
|
1180
|
-
* is appended to the list of tags associated with the resource. If you specify a tag key
|
|
1181
|
-
* that is already associated with the resource, the new tag value that you specify
|
|
1182
|
-
* replaces the previous value for that tag.</p>
|
|
1183
|
-
* <p>You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data
|
|
1184
|
-
* set, data source, dashboard, and template. </p>
|
|
1185
|
-
* <p>Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for
|
|
1186
|
-
* the following:</p>
|
|
1187
|
-
* <ul>
|
|
1188
|
-
* <li>
|
|
1189
|
-
* <p>You can't use tags to track costs for Amazon QuickSight. This isn't
|
|
1190
|
-
* possible because you can't tag the resources that Amazon QuickSight costs are based
|
|
1191
|
-
* on, for example Amazon QuickSight storage capacity (SPICE), number of users, type
|
|
1192
|
-
* of users, and usage metrics.</p>
|
|
1193
|
-
* </li>
|
|
1194
|
-
* <li>
|
|
1195
|
-
* <p>Amazon QuickSight doesn't currently support the tag editor for Resource Groups.</p>
|
|
1196
|
-
* </li>
|
|
1197
|
-
* </ul>
|
|
781
|
+
* @see {@link TagResourceCommand}
|
|
1198
782
|
*/
|
|
1199
783
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
1200
784
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1201
785
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1202
786
|
/**
|
|
1203
|
-
* @
|
|
1204
|
-
* <p>Removes a tag or tags from a resource.</p>
|
|
787
|
+
* @see {@link UntagResourceCommand}
|
|
1205
788
|
*/
|
|
1206
789
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
1207
790
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1208
791
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1209
792
|
/**
|
|
1210
|
-
* @
|
|
1211
|
-
* <p>Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.</p>
|
|
1212
|
-
* <p>You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a
|
|
1213
|
-
* Amazon QuickSight namespace instead. Customizations that apply to a namespace override
|
|
1214
|
-
* customizations that apply to an Amazon Web Services account. To find out which customizations apply, use
|
|
1215
|
-
* the <code>DescribeAccountCustomization</code> API operation. </p>
|
|
793
|
+
* @see {@link UpdateAccountCustomizationCommand}
|
|
1216
794
|
*/
|
|
1217
795
|
updateAccountCustomization(args: UpdateAccountCustomizationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAccountCustomizationCommandOutput>;
|
|
1218
796
|
updateAccountCustomization(args: UpdateAccountCustomizationCommandInput, cb: (err: any, data?: UpdateAccountCustomizationCommandOutput) => void): void;
|
|
1219
797
|
updateAccountCustomization(args: UpdateAccountCustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountCustomizationCommandOutput) => void): void;
|
|
1220
798
|
/**
|
|
1221
|
-
* @
|
|
1222
|
-
* <p>Updates the Amazon QuickSight settings in your Amazon Web Services account.</p>
|
|
799
|
+
* @see {@link UpdateAccountSettingsCommand}
|
|
1223
800
|
*/
|
|
1224
801
|
updateAccountSettings(args: UpdateAccountSettingsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAccountSettingsCommandOutput>;
|
|
1225
802
|
updateAccountSettings(args: UpdateAccountSettingsCommandInput, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void): void;
|
|
1226
803
|
updateAccountSettings(args: UpdateAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void): void;
|
|
1227
804
|
/**
|
|
1228
|
-
* @
|
|
1229
|
-
* <p>Updates an analysis in Amazon QuickSight</p>
|
|
805
|
+
* @see {@link UpdateAnalysisCommand}
|
|
1230
806
|
*/
|
|
1231
807
|
updateAnalysis(args: UpdateAnalysisCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAnalysisCommandOutput>;
|
|
1232
808
|
updateAnalysis(args: UpdateAnalysisCommandInput, cb: (err: any, data?: UpdateAnalysisCommandOutput) => void): void;
|
|
1233
809
|
updateAnalysis(args: UpdateAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAnalysisCommandOutput) => void): void;
|
|
1234
810
|
/**
|
|
1235
|
-
* @
|
|
1236
|
-
* <p>Updates the read and write permissions for an analysis.</p>
|
|
811
|
+
* @see {@link UpdateAnalysisPermissionsCommand}
|
|
1237
812
|
*/
|
|
1238
813
|
updateAnalysisPermissions(args: UpdateAnalysisPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAnalysisPermissionsCommandOutput>;
|
|
1239
814
|
updateAnalysisPermissions(args: UpdateAnalysisPermissionsCommandInput, cb: (err: any, data?: UpdateAnalysisPermissionsCommandOutput) => void): void;
|
|
1240
815
|
updateAnalysisPermissions(args: UpdateAnalysisPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAnalysisPermissionsCommandOutput) => void): void;
|
|
1241
816
|
/**
|
|
1242
|
-
* @
|
|
1243
|
-
* <p>Updates a dashboard in an Amazon Web Services account.</p>
|
|
1244
|
-
* <note>
|
|
1245
|
-
* <p>Updating a Dashboard creates a new dashboard version but does not immediately publish
|
|
1246
|
-
* the new version. You can update the published version of a dashboard by
|
|
1247
|
-
* using the <code>
|
|
1248
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html">UpdateDashboardPublishedVersion</a>
|
|
1249
|
-
* </code> API operation.</p>
|
|
1250
|
-
* </note>
|
|
817
|
+
* @see {@link UpdateDashboardCommand}
|
|
1251
818
|
*/
|
|
1252
819
|
updateDashboard(args: UpdateDashboardCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDashboardCommandOutput>;
|
|
1253
820
|
updateDashboard(args: UpdateDashboardCommandInput, cb: (err: any, data?: UpdateDashboardCommandOutput) => void): void;
|
|
1254
821
|
updateDashboard(args: UpdateDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDashboardCommandOutput) => void): void;
|
|
1255
822
|
/**
|
|
1256
|
-
* @
|
|
1257
|
-
* <p>Updates read and write permissions on a dashboard.</p>
|
|
823
|
+
* @see {@link UpdateDashboardPermissionsCommand}
|
|
1258
824
|
*/
|
|
1259
825
|
updateDashboardPermissions(args: UpdateDashboardPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDashboardPermissionsCommandOutput>;
|
|
1260
826
|
updateDashboardPermissions(args: UpdateDashboardPermissionsCommandInput, cb: (err: any, data?: UpdateDashboardPermissionsCommandOutput) => void): void;
|
|
1261
827
|
updateDashboardPermissions(args: UpdateDashboardPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDashboardPermissionsCommandOutput) => void): void;
|
|
1262
828
|
/**
|
|
1263
|
-
* @
|
|
1264
|
-
* <p>Updates the published version of a dashboard.</p>
|
|
829
|
+
* @see {@link UpdateDashboardPublishedVersionCommand}
|
|
1265
830
|
*/
|
|
1266
831
|
updateDashboardPublishedVersion(args: UpdateDashboardPublishedVersionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDashboardPublishedVersionCommandOutput>;
|
|
1267
832
|
updateDashboardPublishedVersion(args: UpdateDashboardPublishedVersionCommandInput, cb: (err: any, data?: UpdateDashboardPublishedVersionCommandOutput) => void): void;
|
|
1268
833
|
updateDashboardPublishedVersion(args: UpdateDashboardPublishedVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDashboardPublishedVersionCommandOutput) => void): void;
|
|
1269
834
|
/**
|
|
1270
|
-
* @
|
|
1271
|
-
* <p>Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.</p>
|
|
835
|
+
* @see {@link UpdateDataSetCommand}
|
|
1272
836
|
*/
|
|
1273
837
|
updateDataSet(args: UpdateDataSetCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDataSetCommandOutput>;
|
|
1274
838
|
updateDataSet(args: UpdateDataSetCommandInput, cb: (err: any, data?: UpdateDataSetCommandOutput) => void): void;
|
|
1275
839
|
updateDataSet(args: UpdateDataSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataSetCommandOutput) => void): void;
|
|
1276
840
|
/**
|
|
1277
|
-
* @
|
|
1278
|
-
* <p>Updates the permissions on a dataset.</p>
|
|
1279
|
-
* <p>The permissions resource is <code>arn:aws:quicksight:region:aws-account-id:dataset/data-set-id</code>.</p>
|
|
841
|
+
* @see {@link UpdateDataSetPermissionsCommand}
|
|
1280
842
|
*/
|
|
1281
843
|
updateDataSetPermissions(args: UpdateDataSetPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDataSetPermissionsCommandOutput>;
|
|
1282
844
|
updateDataSetPermissions(args: UpdateDataSetPermissionsCommandInput, cb: (err: any, data?: UpdateDataSetPermissionsCommandOutput) => void): void;
|
|
1283
845
|
updateDataSetPermissions(args: UpdateDataSetPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataSetPermissionsCommandOutput) => void): void;
|
|
1284
846
|
/**
|
|
1285
|
-
* @
|
|
1286
|
-
* <p>Updates a data source.</p>
|
|
847
|
+
* @see {@link UpdateDataSourceCommand}
|
|
1287
848
|
*/
|
|
1288
849
|
updateDataSource(args: UpdateDataSourceCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDataSourceCommandOutput>;
|
|
1289
850
|
updateDataSource(args: UpdateDataSourceCommandInput, cb: (err: any, data?: UpdateDataSourceCommandOutput) => void): void;
|
|
1290
851
|
updateDataSource(args: UpdateDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataSourceCommandOutput) => void): void;
|
|
1291
852
|
/**
|
|
1292
|
-
* @
|
|
1293
|
-
* <p>Updates the permissions to a data source.</p>
|
|
853
|
+
* @see {@link UpdateDataSourcePermissionsCommand}
|
|
1294
854
|
*/
|
|
1295
855
|
updateDataSourcePermissions(args: UpdateDataSourcePermissionsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDataSourcePermissionsCommandOutput>;
|
|
1296
856
|
updateDataSourcePermissions(args: UpdateDataSourcePermissionsCommandInput, cb: (err: any, data?: UpdateDataSourcePermissionsCommandOutput) => void): void;
|
|
1297
857
|
updateDataSourcePermissions(args: UpdateDataSourcePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataSourcePermissionsCommandOutput) => void): void;
|
|
1298
858
|
/**
|
|
1299
|
-
* @
|
|
1300
|
-
* <p>Updates the name of a folder.</p>
|
|
859
|
+
* @see {@link UpdateFolderCommand}
|
|
1301
860
|
*/
|
|
1302
861
|
updateFolder(args: UpdateFolderCommandInput, options?: __HttpHandlerOptions): Promise<UpdateFolderCommandOutput>;
|
|
1303
862
|
updateFolder(args: UpdateFolderCommandInput, cb: (err: any, data?: UpdateFolderCommandOutput) => void): void;
|
|
1304
863
|
updateFolder(args: UpdateFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFolderCommandOutput) => void): void;
|
|
1305
864
|
/**
|
|
1306
|
-
* @
|
|
1307
|
-
* <p>Updates permissions of a folder.</p>
|
|
865
|
+
* @see {@link UpdateFolderPermissionsCommand}
|
|
1308
866
|
*/
|
|
1309
867
|
updateFolderPermissions(args: UpdateFolderPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateFolderPermissionsCommandOutput>;
|
|
1310
868
|
updateFolderPermissions(args: UpdateFolderPermissionsCommandInput, cb: (err: any, data?: UpdateFolderPermissionsCommandOutput) => void): void;
|
|
1311
869
|
updateFolderPermissions(args: UpdateFolderPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFolderPermissionsCommandOutput) => void): void;
|
|
1312
870
|
/**
|
|
1313
|
-
* @
|
|
1314
|
-
* <p>Changes a group description. </p>
|
|
871
|
+
* @see {@link UpdateGroupCommand}
|
|
1315
872
|
*/
|
|
1316
873
|
updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGroupCommandOutput>;
|
|
1317
874
|
updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
|
|
1318
875
|
updateGroup(args: UpdateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
|
|
1319
876
|
/**
|
|
1320
|
-
* @
|
|
1321
|
-
* <p>Updates an existing IAM policy assignment. This operation updates only the optional
|
|
1322
|
-
* parameter or parameters that are specified in the request.
|
|
1323
|
-
* This overwrites all of the users included in <code>Identities</code>.
|
|
1324
|
-
* </p>
|
|
877
|
+
* @see {@link UpdateIAMPolicyAssignmentCommand}
|
|
1325
878
|
*/
|
|
1326
879
|
updateIAMPolicyAssignment(args: UpdateIAMPolicyAssignmentCommandInput, options?: __HttpHandlerOptions): Promise<UpdateIAMPolicyAssignmentCommandOutput>;
|
|
1327
880
|
updateIAMPolicyAssignment(args: UpdateIAMPolicyAssignmentCommandInput, cb: (err: any, data?: UpdateIAMPolicyAssignmentCommandOutput) => void): void;
|
|
1328
881
|
updateIAMPolicyAssignment(args: UpdateIAMPolicyAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIAMPolicyAssignmentCommandOutput) => void): void;
|
|
1329
882
|
/**
|
|
1330
|
-
* @
|
|
1331
|
-
* <p>Updates the content and status of IP rules. To use this operation, you need to provide the entire map of rules. You can use the <code>DescribeIpRestriction</code> operation to get the current rule map.</p>
|
|
883
|
+
* @see {@link UpdateIpRestrictionCommand}
|
|
1332
884
|
*/
|
|
1333
885
|
updateIpRestriction(args: UpdateIpRestrictionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateIpRestrictionCommandOutput>;
|
|
1334
886
|
updateIpRestriction(args: UpdateIpRestrictionCommandInput, cb: (err: any, data?: UpdateIpRestrictionCommandOutput) => void): void;
|
|
1335
887
|
updateIpRestriction(args: UpdateIpRestrictionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIpRestrictionCommandOutput) => void): void;
|
|
1336
888
|
/**
|
|
1337
|
-
* @
|
|
1338
|
-
* <p>Use the <code>UpdatePublicSharingSettings</code> operation to turn on or turn off the
|
|
1339
|
-
* public sharing settings of an Amazon QuickSight dashboard.</p>
|
|
1340
|
-
* <p>To use this operation, turn on session capacity pricing for your Amazon QuickSight
|
|
1341
|
-
* account.</p>
|
|
1342
|
-
* <p>Before you can turn on public sharing on your account, make sure to give public sharing
|
|
1343
|
-
* permissions to an administrative user in the Identity and Access Management (IAM)
|
|
1344
|
-
* console. For more information on using IAM with Amazon QuickSight, see
|
|
1345
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html">Using Amazon QuickSight with IAM</a> in the <i>Amazon QuickSight
|
|
1346
|
-
* User Guide</i>.</p>
|
|
889
|
+
* @see {@link UpdatePublicSharingSettingsCommand}
|
|
1347
890
|
*/
|
|
1348
891
|
updatePublicSharingSettings(args: UpdatePublicSharingSettingsCommandInput, options?: __HttpHandlerOptions): Promise<UpdatePublicSharingSettingsCommandOutput>;
|
|
1349
892
|
updatePublicSharingSettings(args: UpdatePublicSharingSettingsCommandInput, cb: (err: any, data?: UpdatePublicSharingSettingsCommandOutput) => void): void;
|
|
1350
893
|
updatePublicSharingSettings(args: UpdatePublicSharingSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePublicSharingSettingsCommandOutput) => void): void;
|
|
1351
894
|
/**
|
|
1352
|
-
* @
|
|
1353
|
-
* <p>Updates a refresh schedule for a dataset.</p>
|
|
895
|
+
* @see {@link UpdateRefreshScheduleCommand}
|
|
1354
896
|
*/
|
|
1355
897
|
updateRefreshSchedule(args: UpdateRefreshScheduleCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRefreshScheduleCommandOutput>;
|
|
1356
898
|
updateRefreshSchedule(args: UpdateRefreshScheduleCommandInput, cb: (err: any, data?: UpdateRefreshScheduleCommandOutput) => void): void;
|
|
1357
899
|
updateRefreshSchedule(args: UpdateRefreshScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRefreshScheduleCommandOutput) => void): void;
|
|
1358
900
|
/**
|
|
1359
|
-
* @
|
|
1360
|
-
* <p>Updates a template from an existing Amazon QuickSight analysis or another template.</p>
|
|
901
|
+
* @see {@link UpdateTemplateCommand}
|
|
1361
902
|
*/
|
|
1362
903
|
updateTemplate(args: UpdateTemplateCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTemplateCommandOutput>;
|
|
1363
904
|
updateTemplate(args: UpdateTemplateCommandInput, cb: (err: any, data?: UpdateTemplateCommandOutput) => void): void;
|
|
1364
905
|
updateTemplate(args: UpdateTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTemplateCommandOutput) => void): void;
|
|
1365
906
|
/**
|
|
1366
|
-
* @
|
|
1367
|
-
* <p>Updates the template alias of a template.</p>
|
|
907
|
+
* @see {@link UpdateTemplateAliasCommand}
|
|
1368
908
|
*/
|
|
1369
909
|
updateTemplateAlias(args: UpdateTemplateAliasCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTemplateAliasCommandOutput>;
|
|
1370
910
|
updateTemplateAlias(args: UpdateTemplateAliasCommandInput, cb: (err: any, data?: UpdateTemplateAliasCommandOutput) => void): void;
|
|
1371
911
|
updateTemplateAlias(args: UpdateTemplateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTemplateAliasCommandOutput) => void): void;
|
|
1372
912
|
/**
|
|
1373
|
-
* @
|
|
1374
|
-
* <p>Updates the resource permissions for a template.</p>
|
|
913
|
+
* @see {@link UpdateTemplatePermissionsCommand}
|
|
1375
914
|
*/
|
|
1376
915
|
updateTemplatePermissions(args: UpdateTemplatePermissionsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTemplatePermissionsCommandOutput>;
|
|
1377
916
|
updateTemplatePermissions(args: UpdateTemplatePermissionsCommandInput, cb: (err: any, data?: UpdateTemplatePermissionsCommandOutput) => void): void;
|
|
1378
917
|
updateTemplatePermissions(args: UpdateTemplatePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTemplatePermissionsCommandOutput) => void): void;
|
|
1379
918
|
/**
|
|
1380
|
-
* @
|
|
1381
|
-
* <p>Updates a theme.</p>
|
|
919
|
+
* @see {@link UpdateThemeCommand}
|
|
1382
920
|
*/
|
|
1383
921
|
updateTheme(args: UpdateThemeCommandInput, options?: __HttpHandlerOptions): Promise<UpdateThemeCommandOutput>;
|
|
1384
922
|
updateTheme(args: UpdateThemeCommandInput, cb: (err: any, data?: UpdateThemeCommandOutput) => void): void;
|
|
1385
923
|
updateTheme(args: UpdateThemeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateThemeCommandOutput) => void): void;
|
|
1386
924
|
/**
|
|
1387
|
-
* @
|
|
1388
|
-
* <p>Updates an alias of a theme.</p>
|
|
925
|
+
* @see {@link UpdateThemeAliasCommand}
|
|
1389
926
|
*/
|
|
1390
927
|
updateThemeAlias(args: UpdateThemeAliasCommandInput, options?: __HttpHandlerOptions): Promise<UpdateThemeAliasCommandOutput>;
|
|
1391
928
|
updateThemeAlias(args: UpdateThemeAliasCommandInput, cb: (err: any, data?: UpdateThemeAliasCommandOutput) => void): void;
|
|
1392
929
|
updateThemeAlias(args: UpdateThemeAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateThemeAliasCommandOutput) => void): void;
|
|
1393
930
|
/**
|
|
1394
|
-
* @
|
|
1395
|
-
* <p>Updates the resource permissions for a theme. Permissions apply to the action to grant or
|
|
1396
|
-
* revoke permissions on, for example <code>"quicksight:DescribeTheme"</code>.</p>
|
|
1397
|
-
* <p>Theme permissions apply in groupings. Valid groupings include the following for the three
|
|
1398
|
-
* levels of permissions, which are user, owner, or no permissions: </p>
|
|
1399
|
-
* <ul>
|
|
1400
|
-
* <li>
|
|
1401
|
-
* <p>User</p>
|
|
1402
|
-
* <ul>
|
|
1403
|
-
* <li>
|
|
1404
|
-
* <p>
|
|
1405
|
-
* <code>"quicksight:DescribeTheme"</code>
|
|
1406
|
-
* </p>
|
|
1407
|
-
* </li>
|
|
1408
|
-
* <li>
|
|
1409
|
-
* <p>
|
|
1410
|
-
* <code>"quicksight:DescribeThemeAlias"</code>
|
|
1411
|
-
* </p>
|
|
1412
|
-
* </li>
|
|
1413
|
-
* <li>
|
|
1414
|
-
* <p>
|
|
1415
|
-
* <code>"quicksight:ListThemeAliases"</code>
|
|
1416
|
-
* </p>
|
|
1417
|
-
* </li>
|
|
1418
|
-
* <li>
|
|
1419
|
-
* <p>
|
|
1420
|
-
* <code>"quicksight:ListThemeVersions"</code>
|
|
1421
|
-
* </p>
|
|
1422
|
-
* </li>
|
|
1423
|
-
* </ul>
|
|
1424
|
-
* </li>
|
|
1425
|
-
* <li>
|
|
1426
|
-
* <p>Owner</p>
|
|
1427
|
-
* <ul>
|
|
1428
|
-
* <li>
|
|
1429
|
-
* <p>
|
|
1430
|
-
* <code>"quicksight:DescribeTheme"</code>
|
|
1431
|
-
* </p>
|
|
1432
|
-
* </li>
|
|
1433
|
-
* <li>
|
|
1434
|
-
* <p>
|
|
1435
|
-
* <code>"quicksight:DescribeThemeAlias"</code>
|
|
1436
|
-
* </p>
|
|
1437
|
-
* </li>
|
|
1438
|
-
* <li>
|
|
1439
|
-
* <p>
|
|
1440
|
-
* <code>"quicksight:ListThemeAliases"</code>
|
|
1441
|
-
* </p>
|
|
1442
|
-
* </li>
|
|
1443
|
-
* <li>
|
|
1444
|
-
* <p>
|
|
1445
|
-
* <code>"quicksight:ListThemeVersions"</code>
|
|
1446
|
-
* </p>
|
|
1447
|
-
* </li>
|
|
1448
|
-
* <li>
|
|
1449
|
-
* <p>
|
|
1450
|
-
* <code>"quicksight:DeleteTheme"</code>
|
|
1451
|
-
* </p>
|
|
1452
|
-
* </li>
|
|
1453
|
-
* <li>
|
|
1454
|
-
* <p>
|
|
1455
|
-
* <code>"quicksight:UpdateTheme"</code>
|
|
1456
|
-
* </p>
|
|
1457
|
-
* </li>
|
|
1458
|
-
* <li>
|
|
1459
|
-
* <p>
|
|
1460
|
-
* <code>"quicksight:CreateThemeAlias"</code>
|
|
1461
|
-
* </p>
|
|
1462
|
-
* </li>
|
|
1463
|
-
* <li>
|
|
1464
|
-
* <p>
|
|
1465
|
-
* <code>"quicksight:DeleteThemeAlias"</code>
|
|
1466
|
-
* </p>
|
|
1467
|
-
* </li>
|
|
1468
|
-
* <li>
|
|
1469
|
-
* <p>
|
|
1470
|
-
* <code>"quicksight:UpdateThemeAlias"</code>
|
|
1471
|
-
* </p>
|
|
1472
|
-
* </li>
|
|
1473
|
-
* <li>
|
|
1474
|
-
* <p>
|
|
1475
|
-
* <code>"quicksight:UpdateThemePermissions"</code>
|
|
1476
|
-
* </p>
|
|
1477
|
-
* </li>
|
|
1478
|
-
* <li>
|
|
1479
|
-
* <p>
|
|
1480
|
-
* <code>"quicksight:DescribeThemePermissions"</code>
|
|
1481
|
-
* </p>
|
|
1482
|
-
* </li>
|
|
1483
|
-
* </ul>
|
|
1484
|
-
* </li>
|
|
1485
|
-
* <li>
|
|
1486
|
-
* <p>To specify no permissions, omit the permissions list.</p>
|
|
1487
|
-
* </li>
|
|
1488
|
-
* </ul>
|
|
931
|
+
* @see {@link UpdateThemePermissionsCommand}
|
|
1489
932
|
*/
|
|
1490
933
|
updateThemePermissions(args: UpdateThemePermissionsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateThemePermissionsCommandOutput>;
|
|
1491
934
|
updateThemePermissions(args: UpdateThemePermissionsCommandInput, cb: (err: any, data?: UpdateThemePermissionsCommandOutput) => void): void;
|
|
1492
935
|
updateThemePermissions(args: UpdateThemePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateThemePermissionsCommandOutput) => void): void;
|
|
1493
936
|
/**
|
|
1494
|
-
* @
|
|
1495
|
-
* <p>Updates an Amazon QuickSight user.</p>
|
|
937
|
+
* @see {@link UpdateUserCommand}
|
|
1496
938
|
*/
|
|
1497
939
|
updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserCommandOutput>;
|
|
1498
940
|
updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void;
|
|
1499
941
|
updateUser(args: UpdateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserCommandOutput) => void): void;
|
|
1500
942
|
}
|
|
943
|
+
/**
|
|
944
|
+
* @public
|
|
945
|
+
* <fullname>Amazon QuickSight API Reference</fullname>
|
|
946
|
+
* <p>Amazon QuickSight is a fully managed, serverless business intelligence service for the
|
|
947
|
+
* Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your
|
|
948
|
+
* organization. This API reference contains documentation for a programming interface that
|
|
949
|
+
* you can use to manage Amazon QuickSight. </p>
|
|
950
|
+
*/
|
|
951
|
+
export declare class QuickSight extends QuickSightClient implements QuickSight {
|
|
952
|
+
}
|