@aws-sdk/client-quicksight 3.42.0 → 3.43.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 +11 -0
- package/dist-cjs/models/models_0.js +21 -18
- package/dist-cjs/models/models_1.js +17 -3
- package/dist-cjs/protocols/Aws_restJson1.js +80 -0
- package/dist-es/models/models_0.js +13 -12
- package/dist-es/models/models_1.js +12 -0
- package/dist-es/protocols/Aws_restJson1.js +189 -115
- package/dist-types/QuickSight.d.ts +40 -33
- package/dist-types/commands/CreateAccountCustomizationCommand.d.ts +7 -5
- package/dist-types/commands/CreateDashboardCommand.d.ts +5 -3
- package/dist-types/commands/CreateIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAccountCustomizationCommand.d.ts +4 -4
- package/dist-types/commands/DescribeIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIpRestrictionCommand.d.ts +1 -1
- package/dist-types/commands/GetSessionEmbedUrlCommand.d.ts +4 -3
- package/dist-types/commands/ListIAMPolicyAssignmentsCommand.d.ts +1 -1
- package/dist-types/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +1 -1
- package/dist-types/commands/RegisterUserCommand.d.ts +1 -2
- package/dist-types/commands/TagResourceCommand.d.ts +8 -7
- package/dist-types/commands/UpdateDashboardCommand.d.ts +3 -1
- package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +189 -176
- package/dist-types/models/models_1.d.ts +213 -83
- package/dist-types/ts3.4/models/models_0.d.ts +78 -37
- package/dist-types/ts3.4/models/models_1.d.ts +43 -1
- package/package.json +2 -2
|
@@ -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
|
|
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>
|
|
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>
|
|
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
|
|
167
|
-
*
|
|
168
|
-
*
|
|
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
|
|
@@ -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
|
|
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>
|
|
@@ -348,7 +352,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
348
352
|
deleteGroupMembership(args: DeleteGroupMembershipCommandInput, cb: (err: any, data?: DeleteGroupMembershipCommandOutput) => void): void;
|
|
349
353
|
deleteGroupMembership(args: DeleteGroupMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupMembershipCommandOutput) => void): void;
|
|
350
354
|
/**
|
|
351
|
-
* <p>Deletes an existing
|
|
355
|
+
* <p>Deletes an existing IAM policy assignment.</p>
|
|
352
356
|
*/
|
|
353
357
|
deleteIAMPolicyAssignment(args: DeleteIAMPolicyAssignmentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteIAMPolicyAssignmentCommandOutput>;
|
|
354
358
|
deleteIAMPolicyAssignment(args: DeleteIAMPolicyAssignmentCommandInput, cb: (err: any, data?: DeleteIAMPolicyAssignmentCommandOutput) => void): void;
|
|
@@ -413,7 +417,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
413
417
|
* <li>
|
|
414
418
|
* <p>
|
|
415
419
|
* <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
|
|
420
|
+
* It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you
|
|
417
421
|
* subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region.
|
|
418
422
|
* That's where your free SPICE capacity is located. You can use Amazon QuickSight in any
|
|
419
423
|
* supported Amazon Web Services Region. </p>
|
|
@@ -426,7 +430,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
426
430
|
* Virginia). Generally speaking, these users have access to Amazon QuickSight in any
|
|
427
431
|
* Amazon Web Services Region, unless they are constrained to a namespace. </p>
|
|
428
432
|
* <p>To run the command in a different Amazon Web Services Region, you change your Region settings.
|
|
429
|
-
* If you're using the
|
|
433
|
+
* If you're using the CLI, you can use one of the following options:</p>
|
|
430
434
|
* <ul>
|
|
431
435
|
* <li>
|
|
432
436
|
* <p>Use <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html">command line options</a>. </p>
|
|
@@ -437,13 +441,13 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
437
441
|
* <li>
|
|
438
442
|
* <p>Run <code>aws configure</code> to change your default Amazon Web Services Region. Use
|
|
439
443
|
* 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
|
|
444
|
+
* <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html">Configuring the CLI</a>.</p>
|
|
441
445
|
* </li>
|
|
442
446
|
* </ul>
|
|
443
447
|
* </li>
|
|
444
448
|
* <li>
|
|
445
449
|
* <p>
|
|
446
|
-
* <code>Namespace</code> - A
|
|
450
|
+
* <code>Namespace</code> - A QuickSight namespace is a partition that contains
|
|
447
451
|
* users and assets (data sources, datasets, dashboards, and so on). To access
|
|
448
452
|
* assets that are in a specific namespace, users and groups must also be part of
|
|
449
453
|
* the same namespace. People who share a namespace are completely isolated from
|
|
@@ -545,7 +549,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
545
549
|
describeGroup(args: DescribeGroupCommandInput, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void;
|
|
546
550
|
describeGroup(args: DescribeGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void;
|
|
547
551
|
/**
|
|
548
|
-
* <p>Describes an existing
|
|
552
|
+
* <p>Describes an existing IAM policy assignment, as specified by the assignment name.</p>
|
|
549
553
|
*/
|
|
550
554
|
describeIAMPolicyAssignment(args: DescribeIAMPolicyAssignmentCommandInput, options?: __HttpHandlerOptions): Promise<DescribeIAMPolicyAssignmentCommandOutput>;
|
|
551
555
|
describeIAMPolicyAssignment(args: DescribeIAMPolicyAssignmentCommandInput, cb: (err: any, data?: DescribeIAMPolicyAssignmentCommandOutput) => void): void;
|
|
@@ -557,7 +561,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
557
561
|
describeIngestion(args: DescribeIngestionCommandInput, cb: (err: any, data?: DescribeIngestionCommandOutput) => void): void;
|
|
558
562
|
describeIngestion(args: DescribeIngestionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIngestionCommandOutput) => void): void;
|
|
559
563
|
/**
|
|
560
|
-
* <p>Provides a summary and status of IP
|
|
564
|
+
* <p>Provides a summary and status of IP rules.</p>
|
|
561
565
|
*/
|
|
562
566
|
describeIpRestriction(args: DescribeIpRestrictionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeIpRestrictionCommandOutput>;
|
|
563
567
|
describeIpRestriction(args: DescribeIpRestrictionCommandInput, cb: (err: any, data?: DescribeIpRestrictionCommandOutput) => void): void;
|
|
@@ -696,10 +700,11 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
696
700
|
* need belong to the author or admin security cohort. If you want to restrict permissions
|
|
697
701
|
* to some of these features, add a custom permissions profile to the user with the
|
|
698
702
|
* <code>
|
|
699
|
-
* <a>UpdateUser</a>
|
|
703
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a>
|
|
700
704
|
* </code> API operation. Use <code>
|
|
701
|
-
* <a>RegisterUser</a>
|
|
702
|
-
* </code>
|
|
705
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html">RegisterUser</a>
|
|
706
|
+
* </code>
|
|
707
|
+
* API operation to add a new user with a custom permission profile attached. For more
|
|
703
708
|
* information, see the following sections in the <i>Amazon QuickSight User
|
|
704
709
|
* Guide</i>:</p>
|
|
705
710
|
* <ul>
|
|
@@ -774,13 +779,13 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
774
779
|
listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
|
|
775
780
|
listGroups(args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
|
|
776
781
|
/**
|
|
777
|
-
* <p>Lists
|
|
782
|
+
* <p>Lists IAM policy assignments in the current Amazon QuickSight account.</p>
|
|
778
783
|
*/
|
|
779
784
|
listIAMPolicyAssignments(args: ListIAMPolicyAssignmentsCommandInput, options?: __HttpHandlerOptions): Promise<ListIAMPolicyAssignmentsCommandOutput>;
|
|
780
785
|
listIAMPolicyAssignments(args: ListIAMPolicyAssignmentsCommandInput, cb: (err: any, data?: ListIAMPolicyAssignmentsCommandOutput) => void): void;
|
|
781
786
|
listIAMPolicyAssignments(args: ListIAMPolicyAssignmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIAMPolicyAssignmentsCommandOutput) => void): void;
|
|
782
787
|
/**
|
|
783
|
-
* <p>Lists all the
|
|
788
|
+
* <p>Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM
|
|
784
789
|
* policies assigned to the specified user and group or groups that the user belongs
|
|
785
790
|
* to.</p>
|
|
786
791
|
*/
|
|
@@ -854,8 +859,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
854
859
|
listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
|
|
855
860
|
listUsers(args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
|
|
856
861
|
/**
|
|
857
|
-
* <p>Creates an Amazon QuickSight user, whose identity is associated with the
|
|
858
|
-
* and Access Management (IAM) identity or role specified in the request. </p>
|
|
862
|
+
* <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
863
|
*/
|
|
860
864
|
registerUser(args: RegisterUserCommandInput, options?: __HttpHandlerOptions): Promise<RegisterUserCommandOutput>;
|
|
861
865
|
registerUser(args: RegisterUserCommandInput, cb: (err: any, data?: RegisterUserCommandOutput) => void): void;
|
|
@@ -901,17 +905,18 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
901
905
|
* replaces the previous value for that tag.</p>
|
|
902
906
|
* <p>You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data
|
|
903
907
|
* set, data source, dashboard, and template. </p>
|
|
904
|
-
* <p>Tagging for Amazon QuickSight works in a similar way to tagging for other
|
|
908
|
+
* <p>Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for
|
|
905
909
|
* the following:</p>
|
|
906
910
|
* <ul>
|
|
907
911
|
* <li>
|
|
908
|
-
*
|
|
909
|
-
*
|
|
910
|
-
*
|
|
911
|
-
*
|
|
912
|
+
* <p>You can't use tags to track costs for Amazon QuickSight. This isn't
|
|
913
|
+
* possible because you can't tag the resources that Amazon QuickSight costs are based
|
|
914
|
+
* on, for example Amazon QuickSight storage capacity (SPICE), number of users, type
|
|
915
|
+
* of users, and usage metrics.</p>
|
|
916
|
+
* </li>
|
|
912
917
|
* <li>
|
|
913
|
-
*
|
|
914
|
-
*
|
|
918
|
+
* <p>Amazon QuickSight doesn't currently support the tag editor for Resource Groups.</p>
|
|
919
|
+
* </li>
|
|
915
920
|
* </ul>
|
|
916
921
|
*/
|
|
917
922
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
@@ -957,7 +962,9 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
957
962
|
* <note>
|
|
958
963
|
* <p>Updating a Dashboard creates a new dashboard version but does not immediately publish
|
|
959
964
|
* the new version. You can update the published version of a dashboard by
|
|
960
|
-
* using the <
|
|
965
|
+
* using the <code>
|
|
966
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html">UpdateDashboardPublishedVersion</a>
|
|
967
|
+
* </code> API operation.</p>
|
|
961
968
|
* </note>
|
|
962
969
|
*/
|
|
963
970
|
updateDashboard(args: UpdateDashboardCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDashboardCommandOutput>;
|
|
@@ -1019,7 +1026,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
1019
1026
|
updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
|
|
1020
1027
|
updateGroup(args: UpdateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
|
|
1021
1028
|
/**
|
|
1022
|
-
* <p>Updates an existing
|
|
1029
|
+
* <p>Updates an existing IAM policy assignment. This operation updates only the optional
|
|
1023
1030
|
* parameter or parameters that are specified in the request.
|
|
1024
1031
|
* This overwrites all of the users included in <code>Identities</code>.
|
|
1025
1032
|
* </p>
|
|
@@ -1028,7 +1035,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
1028
1035
|
updateIAMPolicyAssignment(args: UpdateIAMPolicyAssignmentCommandInput, cb: (err: any, data?: UpdateIAMPolicyAssignmentCommandOutput) => void): void;
|
|
1029
1036
|
updateIAMPolicyAssignment(args: UpdateIAMPolicyAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIAMPolicyAssignmentCommandOutput) => void): void;
|
|
1030
1037
|
/**
|
|
1031
|
-
* <p>Updates content and status of IP
|
|
1038
|
+
* <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
1039
|
*/
|
|
1033
1040
|
updateIpRestriction(args: UpdateIpRestrictionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateIpRestrictionCommandOutput>;
|
|
1034
1041
|
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
|
|
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>
|
|
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>
|
|
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
|
|
11
|
-
*
|
|
12
|
-
*
|
|
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 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 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,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 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
|
|
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
|
|
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
|
|
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
|
|
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 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 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
|
|
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>
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
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
|
-
*
|
|
30
|
-
*
|
|
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 <
|
|
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 UpdateIAMPolicyAssignmentCommandInput extends UpdateIAMPolicyAs
|
|
|
7
7
|
export interface UpdateIAMPolicyAssignmentCommandOutput extends UpdateIAMPolicyAssignmentResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Updates an existing
|
|
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
|
|
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
|