@aws-sdk/client-quicksight 3.41.0 → 3.46.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/CHANGELOG.md +48 -0
  2. package/dist-cjs/endpoints.js +1 -0
  3. package/dist-cjs/models/models_0.js +21 -18
  4. package/dist-cjs/models/models_1.js +17 -3
  5. package/dist-cjs/protocols/Aws_restJson1.js +80 -0
  6. package/dist-cjs/runtimeConfig.js +0 -2
  7. package/dist-es/endpoints.js +1 -0
  8. package/dist-es/models/models_0.js +13 -12
  9. package/dist-es/models/models_1.js +12 -0
  10. package/dist-es/protocols/Aws_restJson1.js +189 -115
  11. package/dist-es/runtimeConfig.js +0 -2
  12. package/dist-types/QuickSight.d.ts +47 -37
  13. package/dist-types/commands/CreateAccountCustomizationCommand.d.ts +7 -5
  14. package/dist-types/commands/CreateDashboardCommand.d.ts +5 -3
  15. package/dist-types/commands/CreateDataSetCommand.d.ts +1 -1
  16. package/dist-types/commands/CreateIAMPolicyAssignmentCommand.d.ts +1 -1
  17. package/dist-types/commands/CreateIngestionCommand.d.ts +4 -1
  18. package/dist-types/commands/DeleteIAMPolicyAssignmentCommand.d.ts +1 -1
  19. package/dist-types/commands/DescribeAccountCustomizationCommand.d.ts +4 -4
  20. package/dist-types/commands/DescribeDataSetCommand.d.ts +1 -1
  21. package/dist-types/commands/DescribeIAMPolicyAssignmentCommand.d.ts +1 -1
  22. package/dist-types/commands/DescribeIpRestrictionCommand.d.ts +1 -1
  23. package/dist-types/commands/GetSessionEmbedUrlCommand.d.ts +4 -3
  24. package/dist-types/commands/ListIAMPolicyAssignmentsCommand.d.ts +1 -1
  25. package/dist-types/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +1 -1
  26. package/dist-types/commands/RegisterUserCommand.d.ts +1 -2
  27. package/dist-types/commands/TagResourceCommand.d.ts +8 -7
  28. package/dist-types/commands/UpdateDashboardCommand.d.ts +3 -1
  29. package/dist-types/commands/UpdateDataSetCommand.d.ts +1 -1
  30. package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
  31. package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +1 -1
  32. package/dist-types/models/models_0.d.ts +189 -176
  33. package/dist-types/models/models_1.d.ts +213 -83
  34. package/dist-types/ts3.4/models/models_0.d.ts +78 -37
  35. package/dist-types/ts3.4/models/models_1.d.ts +43 -1
  36. package/package.json +36 -43
@@ -137,7 +137,7 @@ export declare class QuickSight extends QuickSightClient {
137
137
  * Guide.</i>
138
138
  * </p>
139
139
  * <p>You can create customizations for your Amazon Web Services account or, if you specify a namespace, for
140
- * a Amazon QuickSight namespace instead. Customizations that apply to a namespace always override
140
+ * a QuickSight namespace instead. Customizations that apply to a namespace always override
141
141
  * customizations that apply to an Amazon Web Services account. To find out which customizations apply, use
142
142
  * the <code>DescribeAccountCustomization</code> API operation.</p>
143
143
  * <p>Before you use the <code>CreateAccountCustomization</code> API operation to add a theme
@@ -146,12 +146,14 @@ export declare class QuickSight extends QuickSightClient {
146
146
  * even if you make it the default theme.
147
147
  * To check if the theme is shared, view the current permissions by using the
148
148
  * <code>
149
- * <a>DescribeThemePermissions</a>
150
- * </code> API operation.
149
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeThemePermissions.html">DescribeThemePermissions</a>
150
+ * </code>
151
+ * API operation.
151
152
  * To share the theme, grant permissions by using the
152
153
  * <code>
153
- * <a>UpdateThemePermissions</a>
154
- * </code> API operation. </p>
154
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateThemePermissions.html">UpdateThemePermissions</a>
155
+ * </code>
156
+ * API operation. </p>
155
157
  */
156
158
  createAccountCustomization(args: CreateAccountCustomizationCommandInput, options?: __HttpHandlerOptions): Promise<CreateAccountCustomizationCommandOutput>;
157
159
  createAccountCustomization(args: CreateAccountCustomizationCommandInput, cb: (err: any, data?: CreateAccountCustomizationCommandOutput) => void): void;
@@ -163,9 +165,11 @@ export declare class QuickSight extends QuickSightClient {
163
165
  createAnalysis(args: CreateAnalysisCommandInput, cb: (err: any, data?: CreateAnalysisCommandOutput) => void): void;
164
166
  createAnalysis(args: CreateAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAnalysisCommandOutput) => void): void;
165
167
  /**
166
- * <p>Creates a dashboard from a template. To first create a template, see the <code>
167
- * <a>CreateTemplate</a>
168
- * </code> API operation.</p>
168
+ * <p>Creates a dashboard from a template. To first create a template, see the
169
+ * <code>
170
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>
171
+ * </code>
172
+ * API operation.</p>
169
173
  * <p>A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created
170
174
  * from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can
171
175
  * create scheduled email reports from them. If you have the correct permissions, you can
@@ -175,7 +179,7 @@ export declare class QuickSight extends QuickSightClient {
175
179
  createDashboard(args: CreateDashboardCommandInput, cb: (err: any, data?: CreateDashboardCommandOutput) => void): void;
176
180
  createDashboard(args: CreateDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDashboardCommandOutput) => void): void;
177
181
  /**
178
- * <p>Creates a dataset.</p>
182
+ * <p>Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.</p>
179
183
  */
180
184
  createDataSet(args: CreateDataSetCommandInput, options?: __HttpHandlerOptions): Promise<CreateDataSetCommandOutput>;
181
185
  createDataSet(args: CreateDataSetCommandInput, cb: (err: any, data?: CreateDataSetCommandOutput) => void): void;
@@ -215,7 +219,7 @@ export declare class QuickSight extends QuickSightClient {
215
219
  createGroupMembership(args: CreateGroupMembershipCommandInput, cb: (err: any, data?: CreateGroupMembershipCommandOutput) => void): void;
216
220
  createGroupMembership(args: CreateGroupMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupMembershipCommandOutput) => void): void;
217
221
  /**
218
- * <p>Creates an assignment with one specified IAMpolicy, identified by its Amazon Resource Name
222
+ * <p>Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name
219
223
  * (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight.
220
224
  * Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces,
221
225
  * use assignment names that are unique.</p>
@@ -224,7 +228,10 @@ export declare class QuickSight extends QuickSightClient {
224
228
  createIAMPolicyAssignment(args: CreateIAMPolicyAssignmentCommandInput, cb: (err: any, data?: CreateIAMPolicyAssignmentCommandOutput) => void): void;
225
229
  createIAMPolicyAssignment(args: CreateIAMPolicyAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIAMPolicyAssignmentCommandOutput) => void): void;
226
230
  /**
227
- * <p>Creates and starts a new SPICE ingestion on a dataset</p>
231
+ * <p>Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in
232
+ * an Enterprise edition account 32 times in a 24-hour period. You can manually refresh
233
+ * datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period
234
+ * is measured starting 24 hours before the current date and time.</p>
228
235
  *
229
236
  * <p>Any ingestions operating on tagged datasets inherit the same tags automatically for use in
230
237
  * 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
@@ -348,7 +355,7 @@ export declare class QuickSight extends QuickSightClient {
348
355
  deleteGroupMembership(args: DeleteGroupMembershipCommandInput, cb: (err: any, data?: DeleteGroupMembershipCommandOutput) => void): void;
349
356
  deleteGroupMembership(args: DeleteGroupMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupMembershipCommandOutput) => void): void;
350
357
  /**
351
- * <p>Deletes an existing IAMpolicy assignment.</p>
358
+ * <p>Deletes an existing IAM policy assignment.</p>
352
359
  */
353
360
  deleteIAMPolicyAssignment(args: DeleteIAMPolicyAssignmentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteIAMPolicyAssignmentCommandOutput>;
354
361
  deleteIAMPolicyAssignment(args: DeleteIAMPolicyAssignmentCommandInput, cb: (err: any, data?: DeleteIAMPolicyAssignmentCommandOutput) => void): void;
@@ -413,7 +420,7 @@ export declare class QuickSight extends QuickSightClient {
413
420
  * <li>
414
421
  * <p>
415
422
  * <code>Amazon Web Services account</code> - The Amazon Web Services account exists at the top of the hierarchy.
416
- * It has the potential to use all of the Amazon Web Services Regions and AWS Services. When you
423
+ * It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you
417
424
  * subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region.
418
425
  * That's where your free SPICE capacity is located. You can use Amazon QuickSight in any
419
426
  * supported Amazon Web Services Region. </p>
@@ -426,7 +433,7 @@ export declare class QuickSight extends QuickSightClient {
426
433
  * Virginia). Generally speaking, these users have access to Amazon QuickSight in any
427
434
  * Amazon Web Services Region, unless they are constrained to a namespace. </p>
428
435
  * <p>To run the command in a different Amazon Web Services Region, you change your Region settings.
429
- * If you're using the AWS CLI, you can use one of the following options:</p>
436
+ * If you're using the CLI, you can use one of the following options:</p>
430
437
  * <ul>
431
438
  * <li>
432
439
  * <p>Use <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html">command line options</a>. </p>
@@ -437,13 +444,13 @@ export declare class QuickSight extends QuickSightClient {
437
444
  * <li>
438
445
  * <p>Run <code>aws configure</code> to change your default Amazon Web Services Region. Use
439
446
  * Enter to key the same settings for your keys. For more information, see
440
- * <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html">Configuring the AWS CLI</a>.</p>
447
+ * <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html">Configuring the CLI</a>.</p>
441
448
  * </li>
442
449
  * </ul>
443
450
  * </li>
444
451
  * <li>
445
452
  * <p>
446
- * <code>Namespace</code> - A Amazon QuickSight namespace is a partition that contains
453
+ * <code>Namespace</code> - A QuickSight namespace is a partition that contains
447
454
  * users and assets (data sources, datasets, dashboards, and so on). To access
448
455
  * assets that are in a specific namespace, users and groups must also be part of
449
456
  * the same namespace. People who share a namespace are completely isolated from
@@ -496,7 +503,7 @@ export declare class QuickSight extends QuickSightClient {
496
503
  describeDashboardPermissions(args: DescribeDashboardPermissionsCommandInput, cb: (err: any, data?: DescribeDashboardPermissionsCommandOutput) => void): void;
497
504
  describeDashboardPermissions(args: DescribeDashboardPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDashboardPermissionsCommandOutput) => void): void;
498
505
  /**
499
- * <p>Describes a dataset. </p>
506
+ * <p>Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.</p>
500
507
  */
501
508
  describeDataSet(args: DescribeDataSetCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDataSetCommandOutput>;
502
509
  describeDataSet(args: DescribeDataSetCommandInput, cb: (err: any, data?: DescribeDataSetCommandOutput) => void): void;
@@ -545,7 +552,7 @@ export declare class QuickSight extends QuickSightClient {
545
552
  describeGroup(args: DescribeGroupCommandInput, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void;
546
553
  describeGroup(args: DescribeGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void;
547
554
  /**
548
- * <p>Describes an existing IAMpolicy assignment, as specified by the assignment name.</p>
555
+ * <p>Describes an existing IAM policy assignment, as specified by the assignment name.</p>
549
556
  */
550
557
  describeIAMPolicyAssignment(args: DescribeIAMPolicyAssignmentCommandInput, options?: __HttpHandlerOptions): Promise<DescribeIAMPolicyAssignmentCommandOutput>;
551
558
  describeIAMPolicyAssignment(args: DescribeIAMPolicyAssignmentCommandInput, cb: (err: any, data?: DescribeIAMPolicyAssignmentCommandOutput) => void): void;
@@ -557,7 +564,7 @@ export declare class QuickSight extends QuickSightClient {
557
564
  describeIngestion(args: DescribeIngestionCommandInput, cb: (err: any, data?: DescribeIngestionCommandOutput) => void): void;
558
565
  describeIngestion(args: DescribeIngestionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIngestionCommandOutput) => void): void;
559
566
  /**
560
- * <p>Provides a summary and status of IP Rules.</p>
567
+ * <p>Provides a summary and status of IP rules.</p>
561
568
  */
562
569
  describeIpRestriction(args: DescribeIpRestrictionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeIpRestrictionCommandOutput>;
563
570
  describeIpRestriction(args: DescribeIpRestrictionCommandInput, cb: (err: any, data?: DescribeIpRestrictionCommandOutput) => void): void;
@@ -696,10 +703,11 @@ export declare class QuickSight extends QuickSightClient {
696
703
  * need belong to the author or admin security cohort. If you want to restrict permissions
697
704
  * to some of these features, add a custom permissions profile to the user with the
698
705
  * <code>
699
- * <a>UpdateUser</a>
706
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a>
700
707
  * </code> API operation. Use <code>
701
- * <a>RegisterUser</a>
702
- * </code> API operation to add a new user with a custom permission profile attached. For more
708
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html">RegisterUser</a>
709
+ * </code>
710
+ * API operation to add a new user with a custom permission profile attached. For more
703
711
  * information, see the following sections in the <i>Amazon QuickSight User
704
712
  * Guide</i>:</p>
705
713
  * <ul>
@@ -774,13 +782,13 @@ export declare class QuickSight extends QuickSightClient {
774
782
  listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
775
783
  listGroups(args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
776
784
  /**
777
- * <p>Lists IAMpolicy assignments in the current Amazon QuickSight account.</p>
785
+ * <p>Lists IAM policy assignments in the current Amazon QuickSight account.</p>
778
786
  */
779
787
  listIAMPolicyAssignments(args: ListIAMPolicyAssignmentsCommandInput, options?: __HttpHandlerOptions): Promise<ListIAMPolicyAssignmentsCommandOutput>;
780
788
  listIAMPolicyAssignments(args: ListIAMPolicyAssignmentsCommandInput, cb: (err: any, data?: ListIAMPolicyAssignmentsCommandOutput) => void): void;
781
789
  listIAMPolicyAssignments(args: ListIAMPolicyAssignmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIAMPolicyAssignmentsCommandOutput) => void): void;
782
790
  /**
783
- * <p>Lists all the IAMpolicy assignments, including the Amazon Resource Names (ARNs) for the IAM
791
+ * <p>Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM
784
792
  * policies assigned to the specified user and group or groups that the user belongs
785
793
  * to.</p>
786
794
  */
@@ -854,8 +862,7 @@ export declare class QuickSight extends QuickSightClient {
854
862
  listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
855
863
  listUsers(args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
856
864
  /**
857
- * <p>Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity
858
- * and Access Management (IAM) identity or role specified in the request. </p>
865
+ * <p>Creates an Amazon QuickSight user, whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. </p>
859
866
  */
860
867
  registerUser(args: RegisterUserCommandInput, options?: __HttpHandlerOptions): Promise<RegisterUserCommandOutput>;
861
868
  registerUser(args: RegisterUserCommandInput, cb: (err: any, data?: RegisterUserCommandOutput) => void): void;
@@ -901,17 +908,18 @@ export declare class QuickSight extends QuickSightClient {
901
908
  * replaces the previous value for that tag.</p>
902
909
  * <p>You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data
903
910
  * set, data source, dashboard, and template. </p>
904
- * <p>Tagging for Amazon QuickSight works in a similar way to tagging for other AWS services, except for
911
+ * <p>Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for
905
912
  * the following:</p>
906
913
  * <ul>
907
914
  * <li>
908
- * <p>You can't use tags to track AWS costs for Amazon QuickSight. This restriction is because Amazon QuickSight
909
- * costs are based on users and SPICE capacity, which aren't taggable
910
- * resources.</p>
911
- * </li>
915
+ * <p>You can't use tags to track costs for Amazon QuickSight. This isn't
916
+ * possible because you can't tag the resources that Amazon QuickSight costs are based
917
+ * on, for example Amazon QuickSight storage capacity (SPICE), number of users, type
918
+ * of users, and usage metrics.</p>
919
+ * </li>
912
920
  * <li>
913
- * <p>Amazon QuickSight doesn't currently support the Tag Editor for Resource Groups.</p>
914
- * </li>
921
+ * <p>Amazon QuickSight doesn't currently support the tag editor for Resource Groups.</p>
922
+ * </li>
915
923
  * </ul>
916
924
  */
917
925
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
@@ -957,7 +965,9 @@ export declare class QuickSight extends QuickSightClient {
957
965
  * <note>
958
966
  * <p>Updating a Dashboard creates a new dashboard version but does not immediately publish
959
967
  * the new version. You can update the published version of a dashboard by
960
- * using the <a>UpdateDashboardPublishedVersion</a> API operation.</p>
968
+ * using the <code>
969
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html">UpdateDashboardPublishedVersion</a>
970
+ * </code> API operation.</p>
961
971
  * </note>
962
972
  */
963
973
  updateDashboard(args: UpdateDashboardCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDashboardCommandOutput>;
@@ -976,7 +986,7 @@ export declare class QuickSight extends QuickSightClient {
976
986
  updateDashboardPublishedVersion(args: UpdateDashboardPublishedVersionCommandInput, cb: (err: any, data?: UpdateDashboardPublishedVersionCommandOutput) => void): void;
977
987
  updateDashboardPublishedVersion(args: UpdateDashboardPublishedVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDashboardPublishedVersionCommandOutput) => void): void;
978
988
  /**
979
- * <p>Updates a dataset.</p>
989
+ * <p>Updates a dataset. This operation doesn't support datasets that include uploaded files as a source.</p>
980
990
  */
981
991
  updateDataSet(args: UpdateDataSetCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDataSetCommandOutput>;
982
992
  updateDataSet(args: UpdateDataSetCommandInput, cb: (err: any, data?: UpdateDataSetCommandOutput) => void): void;
@@ -1019,7 +1029,7 @@ export declare class QuickSight extends QuickSightClient {
1019
1029
  updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
1020
1030
  updateGroup(args: UpdateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
1021
1031
  /**
1022
- * <p>Updates an existing IAMpolicy assignment. This operation updates only the optional
1032
+ * <p>Updates an existing IAM policy assignment. This operation updates only the optional
1023
1033
  * parameter or parameters that are specified in the request.
1024
1034
  * This overwrites all of the users included in <code>Identities</code>.
1025
1035
  * </p>
@@ -1028,7 +1038,7 @@ export declare class QuickSight extends QuickSightClient {
1028
1038
  updateIAMPolicyAssignment(args: UpdateIAMPolicyAssignmentCommandInput, cb: (err: any, data?: UpdateIAMPolicyAssignmentCommandOutput) => void): void;
1029
1039
  updateIAMPolicyAssignment(args: UpdateIAMPolicyAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIAMPolicyAssignmentCommandOutput) => void): void;
1030
1040
  /**
1031
- * <p>Updates content and status of IP Rules.</p>
1041
+ * <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>
1032
1042
  */
1033
1043
  updateIpRestriction(args: UpdateIpRestrictionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateIpRestrictionCommandOutput>;
1034
1044
  updateIpRestriction(args: UpdateIpRestrictionCommandInput, cb: (err: any, data?: UpdateIpRestrictionCommandOutput) => void): void;
@@ -14,7 +14,7 @@ export interface CreateAccountCustomizationCommandOutput extends CreateAccountCu
14
14
  * Guide.</i>
15
15
  * </p>
16
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
17
+ * a QuickSight namespace instead. Customizations that apply to a namespace always override
18
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
@@ -23,12 +23,14 @@ export interface CreateAccountCustomizationCommandOutput extends CreateAccountCu
23
23
  * even if you make it the default theme.
24
24
  * To check if the theme is shared, view the current permissions by using the
25
25
  * <code>
26
- * <a>DescribeThemePermissions</a>
27
- * </code> API operation.
26
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeThemePermissions.html">DescribeThemePermissions</a>
27
+ * </code>
28
+ * API operation.
28
29
  * To share the theme, grant permissions by using the
29
30
  * <code>
30
- * <a>UpdateThemePermissions</a>
31
- * </code> API operation. </p>
31
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateThemePermissions.html">UpdateThemePermissions</a>
32
+ * </code>
33
+ * API operation. </p>
32
34
  * @example
33
35
  * Use a bare-bones client and the command you need to make an API call.
34
36
  * ```javascript
@@ -7,9 +7,11 @@ export interface CreateDashboardCommandInput extends CreateDashboardRequest {
7
7
  export interface CreateDashboardCommandOutput extends CreateDashboardResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Creates a dashboard from a template. To first create a template, see the <code>
11
- * <a>CreateTemplate</a>
12
- * </code> API operation.</p>
10
+ * <p>Creates a dashboard from a template. To first create a template, see the
11
+ * <code>
12
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>
13
+ * </code>
14
+ * API operation.</p>
13
15
  * <p>A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created
14
16
  * from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can
15
17
  * create scheduled email reports from them. If you have the correct permissions, you can
@@ -7,7 +7,7 @@ export interface CreateDataSetCommandInput extends CreateDataSetRequest {
7
7
  export interface CreateDataSetCommandOutput extends CreateDataSetResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Creates a dataset.</p>
10
+ * <p>Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.</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,7 +7,7 @@ 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 IAMpolicy, identified by its Amazon Resource Name
10
+ * <p>Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name
11
11
  * (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight.
12
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>
@@ -7,7 +7,10 @@ export interface CreateIngestionCommandInput extends CreateIngestionRequest {
7
7
  export interface CreateIngestionCommandOutput extends CreateIngestionResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Creates and starts a new SPICE ingestion on a dataset</p>
10
+ * <p>Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in
11
+ * an Enterprise edition account 32 times in a 24-hour period. You can manually refresh
12
+ * datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period
13
+ * is measured starting 24 hours before the current date and time.</p>
11
14
  *
12
15
  * <p>Any ingestions operating on tagged datasets inherit the same tags automatically for use in
13
16
  * 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
@@ -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 IAMpolicy assignment.</p>
10
+ * <p>Deletes an existing IAM policy 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
@@ -17,7 +17,7 @@ export interface DescribeAccountCustomizationCommandOutput extends DescribeAccou
17
17
  * <li>
18
18
  * <p>
19
19
  * <code>Amazon Web Services account</code> - The Amazon Web Services account exists at the top of the hierarchy.
20
- * It has the potential to use all of the Amazon Web Services Regions and AWS Services. When you
20
+ * It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you
21
21
  * subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region.
22
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>
@@ -30,7 +30,7 @@ export interface DescribeAccountCustomizationCommandOutput extends DescribeAccou
30
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
- * If you're using the AWS CLI, you can use one of the following options:</p>
33
+ * If you're using the CLI, you can use one of the following options:</p>
34
34
  * <ul>
35
35
  * <li>
36
36
  * <p>Use <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html">command line options</a>. </p>
@@ -41,13 +41,13 @@ export interface DescribeAccountCustomizationCommandOutput extends DescribeAccou
41
41
  * <li>
42
42
  * <p>Run <code>aws configure</code> to change your default Amazon Web Services Region. Use
43
43
  * Enter to key the same settings for your keys. For more information, see
44
- * <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html">Configuring the AWS CLI</a>.</p>
44
+ * <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html">Configuring the CLI</a>.</p>
45
45
  * </li>
46
46
  * </ul>
47
47
  * </li>
48
48
  * <li>
49
49
  * <p>
50
- * <code>Namespace</code> - A Amazon QuickSight namespace is a partition that contains
50
+ * <code>Namespace</code> - A 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
@@ -7,7 +7,7 @@ export interface DescribeDataSetCommandInput extends DescribeDataSetRequest {
7
7
  export interface DescribeDataSetCommandOutput extends DescribeDataSetResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Describes a dataset. </p>
10
+ * <p>Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.</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,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 IAMpolicy assignment, as specified by the assignment name.</p>
10
+ * <p>Describes an existing IAM policy 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
@@ -7,7 +7,7 @@ export interface DescribeIpRestrictionCommandInput extends DescribeIpRestriction
7
7
  export interface DescribeIpRestrictionCommandOutput extends DescribeIpRestrictionResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Provides a summary and status of IP Rules.</p>
10
+ * <p>Provides a summary and status of IP rules.</p>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript
@@ -14,10 +14,11 @@ export interface GetSessionEmbedUrlCommandOutput extends GetSessionEmbedUrlRespo
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>
17
- * <a>UpdateUser</a>
17
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a>
18
18
  * </code> API operation. Use <code>
19
- * <a>RegisterUser</a>
20
- * </code> API operation to add a new user with a custom permission profile attached. For more
19
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html">RegisterUser</a>
20
+ * </code>
21
+ * API operation to add a new user with a custom permission profile attached. For more
21
22
  * information, see the following sections in the <i>Amazon QuickSight User
22
23
  * Guide</i>:</p>
23
24
  * <ul>
@@ -7,7 +7,7 @@ export interface ListIAMPolicyAssignmentsCommandInput extends ListIAMPolicyAssig
7
7
  export interface ListIAMPolicyAssignmentsCommandOutput extends ListIAMPolicyAssignmentsResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Lists IAMpolicy assignments in the current Amazon QuickSight account.</p>
10
+ * <p>Lists IAM policy assignments in the current Amazon QuickSight account.</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,7 +7,7 @@ export interface ListIAMPolicyAssignmentsForUserCommandInput extends ListIAMPoli
7
7
  export interface ListIAMPolicyAssignmentsForUserCommandOutput extends ListIAMPolicyAssignmentsForUserResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Lists all the IAMpolicy assignments, including the Amazon Resource Names (ARNs) for the IAM
10
+ * <p>Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM
11
11
  * policies assigned to the specified user and group or groups that the user belongs
12
12
  * to.</p>
13
13
  * @example
@@ -7,8 +7,7 @@ export interface RegisterUserCommandInput extends RegisterUserRequest {
7
7
  export interface RegisterUserCommandOutput extends RegisterUserResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity
11
- * and Access Management (IAM) identity or role specified in the request. </p>
10
+ * <p>Creates an Amazon QuickSight user, whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. </p>
12
11
  * @example
13
12
  * Use a bare-bones client and the command you need to make an API call.
14
13
  * ```javascript
@@ -17,17 +17,18 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
17
17
  * replaces the previous value for that tag.</p>
18
18
  * <p>You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data
19
19
  * set, data source, dashboard, and template. </p>
20
- * <p>Tagging for Amazon QuickSight works in a similar way to tagging for other AWS services, except for
20
+ * <p>Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for
21
21
  * the following:</p>
22
22
  * <ul>
23
23
  * <li>
24
- * <p>You can't use tags to track AWS costs for Amazon QuickSight. This restriction is because Amazon QuickSight
25
- * costs are based on users and SPICE capacity, which aren't taggable
26
- * resources.</p>
27
- * </li>
24
+ * <p>You can't use tags to track costs for Amazon QuickSight. This isn't
25
+ * possible because you can't tag the resources that Amazon QuickSight costs are based
26
+ * on, for example Amazon QuickSight storage capacity (SPICE), number of users, type
27
+ * of users, and usage metrics.</p>
28
+ * </li>
28
29
  * <li>
29
- * <p>Amazon QuickSight doesn't currently support the Tag Editor for Resource Groups.</p>
30
- * </li>
30
+ * <p>Amazon QuickSight doesn't currently support the tag editor for Resource Groups.</p>
31
+ * </li>
31
32
  * </ul>
32
33
  * @example
33
34
  * Use a bare-bones client and the command you need to make an API call.
@@ -11,7 +11,9 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _
11
11
  * <note>
12
12
  * <p>Updating a Dashboard creates a new dashboard version but does not immediately publish
13
13
  * the new version. You can update the published version of a dashboard by
14
- * using the <a>UpdateDashboardPublishedVersion</a> API operation.</p>
14
+ * using the <code>
15
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html">UpdateDashboardPublishedVersion</a>
16
+ * </code> API operation.</p>
15
17
  * </note>
16
18
  * @example
17
19
  * Use a bare-bones client and the command you need to make an API call.
@@ -7,7 +7,7 @@ export interface UpdateDataSetCommandInput extends UpdateDataSetRequest {
7
7
  export interface UpdateDataSetCommandOutput extends UpdateDataSetResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Updates a dataset.</p>
10
+ * <p>Updates a dataset. This operation doesn't support datasets that include uploaded files as a source.</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,7 +7,7 @@ export interface UpdateIAMPolicyAssignmentCommandInput extends UpdateIAMPolicyAs
7
7
  export interface UpdateIAMPolicyAssignmentCommandOutput extends UpdateIAMPolicyAssignmentResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Updates an existing IAMpolicy assignment. This operation updates only the optional
10
+ * <p>Updates an existing IAM policy assignment. This operation updates only the optional
11
11
  * parameter or parameters that are specified in the request.
12
12
  * This overwrites all of the users included in <code>Identities</code>.
13
13
  * </p>
@@ -7,7 +7,7 @@ export interface UpdateIpRestrictionCommandInput extends UpdateIpRestrictionRequ
7
7
  export interface UpdateIpRestrictionCommandOutput extends UpdateIpRestrictionResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Updates content and status of IP Rules.</p>
10
+ * <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>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript