@aws-sdk/client-quicksight 3.121.0 → 3.128.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 +27 -0
- package/dist-cjs/QuickSight.js +30 -0
- package/dist-cjs/commands/CreateAccountSubscriptionCommand.js +36 -0
- package/dist-cjs/commands/DescribeAccountSubscriptionCommand.js +36 -0
- package/dist-cjs/commands/DescribeThemeAliasCommand.js +3 -3
- package/dist-cjs/commands/DescribeThemeCommand.js +2 -1
- package/dist-cjs/commands/DescribeThemePermissionsCommand.js +3 -3
- package/dist-cjs/commands/index.js +2 -0
- package/dist-cjs/models/models_0.js +64 -63
- package/dist-cjs/models/models_1.js +46 -3
- package/dist-cjs/protocols/Aws_restJson1.js +732 -775
- package/dist-es/QuickSight.js +30 -0
- package/dist-es/commands/CreateAccountSubscriptionCommand.js +39 -0
- package/dist-es/commands/DescribeAccountSubscriptionCommand.js +39 -0
- package/dist-es/commands/DescribeThemeAliasCommand.js +1 -1
- package/dist-es/commands/DescribeThemeCommand.js +2 -1
- package/dist-es/commands/DescribeThemePermissionsCommand.js +1 -1
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +45 -42
- package/dist-es/models/models_1.js +28 -0
- package/dist-es/protocols/Aws_restJson1.js +601 -600
- package/dist-types/QuickSight.d.ts +62 -22
- package/dist-types/QuickSightClient.d.ts +4 -2
- package/dist-types/commands/CreateAccountCustomizationCommand.d.ts +4 -5
- package/dist-types/commands/CreateAccountSubscriptionCommand.d.ts +62 -0
- package/dist-types/commands/DescribeAccountSubscriptionCommand.d.ts +35 -0
- package/dist-types/commands/DescribeThemeAliasCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemeCommand.d.ts +2 -1
- package/dist-types/commands/DescribeThemePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/GenerateEmbedUrlForAnonymousUserCommand.d.ts +2 -4
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +2 -1
- package/dist-types/commands/GetDashboardEmbedUrlCommand.d.ts +3 -7
- package/dist-types/commands/UpdateAccountCustomizationCommand.d.ts +1 -2
- package/dist-types/commands/UpdatePublicSharingSettingsCommand.d.ts +9 -3
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +299 -213
- package/dist-types/models/models_1.d.ts +212 -18
- package/dist-types/protocols/Aws_restJson1.d.ts +6 -0
- package/dist-types/ts3.4/QuickSight.d.ts +10 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +4 -2
- package/dist-types/ts3.4/commands/CreateAccountSubscriptionCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeAccountSubscriptionCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeThemeAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeThemeCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/DescribeThemePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +116 -116
- package/dist-types/ts3.4/models/models_1.d.ts +108 -1857
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +6 -0
- package/package.json +26 -26
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
2
2
|
import { CancelIngestionCommandInput, CancelIngestionCommandOutput } from "./commands/CancelIngestionCommand";
|
|
3
3
|
import { CreateAccountCustomizationCommandInput, CreateAccountCustomizationCommandOutput } from "./commands/CreateAccountCustomizationCommand";
|
|
4
|
+
import { CreateAccountSubscriptionCommandInput, CreateAccountSubscriptionCommandOutput } from "./commands/CreateAccountSubscriptionCommand";
|
|
4
5
|
import { CreateAnalysisCommandInput, CreateAnalysisCommandOutput } from "./commands/CreateAnalysisCommand";
|
|
5
6
|
import { CreateDashboardCommandInput, CreateDashboardCommandOutput } from "./commands/CreateDashboardCommand";
|
|
6
7
|
import { CreateDataSetCommandInput, CreateDataSetCommandOutput } from "./commands/CreateDataSetCommand";
|
|
@@ -35,6 +36,7 @@ import { DeleteUserByPrincipalIdCommandInput, DeleteUserByPrincipalIdCommandOutp
|
|
|
35
36
|
import { DeleteUserCommandInput, DeleteUserCommandOutput } from "./commands/DeleteUserCommand";
|
|
36
37
|
import { DescribeAccountCustomizationCommandInput, DescribeAccountCustomizationCommandOutput } from "./commands/DescribeAccountCustomizationCommand";
|
|
37
38
|
import { DescribeAccountSettingsCommandInput, DescribeAccountSettingsCommandOutput } from "./commands/DescribeAccountSettingsCommand";
|
|
39
|
+
import { DescribeAccountSubscriptionCommandInput, DescribeAccountSubscriptionCommandOutput } from "./commands/DescribeAccountSubscriptionCommand";
|
|
38
40
|
import { DescribeAnalysisCommandInput, DescribeAnalysisCommandOutput } from "./commands/DescribeAnalysisCommand";
|
|
39
41
|
import { DescribeAnalysisPermissionsCommandInput, DescribeAnalysisPermissionsCommandOutput } from "./commands/DescribeAnalysisPermissionsCommand";
|
|
40
42
|
import { DescribeDashboardCommandInput, DescribeDashboardCommandOutput } from "./commands/DescribeDashboardCommand";
|
|
@@ -133,11 +135,10 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
133
135
|
cancelIngestion(args: CancelIngestionCommandInput, cb: (err: any, data?: CancelIngestionCommandOutput) => void): void;
|
|
134
136
|
cancelIngestion(args: CancelIngestionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelIngestionCommandOutput) => void): void;
|
|
135
137
|
/**
|
|
136
|
-
* <p>Creates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, you can
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
* Guide.</i>
|
|
138
|
+
* <p>Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the
|
|
139
|
+
* <code>CreateAccountCustomization</code> or <code>UpdateAccountCustomization</code>
|
|
140
|
+
* API operation. To further customize Amazon QuickSight by removing Amazon QuickSight
|
|
141
|
+
* sample assets and videos for all new users, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html">Customizing Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide.</i>
|
|
141
142
|
* </p>
|
|
142
143
|
* <p>You can create customizations for your Amazon Web Services account or, if you specify a namespace, for
|
|
143
144
|
* a QuickSight namespace instead. Customizations that apply to a namespace always override
|
|
@@ -161,6 +162,39 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
161
162
|
createAccountCustomization(args: CreateAccountCustomizationCommandInput, options?: __HttpHandlerOptions): Promise<CreateAccountCustomizationCommandOutput>;
|
|
162
163
|
createAccountCustomization(args: CreateAccountCustomizationCommandInput, cb: (err: any, data?: CreateAccountCustomizationCommandOutput) => void): void;
|
|
163
164
|
createAccountCustomization(args: CreateAccountCustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccountCustomizationCommandOutput) => void): void;
|
|
165
|
+
/**
|
|
166
|
+
* <p>Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.</p>
|
|
167
|
+
*
|
|
168
|
+
* <p>The Amazon Web Services Region for the account is derived from what is configured in the
|
|
169
|
+
* CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia
|
|
170
|
+
* Pacific (Singapore) Region. </p>
|
|
171
|
+
*
|
|
172
|
+
* <p>Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/setting-up-aws-sign-up.html">Sign
|
|
173
|
+
* up for Amazon Web Services</a> in the <i>Amazon QuickSight User
|
|
174
|
+
* Guide</i>. The person who signs up for Amazon QuickSight needs to have the
|
|
175
|
+
* correct Identity and Access Management (IAM) permissions. For more information,
|
|
176
|
+
* see <a href="https://docs.aws.amazon.com/quicksight/latest/user/iam-policy-examples.html">IAM Policy Examples for Amazon QuickSight</a> in the
|
|
177
|
+
* <i>Amazon QuickSight User Guide</i>.</p>
|
|
178
|
+
*
|
|
179
|
+
* <p>If your IAM policy includes both the <code>Subscribe</code> and
|
|
180
|
+
* <code>CreateAccountSubscription</code> actions, make sure that both actions are set
|
|
181
|
+
* to <code>Allow</code>. If either action is set to <code>Deny</code>, the
|
|
182
|
+
* <code>Deny</code> action prevails and your API call fails.</p>
|
|
183
|
+
*
|
|
184
|
+
* <p>You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to
|
|
185
|
+
* Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html#security-create-iam-role">Passing IAM roles to Amazon QuickSight</a> in the
|
|
186
|
+
* <i>Amazon QuickSight User Guide</i>.</p>
|
|
187
|
+
*
|
|
188
|
+
* <p>You can't set default resource access on the new account from the Amazon QuickSight
|
|
189
|
+
* API. Instead, add default resource access from the Amazon QuickSight console. For more
|
|
190
|
+
* information about setting default resource access to Amazon Web Services services, see
|
|
191
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/scoping-policies-defaults.html">Setting default resource
|
|
192
|
+
* access to Amazon Web Services services</a> in the <i>Amazon QuickSight
|
|
193
|
+
* User Guide</i>.</p>
|
|
194
|
+
*/
|
|
195
|
+
createAccountSubscription(args: CreateAccountSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<CreateAccountSubscriptionCommandOutput>;
|
|
196
|
+
createAccountSubscription(args: CreateAccountSubscriptionCommandInput, cb: (err: any, data?: CreateAccountSubscriptionCommandOutput) => void): void;
|
|
197
|
+
createAccountSubscription(args: CreateAccountSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccountSubscriptionCommandOutput) => void): void;
|
|
164
198
|
/**
|
|
165
199
|
* <p>Creates an analysis in Amazon QuickSight.</p>
|
|
166
200
|
*/
|
|
@@ -481,6 +515,12 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
481
515
|
describeAccountSettings(args: DescribeAccountSettingsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAccountSettingsCommandOutput>;
|
|
482
516
|
describeAccountSettings(args: DescribeAccountSettingsCommandInput, cb: (err: any, data?: DescribeAccountSettingsCommandOutput) => void): void;
|
|
483
517
|
describeAccountSettings(args: DescribeAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountSettingsCommandOutput) => void): void;
|
|
518
|
+
/**
|
|
519
|
+
* <p>Use the DescribeAccountSubscription operation to receive a description of a Amazon QuickSight account's subscription. A successful API call returns an <code>AccountInfo</code> object that includes an account's name, subscription status, authentication type, edition, and notification email address.</p>
|
|
520
|
+
*/
|
|
521
|
+
describeAccountSubscription(args: DescribeAccountSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAccountSubscriptionCommandOutput>;
|
|
522
|
+
describeAccountSubscription(args: DescribeAccountSubscriptionCommandInput, cb: (err: any, data?: DescribeAccountSubscriptionCommandOutput) => void): void;
|
|
523
|
+
describeAccountSubscription(args: DescribeAccountSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountSubscriptionCommandOutput) => void): void;
|
|
484
524
|
/**
|
|
485
525
|
* <p>Provides a summary of the metadata for an analysis.</p>
|
|
486
526
|
*/
|
|
@@ -636,11 +676,9 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
636
676
|
* <p>It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.</p>
|
|
637
677
|
* </li>
|
|
638
678
|
* <li>
|
|
639
|
-
* <p>The URL validity period should not be confused with the actual session lifetime
|
|
640
|
-
* that can be customized using the <code>
|
|
679
|
+
* <p>The URL validity period should not be confused with the actual session lifetime that can be customized using the <code>
|
|
641
680
|
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForAnonymousUser.html#QS-GenerateEmbedUrlForAnonymousUser-request-SessionLifetimeInMinutes">SessionLifetimeInMinutes</a>
|
|
642
|
-
* </code> parameter.</p>
|
|
643
|
-
* <p>The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. </p>
|
|
681
|
+
* </code> parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.</p>
|
|
644
682
|
* </li>
|
|
645
683
|
* <li>
|
|
646
684
|
* <p>You are charged only when the URL is used or there is interaction with Amazon QuickSight.</p>
|
|
@@ -654,7 +692,8 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
654
692
|
generateEmbedUrlForAnonymousUser(args: GenerateEmbedUrlForAnonymousUserCommandInput, cb: (err: any, data?: GenerateEmbedUrlForAnonymousUserCommandOutput) => void): void;
|
|
655
693
|
generateEmbedUrlForAnonymousUser(args: GenerateEmbedUrlForAnonymousUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateEmbedUrlForAnonymousUserCommandOutput) => void): void;
|
|
656
694
|
/**
|
|
657
|
-
* <p>Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account.
|
|
695
|
+
* <p>Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account.
|
|
696
|
+
* Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.</p>
|
|
658
697
|
* <p>The following rules apply to the generated URL:</p>
|
|
659
698
|
* <ul>
|
|
660
699
|
* <li>
|
|
@@ -679,12 +718,8 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
679
718
|
generateEmbedUrlForRegisteredUser(args: GenerateEmbedUrlForRegisteredUserCommandInput, cb: (err: any, data?: GenerateEmbedUrlForRegisteredUserCommandOutput) => void): void;
|
|
680
719
|
generateEmbedUrlForRegisteredUser(args: GenerateEmbedUrlForRegisteredUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateEmbedUrlForRegisteredUserCommandOutput) => void): void;
|
|
681
720
|
/**
|
|
682
|
-
* <p>Generates a session URL and authorization code that you can use to embed an Amazon
|
|
683
|
-
*
|
|
684
|
-
* make sure that you have configured the dashboards and permissions. </p>
|
|
685
|
-
* <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not
|
|
686
|
-
* from the user's browser. The following rules apply to the combination of URL and
|
|
687
|
-
* authorization code:</p>
|
|
721
|
+
* <p>Generates a temporary session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions. </p>
|
|
722
|
+
* <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not from the user's browser. The following rules apply to the generated URL:</p>
|
|
688
723
|
* <ul>
|
|
689
724
|
* <li>
|
|
690
725
|
* <p>They must be used together.</p>
|
|
@@ -696,7 +731,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
696
731
|
* <p>They are valid for 5 minutes after you run this command.</p>
|
|
697
732
|
* </li>
|
|
698
733
|
* <li>
|
|
699
|
-
* <p>The resulting user session is valid for 10 hours.</p>
|
|
734
|
+
* <p>The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional <code>SessionLifetimeInMinutes</code> parameter to customi session duration.</p>
|
|
700
735
|
* </li>
|
|
701
736
|
* </ul>
|
|
702
737
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html">Embedding Analytics Using GetDashboardEmbedUrl</a> in the <i>Amazon QuickSight User
|
|
@@ -949,8 +984,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
949
984
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
950
985
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
951
986
|
/**
|
|
952
|
-
* <p>Updates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, the only
|
|
953
|
-
* customization you can use is a theme.</p>
|
|
987
|
+
* <p>Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.</p>
|
|
954
988
|
* <p>You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a
|
|
955
989
|
* Amazon QuickSight namespace instead. Customizations that apply to a namespace override
|
|
956
990
|
* customizations that apply to an Amazon Web Services account. To find out which customizations apply, use
|
|
@@ -1061,9 +1095,15 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
1061
1095
|
updateIpRestriction(args: UpdateIpRestrictionCommandInput, cb: (err: any, data?: UpdateIpRestrictionCommandOutput) => void): void;
|
|
1062
1096
|
updateIpRestriction(args: UpdateIpRestrictionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIpRestrictionCommandOutput) => void): void;
|
|
1063
1097
|
/**
|
|
1064
|
-
* <p>Use the UpdatePublicSharingSettings operation to
|
|
1065
|
-
*
|
|
1066
|
-
* <p>
|
|
1098
|
+
* <p>Use the <code>UpdatePublicSharingSettings</code> operation to turn on or turn off the
|
|
1099
|
+
* public sharing settings of an Amazon QuickSight dashboard.</p>
|
|
1100
|
+
* <p>To use this operation, turn on session capacity pricing for your Amazon QuickSight
|
|
1101
|
+
* account.</p>
|
|
1102
|
+
* <p>Before you can turn on public sharing on your account, make sure to give public sharing
|
|
1103
|
+
* permissions to an administrative user in the Identity and Access Management (IAM)
|
|
1104
|
+
* console. For more information on using IAM with Amazon QuickSight, see
|
|
1105
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html">Using Amazon QuickSight with IAM</a> in the <i>Amazon QuickSight
|
|
1106
|
+
* User Guide</i>.</p>
|
|
1067
1107
|
*/
|
|
1068
1108
|
updatePublicSharingSettings(args: UpdatePublicSharingSettingsCommandInput, options?: __HttpHandlerOptions): Promise<UpdatePublicSharingSettingsCommandOutput>;
|
|
1069
1109
|
updatePublicSharingSettings(args: UpdatePublicSharingSettingsCommandInput, cb: (err: any, data?: UpdatePublicSharingSettingsCommandOutput) => void): void;
|
|
@@ -8,6 +8,7 @@ import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfig
|
|
|
8
8
|
import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
9
9
|
import { CancelIngestionCommandInput, CancelIngestionCommandOutput } from "./commands/CancelIngestionCommand";
|
|
10
10
|
import { CreateAccountCustomizationCommandInput, CreateAccountCustomizationCommandOutput } from "./commands/CreateAccountCustomizationCommand";
|
|
11
|
+
import { CreateAccountSubscriptionCommandInput, CreateAccountSubscriptionCommandOutput } from "./commands/CreateAccountSubscriptionCommand";
|
|
11
12
|
import { CreateAnalysisCommandInput, CreateAnalysisCommandOutput } from "./commands/CreateAnalysisCommand";
|
|
12
13
|
import { CreateDashboardCommandInput, CreateDashboardCommandOutput } from "./commands/CreateDashboardCommand";
|
|
13
14
|
import { CreateDataSetCommandInput, CreateDataSetCommandOutput } from "./commands/CreateDataSetCommand";
|
|
@@ -42,6 +43,7 @@ import { DeleteUserByPrincipalIdCommandInput, DeleteUserByPrincipalIdCommandOutp
|
|
|
42
43
|
import { DeleteUserCommandInput, DeleteUserCommandOutput } from "./commands/DeleteUserCommand";
|
|
43
44
|
import { DescribeAccountCustomizationCommandInput, DescribeAccountCustomizationCommandOutput } from "./commands/DescribeAccountCustomizationCommand";
|
|
44
45
|
import { DescribeAccountSettingsCommandInput, DescribeAccountSettingsCommandOutput } from "./commands/DescribeAccountSettingsCommand";
|
|
46
|
+
import { DescribeAccountSubscriptionCommandInput, DescribeAccountSubscriptionCommandOutput } from "./commands/DescribeAccountSubscriptionCommand";
|
|
45
47
|
import { DescribeAnalysisCommandInput, DescribeAnalysisCommandOutput } from "./commands/DescribeAnalysisCommand";
|
|
46
48
|
import { DescribeAnalysisPermissionsCommandInput, DescribeAnalysisPermissionsCommandOutput } from "./commands/DescribeAnalysisPermissionsCommand";
|
|
47
49
|
import { DescribeDashboardCommandInput, DescribeDashboardCommandOutput } from "./commands/DescribeDashboardCommand";
|
|
@@ -124,8 +126,8 @@ import { UpdateThemeAliasCommandInput, UpdateThemeAliasCommandOutput } from "./c
|
|
|
124
126
|
import { UpdateThemeCommandInput, UpdateThemeCommandOutput } from "./commands/UpdateThemeCommand";
|
|
125
127
|
import { UpdateThemePermissionsCommandInput, UpdateThemePermissionsCommandOutput } from "./commands/UpdateThemePermissionsCommand";
|
|
126
128
|
import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
|
|
127
|
-
export declare type ServiceInputTypes = CancelIngestionCommandInput | CreateAccountCustomizationCommandInput | CreateAnalysisCommandInput | CreateDashboardCommandInput | CreateDataSetCommandInput | CreateDataSourceCommandInput | CreateFolderCommandInput | CreateFolderMembershipCommandInput | CreateGroupCommandInput | CreateGroupMembershipCommandInput | CreateIAMPolicyAssignmentCommandInput | CreateIngestionCommandInput | CreateNamespaceCommandInput | CreateTemplateAliasCommandInput | CreateTemplateCommandInput | CreateThemeAliasCommandInput | CreateThemeCommandInput | DeleteAccountCustomizationCommandInput | DeleteAnalysisCommandInput | DeleteDashboardCommandInput | DeleteDataSetCommandInput | DeleteDataSourceCommandInput | DeleteFolderCommandInput | DeleteFolderMembershipCommandInput | DeleteGroupCommandInput | DeleteGroupMembershipCommandInput | DeleteIAMPolicyAssignmentCommandInput | DeleteNamespaceCommandInput | DeleteTemplateAliasCommandInput | DeleteTemplateCommandInput | DeleteThemeAliasCommandInput | DeleteThemeCommandInput | DeleteUserByPrincipalIdCommandInput | DeleteUserCommandInput | DescribeAccountCustomizationCommandInput | DescribeAccountSettingsCommandInput | DescribeAnalysisCommandInput | DescribeAnalysisPermissionsCommandInput | DescribeDashboardCommandInput | DescribeDashboardPermissionsCommandInput | DescribeDataSetCommandInput | DescribeDataSetPermissionsCommandInput | DescribeDataSourceCommandInput | DescribeDataSourcePermissionsCommandInput | DescribeFolderCommandInput | DescribeFolderPermissionsCommandInput | DescribeFolderResolvedPermissionsCommandInput | DescribeGroupCommandInput | DescribeGroupMembershipCommandInput | DescribeIAMPolicyAssignmentCommandInput | DescribeIngestionCommandInput | DescribeIpRestrictionCommandInput | DescribeNamespaceCommandInput | DescribeTemplateAliasCommandInput | DescribeTemplateCommandInput | DescribeTemplatePermissionsCommandInput | DescribeThemeAliasCommandInput | DescribeThemeCommandInput | DescribeThemePermissionsCommandInput | DescribeUserCommandInput | GenerateEmbedUrlForAnonymousUserCommandInput | GenerateEmbedUrlForRegisteredUserCommandInput | GetDashboardEmbedUrlCommandInput | GetSessionEmbedUrlCommandInput | ListAnalysesCommandInput | ListDashboardVersionsCommandInput | ListDashboardsCommandInput | ListDataSetsCommandInput | ListDataSourcesCommandInput | ListFolderMembersCommandInput | ListFoldersCommandInput | ListGroupMembershipsCommandInput | ListGroupsCommandInput | ListIAMPolicyAssignmentsCommandInput | ListIAMPolicyAssignmentsForUserCommandInput | ListIngestionsCommandInput | ListNamespacesCommandInput | ListTagsForResourceCommandInput | ListTemplateAliasesCommandInput | ListTemplateVersionsCommandInput | ListTemplatesCommandInput | ListThemeAliasesCommandInput | ListThemeVersionsCommandInput | ListThemesCommandInput | ListUserGroupsCommandInput | ListUsersCommandInput | RegisterUserCommandInput | RestoreAnalysisCommandInput | SearchAnalysesCommandInput | SearchDashboardsCommandInput | SearchFoldersCommandInput | SearchGroupsCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAccountCustomizationCommandInput | UpdateAccountSettingsCommandInput | UpdateAnalysisCommandInput | UpdateAnalysisPermissionsCommandInput | UpdateDashboardCommandInput | UpdateDashboardPermissionsCommandInput | UpdateDashboardPublishedVersionCommandInput | UpdateDataSetCommandInput | UpdateDataSetPermissionsCommandInput | UpdateDataSourceCommandInput | UpdateDataSourcePermissionsCommandInput | UpdateFolderCommandInput | UpdateFolderPermissionsCommandInput | UpdateGroupCommandInput | UpdateIAMPolicyAssignmentCommandInput | UpdateIpRestrictionCommandInput | UpdatePublicSharingSettingsCommandInput | UpdateTemplateAliasCommandInput | UpdateTemplateCommandInput | UpdateTemplatePermissionsCommandInput | UpdateThemeAliasCommandInput | UpdateThemeCommandInput | UpdateThemePermissionsCommandInput | UpdateUserCommandInput;
|
|
128
|
-
export declare type ServiceOutputTypes = CancelIngestionCommandOutput | CreateAccountCustomizationCommandOutput | CreateAnalysisCommandOutput | CreateDashboardCommandOutput | CreateDataSetCommandOutput | CreateDataSourceCommandOutput | CreateFolderCommandOutput | CreateFolderMembershipCommandOutput | CreateGroupCommandOutput | CreateGroupMembershipCommandOutput | CreateIAMPolicyAssignmentCommandOutput | CreateIngestionCommandOutput | CreateNamespaceCommandOutput | CreateTemplateAliasCommandOutput | CreateTemplateCommandOutput | CreateThemeAliasCommandOutput | CreateThemeCommandOutput | DeleteAccountCustomizationCommandOutput | DeleteAnalysisCommandOutput | DeleteDashboardCommandOutput | DeleteDataSetCommandOutput | DeleteDataSourceCommandOutput | DeleteFolderCommandOutput | DeleteFolderMembershipCommandOutput | DeleteGroupCommandOutput | DeleteGroupMembershipCommandOutput | DeleteIAMPolicyAssignmentCommandOutput | DeleteNamespaceCommandOutput | DeleteTemplateAliasCommandOutput | DeleteTemplateCommandOutput | DeleteThemeAliasCommandOutput | DeleteThemeCommandOutput | DeleteUserByPrincipalIdCommandOutput | DeleteUserCommandOutput | DescribeAccountCustomizationCommandOutput | DescribeAccountSettingsCommandOutput | DescribeAnalysisCommandOutput | DescribeAnalysisPermissionsCommandOutput | DescribeDashboardCommandOutput | DescribeDashboardPermissionsCommandOutput | DescribeDataSetCommandOutput | DescribeDataSetPermissionsCommandOutput | DescribeDataSourceCommandOutput | DescribeDataSourcePermissionsCommandOutput | DescribeFolderCommandOutput | DescribeFolderPermissionsCommandOutput | DescribeFolderResolvedPermissionsCommandOutput | DescribeGroupCommandOutput | DescribeGroupMembershipCommandOutput | DescribeIAMPolicyAssignmentCommandOutput | DescribeIngestionCommandOutput | DescribeIpRestrictionCommandOutput | DescribeNamespaceCommandOutput | DescribeTemplateAliasCommandOutput | DescribeTemplateCommandOutput | DescribeTemplatePermissionsCommandOutput | DescribeThemeAliasCommandOutput | DescribeThemeCommandOutput | DescribeThemePermissionsCommandOutput | DescribeUserCommandOutput | GenerateEmbedUrlForAnonymousUserCommandOutput | GenerateEmbedUrlForRegisteredUserCommandOutput | GetDashboardEmbedUrlCommandOutput | GetSessionEmbedUrlCommandOutput | ListAnalysesCommandOutput | ListDashboardVersionsCommandOutput | ListDashboardsCommandOutput | ListDataSetsCommandOutput | ListDataSourcesCommandOutput | ListFolderMembersCommandOutput | ListFoldersCommandOutput | ListGroupMembershipsCommandOutput | ListGroupsCommandOutput | ListIAMPolicyAssignmentsCommandOutput | ListIAMPolicyAssignmentsForUserCommandOutput | ListIngestionsCommandOutput | ListNamespacesCommandOutput | ListTagsForResourceCommandOutput | ListTemplateAliasesCommandOutput | ListTemplateVersionsCommandOutput | ListTemplatesCommandOutput | ListThemeAliasesCommandOutput | ListThemeVersionsCommandOutput | ListThemesCommandOutput | ListUserGroupsCommandOutput | ListUsersCommandOutput | RegisterUserCommandOutput | RestoreAnalysisCommandOutput | SearchAnalysesCommandOutput | SearchDashboardsCommandOutput | SearchFoldersCommandOutput | SearchGroupsCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAccountCustomizationCommandOutput | UpdateAccountSettingsCommandOutput | UpdateAnalysisCommandOutput | UpdateAnalysisPermissionsCommandOutput | UpdateDashboardCommandOutput | UpdateDashboardPermissionsCommandOutput | UpdateDashboardPublishedVersionCommandOutput | UpdateDataSetCommandOutput | UpdateDataSetPermissionsCommandOutput | UpdateDataSourceCommandOutput | UpdateDataSourcePermissionsCommandOutput | UpdateFolderCommandOutput | UpdateFolderPermissionsCommandOutput | UpdateGroupCommandOutput | UpdateIAMPolicyAssignmentCommandOutput | UpdateIpRestrictionCommandOutput | UpdatePublicSharingSettingsCommandOutput | UpdateTemplateAliasCommandOutput | UpdateTemplateCommandOutput | UpdateTemplatePermissionsCommandOutput | UpdateThemeAliasCommandOutput | UpdateThemeCommandOutput | UpdateThemePermissionsCommandOutput | UpdateUserCommandOutput;
|
|
129
|
+
export declare type ServiceInputTypes = CancelIngestionCommandInput | CreateAccountCustomizationCommandInput | CreateAccountSubscriptionCommandInput | CreateAnalysisCommandInput | CreateDashboardCommandInput | CreateDataSetCommandInput | CreateDataSourceCommandInput | CreateFolderCommandInput | CreateFolderMembershipCommandInput | CreateGroupCommandInput | CreateGroupMembershipCommandInput | CreateIAMPolicyAssignmentCommandInput | CreateIngestionCommandInput | CreateNamespaceCommandInput | CreateTemplateAliasCommandInput | CreateTemplateCommandInput | CreateThemeAliasCommandInput | CreateThemeCommandInput | DeleteAccountCustomizationCommandInput | DeleteAnalysisCommandInput | DeleteDashboardCommandInput | DeleteDataSetCommandInput | DeleteDataSourceCommandInput | DeleteFolderCommandInput | DeleteFolderMembershipCommandInput | DeleteGroupCommandInput | DeleteGroupMembershipCommandInput | DeleteIAMPolicyAssignmentCommandInput | DeleteNamespaceCommandInput | DeleteTemplateAliasCommandInput | DeleteTemplateCommandInput | DeleteThemeAliasCommandInput | DeleteThemeCommandInput | DeleteUserByPrincipalIdCommandInput | DeleteUserCommandInput | DescribeAccountCustomizationCommandInput | DescribeAccountSettingsCommandInput | DescribeAccountSubscriptionCommandInput | DescribeAnalysisCommandInput | DescribeAnalysisPermissionsCommandInput | DescribeDashboardCommandInput | DescribeDashboardPermissionsCommandInput | DescribeDataSetCommandInput | DescribeDataSetPermissionsCommandInput | DescribeDataSourceCommandInput | DescribeDataSourcePermissionsCommandInput | DescribeFolderCommandInput | DescribeFolderPermissionsCommandInput | DescribeFolderResolvedPermissionsCommandInput | DescribeGroupCommandInput | DescribeGroupMembershipCommandInput | DescribeIAMPolicyAssignmentCommandInput | DescribeIngestionCommandInput | DescribeIpRestrictionCommandInput | DescribeNamespaceCommandInput | DescribeTemplateAliasCommandInput | DescribeTemplateCommandInput | DescribeTemplatePermissionsCommandInput | DescribeThemeAliasCommandInput | DescribeThemeCommandInput | DescribeThemePermissionsCommandInput | DescribeUserCommandInput | GenerateEmbedUrlForAnonymousUserCommandInput | GenerateEmbedUrlForRegisteredUserCommandInput | GetDashboardEmbedUrlCommandInput | GetSessionEmbedUrlCommandInput | ListAnalysesCommandInput | ListDashboardVersionsCommandInput | ListDashboardsCommandInput | ListDataSetsCommandInput | ListDataSourcesCommandInput | ListFolderMembersCommandInput | ListFoldersCommandInput | ListGroupMembershipsCommandInput | ListGroupsCommandInput | ListIAMPolicyAssignmentsCommandInput | ListIAMPolicyAssignmentsForUserCommandInput | ListIngestionsCommandInput | ListNamespacesCommandInput | ListTagsForResourceCommandInput | ListTemplateAliasesCommandInput | ListTemplateVersionsCommandInput | ListTemplatesCommandInput | ListThemeAliasesCommandInput | ListThemeVersionsCommandInput | ListThemesCommandInput | ListUserGroupsCommandInput | ListUsersCommandInput | RegisterUserCommandInput | RestoreAnalysisCommandInput | SearchAnalysesCommandInput | SearchDashboardsCommandInput | SearchFoldersCommandInput | SearchGroupsCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAccountCustomizationCommandInput | UpdateAccountSettingsCommandInput | UpdateAnalysisCommandInput | UpdateAnalysisPermissionsCommandInput | UpdateDashboardCommandInput | UpdateDashboardPermissionsCommandInput | UpdateDashboardPublishedVersionCommandInput | UpdateDataSetCommandInput | UpdateDataSetPermissionsCommandInput | UpdateDataSourceCommandInput | UpdateDataSourcePermissionsCommandInput | UpdateFolderCommandInput | UpdateFolderPermissionsCommandInput | UpdateGroupCommandInput | UpdateIAMPolicyAssignmentCommandInput | UpdateIpRestrictionCommandInput | UpdatePublicSharingSettingsCommandInput | UpdateTemplateAliasCommandInput | UpdateTemplateCommandInput | UpdateTemplatePermissionsCommandInput | UpdateThemeAliasCommandInput | UpdateThemeCommandInput | UpdateThemePermissionsCommandInput | UpdateUserCommandInput;
|
|
130
|
+
export declare type ServiceOutputTypes = CancelIngestionCommandOutput | CreateAccountCustomizationCommandOutput | CreateAccountSubscriptionCommandOutput | CreateAnalysisCommandOutput | CreateDashboardCommandOutput | CreateDataSetCommandOutput | CreateDataSourceCommandOutput | CreateFolderCommandOutput | CreateFolderMembershipCommandOutput | CreateGroupCommandOutput | CreateGroupMembershipCommandOutput | CreateIAMPolicyAssignmentCommandOutput | CreateIngestionCommandOutput | CreateNamespaceCommandOutput | CreateTemplateAliasCommandOutput | CreateTemplateCommandOutput | CreateThemeAliasCommandOutput | CreateThemeCommandOutput | DeleteAccountCustomizationCommandOutput | DeleteAnalysisCommandOutput | DeleteDashboardCommandOutput | DeleteDataSetCommandOutput | DeleteDataSourceCommandOutput | DeleteFolderCommandOutput | DeleteFolderMembershipCommandOutput | DeleteGroupCommandOutput | DeleteGroupMembershipCommandOutput | DeleteIAMPolicyAssignmentCommandOutput | DeleteNamespaceCommandOutput | DeleteTemplateAliasCommandOutput | DeleteTemplateCommandOutput | DeleteThemeAliasCommandOutput | DeleteThemeCommandOutput | DeleteUserByPrincipalIdCommandOutput | DeleteUserCommandOutput | DescribeAccountCustomizationCommandOutput | DescribeAccountSettingsCommandOutput | DescribeAccountSubscriptionCommandOutput | DescribeAnalysisCommandOutput | DescribeAnalysisPermissionsCommandOutput | DescribeDashboardCommandOutput | DescribeDashboardPermissionsCommandOutput | DescribeDataSetCommandOutput | DescribeDataSetPermissionsCommandOutput | DescribeDataSourceCommandOutput | DescribeDataSourcePermissionsCommandOutput | DescribeFolderCommandOutput | DescribeFolderPermissionsCommandOutput | DescribeFolderResolvedPermissionsCommandOutput | DescribeGroupCommandOutput | DescribeGroupMembershipCommandOutput | DescribeIAMPolicyAssignmentCommandOutput | DescribeIngestionCommandOutput | DescribeIpRestrictionCommandOutput | DescribeNamespaceCommandOutput | DescribeTemplateAliasCommandOutput | DescribeTemplateCommandOutput | DescribeTemplatePermissionsCommandOutput | DescribeThemeAliasCommandOutput | DescribeThemeCommandOutput | DescribeThemePermissionsCommandOutput | DescribeUserCommandOutput | GenerateEmbedUrlForAnonymousUserCommandOutput | GenerateEmbedUrlForRegisteredUserCommandOutput | GetDashboardEmbedUrlCommandOutput | GetSessionEmbedUrlCommandOutput | ListAnalysesCommandOutput | ListDashboardVersionsCommandOutput | ListDashboardsCommandOutput | ListDataSetsCommandOutput | ListDataSourcesCommandOutput | ListFolderMembersCommandOutput | ListFoldersCommandOutput | ListGroupMembershipsCommandOutput | ListGroupsCommandOutput | ListIAMPolicyAssignmentsCommandOutput | ListIAMPolicyAssignmentsForUserCommandOutput | ListIngestionsCommandOutput | ListNamespacesCommandOutput | ListTagsForResourceCommandOutput | ListTemplateAliasesCommandOutput | ListTemplateVersionsCommandOutput | ListTemplatesCommandOutput | ListThemeAliasesCommandOutput | ListThemeVersionsCommandOutput | ListThemesCommandOutput | ListUserGroupsCommandOutput | ListUsersCommandOutput | RegisterUserCommandOutput | RestoreAnalysisCommandOutput | SearchAnalysesCommandOutput | SearchDashboardsCommandOutput | SearchFoldersCommandOutput | SearchGroupsCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAccountCustomizationCommandOutput | UpdateAccountSettingsCommandOutput | UpdateAnalysisCommandOutput | UpdateAnalysisPermissionsCommandOutput | UpdateDashboardCommandOutput | UpdateDashboardPermissionsCommandOutput | UpdateDashboardPublishedVersionCommandOutput | UpdateDataSetCommandOutput | UpdateDataSetPermissionsCommandOutput | UpdateDataSourceCommandOutput | UpdateDataSourcePermissionsCommandOutput | UpdateFolderCommandOutput | UpdateFolderPermissionsCommandOutput | UpdateGroupCommandOutput | UpdateIAMPolicyAssignmentCommandOutput | UpdateIpRestrictionCommandOutput | UpdatePublicSharingSettingsCommandOutput | UpdateTemplateAliasCommandOutput | UpdateTemplateCommandOutput | UpdateTemplatePermissionsCommandOutput | UpdateThemeAliasCommandOutput | UpdateThemeCommandOutput | UpdateThemePermissionsCommandOutput | UpdateUserCommandOutput;
|
|
129
131
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
130
132
|
/**
|
|
131
133
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -7,11 +7,10 @@ export interface CreateAccountCustomizationCommandInput extends CreateAccountCus
|
|
|
7
7
|
export interface CreateAccountCustomizationCommandOutput extends CreateAccountCustomizationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, you can
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* Guide.</i>
|
|
10
|
+
* <p>Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the
|
|
11
|
+
* <code>CreateAccountCustomization</code> or <code>UpdateAccountCustomization</code>
|
|
12
|
+
* API operation. To further customize Amazon QuickSight by removing Amazon QuickSight
|
|
13
|
+
* sample assets and videos for all new users, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html">Customizing Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide.</i>
|
|
15
14
|
* </p>
|
|
16
15
|
* <p>You can create customizations for your Amazon Web Services account or, if you specify a namespace, for
|
|
17
16
|
* a QuickSight namespace instead. Customizations that apply to a namespace always override
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { CreateAccountSubscriptionRequest, CreateAccountSubscriptionResponse } from "../models/models_0";
|
|
4
|
+
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
|
+
export interface CreateAccountSubscriptionCommandInput extends CreateAccountSubscriptionRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface CreateAccountSubscriptionCommandOutput extends CreateAccountSubscriptionResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.</p>
|
|
11
|
+
*
|
|
12
|
+
* <p>The Amazon Web Services Region for the account is derived from what is configured in the
|
|
13
|
+
* CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia
|
|
14
|
+
* Pacific (Singapore) Region. </p>
|
|
15
|
+
*
|
|
16
|
+
* <p>Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/setting-up-aws-sign-up.html">Sign
|
|
17
|
+
* up for Amazon Web Services</a> in the <i>Amazon QuickSight User
|
|
18
|
+
* Guide</i>. The person who signs up for Amazon QuickSight needs to have the
|
|
19
|
+
* correct Identity and Access Management (IAM) permissions. For more information,
|
|
20
|
+
* see <a href="https://docs.aws.amazon.com/quicksight/latest/user/iam-policy-examples.html">IAM Policy Examples for Amazon QuickSight</a> in the
|
|
21
|
+
* <i>Amazon QuickSight User Guide</i>.</p>
|
|
22
|
+
*
|
|
23
|
+
* <p>If your IAM policy includes both the <code>Subscribe</code> and
|
|
24
|
+
* <code>CreateAccountSubscription</code> actions, make sure that both actions are set
|
|
25
|
+
* to <code>Allow</code>. If either action is set to <code>Deny</code>, the
|
|
26
|
+
* <code>Deny</code> action prevails and your API call fails.</p>
|
|
27
|
+
*
|
|
28
|
+
* <p>You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to
|
|
29
|
+
* Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html#security-create-iam-role">Passing IAM roles to Amazon QuickSight</a> in the
|
|
30
|
+
* <i>Amazon QuickSight User Guide</i>.</p>
|
|
31
|
+
*
|
|
32
|
+
* <p>You can't set default resource access on the new account from the Amazon QuickSight
|
|
33
|
+
* API. Instead, add default resource access from the Amazon QuickSight console. For more
|
|
34
|
+
* information about setting default resource access to Amazon Web Services services, see
|
|
35
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/scoping-policies-defaults.html">Setting default resource
|
|
36
|
+
* access to Amazon Web Services services</a> in the <i>Amazon QuickSight
|
|
37
|
+
* User Guide</i>.</p>
|
|
38
|
+
* @example
|
|
39
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
40
|
+
* ```javascript
|
|
41
|
+
* import { QuickSightClient, CreateAccountSubscriptionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
42
|
+
* // const { QuickSightClient, CreateAccountSubscriptionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
43
|
+
* const client = new QuickSightClient(config);
|
|
44
|
+
* const command = new CreateAccountSubscriptionCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @see {@link CreateAccountSubscriptionCommandInput} for command's `input` shape.
|
|
49
|
+
* @see {@link CreateAccountSubscriptionCommandOutput} for command's `response` shape.
|
|
50
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
51
|
+
*
|
|
52
|
+
*/
|
|
53
|
+
export declare class CreateAccountSubscriptionCommand extends $Command<CreateAccountSubscriptionCommandInput, CreateAccountSubscriptionCommandOutput, QuickSightClientResolvedConfig> {
|
|
54
|
+
readonly input: CreateAccountSubscriptionCommandInput;
|
|
55
|
+
constructor(input: CreateAccountSubscriptionCommandInput);
|
|
56
|
+
/**
|
|
57
|
+
* @internal
|
|
58
|
+
*/
|
|
59
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAccountSubscriptionCommandInput, CreateAccountSubscriptionCommandOutput>;
|
|
60
|
+
private serialize;
|
|
61
|
+
private deserialize;
|
|
62
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { DescribeAccountSubscriptionRequest, DescribeAccountSubscriptionResponse } from "../models/models_0";
|
|
4
|
+
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
|
+
export interface DescribeAccountSubscriptionCommandInput extends DescribeAccountSubscriptionRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface DescribeAccountSubscriptionCommandOutput extends DescribeAccountSubscriptionResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Use the DescribeAccountSubscription operation to receive a description of a Amazon QuickSight account's subscription. A successful API call returns an <code>AccountInfo</code> object that includes an account's name, subscription status, authentication type, edition, and notification email address.</p>
|
|
11
|
+
* @example
|
|
12
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
+
* ```javascript
|
|
14
|
+
* import { QuickSightClient, DescribeAccountSubscriptionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
15
|
+
* // const { QuickSightClient, DescribeAccountSubscriptionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
16
|
+
* const client = new QuickSightClient(config);
|
|
17
|
+
* const command = new DescribeAccountSubscriptionCommand(input);
|
|
18
|
+
* const response = await client.send(command);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link DescribeAccountSubscriptionCommandInput} for command's `input` shape.
|
|
22
|
+
* @see {@link DescribeAccountSubscriptionCommandOutput} for command's `response` shape.
|
|
23
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
26
|
+
export declare class DescribeAccountSubscriptionCommand extends $Command<DescribeAccountSubscriptionCommandInput, DescribeAccountSubscriptionCommandOutput, QuickSightClientResolvedConfig> {
|
|
27
|
+
readonly input: DescribeAccountSubscriptionCommandInput;
|
|
28
|
+
constructor(input: DescribeAccountSubscriptionCommandInput);
|
|
29
|
+
/**
|
|
30
|
+
* @internal
|
|
31
|
+
*/
|
|
32
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAccountSubscriptionCommandInput, DescribeAccountSubscriptionCommandOutput>;
|
|
33
|
+
private serialize;
|
|
34
|
+
private deserialize;
|
|
35
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
-
import { DescribeThemeAliasRequest, DescribeThemeAliasResponse } from "../models/
|
|
3
|
+
import { DescribeThemeAliasRequest, DescribeThemeAliasResponse } from "../models/models_1";
|
|
4
4
|
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
export interface DescribeThemeAliasCommandInput extends DescribeThemeAliasRequest {
|
|
6
6
|
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
-
import { DescribeThemeRequest
|
|
3
|
+
import { DescribeThemeRequest } from "../models/models_0";
|
|
4
|
+
import { DescribeThemeResponse } from "../models/models_1";
|
|
4
5
|
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
6
|
export interface DescribeThemeCommandInput extends DescribeThemeRequest {
|
|
6
7
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
-
import { DescribeThemePermissionsRequest, DescribeThemePermissionsResponse } from "../models/
|
|
3
|
+
import { DescribeThemePermissionsRequest, DescribeThemePermissionsResponse } from "../models/models_1";
|
|
4
4
|
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
export interface DescribeThemePermissionsCommandInput extends DescribeThemePermissionsRequest {
|
|
6
6
|
}
|
|
@@ -14,11 +14,9 @@ export interface GenerateEmbedUrlForAnonymousUserCommandOutput extends GenerateE
|
|
|
14
14
|
* <p>It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.</p>
|
|
15
15
|
* </li>
|
|
16
16
|
* <li>
|
|
17
|
-
* <p>The URL validity period should not be confused with the actual session lifetime
|
|
18
|
-
* that can be customized using the <code>
|
|
17
|
+
* <p>The URL validity period should not be confused with the actual session lifetime that can be customized using the <code>
|
|
19
18
|
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForAnonymousUser.html#QS-GenerateEmbedUrlForAnonymousUser-request-SessionLifetimeInMinutes">SessionLifetimeInMinutes</a>
|
|
20
|
-
* </code> parameter.</p>
|
|
21
|
-
* <p>The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. </p>
|
|
19
|
+
* </code> parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.</p>
|
|
22
20
|
* </li>
|
|
23
21
|
* <li>
|
|
24
22
|
* <p>You are charged only when the URL is used or there is interaction with Amazon QuickSight.</p>
|
|
@@ -7,7 +7,8 @@ export interface GenerateEmbedUrlForRegisteredUserCommandInput extends GenerateE
|
|
|
7
7
|
export interface GenerateEmbedUrlForRegisteredUserCommandOutput extends GenerateEmbedUrlForRegisteredUserResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account.
|
|
10
|
+
* <p>Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account.
|
|
11
|
+
* Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.</p>
|
|
11
12
|
* <p>The following rules apply to the generated URL:</p>
|
|
12
13
|
* <ul>
|
|
13
14
|
* <li>
|
|
@@ -7,12 +7,8 @@ export interface GetDashboardEmbedUrlCommandInput extends GetDashboardEmbedUrlRe
|
|
|
7
7
|
export interface GetDashboardEmbedUrlCommandOutput extends GetDashboardEmbedUrlResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Generates a session URL and authorization code that you can use to embed an Amazon
|
|
11
|
-
*
|
|
12
|
-
* make sure that you have configured the dashboards and permissions. </p>
|
|
13
|
-
* <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not
|
|
14
|
-
* from the user's browser. The following rules apply to the combination of URL and
|
|
15
|
-
* authorization code:</p>
|
|
10
|
+
* <p>Generates a temporary session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions. </p>
|
|
11
|
+
* <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not from the user's browser. The following rules apply to the generated URL:</p>
|
|
16
12
|
* <ul>
|
|
17
13
|
* <li>
|
|
18
14
|
* <p>They must be used together.</p>
|
|
@@ -24,7 +20,7 @@ export interface GetDashboardEmbedUrlCommandOutput extends GetDashboardEmbedUrlR
|
|
|
24
20
|
* <p>They are valid for 5 minutes after you run this command.</p>
|
|
25
21
|
* </li>
|
|
26
22
|
* <li>
|
|
27
|
-
* <p>The resulting user session is valid for 10 hours.</p>
|
|
23
|
+
* <p>The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional <code>SessionLifetimeInMinutes</code> parameter to customi session duration.</p>
|
|
28
24
|
* </li>
|
|
29
25
|
* </ul>
|
|
30
26
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html">Embedding Analytics Using GetDashboardEmbedUrl</a> in the <i>Amazon QuickSight User
|
|
@@ -7,8 +7,7 @@ export interface UpdateAccountCustomizationCommandInput extends UpdateAccountCus
|
|
|
7
7
|
export interface UpdateAccountCustomizationCommandOutput extends UpdateAccountCustomizationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Updates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, the only
|
|
11
|
-
* customization you can use is a theme.</p>
|
|
10
|
+
* <p>Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.</p>
|
|
12
11
|
* <p>You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a
|
|
13
12
|
* Amazon QuickSight namespace instead. Customizations that apply to a namespace override
|
|
14
13
|
* customizations that apply to an Amazon Web Services account. To find out which customizations apply, use
|
|
@@ -7,9 +7,15 @@ export interface UpdatePublicSharingSettingsCommandInput extends UpdatePublicSha
|
|
|
7
7
|
export interface UpdatePublicSharingSettingsCommandOutput extends UpdatePublicSharingSettingsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Use the UpdatePublicSharingSettings operation to
|
|
11
|
-
*
|
|
12
|
-
* <p>
|
|
10
|
+
* <p>Use the <code>UpdatePublicSharingSettings</code> operation to turn on or turn off the
|
|
11
|
+
* public sharing settings of an Amazon QuickSight dashboard.</p>
|
|
12
|
+
* <p>To use this operation, turn on session capacity pricing for your Amazon QuickSight
|
|
13
|
+
* account.</p>
|
|
14
|
+
* <p>Before you can turn on public sharing on your account, make sure to give public sharing
|
|
15
|
+
* permissions to an administrative user in the Identity and Access Management (IAM)
|
|
16
|
+
* console. For more information on using IAM with Amazon QuickSight, see
|
|
17
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html">Using Amazon QuickSight with IAM</a> in the <i>Amazon QuickSight
|
|
18
|
+
* User Guide</i>.</p>
|
|
13
19
|
* @example
|
|
14
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
21
|
* ```javascript
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export * from "./CancelIngestionCommand";
|
|
2
2
|
export * from "./CreateAccountCustomizationCommand";
|
|
3
|
+
export * from "./CreateAccountSubscriptionCommand";
|
|
3
4
|
export * from "./CreateAnalysisCommand";
|
|
4
5
|
export * from "./CreateDashboardCommand";
|
|
5
6
|
export * from "./CreateDataSetCommand";
|
|
@@ -34,6 +35,7 @@ export * from "./DeleteUserByPrincipalIdCommand";
|
|
|
34
35
|
export * from "./DeleteUserCommand";
|
|
35
36
|
export * from "./DescribeAccountCustomizationCommand";
|
|
36
37
|
export * from "./DescribeAccountSettingsCommand";
|
|
38
|
+
export * from "./DescribeAccountSubscriptionCommand";
|
|
37
39
|
export * from "./DescribeAnalysisCommand";
|
|
38
40
|
export * from "./DescribeAnalysisPermissionsCommand";
|
|
39
41
|
export * from "./DescribeDashboardCommand";
|