@aws-sdk/client-quicksight 3.28.0 → 3.32.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/CHANGELOG.md +38 -0
- package/QuickSight.ts +59 -59
- package/commands/CreateAccountCustomizationCommand.ts +4 -4
- package/commands/CreateDashboardCommand.ts +3 -3
- package/commands/CreateIAMPolicyAssignmentCommand.ts +2 -2
- package/commands/CreateNamespaceCommand.ts +4 -4
- package/commands/CreateTemplateCommand.ts +1 -1
- package/commands/DeleteAccountCustomizationCommand.ts +1 -1
- package/commands/DeleteAnalysisCommand.ts +3 -3
- package/commands/DeleteIAMPolicyAssignmentCommand.ts +1 -1
- package/commands/DescribeAccountCustomizationCommand.ts +12 -12
- package/commands/DescribeAccountSettingsCommand.ts +2 -2
- package/commands/DescribeIAMPolicyAssignmentCommand.ts +1 -1
- package/commands/GetDashboardEmbedUrlCommand.ts +1 -1
- package/commands/GetSessionEmbedUrlCommand.ts +3 -3
- package/commands/ListAnalysesCommand.ts +1 -1
- package/commands/ListDashboardVersionsCommand.ts +1 -1
- package/commands/ListDashboardsCommand.ts +1 -1
- package/commands/ListDataSetsCommand.ts +1 -1
- package/commands/ListDataSourcesCommand.ts +1 -1
- package/commands/ListIAMPolicyAssignmentsCommand.ts +1 -1
- package/commands/ListIAMPolicyAssignmentsForUserCommand.ts +1 -1
- package/commands/ListNamespacesCommand.ts +1 -1
- package/commands/ListThemeVersionsCommand.ts +1 -1
- package/commands/ListThemesCommand.ts +1 -1
- package/commands/TagResourceCommand.ts +5 -5
- package/commands/UpdateAccountCustomizationCommand.ts +3 -3
- package/commands/UpdateAccountSettingsCommand.ts +1 -1
- package/commands/UpdateDashboardCommand.ts +1 -1
- package/commands/UpdateIAMPolicyAssignmentCommand.ts +1 -1
- package/dist/cjs/commands/CreateAccountCustomizationCommand.js +4 -4
- package/dist/cjs/commands/CreateDashboardCommand.js +3 -3
- package/dist/cjs/commands/CreateIAMPolicyAssignmentCommand.js +2 -2
- package/dist/cjs/commands/CreateNamespaceCommand.js +4 -4
- package/dist/cjs/commands/CreateTemplateCommand.js +1 -1
- package/dist/cjs/commands/DeleteAccountCustomizationCommand.js +1 -1
- package/dist/cjs/commands/DeleteAnalysisCommand.js +3 -3
- package/dist/cjs/commands/DeleteIAMPolicyAssignmentCommand.js +1 -1
- package/dist/cjs/commands/DescribeAccountCustomizationCommand.js +12 -12
- package/dist/cjs/commands/DescribeAccountSettingsCommand.js +2 -2
- package/dist/cjs/commands/DescribeIAMPolicyAssignmentCommand.js +1 -1
- package/dist/cjs/commands/GetDashboardEmbedUrlCommand.js +1 -1
- package/dist/cjs/commands/GetSessionEmbedUrlCommand.js +3 -3
- package/dist/cjs/commands/ListAnalysesCommand.js +1 -1
- package/dist/cjs/commands/ListDashboardVersionsCommand.js +1 -1
- package/dist/cjs/commands/ListDashboardsCommand.js +1 -1
- package/dist/cjs/commands/ListDataSetsCommand.js +1 -1
- package/dist/cjs/commands/ListDataSourcesCommand.js +1 -1
- package/dist/cjs/commands/ListIAMPolicyAssignmentsCommand.js +1 -1
- package/dist/cjs/commands/ListIAMPolicyAssignmentsForUserCommand.js +1 -1
- package/dist/cjs/commands/ListNamespacesCommand.js +1 -1
- package/dist/cjs/commands/ListThemeVersionsCommand.js +1 -1
- package/dist/cjs/commands/ListThemesCommand.js +1 -1
- package/dist/cjs/commands/TagResourceCommand.js +5 -5
- package/dist/cjs/commands/UpdateAccountCustomizationCommand.js +3 -3
- package/dist/cjs/commands/UpdateAccountSettingsCommand.js +1 -1
- package/dist/cjs/commands/UpdateDashboardCommand.js +1 -1
- package/dist/cjs/commands/UpdateIAMPolicyAssignmentCommand.js +1 -1
- package/dist/cjs/models/models_0.js +49 -37
- package/dist/cjs/models/models_0.js.map +1 -1
- package/dist/cjs/models/models_1.js +34 -3
- package/dist/cjs/models/models_1.js.map +1 -1
- package/dist/cjs/package.json +31 -31
- package/dist/cjs/protocols/Aws_restJson1.js +276 -186
- package/dist/cjs/protocols/Aws_restJson1.js.map +1 -1
- package/dist/es/commands/CreateAccountCustomizationCommand.js +4 -4
- package/dist/es/commands/CreateDashboardCommand.js +3 -3
- package/dist/es/commands/CreateIAMPolicyAssignmentCommand.js +2 -2
- package/dist/es/commands/CreateNamespaceCommand.js +4 -4
- package/dist/es/commands/CreateTemplateCommand.js +1 -1
- package/dist/es/commands/DeleteAccountCustomizationCommand.js +1 -1
- package/dist/es/commands/DeleteAnalysisCommand.js +3 -3
- package/dist/es/commands/DeleteIAMPolicyAssignmentCommand.js +1 -1
- package/dist/es/commands/DescribeAccountCustomizationCommand.js +12 -12
- package/dist/es/commands/DescribeAccountSettingsCommand.js +2 -2
- package/dist/es/commands/DescribeIAMPolicyAssignmentCommand.js +1 -1
- package/dist/es/commands/GetDashboardEmbedUrlCommand.js +1 -1
- package/dist/es/commands/GetSessionEmbedUrlCommand.js +3 -3
- package/dist/es/commands/ListAnalysesCommand.js +1 -1
- package/dist/es/commands/ListDashboardVersionsCommand.js +1 -1
- package/dist/es/commands/ListDashboardsCommand.js +1 -1
- package/dist/es/commands/ListDataSetsCommand.js +1 -1
- package/dist/es/commands/ListDataSourcesCommand.js +1 -1
- package/dist/es/commands/ListIAMPolicyAssignmentsCommand.js +1 -1
- package/dist/es/commands/ListIAMPolicyAssignmentsForUserCommand.js +1 -1
- package/dist/es/commands/ListNamespacesCommand.js +1 -1
- package/dist/es/commands/ListThemeVersionsCommand.js +1 -1
- package/dist/es/commands/ListThemesCommand.js +1 -1
- package/dist/es/commands/TagResourceCommand.js +5 -5
- package/dist/es/commands/UpdateAccountCustomizationCommand.js +3 -3
- package/dist/es/commands/UpdateAccountSettingsCommand.js +1 -1
- package/dist/es/commands/UpdateDashboardCommand.js +1 -1
- package/dist/es/commands/UpdateIAMPolicyAssignmentCommand.js +1 -1
- package/dist/es/endpoints.js +1 -2
- package/dist/es/endpoints.js.map +1 -1
- package/dist/es/models/models_0.js +37 -25
- package/dist/es/models/models_0.js.map +1 -1
- package/dist/es/models/models_1.js +25 -0
- package/dist/es/models/models_1.js.map +1 -1
- package/dist/es/package.json +31 -31
- package/dist/es/protocols/Aws_restJson1.js +835 -530
- package/dist/es/protocols/Aws_restJson1.js.map +1 -1
- package/dist/types/QuickSight.d.ts +59 -59
- package/dist/types/commands/CreateAccountCustomizationCommand.d.ts +4 -4
- package/dist/types/commands/CreateDashboardCommand.d.ts +3 -3
- package/dist/types/commands/CreateIAMPolicyAssignmentCommand.d.ts +2 -2
- package/dist/types/commands/CreateNamespaceCommand.d.ts +4 -4
- package/dist/types/commands/CreateTemplateCommand.d.ts +1 -1
- package/dist/types/commands/DeleteAccountCustomizationCommand.d.ts +1 -1
- package/dist/types/commands/DeleteAnalysisCommand.d.ts +3 -3
- package/dist/types/commands/DeleteIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist/types/commands/DescribeAccountCustomizationCommand.d.ts +12 -12
- package/dist/types/commands/DescribeAccountSettingsCommand.d.ts +2 -2
- package/dist/types/commands/DescribeIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist/types/commands/GetDashboardEmbedUrlCommand.d.ts +1 -1
- package/dist/types/commands/GetSessionEmbedUrlCommand.d.ts +3 -3
- package/dist/types/commands/ListAnalysesCommand.d.ts +1 -1
- package/dist/types/commands/ListDashboardVersionsCommand.d.ts +1 -1
- package/dist/types/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist/types/commands/ListDataSetsCommand.d.ts +1 -1
- package/dist/types/commands/ListDataSourcesCommand.d.ts +1 -1
- package/dist/types/commands/ListIAMPolicyAssignmentsCommand.d.ts +1 -1
- package/dist/types/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +1 -1
- package/dist/types/commands/ListNamespacesCommand.d.ts +1 -1
- package/dist/types/commands/ListThemeVersionsCommand.d.ts +1 -1
- package/dist/types/commands/ListThemesCommand.d.ts +1 -1
- package/dist/types/commands/TagResourceCommand.d.ts +5 -5
- package/dist/types/commands/UpdateAccountCustomizationCommand.d.ts +3 -3
- package/dist/types/commands/UpdateAccountSettingsCommand.d.ts +1 -1
- package/dist/types/commands/UpdateDashboardCommand.d.ts +1 -1
- package/dist/types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist/types/models/models_0.d.ts +340 -293
- package/dist/types/models/models_1.d.ts +214 -129
- package/dist/types/ts3.4/QuickSight.d.ts +59 -59
- package/dist/types/ts3.4/commands/CreateAccountCustomizationCommand.d.ts +4 -4
- package/dist/types/ts3.4/commands/CreateDashboardCommand.d.ts +3 -3
- package/dist/types/ts3.4/commands/CreateIAMPolicyAssignmentCommand.d.ts +2 -2
- package/dist/types/ts3.4/commands/CreateNamespaceCommand.d.ts +4 -4
- package/dist/types/ts3.4/commands/CreateTemplateCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/DeleteAccountCustomizationCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/DeleteAnalysisCommand.d.ts +3 -3
- package/dist/types/ts3.4/commands/DeleteIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/DescribeAccountCustomizationCommand.d.ts +12 -12
- package/dist/types/ts3.4/commands/DescribeAccountSettingsCommand.d.ts +2 -2
- package/dist/types/ts3.4/commands/DescribeIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/GetDashboardEmbedUrlCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/GetSessionEmbedUrlCommand.d.ts +3 -3
- package/dist/types/ts3.4/commands/ListAnalysesCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListDashboardVersionsCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListDataSetsCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListDataSourcesCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListIAMPolicyAssignmentsCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListNamespacesCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListThemeVersionsCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListThemesCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/TagResourceCommand.d.ts +5 -5
- package/dist/types/ts3.4/commands/UpdateAccountCustomizationCommand.d.ts +3 -3
- package/dist/types/ts3.4/commands/UpdateAccountSettingsCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/UpdateDashboardCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist/types/ts3.4/models/models_0.d.ts +340 -293
- package/dist/types/ts3.4/models/models_1.d.ts +214 -129
- package/models/models_0.ts +369 -312
- package/models/models_1.ts +238 -131
- package/package.json +31 -31
- package/protocols/Aws_restJson1.ts +321 -190
|
@@ -131,12 +131,12 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
131
131
|
* <p>Creates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, you can
|
|
132
132
|
* add a custom default theme by using the <code>CreateAccountCustomization</code> or
|
|
133
133
|
* <code>UpdateAccountCustomization</code> API operation. To further customize
|
|
134
|
-
* QuickSight by removing QuickSight sample assets and videos for all new users, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html">Customizing QuickSight</a> in the <i>Amazon QuickSight User
|
|
134
|
+
* Amazon QuickSight by removing Amazon QuickSight 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
|
|
135
135
|
* Guide.</i>
|
|
136
136
|
* </p>
|
|
137
|
-
* <p>You can create customizations for your Amazon Web Services account
|
|
138
|
-
* a QuickSight namespace instead. Customizations that apply to a namespace always override
|
|
139
|
-
* customizations that apply to an Amazon Web Services account
|
|
137
|
+
* <p>You can create customizations for your Amazon Web Services account or, if you specify a namespace, for
|
|
138
|
+
* a Amazon QuickSight namespace instead. Customizations that apply to a namespace always override
|
|
139
|
+
* customizations that apply to an Amazon Web Services account. To find out which customizations apply, use
|
|
140
140
|
* the <code>DescribeAccountCustomization</code> API operation.</p>
|
|
141
141
|
* <p>Before you use the <code>CreateAccountCustomization</code> API operation to add a theme
|
|
142
142
|
* as the namespace default, make sure that you first share the theme with the namespace.
|
|
@@ -164,10 +164,10 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
164
164
|
* <p>Creates a dashboard from a template. To first create a template, see the <code>
|
|
165
165
|
* <a>CreateTemplate</a>
|
|
166
166
|
* </code> API operation.</p>
|
|
167
|
-
* <p>A dashboard is an entity in QuickSight that identifies QuickSight reports, created
|
|
168
|
-
* from analyses. You can share QuickSight dashboards. With the right permissions, you can
|
|
167
|
+
* <p>A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created
|
|
168
|
+
* from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can
|
|
169
169
|
* create scheduled email reports from them. If you have the correct permissions, you can
|
|
170
|
-
* create a dashboard from a template that exists in a different Amazon Web Services account
|
|
170
|
+
* create a dashboard from a template that exists in a different Amazon Web Services account.</p>
|
|
171
171
|
*/
|
|
172
172
|
createDashboard(args: CreateDashboardCommandInput, options?: __HttpHandlerOptions): Promise<CreateDashboardCommandOutput>;
|
|
173
173
|
createDashboard(args: CreateDashboardCommandInput, cb: (err: any, data?: CreateDashboardCommandOutput) => void): void;
|
|
@@ -213,9 +213,9 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
213
213
|
createGroupMembership(args: CreateGroupMembershipCommandInput, cb: (err: any, data?: CreateGroupMembershipCommandOutput) => void): void;
|
|
214
214
|
createGroupMembership(args: CreateGroupMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupMembershipCommandOutput) => void): void;
|
|
215
215
|
/**
|
|
216
|
-
* <p>Creates an assignment with one specified
|
|
216
|
+
* <p>Creates an assignment with one specified IAMpolicy, identified by its Amazon Resource Name
|
|
217
217
|
* (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight.
|
|
218
|
-
* Assignment names are unique per Amazon Web Services account
|
|
218
|
+
* Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces,
|
|
219
219
|
* use assignment names that are unique.</p>
|
|
220
220
|
*/
|
|
221
221
|
createIAMPolicyAssignment(args: CreateIAMPolicyAssignmentCommandInput, options?: __HttpHandlerOptions): Promise<CreateIAMPolicyAssignmentCommandOutput>;
|
|
@@ -233,12 +233,12 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
233
233
|
createIngestion(args: CreateIngestionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIngestionCommandOutput) => void): void;
|
|
234
234
|
/**
|
|
235
235
|
* <p>(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.</p>
|
|
236
|
-
* <p>A namespace allows you to isolate the QuickSight users and groups that are registered
|
|
236
|
+
* <p>A namespace allows you to isolate the Amazon QuickSight users and groups that are registered
|
|
237
237
|
* for that namespace. Users that access the namespace can share assets only with other
|
|
238
238
|
* users or groups in the same namespace. They can't see users and groups in other
|
|
239
|
-
* namespaces. You can create a namespace after your Amazon Web Services account
|
|
240
|
-
* QuickSight. The namespace must be unique within the Amazon Web Services account
|
|
241
|
-
* limit of 100 namespaces per Amazon Web Services account
|
|
239
|
+
* namespaces. You can create a namespace after your Amazon Web Services account is subscribed to
|
|
240
|
+
* Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a
|
|
241
|
+
* limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with
|
|
242
242
|
* Amazon Web Services Support. </p>
|
|
243
243
|
*/
|
|
244
244
|
createNamespace(args: CreateNamespaceCommandInput, options?: __HttpHandlerOptions): Promise<CreateNamespaceCommandOutput>;
|
|
@@ -247,7 +247,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
247
247
|
/**
|
|
248
248
|
* <p>Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting
|
|
249
249
|
* template to create a dashboard.</p>
|
|
250
|
-
* <p>A <i>template</i> is an entity in QuickSight that encapsulates the metadata
|
|
250
|
+
* <p>A <i>template</i> is an entity in Amazon QuickSight that encapsulates the metadata
|
|
251
251
|
* required to create an analysis and that you can use to create s dashboard. A template adds
|
|
252
252
|
* a layer of abstraction by using placeholders to replace the dataset associated with the
|
|
253
253
|
* analysis. You can use templates to create dashboards by replacing dataset placeholders
|
|
@@ -280,7 +280,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
280
280
|
createThemeAlias(args: CreateThemeAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateThemeAliasCommandOutput) => void): void;
|
|
281
281
|
/**
|
|
282
282
|
* <p>Deletes all Amazon QuickSight customizations in this Amazon Web Services Region; for the specified
|
|
283
|
-
* Amazon Web Services account
|
|
283
|
+
* Amazon Web Services account and Amazon QuickSight namespace.</p>
|
|
284
284
|
*/
|
|
285
285
|
deleteAccountCustomization(args: DeleteAccountCustomizationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAccountCustomizationCommandOutput>;
|
|
286
286
|
deleteAccountCustomization(args: DeleteAccountCustomizationCommandInput, cb: (err: any, data?: DeleteAccountCustomizationCommandOutput) => void): void;
|
|
@@ -288,14 +288,14 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
288
288
|
/**
|
|
289
289
|
* <p>Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during
|
|
290
290
|
* which you can restore the analysis. If you don't specify a recovery window value, the
|
|
291
|
-
* operation defaults to 30 days. QuickSight attaches a <code>DeletionTime</code> stamp to
|
|
291
|
+
* operation defaults to 30 days. Amazon QuickSight attaches a <code>DeletionTime</code> stamp to
|
|
292
292
|
* the response that specifies the end of the recovery window. At the end of the recovery
|
|
293
|
-
* window, QuickSight deletes the analysis permanently.</p>
|
|
293
|
+
* window, Amazon QuickSight deletes the analysis permanently.</p>
|
|
294
294
|
* <p>At any time before recovery window ends, you can use the <code>RestoreAnalysis</code>
|
|
295
295
|
* API operation to remove the <code>DeletionTime</code> stamp and cancel the deletion of
|
|
296
296
|
* the analysis. The analysis remains visible in the API until it's deleted, so you can
|
|
297
297
|
* describe it but you can't make a template from it.</p>
|
|
298
|
-
* <p>An analysis that's scheduled for deletion isn't accessible in the QuickSight console.
|
|
298
|
+
* <p>An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console.
|
|
299
299
|
* To access it in the console, restore it. Deleting an analysis doesn't delete the
|
|
300
300
|
* dashboards that you publish from it.</p>
|
|
301
301
|
*/
|
|
@@ -346,7 +346,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
346
346
|
deleteGroupMembership(args: DeleteGroupMembershipCommandInput, cb: (err: any, data?: DeleteGroupMembershipCommandOutput) => void): void;
|
|
347
347
|
deleteGroupMembership(args: DeleteGroupMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupMembershipCommandOutput) => void): void;
|
|
348
348
|
/**
|
|
349
|
-
* <p>Deletes an existing
|
|
349
|
+
* <p>Deletes an existing IAMpolicy assignment.</p>
|
|
350
350
|
*/
|
|
351
351
|
deleteIAMPolicyAssignment(args: DeleteIAMPolicyAssignmentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteIAMPolicyAssignmentCommandOutput>;
|
|
352
352
|
deleteIAMPolicyAssignment(args: DeleteIAMPolicyAssignmentCommandInput, cb: (err: any, data?: DeleteIAMPolicyAssignmentCommandOutput) => void): void;
|
|
@@ -401,8 +401,8 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
401
401
|
deleteUserByPrincipalId(args: DeleteUserByPrincipalIdCommandInput, cb: (err: any, data?: DeleteUserByPrincipalIdCommandOutput) => void): void;
|
|
402
402
|
deleteUserByPrincipalId(args: DeleteUserByPrincipalIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserByPrincipalIdCommandOutput) => void): void;
|
|
403
403
|
/**
|
|
404
|
-
* <p>Describes the customizations associated with the provided Amazon Web Services account
|
|
405
|
-
* QuickSight namespace in an Amazon Web Services Region;. The QuickSight console evaluates which
|
|
404
|
+
* <p>Describes the customizations associated with the provided Amazon Web Services account and Amazon
|
|
405
|
+
* Amazon QuickSight namespace in an Amazon Web Services Region;. The Amazon QuickSight console evaluates which
|
|
406
406
|
* customizations to apply by running this API operation with the <code>Resolved</code> flag
|
|
407
407
|
* included. </p>
|
|
408
408
|
* <p>To determine what customizations display when you run this command, it can help to
|
|
@@ -410,18 +410,18 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
410
410
|
* <ul>
|
|
411
411
|
* <li>
|
|
412
412
|
* <p>
|
|
413
|
-
* <code>Amazon Web Services account
|
|
413
|
+
* <code>Amazon Web Services account</code> - The Amazon Web Services account exists at the top of the hierarchy.
|
|
414
414
|
* It has the potential to use all of the Amazon Web Services Regions; and AWS Services. When you
|
|
415
|
-
* subscribe to QuickSight, you choose one Amazon Web Services Region; to use as your home Region.
|
|
416
|
-
* That's where your free SPICE capacity is located. You can use QuickSight in any
|
|
415
|
+
* subscribe to Amazon QuickSight, you choose one Amazon Web Services Region; to use as your home Region.
|
|
416
|
+
* That's where your free SPICE capacity is located. You can use Amazon QuickSight in any
|
|
417
417
|
* supported Amazon Web Services Region;. </p>
|
|
418
418
|
* </li>
|
|
419
419
|
* <li>
|
|
420
420
|
* <p>
|
|
421
|
-
* <code>Amazon Web Services Region;</code> - In each Amazon Web Services Region; where you sign in to QuickSight
|
|
422
|
-
* at least once, QuickSight acts as a separate instance of the same service. If
|
|
421
|
+
* <code>Amazon Web Services Region;</code> - In each Amazon Web Services Region; where you sign in to Amazon QuickSight
|
|
422
|
+
* at least once, Amazon QuickSight acts as a separate instance of the same service. If
|
|
423
423
|
* you have a user directory, it resides in us-east-1, which is the US East (N.
|
|
424
|
-
* Virginia). Generally speaking, these users have access to QuickSight in any
|
|
424
|
+
* Virginia). Generally speaking, these users have access to Amazon QuickSight in any
|
|
425
425
|
* Amazon Web Services Region;, unless they are constrained to a namespace. </p>
|
|
426
426
|
* <p>To run the command in a different Amazon Web Services Region;, you change your Region settings.
|
|
427
427
|
* If you're using the AWS CLI, you can use one of the following options:</p>
|
|
@@ -441,19 +441,19 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
441
441
|
* </li>
|
|
442
442
|
* <li>
|
|
443
443
|
* <p>
|
|
444
|
-
* <code>Namespace</code> - A QuickSight namespace is a partition that contains
|
|
444
|
+
* <code>Namespace</code> - A Amazon QuickSight namespace is a partition that contains
|
|
445
445
|
* users and assets (data sources, datasets, dashboards, and so on). To access
|
|
446
446
|
* assets that are in a specific namespace, users and groups must also be part of
|
|
447
447
|
* the same namespace. People who share a namespace are completely isolated from
|
|
448
|
-
* users and assets in other namespaces, even if they are in the same Amazon Web Services account
|
|
448
|
+
* users and assets in other namespaces, even if they are in the same Amazon Web Services account
|
|
449
449
|
* and Amazon Web Services Region;.</p>
|
|
450
450
|
* </li>
|
|
451
451
|
* <li>
|
|
452
452
|
* <p>
|
|
453
453
|
* <code>Applied customizations</code> - Within an Amazon Web Services Region;, a set of
|
|
454
|
-
* QuickSight customizations can apply to an Amazon Web Services account
|
|
454
|
+
* Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace.
|
|
455
455
|
* Settings that you apply to a namespace override settings that you apply to an
|
|
456
|
-
* Amazon Web Services account
|
|
456
|
+
* Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region;. To apply them in
|
|
457
457
|
* other Amazon Web Services Regions;, run the <code>CreateAccountCustomization</code> command in
|
|
458
458
|
* each Amazon Web Services Region; where you want to apply the same customizations. </p>
|
|
459
459
|
* </li>
|
|
@@ -463,8 +463,8 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
463
463
|
describeAccountCustomization(args: DescribeAccountCustomizationCommandInput, cb: (err: any, data?: DescribeAccountCustomizationCommandOutput) => void): void;
|
|
464
464
|
describeAccountCustomization(args: DescribeAccountCustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountCustomizationCommandOutput) => void): void;
|
|
465
465
|
/**
|
|
466
|
-
* <p>Describes the settings that were used when your QuickSight subscription was first
|
|
467
|
-
* created in this Amazon Web Services account
|
|
466
|
+
* <p>Describes the settings that were used when your Amazon QuickSight subscription was first
|
|
467
|
+
* created in this Amazon Web Services account.</p>
|
|
468
468
|
*/
|
|
469
469
|
describeAccountSettings(args: DescribeAccountSettingsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAccountSettingsCommandOutput>;
|
|
470
470
|
describeAccountSettings(args: DescribeAccountSettingsCommandInput, cb: (err: any, data?: DescribeAccountSettingsCommandOutput) => void): void;
|
|
@@ -543,7 +543,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
543
543
|
describeGroup(args: DescribeGroupCommandInput, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void;
|
|
544
544
|
describeGroup(args: DescribeGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void;
|
|
545
545
|
/**
|
|
546
|
-
* <p>Describes an existing
|
|
546
|
+
* <p>Describes an existing IAMpolicy assignment, as specified by the assignment name.</p>
|
|
547
547
|
*/
|
|
548
548
|
describeIAMPolicyAssignment(args: DescribeIAMPolicyAssignmentCommandInput, options?: __HttpHandlerOptions): Promise<DescribeIAMPolicyAssignmentCommandOutput>;
|
|
549
549
|
describeIAMPolicyAssignment(args: DescribeIAMPolicyAssignmentCommandInput, cb: (err: any, data?: DescribeIAMPolicyAssignmentCommandOutput) => void): void;
|
|
@@ -654,7 +654,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
654
654
|
generateEmbedUrlForRegisteredUser(args: GenerateEmbedUrlForRegisteredUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateEmbedUrlForRegisteredUserCommandOutput) => void): void;
|
|
655
655
|
/**
|
|
656
656
|
* <p>Generates a session URL and authorization code that you can use to embed an Amazon
|
|
657
|
-
* QuickSight read-only dashboard in your web server code. Before you use this command,
|
|
657
|
+
* Amazon QuickSight read-only dashboard in your web server code. Before you use this command,
|
|
658
658
|
* make sure that you have configured the dashboards and permissions. </p>
|
|
659
659
|
* <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not
|
|
660
660
|
* from the user's browser. The following rules apply to the combination of URL and
|
|
@@ -682,9 +682,9 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
682
682
|
getDashboardEmbedUrl(args: GetDashboardEmbedUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDashboardEmbedUrlCommandOutput) => void): void;
|
|
683
683
|
/**
|
|
684
684
|
* <p>Generates a session URL and authorization code that you can use to embed the Amazon
|
|
685
|
-
* QuickSight console in your web server code. Use <code>GetSessionEmbedUrl</code> where
|
|
685
|
+
* Amazon QuickSight console in your web server code. Use <code>GetSessionEmbedUrl</code> where
|
|
686
686
|
* you want to provide an authoring portal that allows users to create data sources,
|
|
687
|
-
* datasets, analyses, and dashboards. The users who access an embedded QuickSight console
|
|
687
|
+
* datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console
|
|
688
688
|
* need belong to the author or admin security cohort. If you want to restrict permissions
|
|
689
689
|
* to some of these features, add a custom permissions profile to the user with the
|
|
690
690
|
* <code>
|
|
@@ -697,7 +697,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
697
697
|
* <ul>
|
|
698
698
|
* <li>
|
|
699
699
|
* <p>
|
|
700
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics
|
|
700
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html">Embedding Analytics</a>
|
|
701
701
|
* </p>
|
|
702
702
|
* </li>
|
|
703
703
|
* <li>
|
|
@@ -711,32 +711,32 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
711
711
|
getSessionEmbedUrl(args: GetSessionEmbedUrlCommandInput, cb: (err: any, data?: GetSessionEmbedUrlCommandOutput) => void): void;
|
|
712
712
|
getSessionEmbedUrl(args: GetSessionEmbedUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSessionEmbedUrlCommandOutput) => void): void;
|
|
713
713
|
/**
|
|
714
|
-
* <p>Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account
|
|
714
|
+
* <p>Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.</p>
|
|
715
715
|
*/
|
|
716
716
|
listAnalyses(args: ListAnalysesCommandInput, options?: __HttpHandlerOptions): Promise<ListAnalysesCommandOutput>;
|
|
717
717
|
listAnalyses(args: ListAnalysesCommandInput, cb: (err: any, data?: ListAnalysesCommandOutput) => void): void;
|
|
718
718
|
listAnalyses(args: ListAnalysesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAnalysesCommandOutput) => void): void;
|
|
719
719
|
/**
|
|
720
|
-
* <p>Lists dashboards in an Amazon Web Services account
|
|
720
|
+
* <p>Lists dashboards in an Amazon Web Services account.</p>
|
|
721
721
|
*/
|
|
722
722
|
listDashboards(args: ListDashboardsCommandInput, options?: __HttpHandlerOptions): Promise<ListDashboardsCommandOutput>;
|
|
723
723
|
listDashboards(args: ListDashboardsCommandInput, cb: (err: any, data?: ListDashboardsCommandOutput) => void): void;
|
|
724
724
|
listDashboards(args: ListDashboardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDashboardsCommandOutput) => void): void;
|
|
725
725
|
/**
|
|
726
|
-
* <p>Lists all the versions of the dashboards in the QuickSight subscription.</p>
|
|
726
|
+
* <p>Lists all the versions of the dashboards in the Amazon QuickSight subscription.</p>
|
|
727
727
|
*/
|
|
728
728
|
listDashboardVersions(args: ListDashboardVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListDashboardVersionsCommandOutput>;
|
|
729
729
|
listDashboardVersions(args: ListDashboardVersionsCommandInput, cb: (err: any, data?: ListDashboardVersionsCommandOutput) => void): void;
|
|
730
730
|
listDashboardVersions(args: ListDashboardVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDashboardVersionsCommandOutput) => void): void;
|
|
731
731
|
/**
|
|
732
|
-
* <p>Lists all of the datasets belonging to the current Amazon Web Services account
|
|
732
|
+
* <p>Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region;.</p>
|
|
733
733
|
* <p>The permissions resource is <code>arn:aws:quicksight:region:aws-account-id:dataset/*</code>.</p>
|
|
734
734
|
*/
|
|
735
735
|
listDataSets(args: ListDataSetsCommandInput, options?: __HttpHandlerOptions): Promise<ListDataSetsCommandOutput>;
|
|
736
736
|
listDataSets(args: ListDataSetsCommandInput, cb: (err: any, data?: ListDataSetsCommandOutput) => void): void;
|
|
737
737
|
listDataSets(args: ListDataSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSetsCommandOutput) => void): void;
|
|
738
738
|
/**
|
|
739
|
-
* <p>Lists data sources in current Amazon Web Services Region; that belong to this Amazon Web Services account
|
|
739
|
+
* <p>Lists data sources in current Amazon Web Services Region; that belong to this Amazon Web Services account.</p>
|
|
740
740
|
*/
|
|
741
741
|
listDataSources(args: ListDataSourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListDataSourcesCommandOutput>;
|
|
742
742
|
listDataSources(args: ListDataSourcesCommandInput, cb: (err: any, data?: ListDataSourcesCommandOutput) => void): void;
|
|
@@ -766,13 +766,13 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
766
766
|
listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
|
|
767
767
|
listGroups(args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
|
|
768
768
|
/**
|
|
769
|
-
* <p>Lists
|
|
769
|
+
* <p>Lists IAMpolicy assignments in the current Amazon QuickSight account.</p>
|
|
770
770
|
*/
|
|
771
771
|
listIAMPolicyAssignments(args: ListIAMPolicyAssignmentsCommandInput, options?: __HttpHandlerOptions): Promise<ListIAMPolicyAssignmentsCommandOutput>;
|
|
772
772
|
listIAMPolicyAssignments(args: ListIAMPolicyAssignmentsCommandInput, cb: (err: any, data?: ListIAMPolicyAssignmentsCommandOutput) => void): void;
|
|
773
773
|
listIAMPolicyAssignments(args: ListIAMPolicyAssignmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIAMPolicyAssignmentsCommandOutput) => void): void;
|
|
774
774
|
/**
|
|
775
|
-
* <p>Lists all the
|
|
775
|
+
* <p>Lists all the IAMpolicy assignments, including the Amazon Resource Names (ARNs) for the IAM
|
|
776
776
|
* policies assigned to the specified user and group or groups that the user belongs
|
|
777
777
|
* to.</p>
|
|
778
778
|
*/
|
|
@@ -786,7 +786,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
786
786
|
listIngestions(args: ListIngestionsCommandInput, cb: (err: any, data?: ListIngestionsCommandOutput) => void): void;
|
|
787
787
|
listIngestions(args: ListIngestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIngestionsCommandOutput) => void): void;
|
|
788
788
|
/**
|
|
789
|
-
* <p>Lists the namespaces for the specified Amazon Web Services account
|
|
789
|
+
* <p>Lists the namespaces for the specified Amazon Web Services account.</p>
|
|
790
790
|
*/
|
|
791
791
|
listNamespaces(args: ListNamespacesCommandInput, options?: __HttpHandlerOptions): Promise<ListNamespacesCommandOutput>;
|
|
792
792
|
listNamespaces(args: ListNamespacesCommandInput, cb: (err: any, data?: ListNamespacesCommandOutput) => void): void;
|
|
@@ -822,13 +822,13 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
822
822
|
listThemeAliases(args: ListThemeAliasesCommandInput, cb: (err: any, data?: ListThemeAliasesCommandOutput) => void): void;
|
|
823
823
|
listThemeAliases(args: ListThemeAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThemeAliasesCommandOutput) => void): void;
|
|
824
824
|
/**
|
|
825
|
-
* <p>Lists all the themes in the current Amazon Web Services account
|
|
825
|
+
* <p>Lists all the themes in the current Amazon Web Services account.</p>
|
|
826
826
|
*/
|
|
827
827
|
listThemes(args: ListThemesCommandInput, options?: __HttpHandlerOptions): Promise<ListThemesCommandOutput>;
|
|
828
828
|
listThemes(args: ListThemesCommandInput, cb: (err: any, data?: ListThemesCommandOutput) => void): void;
|
|
829
829
|
listThemes(args: ListThemesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThemesCommandOutput) => void): void;
|
|
830
830
|
/**
|
|
831
|
-
* <p>Lists all the versions of the themes in the current Amazon Web Services account
|
|
831
|
+
* <p>Lists all the versions of the themes in the current Amazon Web Services account.</p>
|
|
832
832
|
*/
|
|
833
833
|
listThemeVersions(args: ListThemeVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListThemeVersionsCommandOutput>;
|
|
834
834
|
listThemeVersions(args: ListThemeVersionsCommandInput, cb: (err: any, data?: ListThemeVersionsCommandOutput) => void): void;
|
|
@@ -883,7 +883,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
883
883
|
searchFolders(args: SearchFoldersCommandInput, cb: (err: any, data?: SearchFoldersCommandOutput) => void): void;
|
|
884
884
|
searchFolders(args: SearchFoldersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchFoldersCommandOutput) => void): void;
|
|
885
885
|
/**
|
|
886
|
-
* <p>Assigns one or more tags (key-value pairs) to the specified QuickSight resource. </p>
|
|
886
|
+
* <p>Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource. </p>
|
|
887
887
|
* <p>Tags can help you organize and categorize your resources. You can also use them to
|
|
888
888
|
* scope user permissions, by granting a user permission to access or change only resources
|
|
889
889
|
* with certain tag values. You can use the <code>TagResource</code> operation with a
|
|
@@ -891,18 +891,18 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
891
891
|
* is appended to the list of tags associated with the resource. If you specify a tag key
|
|
892
892
|
* that is already associated with the resource, the new tag value that you specify
|
|
893
893
|
* replaces the previous value for that tag.</p>
|
|
894
|
-
* <p>You can associate as many as 50 tags with a resource. QuickSight supports tagging on data
|
|
894
|
+
* <p>You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data
|
|
895
895
|
* set, data source, dashboard, and template. </p>
|
|
896
|
-
* <p>Tagging for QuickSight works in a similar way to tagging for other AWS services, except for
|
|
896
|
+
* <p>Tagging for Amazon QuickSight works in a similar way to tagging for other AWS services, except for
|
|
897
897
|
* the following:</p>
|
|
898
898
|
* <ul>
|
|
899
899
|
* <li>
|
|
900
|
-
* <p>You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight
|
|
900
|
+
* <p>You can't use tags to track AWS costs for Amazon QuickSight. This restriction is because Amazon QuickSight
|
|
901
901
|
* costs are based on users and SPICE capacity, which aren't taggable
|
|
902
902
|
* resources.</p>
|
|
903
903
|
* </li>
|
|
904
904
|
* <li>
|
|
905
|
-
* <p>QuickSight doesn't currently support the Tag Editor for Resource Groups.</p>
|
|
905
|
+
* <p>Amazon QuickSight doesn't currently support the Tag Editor for Resource Groups.</p>
|
|
906
906
|
* </li>
|
|
907
907
|
* </ul>
|
|
908
908
|
*/
|
|
@@ -918,16 +918,16 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
918
918
|
/**
|
|
919
919
|
* <p>Updates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, the only
|
|
920
920
|
* customization you can use is a theme.</p>
|
|
921
|
-
* <p>You can use customizations for your Amazon Web Services account
|
|
922
|
-
* QuickSight namespace instead. Customizations that apply to a namespace override
|
|
923
|
-
* customizations that apply to an Amazon Web Services account
|
|
921
|
+
* <p>You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a
|
|
922
|
+
* Amazon QuickSight namespace instead. Customizations that apply to a namespace override
|
|
923
|
+
* customizations that apply to an Amazon Web Services account. To find out which customizations apply, use
|
|
924
924
|
* the <code>DescribeAccountCustomization</code> API operation. </p>
|
|
925
925
|
*/
|
|
926
926
|
updateAccountCustomization(args: UpdateAccountCustomizationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAccountCustomizationCommandOutput>;
|
|
927
927
|
updateAccountCustomization(args: UpdateAccountCustomizationCommandInput, cb: (err: any, data?: UpdateAccountCustomizationCommandOutput) => void): void;
|
|
928
928
|
updateAccountCustomization(args: UpdateAccountCustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountCustomizationCommandOutput) => void): void;
|
|
929
929
|
/**
|
|
930
|
-
* <p>Updates the Amazon QuickSight settings in your Amazon Web Services account
|
|
930
|
+
* <p>Updates the Amazon QuickSight settings in your Amazon Web Services account.</p>
|
|
931
931
|
*/
|
|
932
932
|
updateAccountSettings(args: UpdateAccountSettingsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAccountSettingsCommandOutput>;
|
|
933
933
|
updateAccountSettings(args: UpdateAccountSettingsCommandInput, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void): void;
|
|
@@ -945,7 +945,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
945
945
|
updateAnalysisPermissions(args: UpdateAnalysisPermissionsCommandInput, cb: (err: any, data?: UpdateAnalysisPermissionsCommandOutput) => void): void;
|
|
946
946
|
updateAnalysisPermissions(args: UpdateAnalysisPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAnalysisPermissionsCommandOutput) => void): void;
|
|
947
947
|
/**
|
|
948
|
-
* <p>Updates a dashboard in an Amazon Web Services account
|
|
948
|
+
* <p>Updates a dashboard in an Amazon Web Services account.</p>
|
|
949
949
|
* <note>
|
|
950
950
|
* <p>Updating a Dashboard creates a new dashboard version but does not immediately publish
|
|
951
951
|
* the new version. You can update the published version of a dashboard by
|
|
@@ -1011,7 +1011,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
1011
1011
|
updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
|
|
1012
1012
|
updateGroup(args: UpdateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
|
|
1013
1013
|
/**
|
|
1014
|
-
* <p>Updates an existing
|
|
1014
|
+
* <p>Updates an existing IAMpolicy assignment. This operation updates only the optional
|
|
1015
1015
|
* parameter or parameters that are specified in the request.
|
|
1016
1016
|
* This overwrites all of the users included in <code>Identities</code>.
|
|
1017
1017
|
* </p>
|
|
@@ -10,12 +10,12 @@ export interface CreateAccountCustomizationCommandOutput extends CreateAccountCu
|
|
|
10
10
|
* <p>Creates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, you can
|
|
11
11
|
* add a custom default theme by using the <code>CreateAccountCustomization</code> or
|
|
12
12
|
* <code>UpdateAccountCustomization</code> API operation. To further customize
|
|
13
|
-
* QuickSight by removing QuickSight sample assets and videos for all new users, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html">Customizing QuickSight</a> in the <i>Amazon QuickSight User
|
|
13
|
+
* Amazon QuickSight by removing Amazon QuickSight 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
|
|
14
14
|
* Guide.</i>
|
|
15
15
|
* </p>
|
|
16
|
-
* <p>You can create customizations for your Amazon Web Services account
|
|
17
|
-
* a QuickSight namespace instead. Customizations that apply to a namespace always override
|
|
18
|
-
* customizations that apply to an Amazon Web Services account
|
|
16
|
+
* <p>You can create customizations for your Amazon Web Services account or, if you specify a namespace, for
|
|
17
|
+
* a Amazon QuickSight namespace instead. Customizations that apply to a namespace always override
|
|
18
|
+
* customizations that apply to an Amazon Web Services account. To find out which customizations apply, use
|
|
19
19
|
* the <code>DescribeAccountCustomization</code> API operation.</p>
|
|
20
20
|
* <p>Before you use the <code>CreateAccountCustomization</code> API operation to add a theme
|
|
21
21
|
* as the namespace default, make sure that you first share the theme with the namespace.
|
|
@@ -10,10 +10,10 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _
|
|
|
10
10
|
* <p>Creates a dashboard from a template. To first create a template, see the <code>
|
|
11
11
|
* <a>CreateTemplate</a>
|
|
12
12
|
* </code> API operation.</p>
|
|
13
|
-
* <p>A dashboard is an entity in QuickSight that identifies QuickSight reports, created
|
|
14
|
-
* from analyses. You can share QuickSight dashboards. With the right permissions, you can
|
|
13
|
+
* <p>A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created
|
|
14
|
+
* from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can
|
|
15
15
|
* create scheduled email reports from them. If you have the correct permissions, you can
|
|
16
|
-
* create a dashboard from a template that exists in a different Amazon Web Services account
|
|
16
|
+
* create a dashboard from a template that exists in a different Amazon Web Services account.</p>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
19
|
* ```javascript
|
|
@@ -7,9 +7,9 @@ export interface CreateIAMPolicyAssignmentCommandInput extends CreateIAMPolicyAs
|
|
|
7
7
|
export interface CreateIAMPolicyAssignmentCommandOutput extends CreateIAMPolicyAssignmentResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates an assignment with one specified
|
|
10
|
+
* <p>Creates an assignment with one specified IAMpolicy, identified by its Amazon Resource Name
|
|
11
11
|
* (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight.
|
|
12
|
-
* Assignment names are unique per Amazon Web Services account
|
|
12
|
+
* Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces,
|
|
13
13
|
* use assignment names that are unique.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -8,12 +8,12 @@ export interface CreateNamespaceCommandOutput extends CreateNamespaceResponse, _
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.</p>
|
|
11
|
-
* <p>A namespace allows you to isolate the QuickSight users and groups that are registered
|
|
11
|
+
* <p>A namespace allows you to isolate the Amazon QuickSight users and groups that are registered
|
|
12
12
|
* for that namespace. Users that access the namespace can share assets only with other
|
|
13
13
|
* users or groups in the same namespace. They can't see users and groups in other
|
|
14
|
-
* namespaces. You can create a namespace after your Amazon Web Services account
|
|
15
|
-
* QuickSight. The namespace must be unique within the Amazon Web Services account
|
|
16
|
-
* limit of 100 namespaces per Amazon Web Services account
|
|
14
|
+
* namespaces. You can create a namespace after your Amazon Web Services account is subscribed to
|
|
15
|
+
* Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a
|
|
16
|
+
* limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with
|
|
17
17
|
* Amazon Web Services Support. </p>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting
|
|
11
11
|
* template to create a dashboard.</p>
|
|
12
|
-
* <p>A <i>template</i> is an entity in QuickSight that encapsulates the metadata
|
|
12
|
+
* <p>A <i>template</i> is an entity in Amazon QuickSight that encapsulates the metadata
|
|
13
13
|
* required to create an analysis and that you can use to create s dashboard. A template adds
|
|
14
14
|
* a layer of abstraction by using placeholders to replace the dataset associated with the
|
|
15
15
|
* analysis. You can use templates to create dashboards by replacing dataset placeholders
|
|
@@ -8,7 +8,7 @@ export interface DeleteAccountCustomizationCommandOutput extends DeleteAccountCu
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Deletes all Amazon QuickSight customizations in this Amazon Web Services Region; for the specified
|
|
11
|
-
* Amazon Web Services account
|
|
11
|
+
* Amazon Web Services account and Amazon QuickSight namespace.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -9,14 +9,14 @@ export interface DeleteAnalysisCommandOutput extends DeleteAnalysisResponse, __M
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during
|
|
11
11
|
* which you can restore the analysis. If you don't specify a recovery window value, the
|
|
12
|
-
* operation defaults to 30 days. QuickSight attaches a <code>DeletionTime</code> stamp to
|
|
12
|
+
* operation defaults to 30 days. Amazon QuickSight attaches a <code>DeletionTime</code> stamp to
|
|
13
13
|
* the response that specifies the end of the recovery window. At the end of the recovery
|
|
14
|
-
* window, QuickSight deletes the analysis permanently.</p>
|
|
14
|
+
* window, Amazon QuickSight deletes the analysis permanently.</p>
|
|
15
15
|
* <p>At any time before recovery window ends, you can use the <code>RestoreAnalysis</code>
|
|
16
16
|
* API operation to remove the <code>DeletionTime</code> stamp and cancel the deletion of
|
|
17
17
|
* the analysis. The analysis remains visible in the API until it's deleted, so you can
|
|
18
18
|
* describe it but you can't make a template from it.</p>
|
|
19
|
-
* <p>An analysis that's scheduled for deletion isn't accessible in the QuickSight console.
|
|
19
|
+
* <p>An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console.
|
|
20
20
|
* To access it in the console, restore it. Deleting an analysis doesn't delete the
|
|
21
21
|
* dashboards that you publish from it.</p>
|
|
22
22
|
* @example
|
|
@@ -7,7 +7,7 @@ export interface DeleteIAMPolicyAssignmentCommandInput extends DeleteIAMPolicyAs
|
|
|
7
7
|
export interface DeleteIAMPolicyAssignmentCommandOutput extends DeleteIAMPolicyAssignmentResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes an existing
|
|
10
|
+
* <p>Deletes an existing IAMpolicy assignment.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,8 +7,8 @@ export interface DescribeAccountCustomizationCommandInput extends DescribeAccoun
|
|
|
7
7
|
export interface DescribeAccountCustomizationCommandOutput extends DescribeAccountCustomizationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describes the customizations associated with the provided Amazon Web Services account
|
|
11
|
-
* QuickSight namespace in an Amazon Web Services Region;. The QuickSight console evaluates which
|
|
10
|
+
* <p>Describes the customizations associated with the provided Amazon Web Services account and Amazon
|
|
11
|
+
* Amazon QuickSight namespace in an Amazon Web Services Region;. The Amazon QuickSight console evaluates which
|
|
12
12
|
* customizations to apply by running this API operation with the <code>Resolved</code> flag
|
|
13
13
|
* included. </p>
|
|
14
14
|
* <p>To determine what customizations display when you run this command, it can help to
|
|
@@ -16,18 +16,18 @@ export interface DescribeAccountCustomizationCommandOutput extends DescribeAccou
|
|
|
16
16
|
* <ul>
|
|
17
17
|
* <li>
|
|
18
18
|
* <p>
|
|
19
|
-
* <code>Amazon Web Services account
|
|
19
|
+
* <code>Amazon Web Services account</code> - The Amazon Web Services account exists at the top of the hierarchy.
|
|
20
20
|
* It has the potential to use all of the Amazon Web Services Regions; and AWS Services. When you
|
|
21
|
-
* subscribe to QuickSight, you choose one Amazon Web Services Region; to use as your home Region.
|
|
22
|
-
* That's where your free SPICE capacity is located. You can use QuickSight in any
|
|
21
|
+
* subscribe to Amazon QuickSight, you choose one Amazon Web Services Region; to use as your home Region.
|
|
22
|
+
* That's where your free SPICE capacity is located. You can use Amazon QuickSight in any
|
|
23
23
|
* supported Amazon Web Services Region;. </p>
|
|
24
24
|
* </li>
|
|
25
25
|
* <li>
|
|
26
26
|
* <p>
|
|
27
|
-
* <code>Amazon Web Services Region;</code> - In each Amazon Web Services Region; where you sign in to QuickSight
|
|
28
|
-
* at least once, QuickSight acts as a separate instance of the same service. If
|
|
27
|
+
* <code>Amazon Web Services Region;</code> - In each Amazon Web Services Region; where you sign in to Amazon QuickSight
|
|
28
|
+
* at least once, Amazon QuickSight acts as a separate instance of the same service. If
|
|
29
29
|
* you have a user directory, it resides in us-east-1, which is the US East (N.
|
|
30
|
-
* Virginia). Generally speaking, these users have access to QuickSight in any
|
|
30
|
+
* Virginia). Generally speaking, these users have access to Amazon QuickSight in any
|
|
31
31
|
* Amazon Web Services Region;, unless they are constrained to a namespace. </p>
|
|
32
32
|
* <p>To run the command in a different Amazon Web Services Region;, you change your Region settings.
|
|
33
33
|
* If you're using the AWS CLI, you can use one of the following options:</p>
|
|
@@ -47,19 +47,19 @@ export interface DescribeAccountCustomizationCommandOutput extends DescribeAccou
|
|
|
47
47
|
* </li>
|
|
48
48
|
* <li>
|
|
49
49
|
* <p>
|
|
50
|
-
* <code>Namespace</code> - A QuickSight namespace is a partition that contains
|
|
50
|
+
* <code>Namespace</code> - A Amazon QuickSight namespace is a partition that contains
|
|
51
51
|
* users and assets (data sources, datasets, dashboards, and so on). To access
|
|
52
52
|
* assets that are in a specific namespace, users and groups must also be part of
|
|
53
53
|
* the same namespace. People who share a namespace are completely isolated from
|
|
54
|
-
* users and assets in other namespaces, even if they are in the same Amazon Web Services account
|
|
54
|
+
* users and assets in other namespaces, even if they are in the same Amazon Web Services account
|
|
55
55
|
* and Amazon Web Services Region;.</p>
|
|
56
56
|
* </li>
|
|
57
57
|
* <li>
|
|
58
58
|
* <p>
|
|
59
59
|
* <code>Applied customizations</code> - Within an Amazon Web Services Region;, a set of
|
|
60
|
-
* QuickSight customizations can apply to an Amazon Web Services account
|
|
60
|
+
* Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace.
|
|
61
61
|
* Settings that you apply to a namespace override settings that you apply to an
|
|
62
|
-
* Amazon Web Services account
|
|
62
|
+
* Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region;. To apply them in
|
|
63
63
|
* other Amazon Web Services Regions;, run the <code>CreateAccountCustomization</code> command in
|
|
64
64
|
* each Amazon Web Services Region; where you want to apply the same customizations. </p>
|
|
65
65
|
* </li>
|
|
@@ -7,8 +7,8 @@ export interface DescribeAccountSettingsCommandInput extends DescribeAccountSett
|
|
|
7
7
|
export interface DescribeAccountSettingsCommandOutput extends DescribeAccountSettingsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describes the settings that were used when your QuickSight subscription was first
|
|
11
|
-
* created in this Amazon Web Services account
|
|
10
|
+
* <p>Describes the settings that were used when your Amazon QuickSight subscription was first
|
|
11
|
+
* created in this Amazon Web Services account.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DescribeIAMPolicyAssignmentCommandInput extends DescribeIAMPoli
|
|
|
7
7
|
export interface DescribeIAMPolicyAssignmentCommandOutput extends DescribeIAMPolicyAssignmentResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describes an existing
|
|
10
|
+
* <p>Describes an existing IAMpolicy assignment, as specified by the assignment name.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -8,7 +8,7 @@ export interface GetDashboardEmbedUrlCommandOutput extends GetDashboardEmbedUrlR
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Generates a session URL and authorization code that you can use to embed an Amazon
|
|
11
|
-
* QuickSight read-only dashboard in your web server code. Before you use this command,
|
|
11
|
+
* Amazon QuickSight read-only dashboard in your web server code. Before you use this command,
|
|
12
12
|
* make sure that you have configured the dashboards and permissions. </p>
|
|
13
13
|
* <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not
|
|
14
14
|
* from the user's browser. The following rules apply to the combination of URL and
|
|
@@ -8,9 +8,9 @@ export interface GetSessionEmbedUrlCommandOutput extends GetSessionEmbedUrlRespo
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Generates a session URL and authorization code that you can use to embed the Amazon
|
|
11
|
-
* QuickSight console in your web server code. Use <code>GetSessionEmbedUrl</code> where
|
|
11
|
+
* Amazon QuickSight console in your web server code. Use <code>GetSessionEmbedUrl</code> where
|
|
12
12
|
* you want to provide an authoring portal that allows users to create data sources,
|
|
13
|
-
* datasets, analyses, and dashboards. The users who access an embedded QuickSight console
|
|
13
|
+
* datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console
|
|
14
14
|
* need belong to the author or admin security cohort. If you want to restrict permissions
|
|
15
15
|
* to some of these features, add a custom permissions profile to the user with the
|
|
16
16
|
* <code>
|
|
@@ -23,7 +23,7 @@ export interface GetSessionEmbedUrlCommandOutput extends GetSessionEmbedUrlRespo
|
|
|
23
23
|
* <ul>
|
|
24
24
|
* <li>
|
|
25
25
|
* <p>
|
|
26
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics
|
|
26
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html">Embedding Analytics</a>
|
|
27
27
|
* </p>
|
|
28
28
|
* </li>
|
|
29
29
|
* <li>
|