@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
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,44 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [3.32.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.31.0...v3.32.0) (2021-09-17)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @aws-sdk/client-quicksight
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# [3.31.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.30.0...v3.31.0) (2021-09-11)
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
### Features
|
|
18
|
+
|
|
19
|
+
* **clients:** update clients as of 09/10/2021 ([#2776](https://github.com/aws/aws-sdk-js-v3/issues/2776)) ([3f49ae7](https://github.com/aws/aws-sdk-js-v3/commit/3f49ae758688f73d5ce16ee21ac597a113199bff))
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
# [3.30.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.29.0...v3.30.0) (2021-09-07)
|
|
26
|
+
|
|
27
|
+
**Note:** Version bump only for package @aws-sdk/client-quicksight
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
# [3.29.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.28.0...v3.29.0) (2021-09-02)
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
### Features
|
|
37
|
+
|
|
38
|
+
* **clients:** update clients as of 09/02/2021 ([#2744](https://github.com/aws/aws-sdk-js-v3/issues/2744)) ([19f061f](https://github.com/aws/aws-sdk-js-v3/commit/19f061fa189539c8e64563e5337ac640450c17ab))
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
6
44
|
# [3.28.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.27.0...v3.28.0) (2021-08-27)
|
|
7
45
|
|
|
8
46
|
|
package/QuickSight.ts
CHANGED
|
@@ -558,12 +558,12 @@ export class QuickSight extends QuickSightClient {
|
|
|
558
558
|
* <p>Creates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, you can
|
|
559
559
|
* add a custom default theme by using the <code>CreateAccountCustomization</code> or
|
|
560
560
|
* <code>UpdateAccountCustomization</code> API operation. To further customize
|
|
561
|
-
* 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
|
|
561
|
+
* 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
|
|
562
562
|
* Guide.</i>
|
|
563
563
|
* </p>
|
|
564
|
-
* <p>You can create customizations for your Amazon Web Services account
|
|
565
|
-
* a QuickSight namespace instead. Customizations that apply to a namespace always override
|
|
566
|
-
* customizations that apply to an Amazon Web Services account
|
|
564
|
+
* <p>You can create customizations for your Amazon Web Services account or, if you specify a namespace, for
|
|
565
|
+
* a Amazon QuickSight namespace instead. Customizations that apply to a namespace always override
|
|
566
|
+
* customizations that apply to an Amazon Web Services account. To find out which customizations apply, use
|
|
567
567
|
* the <code>DescribeAccountCustomization</code> API operation.</p>
|
|
568
568
|
* <p>Before you use the <code>CreateAccountCustomization</code> API operation to add a theme
|
|
569
569
|
* as the namespace default, make sure that you first share the theme with the namespace.
|
|
@@ -643,10 +643,10 @@ export class QuickSight extends QuickSightClient {
|
|
|
643
643
|
* <p>Creates a dashboard from a template. To first create a template, see the <code>
|
|
644
644
|
* <a>CreateTemplate</a>
|
|
645
645
|
* </code> API operation.</p>
|
|
646
|
-
* <p>A dashboard is an entity in QuickSight that identifies QuickSight reports, created
|
|
647
|
-
* from analyses. You can share QuickSight dashboards. With the right permissions, you can
|
|
646
|
+
* <p>A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created
|
|
647
|
+
* from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can
|
|
648
648
|
* create scheduled email reports from them. If you have the correct permissions, you can
|
|
649
|
-
* create a dashboard from a template that exists in a different Amazon Web Services account
|
|
649
|
+
* create a dashboard from a template that exists in a different Amazon Web Services account.</p>
|
|
650
650
|
*/
|
|
651
651
|
public createDashboard(
|
|
652
652
|
args: CreateDashboardCommandInput,
|
|
@@ -865,9 +865,9 @@ export class QuickSight extends QuickSightClient {
|
|
|
865
865
|
}
|
|
866
866
|
|
|
867
867
|
/**
|
|
868
|
-
* <p>Creates an assignment with one specified
|
|
868
|
+
* <p>Creates an assignment with one specified IAMpolicy, identified by its Amazon Resource Name
|
|
869
869
|
* (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight.
|
|
870
|
-
* Assignment names are unique per Amazon Web Services account
|
|
870
|
+
* Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces,
|
|
871
871
|
* use assignment names that are unique.</p>
|
|
872
872
|
*/
|
|
873
873
|
public createIAMPolicyAssignment(
|
|
@@ -937,12 +937,12 @@ export class QuickSight extends QuickSightClient {
|
|
|
937
937
|
|
|
938
938
|
/**
|
|
939
939
|
* <p>(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.</p>
|
|
940
|
-
* <p>A namespace allows you to isolate the QuickSight users and groups that are registered
|
|
940
|
+
* <p>A namespace allows you to isolate the Amazon QuickSight users and groups that are registered
|
|
941
941
|
* for that namespace. Users that access the namespace can share assets only with other
|
|
942
942
|
* users or groups in the same namespace. They can't see users and groups in other
|
|
943
|
-
* namespaces. You can create a namespace after your Amazon Web Services account
|
|
944
|
-
* QuickSight. The namespace must be unique within the Amazon Web Services account
|
|
945
|
-
* limit of 100 namespaces per Amazon Web Services account
|
|
943
|
+
* namespaces. You can create a namespace after your Amazon Web Services account is subscribed to
|
|
944
|
+
* Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a
|
|
945
|
+
* limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with
|
|
946
946
|
* Amazon Web Services Support. </p>
|
|
947
947
|
*/
|
|
948
948
|
public createNamespace(
|
|
@@ -977,7 +977,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
977
977
|
/**
|
|
978
978
|
* <p>Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting
|
|
979
979
|
* template to create a dashboard.</p>
|
|
980
|
-
* <p>A <i>template</i> is an entity in QuickSight that encapsulates the metadata
|
|
980
|
+
* <p>A <i>template</i> is an entity in Amazon QuickSight that encapsulates the metadata
|
|
981
981
|
* required to create an analysis and that you can use to create s dashboard. A template adds
|
|
982
982
|
* a layer of abstraction by using placeholders to replace the dataset associated with the
|
|
983
983
|
* analysis. You can use templates to create dashboards by replacing dataset placeholders
|
|
@@ -1108,7 +1108,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
1108
1108
|
|
|
1109
1109
|
/**
|
|
1110
1110
|
* <p>Deletes all Amazon QuickSight customizations in this Amazon Web Services Region; for the specified
|
|
1111
|
-
* Amazon Web Services account
|
|
1111
|
+
* Amazon Web Services account and Amazon QuickSight namespace.</p>
|
|
1112
1112
|
*/
|
|
1113
1113
|
public deleteAccountCustomization(
|
|
1114
1114
|
args: DeleteAccountCustomizationCommandInput,
|
|
@@ -1142,14 +1142,14 @@ export class QuickSight extends QuickSightClient {
|
|
|
1142
1142
|
/**
|
|
1143
1143
|
* <p>Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during
|
|
1144
1144
|
* which you can restore the analysis. If you don't specify a recovery window value, the
|
|
1145
|
-
* operation defaults to 30 days. QuickSight attaches a <code>DeletionTime</code> stamp to
|
|
1145
|
+
* operation defaults to 30 days. Amazon QuickSight attaches a <code>DeletionTime</code> stamp to
|
|
1146
1146
|
* the response that specifies the end of the recovery window. At the end of the recovery
|
|
1147
|
-
* window, QuickSight deletes the analysis permanently.</p>
|
|
1147
|
+
* window, Amazon QuickSight deletes the analysis permanently.</p>
|
|
1148
1148
|
* <p>At any time before recovery window ends, you can use the <code>RestoreAnalysis</code>
|
|
1149
1149
|
* API operation to remove the <code>DeletionTime</code> stamp and cancel the deletion of
|
|
1150
1150
|
* the analysis. The analysis remains visible in the API until it's deleted, so you can
|
|
1151
1151
|
* describe it but you can't make a template from it.</p>
|
|
1152
|
-
* <p>An analysis that's scheduled for deletion isn't accessible in the QuickSight console.
|
|
1152
|
+
* <p>An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console.
|
|
1153
1153
|
* To access it in the console, restore it. Deleting an analysis doesn't delete the
|
|
1154
1154
|
* dashboards that you publish from it.</p>
|
|
1155
1155
|
*/
|
|
@@ -1399,7 +1399,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
1399
1399
|
}
|
|
1400
1400
|
|
|
1401
1401
|
/**
|
|
1402
|
-
* <p>Deletes an existing
|
|
1402
|
+
* <p>Deletes an existing IAMpolicy assignment.</p>
|
|
1403
1403
|
*/
|
|
1404
1404
|
public deleteIAMPolicyAssignment(
|
|
1405
1405
|
args: DeleteIAMPolicyAssignmentCommandInput,
|
|
@@ -1650,8 +1650,8 @@ export class QuickSight extends QuickSightClient {
|
|
|
1650
1650
|
}
|
|
1651
1651
|
|
|
1652
1652
|
/**
|
|
1653
|
-
* <p>Describes the customizations associated with the provided Amazon Web Services account
|
|
1654
|
-
* QuickSight namespace in an Amazon Web Services Region;. The QuickSight console evaluates which
|
|
1653
|
+
* <p>Describes the customizations associated with the provided Amazon Web Services account and Amazon
|
|
1654
|
+
* Amazon QuickSight namespace in an Amazon Web Services Region;. The Amazon QuickSight console evaluates which
|
|
1655
1655
|
* customizations to apply by running this API operation with the <code>Resolved</code> flag
|
|
1656
1656
|
* included. </p>
|
|
1657
1657
|
* <p>To determine what customizations display when you run this command, it can help to
|
|
@@ -1659,18 +1659,18 @@ export class QuickSight extends QuickSightClient {
|
|
|
1659
1659
|
* <ul>
|
|
1660
1660
|
* <li>
|
|
1661
1661
|
* <p>
|
|
1662
|
-
* <code>Amazon Web Services account
|
|
1662
|
+
* <code>Amazon Web Services account</code> - The Amazon Web Services account exists at the top of the hierarchy.
|
|
1663
1663
|
* It has the potential to use all of the Amazon Web Services Regions; and AWS Services. When you
|
|
1664
|
-
* subscribe to QuickSight, you choose one Amazon Web Services Region; to use as your home Region.
|
|
1665
|
-
* That's where your free SPICE capacity is located. You can use QuickSight in any
|
|
1664
|
+
* subscribe to Amazon QuickSight, you choose one Amazon Web Services Region; to use as your home Region.
|
|
1665
|
+
* That's where your free SPICE capacity is located. You can use Amazon QuickSight in any
|
|
1666
1666
|
* supported Amazon Web Services Region;. </p>
|
|
1667
1667
|
* </li>
|
|
1668
1668
|
* <li>
|
|
1669
1669
|
* <p>
|
|
1670
|
-
* <code>Amazon Web Services Region;</code> - In each Amazon Web Services Region; where you sign in to QuickSight
|
|
1671
|
-
* at least once, QuickSight acts as a separate instance of the same service. If
|
|
1670
|
+
* <code>Amazon Web Services Region;</code> - In each Amazon Web Services Region; where you sign in to Amazon QuickSight
|
|
1671
|
+
* at least once, Amazon QuickSight acts as a separate instance of the same service. If
|
|
1672
1672
|
* you have a user directory, it resides in us-east-1, which is the US East (N.
|
|
1673
|
-
* Virginia). Generally speaking, these users have access to QuickSight in any
|
|
1673
|
+
* Virginia). Generally speaking, these users have access to Amazon QuickSight in any
|
|
1674
1674
|
* Amazon Web Services Region;, unless they are constrained to a namespace. </p>
|
|
1675
1675
|
* <p>To run the command in a different Amazon Web Services Region;, you change your Region settings.
|
|
1676
1676
|
* If you're using the AWS CLI, you can use one of the following options:</p>
|
|
@@ -1690,19 +1690,19 @@ export class QuickSight extends QuickSightClient {
|
|
|
1690
1690
|
* </li>
|
|
1691
1691
|
* <li>
|
|
1692
1692
|
* <p>
|
|
1693
|
-
* <code>Namespace</code> - A QuickSight namespace is a partition that contains
|
|
1693
|
+
* <code>Namespace</code> - A Amazon QuickSight namespace is a partition that contains
|
|
1694
1694
|
* users and assets (data sources, datasets, dashboards, and so on). To access
|
|
1695
1695
|
* assets that are in a specific namespace, users and groups must also be part of
|
|
1696
1696
|
* the same namespace. People who share a namespace are completely isolated from
|
|
1697
|
-
* users and assets in other namespaces, even if they are in the same Amazon Web Services account
|
|
1697
|
+
* users and assets in other namespaces, even if they are in the same Amazon Web Services account
|
|
1698
1698
|
* and Amazon Web Services Region;.</p>
|
|
1699
1699
|
* </li>
|
|
1700
1700
|
* <li>
|
|
1701
1701
|
* <p>
|
|
1702
1702
|
* <code>Applied customizations</code> - Within an Amazon Web Services Region;, a set of
|
|
1703
|
-
* QuickSight customizations can apply to an Amazon Web Services account
|
|
1703
|
+
* Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace.
|
|
1704
1704
|
* Settings that you apply to a namespace override settings that you apply to an
|
|
1705
|
-
* Amazon Web Services account
|
|
1705
|
+
* Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region;. To apply them in
|
|
1706
1706
|
* other Amazon Web Services Regions;, run the <code>CreateAccountCustomization</code> command in
|
|
1707
1707
|
* each Amazon Web Services Region; where you want to apply the same customizations. </p>
|
|
1708
1708
|
* </li>
|
|
@@ -1738,8 +1738,8 @@ export class QuickSight extends QuickSightClient {
|
|
|
1738
1738
|
}
|
|
1739
1739
|
|
|
1740
1740
|
/**
|
|
1741
|
-
* <p>Describes the settings that were used when your QuickSight subscription was first
|
|
1742
|
-
* created in this Amazon Web Services account
|
|
1741
|
+
* <p>Describes the settings that were used when your Amazon QuickSight subscription was first
|
|
1742
|
+
* created in this Amazon Web Services account.</p>
|
|
1743
1743
|
*/
|
|
1744
1744
|
public describeAccountSettings(
|
|
1745
1745
|
args: DescribeAccountSettingsCommandInput,
|
|
@@ -2156,7 +2156,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
2156
2156
|
}
|
|
2157
2157
|
|
|
2158
2158
|
/**
|
|
2159
|
-
* <p>Describes an existing
|
|
2159
|
+
* <p>Describes an existing IAMpolicy assignment, as specified by the assignment name.</p>
|
|
2160
2160
|
*/
|
|
2161
2161
|
public describeIAMPolicyAssignment(
|
|
2162
2162
|
args: DescribeIAMPolicyAssignmentCommandInput,
|
|
@@ -2576,7 +2576,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
2576
2576
|
|
|
2577
2577
|
/**
|
|
2578
2578
|
* <p>Generates a session URL and authorization code that you can use to embed an Amazon
|
|
2579
|
-
* QuickSight read-only dashboard in your web server code. Before you use this command,
|
|
2579
|
+
* Amazon QuickSight read-only dashboard in your web server code. Before you use this command,
|
|
2580
2580
|
* make sure that you have configured the dashboards and permissions. </p>
|
|
2581
2581
|
* <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not
|
|
2582
2582
|
* from the user's browser. The following rules apply to the combination of URL and
|
|
@@ -2630,9 +2630,9 @@ export class QuickSight extends QuickSightClient {
|
|
|
2630
2630
|
|
|
2631
2631
|
/**
|
|
2632
2632
|
* <p>Generates a session URL and authorization code that you can use to embed the Amazon
|
|
2633
|
-
* QuickSight console in your web server code. Use <code>GetSessionEmbedUrl</code> where
|
|
2633
|
+
* Amazon QuickSight console in your web server code. Use <code>GetSessionEmbedUrl</code> where
|
|
2634
2634
|
* you want to provide an authoring portal that allows users to create data sources,
|
|
2635
|
-
* datasets, analyses, and dashboards. The users who access an embedded QuickSight console
|
|
2635
|
+
* datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console
|
|
2636
2636
|
* need belong to the author or admin security cohort. If you want to restrict permissions
|
|
2637
2637
|
* to some of these features, add a custom permissions profile to the user with the
|
|
2638
2638
|
* <code>
|
|
@@ -2645,7 +2645,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
2645
2645
|
* <ul>
|
|
2646
2646
|
* <li>
|
|
2647
2647
|
* <p>
|
|
2648
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics
|
|
2648
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html">Embedding Analytics</a>
|
|
2649
2649
|
* </p>
|
|
2650
2650
|
* </li>
|
|
2651
2651
|
* <li>
|
|
@@ -2685,7 +2685,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
2685
2685
|
}
|
|
2686
2686
|
|
|
2687
2687
|
/**
|
|
2688
|
-
* <p>Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account
|
|
2688
|
+
* <p>Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.</p>
|
|
2689
2689
|
*/
|
|
2690
2690
|
public listAnalyses(
|
|
2691
2691
|
args: ListAnalysesCommandInput,
|
|
@@ -2714,7 +2714,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
2714
2714
|
}
|
|
2715
2715
|
|
|
2716
2716
|
/**
|
|
2717
|
-
* <p>Lists dashboards in an Amazon Web Services account
|
|
2717
|
+
* <p>Lists dashboards in an Amazon Web Services account.</p>
|
|
2718
2718
|
*/
|
|
2719
2719
|
public listDashboards(
|
|
2720
2720
|
args: ListDashboardsCommandInput,
|
|
@@ -2746,7 +2746,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
2746
2746
|
}
|
|
2747
2747
|
|
|
2748
2748
|
/**
|
|
2749
|
-
* <p>Lists all the versions of the dashboards in the QuickSight subscription.</p>
|
|
2749
|
+
* <p>Lists all the versions of the dashboards in the Amazon QuickSight subscription.</p>
|
|
2750
2750
|
*/
|
|
2751
2751
|
public listDashboardVersions(
|
|
2752
2752
|
args: ListDashboardVersionsCommandInput,
|
|
@@ -2778,7 +2778,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
2778
2778
|
}
|
|
2779
2779
|
|
|
2780
2780
|
/**
|
|
2781
|
-
* <p>Lists all of the datasets belonging to the current Amazon Web Services account
|
|
2781
|
+
* <p>Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region;.</p>
|
|
2782
2782
|
* <p>The permissions resource is <code>arn:aws:quicksight:region:aws-account-id:dataset/*</code>.</p>
|
|
2783
2783
|
*/
|
|
2784
2784
|
public listDataSets(
|
|
@@ -2808,7 +2808,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
2808
2808
|
}
|
|
2809
2809
|
|
|
2810
2810
|
/**
|
|
2811
|
-
* <p>Lists data sources in current Amazon Web Services Region; that belong to this Amazon Web Services account
|
|
2811
|
+
* <p>Lists data sources in current Amazon Web Services Region; that belong to this Amazon Web Services account.</p>
|
|
2812
2812
|
*/
|
|
2813
2813
|
public listDataSources(
|
|
2814
2814
|
args: ListDataSourcesCommandInput,
|
|
@@ -2956,7 +2956,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
2956
2956
|
}
|
|
2957
2957
|
|
|
2958
2958
|
/**
|
|
2959
|
-
* <p>Lists
|
|
2959
|
+
* <p>Lists IAMpolicy assignments in the current Amazon QuickSight account.</p>
|
|
2960
2960
|
*/
|
|
2961
2961
|
public listIAMPolicyAssignments(
|
|
2962
2962
|
args: ListIAMPolicyAssignmentsCommandInput,
|
|
@@ -2988,7 +2988,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
2988
2988
|
}
|
|
2989
2989
|
|
|
2990
2990
|
/**
|
|
2991
|
-
* <p>Lists all the
|
|
2991
|
+
* <p>Lists all the IAMpolicy assignments, including the Amazon Resource Names (ARNs) for the IAM
|
|
2992
2992
|
* policies assigned to the specified user and group or groups that the user belongs
|
|
2993
2993
|
* to.</p>
|
|
2994
2994
|
*/
|
|
@@ -3054,7 +3054,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
3054
3054
|
}
|
|
3055
3055
|
|
|
3056
3056
|
/**
|
|
3057
|
-
* <p>Lists the namespaces for the specified Amazon Web Services account
|
|
3057
|
+
* <p>Lists the namespaces for the specified Amazon Web Services account.</p>
|
|
3058
3058
|
*/
|
|
3059
3059
|
public listNamespaces(
|
|
3060
3060
|
args: ListNamespacesCommandInput,
|
|
@@ -3246,7 +3246,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
3246
3246
|
}
|
|
3247
3247
|
|
|
3248
3248
|
/**
|
|
3249
|
-
* <p>Lists all the themes in the current Amazon Web Services account
|
|
3249
|
+
* <p>Lists all the themes in the current Amazon Web Services account.</p>
|
|
3250
3250
|
*/
|
|
3251
3251
|
public listThemes(args: ListThemesCommandInput, options?: __HttpHandlerOptions): Promise<ListThemesCommandOutput>;
|
|
3252
3252
|
public listThemes(args: ListThemesCommandInput, cb: (err: any, data?: ListThemesCommandOutput) => void): void;
|
|
@@ -3272,7 +3272,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
3272
3272
|
}
|
|
3273
3273
|
|
|
3274
3274
|
/**
|
|
3275
|
-
* <p>Lists all the versions of the themes in the current Amazon Web Services account
|
|
3275
|
+
* <p>Lists all the versions of the themes in the current Amazon Web Services account.</p>
|
|
3276
3276
|
*/
|
|
3277
3277
|
public listThemeVersions(
|
|
3278
3278
|
args: ListThemeVersionsCommandInput,
|
|
@@ -3526,7 +3526,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
3526
3526
|
}
|
|
3527
3527
|
|
|
3528
3528
|
/**
|
|
3529
|
-
* <p>Assigns one or more tags (key-value pairs) to the specified QuickSight resource. </p>
|
|
3529
|
+
* <p>Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource. </p>
|
|
3530
3530
|
* <p>Tags can help you organize and categorize your resources. You can also use them to
|
|
3531
3531
|
* scope user permissions, by granting a user permission to access or change only resources
|
|
3532
3532
|
* with certain tag values. You can use the <code>TagResource</code> operation with a
|
|
@@ -3534,18 +3534,18 @@ export class QuickSight extends QuickSightClient {
|
|
|
3534
3534
|
* is appended to the list of tags associated with the resource. If you specify a tag key
|
|
3535
3535
|
* that is already associated with the resource, the new tag value that you specify
|
|
3536
3536
|
* replaces the previous value for that tag.</p>
|
|
3537
|
-
* <p>You can associate as many as 50 tags with a resource. QuickSight supports tagging on data
|
|
3537
|
+
* <p>You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data
|
|
3538
3538
|
* set, data source, dashboard, and template. </p>
|
|
3539
|
-
* <p>Tagging for QuickSight works in a similar way to tagging for other AWS services, except for
|
|
3539
|
+
* <p>Tagging for Amazon QuickSight works in a similar way to tagging for other AWS services, except for
|
|
3540
3540
|
* the following:</p>
|
|
3541
3541
|
* <ul>
|
|
3542
3542
|
* <li>
|
|
3543
|
-
* <p>You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight
|
|
3543
|
+
* <p>You can't use tags to track AWS costs for Amazon QuickSight. This restriction is because Amazon QuickSight
|
|
3544
3544
|
* costs are based on users and SPICE capacity, which aren't taggable
|
|
3545
3545
|
* resources.</p>
|
|
3546
3546
|
* </li>
|
|
3547
3547
|
* <li>
|
|
3548
|
-
* <p>QuickSight doesn't currently support the Tag Editor for Resource Groups.</p>
|
|
3548
|
+
* <p>Amazon QuickSight doesn't currently support the Tag Editor for Resource Groups.</p>
|
|
3549
3549
|
* </li>
|
|
3550
3550
|
* </ul>
|
|
3551
3551
|
*/
|
|
@@ -3607,9 +3607,9 @@ export class QuickSight extends QuickSightClient {
|
|
|
3607
3607
|
/**
|
|
3608
3608
|
* <p>Updates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, the only
|
|
3609
3609
|
* customization you can use is a theme.</p>
|
|
3610
|
-
* <p>You can use customizations for your Amazon Web Services account
|
|
3611
|
-
* QuickSight namespace instead. Customizations that apply to a namespace override
|
|
3612
|
-
* customizations that apply to an Amazon Web Services account
|
|
3610
|
+
* <p>You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a
|
|
3611
|
+
* Amazon QuickSight namespace instead. Customizations that apply to a namespace override
|
|
3612
|
+
* customizations that apply to an Amazon Web Services account. To find out which customizations apply, use
|
|
3613
3613
|
* the <code>DescribeAccountCustomization</code> API operation. </p>
|
|
3614
3614
|
*/
|
|
3615
3615
|
public updateAccountCustomization(
|
|
@@ -3642,7 +3642,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
3642
3642
|
}
|
|
3643
3643
|
|
|
3644
3644
|
/**
|
|
3645
|
-
* <p>Updates the Amazon QuickSight settings in your Amazon Web Services account
|
|
3645
|
+
* <p>Updates the Amazon QuickSight settings in your Amazon Web Services account.</p>
|
|
3646
3646
|
*/
|
|
3647
3647
|
public updateAccountSettings(
|
|
3648
3648
|
args: UpdateAccountSettingsCommandInput,
|
|
@@ -3738,7 +3738,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
3738
3738
|
}
|
|
3739
3739
|
|
|
3740
3740
|
/**
|
|
3741
|
-
* <p>Updates a dashboard in an Amazon Web Services account
|
|
3741
|
+
* <p>Updates a dashboard in an Amazon Web Services account.</p>
|
|
3742
3742
|
* <note>
|
|
3743
3743
|
* <p>Updating a Dashboard creates a new dashboard version but does not immediately publish
|
|
3744
3744
|
* the new version. You can update the published version of a dashboard by
|
|
@@ -4055,7 +4055,7 @@ export class QuickSight extends QuickSightClient {
|
|
|
4055
4055
|
}
|
|
4056
4056
|
|
|
4057
4057
|
/**
|
|
4058
|
-
* <p>Updates an existing
|
|
4058
|
+
* <p>Updates an existing IAMpolicy assignment. This operation updates only the optional
|
|
4059
4059
|
* parameter or parameters that are specified in the request.
|
|
4060
4060
|
* This overwrites all of the users included in <code>Identities</code>.
|
|
4061
4061
|
* </p>
|
|
@@ -24,12 +24,12 @@ export interface CreateAccountCustomizationCommandOutput extends CreateAccountCu
|
|
|
24
24
|
* <p>Creates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, you can
|
|
25
25
|
* add a custom default theme by using the <code>CreateAccountCustomization</code> or
|
|
26
26
|
* <code>UpdateAccountCustomization</code> API operation. To further customize
|
|
27
|
-
* 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
|
|
27
|
+
* 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
|
|
28
28
|
* Guide.</i>
|
|
29
29
|
* </p>
|
|
30
|
-
* <p>You can create customizations for your Amazon Web Services account
|
|
31
|
-
* a QuickSight namespace instead. Customizations that apply to a namespace always override
|
|
32
|
-
* customizations that apply to an Amazon Web Services account
|
|
30
|
+
* <p>You can create customizations for your Amazon Web Services account or, if you specify a namespace, for
|
|
31
|
+
* a Amazon QuickSight namespace instead. Customizations that apply to a namespace always override
|
|
32
|
+
* customizations that apply to an Amazon Web Services account. To find out which customizations apply, use
|
|
33
33
|
* the <code>DescribeAccountCustomization</code> API operation.</p>
|
|
34
34
|
* <p>Before you use the <code>CreateAccountCustomization</code> API operation to add a theme
|
|
35
35
|
* as the namespace default, make sure that you first share the theme with the namespace.
|
|
@@ -24,10 +24,10 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _
|
|
|
24
24
|
* <p>Creates a dashboard from a template. To first create a template, see the <code>
|
|
25
25
|
* <a>CreateTemplate</a>
|
|
26
26
|
* </code> API operation.</p>
|
|
27
|
-
* <p>A dashboard is an entity in QuickSight that identifies QuickSight reports, created
|
|
28
|
-
* from analyses. You can share QuickSight dashboards. With the right permissions, you can
|
|
27
|
+
* <p>A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created
|
|
28
|
+
* from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can
|
|
29
29
|
* create scheduled email reports from them. If you have the correct permissions, you can
|
|
30
|
-
* create a dashboard from a template that exists in a different Amazon Web Services account
|
|
30
|
+
* create a dashboard from a template that exists in a different Amazon Web Services account.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -21,9 +21,9 @@ export interface CreateIAMPolicyAssignmentCommandInput extends CreateIAMPolicyAs
|
|
|
21
21
|
export interface CreateIAMPolicyAssignmentCommandOutput extends CreateIAMPolicyAssignmentResponse, __MetadataBearer {}
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
|
-
* <p>Creates an assignment with one specified
|
|
24
|
+
* <p>Creates an assignment with one specified IAMpolicy, identified by its Amazon Resource Name
|
|
25
25
|
* (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight.
|
|
26
|
-
* Assignment names are unique per Amazon Web Services account
|
|
26
|
+
* Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces,
|
|
27
27
|
* use assignment names that are unique.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -22,12 +22,12 @@ export interface CreateNamespaceCommandOutput extends CreateNamespaceResponse, _
|
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
24
|
* <p>(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.</p>
|
|
25
|
-
* <p>A namespace allows you to isolate the QuickSight users and groups that are registered
|
|
25
|
+
* <p>A namespace allows you to isolate the Amazon QuickSight users and groups that are registered
|
|
26
26
|
* for that namespace. Users that access the namespace can share assets only with other
|
|
27
27
|
* users or groups in the same namespace. They can't see users and groups in other
|
|
28
|
-
* namespaces. You can create a namespace after your Amazon Web Services account
|
|
29
|
-
* QuickSight. The namespace must be unique within the Amazon Web Services account
|
|
30
|
-
* limit of 100 namespaces per Amazon Web Services account
|
|
28
|
+
* namespaces. You can create a namespace after your Amazon Web Services account is subscribed to
|
|
29
|
+
* Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a
|
|
30
|
+
* limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with
|
|
31
31
|
* Amazon Web Services Support. </p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,7 +23,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M
|
|
|
23
23
|
/**
|
|
24
24
|
* <p>Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting
|
|
25
25
|
* template to create a dashboard.</p>
|
|
26
|
-
* <p>A <i>template</i> is an entity in QuickSight that encapsulates the metadata
|
|
26
|
+
* <p>A <i>template</i> is an entity in Amazon QuickSight that encapsulates the metadata
|
|
27
27
|
* required to create an analysis and that you can use to create s dashboard. A template adds
|
|
28
28
|
* a layer of abstraction by using placeholders to replace the dataset associated with the
|
|
29
29
|
* analysis. You can use templates to create dashboards by replacing dataset placeholders
|
|
@@ -22,7 +22,7 @@ export interface DeleteAccountCustomizationCommandOutput extends DeleteAccountCu
|
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
24
|
* <p>Deletes all Amazon QuickSight customizations in this Amazon Web Services Region; for the specified
|
|
25
|
-
* Amazon Web Services account
|
|
25
|
+
* Amazon Web Services account and Amazon QuickSight namespace.</p>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
28
|
* ```javascript
|
|
@@ -23,14 +23,14 @@ export interface DeleteAnalysisCommandOutput extends DeleteAnalysisResponse, __M
|
|
|
23
23
|
/**
|
|
24
24
|
* <p>Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during
|
|
25
25
|
* which you can restore the analysis. If you don't specify a recovery window value, the
|
|
26
|
-
* operation defaults to 30 days. QuickSight attaches a <code>DeletionTime</code> stamp to
|
|
26
|
+
* operation defaults to 30 days. Amazon QuickSight attaches a <code>DeletionTime</code> stamp to
|
|
27
27
|
* the response that specifies the end of the recovery window. At the end of the recovery
|
|
28
|
-
* window, QuickSight deletes the analysis permanently.</p>
|
|
28
|
+
* window, Amazon QuickSight deletes the analysis permanently.</p>
|
|
29
29
|
* <p>At any time before recovery window ends, you can use the <code>RestoreAnalysis</code>
|
|
30
30
|
* API operation to remove the <code>DeletionTime</code> stamp and cancel the deletion of
|
|
31
31
|
* the analysis. The analysis remains visible in the API until it's deleted, so you can
|
|
32
32
|
* describe it but you can't make a template from it.</p>
|
|
33
|
-
* <p>An analysis that's scheduled for deletion isn't accessible in the QuickSight console.
|
|
33
|
+
* <p>An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console.
|
|
34
34
|
* To access it in the console, restore it. Deleting an analysis doesn't delete the
|
|
35
35
|
* dashboards that you publish from it.</p>
|
|
36
36
|
* @example
|
|
@@ -21,7 +21,7 @@ export interface DeleteIAMPolicyAssignmentCommandInput extends DeleteIAMPolicyAs
|
|
|
21
21
|
export interface DeleteIAMPolicyAssignmentCommandOutput extends DeleteIAMPolicyAssignmentResponse, __MetadataBearer {}
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
|
-
* <p>Deletes an existing
|
|
24
|
+
* <p>Deletes an existing IAMpolicy assignment.</p>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
27
|
* ```javascript
|
|
@@ -23,8 +23,8 @@ export interface DescribeAccountCustomizationCommandOutput
|
|
|
23
23
|
__MetadataBearer {}
|
|
24
24
|
|
|
25
25
|
/**
|
|
26
|
-
* <p>Describes the customizations associated with the provided Amazon Web Services account
|
|
27
|
-
* QuickSight namespace in an Amazon Web Services Region;. The QuickSight console evaluates which
|
|
26
|
+
* <p>Describes the customizations associated with the provided Amazon Web Services account and Amazon
|
|
27
|
+
* Amazon QuickSight namespace in an Amazon Web Services Region;. The Amazon QuickSight console evaluates which
|
|
28
28
|
* customizations to apply by running this API operation with the <code>Resolved</code> flag
|
|
29
29
|
* included. </p>
|
|
30
30
|
* <p>To determine what customizations display when you run this command, it can help to
|
|
@@ -32,18 +32,18 @@ export interface DescribeAccountCustomizationCommandOutput
|
|
|
32
32
|
* <ul>
|
|
33
33
|
* <li>
|
|
34
34
|
* <p>
|
|
35
|
-
* <code>Amazon Web Services account
|
|
35
|
+
* <code>Amazon Web Services account</code> - The Amazon Web Services account exists at the top of the hierarchy.
|
|
36
36
|
* It has the potential to use all of the Amazon Web Services Regions; and AWS Services. When you
|
|
37
|
-
* subscribe to QuickSight, you choose one Amazon Web Services Region; to use as your home Region.
|
|
38
|
-
* That's where your free SPICE capacity is located. You can use QuickSight in any
|
|
37
|
+
* subscribe to Amazon QuickSight, you choose one Amazon Web Services Region; to use as your home Region.
|
|
38
|
+
* That's where your free SPICE capacity is located. You can use Amazon QuickSight in any
|
|
39
39
|
* supported Amazon Web Services Region;. </p>
|
|
40
40
|
* </li>
|
|
41
41
|
* <li>
|
|
42
42
|
* <p>
|
|
43
|
-
* <code>Amazon Web Services Region;</code> - In each Amazon Web Services Region; where you sign in to QuickSight
|
|
44
|
-
* at least once, QuickSight acts as a separate instance of the same service. If
|
|
43
|
+
* <code>Amazon Web Services Region;</code> - In each Amazon Web Services Region; where you sign in to Amazon QuickSight
|
|
44
|
+
* at least once, Amazon QuickSight acts as a separate instance of the same service. If
|
|
45
45
|
* you have a user directory, it resides in us-east-1, which is the US East (N.
|
|
46
|
-
* Virginia). Generally speaking, these users have access to QuickSight in any
|
|
46
|
+
* Virginia). Generally speaking, these users have access to Amazon QuickSight in any
|
|
47
47
|
* Amazon Web Services Region;, unless they are constrained to a namespace. </p>
|
|
48
48
|
* <p>To run the command in a different Amazon Web Services Region;, you change your Region settings.
|
|
49
49
|
* If you're using the AWS CLI, you can use one of the following options:</p>
|
|
@@ -63,19 +63,19 @@ export interface DescribeAccountCustomizationCommandOutput
|
|
|
63
63
|
* </li>
|
|
64
64
|
* <li>
|
|
65
65
|
* <p>
|
|
66
|
-
* <code>Namespace</code> - A QuickSight namespace is a partition that contains
|
|
66
|
+
* <code>Namespace</code> - A Amazon QuickSight namespace is a partition that contains
|
|
67
67
|
* users and assets (data sources, datasets, dashboards, and so on). To access
|
|
68
68
|
* assets that are in a specific namespace, users and groups must also be part of
|
|
69
69
|
* the same namespace. People who share a namespace are completely isolated from
|
|
70
|
-
* users and assets in other namespaces, even if they are in the same Amazon Web Services account
|
|
70
|
+
* users and assets in other namespaces, even if they are in the same Amazon Web Services account
|
|
71
71
|
* and Amazon Web Services Region;.</p>
|
|
72
72
|
* </li>
|
|
73
73
|
* <li>
|
|
74
74
|
* <p>
|
|
75
75
|
* <code>Applied customizations</code> - Within an Amazon Web Services Region;, a set of
|
|
76
|
-
* QuickSight customizations can apply to an Amazon Web Services account
|
|
76
|
+
* Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace.
|
|
77
77
|
* Settings that you apply to a namespace override settings that you apply to an
|
|
78
|
-
* Amazon Web Services account
|
|
78
|
+
* Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region;. To apply them in
|
|
79
79
|
* other Amazon Web Services Regions;, run the <code>CreateAccountCustomization</code> command in
|
|
80
80
|
* each Amazon Web Services Region; where you want to apply the same customizations. </p>
|
|
81
81
|
* </li>
|
|
@@ -21,8 +21,8 @@ export interface DescribeAccountSettingsCommandInput extends DescribeAccountSett
|
|
|
21
21
|
export interface DescribeAccountSettingsCommandOutput extends DescribeAccountSettingsResponse, __MetadataBearer {}
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
|
-
* <p>Describes the settings that were used when your QuickSight subscription was first
|
|
25
|
-
* created in this Amazon Web Services account
|
|
24
|
+
* <p>Describes the settings that were used when your Amazon QuickSight subscription was first
|
|
25
|
+
* created in this Amazon Web Services account.</p>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
28
|
* ```javascript
|
|
@@ -23,7 +23,7 @@ export interface DescribeIAMPolicyAssignmentCommandOutput
|
|
|
23
23
|
__MetadataBearer {}
|
|
24
24
|
|
|
25
25
|
/**
|
|
26
|
-
* <p>Describes an existing
|
|
26
|
+
* <p>Describes an existing IAMpolicy assignment, as specified by the assignment name.</p>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
29
|
* ```javascript
|
|
@@ -22,7 +22,7 @@ export interface GetDashboardEmbedUrlCommandOutput extends GetDashboardEmbedUrlR
|
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
24
|
* <p>Generates a session URL and authorization code that you can use to embed an Amazon
|
|
25
|
-
* QuickSight read-only dashboard in your web server code. Before you use this command,
|
|
25
|
+
* Amazon QuickSight read-only dashboard in your web server code. Before you use this command,
|
|
26
26
|
* make sure that you have configured the dashboards and permissions. </p>
|
|
27
27
|
* <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not
|
|
28
28
|
* from the user's browser. The following rules apply to the combination of URL and
|