@aws-sdk/client-quicksight 3.883.0 → 3.887.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/README.md +24 -0
- package/dist-cjs/index.js +175 -16
- package/dist-es/QuickSight.js +6 -0
- package/dist-es/commands/DeleteAccountCustomPermissionCommand.js +22 -0
- package/dist-es/commands/DescribeAccountCustomPermissionCommand.js +22 -0
- package/dist-es/commands/UpdateAccountCustomPermissionCommand.js +22 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_2.js +2 -0
- package/dist-es/models/models_3.js +12 -0
- package/dist-es/models/models_4.js +4 -13
- package/dist-es/models/models_5.js +13 -0
- package/dist-es/protocols/Aws_restJson1.js +79 -0
- package/dist-types/QuickSight.d.ts +21 -0
- package/dist-types/QuickSightClient.d.ts +5 -2
- package/dist-types/commands/CreateAccountCustomizationCommand.d.ts +2 -2
- package/dist-types/commands/CreateAccountSubscriptionCommand.d.ts +9 -9
- package/dist-types/commands/CreateAnalysisCommand.d.ts +1 -1
- package/dist-types/commands/CreateBrandCommand.d.ts +1 -1
- package/dist-types/commands/CreateCustomPermissionsCommand.d.ts +2 -0
- package/dist-types/commands/CreateDashboardCommand.d.ts +9 -3
- package/dist-types/commands/CreateDataSetCommand.d.ts +1 -1
- package/dist-types/commands/CreateDataSourceCommand.d.ts +8 -2
- package/dist-types/commands/CreateFolderCommand.d.ts +1 -1
- package/dist-types/commands/CreateFolderMembershipCommand.d.ts +1 -1
- package/dist-types/commands/CreateGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateNamespaceCommand.d.ts +3 -3
- package/dist-types/commands/CreateRoleMembershipCommand.d.ts +1 -1
- package/dist-types/commands/CreateTemplateAliasCommand.d.ts +1 -1
- package/dist-types/commands/CreateTemplateCommand.d.ts +3 -3
- package/dist-types/commands/CreateThemeAliasCommand.d.ts +1 -1
- package/dist-types/commands/CreateThemeCommand.d.ts +1 -1
- package/dist-types/commands/CreateTopicCommand.d.ts +9 -1
- package/dist-types/commands/CreateVPCConnectionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAccountCustomPermissionCommand.d.ts +91 -0
- package/dist-types/commands/DeleteAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAccountSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAnalysisCommand.d.ts +4 -4
- package/dist-types/commands/DeleteBrandCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDashboardCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDefaultQBusinessApplicationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteFolderCommand.d.ts +1 -1
- package/dist-types/commands/DeleteFolderMembershipCommand.d.ts +1 -1
- package/dist-types/commands/DeleteIdentityPropagationConfigCommand.d.ts +2 -2
- package/dist-types/commands/DeleteRoleMembershipCommand.d.ts +2 -1
- package/dist-types/commands/DeleteTemplateAliasCommand.d.ts +2 -2
- package/dist-types/commands/DeleteTemplateCommand.d.ts +2 -2
- package/dist-types/commands/DeleteThemeAliasCommand.d.ts +1 -1
- package/dist-types/commands/DeleteThemeCommand.d.ts +2 -2
- package/dist-types/commands/DeleteVPCConnectionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAccountCustomPermissionCommand.d.ts +92 -0
- package/dist-types/commands/DescribeAccountCustomizationCommand.d.ts +7 -7
- package/dist-types/commands/DescribeAccountSettingsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAccountSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAnalysisCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAnalysisPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAssetBundleExportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAssetBundleImportJobCommand.d.ts +4 -1
- package/dist-types/commands/DescribeCustomPermissionsCommand.d.ts +2 -0
- package/dist-types/commands/DescribeDashboardCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +7 -1
- package/dist-types/commands/DescribeDashboardPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDashboardSnapshotJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +7 -1
- package/dist-types/commands/DescribeDefaultQBusinessApplicationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFolderCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFolderResolvedPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeKeyRegistrationCommand.d.ts +5 -1
- package/dist-types/commands/DescribeQuickSightQSearchConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateAliasCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplatePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemeAliasCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTopicCommand.d.ts +9 -1
- package/dist-types/commands/DescribeVPCConnectionCommand.d.ts +1 -1
- package/dist-types/commands/GenerateEmbedUrlForAnonymousUserCommand.d.ts +3 -3
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +3 -3
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserWithIdentityCommand.d.ts +5 -5
- package/dist-types/commands/GetDashboardEmbedUrlCommand.d.ts +5 -5
- package/dist-types/commands/GetSessionEmbedUrlCommand.d.ts +3 -3
- package/dist-types/commands/ListAnalysesCommand.d.ts +1 -1
- package/dist-types/commands/ListAssetBundleExportJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListAssetBundleImportJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListBrandsCommand.d.ts +1 -1
- package/dist-types/commands/ListCustomPermissionsCommand.d.ts +2 -0
- package/dist-types/commands/ListDashboardVersionsCommand.d.ts +2 -2
- package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist-types/commands/ListDataSourcesCommand.d.ts +7 -1
- package/dist-types/commands/ListFolderMembersCommand.d.ts +1 -1
- package/dist-types/commands/ListFoldersCommand.d.ts +1 -1
- package/dist-types/commands/ListFoldersForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListIdentityPropagationConfigsCommand.d.ts +2 -2
- package/dist-types/commands/ListTemplateAliasesCommand.d.ts +1 -1
- package/dist-types/commands/ListTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListTemplatesCommand.d.ts +1 -1
- package/dist-types/commands/ListThemeAliasesCommand.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/ListVPCConnectionsCommand.d.ts +1 -1
- package/dist-types/commands/PredictQAResultsCommand.d.ts +1 -1
- package/dist-types/commands/RegisterUserCommand.d.ts +1 -1
- package/dist-types/commands/RestoreAnalysisCommand.d.ts +1 -1
- package/dist-types/commands/SearchAnalysesCommand.d.ts +1 -1
- package/dist-types/commands/SearchDashboardsCommand.d.ts +1 -1
- package/dist-types/commands/SearchDataSetsCommand.d.ts +1 -1
- package/dist-types/commands/SearchDataSourcesCommand.d.ts +2 -2
- package/dist-types/commands/SearchFoldersCommand.d.ts +2 -2
- package/dist-types/commands/SearchGroupsCommand.d.ts +2 -2
- package/dist-types/commands/SearchTopicsCommand.d.ts +2 -2
- package/dist-types/commands/StartAssetBundleExportJobCommand.d.ts +2 -2
- package/dist-types/commands/StartAssetBundleImportJobCommand.d.ts +5 -2
- package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +6 -6
- package/dist-types/commands/StartDashboardSnapshotJobScheduleCommand.d.ts +2 -2
- package/dist-types/commands/TagResourceCommand.d.ts +5 -5
- package/dist-types/commands/UpdateAccountCustomPermissionCommand.d.ts +92 -0
- package/dist-types/commands/UpdateAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAnalysisPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateApplicationWithTokenExchangeGrantCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCustomPermissionsCommand.d.ts +2 -0
- package/dist-types/commands/UpdateDashboardCommand.d.ts +7 -1
- package/dist-types/commands/UpdateDashboardLinksCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardPublishedVersionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +7 -1
- package/dist-types/commands/UpdateDefaultQBusinessApplicationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFolderCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIdentityPropagationConfigCommand.d.ts +2 -2
- package/dist-types/commands/UpdateKeyRegistrationCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePublicSharingSettingsCommand.d.ts +6 -6
- package/dist-types/commands/UpdateQuickSightQSearchConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSPICECapacityConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTemplateAliasCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTemplateCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTemplatePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThemeAliasCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThemeCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThemePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTopicCommand.d.ts +9 -1
- package/dist-types/commands/UpdateTopicPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateVPCConnectionCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +39 -39
- package/dist-types/models/models_1.d.ts +2 -2
- package/dist-types/models/models_2.d.ts +106 -47
- package/dist-types/models/models_3.d.ts +236 -257
- package/dist-types/models/models_4.d.ts +346 -362
- package/dist-types/models/models_5.d.ts +355 -55
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/ts3.4/QuickSight.d.ts +51 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/DeleteAccountCustomPermissionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteRoleMembershipCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DeleteTemplateAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteThemeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeAccountCustomPermissionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/SearchDataSetsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchDataSourcesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchFoldersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAccountCustomPermissionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_2.d.ts +64 -4
- package/dist-types/ts3.4/models/models_3.d.ts +44 -43
- package/dist-types/ts3.4/models/models_4.d.ts +56 -74
- package/dist-types/ts3.4/models/models_5.d.ts +86 -1
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
- package/package.json +37 -37
|
@@ -27,7 +27,7 @@ declare const RegisterUserCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the
|
|
30
|
+
* <p>Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the QuickSight API, QuickSight generates a registration URL. The user accesses this registration URL to create their account. QuickSight doesn't send a registration email to users who are registered from the QuickSight API. If you want new users to receive a registration email, then add those users in the QuickSight console. For more information on registering a new user in the QuickSight console, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/managing-users.html#inviting-users"> Inviting users to access QuickSight</a>.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -83,7 +83,7 @@ declare const RestoreAnalysisCommand_base: {
|
|
|
83
83
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
84
84
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
85
85
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
86
|
-
*
|
|
86
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
87
87
|
* capability is available in every edition.</p>
|
|
88
88
|
*
|
|
89
89
|
* @throws {@link QuickSightServiceException}
|
|
@@ -93,7 +93,7 @@ declare const SearchAnalysesCommand_base: {
|
|
|
93
93
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
94
94
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
95
95
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
96
|
-
*
|
|
96
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
97
97
|
* capability is available in every edition.</p>
|
|
98
98
|
*
|
|
99
99
|
* @throws {@link QuickSightServiceException}
|
|
@@ -94,7 +94,7 @@ declare const SearchDashboardsCommand_base: {
|
|
|
94
94
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
95
95
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
96
96
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
97
|
-
*
|
|
97
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
98
98
|
* capability is available in every edition.</p>
|
|
99
99
|
*
|
|
100
100
|
* @throws {@link QuickSightServiceException}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { SearchDataSetsRequest, SearchDataSetsResponse } from "../models/
|
|
3
|
+
import { SearchDataSetsRequest, SearchDataSetsResponse } from "../models/models_5";
|
|
4
4
|
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { SearchDataSourcesRequest, SearchDataSourcesResponse } from "../models/
|
|
3
|
+
import { SearchDataSourcesRequest, SearchDataSourcesResponse } from "../models/models_5";
|
|
4
4
|
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -54,7 +54,7 @@ declare const SearchDataSourcesCommand_base: {
|
|
|
54
54
|
* // Arn: "STRING_VALUE",
|
|
55
55
|
* // DataSourceId: "STRING_VALUE",
|
|
56
56
|
* // Name: "STRING_VALUE",
|
|
57
|
-
* // Type: "ADOBE_ANALYTICS" || "AMAZON_ELASTICSEARCH" || "ATHENA" || "AURORA" || "AURORA_POSTGRESQL" || "AWS_IOT_ANALYTICS" || "GITHUB" || "JIRA" || "MARIADB" || "MYSQL" || "ORACLE" || "POSTGRESQL" || "PRESTO" || "REDSHIFT" || "S3" || "SALESFORCE" || "SERVICENOW" || "SNOWFLAKE" || "SPARK" || "SQLSERVER" || "TERADATA" || "TWITTER" || "TIMESTREAM" || "AMAZON_OPENSEARCH" || "EXASOL" || "DATABRICKS" || "STARBURST" || "TRINO" || "BIGQUERY",
|
|
57
|
+
* // Type: "ADOBE_ANALYTICS" || "AMAZON_ELASTICSEARCH" || "ATHENA" || "AURORA" || "AURORA_POSTGRESQL" || "AWS_IOT_ANALYTICS" || "GITHUB" || "JIRA" || "MARIADB" || "MYSQL" || "ORACLE" || "POSTGRESQL" || "PRESTO" || "REDSHIFT" || "S3" || "SALESFORCE" || "SERVICENOW" || "SNOWFLAKE" || "SPARK" || "SQLSERVER" || "TERADATA" || "TWITTER" || "TIMESTREAM" || "AMAZON_OPENSEARCH" || "EXASOL" || "DATABRICKS" || "STARBURST" || "TRINO" || "BIGQUERY" || "GOOGLESHEETS",
|
|
58
58
|
* // CreatedTime: new Date("TIMESTAMP"),
|
|
59
59
|
* // LastUpdatedTime: new Date("TIMESTAMP"),
|
|
60
60
|
* // },
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { SearchFoldersRequest, SearchFoldersResponse } from "../models/
|
|
3
|
+
import { SearchFoldersRequest, SearchFoldersResponse } from "../models/models_5";
|
|
4
4
|
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -100,7 +100,7 @@ declare const SearchFoldersCommand_base: {
|
|
|
100
100
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
101
101
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
102
102
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
103
|
-
*
|
|
103
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
104
104
|
* capability is available in every edition.</p>
|
|
105
105
|
*
|
|
106
106
|
* @throws {@link QuickSightServiceException}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { SearchGroupsRequest, SearchGroupsResponse } from "../models/
|
|
3
|
+
import { SearchGroupsRequest, SearchGroupsResponse } from "../models/models_5";
|
|
4
4
|
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -27,7 +27,7 @@ declare const SearchGroupsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Use the <code>SearchGroups</code> operation to search groups in a specified
|
|
30
|
+
* <p>Use the <code>SearchGroups</code> operation to search groups in a specified QuickSight namespace using the supplied filters.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const SearchTopicsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Searches for any Q topic that exists in an
|
|
30
|
+
* <p>Searches for any Q topic that exists in an QuickSight 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
|
|
@@ -88,7 +88,7 @@ declare const SearchTopicsCommand_base: {
|
|
|
88
88
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
89
89
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
90
90
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
91
|
-
*
|
|
91
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
92
92
|
* capability is available in every edition.</p>
|
|
93
93
|
*
|
|
94
94
|
* @throws {@link QuickSightServiceException}
|
|
@@ -28,7 +28,7 @@ declare const StartAssetBundleExportJobCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Starts an Asset Bundle export job.</p>
|
|
31
|
-
* <p>An Asset Bundle export job exports specified
|
|
31
|
+
* <p>An Asset Bundle export job exports specified QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a <code>DescribeAssetBundleExportJob</code> API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a <code>DescribeAssetBundleExportJob</code> API call. Each QuickSight account can run up to 5 export jobs concurrently.</p>
|
|
32
32
|
* <p>The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -162,7 +162,7 @@ declare const StartAssetBundleExportJobCommand_base: {
|
|
|
162
162
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
163
163
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
164
164
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
165
|
-
*
|
|
165
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
166
166
|
* capability is available in every edition.</p>
|
|
167
167
|
*
|
|
168
168
|
* @throws {@link QuickSightServiceException}
|
|
@@ -28,7 +28,7 @@ declare const StartAssetBundleImportJobCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Starts an Asset Bundle import job.</p>
|
|
31
|
-
* <p>An Asset Bundle import job imports specified
|
|
31
|
+
* <p>An Asset Bundle import job imports specified QuickSight assets into an QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your QuickSight account. Each QuickSight account can run up to 5 import jobs concurrently.</p>
|
|
32
32
|
* <p>The API caller must have the necessary <code>"create"</code>, <code>"describe"</code>, and <code>"update"</code> permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -234,6 +234,9 @@ declare const StartAssetBundleImportJobCommand_base: {
|
|
|
234
234
|
* Database: "STRING_VALUE",
|
|
235
235
|
* SqlEndpointPath: "STRING_VALUE", // required
|
|
236
236
|
* },
|
|
237
|
+
* CustomConnectionParameters: { // CustomConnectionParameters
|
|
238
|
+
* ConnectionType: "STRING_VALUE",
|
|
239
|
+
* },
|
|
237
240
|
* },
|
|
238
241
|
* VpcConnectionProperties: {
|
|
239
242
|
* VpcConnectionArn: "STRING_VALUE", // required
|
|
@@ -499,7 +502,7 @@ declare const StartAssetBundleImportJobCommand_base: {
|
|
|
499
502
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
500
503
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
501
504
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
502
|
-
*
|
|
505
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
503
506
|
* capability is available in every edition.</p>
|
|
504
507
|
*
|
|
505
508
|
* @throws {@link QuickSightServiceException}
|
|
@@ -43,7 +43,7 @@ declare const StartDashboardSnapshotJobCommand_base: {
|
|
|
43
43
|
* <p>
|
|
44
44
|
* <b>StartDashboardSnapshotJob API throttling</b>
|
|
45
45
|
* </p>
|
|
46
|
-
* <p>
|
|
46
|
+
* <p>QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the <code>StartDashboardSnapshotJob</code>. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, QuickSight throttles the API calls to maintin an optimal experience and reliability for all QuickSight users.</p>
|
|
47
47
|
* <p>
|
|
48
48
|
* <b>Common throttling scenarios</b>
|
|
49
49
|
* </p>
|
|
@@ -55,14 +55,14 @@ declare const StartDashboardSnapshotJobCommand_base: {
|
|
|
55
55
|
* </li>
|
|
56
56
|
* <li>
|
|
57
57
|
* <p>
|
|
58
|
-
* <b>A large number of API requests are submitted on an Amazon Web Services account.</b> When a user makes more than 10 API calls to the
|
|
58
|
+
* <b>A large number of API requests are submitted on an Amazon Web Services account.</b> When a user makes more than 10 API calls to the QuickSight API in one second, a <code>ThrottlingException</code> is returned.</p>
|
|
59
59
|
* </li>
|
|
60
60
|
* </ul>
|
|
61
61
|
* <p>If your use case requires a higher throttling limit, contact your account admin or <a href="http://aws.amazon.com/contact-us/">Amazon Web ServicesSupport</a> to explore options to tailor a more optimal expereince for your account.</p>
|
|
62
62
|
* <p>
|
|
63
63
|
* <b>Best practices to handle throttling</b>
|
|
64
64
|
* </p>
|
|
65
|
-
* <p>If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the
|
|
65
|
+
* <p>If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example <code>(12 minutes * 9 = 108 minutes)</code>. Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.</p>
|
|
66
66
|
* <p>The time that it takes to process a job can be impacted by the following factors:</p>
|
|
67
67
|
* <ul>
|
|
68
68
|
* <li>
|
|
@@ -219,8 +219,8 @@ declare const StartDashboardSnapshotJobCommand_base: {
|
|
|
219
219
|
* @throws {@link UnsupportedPricingPlanException} (client fault)
|
|
220
220
|
* <p>This error indicates that you are calling an embedding operation in Amazon QuickSight
|
|
221
221
|
* without the required pricing plan on your Amazon Web Services account. Before you can use embedding
|
|
222
|
-
* for anonymous users, a QuickSight administrator needs to add capacity pricing to
|
|
223
|
-
* can do this on the <b>Manage
|
|
222
|
+
* for anonymous users, a QuickSight administrator needs to add capacity pricing to QuickSight. You
|
|
223
|
+
* can do this on the <b>Manage QuickSight</b> page. </p>
|
|
224
224
|
* <p>After capacity pricing is added, you can use the
|
|
225
225
|
* <code>
|
|
226
226
|
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetDashboardEmbedUrl.html">GetDashboardEmbedUrl</a>
|
|
@@ -230,7 +230,7 @@ declare const StartDashboardSnapshotJobCommand_base: {
|
|
|
230
230
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
231
231
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
232
232
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
233
|
-
*
|
|
233
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
234
234
|
* capability is available in every edition.</p>
|
|
235
235
|
*
|
|
236
236
|
* @throws {@link QuickSightServiceException}
|
|
@@ -29,7 +29,7 @@ declare const StartDashboardSnapshotJobScheduleCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email. </p>
|
|
31
31
|
* <p>Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a <code>202</code> HTTP status code.</p>
|
|
32
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sending-reports.html">Scheduling and sending
|
|
32
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sending-reports.html">Scheduling and sending QuickSight reports by email</a> and <a href="https://docs.aws.amazon.com/quicksight/latest/user/email-reports-from-dashboard.html">Configuring email report settings for a QuickSight dashboard</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -80,7 +80,7 @@ declare const StartDashboardSnapshotJobScheduleCommand_base: {
|
|
|
80
80
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
81
81
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
82
82
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
83
|
-
*
|
|
83
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
84
84
|
* capability is available in every edition.</p>
|
|
85
85
|
*
|
|
86
86
|
* @throws {@link QuickSightServiceException}
|
|
@@ -27,7 +27,7 @@ declare const TagResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Assigns one or more tags (key-value pairs) to the specified
|
|
30
|
+
* <p>Assigns one or more tags (key-value pairs) to the specified QuickSight resource. </p>
|
|
31
31
|
* <p>Tags can help you organize and categorize your resources. You can also use them to
|
|
32
32
|
* scope user permissions, by granting a user permission to access or change only resources
|
|
33
33
|
* with certain tag values. You can use the <code>TagResource</code> operation with a
|
|
@@ -35,16 +35,16 @@ declare const TagResourceCommand_base: {
|
|
|
35
35
|
* is appended to the list of tags associated with the resource. If you specify a tag key
|
|
36
36
|
* that is already associated with the resource, the new tag value that you specify
|
|
37
37
|
* replaces the previous value for that tag.</p>
|
|
38
|
-
* <p>You can associate as many as 50 tags with a resource.
|
|
38
|
+
* <p>You can associate as many as 50 tags with a resource. QuickSight supports tagging on data
|
|
39
39
|
* set, data source, dashboard, template, topic, and user. </p>
|
|
40
|
-
* <p>Tagging for
|
|
40
|
+
* <p>Tagging for QuickSight works in a similar way to tagging for other Amazon Web Services services, except for
|
|
41
41
|
* the following:</p>
|
|
42
42
|
* <ul>
|
|
43
43
|
* <li>
|
|
44
|
-
* <p>Tags are used to track costs for users in
|
|
44
|
+
* <p>Tags are used to track costs for users in QuickSight. You can't tag other resources that QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.</p>
|
|
45
45
|
* </li>
|
|
46
46
|
* <li>
|
|
47
|
-
* <p>
|
|
47
|
+
* <p>QuickSight doesn't currently support the tag editor for Resource Groups.</p>
|
|
48
48
|
* </li>
|
|
49
49
|
* </ul>
|
|
50
50
|
* @example
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { UpdateAccountCustomPermissionRequest, UpdateAccountCustomPermissionResponse } from "../models/models_5";
|
|
4
|
+
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateAccountCustomPermissionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateAccountCustomPermissionCommandInput extends UpdateAccountCustomPermissionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateAccountCustomPermissionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateAccountCustomPermissionCommandOutput extends UpdateAccountCustomPermissionResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateAccountCustomPermissionCommand_base: {
|
|
25
|
+
new (input: UpdateAccountCustomPermissionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateAccountCustomPermissionCommandInput, UpdateAccountCustomPermissionCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateAccountCustomPermissionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateAccountCustomPermissionCommandInput, UpdateAccountCustomPermissionCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Applies a custom permissions profile to an account.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QuickSightClient, UpdateAccountCustomPermissionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
35
|
+
* // const { QuickSightClient, UpdateAccountCustomPermissionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
36
|
+
* const client = new QuickSightClient(config);
|
|
37
|
+
* const input = { // UpdateAccountCustomPermissionRequest
|
|
38
|
+
* CustomPermissionsName: "STRING_VALUE", // required
|
|
39
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new UpdateAccountCustomPermissionCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // UpdateAccountCustomPermissionResponse
|
|
44
|
+
* // RequestId: "STRING_VALUE",
|
|
45
|
+
* // Status: Number("int"),
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
50
|
+
* @param UpdateAccountCustomPermissionCommandInput - {@link UpdateAccountCustomPermissionCommandInput}
|
|
51
|
+
* @returns {@link UpdateAccountCustomPermissionCommandOutput}
|
|
52
|
+
* @see {@link UpdateAccountCustomPermissionCommandInput} for command's `input` shape.
|
|
53
|
+
* @see {@link UpdateAccountCustomPermissionCommandOutput} for command's `response` shape.
|
|
54
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
57
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
58
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
59
|
+
* account is authorized to use the Amazon QuickSight service, that your policies have the
|
|
60
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
63
|
+
* <p>An internal failure occurred.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
66
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
69
|
+
* <p>One or more resources can't be found.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
72
|
+
* <p>Access is throttled.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link QuickSightServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
76
|
+
*
|
|
77
|
+
*
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
export declare class UpdateAccountCustomPermissionCommand extends UpdateAccountCustomPermissionCommand_base {
|
|
81
|
+
/** @internal type navigation helper, not in runtime. */
|
|
82
|
+
protected static __types: {
|
|
83
|
+
api: {
|
|
84
|
+
input: UpdateAccountCustomPermissionRequest;
|
|
85
|
+
output: UpdateAccountCustomPermissionResponse;
|
|
86
|
+
};
|
|
87
|
+
sdk: {
|
|
88
|
+
input: UpdateAccountCustomPermissionCommandInput;
|
|
89
|
+
output: UpdateAccountCustomPermissionCommandOutput;
|
|
90
|
+
};
|
|
91
|
+
};
|
|
92
|
+
}
|
|
@@ -29,7 +29,7 @@ declare const UpdateAccountCustomizationCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.</p>
|
|
31
31
|
* <p>You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a
|
|
32
|
-
*
|
|
32
|
+
* QuickSight namespace instead. Customizations that apply to a namespace override
|
|
33
33
|
* customizations that apply to an Amazon Web Services account. To find out which customizations apply, use
|
|
34
34
|
* the <code>DescribeAccountCustomization</code> API operation. </p>
|
|
35
35
|
* @example
|
|
@@ -5540,7 +5540,7 @@ declare const UpdateAnalysisCommand_base: {
|
|
|
5540
5540
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
5541
5541
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
5542
5542
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
5543
|
-
*
|
|
5543
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
5544
5544
|
* capability is available in every edition.</p>
|
|
5545
5545
|
*
|
|
5546
5546
|
* @throws {@link QuickSightServiceException}
|
|
@@ -100,7 +100,7 @@ declare const UpdateAnalysisPermissionsCommand_base: {
|
|
|
100
100
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
101
101
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
102
102
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
103
|
-
*
|
|
103
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
104
104
|
* capability is available in every edition.</p>
|
|
105
105
|
*
|
|
106
106
|
* @throws {@link QuickSightServiceException}
|
|
@@ -27,7 +27,7 @@ declare const UpdateApplicationWithTokenExchangeGrantCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates an
|
|
30
|
+
* <p>Updates an QuickSight application with a token exchange grant. This operation only supports QuickSight applications that are registered with IAM Identity Center.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -61,6 +61,8 @@ declare const UpdateCustomPermissionsCommand_base: {
|
|
|
61
61
|
* ExportToCsvInScheduledReports: "DENY",
|
|
62
62
|
* ExportToExcelInScheduledReports: "DENY",
|
|
63
63
|
* IncludeContentInScheduledReportsEmail: "DENY",
|
|
64
|
+
* Dashboard: "DENY",
|
|
65
|
+
* Analysis: "DENY",
|
|
64
66
|
* },
|
|
65
67
|
* };
|
|
66
68
|
* const command = new UpdateCustomPermissionsCommand(input);
|
|
@@ -130,6 +130,12 @@ declare const UpdateDashboardCommand_base: {
|
|
|
130
130
|
* DataQAEnabledOption: { // DataQAEnabledOption
|
|
131
131
|
* AvailabilityStatus: "ENABLED" || "DISABLED",
|
|
132
132
|
* },
|
|
133
|
+
* ExecutiveSummaryOption: { // ExecutiveSummaryOption
|
|
134
|
+
* AvailabilityStatus: "ENABLED" || "DISABLED",
|
|
135
|
+
* },
|
|
136
|
+
* DataStoriesSharingOption: { // DataStoriesSharingOption
|
|
137
|
+
* AvailabilityStatus: "ENABLED" || "DISABLED",
|
|
138
|
+
* },
|
|
133
139
|
* },
|
|
134
140
|
* ThemeArn: "STRING_VALUE",
|
|
135
141
|
* Definition: { // DashboardVersionDefinition
|
|
@@ -5584,7 +5590,7 @@ declare const UpdateDashboardCommand_base: {
|
|
|
5584
5590
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
5585
5591
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
5586
5592
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
5587
|
-
*
|
|
5593
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
5588
5594
|
* capability is available in every edition.</p>
|
|
5589
5595
|
*
|
|
5590
5596
|
* @throws {@link QuickSightServiceException}
|
|
@@ -84,7 +84,7 @@ declare const UpdateDashboardLinksCommand_base: {
|
|
|
84
84
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
85
85
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
86
86
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
87
|
-
*
|
|
87
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
88
88
|
* capability is available in every edition.</p>
|
|
89
89
|
*
|
|
90
90
|
* @throws {@link QuickSightServiceException}
|
|
@@ -126,7 +126,7 @@ declare const UpdateDashboardPermissionsCommand_base: {
|
|
|
126
126
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
127
127
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
128
128
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
129
|
-
*
|
|
129
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
130
130
|
* capability is available in every edition.</p>
|
|
131
131
|
*
|
|
132
132
|
* @throws {@link QuickSightServiceException}
|
|
@@ -74,7 +74,7 @@ declare const UpdateDashboardPublishedVersionCommand_base: {
|
|
|
74
74
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
75
75
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
76
76
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
77
|
-
*
|
|
77
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
78
78
|
* capability is available in every edition.</p>
|
|
79
79
|
*
|
|
80
80
|
* @throws {@link QuickSightServiceException}
|
|
@@ -329,7 +329,7 @@ declare const UpdateDataSetCommand_base: {
|
|
|
329
329
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
330
330
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
331
331
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
332
|
-
*
|
|
332
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
333
333
|
* capability is available in every edition.</p>
|
|
334
334
|
*
|
|
335
335
|
* @throws {@link QuickSightServiceException}
|
|
@@ -198,6 +198,9 @@ declare const UpdateDataSourceCommand_base: {
|
|
|
198
198
|
* Database: "STRING_VALUE",
|
|
199
199
|
* SqlEndpointPath: "STRING_VALUE", // required
|
|
200
200
|
* },
|
|
201
|
+
* CustomConnectionParameters: { // CustomConnectionParameters
|
|
202
|
+
* ConnectionType: "STRING_VALUE",
|
|
203
|
+
* },
|
|
201
204
|
* },
|
|
202
205
|
* Credentials: { // DataSourceCredentials
|
|
203
206
|
* CredentialPair: { // CredentialPair
|
|
@@ -364,6 +367,9 @@ declare const UpdateDataSourceCommand_base: {
|
|
|
364
367
|
* Database: "STRING_VALUE",
|
|
365
368
|
* SqlEndpointPath: "STRING_VALUE", // required
|
|
366
369
|
* },
|
|
370
|
+
* CustomConnectionParameters: {
|
|
371
|
+
* ConnectionType: "STRING_VALUE",
|
|
372
|
+
* },
|
|
367
373
|
* },
|
|
368
374
|
* ],
|
|
369
375
|
* },
|
|
@@ -403,7 +409,7 @@ declare const UpdateDataSourceCommand_base: {
|
|
|
403
409
|
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
404
410
|
*
|
|
405
411
|
* @throws {@link CustomerManagedKeyUnavailableException} (client fault)
|
|
406
|
-
* <p>The customer managed key that is registered to your
|
|
412
|
+
* <p>The customer managed key that is registered to your QuickSight account is unavailable.</p>
|
|
407
413
|
*
|
|
408
414
|
* @throws {@link InternalFailureException} (server fault)
|
|
409
415
|
* <p>An internal failure occurred.</p>
|
|
@@ -27,7 +27,7 @@ declare const UpdateDefaultQBusinessApplicationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates a Amazon Q Business application that is linked to a
|
|
30
|
+
* <p>Updates a Amazon Q Business application that is linked to a QuickSight 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
|
|
@@ -83,7 +83,7 @@ declare const UpdateFolderCommand_base: {
|
|
|
83
83
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
84
84
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
85
85
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
86
|
-
*
|
|
86
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
87
87
|
* capability is available in every edition.</p>
|
|
88
88
|
*
|
|
89
89
|
* @throws {@link QuickSightServiceException}
|
|
@@ -103,7 +103,7 @@ declare const UpdateFolderPermissionsCommand_base: {
|
|
|
103
103
|
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
104
104
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
105
105
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
106
|
-
*
|
|
106
|
+
* QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
107
107
|
* capability is available in every edition.</p>
|
|
108
108
|
*
|
|
109
109
|
* @throws {@link QuickSightServiceException}
|
|
@@ -27,8 +27,8 @@ declare const UpdateIdentityPropagationConfigCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Adds or updates services and authorized targets to configure what the
|
|
31
|
-
* <p>This operation is only supported for
|
|
30
|
+
* <p>Adds or updates services and authorized targets to configure what the QuickSight IAM Identity Center application can access.</p>
|
|
31
|
+
* <p>This operation is only supported for QuickSight accounts using IAM Identity Center</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const UpdateKeyRegistrationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates a customer managed key in a
|
|
30
|
+
* <p>Updates a customer managed key in a QuickSight 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
|
|
@@ -28,13 +28,13 @@ declare const UpdatePublicSharingSettingsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Use the <code>UpdatePublicSharingSettings</code> operation to turn on or turn off the
|
|
31
|
-
* public sharing settings of an
|
|
32
|
-
* <p>To use this operation, turn on session capacity pricing for your
|
|
31
|
+
* public sharing settings of an QuickSight dashboard.</p>
|
|
32
|
+
* <p>To use this operation, turn on session capacity pricing for your QuickSight
|
|
33
33
|
* account.</p>
|
|
34
34
|
* <p>Before you can turn on public sharing on your account, make sure to give public sharing
|
|
35
35
|
* permissions to an administrative user in the Identity and Access Management (IAM)
|
|
36
|
-
* console. For more information on using IAM with
|
|
37
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html">Using
|
|
36
|
+
* console. For more information on using IAM with QuickSight, see
|
|
37
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html">Using QuickSight with IAM</a> in the <i>QuickSight
|
|
38
38
|
* User Guide</i>.</p>
|
|
39
39
|
* @example
|
|
40
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -82,8 +82,8 @@ declare const UpdatePublicSharingSettingsCommand_base: {
|
|
|
82
82
|
* @throws {@link UnsupportedPricingPlanException} (client fault)
|
|
83
83
|
* <p>This error indicates that you are calling an embedding operation in Amazon QuickSight
|
|
84
84
|
* without the required pricing plan on your Amazon Web Services account. Before you can use embedding
|
|
85
|
-
* for anonymous users, a QuickSight administrator needs to add capacity pricing to
|
|
86
|
-
* can do this on the <b>Manage
|
|
85
|
+
* for anonymous users, a QuickSight administrator needs to add capacity pricing to QuickSight. You
|
|
86
|
+
* can do this on the <b>Manage QuickSight</b> page. </p>
|
|
87
87
|
* <p>After capacity pricing is added, you can use the
|
|
88
88
|
* <code>
|
|
89
89
|
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetDashboardEmbedUrl.html">GetDashboardEmbedUrl</a>
|
|
@@ -27,7 +27,7 @@ declare const UpdateQuickSightQSearchConfigurationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates the state of a
|
|
30
|
+
* <p>Updates the state of a QuickSight Q Search configuration.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|