From 81b1f8ca7d33fdfeaf816cc2057e2bd571d694fd Mon Sep 17 00:00:00 2001 From: awstools Date: Thu, 14 Nov 2024 19:14:42 +0000 Subject: [PATCH] feat(client-quicksight): This release adds APIs for Custom Permissions management in QuickSight, and APIs to support QuickSight Branding. --- clients/client-quicksight/README.md | 150 +- clients/client-quicksight/src/QuickSight.ts | 345 + .../client-quicksight/src/QuickSightClient.ts | 87 + .../src/commands/CreateBrandCommand.ts | 289 + .../CreateCustomPermissionsCommand.ts | 153 + .../commands/DeleteBrandAssignmentCommand.ts | 113 + .../src/commands/DeleteBrandCommand.ts | 114 + .../DeleteCustomPermissionsCommand.ts | 125 + .../DeleteUserCustomPermissionCommand.ts | 122 + .../DescribeBrandAssignmentCommand.ts | 114 + .../src/commands/DescribeBrandCommand.ts | 225 + .../DescribeBrandPublishedVersionCommand.ts | 229 + .../DescribeCustomPermissionsCommand.ts | 141 + .../src/commands/DescribeIngestionCommand.ts | 3 +- .../commands/DescribeIpRestrictionCommand.ts | 2 +- .../DescribeKeyRegistrationCommand.ts | 2 +- .../src/commands/DescribeNamespaceCommand.ts | 2 +- ...ibeQPersonalizationConfigurationCommand.ts | 2 +- .../DescribeRefreshScheduleCommand.ts | 2 +- .../DescribeRoleCustomPermissionCommand.ts | 2 +- .../commands/DescribeTemplateAliasCommand.ts | 2 +- .../src/commands/DescribeTemplateCommand.ts | 2 +- .../DescribeTemplateDefinitionCommand.ts | 2 +- .../DescribeTemplatePermissionsCommand.ts | 2 +- .../src/commands/DescribeThemeAliasCommand.ts | 2 +- .../src/commands/DescribeThemeCommand.ts | 2 +- .../DescribeThemePermissionsCommand.ts | 2 +- .../src/commands/DescribeTopicCommand.ts | 2 +- .../DescribeTopicPermissionsCommand.ts | 3 +- .../src/commands/ListBrandsCommand.ts | 120 + .../commands/ListCustomPermissionsCommand.ts | 145 + .../commands/UpdateBrandAssignmentCommand.ts | 115 + .../src/commands/UpdateBrandCommand.ts | 283 + .../UpdateBrandPublishedVersionCommand.ts | 121 + .../UpdateCustomPermissionsCommand.ts | 141 + .../UpdateUserCustomPermissionCommand.ts | 123 + .../client-quicksight/src/commands/index.ts | 17 + .../client-quicksight/src/models/models_2.ts | 3047 +++--- .../client-quicksight/src/models/models_3.ts | 8816 ++++++++--------- .../client-quicksight/src/models/models_4.ts | 1782 +++- .../src/pagination/ListBrandsPaginator.ts | 20 + .../ListCustomPermissionsPaginator.ts | 24 + .../client-quicksight/src/pagination/index.ts | 2 + .../src/protocols/Aws_restJson1.ts | 1087 +- .../sdk-codegen/aws-models/quicksight.json | 2441 ++++- 45 files changed, 14235 insertions(+), 6290 deletions(-) create mode 100644 clients/client-quicksight/src/commands/CreateBrandCommand.ts create mode 100644 clients/client-quicksight/src/commands/CreateCustomPermissionsCommand.ts create mode 100644 clients/client-quicksight/src/commands/DeleteBrandAssignmentCommand.ts create mode 100644 clients/client-quicksight/src/commands/DeleteBrandCommand.ts create mode 100644 clients/client-quicksight/src/commands/DeleteCustomPermissionsCommand.ts create mode 100644 clients/client-quicksight/src/commands/DeleteUserCustomPermissionCommand.ts create mode 100644 clients/client-quicksight/src/commands/DescribeBrandAssignmentCommand.ts create mode 100644 clients/client-quicksight/src/commands/DescribeBrandCommand.ts create mode 100644 clients/client-quicksight/src/commands/DescribeBrandPublishedVersionCommand.ts create mode 100644 clients/client-quicksight/src/commands/DescribeCustomPermissionsCommand.ts create mode 100644 clients/client-quicksight/src/commands/ListBrandsCommand.ts create mode 100644 clients/client-quicksight/src/commands/ListCustomPermissionsCommand.ts create mode 100644 clients/client-quicksight/src/commands/UpdateBrandAssignmentCommand.ts create mode 100644 clients/client-quicksight/src/commands/UpdateBrandCommand.ts create mode 100644 clients/client-quicksight/src/commands/UpdateBrandPublishedVersionCommand.ts create mode 100644 clients/client-quicksight/src/commands/UpdateCustomPermissionsCommand.ts create mode 100644 clients/client-quicksight/src/commands/UpdateUserCustomPermissionCommand.ts create mode 100644 clients/client-quicksight/src/pagination/ListBrandsPaginator.ts create mode 100644 clients/client-quicksight/src/pagination/ListCustomPermissionsPaginator.ts diff --git a/clients/client-quicksight/README.md b/clients/client-quicksight/README.md index 2704cca75c18..b4d513b0d9f4 100644 --- a/clients/client-quicksight/README.md +++ b/clients/client-quicksight/README.md @@ -28,16 +28,16 @@ using your favorite package manager: The AWS SDK is modulized by clients and commands. To send a request, you only need to import the `QuickSightClient` and -the commands you need, for example `ListFoldersCommand`: +the commands you need, for example `ListBrandsCommand`: ```js // ES5 example -const { QuickSightClient, ListFoldersCommand } = require("@aws-sdk/client-quicksight"); +const { QuickSightClient, ListBrandsCommand } = require("@aws-sdk/client-quicksight"); ``` ```ts // ES6+ example -import { QuickSightClient, ListFoldersCommand } from "@aws-sdk/client-quicksight"; +import { QuickSightClient, ListBrandsCommand } from "@aws-sdk/client-quicksight"; ``` ### Usage @@ -56,7 +56,7 @@ const client = new QuickSightClient({ region: "REGION" }); const params = { /** input parameters */ }; -const command = new ListFoldersCommand(params); +const command = new ListBrandsCommand(params); ``` #### Async/await @@ -135,7 +135,7 @@ const client = new AWS.QuickSight({ region: "REGION" }); // async/await. try { - const data = await client.listFolders(params); + const data = await client.listBrands(params); // process data. } catch (error) { // error handling. @@ -143,7 +143,7 @@ try { // Promises. client - .listFolders(params) + .listBrands(params) .then((data) => { // process data. }) @@ -152,7 +152,7 @@ client }); // callbacks. -client.listFolders(params, (err, data) => { +client.listBrands(params, (err, data) => { // process err and data. }); ``` @@ -255,6 +255,22 @@ CreateAnalysis [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/CreateAnalysisCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/CreateAnalysisCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/CreateAnalysisCommandOutput/) + +
+ +CreateBrand + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/CreateBrandCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/CreateBrandCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/CreateBrandCommandOutput/) + +
+
+ +CreateCustomPermissions + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/CreateCustomPermissionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/CreateCustomPermissionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/CreateCustomPermissionsCommandOutput/) +
@@ -431,6 +447,30 @@ DeleteAnalysis [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DeleteAnalysisCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteAnalysisCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteAnalysisCommandOutput/) +
+
+ +DeleteBrand + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DeleteBrandCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteBrandCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteBrandCommandOutput/) + +
+
+ +DeleteBrandAssignment + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DeleteBrandAssignmentCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteBrandAssignmentCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteBrandAssignmentCommandOutput/) + +
+
+ +DeleteCustomPermissions + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DeleteCustomPermissionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteCustomPermissionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteCustomPermissionsCommandOutput/) +
@@ -607,6 +647,14 @@ DeleteUserByPrincipalId [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DeleteUserByPrincipalIdCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteUserByPrincipalIdCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteUserByPrincipalIdCommandOutput/) +
+
+ +DeleteUserCustomPermission + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DeleteUserCustomPermissionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteUserCustomPermissionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteUserCustomPermissionCommandOutput/) +
@@ -679,6 +727,38 @@ DescribeAssetBundleImportJob [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DescribeAssetBundleImportJobCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeAssetBundleImportJobCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeAssetBundleImportJobCommandOutput/) +
+
+ +DescribeBrand + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DescribeBrandCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeBrandCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeBrandCommandOutput/) + +
+
+ +DescribeBrandAssignment + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DescribeBrandAssignmentCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeBrandAssignmentCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeBrandAssignmentCommandOutput/) + +
+
+ +DescribeBrandPublishedVersion + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DescribeBrandPublishedVersionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeBrandPublishedVersionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeBrandPublishedVersionCommandOutput/) + +
+
+ +DescribeCustomPermissions + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DescribeCustomPermissionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeCustomPermissionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeCustomPermissionsCommandOutput/) +
@@ -1023,6 +1103,22 @@ ListAssetBundleImportJobs [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/ListAssetBundleImportJobsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/ListAssetBundleImportJobsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/ListAssetBundleImportJobsCommandOutput/) +
+
+ +ListBrands + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/ListBrandsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/ListBrandsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/ListBrandsCommandOutput/) + +
+
+ +ListCustomPermissions + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/ListCustomPermissionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/ListCustomPermissionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/ListCustomPermissionsCommandOutput/) +
@@ -1407,6 +1503,38 @@ UpdateAnalysisPermissions [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateAnalysisPermissionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateAnalysisPermissionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateAnalysisPermissionsCommandOutput/) +
+
+ +UpdateBrand + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateBrandCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateBrandCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateBrandCommandOutput/) + +
+
+ +UpdateBrandAssignment + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateBrandAssignmentCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateBrandAssignmentCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateBrandAssignmentCommandOutput/) + +
+
+ +UpdateBrandPublishedVersion + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateBrandPublishedVersionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateBrandPublishedVersionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateBrandPublishedVersionCommandOutput/) + +
+
+ +UpdateCustomPermissions + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateCustomPermissionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateCustomPermissionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateCustomPermissionsCommandOutput/) +
@@ -1647,6 +1775,14 @@ UpdateUser [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateUserCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateUserCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateUserCommandOutput/) +
+
+ +UpdateUserCustomPermission + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateUserCustomPermissionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateUserCustomPermissionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateUserCustomPermissionCommandOutput/) +
diff --git a/clients/client-quicksight/src/QuickSight.ts b/clients/client-quicksight/src/QuickSight.ts index 861f78a075ff..83d2d326ccf4 100644 --- a/clients/client-quicksight/src/QuickSight.ts +++ b/clients/client-quicksight/src/QuickSight.ts @@ -32,6 +32,12 @@ import { CreateAnalysisCommandInput, CreateAnalysisCommandOutput, } from "./commands/CreateAnalysisCommand"; +import { CreateBrandCommand, CreateBrandCommandInput, CreateBrandCommandOutput } from "./commands/CreateBrandCommand"; +import { + CreateCustomPermissionsCommand, + CreateCustomPermissionsCommandInput, + CreateCustomPermissionsCommandOutput, +} from "./commands/CreateCustomPermissionsCommand"; import { CreateDashboardCommand, CreateDashboardCommandInput, @@ -130,6 +136,17 @@ import { DeleteAnalysisCommandInput, DeleteAnalysisCommandOutput, } from "./commands/DeleteAnalysisCommand"; +import { + DeleteBrandAssignmentCommand, + DeleteBrandAssignmentCommandInput, + DeleteBrandAssignmentCommandOutput, +} from "./commands/DeleteBrandAssignmentCommand"; +import { DeleteBrandCommand, DeleteBrandCommandInput, DeleteBrandCommandOutput } from "./commands/DeleteBrandCommand"; +import { + DeleteCustomPermissionsCommand, + DeleteCustomPermissionsCommandInput, + DeleteCustomPermissionsCommandOutput, +} from "./commands/DeleteCustomPermissionsCommand"; import { DeleteDashboardCommand, DeleteDashboardCommandInput, @@ -224,6 +241,11 @@ import { DeleteUserByPrincipalIdCommandOutput, } from "./commands/DeleteUserByPrincipalIdCommand"; import { DeleteUserCommand, DeleteUserCommandInput, DeleteUserCommandOutput } from "./commands/DeleteUserCommand"; +import { + DeleteUserCustomPermissionCommand, + DeleteUserCustomPermissionCommandInput, + DeleteUserCustomPermissionCommandOutput, +} from "./commands/DeleteUserCustomPermissionCommand"; import { DeleteVPCConnectionCommand, DeleteVPCConnectionCommandInput, @@ -269,6 +291,26 @@ import { DescribeAssetBundleImportJobCommandInput, DescribeAssetBundleImportJobCommandOutput, } from "./commands/DescribeAssetBundleImportJobCommand"; +import { + DescribeBrandAssignmentCommand, + DescribeBrandAssignmentCommandInput, + DescribeBrandAssignmentCommandOutput, +} from "./commands/DescribeBrandAssignmentCommand"; +import { + DescribeBrandCommand, + DescribeBrandCommandInput, + DescribeBrandCommandOutput, +} from "./commands/DescribeBrandCommand"; +import { + DescribeBrandPublishedVersionCommand, + DescribeBrandPublishedVersionCommandInput, + DescribeBrandPublishedVersionCommandOutput, +} from "./commands/DescribeBrandPublishedVersionCommand"; +import { + DescribeCustomPermissionsCommand, + DescribeCustomPermissionsCommandInput, + DescribeCustomPermissionsCommandOutput, +} from "./commands/DescribeCustomPermissionsCommand"; import { DescribeDashboardCommand, DescribeDashboardCommandInput, @@ -484,6 +526,12 @@ import { ListAssetBundleImportJobsCommandInput, ListAssetBundleImportJobsCommandOutput, } from "./commands/ListAssetBundleImportJobsCommand"; +import { ListBrandsCommand, ListBrandsCommandInput, ListBrandsCommandOutput } from "./commands/ListBrandsCommand"; +import { + ListCustomPermissionsCommand, + ListCustomPermissionsCommandInput, + ListCustomPermissionsCommandOutput, +} from "./commands/ListCustomPermissionsCommand"; import { ListDashboardsCommand, ListDashboardsCommandInput, @@ -700,6 +748,22 @@ import { UpdateAnalysisPermissionsCommandInput, UpdateAnalysisPermissionsCommandOutput, } from "./commands/UpdateAnalysisPermissionsCommand"; +import { + UpdateBrandAssignmentCommand, + UpdateBrandAssignmentCommandInput, + UpdateBrandAssignmentCommandOutput, +} from "./commands/UpdateBrandAssignmentCommand"; +import { UpdateBrandCommand, UpdateBrandCommandInput, UpdateBrandCommandOutput } from "./commands/UpdateBrandCommand"; +import { + UpdateBrandPublishedVersionCommand, + UpdateBrandPublishedVersionCommandInput, + UpdateBrandPublishedVersionCommandOutput, +} from "./commands/UpdateBrandPublishedVersionCommand"; +import { + UpdateCustomPermissionsCommand, + UpdateCustomPermissionsCommandInput, + UpdateCustomPermissionsCommandOutput, +} from "./commands/UpdateCustomPermissionsCommand"; import { UpdateDashboardCommand, UpdateDashboardCommandInput, @@ -834,6 +898,11 @@ import { UpdateTopicRefreshScheduleCommandOutput, } from "./commands/UpdateTopicRefreshScheduleCommand"; import { UpdateUserCommand, UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand"; +import { + UpdateUserCustomPermissionCommand, + UpdateUserCustomPermissionCommandInput, + UpdateUserCustomPermissionCommandOutput, +} from "./commands/UpdateUserCustomPermissionCommand"; import { UpdateVPCConnectionCommand, UpdateVPCConnectionCommandInput, @@ -848,6 +917,8 @@ const commands = { CreateAccountCustomizationCommand, CreateAccountSubscriptionCommand, CreateAnalysisCommand, + CreateBrandCommand, + CreateCustomPermissionsCommand, CreateDashboardCommand, CreateDataSetCommand, CreateDataSourceCommand, @@ -870,6 +941,9 @@ const commands = { DeleteAccountCustomizationCommand, DeleteAccountSubscriptionCommand, DeleteAnalysisCommand, + DeleteBrandCommand, + DeleteBrandAssignmentCommand, + DeleteCustomPermissionsCommand, DeleteDashboardCommand, DeleteDataSetCommand, DeleteDataSetRefreshPropertiesCommand, @@ -892,6 +966,7 @@ const commands = { DeleteTopicRefreshScheduleCommand, DeleteUserCommand, DeleteUserByPrincipalIdCommand, + DeleteUserCustomPermissionCommand, DeleteVPCConnectionCommand, DescribeAccountCustomizationCommand, DescribeAccountSettingsCommand, @@ -901,6 +976,10 @@ const commands = { DescribeAnalysisPermissionsCommand, DescribeAssetBundleExportJobCommand, DescribeAssetBundleImportJobCommand, + DescribeBrandCommand, + DescribeBrandAssignmentCommand, + DescribeBrandPublishedVersionCommand, + DescribeCustomPermissionsCommand, DescribeDashboardCommand, DescribeDashboardDefinitionCommand, DescribeDashboardPermissionsCommand, @@ -944,6 +1023,8 @@ const commands = { ListAnalysesCommand, ListAssetBundleExportJobsCommand, ListAssetBundleImportJobsCommand, + ListBrandsCommand, + ListCustomPermissionsCommand, ListDashboardsCommand, ListDashboardVersionsCommand, ListDataSetsCommand, @@ -992,6 +1073,10 @@ const commands = { UpdateAccountSettingsCommand, UpdateAnalysisCommand, UpdateAnalysisPermissionsCommand, + UpdateBrandCommand, + UpdateBrandAssignmentCommand, + UpdateBrandPublishedVersionCommand, + UpdateCustomPermissionsCommand, UpdateDashboardCommand, UpdateDashboardLinksCommand, UpdateDashboardPermissionsCommand, @@ -1022,6 +1107,7 @@ const commands = { UpdateTopicPermissionsCommand, UpdateTopicRefreshScheduleCommand, UpdateUserCommand, + UpdateUserCustomPermissionCommand, UpdateVPCConnectionCommand, }; @@ -1122,6 +1208,34 @@ export interface QuickSight { cb: (err: any, data?: CreateAnalysisCommandOutput) => void ): void; + /** + * @see {@link CreateBrandCommand} + */ + createBrand(args: CreateBrandCommandInput, options?: __HttpHandlerOptions): Promise; + createBrand(args: CreateBrandCommandInput, cb: (err: any, data?: CreateBrandCommandOutput) => void): void; + createBrand( + args: CreateBrandCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: CreateBrandCommandOutput) => void + ): void; + + /** + * @see {@link CreateCustomPermissionsCommand} + */ + createCustomPermissions( + args: CreateCustomPermissionsCommandInput, + options?: __HttpHandlerOptions + ): Promise; + createCustomPermissions( + args: CreateCustomPermissionsCommandInput, + cb: (err: any, data?: CreateCustomPermissionsCommandOutput) => void + ): void; + createCustomPermissions( + args: CreateCustomPermissionsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: CreateCustomPermissionsCommandOutput) => void + ): void; + /** * @see {@link CreateDashboardCommand} */ @@ -1451,6 +1565,51 @@ export interface QuickSight { cb: (err: any, data?: DeleteAnalysisCommandOutput) => void ): void; + /** + * @see {@link DeleteBrandCommand} + */ + deleteBrand(args: DeleteBrandCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBrand(args: DeleteBrandCommandInput, cb: (err: any, data?: DeleteBrandCommandOutput) => void): void; + deleteBrand( + args: DeleteBrandCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DeleteBrandCommandOutput) => void + ): void; + + /** + * @see {@link DeleteBrandAssignmentCommand} + */ + deleteBrandAssignment( + args: DeleteBrandAssignmentCommandInput, + options?: __HttpHandlerOptions + ): Promise; + deleteBrandAssignment( + args: DeleteBrandAssignmentCommandInput, + cb: (err: any, data?: DeleteBrandAssignmentCommandOutput) => void + ): void; + deleteBrandAssignment( + args: DeleteBrandAssignmentCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DeleteBrandAssignmentCommandOutput) => void + ): void; + + /** + * @see {@link DeleteCustomPermissionsCommand} + */ + deleteCustomPermissions( + args: DeleteCustomPermissionsCommandInput, + options?: __HttpHandlerOptions + ): Promise; + deleteCustomPermissions( + args: DeleteCustomPermissionsCommandInput, + cb: (err: any, data?: DeleteCustomPermissionsCommandOutput) => void + ): void; + deleteCustomPermissions( + args: DeleteCustomPermissionsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DeleteCustomPermissionsCommandOutput) => void + ): void; + /** * @see {@link DeleteDashboardCommand} */ @@ -1780,6 +1939,23 @@ export interface QuickSight { cb: (err: any, data?: DeleteUserByPrincipalIdCommandOutput) => void ): void; + /** + * @see {@link DeleteUserCustomPermissionCommand} + */ + deleteUserCustomPermission( + args: DeleteUserCustomPermissionCommandInput, + options?: __HttpHandlerOptions + ): Promise; + deleteUserCustomPermission( + args: DeleteUserCustomPermissionCommandInput, + cb: (err: any, data?: DeleteUserCustomPermissionCommandOutput) => void + ): void; + deleteUserCustomPermission( + args: DeleteUserCustomPermissionCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DeleteUserCustomPermissionCommandOutput) => void + ): void; + /** * @see {@link DeleteVPCConnectionCommand} */ @@ -1933,6 +2109,68 @@ export interface QuickSight { cb: (err: any, data?: DescribeAssetBundleImportJobCommandOutput) => void ): void; + /** + * @see {@link DescribeBrandCommand} + */ + describeBrand(args: DescribeBrandCommandInput, options?: __HttpHandlerOptions): Promise; + describeBrand(args: DescribeBrandCommandInput, cb: (err: any, data?: DescribeBrandCommandOutput) => void): void; + describeBrand( + args: DescribeBrandCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DescribeBrandCommandOutput) => void + ): void; + + /** + * @see {@link DescribeBrandAssignmentCommand} + */ + describeBrandAssignment( + args: DescribeBrandAssignmentCommandInput, + options?: __HttpHandlerOptions + ): Promise; + describeBrandAssignment( + args: DescribeBrandAssignmentCommandInput, + cb: (err: any, data?: DescribeBrandAssignmentCommandOutput) => void + ): void; + describeBrandAssignment( + args: DescribeBrandAssignmentCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DescribeBrandAssignmentCommandOutput) => void + ): void; + + /** + * @see {@link DescribeBrandPublishedVersionCommand} + */ + describeBrandPublishedVersion( + args: DescribeBrandPublishedVersionCommandInput, + options?: __HttpHandlerOptions + ): Promise; + describeBrandPublishedVersion( + args: DescribeBrandPublishedVersionCommandInput, + cb: (err: any, data?: DescribeBrandPublishedVersionCommandOutput) => void + ): void; + describeBrandPublishedVersion( + args: DescribeBrandPublishedVersionCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DescribeBrandPublishedVersionCommandOutput) => void + ): void; + + /** + * @see {@link DescribeCustomPermissionsCommand} + */ + describeCustomPermissions( + args: DescribeCustomPermissionsCommandInput, + options?: __HttpHandlerOptions + ): Promise; + describeCustomPermissions( + args: DescribeCustomPermissionsCommandInput, + cb: (err: any, data?: DescribeCustomPermissionsCommandOutput) => void + ): void; + describeCustomPermissions( + args: DescribeCustomPermissionsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DescribeCustomPermissionsCommandOutput) => void + ): void; + /** * @see {@link DescribeDashboardCommand} */ @@ -2628,6 +2866,34 @@ export interface QuickSight { cb: (err: any, data?: ListAssetBundleImportJobsCommandOutput) => void ): void; + /** + * @see {@link ListBrandsCommand} + */ + listBrands(args: ListBrandsCommandInput, options?: __HttpHandlerOptions): Promise; + listBrands(args: ListBrandsCommandInput, cb: (err: any, data?: ListBrandsCommandOutput) => void): void; + listBrands( + args: ListBrandsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListBrandsCommandOutput) => void + ): void; + + /** + * @see {@link ListCustomPermissionsCommand} + */ + listCustomPermissions( + args: ListCustomPermissionsCommandInput, + options?: __HttpHandlerOptions + ): Promise; + listCustomPermissions( + args: ListCustomPermissionsCommandInput, + cb: (err: any, data?: ListCustomPermissionsCommandOutput) => void + ): void; + listCustomPermissions( + args: ListCustomPermissionsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListCustomPermissionsCommandOutput) => void + ): void; + /** * @see {@link ListDashboardsCommand} */ @@ -3345,6 +3611,68 @@ export interface QuickSight { cb: (err: any, data?: UpdateAnalysisPermissionsCommandOutput) => void ): void; + /** + * @see {@link UpdateBrandCommand} + */ + updateBrand(args: UpdateBrandCommandInput, options?: __HttpHandlerOptions): Promise; + updateBrand(args: UpdateBrandCommandInput, cb: (err: any, data?: UpdateBrandCommandOutput) => void): void; + updateBrand( + args: UpdateBrandCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: UpdateBrandCommandOutput) => void + ): void; + + /** + * @see {@link UpdateBrandAssignmentCommand} + */ + updateBrandAssignment( + args: UpdateBrandAssignmentCommandInput, + options?: __HttpHandlerOptions + ): Promise; + updateBrandAssignment( + args: UpdateBrandAssignmentCommandInput, + cb: (err: any, data?: UpdateBrandAssignmentCommandOutput) => void + ): void; + updateBrandAssignment( + args: UpdateBrandAssignmentCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: UpdateBrandAssignmentCommandOutput) => void + ): void; + + /** + * @see {@link UpdateBrandPublishedVersionCommand} + */ + updateBrandPublishedVersion( + args: UpdateBrandPublishedVersionCommandInput, + options?: __HttpHandlerOptions + ): Promise; + updateBrandPublishedVersion( + args: UpdateBrandPublishedVersionCommandInput, + cb: (err: any, data?: UpdateBrandPublishedVersionCommandOutput) => void + ): void; + updateBrandPublishedVersion( + args: UpdateBrandPublishedVersionCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: UpdateBrandPublishedVersionCommandOutput) => void + ): void; + + /** + * @see {@link UpdateCustomPermissionsCommand} + */ + updateCustomPermissions( + args: UpdateCustomPermissionsCommandInput, + options?: __HttpHandlerOptions + ): Promise; + updateCustomPermissions( + args: UpdateCustomPermissionsCommandInput, + cb: (err: any, data?: UpdateCustomPermissionsCommandOutput) => void + ): void; + updateCustomPermissions( + args: UpdateCustomPermissionsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: UpdateCustomPermissionsCommandOutput) => void + ): void; + /** * @see {@link UpdateDashboardCommand} */ @@ -3813,6 +4141,23 @@ export interface QuickSight { cb: (err: any, data?: UpdateUserCommandOutput) => void ): void; + /** + * @see {@link UpdateUserCustomPermissionCommand} + */ + updateUserCustomPermission( + args: UpdateUserCustomPermissionCommandInput, + options?: __HttpHandlerOptions + ): Promise; + updateUserCustomPermission( + args: UpdateUserCustomPermissionCommandInput, + cb: (err: any, data?: UpdateUserCustomPermissionCommandOutput) => void + ): void; + updateUserCustomPermission( + args: UpdateUserCustomPermissionCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: UpdateUserCustomPermissionCommandOutput) => void + ): void; + /** * @see {@link UpdateVPCConnectionCommand} */ diff --git a/clients/client-quicksight/src/QuickSightClient.ts b/clients/client-quicksight/src/QuickSightClient.ts index cb26235be8bf..e38f9552c33c 100644 --- a/clients/client-quicksight/src/QuickSightClient.ts +++ b/clients/client-quicksight/src/QuickSightClient.ts @@ -71,6 +71,11 @@ import { CreateAccountSubscriptionCommandOutput, } from "./commands/CreateAccountSubscriptionCommand"; import { CreateAnalysisCommandInput, CreateAnalysisCommandOutput } from "./commands/CreateAnalysisCommand"; +import { CreateBrandCommandInput, CreateBrandCommandOutput } from "./commands/CreateBrandCommand"; +import { + CreateCustomPermissionsCommandInput, + CreateCustomPermissionsCommandOutput, +} from "./commands/CreateCustomPermissionsCommand"; import { CreateDashboardCommandInput, CreateDashboardCommandOutput } from "./commands/CreateDashboardCommand"; import { CreateDataSetCommandInput, CreateDataSetCommandOutput } from "./commands/CreateDataSetCommand"; import { CreateDataSourceCommandInput, CreateDataSourceCommandOutput } from "./commands/CreateDataSourceCommand"; @@ -123,6 +128,15 @@ import { DeleteAccountSubscriptionCommandOutput, } from "./commands/DeleteAccountSubscriptionCommand"; import { DeleteAnalysisCommandInput, DeleteAnalysisCommandOutput } from "./commands/DeleteAnalysisCommand"; +import { + DeleteBrandAssignmentCommandInput, + DeleteBrandAssignmentCommandOutput, +} from "./commands/DeleteBrandAssignmentCommand"; +import { DeleteBrandCommandInput, DeleteBrandCommandOutput } from "./commands/DeleteBrandCommand"; +import { + DeleteCustomPermissionsCommandInput, + DeleteCustomPermissionsCommandOutput, +} from "./commands/DeleteCustomPermissionsCommand"; import { DeleteDashboardCommandInput, DeleteDashboardCommandOutput } from "./commands/DeleteDashboardCommand"; import { DeleteDataSetCommandInput, DeleteDataSetCommandOutput } from "./commands/DeleteDataSetCommand"; import { @@ -178,6 +192,10 @@ import { DeleteUserByPrincipalIdCommandOutput, } from "./commands/DeleteUserByPrincipalIdCommand"; import { DeleteUserCommandInput, DeleteUserCommandOutput } from "./commands/DeleteUserCommand"; +import { + DeleteUserCustomPermissionCommandInput, + DeleteUserCustomPermissionCommandOutput, +} from "./commands/DeleteUserCustomPermissionCommand"; import { DeleteVPCConnectionCommandInput, DeleteVPCConnectionCommandOutput, @@ -211,6 +229,19 @@ import { DescribeAssetBundleImportJobCommandInput, DescribeAssetBundleImportJobCommandOutput, } from "./commands/DescribeAssetBundleImportJobCommand"; +import { + DescribeBrandAssignmentCommandInput, + DescribeBrandAssignmentCommandOutput, +} from "./commands/DescribeBrandAssignmentCommand"; +import { DescribeBrandCommandInput, DescribeBrandCommandOutput } from "./commands/DescribeBrandCommand"; +import { + DescribeBrandPublishedVersionCommandInput, + DescribeBrandPublishedVersionCommandOutput, +} from "./commands/DescribeBrandPublishedVersionCommand"; +import { + DescribeCustomPermissionsCommandInput, + DescribeCustomPermissionsCommandOutput, +} from "./commands/DescribeCustomPermissionsCommand"; import { DescribeDashboardCommandInput, DescribeDashboardCommandOutput } from "./commands/DescribeDashboardCommand"; import { DescribeDashboardDefinitionCommandInput, @@ -341,6 +372,11 @@ import { ListAssetBundleImportJobsCommandInput, ListAssetBundleImportJobsCommandOutput, } from "./commands/ListAssetBundleImportJobsCommand"; +import { ListBrandsCommandInput, ListBrandsCommandOutput } from "./commands/ListBrandsCommand"; +import { + ListCustomPermissionsCommandInput, + ListCustomPermissionsCommandOutput, +} from "./commands/ListCustomPermissionsCommand"; import { ListDashboardsCommandInput, ListDashboardsCommandOutput } from "./commands/ListDashboardsCommand"; import { ListDashboardVersionsCommandInput, @@ -452,6 +488,19 @@ import { UpdateAnalysisPermissionsCommandInput, UpdateAnalysisPermissionsCommandOutput, } from "./commands/UpdateAnalysisPermissionsCommand"; +import { + UpdateBrandAssignmentCommandInput, + UpdateBrandAssignmentCommandOutput, +} from "./commands/UpdateBrandAssignmentCommand"; +import { UpdateBrandCommandInput, UpdateBrandCommandOutput } from "./commands/UpdateBrandCommand"; +import { + UpdateBrandPublishedVersionCommandInput, + UpdateBrandPublishedVersionCommandOutput, +} from "./commands/UpdateBrandPublishedVersionCommand"; +import { + UpdateCustomPermissionsCommandInput, + UpdateCustomPermissionsCommandOutput, +} from "./commands/UpdateCustomPermissionsCommand"; import { UpdateDashboardCommandInput, UpdateDashboardCommandOutput } from "./commands/UpdateDashboardCommand"; import { UpdateDashboardLinksCommandInput, @@ -542,6 +591,10 @@ import { UpdateTopicRefreshScheduleCommandOutput, } from "./commands/UpdateTopicRefreshScheduleCommand"; import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand"; +import { + UpdateUserCustomPermissionCommandInput, + UpdateUserCustomPermissionCommandOutput, +} from "./commands/UpdateUserCustomPermissionCommand"; import { UpdateVPCConnectionCommandInput, UpdateVPCConnectionCommandOutput, @@ -567,6 +620,8 @@ export type ServiceInputTypes = | CreateAccountCustomizationCommandInput | CreateAccountSubscriptionCommandInput | CreateAnalysisCommandInput + | CreateBrandCommandInput + | CreateCustomPermissionsCommandInput | CreateDashboardCommandInput | CreateDataSetCommandInput | CreateDataSourceCommandInput @@ -589,6 +644,9 @@ export type ServiceInputTypes = | DeleteAccountCustomizationCommandInput | DeleteAccountSubscriptionCommandInput | DeleteAnalysisCommandInput + | DeleteBrandAssignmentCommandInput + | DeleteBrandCommandInput + | DeleteCustomPermissionsCommandInput | DeleteDashboardCommandInput | DeleteDataSetCommandInput | DeleteDataSetRefreshPropertiesCommandInput @@ -611,6 +669,7 @@ export type ServiceInputTypes = | DeleteTopicRefreshScheduleCommandInput | DeleteUserByPrincipalIdCommandInput | DeleteUserCommandInput + | DeleteUserCustomPermissionCommandInput | DeleteVPCConnectionCommandInput | DescribeAccountCustomizationCommandInput | DescribeAccountSettingsCommandInput @@ -620,6 +679,10 @@ export type ServiceInputTypes = | DescribeAnalysisPermissionsCommandInput | DescribeAssetBundleExportJobCommandInput | DescribeAssetBundleImportJobCommandInput + | DescribeBrandAssignmentCommandInput + | DescribeBrandCommandInput + | DescribeBrandPublishedVersionCommandInput + | DescribeCustomPermissionsCommandInput | DescribeDashboardCommandInput | DescribeDashboardDefinitionCommandInput | DescribeDashboardPermissionsCommandInput @@ -663,6 +726,8 @@ export type ServiceInputTypes = | ListAnalysesCommandInput | ListAssetBundleExportJobsCommandInput | ListAssetBundleImportJobsCommandInput + | ListBrandsCommandInput + | ListCustomPermissionsCommandInput | ListDashboardVersionsCommandInput | ListDashboardsCommandInput | ListDataSetsCommandInput @@ -711,6 +776,10 @@ export type ServiceInputTypes = | UpdateAccountSettingsCommandInput | UpdateAnalysisCommandInput | UpdateAnalysisPermissionsCommandInput + | UpdateBrandAssignmentCommandInput + | UpdateBrandCommandInput + | UpdateBrandPublishedVersionCommandInput + | UpdateCustomPermissionsCommandInput | UpdateDashboardCommandInput | UpdateDashboardLinksCommandInput | UpdateDashboardPermissionsCommandInput @@ -741,6 +810,7 @@ export type ServiceInputTypes = | UpdateTopicPermissionsCommandInput | UpdateTopicRefreshScheduleCommandInput | UpdateUserCommandInput + | UpdateUserCustomPermissionCommandInput | UpdateVPCConnectionCommandInput; /** @@ -753,6 +823,8 @@ export type ServiceOutputTypes = | CreateAccountCustomizationCommandOutput | CreateAccountSubscriptionCommandOutput | CreateAnalysisCommandOutput + | CreateBrandCommandOutput + | CreateCustomPermissionsCommandOutput | CreateDashboardCommandOutput | CreateDataSetCommandOutput | CreateDataSourceCommandOutput @@ -775,6 +847,9 @@ export type ServiceOutputTypes = | DeleteAccountCustomizationCommandOutput | DeleteAccountSubscriptionCommandOutput | DeleteAnalysisCommandOutput + | DeleteBrandAssignmentCommandOutput + | DeleteBrandCommandOutput + | DeleteCustomPermissionsCommandOutput | DeleteDashboardCommandOutput | DeleteDataSetCommandOutput | DeleteDataSetRefreshPropertiesCommandOutput @@ -797,6 +872,7 @@ export type ServiceOutputTypes = | DeleteTopicRefreshScheduleCommandOutput | DeleteUserByPrincipalIdCommandOutput | DeleteUserCommandOutput + | DeleteUserCustomPermissionCommandOutput | DeleteVPCConnectionCommandOutput | DescribeAccountCustomizationCommandOutput | DescribeAccountSettingsCommandOutput @@ -806,6 +882,10 @@ export type ServiceOutputTypes = | DescribeAnalysisPermissionsCommandOutput | DescribeAssetBundleExportJobCommandOutput | DescribeAssetBundleImportJobCommandOutput + | DescribeBrandAssignmentCommandOutput + | DescribeBrandCommandOutput + | DescribeBrandPublishedVersionCommandOutput + | DescribeCustomPermissionsCommandOutput | DescribeDashboardCommandOutput | DescribeDashboardDefinitionCommandOutput | DescribeDashboardPermissionsCommandOutput @@ -849,6 +929,8 @@ export type ServiceOutputTypes = | ListAnalysesCommandOutput | ListAssetBundleExportJobsCommandOutput | ListAssetBundleImportJobsCommandOutput + | ListBrandsCommandOutput + | ListCustomPermissionsCommandOutput | ListDashboardVersionsCommandOutput | ListDashboardsCommandOutput | ListDataSetsCommandOutput @@ -897,6 +979,10 @@ export type ServiceOutputTypes = | UpdateAccountSettingsCommandOutput | UpdateAnalysisCommandOutput | UpdateAnalysisPermissionsCommandOutput + | UpdateBrandAssignmentCommandOutput + | UpdateBrandCommandOutput + | UpdateBrandPublishedVersionCommandOutput + | UpdateCustomPermissionsCommandOutput | UpdateDashboardCommandOutput | UpdateDashboardLinksCommandOutput | UpdateDashboardPermissionsCommandOutput @@ -927,6 +1013,7 @@ export type ServiceOutputTypes = | UpdateTopicPermissionsCommandOutput | UpdateTopicRefreshScheduleCommandOutput | UpdateUserCommandOutput + | UpdateUserCustomPermissionCommandOutput | UpdateVPCConnectionCommandOutput; /** diff --git a/clients/client-quicksight/src/commands/CreateBrandCommand.ts b/clients/client-quicksight/src/commands/CreateBrandCommand.ts new file mode 100644 index 000000000000..6a4a373e968a --- /dev/null +++ b/clients/client-quicksight/src/commands/CreateBrandCommand.ts @@ -0,0 +1,289 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { CreateBrandRequest, CreateBrandResponse } from "../models/models_2"; +import { de_CreateBrandCommand, se_CreateBrandCommand } from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateBrandCommand}. + */ +export interface CreateBrandCommandInput extends CreateBrandRequest {} +/** + * @public + * + * The output of {@link CreateBrandCommand}. + */ +export interface CreateBrandCommandOutput extends CreateBrandResponse, __MetadataBearer {} + +/** + *

Creates an Amazon QuickSight brand.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CreateBrandCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CreateBrandCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // CreateBrandRequest + * AwsAccountId: "STRING_VALUE", // required + * BrandId: "STRING_VALUE", // required + * BrandDefinition: { // BrandDefinition + * BrandName: "STRING_VALUE", // required + * Description: "STRING_VALUE", + * ApplicationTheme: { // ApplicationTheme + * BrandColorPalette: { // BrandColorPalette + * Primary: { // Palette + * Foreground: "STRING_VALUE", + * Background: "STRING_VALUE", + * }, + * Secondary: { + * Foreground: "STRING_VALUE", + * Background: "STRING_VALUE", + * }, + * Accent: { + * Foreground: "STRING_VALUE", + * Background: "STRING_VALUE", + * }, + * Measure: { + * Foreground: "STRING_VALUE", + * Background: "STRING_VALUE", + * }, + * Dimension: { + * Foreground: "STRING_VALUE", + * Background: "STRING_VALUE", + * }, + * Success: "", + * Info: "", + * Warning: "", + * Danger: "", + * }, + * BrandElementStyle: { // BrandElementStyle + * NavbarStyle: { // NavbarStyle + * GlobalNavbar: "", + * ContextualNavbar: "", + * }, + * }, + * }, + * LogoConfiguration: { // LogoConfiguration + * AltText: "STRING_VALUE", // required + * LogoSet: { // LogoSetConfiguration + * Primary: { // ImageSetConfiguration + * Original: { // ImageConfiguration + * Source: { // ImageSource Union: only one key present + * PublicUrl: "STRING_VALUE", + * S3Uri: "STRING_VALUE", + * }, + * }, + * }, + * Favicon: { + * Original: { + * Source: {// Union: only one key present + * PublicUrl: "STRING_VALUE", + * S3Uri: "STRING_VALUE", + * }, + * }, + * }, + * }, + * }, + * }, + * Tags: [ // TagList + * { // Tag + * Key: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new CreateBrandCommand(input); + * const response = await client.send(command); + * // { // CreateBrandResponse + * // RequestId: "STRING_VALUE", + * // BrandDetail: { // BrandDetail + * // BrandId: "STRING_VALUE", // required + * // Arn: "STRING_VALUE", + * // BrandStatus: "CREATE_IN_PROGRESS" || "CREATE_SUCCEEDED" || "CREATE_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_FAILED", + * // CreatedTime: new Date("TIMESTAMP"), + * // LastUpdatedTime: new Date("TIMESTAMP"), + * // VersionId: "STRING_VALUE", + * // VersionStatus: "CREATE_IN_PROGRESS" || "CREATE_SUCCEEDED" || "CREATE_FAILED", + * // Errors: [ // ErrorList + * // "STRING_VALUE", + * // ], + * // Logo: { // Logo + * // AltText: "STRING_VALUE", // required + * // LogoSet: { // LogoSet + * // Primary: { // ImageSet + * // Original: { // Image + * // Source: { // ImageSource Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // Height64: { + * // Source: {// Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // Height32: { + * // Source: {// Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // }, + * // Favicon: { + * // Original: { + * // Source: {// Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // Height64: { + * // Source: {// Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // Height32: "", + * // }, + * // }, + * // }, + * // }, + * // BrandDefinition: { // BrandDefinition + * // BrandName: "STRING_VALUE", // required + * // Description: "STRING_VALUE", + * // ApplicationTheme: { // ApplicationTheme + * // BrandColorPalette: { // BrandColorPalette + * // Primary: { // Palette + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Secondary: { + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Accent: { + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Measure: { + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Dimension: { + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Success: "", + * // Info: "", + * // Warning: "", + * // Danger: "", + * // }, + * // BrandElementStyle: { // BrandElementStyle + * // NavbarStyle: { // NavbarStyle + * // GlobalNavbar: "", + * // ContextualNavbar: "", + * // }, + * // }, + * // }, + * // LogoConfiguration: { // LogoConfiguration + * // AltText: "STRING_VALUE", // required + * // LogoSet: { // LogoSetConfiguration + * // Primary: { // ImageSetConfiguration + * // Original: { // ImageConfiguration + * // Source: "", + * // }, + * // }, + * // Favicon: { + * // Original: { + * // Source: "", + * // }, + * // }, + * // }, + * // }, + * // }, + * // }; + * + * ``` + * + * @param CreateBrandCommandInput - {@link CreateBrandCommandInput} + * @returns {@link CreateBrandCommandOutput} + * @see {@link CreateBrandCommandInput} for command's `input` shape. + * @see {@link CreateBrandCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.

+ * + * @throws {@link ConflictException} (client fault) + *

Updating or deleting a resource can cause an inconsistent state.

+ * + * @throws {@link InternalServerException} (server fault) + *

An internal service exception.

+ * + * @throws {@link InvalidRequestException} (client fault) + *

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

+ * + * @throws {@link LimitExceededException} (client fault) + *

A limit is exceeded.

+ * + * @throws {@link ThrottlingException} (client fault) + *

Access is throttled.

+ * + * @throws {@link QuickSightServiceException} + *

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class CreateBrandCommand extends $Command + .classBuilder< + CreateBrandCommandInput, + CreateBrandCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "CreateBrand", {}) + .n("QuickSightClient", "CreateBrandCommand") + .f(void 0, void 0) + .ser(se_CreateBrandCommand) + .de(de_CreateBrandCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateBrandRequest; + output: CreateBrandResponse; + }; + sdk: { + input: CreateBrandCommandInput; + output: CreateBrandCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/CreateCustomPermissionsCommand.ts b/clients/client-quicksight/src/commands/CreateCustomPermissionsCommand.ts new file mode 100644 index 000000000000..3ec166bcd2e9 --- /dev/null +++ b/clients/client-quicksight/src/commands/CreateCustomPermissionsCommand.ts @@ -0,0 +1,153 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { CreateCustomPermissionsRequest, CreateCustomPermissionsResponse } from "../models/models_2"; +import { de_CreateCustomPermissionsCommand, se_CreateCustomPermissionsCommand } from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateCustomPermissionsCommand}. + */ +export interface CreateCustomPermissionsCommandInput extends CreateCustomPermissionsRequest {} +/** + * @public + * + * The output of {@link CreateCustomPermissionsCommand}. + */ +export interface CreateCustomPermissionsCommandOutput extends CreateCustomPermissionsResponse, __MetadataBearer {} + +/** + *

Creates a custom permissions profile.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CreateCustomPermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CreateCustomPermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // CreateCustomPermissionsRequest + * AwsAccountId: "STRING_VALUE", // required + * CustomPermissionsName: "STRING_VALUE", // required + * Capabilities: { // Capabilities + * ExportToCsv: "DENY", + * ExportToExcel: "DENY", + * CreateAndUpdateThemes: "DENY", + * AddOrRunAnomalyDetectionForAnalyses: "DENY", + * ShareAnalyses: "DENY", + * CreateAndUpdateDatasets: "DENY", + * ShareDatasets: "DENY", + * SubscribeDashboardEmailReports: "DENY", + * CreateAndUpdateDashboardEmailReports: "DENY", + * ShareDashboards: "DENY", + * CreateAndUpdateThresholdAlerts: "DENY", + * RenameSharedFolders: "DENY", + * CreateSharedFolders: "DENY", + * CreateAndUpdateDataSources: "DENY", + * ShareDataSources: "DENY", + * ViewAccountSPICECapacity: "DENY", + * CreateSPICEDataset: "DENY", + * }, + * Tags: [ // TagList + * { // Tag + * Key: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new CreateCustomPermissionsCommand(input); + * const response = await client.send(command); + * // { // CreateCustomPermissionsResponse + * // Status: Number("int"), + * // Arn: "STRING_VALUE", + * // RequestId: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CreateCustomPermissionsCommandInput - {@link CreateCustomPermissionsCommandInput} + * @returns {@link CreateCustomPermissionsCommandOutput} + * @see {@link CreateCustomPermissionsCommandInput} for command's `input` shape. + * @see {@link CreateCustomPermissionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.

+ * + * @throws {@link ConflictException} (client fault) + *

Updating or deleting a resource can cause an inconsistent state.

+ * + * @throws {@link InternalFailureException} (server fault) + *

An internal failure occurred.

+ * + * @throws {@link InvalidParameterValueException} (client fault) + *

One or more parameters has a value that isn't valid.

+ * + * @throws {@link LimitExceededException} (client fault) + *

A limit is exceeded.

+ * + * @throws {@link PreconditionNotMetException} (client fault) + *

One or more preconditions aren't met.

+ * + * @throws {@link ResourceExistsException} (client fault) + *

The resource specified already exists.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

One or more resources can't be found.

+ * + * @throws {@link ResourceUnavailableException} (server fault) + *

This resource is currently unavailable.

+ * + * @throws {@link ThrottlingException} (client fault) + *

Access is throttled.

+ * + * @throws {@link QuickSightServiceException} + *

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class CreateCustomPermissionsCommand extends $Command + .classBuilder< + CreateCustomPermissionsCommandInput, + CreateCustomPermissionsCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "CreateCustomPermissions", {}) + .n("QuickSightClient", "CreateCustomPermissionsCommand") + .f(void 0, void 0) + .ser(se_CreateCustomPermissionsCommand) + .de(de_CreateCustomPermissionsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateCustomPermissionsRequest; + output: CreateCustomPermissionsResponse; + }; + sdk: { + input: CreateCustomPermissionsCommandInput; + output: CreateCustomPermissionsCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/DeleteBrandAssignmentCommand.ts b/clients/client-quicksight/src/commands/DeleteBrandAssignmentCommand.ts new file mode 100644 index 000000000000..77388c2268f8 --- /dev/null +++ b/clients/client-quicksight/src/commands/DeleteBrandAssignmentCommand.ts @@ -0,0 +1,113 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteBrandAssignmentRequest, DeleteBrandAssignmentResponse } from "../models/models_3"; +import { de_DeleteBrandAssignmentCommand, se_DeleteBrandAssignmentCommand } from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteBrandAssignmentCommand}. + */ +export interface DeleteBrandAssignmentCommandInput extends DeleteBrandAssignmentRequest {} +/** + * @public + * + * The output of {@link DeleteBrandAssignmentCommand}. + */ +export interface DeleteBrandAssignmentCommandOutput extends DeleteBrandAssignmentResponse, __MetadataBearer {} + +/** + *

Deletes a brand assignment.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteBrandAssignmentCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteBrandAssignmentCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // DeleteBrandAssignmentRequest + * AwsAccountId: "STRING_VALUE", // required + * }; + * const command = new DeleteBrandAssignmentCommand(input); + * const response = await client.send(command); + * // { // DeleteBrandAssignmentResponse + * // RequestId: "STRING_VALUE", + * // }; + * + * ``` + * + * @param DeleteBrandAssignmentCommandInput - {@link DeleteBrandAssignmentCommandInput} + * @returns {@link DeleteBrandAssignmentCommandOutput} + * @see {@link DeleteBrandAssignmentCommandInput} for command's `input` shape. + * @see {@link DeleteBrandAssignmentCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.

+ * + * @throws {@link ConflictException} (client fault) + *

Updating or deleting a resource can cause an inconsistent state.

+ * + * @throws {@link InternalServerException} (server fault) + *

An internal service exception.

+ * + * @throws {@link InvalidRequestException} (client fault) + *

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

One or more resources can't be found.

+ * + * @throws {@link ThrottlingException} (client fault) + *

Access is throttled.

+ * + * @throws {@link QuickSightServiceException} + *

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class DeleteBrandAssignmentCommand extends $Command + .classBuilder< + DeleteBrandAssignmentCommandInput, + DeleteBrandAssignmentCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "DeleteBrandAssignment", {}) + .n("QuickSightClient", "DeleteBrandAssignmentCommand") + .f(void 0, void 0) + .ser(se_DeleteBrandAssignmentCommand) + .de(de_DeleteBrandAssignmentCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteBrandAssignmentRequest; + output: DeleteBrandAssignmentResponse; + }; + sdk: { + input: DeleteBrandAssignmentCommandInput; + output: DeleteBrandAssignmentCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/DeleteBrandCommand.ts b/clients/client-quicksight/src/commands/DeleteBrandCommand.ts new file mode 100644 index 000000000000..474bb39eab90 --- /dev/null +++ b/clients/client-quicksight/src/commands/DeleteBrandCommand.ts @@ -0,0 +1,114 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteBrandRequest, DeleteBrandResponse } from "../models/models_3"; +import { de_DeleteBrandCommand, se_DeleteBrandCommand } from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteBrandCommand}. + */ +export interface DeleteBrandCommandInput extends DeleteBrandRequest {} +/** + * @public + * + * The output of {@link DeleteBrandCommand}. + */ +export interface DeleteBrandCommandOutput extends DeleteBrandResponse, __MetadataBearer {} + +/** + *

Deletes an Amazon QuickSight brand.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteBrandCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteBrandCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // DeleteBrandRequest + * AwsAccountId: "STRING_VALUE", // required + * BrandId: "STRING_VALUE", // required + * }; + * const command = new DeleteBrandCommand(input); + * const response = await client.send(command); + * // { // DeleteBrandResponse + * // RequestId: "STRING_VALUE", + * // }; + * + * ``` + * + * @param DeleteBrandCommandInput - {@link DeleteBrandCommandInput} + * @returns {@link DeleteBrandCommandOutput} + * @see {@link DeleteBrandCommandInput} for command's `input` shape. + * @see {@link DeleteBrandCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.

+ * + * @throws {@link ConflictException} (client fault) + *

Updating or deleting a resource can cause an inconsistent state.

+ * + * @throws {@link InternalServerException} (server fault) + *

An internal service exception.

+ * + * @throws {@link InvalidRequestException} (client fault) + *

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

One or more resources can't be found.

+ * + * @throws {@link ThrottlingException} (client fault) + *

Access is throttled.

+ * + * @throws {@link QuickSightServiceException} + *

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class DeleteBrandCommand extends $Command + .classBuilder< + DeleteBrandCommandInput, + DeleteBrandCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "DeleteBrand", {}) + .n("QuickSightClient", "DeleteBrandCommand") + .f(void 0, void 0) + .ser(se_DeleteBrandCommand) + .de(de_DeleteBrandCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteBrandRequest; + output: DeleteBrandResponse; + }; + sdk: { + input: DeleteBrandCommandInput; + output: DeleteBrandCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/DeleteCustomPermissionsCommand.ts b/clients/client-quicksight/src/commands/DeleteCustomPermissionsCommand.ts new file mode 100644 index 000000000000..c41cbf0d3109 --- /dev/null +++ b/clients/client-quicksight/src/commands/DeleteCustomPermissionsCommand.ts @@ -0,0 +1,125 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteCustomPermissionsRequest, DeleteCustomPermissionsResponse } from "../models/models_3"; +import { de_DeleteCustomPermissionsCommand, se_DeleteCustomPermissionsCommand } from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteCustomPermissionsCommand}. + */ +export interface DeleteCustomPermissionsCommandInput extends DeleteCustomPermissionsRequest {} +/** + * @public + * + * The output of {@link DeleteCustomPermissionsCommand}. + */ +export interface DeleteCustomPermissionsCommandOutput extends DeleteCustomPermissionsResponse, __MetadataBearer {} + +/** + *

Deletes a custom permissions profile.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteCustomPermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteCustomPermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // DeleteCustomPermissionsRequest + * AwsAccountId: "STRING_VALUE", // required + * CustomPermissionsName: "STRING_VALUE", // required + * }; + * const command = new DeleteCustomPermissionsCommand(input); + * const response = await client.send(command); + * // { // DeleteCustomPermissionsResponse + * // Status: Number("int"), + * // Arn: "STRING_VALUE", + * // RequestId: "STRING_VALUE", + * // }; + * + * ``` + * + * @param DeleteCustomPermissionsCommandInput - {@link DeleteCustomPermissionsCommandInput} + * @returns {@link DeleteCustomPermissionsCommandOutput} + * @see {@link DeleteCustomPermissionsCommandInput} for command's `input` shape. + * @see {@link DeleteCustomPermissionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.

+ * + * @throws {@link ConflictException} (client fault) + *

Updating or deleting a resource can cause an inconsistent state.

+ * + * @throws {@link InternalFailureException} (server fault) + *

An internal failure occurred.

+ * + * @throws {@link InvalidParameterValueException} (client fault) + *

One or more parameters has a value that isn't valid.

+ * + * @throws {@link PreconditionNotMetException} (client fault) + *

One or more preconditions aren't met.

+ * + * @throws {@link ResourceExistsException} (client fault) + *

The resource specified already exists.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

One or more resources can't be found.

+ * + * @throws {@link ResourceUnavailableException} (server fault) + *

This resource is currently unavailable.

+ * + * @throws {@link ThrottlingException} (client fault) + *

Access is throttled.

+ * + * @throws {@link QuickSightServiceException} + *

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class DeleteCustomPermissionsCommand extends $Command + .classBuilder< + DeleteCustomPermissionsCommandInput, + DeleteCustomPermissionsCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "DeleteCustomPermissions", {}) + .n("QuickSightClient", "DeleteCustomPermissionsCommand") + .f(void 0, void 0) + .ser(se_DeleteCustomPermissionsCommand) + .de(de_DeleteCustomPermissionsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteCustomPermissionsRequest; + output: DeleteCustomPermissionsResponse; + }; + sdk: { + input: DeleteCustomPermissionsCommandInput; + output: DeleteCustomPermissionsCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/DeleteUserCustomPermissionCommand.ts b/clients/client-quicksight/src/commands/DeleteUserCustomPermissionCommand.ts new file mode 100644 index 000000000000..3f5be5a820aa --- /dev/null +++ b/clients/client-quicksight/src/commands/DeleteUserCustomPermissionCommand.ts @@ -0,0 +1,122 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteUserCustomPermissionRequest, DeleteUserCustomPermissionResponse } from "../models/models_3"; +import { de_DeleteUserCustomPermissionCommand, se_DeleteUserCustomPermissionCommand } from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteUserCustomPermissionCommand}. + */ +export interface DeleteUserCustomPermissionCommandInput extends DeleteUserCustomPermissionRequest {} +/** + * @public + * + * The output of {@link DeleteUserCustomPermissionCommand}. + */ +export interface DeleteUserCustomPermissionCommandOutput extends DeleteUserCustomPermissionResponse, __MetadataBearer {} + +/** + *

Deletes a custom permissions profile from a user.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteUserCustomPermissionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteUserCustomPermissionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // DeleteUserCustomPermissionRequest + * UserName: "STRING_VALUE", // required + * AwsAccountId: "STRING_VALUE", // required + * Namespace: "STRING_VALUE", // required + * }; + * const command = new DeleteUserCustomPermissionCommand(input); + * const response = await client.send(command); + * // { // DeleteUserCustomPermissionResponse + * // RequestId: "STRING_VALUE", + * // Status: Number("int"), + * // }; + * + * ``` + * + * @param DeleteUserCustomPermissionCommandInput - {@link DeleteUserCustomPermissionCommandInput} + * @returns {@link DeleteUserCustomPermissionCommandOutput} + * @see {@link DeleteUserCustomPermissionCommandInput} for command's `input` shape. + * @see {@link DeleteUserCustomPermissionCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.

+ * + * @throws {@link ConflictException} (client fault) + *

Updating or deleting a resource can cause an inconsistent state.

+ * + * @throws {@link InternalFailureException} (server fault) + *

An internal failure occurred.

+ * + * @throws {@link InvalidParameterValueException} (client fault) + *

One or more parameters has a value that isn't valid.

+ * + * @throws {@link PreconditionNotMetException} (client fault) + *

One or more preconditions aren't met.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

One or more resources can't be found.

+ * + * @throws {@link ResourceUnavailableException} (server fault) + *

This resource is currently unavailable.

+ * + * @throws {@link ThrottlingException} (client fault) + *

Access is throttled.

+ * + * @throws {@link QuickSightServiceException} + *

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class DeleteUserCustomPermissionCommand extends $Command + .classBuilder< + DeleteUserCustomPermissionCommandInput, + DeleteUserCustomPermissionCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "DeleteUserCustomPermission", {}) + .n("QuickSightClient", "DeleteUserCustomPermissionCommand") + .f(void 0, void 0) + .ser(se_DeleteUserCustomPermissionCommand) + .de(de_DeleteUserCustomPermissionCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteUserCustomPermissionRequest; + output: DeleteUserCustomPermissionResponse; + }; + sdk: { + input: DeleteUserCustomPermissionCommandInput; + output: DeleteUserCustomPermissionCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/DescribeBrandAssignmentCommand.ts b/clients/client-quicksight/src/commands/DescribeBrandAssignmentCommand.ts new file mode 100644 index 000000000000..2f9a844a0157 --- /dev/null +++ b/clients/client-quicksight/src/commands/DescribeBrandAssignmentCommand.ts @@ -0,0 +1,114 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribeBrandAssignmentRequest, DescribeBrandAssignmentResponse } from "../models/models_3"; +import { de_DescribeBrandAssignmentCommand, se_DescribeBrandAssignmentCommand } from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribeBrandAssignmentCommand}. + */ +export interface DescribeBrandAssignmentCommandInput extends DescribeBrandAssignmentRequest {} +/** + * @public + * + * The output of {@link DescribeBrandAssignmentCommand}. + */ +export interface DescribeBrandAssignmentCommandOutput extends DescribeBrandAssignmentResponse, __MetadataBearer {} + +/** + *

Describes a brand assignment.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeBrandAssignmentCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeBrandAssignmentCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // DescribeBrandAssignmentRequest + * AwsAccountId: "STRING_VALUE", // required + * }; + * const command = new DescribeBrandAssignmentCommand(input); + * const response = await client.send(command); + * // { // DescribeBrandAssignmentResponse + * // RequestId: "STRING_VALUE", + * // BrandArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param DescribeBrandAssignmentCommandInput - {@link DescribeBrandAssignmentCommandInput} + * @returns {@link DescribeBrandAssignmentCommandOutput} + * @see {@link DescribeBrandAssignmentCommandInput} for command's `input` shape. + * @see {@link DescribeBrandAssignmentCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.

+ * + * @throws {@link ConflictException} (client fault) + *

Updating or deleting a resource can cause an inconsistent state.

+ * + * @throws {@link InternalServerException} (server fault) + *

An internal service exception.

+ * + * @throws {@link InvalidRequestException} (client fault) + *

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

One or more resources can't be found.

+ * + * @throws {@link ThrottlingException} (client fault) + *

Access is throttled.

+ * + * @throws {@link QuickSightServiceException} + *

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class DescribeBrandAssignmentCommand extends $Command + .classBuilder< + DescribeBrandAssignmentCommandInput, + DescribeBrandAssignmentCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "DescribeBrandAssignment", {}) + .n("QuickSightClient", "DescribeBrandAssignmentCommand") + .f(void 0, void 0) + .ser(se_DescribeBrandAssignmentCommand) + .de(de_DescribeBrandAssignmentCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribeBrandAssignmentRequest; + output: DescribeBrandAssignmentResponse; + }; + sdk: { + input: DescribeBrandAssignmentCommandInput; + output: DescribeBrandAssignmentCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/DescribeBrandCommand.ts b/clients/client-quicksight/src/commands/DescribeBrandCommand.ts new file mode 100644 index 000000000000..e72709c02226 --- /dev/null +++ b/clients/client-quicksight/src/commands/DescribeBrandCommand.ts @@ -0,0 +1,225 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribeBrandRequest, DescribeBrandResponse } from "../models/models_3"; +import { de_DescribeBrandCommand, se_DescribeBrandCommand } from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribeBrandCommand}. + */ +export interface DescribeBrandCommandInput extends DescribeBrandRequest {} +/** + * @public + * + * The output of {@link DescribeBrandCommand}. + */ +export interface DescribeBrandCommandOutput extends DescribeBrandResponse, __MetadataBearer {} + +/** + *

Describes a brand.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeBrandCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeBrandCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // DescribeBrandRequest + * AwsAccountId: "STRING_VALUE", // required + * BrandId: "STRING_VALUE", // required + * VersionId: "STRING_VALUE", + * }; + * const command = new DescribeBrandCommand(input); + * const response = await client.send(command); + * // { // DescribeBrandResponse + * // RequestId: "STRING_VALUE", + * // BrandDetail: { // BrandDetail + * // BrandId: "STRING_VALUE", // required + * // Arn: "STRING_VALUE", + * // BrandStatus: "CREATE_IN_PROGRESS" || "CREATE_SUCCEEDED" || "CREATE_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_FAILED", + * // CreatedTime: new Date("TIMESTAMP"), + * // LastUpdatedTime: new Date("TIMESTAMP"), + * // VersionId: "STRING_VALUE", + * // VersionStatus: "CREATE_IN_PROGRESS" || "CREATE_SUCCEEDED" || "CREATE_FAILED", + * // Errors: [ // ErrorList + * // "STRING_VALUE", + * // ], + * // Logo: { // Logo + * // AltText: "STRING_VALUE", // required + * // LogoSet: { // LogoSet + * // Primary: { // ImageSet + * // Original: { // Image + * // Source: { // ImageSource Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // Height64: { + * // Source: {// Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // Height32: { + * // Source: {// Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // }, + * // Favicon: { + * // Original: { + * // Source: {// Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // Height64: { + * // Source: {// Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // Height32: "", + * // }, + * // }, + * // }, + * // }, + * // BrandDefinition: { // BrandDefinition + * // BrandName: "STRING_VALUE", // required + * // Description: "STRING_VALUE", + * // ApplicationTheme: { // ApplicationTheme + * // BrandColorPalette: { // BrandColorPalette + * // Primary: { // Palette + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Secondary: { + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Accent: { + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Measure: { + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Dimension: { + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Success: "", + * // Info: "", + * // Warning: "", + * // Danger: "", + * // }, + * // BrandElementStyle: { // BrandElementStyle + * // NavbarStyle: { // NavbarStyle + * // GlobalNavbar: "", + * // ContextualNavbar: "", + * // }, + * // }, + * // }, + * // LogoConfiguration: { // LogoConfiguration + * // AltText: "STRING_VALUE", // required + * // LogoSet: { // LogoSetConfiguration + * // Primary: { // ImageSetConfiguration + * // Original: { // ImageConfiguration + * // Source: "", + * // }, + * // }, + * // Favicon: { + * // Original: { + * // Source: "", + * // }, + * // }, + * // }, + * // }, + * // }, + * // }; + * + * ``` + * + * @param DescribeBrandCommandInput - {@link DescribeBrandCommandInput} + * @returns {@link DescribeBrandCommandOutput} + * @see {@link DescribeBrandCommandInput} for command's `input` shape. + * @see {@link DescribeBrandCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.

+ * + * @throws {@link ConflictException} (client fault) + *

Updating or deleting a resource can cause an inconsistent state.

+ * + * @throws {@link InternalServerException} (server fault) + *

An internal service exception.

+ * + * @throws {@link InvalidRequestException} (client fault) + *

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

One or more resources can't be found.

+ * + * @throws {@link ThrottlingException} (client fault) + *

Access is throttled.

+ * + * @throws {@link QuickSightServiceException} + *

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class DescribeBrandCommand extends $Command + .classBuilder< + DescribeBrandCommandInput, + DescribeBrandCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "DescribeBrand", {}) + .n("QuickSightClient", "DescribeBrandCommand") + .f(void 0, void 0) + .ser(se_DescribeBrandCommand) + .de(de_DescribeBrandCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribeBrandRequest; + output: DescribeBrandResponse; + }; + sdk: { + input: DescribeBrandCommandInput; + output: DescribeBrandCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/DescribeBrandPublishedVersionCommand.ts b/clients/client-quicksight/src/commands/DescribeBrandPublishedVersionCommand.ts new file mode 100644 index 000000000000..8b40ec74aaf6 --- /dev/null +++ b/clients/client-quicksight/src/commands/DescribeBrandPublishedVersionCommand.ts @@ -0,0 +1,229 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribeBrandPublishedVersionRequest, DescribeBrandPublishedVersionResponse } from "../models/models_3"; +import { + de_DescribeBrandPublishedVersionCommand, + se_DescribeBrandPublishedVersionCommand, +} from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribeBrandPublishedVersionCommand}. + */ +export interface DescribeBrandPublishedVersionCommandInput extends DescribeBrandPublishedVersionRequest {} +/** + * @public + * + * The output of {@link DescribeBrandPublishedVersionCommand}. + */ +export interface DescribeBrandPublishedVersionCommandOutput + extends DescribeBrandPublishedVersionResponse, + __MetadataBearer {} + +/** + *

Describes the published version of the brand.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeBrandPublishedVersionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeBrandPublishedVersionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // DescribeBrandPublishedVersionRequest + * AwsAccountId: "STRING_VALUE", // required + * BrandId: "STRING_VALUE", // required + * }; + * const command = new DescribeBrandPublishedVersionCommand(input); + * const response = await client.send(command); + * // { // DescribeBrandPublishedVersionResponse + * // RequestId: "STRING_VALUE", + * // BrandDetail: { // BrandDetail + * // BrandId: "STRING_VALUE", // required + * // Arn: "STRING_VALUE", + * // BrandStatus: "CREATE_IN_PROGRESS" || "CREATE_SUCCEEDED" || "CREATE_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_FAILED", + * // CreatedTime: new Date("TIMESTAMP"), + * // LastUpdatedTime: new Date("TIMESTAMP"), + * // VersionId: "STRING_VALUE", + * // VersionStatus: "CREATE_IN_PROGRESS" || "CREATE_SUCCEEDED" || "CREATE_FAILED", + * // Errors: [ // ErrorList + * // "STRING_VALUE", + * // ], + * // Logo: { // Logo + * // AltText: "STRING_VALUE", // required + * // LogoSet: { // LogoSet + * // Primary: { // ImageSet + * // Original: { // Image + * // Source: { // ImageSource Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // Height64: { + * // Source: {// Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // Height32: { + * // Source: {// Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // }, + * // Favicon: { + * // Original: { + * // Source: {// Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // Height64: { + * // Source: {// Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // Height32: "", + * // }, + * // }, + * // }, + * // }, + * // BrandDefinition: { // BrandDefinition + * // BrandName: "STRING_VALUE", // required + * // Description: "STRING_VALUE", + * // ApplicationTheme: { // ApplicationTheme + * // BrandColorPalette: { // BrandColorPalette + * // Primary: { // Palette + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Secondary: { + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Accent: { + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Measure: { + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Dimension: { + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Success: "", + * // Info: "", + * // Warning: "", + * // Danger: "", + * // }, + * // BrandElementStyle: { // BrandElementStyle + * // NavbarStyle: { // NavbarStyle + * // GlobalNavbar: "", + * // ContextualNavbar: "", + * // }, + * // }, + * // }, + * // LogoConfiguration: { // LogoConfiguration + * // AltText: "STRING_VALUE", // required + * // LogoSet: { // LogoSetConfiguration + * // Primary: { // ImageSetConfiguration + * // Original: { // ImageConfiguration + * // Source: "", + * // }, + * // }, + * // Favicon: { + * // Original: { + * // Source: "", + * // }, + * // }, + * // }, + * // }, + * // }, + * // }; + * + * ``` + * + * @param DescribeBrandPublishedVersionCommandInput - {@link DescribeBrandPublishedVersionCommandInput} + * @returns {@link DescribeBrandPublishedVersionCommandOutput} + * @see {@link DescribeBrandPublishedVersionCommandInput} for command's `input` shape. + * @see {@link DescribeBrandPublishedVersionCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.

+ * + * @throws {@link ConflictException} (client fault) + *

Updating or deleting a resource can cause an inconsistent state.

+ * + * @throws {@link InternalServerException} (server fault) + *

An internal service exception.

+ * + * @throws {@link InvalidRequestException} (client fault) + *

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

One or more resources can't be found.

+ * + * @throws {@link ThrottlingException} (client fault) + *

Access is throttled.

+ * + * @throws {@link QuickSightServiceException} + *

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class DescribeBrandPublishedVersionCommand extends $Command + .classBuilder< + DescribeBrandPublishedVersionCommandInput, + DescribeBrandPublishedVersionCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "DescribeBrandPublishedVersion", {}) + .n("QuickSightClient", "DescribeBrandPublishedVersionCommand") + .f(void 0, void 0) + .ser(se_DescribeBrandPublishedVersionCommand) + .de(de_DescribeBrandPublishedVersionCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribeBrandPublishedVersionRequest; + output: DescribeBrandPublishedVersionResponse; + }; + sdk: { + input: DescribeBrandPublishedVersionCommandInput; + output: DescribeBrandPublishedVersionCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/DescribeCustomPermissionsCommand.ts b/clients/client-quicksight/src/commands/DescribeCustomPermissionsCommand.ts new file mode 100644 index 000000000000..2221941bb311 --- /dev/null +++ b/clients/client-quicksight/src/commands/DescribeCustomPermissionsCommand.ts @@ -0,0 +1,141 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribeCustomPermissionsRequest, DescribeCustomPermissionsResponse } from "../models/models_3"; +import { de_DescribeCustomPermissionsCommand, se_DescribeCustomPermissionsCommand } from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribeCustomPermissionsCommand}. + */ +export interface DescribeCustomPermissionsCommandInput extends DescribeCustomPermissionsRequest {} +/** + * @public + * + * The output of {@link DescribeCustomPermissionsCommand}. + */ +export interface DescribeCustomPermissionsCommandOutput extends DescribeCustomPermissionsResponse, __MetadataBearer {} + +/** + *

Describes a custom permissions profile.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeCustomPermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeCustomPermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // DescribeCustomPermissionsRequest + * AwsAccountId: "STRING_VALUE", // required + * CustomPermissionsName: "STRING_VALUE", // required + * }; + * const command = new DescribeCustomPermissionsCommand(input); + * const response = await client.send(command); + * // { // DescribeCustomPermissionsResponse + * // Status: Number("int"), + * // CustomPermissions: { // CustomPermissions + * // Arn: "STRING_VALUE", + * // CustomPermissionsName: "STRING_VALUE", + * // Capabilities: { // Capabilities + * // ExportToCsv: "DENY", + * // ExportToExcel: "DENY", + * // CreateAndUpdateThemes: "DENY", + * // AddOrRunAnomalyDetectionForAnalyses: "DENY", + * // ShareAnalyses: "DENY", + * // CreateAndUpdateDatasets: "DENY", + * // ShareDatasets: "DENY", + * // SubscribeDashboardEmailReports: "DENY", + * // CreateAndUpdateDashboardEmailReports: "DENY", + * // ShareDashboards: "DENY", + * // CreateAndUpdateThresholdAlerts: "DENY", + * // RenameSharedFolders: "DENY", + * // CreateSharedFolders: "DENY", + * // CreateAndUpdateDataSources: "DENY", + * // ShareDataSources: "DENY", + * // ViewAccountSPICECapacity: "DENY", + * // CreateSPICEDataset: "DENY", + * // }, + * // }, + * // RequestId: "STRING_VALUE", + * // }; + * + * ``` + * + * @param DescribeCustomPermissionsCommandInput - {@link DescribeCustomPermissionsCommandInput} + * @returns {@link DescribeCustomPermissionsCommandOutput} + * @see {@link DescribeCustomPermissionsCommandInput} for command's `input` shape. + * @see {@link DescribeCustomPermissionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.

+ * + * @throws {@link InternalFailureException} (server fault) + *

An internal failure occurred.

+ * + * @throws {@link InvalidParameterValueException} (client fault) + *

One or more parameters has a value that isn't valid.

+ * + * @throws {@link PreconditionNotMetException} (client fault) + *

One or more preconditions aren't met.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

One or more resources can't be found.

+ * + * @throws {@link ResourceUnavailableException} (server fault) + *

This resource is currently unavailable.

+ * + * @throws {@link ThrottlingException} (client fault) + *

Access is throttled.

+ * + * @throws {@link QuickSightServiceException} + *

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class DescribeCustomPermissionsCommand extends $Command + .classBuilder< + DescribeCustomPermissionsCommandInput, + DescribeCustomPermissionsCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "DescribeCustomPermissions", {}) + .n("QuickSightClient", "DescribeCustomPermissionsCommand") + .f(void 0, void 0) + .ser(se_DescribeCustomPermissionsCommand) + .de(de_DescribeCustomPermissionsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribeCustomPermissionsRequest; + output: DescribeCustomPermissionsResponse; + }; + sdk: { + input: DescribeCustomPermissionsCommandInput; + output: DescribeCustomPermissionsCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/DescribeIngestionCommand.ts b/clients/client-quicksight/src/commands/DescribeIngestionCommand.ts index b727f6fb788e..d0962e089585 100644 --- a/clients/client-quicksight/src/commands/DescribeIngestionCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeIngestionCommand.ts @@ -5,7 +5,8 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeIngestionRequest, DescribeIngestionResponse } from "../models/models_3"; +import { DescribeIngestionRequest } from "../models/models_3"; +import { DescribeIngestionResponse } from "../models/models_4"; import { de_DescribeIngestionCommand, se_DescribeIngestionCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeIpRestrictionCommand.ts b/clients/client-quicksight/src/commands/DescribeIpRestrictionCommand.ts index 0bffc4fe5524..d264056fdb3d 100644 --- a/clients/client-quicksight/src/commands/DescribeIpRestrictionCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeIpRestrictionCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeIpRestrictionRequest, DescribeIpRestrictionResponse } from "../models/models_3"; +import { DescribeIpRestrictionRequest, DescribeIpRestrictionResponse } from "../models/models_4"; import { de_DescribeIpRestrictionCommand, se_DescribeIpRestrictionCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeKeyRegistrationCommand.ts b/clients/client-quicksight/src/commands/DescribeKeyRegistrationCommand.ts index 709a73fa54a9..71fe0b140a1e 100644 --- a/clients/client-quicksight/src/commands/DescribeKeyRegistrationCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeKeyRegistrationCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeKeyRegistrationRequest, DescribeKeyRegistrationResponse } from "../models/models_3"; +import { DescribeKeyRegistrationRequest, DescribeKeyRegistrationResponse } from "../models/models_4"; import { de_DescribeKeyRegistrationCommand, se_DescribeKeyRegistrationCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeNamespaceCommand.ts b/clients/client-quicksight/src/commands/DescribeNamespaceCommand.ts index 442aceed71d0..5c98ef27b005 100644 --- a/clients/client-quicksight/src/commands/DescribeNamespaceCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeNamespaceCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeNamespaceRequest, DescribeNamespaceResponse } from "../models/models_3"; +import { DescribeNamespaceRequest, DescribeNamespaceResponse } from "../models/models_4"; import { de_DescribeNamespaceCommand, se_DescribeNamespaceCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeQPersonalizationConfigurationCommand.ts b/clients/client-quicksight/src/commands/DescribeQPersonalizationConfigurationCommand.ts index 769f7bd2f10c..aac4d1824938 100644 --- a/clients/client-quicksight/src/commands/DescribeQPersonalizationConfigurationCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeQPersonalizationConfigurationCommand.ts @@ -8,7 +8,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { DescribeQPersonalizationConfigurationRequest, DescribeQPersonalizationConfigurationResponse, -} from "../models/models_3"; +} from "../models/models_4"; import { de_DescribeQPersonalizationConfigurationCommand, se_DescribeQPersonalizationConfigurationCommand, diff --git a/clients/client-quicksight/src/commands/DescribeRefreshScheduleCommand.ts b/clients/client-quicksight/src/commands/DescribeRefreshScheduleCommand.ts index 680c2ff3a87b..70532b6839fd 100644 --- a/clients/client-quicksight/src/commands/DescribeRefreshScheduleCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeRefreshScheduleCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeRefreshScheduleRequest, DescribeRefreshScheduleResponse } from "../models/models_3"; +import { DescribeRefreshScheduleRequest, DescribeRefreshScheduleResponse } from "../models/models_4"; import { de_DescribeRefreshScheduleCommand, se_DescribeRefreshScheduleCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeRoleCustomPermissionCommand.ts b/clients/client-quicksight/src/commands/DescribeRoleCustomPermissionCommand.ts index f4f8e23daae3..5d2427d4fb7a 100644 --- a/clients/client-quicksight/src/commands/DescribeRoleCustomPermissionCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeRoleCustomPermissionCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeRoleCustomPermissionRequest, DescribeRoleCustomPermissionResponse } from "../models/models_3"; +import { DescribeRoleCustomPermissionRequest, DescribeRoleCustomPermissionResponse } from "../models/models_4"; import { de_DescribeRoleCustomPermissionCommand, se_DescribeRoleCustomPermissionCommand, diff --git a/clients/client-quicksight/src/commands/DescribeTemplateAliasCommand.ts b/clients/client-quicksight/src/commands/DescribeTemplateAliasCommand.ts index ff9b52e073cb..924d146f60db 100644 --- a/clients/client-quicksight/src/commands/DescribeTemplateAliasCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeTemplateAliasCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeTemplateAliasRequest, DescribeTemplateAliasResponse } from "../models/models_3"; +import { DescribeTemplateAliasRequest, DescribeTemplateAliasResponse } from "../models/models_4"; import { de_DescribeTemplateAliasCommand, se_DescribeTemplateAliasCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeTemplateCommand.ts b/clients/client-quicksight/src/commands/DescribeTemplateCommand.ts index 9a5779eac456..5a9640db3779 100644 --- a/clients/client-quicksight/src/commands/DescribeTemplateCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeTemplateCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeTemplateRequest, DescribeTemplateResponse } from "../models/models_3"; +import { DescribeTemplateRequest, DescribeTemplateResponse } from "../models/models_4"; import { de_DescribeTemplateCommand, se_DescribeTemplateCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts b/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts index bfe6fb974d6b..cc01676b32fd 100644 --- a/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts @@ -9,7 +9,7 @@ import { DescribeTemplateDefinitionRequest, DescribeTemplateDefinitionResponse, DescribeTemplateDefinitionResponseFilterSensitiveLog, -} from "../models/models_3"; +} from "../models/models_4"; import { de_DescribeTemplateDefinitionCommand, se_DescribeTemplateDefinitionCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeTemplatePermissionsCommand.ts b/clients/client-quicksight/src/commands/DescribeTemplatePermissionsCommand.ts index 8aae6a65ffb2..738cd4c3f332 100644 --- a/clients/client-quicksight/src/commands/DescribeTemplatePermissionsCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeTemplatePermissionsCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeTemplatePermissionsRequest, DescribeTemplatePermissionsResponse } from "../models/models_3"; +import { DescribeTemplatePermissionsRequest, DescribeTemplatePermissionsResponse } from "../models/models_4"; import { de_DescribeTemplatePermissionsCommand, se_DescribeTemplatePermissionsCommand, diff --git a/clients/client-quicksight/src/commands/DescribeThemeAliasCommand.ts b/clients/client-quicksight/src/commands/DescribeThemeAliasCommand.ts index 277f122140b3..4ae88d087558 100644 --- a/clients/client-quicksight/src/commands/DescribeThemeAliasCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeThemeAliasCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeThemeAliasRequest, DescribeThemeAliasResponse } from "../models/models_3"; +import { DescribeThemeAliasRequest, DescribeThemeAliasResponse } from "../models/models_4"; import { de_DescribeThemeAliasCommand, se_DescribeThemeAliasCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeThemeCommand.ts b/clients/client-quicksight/src/commands/DescribeThemeCommand.ts index c7bda68de712..d34d6ff39e71 100644 --- a/clients/client-quicksight/src/commands/DescribeThemeCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeThemeCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeThemeRequest, DescribeThemeResponse } from "../models/models_3"; +import { DescribeThemeRequest, DescribeThemeResponse } from "../models/models_4"; import { de_DescribeThemeCommand, se_DescribeThemeCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeThemePermissionsCommand.ts b/clients/client-quicksight/src/commands/DescribeThemePermissionsCommand.ts index c3b952d05a6d..69d045502e00 100644 --- a/clients/client-quicksight/src/commands/DescribeThemePermissionsCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeThemePermissionsCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeThemePermissionsRequest, DescribeThemePermissionsResponse } from "../models/models_3"; +import { DescribeThemePermissionsRequest, DescribeThemePermissionsResponse } from "../models/models_4"; import { de_DescribeThemePermissionsCommand, se_DescribeThemePermissionsCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeTopicCommand.ts b/clients/client-quicksight/src/commands/DescribeTopicCommand.ts index 2805470a6f9c..718dc814d12d 100644 --- a/clients/client-quicksight/src/commands/DescribeTopicCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeTopicCommand.ts @@ -9,7 +9,7 @@ import { DescribeTopicRequest, DescribeTopicResponse, DescribeTopicResponseFilterSensitiveLog, -} from "../models/models_3"; +} from "../models/models_4"; import { de_DescribeTopicCommand, se_DescribeTopicCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeTopicPermissionsCommand.ts b/clients/client-quicksight/src/commands/DescribeTopicPermissionsCommand.ts index 008e2acb3565..947b6783d107 100644 --- a/clients/client-quicksight/src/commands/DescribeTopicPermissionsCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeTopicPermissionsCommand.ts @@ -5,8 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeTopicPermissionsRequest } from "../models/models_3"; -import { DescribeTopicPermissionsResponse } from "../models/models_4"; +import { DescribeTopicPermissionsRequest, DescribeTopicPermissionsResponse } from "../models/models_4"; import { de_DescribeTopicPermissionsCommand, se_DescribeTopicPermissionsCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/ListBrandsCommand.ts b/clients/client-quicksight/src/commands/ListBrandsCommand.ts new file mode 100644 index 000000000000..ada51faa963e --- /dev/null +++ b/clients/client-quicksight/src/commands/ListBrandsCommand.ts @@ -0,0 +1,120 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListBrandsRequest, ListBrandsResponse } from "../models/models_4"; +import { de_ListBrandsCommand, se_ListBrandsCommand } from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListBrandsCommand}. + */ +export interface ListBrandsCommandInput extends ListBrandsRequest {} +/** + * @public + * + * The output of {@link ListBrandsCommand}. + */ +export interface ListBrandsCommandOutput extends ListBrandsResponse, __MetadataBearer {} + +/** + *

Lists all brands in an Amazon QuickSight account.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListBrandsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListBrandsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // ListBrandsRequest + * AwsAccountId: "STRING_VALUE", // required + * MaxResults: Number("int"), + * NextToken: "STRING_VALUE", + * }; + * const command = new ListBrandsCommand(input); + * const response = await client.send(command); + * // { // ListBrandsResponse + * // NextToken: "STRING_VALUE", + * // Brands: [ // BrandSummaryList + * // { // BrandSummary + * // Arn: "STRING_VALUE", + * // BrandId: "STRING_VALUE", + * // BrandName: "STRING_VALUE", + * // Description: "STRING_VALUE", + * // BrandStatus: "CREATE_IN_PROGRESS" || "CREATE_SUCCEEDED" || "CREATE_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_FAILED", + * // CreatedTime: new Date("TIMESTAMP"), + * // LastUpdatedTime: new Date("TIMESTAMP"), + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListBrandsCommandInput - {@link ListBrandsCommandInput} + * @returns {@link ListBrandsCommandOutput} + * @see {@link ListBrandsCommandInput} for command's `input` shape. + * @see {@link ListBrandsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.

+ * + * @throws {@link InternalServerException} (server fault) + *

An internal service exception.

+ * + * @throws {@link InvalidRequestException} (client fault) + *

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

+ * + * @throws {@link ThrottlingException} (client fault) + *

Access is throttled.

+ * + * @throws {@link QuickSightServiceException} + *

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class ListBrandsCommand extends $Command + .classBuilder< + ListBrandsCommandInput, + ListBrandsCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "ListBrands", {}) + .n("QuickSightClient", "ListBrandsCommand") + .f(void 0, void 0) + .ser(se_ListBrandsCommand) + .de(de_ListBrandsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListBrandsRequest; + output: ListBrandsResponse; + }; + sdk: { + input: ListBrandsCommandInput; + output: ListBrandsCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/ListCustomPermissionsCommand.ts b/clients/client-quicksight/src/commands/ListCustomPermissionsCommand.ts new file mode 100644 index 000000000000..a1c2c867c06f --- /dev/null +++ b/clients/client-quicksight/src/commands/ListCustomPermissionsCommand.ts @@ -0,0 +1,145 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListCustomPermissionsRequest, ListCustomPermissionsResponse } from "../models/models_4"; +import { de_ListCustomPermissionsCommand, se_ListCustomPermissionsCommand } from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListCustomPermissionsCommand}. + */ +export interface ListCustomPermissionsCommandInput extends ListCustomPermissionsRequest {} +/** + * @public + * + * The output of {@link ListCustomPermissionsCommand}. + */ +export interface ListCustomPermissionsCommandOutput extends ListCustomPermissionsResponse, __MetadataBearer {} + +/** + *

Returns a list of all the custom permissions profiles.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListCustomPermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListCustomPermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // ListCustomPermissionsRequest + * AwsAccountId: "STRING_VALUE", // required + * MaxResults: Number("int"), + * NextToken: "STRING_VALUE", + * }; + * const command = new ListCustomPermissionsCommand(input); + * const response = await client.send(command); + * // { // ListCustomPermissionsResponse + * // Status: Number("int"), + * // CustomPermissionsList: [ // CustomPermissionsList + * // { // CustomPermissions + * // Arn: "STRING_VALUE", + * // CustomPermissionsName: "STRING_VALUE", + * // Capabilities: { // Capabilities + * // ExportToCsv: "DENY", + * // ExportToExcel: "DENY", + * // CreateAndUpdateThemes: "DENY", + * // AddOrRunAnomalyDetectionForAnalyses: "DENY", + * // ShareAnalyses: "DENY", + * // CreateAndUpdateDatasets: "DENY", + * // ShareDatasets: "DENY", + * // SubscribeDashboardEmailReports: "DENY", + * // CreateAndUpdateDashboardEmailReports: "DENY", + * // ShareDashboards: "DENY", + * // CreateAndUpdateThresholdAlerts: "DENY", + * // RenameSharedFolders: "DENY", + * // CreateSharedFolders: "DENY", + * // CreateAndUpdateDataSources: "DENY", + * // ShareDataSources: "DENY", + * // ViewAccountSPICECapacity: "DENY", + * // CreateSPICEDataset: "DENY", + * // }, + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // RequestId: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListCustomPermissionsCommandInput - {@link ListCustomPermissionsCommandInput} + * @returns {@link ListCustomPermissionsCommandOutput} + * @see {@link ListCustomPermissionsCommandInput} for command's `input` shape. + * @see {@link ListCustomPermissionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.

+ * + * @throws {@link InternalFailureException} (server fault) + *

An internal failure occurred.

+ * + * @throws {@link InvalidParameterValueException} (client fault) + *

One or more parameters has a value that isn't valid.

+ * + * @throws {@link PreconditionNotMetException} (client fault) + *

One or more preconditions aren't met.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

One or more resources can't be found.

+ * + * @throws {@link ResourceUnavailableException} (server fault) + *

This resource is currently unavailable.

+ * + * @throws {@link ThrottlingException} (client fault) + *

Access is throttled.

+ * + * @throws {@link QuickSightServiceException} + *

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class ListCustomPermissionsCommand extends $Command + .classBuilder< + ListCustomPermissionsCommandInput, + ListCustomPermissionsCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "ListCustomPermissions", {}) + .n("QuickSightClient", "ListCustomPermissionsCommand") + .f(void 0, void 0) + .ser(se_ListCustomPermissionsCommand) + .de(de_ListCustomPermissionsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListCustomPermissionsRequest; + output: ListCustomPermissionsResponse; + }; + sdk: { + input: ListCustomPermissionsCommandInput; + output: ListCustomPermissionsCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/UpdateBrandAssignmentCommand.ts b/clients/client-quicksight/src/commands/UpdateBrandAssignmentCommand.ts new file mode 100644 index 000000000000..c6f622fd64a7 --- /dev/null +++ b/clients/client-quicksight/src/commands/UpdateBrandAssignmentCommand.ts @@ -0,0 +1,115 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateBrandAssignmentRequest, UpdateBrandAssignmentResponse } from "../models/models_4"; +import { de_UpdateBrandAssignmentCommand, se_UpdateBrandAssignmentCommand } from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateBrandAssignmentCommand}. + */ +export interface UpdateBrandAssignmentCommandInput extends UpdateBrandAssignmentRequest {} +/** + * @public + * + * The output of {@link UpdateBrandAssignmentCommand}. + */ +export interface UpdateBrandAssignmentCommandOutput extends UpdateBrandAssignmentResponse, __MetadataBearer {} + +/** + *

Updates a brand assignment.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateBrandAssignmentCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateBrandAssignmentCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // UpdateBrandAssignmentRequest + * AwsAccountId: "STRING_VALUE", // required + * BrandArn: "STRING_VALUE", // required + * }; + * const command = new UpdateBrandAssignmentCommand(input); + * const response = await client.send(command); + * // { // UpdateBrandAssignmentResponse + * // RequestId: "STRING_VALUE", + * // BrandArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param UpdateBrandAssignmentCommandInput - {@link UpdateBrandAssignmentCommandInput} + * @returns {@link UpdateBrandAssignmentCommandOutput} + * @see {@link UpdateBrandAssignmentCommandInput} for command's `input` shape. + * @see {@link UpdateBrandAssignmentCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.

+ * + * @throws {@link ConflictException} (client fault) + *

Updating or deleting a resource can cause an inconsistent state.

+ * + * @throws {@link InternalServerException} (server fault) + *

An internal service exception.

+ * + * @throws {@link InvalidRequestException} (client fault) + *

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

One or more resources can't be found.

+ * + * @throws {@link ThrottlingException} (client fault) + *

Access is throttled.

+ * + * @throws {@link QuickSightServiceException} + *

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class UpdateBrandAssignmentCommand extends $Command + .classBuilder< + UpdateBrandAssignmentCommandInput, + UpdateBrandAssignmentCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "UpdateBrandAssignment", {}) + .n("QuickSightClient", "UpdateBrandAssignmentCommand") + .f(void 0, void 0) + .ser(se_UpdateBrandAssignmentCommand) + .de(de_UpdateBrandAssignmentCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateBrandAssignmentRequest; + output: UpdateBrandAssignmentResponse; + }; + sdk: { + input: UpdateBrandAssignmentCommandInput; + output: UpdateBrandAssignmentCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/UpdateBrandCommand.ts b/clients/client-quicksight/src/commands/UpdateBrandCommand.ts new file mode 100644 index 000000000000..2f3d3ec21eac --- /dev/null +++ b/clients/client-quicksight/src/commands/UpdateBrandCommand.ts @@ -0,0 +1,283 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateBrandRequest, UpdateBrandResponse } from "../models/models_4"; +import { de_UpdateBrandCommand, se_UpdateBrandCommand } from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateBrandCommand}. + */ +export interface UpdateBrandCommandInput extends UpdateBrandRequest {} +/** + * @public + * + * The output of {@link UpdateBrandCommand}. + */ +export interface UpdateBrandCommandOutput extends UpdateBrandResponse, __MetadataBearer {} + +/** + *

Updates a brand.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateBrandCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateBrandCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // UpdateBrandRequest + * AwsAccountId: "STRING_VALUE", // required + * BrandId: "STRING_VALUE", // required + * BrandDefinition: { // BrandDefinition + * BrandName: "STRING_VALUE", // required + * Description: "STRING_VALUE", + * ApplicationTheme: { // ApplicationTheme + * BrandColorPalette: { // BrandColorPalette + * Primary: { // Palette + * Foreground: "STRING_VALUE", + * Background: "STRING_VALUE", + * }, + * Secondary: { + * Foreground: "STRING_VALUE", + * Background: "STRING_VALUE", + * }, + * Accent: { + * Foreground: "STRING_VALUE", + * Background: "STRING_VALUE", + * }, + * Measure: { + * Foreground: "STRING_VALUE", + * Background: "STRING_VALUE", + * }, + * Dimension: { + * Foreground: "STRING_VALUE", + * Background: "STRING_VALUE", + * }, + * Success: "", + * Info: "", + * Warning: "", + * Danger: "", + * }, + * BrandElementStyle: { // BrandElementStyle + * NavbarStyle: { // NavbarStyle + * GlobalNavbar: "", + * ContextualNavbar: "", + * }, + * }, + * }, + * LogoConfiguration: { // LogoConfiguration + * AltText: "STRING_VALUE", // required + * LogoSet: { // LogoSetConfiguration + * Primary: { // ImageSetConfiguration + * Original: { // ImageConfiguration + * Source: { // ImageSource Union: only one key present + * PublicUrl: "STRING_VALUE", + * S3Uri: "STRING_VALUE", + * }, + * }, + * }, + * Favicon: { + * Original: { + * Source: {// Union: only one key present + * PublicUrl: "STRING_VALUE", + * S3Uri: "STRING_VALUE", + * }, + * }, + * }, + * }, + * }, + * }, + * }; + * const command = new UpdateBrandCommand(input); + * const response = await client.send(command); + * // { // UpdateBrandResponse + * // RequestId: "STRING_VALUE", + * // BrandDetail: { // BrandDetail + * // BrandId: "STRING_VALUE", // required + * // Arn: "STRING_VALUE", + * // BrandStatus: "CREATE_IN_PROGRESS" || "CREATE_SUCCEEDED" || "CREATE_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_FAILED", + * // CreatedTime: new Date("TIMESTAMP"), + * // LastUpdatedTime: new Date("TIMESTAMP"), + * // VersionId: "STRING_VALUE", + * // VersionStatus: "CREATE_IN_PROGRESS" || "CREATE_SUCCEEDED" || "CREATE_FAILED", + * // Errors: [ // ErrorList + * // "STRING_VALUE", + * // ], + * // Logo: { // Logo + * // AltText: "STRING_VALUE", // required + * // LogoSet: { // LogoSet + * // Primary: { // ImageSet + * // Original: { // Image + * // Source: { // ImageSource Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // Height64: { + * // Source: {// Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // Height32: { + * // Source: {// Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // }, + * // Favicon: { + * // Original: { + * // Source: {// Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // Height64: { + * // Source: {// Union: only one key present + * // PublicUrl: "STRING_VALUE", + * // S3Uri: "STRING_VALUE", + * // }, + * // GeneratedImageUrl: "STRING_VALUE", + * // }, + * // Height32: "", + * // }, + * // }, + * // }, + * // }, + * // BrandDefinition: { // BrandDefinition + * // BrandName: "STRING_VALUE", // required + * // Description: "STRING_VALUE", + * // ApplicationTheme: { // ApplicationTheme + * // BrandColorPalette: { // BrandColorPalette + * // Primary: { // Palette + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Secondary: { + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Accent: { + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Measure: { + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Dimension: { + * // Foreground: "STRING_VALUE", + * // Background: "STRING_VALUE", + * // }, + * // Success: "", + * // Info: "", + * // Warning: "", + * // Danger: "", + * // }, + * // BrandElementStyle: { // BrandElementStyle + * // NavbarStyle: { // NavbarStyle + * // GlobalNavbar: "", + * // ContextualNavbar: "", + * // }, + * // }, + * // }, + * // LogoConfiguration: { // LogoConfiguration + * // AltText: "STRING_VALUE", // required + * // LogoSet: { // LogoSetConfiguration + * // Primary: { // ImageSetConfiguration + * // Original: { // ImageConfiguration + * // Source: "", + * // }, + * // }, + * // Favicon: { + * // Original: { + * // Source: "", + * // }, + * // }, + * // }, + * // }, + * // }, + * // }; + * + * ``` + * + * @param UpdateBrandCommandInput - {@link UpdateBrandCommandInput} + * @returns {@link UpdateBrandCommandOutput} + * @see {@link UpdateBrandCommandInput} for command's `input` shape. + * @see {@link UpdateBrandCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.

+ * + * @throws {@link ConflictException} (client fault) + *

Updating or deleting a resource can cause an inconsistent state.

+ * + * @throws {@link InternalServerException} (server fault) + *

An internal service exception.

+ * + * @throws {@link InvalidRequestException} (client fault) + *

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

One or more resources can't be found.

+ * + * @throws {@link ThrottlingException} (client fault) + *

Access is throttled.

+ * + * @throws {@link QuickSightServiceException} + *

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class UpdateBrandCommand extends $Command + .classBuilder< + UpdateBrandCommandInput, + UpdateBrandCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "UpdateBrand", {}) + .n("QuickSightClient", "UpdateBrandCommand") + .f(void 0, void 0) + .ser(se_UpdateBrandCommand) + .de(de_UpdateBrandCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateBrandRequest; + output: UpdateBrandResponse; + }; + sdk: { + input: UpdateBrandCommandInput; + output: UpdateBrandCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/UpdateBrandPublishedVersionCommand.ts b/clients/client-quicksight/src/commands/UpdateBrandPublishedVersionCommand.ts new file mode 100644 index 000000000000..74d238a61f8c --- /dev/null +++ b/clients/client-quicksight/src/commands/UpdateBrandPublishedVersionCommand.ts @@ -0,0 +1,121 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateBrandPublishedVersionRequest, UpdateBrandPublishedVersionResponse } from "../models/models_4"; +import { + de_UpdateBrandPublishedVersionCommand, + se_UpdateBrandPublishedVersionCommand, +} from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateBrandPublishedVersionCommand}. + */ +export interface UpdateBrandPublishedVersionCommandInput extends UpdateBrandPublishedVersionRequest {} +/** + * @public + * + * The output of {@link UpdateBrandPublishedVersionCommand}. + */ +export interface UpdateBrandPublishedVersionCommandOutput + extends UpdateBrandPublishedVersionResponse, + __MetadataBearer {} + +/** + *

Updates the published version of a brand.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateBrandPublishedVersionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateBrandPublishedVersionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // UpdateBrandPublishedVersionRequest + * AwsAccountId: "STRING_VALUE", // required + * BrandId: "STRING_VALUE", // required + * VersionId: "STRING_VALUE", // required + * }; + * const command = new UpdateBrandPublishedVersionCommand(input); + * const response = await client.send(command); + * // { // UpdateBrandPublishedVersionResponse + * // RequestId: "STRING_VALUE", + * // VersionId: "STRING_VALUE", + * // }; + * + * ``` + * + * @param UpdateBrandPublishedVersionCommandInput - {@link UpdateBrandPublishedVersionCommandInput} + * @returns {@link UpdateBrandPublishedVersionCommandOutput} + * @see {@link UpdateBrandPublishedVersionCommandInput} for command's `input` shape. + * @see {@link UpdateBrandPublishedVersionCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.

+ * + * @throws {@link ConflictException} (client fault) + *

Updating or deleting a resource can cause an inconsistent state.

+ * + * @throws {@link InternalServerException} (server fault) + *

An internal service exception.

+ * + * @throws {@link InvalidRequestException} (client fault) + *

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

One or more resources can't be found.

+ * + * @throws {@link ThrottlingException} (client fault) + *

Access is throttled.

+ * + * @throws {@link QuickSightServiceException} + *

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class UpdateBrandPublishedVersionCommand extends $Command + .classBuilder< + UpdateBrandPublishedVersionCommandInput, + UpdateBrandPublishedVersionCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "UpdateBrandPublishedVersion", {}) + .n("QuickSightClient", "UpdateBrandPublishedVersionCommand") + .f(void 0, void 0) + .ser(se_UpdateBrandPublishedVersionCommand) + .de(de_UpdateBrandPublishedVersionCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateBrandPublishedVersionRequest; + output: UpdateBrandPublishedVersionResponse; + }; + sdk: { + input: UpdateBrandPublishedVersionCommandInput; + output: UpdateBrandPublishedVersionCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/UpdateCustomPermissionsCommand.ts b/clients/client-quicksight/src/commands/UpdateCustomPermissionsCommand.ts new file mode 100644 index 000000000000..045b9dc81af7 --- /dev/null +++ b/clients/client-quicksight/src/commands/UpdateCustomPermissionsCommand.ts @@ -0,0 +1,141 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateCustomPermissionsRequest, UpdateCustomPermissionsResponse } from "../models/models_4"; +import { de_UpdateCustomPermissionsCommand, se_UpdateCustomPermissionsCommand } from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateCustomPermissionsCommand}. + */ +export interface UpdateCustomPermissionsCommandInput extends UpdateCustomPermissionsRequest {} +/** + * @public + * + * The output of {@link UpdateCustomPermissionsCommand}. + */ +export interface UpdateCustomPermissionsCommandOutput extends UpdateCustomPermissionsResponse, __MetadataBearer {} + +/** + *

Updates a custom permissions profile.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateCustomPermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateCustomPermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // UpdateCustomPermissionsRequest + * AwsAccountId: "STRING_VALUE", // required + * CustomPermissionsName: "STRING_VALUE", // required + * Capabilities: { // Capabilities + * ExportToCsv: "DENY", + * ExportToExcel: "DENY", + * CreateAndUpdateThemes: "DENY", + * AddOrRunAnomalyDetectionForAnalyses: "DENY", + * ShareAnalyses: "DENY", + * CreateAndUpdateDatasets: "DENY", + * ShareDatasets: "DENY", + * SubscribeDashboardEmailReports: "DENY", + * CreateAndUpdateDashboardEmailReports: "DENY", + * ShareDashboards: "DENY", + * CreateAndUpdateThresholdAlerts: "DENY", + * RenameSharedFolders: "DENY", + * CreateSharedFolders: "DENY", + * CreateAndUpdateDataSources: "DENY", + * ShareDataSources: "DENY", + * ViewAccountSPICECapacity: "DENY", + * CreateSPICEDataset: "DENY", + * }, + * }; + * const command = new UpdateCustomPermissionsCommand(input); + * const response = await client.send(command); + * // { // UpdateCustomPermissionsResponse + * // Status: Number("int"), + * // Arn: "STRING_VALUE", + * // RequestId: "STRING_VALUE", + * // }; + * + * ``` + * + * @param UpdateCustomPermissionsCommandInput - {@link UpdateCustomPermissionsCommandInput} + * @returns {@link UpdateCustomPermissionsCommandOutput} + * @see {@link UpdateCustomPermissionsCommandInput} for command's `input` shape. + * @see {@link UpdateCustomPermissionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.

+ * + * @throws {@link ConflictException} (client fault) + *

Updating or deleting a resource can cause an inconsistent state.

+ * + * @throws {@link InternalFailureException} (server fault) + *

An internal failure occurred.

+ * + * @throws {@link InvalidParameterValueException} (client fault) + *

One or more parameters has a value that isn't valid.

+ * + * @throws {@link PreconditionNotMetException} (client fault) + *

One or more preconditions aren't met.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

One or more resources can't be found.

+ * + * @throws {@link ResourceUnavailableException} (server fault) + *

This resource is currently unavailable.

+ * + * @throws {@link ThrottlingException} (client fault) + *

Access is throttled.

+ * + * @throws {@link QuickSightServiceException} + *

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class UpdateCustomPermissionsCommand extends $Command + .classBuilder< + UpdateCustomPermissionsCommandInput, + UpdateCustomPermissionsCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "UpdateCustomPermissions", {}) + .n("QuickSightClient", "UpdateCustomPermissionsCommand") + .f(void 0, void 0) + .ser(se_UpdateCustomPermissionsCommand) + .de(de_UpdateCustomPermissionsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateCustomPermissionsRequest; + output: UpdateCustomPermissionsResponse; + }; + sdk: { + input: UpdateCustomPermissionsCommandInput; + output: UpdateCustomPermissionsCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/UpdateUserCustomPermissionCommand.ts b/clients/client-quicksight/src/commands/UpdateUserCustomPermissionCommand.ts new file mode 100644 index 000000000000..4daa4a473dea --- /dev/null +++ b/clients/client-quicksight/src/commands/UpdateUserCustomPermissionCommand.ts @@ -0,0 +1,123 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateUserCustomPermissionRequest, UpdateUserCustomPermissionResponse } from "../models/models_4"; +import { de_UpdateUserCustomPermissionCommand, se_UpdateUserCustomPermissionCommand } from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateUserCustomPermissionCommand}. + */ +export interface UpdateUserCustomPermissionCommandInput extends UpdateUserCustomPermissionRequest {} +/** + * @public + * + * The output of {@link UpdateUserCustomPermissionCommand}. + */ +export interface UpdateUserCustomPermissionCommandOutput extends UpdateUserCustomPermissionResponse, __MetadataBearer {} + +/** + *

Updates a custom permissions profile for a user.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateUserCustomPermissionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateUserCustomPermissionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // UpdateUserCustomPermissionRequest + * UserName: "STRING_VALUE", // required + * AwsAccountId: "STRING_VALUE", // required + * Namespace: "STRING_VALUE", // required + * CustomPermissionsName: "STRING_VALUE", // required + * }; + * const command = new UpdateUserCustomPermissionCommand(input); + * const response = await client.send(command); + * // { // UpdateUserCustomPermissionResponse + * // RequestId: "STRING_VALUE", + * // Status: Number("int"), + * // }; + * + * ``` + * + * @param UpdateUserCustomPermissionCommandInput - {@link UpdateUserCustomPermissionCommandInput} + * @returns {@link UpdateUserCustomPermissionCommandOutput} + * @see {@link UpdateUserCustomPermissionCommandInput} for command's `input` shape. + * @see {@link UpdateUserCustomPermissionCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.

+ * + * @throws {@link ConflictException} (client fault) + *

Updating or deleting a resource can cause an inconsistent state.

+ * + * @throws {@link InternalFailureException} (server fault) + *

An internal failure occurred.

+ * + * @throws {@link InvalidParameterValueException} (client fault) + *

One or more parameters has a value that isn't valid.

+ * + * @throws {@link PreconditionNotMetException} (client fault) + *

One or more preconditions aren't met.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

One or more resources can't be found.

+ * + * @throws {@link ResourceUnavailableException} (server fault) + *

This resource is currently unavailable.

+ * + * @throws {@link ThrottlingException} (client fault) + *

Access is throttled.

+ * + * @throws {@link QuickSightServiceException} + *

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class UpdateUserCustomPermissionCommand extends $Command + .classBuilder< + UpdateUserCustomPermissionCommandInput, + UpdateUserCustomPermissionCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "UpdateUserCustomPermission", {}) + .n("QuickSightClient", "UpdateUserCustomPermissionCommand") + .f(void 0, void 0) + .ser(se_UpdateUserCustomPermissionCommand) + .de(de_UpdateUserCustomPermissionCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateUserCustomPermissionRequest; + output: UpdateUserCustomPermissionResponse; + }; + sdk: { + input: UpdateUserCustomPermissionCommandInput; + output: UpdateUserCustomPermissionCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/index.ts b/clients/client-quicksight/src/commands/index.ts index 0ebc4aa2e6a3..658430b64097 100644 --- a/clients/client-quicksight/src/commands/index.ts +++ b/clients/client-quicksight/src/commands/index.ts @@ -5,6 +5,8 @@ export * from "./CancelIngestionCommand"; export * from "./CreateAccountCustomizationCommand"; export * from "./CreateAccountSubscriptionCommand"; export * from "./CreateAnalysisCommand"; +export * from "./CreateBrandCommand"; +export * from "./CreateCustomPermissionsCommand"; export * from "./CreateDashboardCommand"; export * from "./CreateDataSetCommand"; export * from "./CreateDataSourceCommand"; @@ -27,6 +29,9 @@ export * from "./CreateVPCConnectionCommand"; export * from "./DeleteAccountCustomizationCommand"; export * from "./DeleteAccountSubscriptionCommand"; export * from "./DeleteAnalysisCommand"; +export * from "./DeleteBrandAssignmentCommand"; +export * from "./DeleteBrandCommand"; +export * from "./DeleteCustomPermissionsCommand"; export * from "./DeleteDashboardCommand"; export * from "./DeleteDataSetCommand"; export * from "./DeleteDataSetRefreshPropertiesCommand"; @@ -49,6 +54,7 @@ export * from "./DeleteTopicCommand"; export * from "./DeleteTopicRefreshScheduleCommand"; export * from "./DeleteUserByPrincipalIdCommand"; export * from "./DeleteUserCommand"; +export * from "./DeleteUserCustomPermissionCommand"; export * from "./DeleteVPCConnectionCommand"; export * from "./DescribeAccountCustomizationCommand"; export * from "./DescribeAccountSettingsCommand"; @@ -58,6 +64,10 @@ export * from "./DescribeAnalysisDefinitionCommand"; export * from "./DescribeAnalysisPermissionsCommand"; export * from "./DescribeAssetBundleExportJobCommand"; export * from "./DescribeAssetBundleImportJobCommand"; +export * from "./DescribeBrandAssignmentCommand"; +export * from "./DescribeBrandCommand"; +export * from "./DescribeBrandPublishedVersionCommand"; +export * from "./DescribeCustomPermissionsCommand"; export * from "./DescribeDashboardCommand"; export * from "./DescribeDashboardDefinitionCommand"; export * from "./DescribeDashboardPermissionsCommand"; @@ -101,6 +111,8 @@ export * from "./GetSessionEmbedUrlCommand"; export * from "./ListAnalysesCommand"; export * from "./ListAssetBundleExportJobsCommand"; export * from "./ListAssetBundleImportJobsCommand"; +export * from "./ListBrandsCommand"; +export * from "./ListCustomPermissionsCommand"; export * from "./ListDashboardVersionsCommand"; export * from "./ListDashboardsCommand"; export * from "./ListDataSetsCommand"; @@ -149,6 +161,10 @@ export * from "./UpdateAccountCustomizationCommand"; export * from "./UpdateAccountSettingsCommand"; export * from "./UpdateAnalysisCommand"; export * from "./UpdateAnalysisPermissionsCommand"; +export * from "./UpdateBrandAssignmentCommand"; +export * from "./UpdateBrandCommand"; +export * from "./UpdateBrandPublishedVersionCommand"; +export * from "./UpdateCustomPermissionsCommand"; export * from "./UpdateDashboardCommand"; export * from "./UpdateDashboardLinksCommand"; export * from "./UpdateDashboardPermissionsCommand"; @@ -179,4 +195,5 @@ export * from "./UpdateTopicCommand"; export * from "./UpdateTopicPermissionsCommand"; export * from "./UpdateTopicRefreshScheduleCommand"; export * from "./UpdateUserCommand"; +export * from "./UpdateUserCustomPermissionCommand"; export * from "./UpdateVPCConnectionCommand"; diff --git a/clients/client-quicksight/src/models/models_2.ts b/clients/client-quicksight/src/models/models_2.ts index 2ca43f6a00f1..7a38b90aea9f 100644 --- a/clients/client-quicksight/src/models/models_2.ts +++ b/clients/client-quicksight/src/models/models_2.ts @@ -1581,6 +1581,132 @@ export interface AnonymousUserSnapshotJobResult { FileGroups?: SnapshotJobResultFileGroup[] | undefined; } +/** + *

The color palette.

+ * @public + */ +export interface Palette { + /** + *

The foreground color.

+ * @public + */ + Foreground?: string | undefined; + + /** + *

The background color.

+ * @public + */ + Background?: string | undefined; +} + +/** + *

The color palette.

+ * @public + */ +export interface BrandColorPalette { + /** + *

The primary color.

+ * @public + */ + Primary?: Palette | undefined; + + /** + *

The secondary color.

+ * @public + */ + Secondary?: Palette | undefined; + + /** + *

The color that is used for accent elements.

+ * @public + */ + Accent?: Palette | undefined; + + /** + *

The color that is used for measure elements.

+ * @public + */ + Measure?: Palette | undefined; + + /** + *

The color that is used for dimension elements.

+ * @public + */ + Dimension?: Palette | undefined; + + /** + *

The color that is used for success elements.

+ * @public + */ + Success?: Palette | undefined; + + /** + *

The color that is used for info elements.

+ * @public + */ + Info?: Palette | undefined; + + /** + *

The color that is used for warning elements.

+ * @public + */ + Warning?: Palette | undefined; + + /** + *

The color that is used for danger elements.

+ * @public + */ + Danger?: Palette | undefined; +} + +/** + *

The navigation bar style.

+ * @public + */ +export interface NavbarStyle { + /** + *

The global navigation bar style.

+ * @public + */ + GlobalNavbar?: Palette | undefined; + + /** + *

The contextual navigation bar style.

+ * @public + */ + ContextualNavbar?: Palette | undefined; +} + +/** + *

The element style.

+ * @public + */ +export interface BrandElementStyle { + /** + *

The navigation bar style.

+ * @public + */ + NavbarStyle?: NavbarStyle | undefined; +} + +/** + *

The application theme.

+ * @public + */ +export interface ApplicationTheme { + /** + *

The color palette.

+ * @public + */ + BrandColorPalette?: BrandColorPalette | undefined; + + /** + *

The element style.

+ * @public + */ + BrandElementStyle?: BrandElementStyle | undefined; +} + /** * @public * @enum @@ -5909,591 +6035,429 @@ export interface BorderStyle { } /** - *

A calculated column for a dataset.

+ *

The source of the image.

* @public */ -export interface CalculatedColumn { +export type ImageSource = ImageSource.PublicUrlMember | ImageSource.S3UriMember | ImageSource.$UnknownMember; + +/** + * @public + */ +export namespace ImageSource { /** - *

Column name.

+ *

The public URL that points to the source image.

* @public */ - ColumnName: string | undefined; + export interface PublicUrlMember { + PublicUrl: string; + S3Uri?: never; + $unknown?: never; + } /** - *

A unique ID to identify a calculated column. During a dataset update, if the column ID - * of a calculated column matches that of an existing calculated column, Amazon QuickSight - * preserves the existing calculated column.

+ *

The Amazon S3 URI that points to the source image.

* @public */ - ColumnId: string | undefined; + export interface S3UriMember { + PublicUrl?: never; + S3Uri: string; + $unknown?: never; + } /** - *

An expression that defines the calculated column.

* @public */ - Expression: string | undefined; + export interface $UnknownMember { + PublicUrl?: never; + S3Uri?: never; + $unknown: [string, any]; + } + + export interface Visitor { + PublicUrl: (value: string) => T; + S3Uri: (value: string) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: ImageSource, visitor: Visitor): T => { + if (value.PublicUrl !== undefined) return visitor.PublicUrl(value.PublicUrl); + if (value.S3Uri !== undefined) return visitor.S3Uri(value.S3Uri); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** + *

The logo image configuration.

* @public */ -export interface CancelIngestionRequest { - /** - *

The Amazon Web Services account ID.

- * @public - */ - AwsAccountId: string | undefined; - +export interface ImageConfiguration { /** - *

The ID of the dataset used in the ingestion.

+ *

The source of the image.

* @public */ - DataSetId: string | undefined; + Source?: ImageSource | undefined; +} +/** + *

The image set configuration.

+ * @public + */ +export interface ImageSetConfiguration { /** - *

An ID for the ingestion.

+ *

The original image.

* @public */ - IngestionId: string | undefined; + Original: ImageConfiguration | undefined; } /** + *

The logo set configuration.

* @public */ -export interface CancelIngestionResponse { +export interface LogoSetConfiguration { /** - *

The Amazon Resource Name (ARN) for the data ingestion.

+ *

The primary logo.

* @public */ - Arn?: string | undefined; + Primary: ImageSetConfiguration | undefined; /** - *

An ID for the ingestion.

+ *

The favicon logo.

* @public */ - IngestionId?: string | undefined; + Favicon?: ImageSetConfiguration | undefined; +} +/** + *

The logo configuration.

+ * @public + */ +export interface LogoConfiguration { /** - *

The Amazon Web Services request ID for this operation.

+ *

The alt text for the logo.

* @public */ - RequestId?: string | undefined; + AltText: string | undefined; /** - *

The HTTP status of the request.

+ *

A set of configured logos.

* @public */ - Status?: number | undefined; + LogoSet: LogoSetConfiguration | undefined; } /** - *

The resource specified already exists.

+ *

The definition of the brand.

* @public */ -export class ResourceExistsException extends __BaseException { - readonly name: "ResourceExistsException" = "ResourceExistsException"; - readonly $fault: "client" = "client"; - Message?: string | undefined; +export interface BrandDefinition { /** - *

The resource type for this request.

+ *

The name of the brand.

* @public */ - ResourceType?: ExceptionResourceType | undefined; + BrandName: string | undefined; /** - *

The Amazon Web Services request ID for this request.

+ *

The description of the brand.

* @public */ - RequestId?: string | undefined; + Description?: string | undefined; + /** - * @internal + *

The application theme of the brand.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "ResourceExistsException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, ResourceExistsException.prototype); - this.Message = opts.Message; - this.ResourceType = opts.ResourceType; - this.RequestId = opts.RequestId; - } + ApplicationTheme?: ApplicationTheme | undefined; + + /** + *

The logo configuration of the brand.

+ * @public + */ + LogoConfiguration?: LogoConfiguration | undefined; } /** * @public * @enum */ -export const ColumnDataType = { - DATETIME: "DATETIME", - DECIMAL: "DECIMAL", - INTEGER: "INTEGER", - STRING: "STRING", +export const BrandStatus = { + CREATE_FAILED: "CREATE_FAILED", + CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS", + CREATE_SUCCEEDED: "CREATE_SUCCEEDED", + DELETE_FAILED: "DELETE_FAILED", + DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS", } as const; /** * @public */ -export type ColumnDataType = (typeof ColumnDataType)[keyof typeof ColumnDataType]; - -/** - * @public - * @enum - */ -export const ColumnDataSubType = { - FIXED: "FIXED", - FLOAT: "FLOAT", -} as const; +export type BrandStatus = (typeof BrandStatus)[keyof typeof BrandStatus]; /** + *

The logo image.

* @public */ -export type ColumnDataSubType = (typeof ColumnDataSubType)[keyof typeof ColumnDataSubType]; +export interface Image { + /** + *

The source of the logo image.

+ * @public + */ + Source?: ImageSource | undefined; -/** - *

A transform operation that casts a column to a different type.

- * @public - */ -export interface CastColumnTypeOperation { /** - *

Column name.

+ *

The URL that points to the generated logo image.

* @public */ - ColumnName: string | undefined; + GeneratedImageUrl?: string | undefined; +} +/** + *

The image set.

+ * @public + */ +export interface ImageSet { /** - *

New column data type.

+ *

The original image.

* @public */ - NewColumnType: ColumnDataType | undefined; + Original: Image | undefined; /** - *

The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.

+ *

The image with the height set to 64 pixels.

* @public */ - SubType?: ColumnDataSubType | undefined; + Height64?: Image | undefined; /** - *

When casting a column from string to datetime type, you can supply a string in a - * format supported by Amazon QuickSight to denote the source data format.

+ *

The image with the height set to 32 pixels.

* @public */ - Format?: string | undefined; + Height32?: Image | undefined; } /** - * @public - * @enum - */ -export const CategoryFilterFunction = { - CONTAINS: "CONTAINS", - EXACT: "EXACT", -} as const; - -/** - * @public - */ -export type CategoryFilterFunction = (typeof CategoryFilterFunction)[keyof typeof CategoryFilterFunction]; - -/** - * @public - * @enum - */ -export const CategoryFilterType = { - CUSTOM_FILTER: "CUSTOM_FILTER", - CUSTOM_FILTER_LIST: "CUSTOM_FILTER_LIST", - FILTER_LIST: "FILTER_LIST", -} as const; - -/** - * @public - */ -export type CategoryFilterType = (typeof CategoryFilterType)[keyof typeof CategoryFilterType]; - -/** - *

A structure that represents the cell value synonym.

+ *

A set of logos.

* @public */ -export interface CellValueSynonym { +export interface LogoSet { /** - *

The cell value.

+ *

The primary logo.

* @public */ - CellValue?: string | undefined; + Primary: ImageSet | undefined; /** - *

Other names or aliases for the cell value.

+ *

The favicon logo.

* @public */ - Synonyms?: string[] | undefined; + Favicon?: ImageSet | undefined; } /** - *

A structure that represents a collective constant.

+ *

The logo configuration.

* @public */ -export interface CollectiveConstant { +export interface Logo { /** - *

A list of values for the collective constant.

+ *

The alt text for the logo.

* @public */ - ValueList?: string[] | undefined; + AltText: string | undefined; + + /** + *

A set of configured logos.

+ * @public + */ + LogoSet: LogoSet | undefined; } /** * @public * @enum */ -export const ColumnDataRole = { - DIMENSION: "DIMENSION", - MEASURE: "MEASURE", +export const BrandVersionStatus = { + CREATE_FAILED: "CREATE_FAILED", + CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS", + CREATE_SUCCEEDED: "CREATE_SUCCEEDED", } as const; /** * @public */ -export type ColumnDataRole = (typeof ColumnDataRole)[keyof typeof ColumnDataRole]; +export type BrandVersionStatus = (typeof BrandVersionStatus)[keyof typeof BrandVersionStatus]; /** - *

Metadata that contains a description for a column.

+ *

The details of the brand.

* @public */ -export interface ColumnDescription { +export interface BrandDetail { /** - *

The text of a description for a column.

+ *

The ID of the Amazon QuickSight brand.

* @public */ - Text?: string | undefined; -} - -/** - * @public - * @enum - */ -export const GeoSpatialCountryCode = { - US: "US", -} as const; + BrandId: string | undefined; -/** - * @public - */ -export type GeoSpatialCountryCode = (typeof GeoSpatialCountryCode)[keyof typeof GeoSpatialCountryCode]; + /** + *

The Amazon Resource Name (ARN) of the brand.

+ * @public + */ + Arn?: string | undefined; -/** - *

Geospatial column group that denotes a hierarchy.

- * @public - */ -export interface GeoSpatialColumnGroup { /** - *

A display name for the hierarchy.

+ *

The status of the brand.

* @public */ - Name: string | undefined; + BrandStatus?: BrandStatus | undefined; /** - *

Country code.

+ *

The time that the brand was created.

* @public */ - CountryCode?: GeoSpatialCountryCode | undefined; + CreatedTime?: Date | undefined; /** - *

Columns in this hierarchy.

+ *

The last time the brand was updated.

* @public */ - Columns: string[] | undefined; -} + LastUpdatedTime?: Date | undefined; -/** - *

Groupings of columns that work together in certain Amazon QuickSight features. This is - * a variant type structure. For this structure to be valid, only one of the attributes can - * be non-null.

- * @public - */ -export interface ColumnGroup { /** - *

Geospatial column group that denotes a hierarchy.

+ *

The ID of the version.

* @public */ - GeoSpatialColumnGroup?: GeoSpatialColumnGroup | undefined; -} + VersionId?: string | undefined; -/** - *

A structure describing the name, data type, and geographic role of the columns.

- * @public - */ -export interface ColumnGroupColumnSchema { /** - *

The name of the column group's column schema.

+ *

The status of the version.

* @public */ - Name?: string | undefined; -} + VersionStatus?: BrandVersionStatus | undefined; -/** - *

The column group schema.

- * @public - */ -export interface ColumnGroupSchema { /** - *

The name of the column group schema.

+ *

A list of errors that occurred during the most recent brand operation.

* @public */ - Name?: string | undefined; + Errors?: string[] | undefined; /** - *

A structure containing the list of schemas for column group columns.

+ *

The logo details.

* @public */ - ColumnGroupColumnSchemaList?: ColumnGroupColumnSchema[] | undefined; + Logo?: Logo | undefined; } /** - *

A rule defined to grant access on one or more restricted columns. - * Each dataset can have multiple rules. - * To create a restricted column, you add it to one or more rules. - * Each rule must contain at least one column and at least one user or group. - * To be able to see a restricted column, a user or group needs to be added - * to a rule for that column.

+ *

A summary of the brand.

* @public */ -export interface ColumnLevelPermissionRule { +export interface BrandSummary { /** - *

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

+ *

The Amazon Resource Name (ARN) of the brand.

* @public */ - Principals?: string[] | undefined; + Arn?: string | undefined; /** - *

An array of column names.

+ *

The ID of the Amazon QuickSight brand.

* @public */ - ColumnNames?: string[] | undefined; -} - -/** - * @public - * @enum - */ -export const ColumnOrderingType = { - GREATER_IS_BETTER: "GREATER_IS_BETTER", - LESSER_IS_BETTER: "LESSER_IS_BETTER", - SPECIFIED: "SPECIFIED", -} as const; - -/** - * @public - */ -export type ColumnOrderingType = (typeof ColumnOrderingType)[keyof typeof ColumnOrderingType]; + BrandId?: string | undefined; -/** - *

The column schema.

- * @public - */ -export interface ColumnSchema { /** - *

The name of the column schema.

+ *

The name of the brand.

* @public */ - Name?: string | undefined; + BrandName?: string | undefined; /** - *

The data type of the column schema.

+ *

The description of the brand.

* @public */ - DataType?: string | undefined; + Description?: string | undefined; /** - *

The geographic role of the column schema.

+ *

The status of the brand.

* @public */ - GeographicRole?: string | undefined; -} - -/** - * @public - * @enum - */ -export const GeoSpatialDataRole = { - CITY: "CITY", - COUNTRY: "COUNTRY", - COUNTY: "COUNTY", - LATITUDE: "LATITUDE", - LONGITUDE: "LONGITUDE", - POSTCODE: "POSTCODE", - STATE: "STATE", -} as const; - -/** - * @public - */ -export type GeoSpatialDataRole = (typeof GeoSpatialDataRole)[keyof typeof GeoSpatialDataRole]; + BrandStatus?: BrandStatus | undefined; -/** - *

A tag for a column in a - * - * TagColumnOperation - * - * structure. This is a - * variant type structure. For this structure to be valid, only one of the attributes can - * be non-null.

- * @public - */ -export interface ColumnTag { /** - *

A geospatial role for a column.

+ *

The time that the brand was created.

* @public */ - ColumnGeographicRole?: GeoSpatialDataRole | undefined; + CreatedTime?: Date | undefined; /** - *

A description for a column.

+ *

The time when the brand was last updated.

* @public */ - ColumnDescription?: ColumnDescription | undefined; + LastUpdatedTime?: Date | undefined; } /** - * @public - * @enum - */ -export const ColumnTagName = { - COLUMN_DESCRIPTION: "COLUMN_DESCRIPTION", - COLUMN_GEOGRAPHIC_ROLE: "COLUMN_GEOGRAPHIC_ROLE", -} as const; - -/** - * @public - */ -export type ColumnTagName = (typeof ColumnTagName)[keyof typeof ColumnTagName]; - -/** - * @public - * @enum - */ -export const UndefinedSpecifiedValueType = { - LEAST: "LEAST", - MOST: "MOST", -} as const; - -/** - * @public - */ -export type UndefinedSpecifiedValueType = - (typeof UndefinedSpecifiedValueType)[keyof typeof UndefinedSpecifiedValueType]; - -/** - *

A structure that represents a comparative order.

+ *

A calculated column for a dataset.

* @public */ -export interface ComparativeOrder { +export interface CalculatedColumn { /** - *

The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.

+ *

Column name.

* @public */ - UseOrdering?: ColumnOrderingType | undefined; + ColumnName: string | undefined; /** - *

The list of columns to be used in the ordering.

+ *

A unique ID to identify a calculated column. During a dataset update, if the column ID + * of a calculated column matches that of an existing calculated column, Amazon QuickSight + * preserves the existing calculated column.

* @public */ - SpecifedOrder?: string[] | undefined; + ColumnId: string | undefined; /** - *

The treat of undefined specified values. Valid values for this structure are LEAST and MOST.

+ *

An expression that defines the calculated column.

* @public */ - TreatUndefinedSpecifiedValues?: UndefinedSpecifiedValueType | undefined; -} - -/** - *

A resource is already in a state that indicates an operation is happening that must complete - * before a new update can be applied.

- * @public - */ -export class ConcurrentUpdatingException extends __BaseException { - readonly name: "ConcurrentUpdatingException" = "ConcurrentUpdatingException"; - readonly $fault: "server" = "server"; - Message?: string | undefined; - RequestId?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "ConcurrentUpdatingException", - $fault: "server", - ...opts, - }); - Object.setPrototypeOf(this, ConcurrentUpdatingException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } + Expression: string | undefined; } /** * @public */ -export interface CreateAccountCustomizationRequest { +export interface CancelIngestionRequest { /** - *

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

+ *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** - *

The Amazon QuickSight namespace that you want to add customizations to.

- * @public - */ - Namespace?: string | undefined; - - /** - *

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add - * these to an Amazon Web Services account and a QuickSight namespace.

- *

For example, you can add a default theme by setting AccountCustomization - * to the midnight theme: "AccountCustomization": \{ "DefaultTheme": - * "arn:aws:quicksight::aws:theme/MIDNIGHT" \}. Or, you can add a custom theme by - * specifying "AccountCustomization": \{ "DefaultTheme": - * "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" - * \}.

+ *

The ID of the dataset used in the ingestion.

* @public */ - AccountCustomization: AccountCustomization | undefined; + DataSetId: string | undefined; /** - *

A list of the tags that you want to attach to this resource.

+ *

An ID for the ingestion.

* @public */ - Tags?: Tag[] | undefined; + IngestionId: string | undefined; } /** * @public */ -export interface CreateAccountCustomizationResponse { +export interface CancelIngestionResponse { /** - *

The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.

+ *

The Amazon Resource Name (ARN) for the data ingestion.

* @public */ Arn?: string | undefined; /** - *

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

- * @public - */ - AwsAccountId?: string | undefined; - - /** - *

The namespace associated with the customization you're creating.

- * @public - */ - Namespace?: string | undefined; - - /** - *

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.

+ *

An ID for the ingestion.

* @public */ - AccountCustomization?: AccountCustomization | undefined; + IngestionId?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -6509,12 +6473,12 @@ export interface CreateAccountCustomizationResponse { } /** - *

This resource is currently unavailable.

+ *

The resource specified already exists.

* @public */ -export class ResourceUnavailableException extends __BaseException { - readonly name: "ResourceUnavailableException" = "ResourceUnavailableException"; - readonly $fault: "server" = "server"; +export class ResourceExistsException extends __BaseException { + readonly name: "ResourceExistsException" = "ResourceExistsException"; + readonly $fault: "client" = "client"; Message?: string | undefined; /** *

The resource type for this request.

@@ -6530,13 +6494,13 @@ export class ResourceUnavailableException extends __BaseException { /** * @internal */ - constructor(opts: __ExceptionOptionType) { + constructor(opts: __ExceptionOptionType) { super({ - name: "ResourceUnavailableException", - $fault: "server", + name: "ResourceExistsException", + $fault: "client", ...opts, }); - Object.setPrototypeOf(this, ResourceUnavailableException.prototype); + Object.setPrototypeOf(this, ResourceExistsException.prototype); this.Message = opts.Message; this.ResourceType = opts.ResourceType; this.RequestId = opts.RequestId; @@ -6545,2135 +6509,2123 @@ export class ResourceUnavailableException extends __BaseException { /** * @public + * @enum */ -export interface CreateAccountSubscriptionRequest { - /** - *

The edition of Amazon QuickSight that you want your account to have. Currently, you can - * choose from ENTERPRISE or - * ENTERPRISE_AND_Q.

- *

If you choose ENTERPRISE_AND_Q, the following parameters are - * required:

- *
    - *
  • - *

    - * FirstName - *

    - *
  • - *
  • - *

    - * LastName - *

    - *
  • - *
  • - *

    - * EmailAddress - *

    - *
  • - *
  • - *

    - * ContactNumber - *

    - *
  • - *
- * @public - */ - Edition?: Edition | undefined; +export const CapabilityState = { + DENY: "DENY", +} as const; - /** - *

The method that you want to use to authenticate your Amazon QuickSight account.

- *

If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName - * and an AdminGroup associated with your Active Directory.

- *

If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

- * @public - */ - AuthenticationMethod: AuthenticationMethodOption | undefined; +/** + * @public + */ +export type CapabilityState = (typeof CapabilityState)[keyof typeof CapabilityState]; +/** + *

A set of actions that correspond to Amazon QuickSight permissions.

+ * @public + */ +export interface Capabilities { /** - *

The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.

+ *

The ability to export to CSV files.

* @public */ - AwsAccountId: string | undefined; + ExportToCsv?: CapabilityState | undefined; /** - *

The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change - * AccountName value after the Amazon QuickSight account is - * created.

+ *

The ability to export to Excel files.

* @public */ - AccountName: string | undefined; + ExportToExcel?: CapabilityState | undefined; /** - *

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

+ *

The ability to export to Create and Update themes.

* @public */ - NotificationEmail: string | undefined; + CreateAndUpdateThemes?: CapabilityState | undefined; /** - *

The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

+ *

The ability to add or run anomaly detection.

* @public */ - ActiveDirectoryName?: string | undefined; + AddOrRunAnomalyDetectionForAnalyses?: CapabilityState | undefined; /** - *

The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

+ *

The ability to share analyses.

* @public */ - Realm?: string | undefined; + ShareAnalyses?: CapabilityState | undefined; /** - *

The ID of the Active Directory that is associated with your Amazon QuickSight account.

+ *

The ability to create and update datasets.

* @public */ - DirectoryId?: string | undefined; + CreateAndUpdateDatasets?: CapabilityState | undefined; /** - *

The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

- *

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

+ *

The ability to share datasets.

* @public */ - AdminGroup?: string[] | undefined; + ShareDatasets?: CapabilityState | undefined; /** - *

The author group associated with your Active Directory or IAM Identity Center account.

- *

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

+ *

The ability to subscribe to email reports.

* @public */ - AuthorGroup?: string[] | undefined; + SubscribeDashboardEmailReports?: CapabilityState | undefined; /** - *

The reader group associated with your Active Directory or IAM Identity Center account.

- *

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

+ *

The ability to create and update email reports.

* @public */ - ReaderGroup?: string[] | undefined; + CreateAndUpdateDashboardEmailReports?: CapabilityState | undefined; /** - *

The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

- *

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

+ *

The ability to share dashboards.

* @public */ - AdminProGroup?: string[] | undefined; + ShareDashboards?: CapabilityState | undefined; /** - *

The author pro group associated with your Active Directory or IAM Identity Center account.

- *

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

+ *

The ability to create and update threshold alerts.

* @public */ - AuthorProGroup?: string[] | undefined; + CreateAndUpdateThresholdAlerts?: CapabilityState | undefined; /** - *

The reader pro group associated with your Active Directory or IAM Identity Center account.

- *

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

+ *

The ability to rename shared folders.

* @public */ - ReaderProGroup?: string[] | undefined; + RenameSharedFolders?: CapabilityState | undefined; /** - *

The first name of the author of the Amazon QuickSight account to use for future - * communications. This field is required if ENTERPPRISE_AND_Q is the selected - * edition of the new Amazon QuickSight account.

+ *

The ability to create shared folders.

* @public */ - FirstName?: string | undefined; + CreateSharedFolders?: CapabilityState | undefined; /** - *

The last name of the author of the Amazon QuickSight account to use for future - * communications. This field is required if ENTERPPRISE_AND_Q is the selected - * edition of the new Amazon QuickSight account.

+ *

The ability to create and update data sources.

* @public */ - LastName?: string | undefined; + CreateAndUpdateDataSources?: CapabilityState | undefined; /** - *

The email address of the author of the Amazon QuickSight account to use for future - * communications. This field is required if ENTERPPRISE_AND_Q is the selected - * edition of the new Amazon QuickSight account.

+ *

The ability to share data sources.

* @public */ - EmailAddress?: string | undefined; + ShareDataSources?: CapabilityState | undefined; /** - *

A 10-digit phone number for the author of the Amazon QuickSight account to use for - * future communications. This field is required if ENTERPPRISE_AND_Q is the - * selected edition of the new Amazon QuickSight account.

+ *

The ability to view account SPICE capacity.

* @public */ - ContactNumber?: string | undefined; + ViewAccountSPICECapacity?: CapabilityState | undefined; /** - *

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

+ *

The ability to create a SPICE dataset.

* @public */ - IAMIdentityCenterInstanceArn?: string | undefined; + CreateSPICEDataset?: CapabilityState | undefined; } /** - *

A SignupResponse object that contains a summary of a newly created account.

+ * @public + * @enum + */ +export const ColumnDataType = { + DATETIME: "DATETIME", + DECIMAL: "DECIMAL", + INTEGER: "INTEGER", + STRING: "STRING", +} as const; + +/** * @public */ -export interface SignupResponse { +export type ColumnDataType = (typeof ColumnDataType)[keyof typeof ColumnDataType]; + +/** + * @public + * @enum + */ +export const ColumnDataSubType = { + FIXED: "FIXED", + FLOAT: "FLOAT", +} as const; + +/** + * @public + */ +export type ColumnDataSubType = (typeof ColumnDataSubType)[keyof typeof ColumnDataSubType]; + +/** + *

A transform operation that casts a column to a different type.

+ * @public + */ +export interface CastColumnTypeOperation { /** - *

A Boolean that is TRUE if the Amazon QuickSight uses IAM as an - * authentication method.

+ *

Column name.

* @public */ - IAMUser?: boolean | undefined; + ColumnName: string | undefined; /** - *

The user login name for your Amazon QuickSight account.

+ *

New column data type.

* @public */ - userLoginName?: string | undefined; + NewColumnType: ColumnDataType | undefined; /** - *

The name of your Amazon QuickSight account.

+ *

The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.

* @public */ - accountName?: string | undefined; + SubType?: ColumnDataSubType | undefined; /** - *

The type of Active Directory that is being used to authenticate the Amazon QuickSight - * account. Valid values are SIMPLE_AD, AD_CONNECTOR, and - * MICROSOFT_AD.

+ *

When casting a column from string to datetime type, you can supply a string in a + * format supported by Amazon QuickSight to denote the source data format.

* @public */ - directoryType?: string | undefined; + Format?: string | undefined; } /** * @public + * @enum */ -export interface CreateAccountSubscriptionResponse { - /** - *

A SignupResponse object that returns information about a newly created Amazon QuickSight account.

- * @public - */ - SignupResponse?: SignupResponse | undefined; +export const CategoryFilterFunction = { + CONTAINS: "CONTAINS", + EXACT: "EXACT", +} as const; - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; +/** + * @public + */ +export type CategoryFilterFunction = (typeof CategoryFilterFunction)[keyof typeof CategoryFilterFunction]; - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; -} +/** + * @public + * @enum + */ +export const CategoryFilterType = { + CUSTOM_FILTER: "CUSTOM_FILTER", + CUSTOM_FILTER_LIST: "CUSTOM_FILTER_LIST", + FILTER_LIST: "FILTER_LIST", +} as const; /** - *

One or more preconditions aren't met.

* @public */ -export class PreconditionNotMetException extends __BaseException { - readonly name: "PreconditionNotMetException" = "PreconditionNotMetException"; - readonly $fault: "client" = "client"; - Message?: string | undefined; - /** - *

The Amazon Web Services request ID for this request.

- * @public - */ - RequestId?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "PreconditionNotMetException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, PreconditionNotMetException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } -} +export type CategoryFilterType = (typeof CategoryFilterType)[keyof typeof CategoryFilterType]; /** - *

A date-time parameter.

+ *

A structure that represents the cell value synonym.

* @public */ -export interface DateTimeParameter { +export interface CellValueSynonym { /** - *

A display name for the date-time parameter.

+ *

The cell value.

* @public */ - Name: string | undefined; + CellValue?: string | undefined; /** - *

The values for the date-time parameter.

+ *

Other names or aliases for the cell value.

* @public */ - Values: Date[] | undefined; + Synonyms?: string[] | undefined; } /** - *

A decimal parameter.

+ *

A structure that represents a collective constant.

* @public */ -export interface DecimalParameter { - /** - *

A display name for the decimal parameter.

- * @public - */ - Name: string | undefined; - +export interface CollectiveConstant { /** - *

The values for the decimal parameter.

+ *

A list of values for the collective constant.

* @public */ - Values: number[] | undefined; + ValueList?: string[] | undefined; } /** - *

An integer parameter.

* @public + * @enum */ -export interface IntegerParameter { - /** - *

The name of the integer parameter.

- * @public +export const ColumnDataRole = { + DIMENSION: "DIMENSION", + MEASURE: "MEASURE", +} as const; + +/** + * @public + */ +export type ColumnDataRole = (typeof ColumnDataRole)[keyof typeof ColumnDataRole]; + +/** + *

Metadata that contains a description for a column.

+ * @public + */ +export interface ColumnDescription { + /** + *

The text of a description for a column.

+ * @public + */ + Text?: string | undefined; +} + +/** + * @public + * @enum + */ +export const GeoSpatialCountryCode = { + US: "US", +} as const; + +/** + * @public + */ +export type GeoSpatialCountryCode = (typeof GeoSpatialCountryCode)[keyof typeof GeoSpatialCountryCode]; + +/** + *

Geospatial column group that denotes a hierarchy.

+ * @public + */ +export interface GeoSpatialColumnGroup { + /** + *

A display name for the hierarchy.

+ * @public */ Name: string | undefined; /** - *

The values for the integer parameter.

+ *

Country code.

* @public */ - Values: number[] | undefined; + CountryCode?: GeoSpatialCountryCode | undefined; + + /** + *

Columns in this hierarchy.

+ * @public + */ + Columns: string[] | undefined; } /** - *

A string parameter.

+ *

Groupings of columns that work together in certain Amazon QuickSight features. This is + * a variant type structure. For this structure to be valid, only one of the attributes can + * be non-null.

* @public */ -export interface StringParameter { +export interface ColumnGroup { /** - *

A display name for a string parameter.

+ *

Geospatial column group that denotes a hierarchy.

* @public */ - Name: string | undefined; + GeoSpatialColumnGroup?: GeoSpatialColumnGroup | undefined; +} +/** + *

A structure describing the name, data type, and geographic role of the columns.

+ * @public + */ +export interface ColumnGroupColumnSchema { /** - *

The values of a string parameter.

+ *

The name of the column group's column schema.

* @public */ - Values: string[] | undefined; + Name?: string | undefined; } /** - *

A list of Amazon QuickSight parameters and the list's override values.

+ *

The column group schema.

* @public */ -export interface _Parameters { +export interface ColumnGroupSchema { /** - *

The parameters that have a data type of string.

+ *

The name of the column group schema.

* @public */ - StringParameters?: StringParameter[] | undefined; + Name?: string | undefined; /** - *

The parameters that have a data type of integer.

+ *

A structure containing the list of schemas for column group columns.

* @public */ - IntegerParameters?: IntegerParameter[] | undefined; + ColumnGroupColumnSchemaList?: ColumnGroupColumnSchema[] | undefined; +} +/** + *

A rule defined to grant access on one or more restricted columns. + * Each dataset can have multiple rules. + * To create a restricted column, you add it to one or more rules. + * Each rule must contain at least one column and at least one user or group. + * To be able to see a restricted column, a user or group needs to be added + * to a rule for that column.

+ * @public + */ +export interface ColumnLevelPermissionRule { /** - *

The parameters that have a data type of decimal.

+ *

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

* @public */ - DecimalParameters?: DecimalParameter[] | undefined; + Principals?: string[] | undefined; /** - *

The parameters that have a data type of date-time.

+ *

An array of column names.

* @public */ - DateTimeParameters?: DateTimeParameter[] | undefined; + ColumnNames?: string[] | undefined; } /** - *

Permission for the resource.

* @public + * @enum */ -export interface ResourcePermission { +export const ColumnOrderingType = { + GREATER_IS_BETTER: "GREATER_IS_BETTER", + LESSER_IS_BETTER: "LESSER_IS_BETTER", + SPECIFIED: "SPECIFIED", +} as const; + +/** + * @public + */ +export type ColumnOrderingType = (typeof ColumnOrderingType)[keyof typeof ColumnOrderingType]; + +/** + *

The column schema.

+ * @public + */ +export interface ColumnSchema { /** - *

The Amazon Resource Name (ARN) of the principal. This can be one of the - * following:

- *
    - *
  • - *

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    - *
  • - *
  • - *

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    - *
  • - *
  • - *

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight - * ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. - * (This is less common.)

    - *
  • - *
+ *

The name of the column schema.

* @public */ - Principal: string | undefined; + Name?: string | undefined; /** - *

The IAM action to grant or revoke permissions on.

+ *

The data type of the column schema.

* @public */ - Actions: string[] | undefined; + DataType?: string | undefined; + + /** + *

The geographic role of the column schema.

+ * @public + */ + GeographicRole?: string | undefined; } /** * @public * @enum */ -export const ValidationStrategyMode = { - LENIENT: "LENIENT", - STRICT: "STRICT", +export const GeoSpatialDataRole = { + CITY: "CITY", + COUNTRY: "COUNTRY", + COUNTY: "COUNTY", + LATITUDE: "LATITUDE", + LONGITUDE: "LONGITUDE", + POSTCODE: "POSTCODE", + STATE: "STATE", } as const; /** * @public */ -export type ValidationStrategyMode = (typeof ValidationStrategyMode)[keyof typeof ValidationStrategyMode]; +export type GeoSpatialDataRole = (typeof GeoSpatialDataRole)[keyof typeof GeoSpatialDataRole]; /** - *

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

+ *

A tag for a column in a + * + * TagColumnOperation + * + * structure. This is a + * variant type structure. For this structure to be valid, only one of the attributes can + * be non-null.

* @public */ -export interface ValidationStrategy { +export interface ColumnTag { /** - *

The mode of validation for the asset to be created or updated. When you set this value to STRICT, strict validation for every error is enforced. When you set this value to LENIENT, validation is skipped for specific UI errors.

+ *

A geospatial role for a column.

* @public */ - Mode: ValidationStrategyMode | undefined; + ColumnGeographicRole?: GeoSpatialDataRole | undefined; + + /** + *

A description for a column.

+ * @public + */ + ColumnDescription?: ColumnDescription | undefined; } /** * @public + * @enum */ -export interface CreateAnalysisRequest { +export const ColumnTagName = { + COLUMN_DESCRIPTION: "COLUMN_DESCRIPTION", + COLUMN_GEOGRAPHIC_ROLE: "COLUMN_GEOGRAPHIC_ROLE", +} as const; + +/** + * @public + */ +export type ColumnTagName = (typeof ColumnTagName)[keyof typeof ColumnTagName]; + +/** + * @public + * @enum + */ +export const UndefinedSpecifiedValueType = { + LEAST: "LEAST", + MOST: "MOST", +} as const; + +/** + * @public + */ +export type UndefinedSpecifiedValueType = + (typeof UndefinedSpecifiedValueType)[keyof typeof UndefinedSpecifiedValueType]; + +/** + *

A structure that represents a comparative order.

+ * @public + */ +export interface ComparativeOrder { /** - *

The ID of the Amazon Web Services account where you are creating an analysis.

+ *

The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.

+ * @public + */ + UseOrdering?: ColumnOrderingType | undefined; + + /** + *

The list of columns to be used in the ordering.

+ * @public + */ + SpecifedOrder?: string[] | undefined; + + /** + *

The treat of undefined specified values. Valid values for this structure are LEAST and MOST.

+ * @public + */ + TreatUndefinedSpecifiedValues?: UndefinedSpecifiedValueType | undefined; +} + +/** + *

A resource is already in a state that indicates an operation is happening that must complete + * before a new update can be applied.

+ * @public + */ +export class ConcurrentUpdatingException extends __BaseException { + readonly name: "ConcurrentUpdatingException" = "ConcurrentUpdatingException"; + readonly $fault: "server" = "server"; + Message?: string | undefined; + RequestId?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType) { + super({ + name: "ConcurrentUpdatingException", + $fault: "server", + ...opts, + }); + Object.setPrototypeOf(this, ConcurrentUpdatingException.prototype); + this.Message = opts.Message; + this.RequestId = opts.RequestId; + } +} + +/** + * @public + */ +export interface CreateAccountCustomizationRequest { + /** + *

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the analysis that you're creating. This ID displays in the URL of the - * analysis.

+ *

The Amazon QuickSight namespace that you want to add customizations to.

* @public */ - AnalysisId: string | undefined; + Namespace?: string | undefined; /** - *

A descriptive name for the analysis that you're creating. This name displays for the - * analysis in the Amazon QuickSight console.

+ *

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add + * these to an Amazon Web Services account and a QuickSight namespace.

+ *

For example, you can add a default theme by setting AccountCustomization + * to the midnight theme: "AccountCustomization": \{ "DefaultTheme": + * "arn:aws:quicksight::aws:theme/MIDNIGHT" \}. Or, you can add a custom theme by + * specifying "AccountCustomization": \{ "DefaultTheme": + * "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" + * \}.

* @public */ - Name: string | undefined; + AccountCustomization: AccountCustomization | undefined; /** - *

The parameter names and override values that you want to use. An analysis can have - * any parameter type, and some parameters might accept multiple values.

+ *

A list of the tags that you want to attach to this resource.

* @public */ - Parameters?: _Parameters | undefined; + Tags?: Tag[] | undefined; +} +/** + * @public + */ +export interface CreateAccountCustomizationResponse { /** - *

A structure that describes the principals and the resource-level permissions on an - * analysis. You can use the Permissions structure to grant permissions by - * providing a list of Identity and Access Management (IAM) action information for each - * principal listed by Amazon Resource Name (ARN).

- *

To specify no permissions, omit Permissions.

+ *

The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.

* @public */ - Permissions?: ResourcePermission[] | undefined; + Arn?: string | undefined; /** - *

A source entity to use for the analysis that you're creating. This metadata structure - * contains details that describe a source template and one or more datasets.

- *

Either a SourceEntity or a Definition must be provided in - * order for the request to be valid.

+ *

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

* @public */ - SourceEntity?: AnalysisSourceEntity | undefined; + AwsAccountId?: string | undefined; /** - *

The ARN for the theme to apply to the analysis that you're creating. To see the theme - * in the Amazon QuickSight console, make sure that you have access to it.

+ *

The namespace associated with the customization you're creating.

* @public */ - ThemeArn?: string | undefined; + Namespace?: string | undefined; /** - *

Contains a map of the key-value pairs for the resource tag or tags assigned to the - * analysis.

+ *

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.

* @public */ - Tags?: Tag[] | undefined; + AccountCustomization?: AccountCustomization | undefined; /** - *

The definition of an analysis.

- *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

- *

Either a SourceEntity or a Definition must be provided in - * order for the request to be valid.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Definition?: AnalysisDefinition | undefined; + RequestId?: string | undefined; /** - *

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

+ *

The HTTP status of the request.

* @public */ - ValidationStrategy?: ValidationStrategy | undefined; + Status?: number | undefined; +} + +/** + *

This resource is currently unavailable.

+ * @public + */ +export class ResourceUnavailableException extends __BaseException { + readonly name: "ResourceUnavailableException" = "ResourceUnavailableException"; + readonly $fault: "server" = "server"; + Message?: string | undefined; + /** + *

The resource type for this request.

+ * @public + */ + ResourceType?: ExceptionResourceType | undefined; /** - *

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

+ *

The Amazon Web Services request ID for this request.

* @public */ - FolderArns?: string[] | undefined; + RequestId?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType) { + super({ + name: "ResourceUnavailableException", + $fault: "server", + ...opts, + }); + Object.setPrototypeOf(this, ResourceUnavailableException.prototype); + this.Message = opts.Message; + this.ResourceType = opts.ResourceType; + this.RequestId = opts.RequestId; + } } /** * @public */ -export interface CreateAnalysisResponse { +export interface CreateAccountSubscriptionRequest { /** - *

The ARN for the analysis.

+ *

The edition of Amazon QuickSight that you want your account to have. Currently, you can + * choose from ENTERPRISE or + * ENTERPRISE_AND_Q.

+ *

If you choose ENTERPRISE_AND_Q, the following parameters are + * required:

+ *
    + *
  • + *

    + * FirstName + *

    + *
  • + *
  • + *

    + * LastName + *

    + *
  • + *
  • + *

    + * EmailAddress + *

    + *
  • + *
  • + *

    + * ContactNumber + *

    + *
  • + *
* @public */ - Arn?: string | undefined; + Edition?: Edition | undefined; /** - *

The ID of the analysis.

+ *

The method that you want to use to authenticate your Amazon QuickSight account.

+ *

If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName + * and an AdminGroup associated with your Active Directory.

+ *

If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

* @public */ - AnalysisId?: string | undefined; + AuthenticationMethod: AuthenticationMethodOption | undefined; + + /** + *

The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change + * AccountName value after the Amazon QuickSight account is + * created.

+ * @public + */ + AccountName: string | undefined; /** - *

The status of the creation of the analysis.

+ *

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

* @public */ - CreationStatus?: ResourceStatus | undefined; + NotificationEmail: string | undefined; /** - *

The HTTP status of the request.

+ *

The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

* @public */ - Status?: number | undefined; + ActiveDirectoryName?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

* @public */ - RequestId?: string | undefined; -} + Realm?: string | undefined; -/** - *

A limit is exceeded.

- * @public - */ -export class LimitExceededException extends __BaseException { - readonly name: "LimitExceededException" = "LimitExceededException"; - readonly $fault: "client" = "client"; - Message?: string | undefined; /** - *

Limit exceeded.

+ *

The ID of the Active Directory that is associated with your Amazon QuickSight account.

* @public */ - ResourceType?: ExceptionResourceType | undefined; + DirectoryId?: string | undefined; /** - *

The Amazon Web Services request ID for this request.

+ *

The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

+ *

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

* @public */ - RequestId?: string | undefined; + AdminGroup?: string[] | undefined; + /** - * @internal + *

The author group associated with your Active Directory or IAM Identity Center account.

+ *

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "LimitExceededException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, LimitExceededException.prototype); - this.Message = opts.Message; - this.ResourceType = opts.ResourceType; - this.RequestId = opts.RequestId; - } -} + AuthorGroup?: string[] | undefined; -/** - *

This error indicates that you are calling an operation on an Amazon QuickSight - * subscription where the edition doesn't include support for that operation. Amazon - * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and - * capability is available in every edition.

- * @public - */ -export class UnsupportedUserEditionException extends __BaseException { - readonly name: "UnsupportedUserEditionException" = "UnsupportedUserEditionException"; - readonly $fault: "client" = "client"; - Message?: string | undefined; /** - *

The Amazon Web Services request ID for this request.

+ *

The reader group associated with your Active Directory or IAM Identity Center account.

+ *

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

* @public */ - RequestId?: string | undefined; + ReaderGroup?: string[] | undefined; + /** - * @internal + *

The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

+ *

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "UnsupportedUserEditionException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, UnsupportedUserEditionException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } -} + AdminProGroup?: string[] | undefined; -/** - *

A transform operation that creates calculated columns. Columns created in one such - * operation form a lexical closure.

- * @public - */ -export interface CreateColumnsOperation { /** - *

Calculated columns to create.

+ *

The author pro group associated with your Active Directory or IAM Identity Center account.

+ *

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

* @public */ - Columns: CalculatedColumn[] | undefined; -} + AuthorProGroup?: string[] | undefined; -/** - *

The drill down options for data points in a dashbaord.

- * @public - */ -export interface DataPointDrillUpDownOption { /** - *

The status of the drill down options of data points.

+ *

The reader pro group associated with your Active Directory or IAM Identity Center account.

+ *

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

* @public */ - AvailabilityStatus?: DashboardBehavior | undefined; -} + ReaderProGroup?: string[] | undefined; -/** - *

The data point menu options of a dashboard.

- * @public - */ -export interface DataPointMenuLabelOption { /** - *

The status of the data point menu options.

+ *

The first name of the author of the Amazon QuickSight account to use for future + * communications. This field is required if ENTERPPRISE_AND_Q is the selected + * edition of the new Amazon QuickSight account.

* @public */ - AvailabilityStatus?: DashboardBehavior | undefined; -} + FirstName?: string | undefined; -/** - *

The data point tooltip options.

- * @public - */ -export interface DataPointTooltipOption { /** - *

The status of the data point tool tip options.

+ *

The last name of the author of the Amazon QuickSight account to use for future + * communications. This field is required if ENTERPPRISE_AND_Q is the selected + * edition of the new Amazon QuickSight account.

* @public */ - AvailabilityStatus?: DashboardBehavior | undefined; -} + LastName?: string | undefined; -/** - *

Export to .csv option.

- * @public - */ -export interface ExportToCSVOption { /** - *

Availability status.

+ *

The email address of the author of the Amazon QuickSight account to use for future + * communications. This field is required if ENTERPPRISE_AND_Q is the selected + * edition of the new Amazon QuickSight account.

* @public */ - AvailabilityStatus?: DashboardBehavior | undefined; -} + EmailAddress?: string | undefined; -/** - *

Determines whether or not hidden fields are visible on exported dashbaords.

- * @public - */ -export interface ExportWithHiddenFieldsOption { /** - *

The status of the export with hidden fields options.

+ *

A 10-digit phone number for the author of the Amazon QuickSight account to use for + * future communications. This field is required if ENTERPPRISE_AND_Q is the + * selected edition of the new Amazon QuickSight account.

* @public */ - AvailabilityStatus?: DashboardBehavior | undefined; -} - -/** - * @public - * @enum - */ -export const DashboardUIState = { - COLLAPSED: "COLLAPSED", - EXPANDED: "EXPANDED", -} as const; - -/** - * @public - */ -export type DashboardUIState = (typeof DashboardUIState)[keyof typeof DashboardUIState]; + ContactNumber?: string | undefined; -/** - *

Sheet controls option.

- * @public - */ -export interface SheetControlsOption { /** - *

Visibility state.

+ *

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

* @public */ - VisibilityState?: DashboardUIState | undefined; + IAMIdentityCenterInstanceArn?: string | undefined; } /** - *

The sheet layout maximization options of a dashbaord.

+ *

A SignupResponse object that contains a summary of a newly created account.

* @public */ -export interface SheetLayoutElementMaximizationOption { +export interface SignupResponse { /** - *

The status of the sheet layout maximization options of a dashbaord.

+ *

A Boolean that is TRUE if the Amazon QuickSight uses IAM as an + * authentication method.

* @public */ - AvailabilityStatus?: DashboardBehavior | undefined; -} + IAMUser?: boolean | undefined; -/** - *

The axis sort options for a visual.

- * @public - */ -export interface VisualAxisSortOption { /** - *

The availaiblity status of a visual's axis sort options.

+ *

The user login name for your Amazon QuickSight account.

* @public */ - AvailabilityStatus?: DashboardBehavior | undefined; -} + userLoginName?: string | undefined; -/** - *

Determines if hidden fields are included in an exported dashboard.

- * @public - */ -export interface ExportHiddenFieldsOption { /** - *

The status of the export hidden fields options of a dashbaord.

+ *

The name of your Amazon QuickSight account.

* @public */ - AvailabilityStatus?: DashboardBehavior | undefined; -} + accountName?: string | undefined; -/** - *

The visual publish options of a visual in a dashboard

- * @public - */ -export interface DashboardVisualPublishOptions { /** - *

Determines if hidden fields are included in an exported dashboard.

+ *

The type of Active Directory that is being used to authenticate the Amazon QuickSight + * account. Valid values are SIMPLE_AD, AD_CONNECTOR, and + * MICROSOFT_AD.

* @public */ - ExportHiddenFieldsOption?: ExportHiddenFieldsOption | undefined; + directoryType?: string | undefined; } /** - *

Dashboard publish options.

* @public */ -export interface DashboardPublishOptions { +export interface CreateAccountSubscriptionResponse { /** - *

Ad hoc (one-time) filtering option.

+ *

A SignupResponse object that returns information about a newly created Amazon QuickSight account.

* @public */ - AdHocFilteringOption?: AdHocFilteringOption | undefined; + SignupResponse?: SignupResponse | undefined; /** - *

Export to .csv option.

+ *

The HTTP status of the request.

* @public */ - ExportToCSVOption?: ExportToCSVOption | undefined; + Status?: number | undefined; /** - *

Sheet controls option.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - SheetControlsOption?: SheetControlsOption | undefined; + RequestId?: string | undefined; +} +/** + *

One or more preconditions aren't met.

+ * @public + */ +export class PreconditionNotMetException extends __BaseException { + readonly name: "PreconditionNotMetException" = "PreconditionNotMetException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; /** - * @deprecated - * - *

The visual publish options of a visual in a dashboard.

+ *

The Amazon Web Services request ID for this request.

* @public */ - VisualPublishOptions?: DashboardVisualPublishOptions | undefined; - + RequestId?: string | undefined; /** - *

The sheet layout maximization options of a dashbaord.

- * @public + * @internal */ - SheetLayoutElementMaximizationOption?: SheetLayoutElementMaximizationOption | undefined; + constructor(opts: __ExceptionOptionType) { + super({ + name: "PreconditionNotMetException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, PreconditionNotMetException.prototype); + this.Message = opts.Message; + this.RequestId = opts.RequestId; + } +} +/** + *

A date-time parameter.

+ * @public + */ +export interface DateTimeParameter { /** - *

The menu options of a visual in a dashboard.

+ *

A display name for the date-time parameter.

* @public */ - VisualMenuOption?: VisualMenuOption | undefined; + Name: string | undefined; /** - *

The axis sort options of a dashboard.

+ *

The values for the date-time parameter.

* @public */ - VisualAxisSortOption?: VisualAxisSortOption | undefined; + Values: Date[] | undefined; +} +/** + *

A decimal parameter.

+ * @public + */ +export interface DecimalParameter { /** - *

Determines if hidden fields are exported with a dashboard.

+ *

A display name for the decimal parameter.

* @public */ - ExportWithHiddenFieldsOption?: ExportWithHiddenFieldsOption | undefined; + Name: string | undefined; /** - *

The drill-down options of data points in a dashboard.

+ *

The values for the decimal parameter.

* @public */ - DataPointDrillUpDownOption?: DataPointDrillUpDownOption | undefined; + Values: number[] | undefined; +} +/** + *

An integer parameter.

+ * @public + */ +export interface IntegerParameter { /** - *

The data point menu label options of a dashboard.

+ *

The name of the integer parameter.

* @public */ - DataPointMenuLabelOption?: DataPointMenuLabelOption | undefined; + Name: string | undefined; /** - *

The data point tool tip options of a dashboard.

+ *

The values for the integer parameter.

* @public */ - DataPointTooltipOption?: DataPointTooltipOption | undefined; + Values: number[] | undefined; } /** - *

The contents of a dashboard.

+ *

A string parameter.

* @public */ -export interface DashboardVersionDefinition { +export interface StringParameter { /** - *

An array of dataset identifier declarations. With - * this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.

+ *

A display name for a string parameter.

* @public */ - DataSetIdentifierDeclarations: DataSetIdentifierDeclaration[] | undefined; + Name: string | undefined; /** - *

An array of sheet definitions for a dashboard.

+ *

The values of a string parameter.

* @public */ - Sheets?: SheetDefinition[] | undefined; + Values: string[] | undefined; +} +/** + *

A list of Amazon QuickSight parameters and the list's override values.

+ * @public + */ +export interface _Parameters { /** - *

An array of calculated field definitions for the dashboard.

+ *

The parameters that have a data type of string.

* @public */ - CalculatedFields?: CalculatedField[] | undefined; + StringParameters?: StringParameter[] | undefined; /** - *

The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.

- *

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

+ *

The parameters that have a data type of integer.

* @public */ - ParameterDeclarations?: ParameterDeclaration[] | undefined; + IntegerParameters?: IntegerParameter[] | undefined; /** - *

The filter definitions for a dashboard.

- *

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

+ *

The parameters that have a data type of decimal.

* @public */ - FilterGroups?: FilterGroup[] | undefined; + DecimalParameters?: DecimalParameter[] | undefined; /** - *

An array of dashboard-level column configurations. Column configurations - * are used to set the default formatting for a column that - * is used throughout a dashboard.

+ *

The parameters that have a data type of date-time.

* @public */ - ColumnConfigurations?: ColumnConfiguration[] | undefined; + DateTimeParameters?: DateTimeParameter[] | undefined; +} +/** + *

Permission for the resource.

+ * @public + */ +export interface ResourcePermission { /** - *

The configuration for default analysis settings.

+ *

The Amazon Resource Name (ARN) of the principal. This can be one of the + * following:

+ *
    + *
  • + *

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    + *
  • + *
  • + *

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    + *
  • + *
  • + *

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight + * ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. + * (This is less common.)

    + *
  • + *
* @public */ - AnalysisDefaults?: AnalysisDefaults | undefined; + Principal: string | undefined; /** - *

An array of option definitions for a dashboard.

+ *

The IAM action to grant or revoke permissions on.

* @public */ - Options?: AssetOptions | undefined; + Actions: string[] | undefined; } /** - *

A structure that contains the configuration of a shareable link to the dashboard.

* @public + * @enum */ -export interface LinkSharingConfiguration { - /** - *

A structure that contains the permissions of a shareable link.

- * @public - */ - Permissions?: ResourcePermission[] | undefined; -} +export const ValidationStrategyMode = { + LENIENT: "LENIENT", + STRICT: "STRICT", +} as const; /** - *

Dashboard source template.

* @public */ -export interface DashboardSourceTemplate { - /** - *

Dataset references.

- * @public - */ - DataSetReferences: DataSetReference[] | undefined; - - /** - *

The Amazon Resource Name (ARN) of the resource.

- * @public - */ - Arn: string | undefined; -} +export type ValidationStrategyMode = (typeof ValidationStrategyMode)[keyof typeof ValidationStrategyMode]; /** - *

Dashboard source entity.

+ *

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

* @public */ -export interface DashboardSourceEntity { +export interface ValidationStrategy { /** - *

Source template.

+ *

The mode of validation for the asset to be created or updated. When you set this value to STRICT, strict validation for every error is enforced. When you set this value to LENIENT, validation is skipped for specific UI errors.

* @public */ - SourceTemplate?: DashboardSourceTemplate | undefined; + Mode: ValidationStrategyMode | undefined; } /** * @public */ -export interface CreateDashboardRequest { +export interface CreateAnalysisRequest { /** - *

The ID of the Amazon Web Services account where you want to create the dashboard.

+ *

The ID of the Amazon Web Services account where you are creating an analysis.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the dashboard, also added to the IAM policy.

+ *

The ID for the analysis that you're creating. This ID displays in the URL of the + * analysis.

* @public */ - DashboardId: string | undefined; + AnalysisId: string | undefined; /** - *

The display name of the dashboard.

+ *

A descriptive name for the analysis that you're creating. This name displays for the + * analysis in the Amazon QuickSight console.

* @public */ Name: string | undefined; /** - *

The parameters for the creation of the dashboard, which you want to use to override - * the default settings. A dashboard can have any type of parameters, and some parameters - * might accept multiple values.

+ *

The parameter names and override values that you want to use. An analysis can have + * any parameter type, and some parameters might accept multiple values.

* @public */ Parameters?: _Parameters | undefined; /** - *

A structure that contains the permissions of the dashboard. You can use this structure - * for granting permissions by providing a list of IAM action information for each - * principal ARN.

- *

To specify no permissions, omit the permissions list.

+ *

A structure that describes the principals and the resource-level permissions on an + * analysis. You can use the Permissions structure to grant permissions by + * providing a list of Identity and Access Management (IAM) action information for each + * principal listed by Amazon Resource Name (ARN).

+ *

To specify no permissions, omit Permissions.

* @public */ Permissions?: ResourcePermission[] | undefined; /** - *

The entity that you are using as a source when you create the dashboard. In - * SourceEntity, you specify the type of object you're using as source. You - * can only create a dashboard from a template, so you use a SourceTemplate - * entity. If you need to create a dashboard from an analysis, first convert the analysis - * to a template by using the - * CreateTemplate - * - * API operation. For - * SourceTemplate, specify the Amazon Resource Name (ARN) of the source - * template. The SourceTemplateARN can contain any Amazon Web Services account and any - * Amazon QuickSight-supported Amazon Web Services Region.

- *

Use the DataSetReferences entity within SourceTemplate to - * list the replacement datasets for the placeholders listed in the original. The schema in - * each dataset must match its placeholder.

+ *

A source entity to use for the analysis that you're creating. This metadata structure + * contains details that describe a source template and one or more datasets.

*

Either a SourceEntity or a Definition must be provided in * order for the request to be valid.

* @public */ - SourceEntity?: DashboardSourceEntity | undefined; + SourceEntity?: AnalysisSourceEntity | undefined; + + /** + *

The ARN for the theme to apply to the analysis that you're creating. To see the theme + * in the Amazon QuickSight console, make sure that you have access to it.

+ * @public + */ + ThemeArn?: string | undefined; /** *

Contains a map of the key-value pairs for the resource tag or tags assigned to the - * dashboard.

+ * analysis.

* @public */ Tags?: Tag[] | undefined; /** - *

A description for the first version of the dashboard being created.

+ *

The definition of an analysis.

+ *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

+ *

Either a SourceEntity or a Definition must be provided in + * order for the request to be valid.

* @public */ - VersionDescription?: string | undefined; + Definition?: AnalysisDefinition | undefined; /** - *

Options for publishing the dashboard when you create it:

- *
    - *
  • - *

    - * AvailabilityStatus for AdHocFilteringOption - This - * status can be either ENABLED or DISABLED. When this is - * set to DISABLED, Amazon QuickSight disables the left filter pane on the - * published dashboard, which can be used for ad hoc (one-time) filtering. This - * option is ENABLED by default.

    - *
  • - *
  • - *

    - * AvailabilityStatus for ExportToCSVOption - This - * status can be either ENABLED or DISABLED. The visual - * option to export data to .CSV format isn't enabled when this is set to - * DISABLED. This option is ENABLED by default.

    - *
  • - *
  • - *

    - * VisibilityState for SheetControlsOption - This - * visibility state can be either COLLAPSED or EXPANDED. - * This option is COLLAPSED by default.

    - *
  • - *
+ *

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

* @public */ - DashboardPublishOptions?: DashboardPublishOptions | undefined; + ValidationStrategy?: ValidationStrategy | undefined; /** - *

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If - * you add a value for this field, it overrides the value that is used in the source - * entity. The theme ARN must exist in the same Amazon Web Services account where you create the - * dashboard.

+ *

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

+ * @public + */ + FolderArns?: string[] | undefined; +} + +/** + * @public + */ +export interface CreateAnalysisResponse { + /** + *

The ARN for the analysis.

+ * @public + */ + Arn?: string | undefined; + + /** + *

The ID of the analysis.

* @public */ - ThemeArn?: string | undefined; + AnalysisId?: string | undefined; /** - *

The definition of a dashboard.

- *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

- *

Either a SourceEntity or a Definition must be provided in - * order for the request to be valid.

+ *

The status of the creation of the analysis.

* @public */ - Definition?: DashboardVersionDefinition | undefined; + CreationStatus?: ResourceStatus | undefined; /** - *

The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.

+ *

The HTTP status of the request.

* @public */ - ValidationStrategy?: ValidationStrategy | undefined; + Status?: number | undefined; /** - *

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - FolderArns?: string[] | undefined; + RequestId?: string | undefined; +} +/** + *

A limit is exceeded.

+ * @public + */ +export class LimitExceededException extends __BaseException { + readonly name: "LimitExceededException" = "LimitExceededException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; /** - *

A structure that contains the permissions of a shareable link to the dashboard.

+ *

Limit exceeded.

* @public */ - LinkSharingConfiguration?: LinkSharingConfiguration | undefined; + ResourceType?: ExceptionResourceType | undefined; /** - *

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

+ *

The Amazon Web Services request ID for this request.

* @public */ - LinkEntities?: string[] | undefined; + RequestId?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType) { + super({ + name: "LimitExceededException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, LimitExceededException.prototype); + this.Message = opts.Message; + this.ResourceType = opts.ResourceType; + this.RequestId = opts.RequestId; + } } /** + *

This error indicates that you are calling an operation on an Amazon QuickSight + * subscription where the edition doesn't include support for that operation. Amazon + * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and + * capability is available in every edition.

* @public */ -export interface CreateDashboardResponse { +export class UnsupportedUserEditionException extends __BaseException { + readonly name: "UnsupportedUserEditionException" = "UnsupportedUserEditionException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; /** - *

The ARN of the dashboard.

+ *

The Amazon Web Services request ID for this request.

* @public */ - Arn?: string | undefined; - + RequestId?: string | undefined; /** - *

The ARN of the dashboard, including the version number of the first version that is - * created.

- * @public + * @internal */ - VersionArn?: string | undefined; + constructor(opts: __ExceptionOptionType) { + super({ + name: "UnsupportedUserEditionException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, UnsupportedUserEditionException.prototype); + this.Message = opts.Message; + this.RequestId = opts.RequestId; + } +} +/** + * @public + */ +export interface CreateBrandRequest { /** - *

The ID for the dashboard.

+ *

The ID of the Amazon Web Services account that owns the brand.

* @public */ - DashboardId?: string | undefined; + AwsAccountId: string | undefined; /** - *

The status of the dashboard creation request.

+ *

The ID of the Amazon QuickSight brand.

* @public */ - CreationStatus?: ResourceStatus | undefined; + BrandId: string | undefined; /** - *

The HTTP status of the request.

+ *

The definition of the brand.

* @public */ - Status?: number | undefined; + BrandDefinition?: BrandDefinition | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

A map of the key-value pairs that are assigned to the brand.

* @public */ - RequestId?: string | undefined; + Tags?: Tag[] | undefined; } /** - *

The default values of a date time parameter.

* @public */ -export interface DateTimeDatasetParameterDefaultValues { +export interface CreateBrandResponse { /** - *

A list of static default values for a given date time parameter.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - StaticValues?: Date[] | undefined; + RequestId?: string | undefined; + + /** + *

The details of the brand.

+ * @public + */ + BrandDetail?: BrandDetail | undefined; + + /** + *

The definition of the brand.

+ * @public + */ + BrandDefinition?: BrandDefinition | undefined; } /** + *

An internal service exception.

* @public - * @enum */ -export const DatasetParameterValueType = { - MULTI_VALUED: "MULTI_VALUED", - SINGLE_VALUED: "SINGLE_VALUED", -} as const; +export class InternalServerException extends __BaseException { + readonly name: "InternalServerException" = "InternalServerException"; + readonly $fault: "server" = "server"; + Message: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType) { + super({ + name: "InternalServerException", + $fault: "server", + ...opts, + }); + Object.setPrototypeOf(this, InternalServerException.prototype); + this.Message = opts.Message; + } +} /** + *

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

* @public */ -export type DatasetParameterValueType = (typeof DatasetParameterValueType)[keyof typeof DatasetParameterValueType]; +export class InvalidRequestException extends __BaseException { + readonly name: "InvalidRequestException" = "InvalidRequestException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; + /** + *

The Amazon Web Services request ID for this request.

+ * @public + */ + RequestId?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType) { + super({ + name: "InvalidRequestException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, InvalidRequestException.prototype); + this.Message = opts.Message; + this.RequestId = opts.RequestId; + } +} /** - *

A date time parameter for a dataset.

+ *

A transform operation that creates calculated columns. Columns created in one such + * operation form a lexical closure.

* @public */ -export interface DateTimeDatasetParameter { +export interface CreateColumnsOperation { /** - *

An identifier for the parameter that is created in the dataset.

+ *

Calculated columns to create.

* @public */ - Id: string | undefined; + Columns: CalculatedColumn[] | undefined; +} +/** + * @public + */ +export interface CreateCustomPermissionsRequest { /** - *

The name of the date time parameter that is created in the dataset.

+ *

The ID of the Amazon Web Services account that you want to create the custom permissions profile in.

* @public */ - Name: string | undefined; + AwsAccountId: string | undefined; /** - *

The value type of the dataset parameter. Valid values are single value or multi value.

+ *

The name of the custom permissions profile that you want to create.

* @public */ - ValueType: DatasetParameterValueType | undefined; + CustomPermissionsName: string | undefined; /** - *

The time granularity of the date time parameter.

+ *

A set of actions to include in the custom permissions profile.

* @public */ - TimeGranularity?: TimeGranularity | undefined; + Capabilities?: Capabilities | undefined; /** - *

A list of default values for a given date time parameter. This structure only accepts static values.

+ *

The tags to associate with the custom permissions profile.

* @public */ - DefaultValues?: DateTimeDatasetParameterDefaultValues | undefined; + Tags?: Tag[] | undefined; } /** - *

The default values of a decimal parameter.

* @public */ -export interface DecimalDatasetParameterDefaultValues { +export interface CreateCustomPermissionsResponse { /** - *

A list of static default values for a given decimal parameter.

+ *

The HTTP status of the request.

* @public */ - StaticValues?: number[] | undefined; -} + Status?: number | undefined; -/** - *

A decimal parameter for a dataset.

- * @public - */ -export interface DecimalDatasetParameter { /** - *

An identifier for the decimal parameter created in the dataset.

+ *

The Amazon Resource Name (ARN) of the custom permissions profile.

* @public */ - Id: string | undefined; + Arn?: string | undefined; /** - *

The name of the decimal parameter that is created in the dataset.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Name: string | undefined; + RequestId?: string | undefined; +} +/** + *

The drill down options for data points in a dashbaord.

+ * @public + */ +export interface DataPointDrillUpDownOption { /** - *

The value type of the dataset parameter. Valid values are single value or multi value.

+ *

The status of the drill down options of data points.

* @public */ - ValueType: DatasetParameterValueType | undefined; + AvailabilityStatus?: DashboardBehavior | undefined; +} +/** + *

The data point menu options of a dashboard.

+ * @public + */ +export interface DataPointMenuLabelOption { /** - *

A list of default values for a given decimal parameter. This structure only accepts static values.

+ *

The status of the data point menu options.

* @public */ - DefaultValues?: DecimalDatasetParameterDefaultValues | undefined; + AvailabilityStatus?: DashboardBehavior | undefined; } /** - *

The default values of an integer parameter.

+ *

The data point tooltip options.

* @public */ -export interface IntegerDatasetParameterDefaultValues { +export interface DataPointTooltipOption { /** - *

A list of static default values for a given integer parameter.

+ *

The status of the data point tool tip options.

* @public */ - StaticValues?: number[] | undefined; + AvailabilityStatus?: DashboardBehavior | undefined; } /** - *

An integer parameter for a dataset.

+ *

Export to .csv option.

* @public */ -export interface IntegerDatasetParameter { +export interface ExportToCSVOption { /** - *

An identifier for the integer parameter created in the dataset.

+ *

Availability status.

* @public */ - Id: string | undefined; + AvailabilityStatus?: DashboardBehavior | undefined; +} +/** + *

Determines whether or not hidden fields are visible on exported dashbaords.

+ * @public + */ +export interface ExportWithHiddenFieldsOption { /** - *

The name of the integer parameter that is created in the dataset.

+ *

The status of the export with hidden fields options.

* @public */ - Name: string | undefined; + AvailabilityStatus?: DashboardBehavior | undefined; +} + +/** + * @public + * @enum + */ +export const DashboardUIState = { + COLLAPSED: "COLLAPSED", + EXPANDED: "EXPANDED", +} as const; + +/** + * @public + */ +export type DashboardUIState = (typeof DashboardUIState)[keyof typeof DashboardUIState]; +/** + *

Sheet controls option.

+ * @public + */ +export interface SheetControlsOption { /** - *

The value type of the dataset parameter. Valid values are single value or multi value.

+ *

Visibility state.

* @public */ - ValueType: DatasetParameterValueType | undefined; + VisibilityState?: DashboardUIState | undefined; +} +/** + *

The sheet layout maximization options of a dashbaord.

+ * @public + */ +export interface SheetLayoutElementMaximizationOption { /** - *

A list of default values for a given integer parameter. This structure only accepts static values.

+ *

The status of the sheet layout maximization options of a dashbaord.

* @public */ - DefaultValues?: IntegerDatasetParameterDefaultValues | undefined; + AvailabilityStatus?: DashboardBehavior | undefined; } /** - *

The default values of a string parameter.

+ *

The axis sort options for a visual.

* @public */ -export interface StringDatasetParameterDefaultValues { +export interface VisualAxisSortOption { /** - *

A list of static default values for a given string parameter.

+ *

The availaiblity status of a visual's axis sort options.

* @public */ - StaticValues?: string[] | undefined; + AvailabilityStatus?: DashboardBehavior | undefined; } /** - *

A string parameter for a dataset.

+ *

Determines if hidden fields are included in an exported dashboard.

* @public */ -export interface StringDatasetParameter { +export interface ExportHiddenFieldsOption { /** - *

An identifier for the string parameter that is created in the dataset.

+ *

The status of the export hidden fields options of a dashbaord.

* @public */ - Id: string | undefined; + AvailabilityStatus?: DashboardBehavior | undefined; +} +/** + *

The visual publish options of a visual in a dashboard

+ * @public + */ +export interface DashboardVisualPublishOptions { /** - *

The name of the string parameter that is created in the dataset.

+ *

Determines if hidden fields are included in an exported dashboard.

* @public */ - Name: string | undefined; + ExportHiddenFieldsOption?: ExportHiddenFieldsOption | undefined; +} +/** + *

Dashboard publish options.

+ * @public + */ +export interface DashboardPublishOptions { /** - *

The value type of the dataset parameter. Valid values are single value or multi value.

+ *

Ad hoc (one-time) filtering option.

* @public */ - ValueType: DatasetParameterValueType | undefined; + AdHocFilteringOption?: AdHocFilteringOption | undefined; /** - *

A list of default values for a given string dataset parameter type. This structure only accepts static values.

+ *

Export to .csv option.

* @public */ - DefaultValues?: StringDatasetParameterDefaultValues | undefined; -} + ExportToCSVOption?: ExportToCSVOption | undefined; -/** - *

A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.

- * @public - */ -export interface DatasetParameter { /** - *

A string parameter that is created in the dataset.

+ *

Sheet controls option.

* @public */ - StringDatasetParameter?: StringDatasetParameter | undefined; + SheetControlsOption?: SheetControlsOption | undefined; /** - *

A decimal parameter that is created in the dataset.

+ * @deprecated + * + *

The visual publish options of a visual in a dashboard.

* @public */ - DecimalDatasetParameter?: DecimalDatasetParameter | undefined; + VisualPublishOptions?: DashboardVisualPublishOptions | undefined; /** - *

An integer parameter that is created in the dataset.

+ *

The sheet layout maximization options of a dashbaord.

* @public */ - IntegerDatasetParameter?: IntegerDatasetParameter | undefined; + SheetLayoutElementMaximizationOption?: SheetLayoutElementMaximizationOption | undefined; /** - *

A date time parameter that is created in the dataset.

+ *

The menu options of a visual in a dashboard.

* @public */ - DateTimeDatasetParameter?: DateTimeDatasetParameter | undefined; -} + VisualMenuOption?: VisualMenuOption | undefined; -/** - *

The usage configuration to apply to child datasets that reference this dataset as a source.

- * @public - */ -export interface DataSetUsageConfiguration { /** - *

An option that controls whether a child dataset of a direct query can use this dataset as a source.

+ *

The axis sort options of a dashboard.

* @public */ - DisableUseAsDirectQuerySource?: boolean | undefined; + VisualAxisSortOption?: VisualAxisSortOption | undefined; /** - *

An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

+ *

Determines if hidden fields are exported with a dashboard.

* @public */ - DisableUseAsImportedSource?: boolean | undefined; -} + ExportWithHiddenFieldsOption?: ExportWithHiddenFieldsOption | undefined; -/** - *

A FieldFolder element is a folder that contains fields and nested subfolders.

- * @public - */ -export interface FieldFolder { /** - *

The description for a field folder.

+ *

The drill-down options of data points in a dashboard.

* @public */ - description?: string | undefined; + DataPointDrillUpDownOption?: DataPointDrillUpDownOption | undefined; /** - *

A folder has a list of columns. A column can only be in one folder.

+ *

The data point menu label options of a dashboard.

* @public */ - columns?: string[] | undefined; -} - -/** - * @public - * @enum - */ -export const DataSetImportMode = { - DIRECT_QUERY: "DIRECT_QUERY", - SPICE: "SPICE", -} as const; - -/** - * @public - */ -export type DataSetImportMode = (typeof DataSetImportMode)[keyof typeof DataSetImportMode]; + DataPointMenuLabelOption?: DataPointMenuLabelOption | undefined; -/** - *

A transform operation that filters rows based on a condition.

- * @public - */ -export interface FilterOperation { /** - *

An expression that must evaluate to a Boolean value. Rows for which the expression - * evaluates to true are kept in the dataset.

+ *

The data point tool tip options of a dashboard.

* @public */ - ConditionExpression: string | undefined; + DataPointTooltipOption?: DataPointTooltipOption | undefined; } /** - *

The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.

+ *

The contents of a dashboard.

* @public */ -export interface NewDefaultValues { +export interface DashboardVersionDefinition { /** - *

A list of static default values for a given string parameter.

+ *

An array of dataset identifier declarations. With + * this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.

* @public */ - StringStaticValues?: string[] | undefined; + DataSetIdentifierDeclarations: DataSetIdentifierDeclaration[] | undefined; /** - *

A list of static default values for a given decimal parameter.

+ *

An array of sheet definitions for a dashboard.

* @public */ - DecimalStaticValues?: number[] | undefined; + Sheets?: SheetDefinition[] | undefined; /** - *

A list of static default values for a given date time parameter.

+ *

An array of calculated field definitions for the dashboard.

* @public */ - DateTimeStaticValues?: Date[] | undefined; + CalculatedFields?: CalculatedField[] | undefined; /** - *

A list of static default values for a given integer parameter.

+ *

The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.

+ *

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

* @public */ - IntegerStaticValues?: number[] | undefined; -} + ParameterDeclarations?: ParameterDeclaration[] | undefined; -/** - *

A transform operation that overrides the dataset parameter values that are defined in another dataset.

- * @public - */ -export interface OverrideDatasetParameterOperation { /** - *

The name of the parameter to be overridden with different values.

+ *

The filter definitions for a dashboard.

+ *

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

* @public */ - ParameterName: string | undefined; + FilterGroups?: FilterGroup[] | undefined; /** - *

The new name for the parameter.

+ *

An array of dashboard-level column configurations. Column configurations + * are used to set the default formatting for a column that + * is used throughout a dashboard.

* @public */ - NewParameterName?: string | undefined; + ColumnConfigurations?: ColumnConfiguration[] | undefined; /** - *

The new default values for the parameter.

+ *

The configuration for default analysis settings.

* @public */ - NewDefaultValues?: NewDefaultValues | undefined; -} + AnalysisDefaults?: AnalysisDefaults | undefined; -/** - *

A transform operation that projects columns. Operations that come after a projection - * can only refer to projected columns.

- * @public - */ -export interface ProjectOperation { /** - *

Projected columns.

+ *

An array of option definitions for a dashboard.

* @public */ - ProjectedColumns: string[] | undefined; + Options?: AssetOptions | undefined; } /** - *

A transform operation that renames a column.

+ *

A structure that contains the configuration of a shareable link to the dashboard.

* @public */ -export interface RenameColumnOperation { - /** - *

The name of the column to be renamed.

- * @public - */ - ColumnName: string | undefined; - +export interface LinkSharingConfiguration { /** - *

The new name for the column.

+ *

A structure that contains the permissions of a shareable link.

* @public */ - NewColumnName: string | undefined; + Permissions?: ResourcePermission[] | undefined; } /** - *

A transform operation that tags a column with additional information.

+ *

Dashboard source template.

* @public */ -export interface TagColumnOperation { +export interface DashboardSourceTemplate { /** - *

The column that this operation acts on.

+ *

Dataset references.

* @public */ - ColumnName: string | undefined; + DataSetReferences: DataSetReference[] | undefined; /** - *

The dataset column tag, currently only used for geospatial type tagging.

- * - *

This is not tags for the Amazon Web Services tagging feature.

- *
+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ - Tags: ColumnTag[] | undefined; + Arn: string | undefined; } /** - *

A transform operation that removes tags associated with a column.

+ *

Dashboard source entity.

* @public */ -export interface UntagColumnOperation { - /** - *

The column that this operation acts on.

- * @public - */ - ColumnName: string | undefined; - +export interface DashboardSourceEntity { /** - *

The column tags to remove from this column.

+ *

Source template.

* @public */ - TagNames: ColumnTagName[] | undefined; + SourceTemplate?: DashboardSourceTemplate | undefined; } -/** - *

A data transformation on a logical table. This is a variant type structure. For this - * structure to be valid, only one of the attributes can be non-null.

- * @public - */ -export type TransformOperation = - | TransformOperation.CastColumnTypeOperationMember - | TransformOperation.CreateColumnsOperationMember - | TransformOperation.FilterOperationMember - | TransformOperation.OverrideDatasetParameterOperationMember - | TransformOperation.ProjectOperationMember - | TransformOperation.RenameColumnOperationMember - | TransformOperation.TagColumnOperationMember - | TransformOperation.UntagColumnOperationMember - | TransformOperation.$UnknownMember; - /** * @public */ -export namespace TransformOperation { - /** - *

An operation that projects columns. Operations that come after a projection can only - * refer to projected columns.

- * @public - */ - export interface ProjectOperationMember { - ProjectOperation: ProjectOperation; - FilterOperation?: never; - CreateColumnsOperation?: never; - RenameColumnOperation?: never; - CastColumnTypeOperation?: never; - TagColumnOperation?: never; - UntagColumnOperation?: never; - OverrideDatasetParameterOperation?: never; - $unknown?: never; - } - +export interface CreateDashboardRequest { /** - *

An operation that filters rows based on some condition.

+ *

The ID of the Amazon Web Services account where you want to create the dashboard.

* @public */ - export interface FilterOperationMember { - ProjectOperation?: never; - FilterOperation: FilterOperation; - CreateColumnsOperation?: never; - RenameColumnOperation?: never; - CastColumnTypeOperation?: never; - TagColumnOperation?: never; - UntagColumnOperation?: never; - OverrideDatasetParameterOperation?: never; - $unknown?: never; - } + AwsAccountId: string | undefined; /** - *

An operation that creates calculated columns. Columns created in one such operation - * form a lexical closure.

+ *

The ID for the dashboard, also added to the IAM policy.

* @public */ - export interface CreateColumnsOperationMember { - ProjectOperation?: never; - FilterOperation?: never; - CreateColumnsOperation: CreateColumnsOperation; - RenameColumnOperation?: never; - CastColumnTypeOperation?: never; - TagColumnOperation?: never; - UntagColumnOperation?: never; - OverrideDatasetParameterOperation?: never; - $unknown?: never; - } + DashboardId: string | undefined; /** - *

An operation that renames a column.

+ *

The display name of the dashboard.

* @public */ - export interface RenameColumnOperationMember { - ProjectOperation?: never; - FilterOperation?: never; - CreateColumnsOperation?: never; - RenameColumnOperation: RenameColumnOperation; - CastColumnTypeOperation?: never; - TagColumnOperation?: never; - UntagColumnOperation?: never; - OverrideDatasetParameterOperation?: never; - $unknown?: never; - } + Name: string | undefined; /** - *

A transform operation that casts a column to a different type.

+ *

The parameters for the creation of the dashboard, which you want to use to override + * the default settings. A dashboard can have any type of parameters, and some parameters + * might accept multiple values.

* @public */ - export interface CastColumnTypeOperationMember { - ProjectOperation?: never; - FilterOperation?: never; - CreateColumnsOperation?: never; - RenameColumnOperation?: never; - CastColumnTypeOperation: CastColumnTypeOperation; - TagColumnOperation?: never; - UntagColumnOperation?: never; - OverrideDatasetParameterOperation?: never; - $unknown?: never; - } + Parameters?: _Parameters | undefined; /** - *

An operation that tags a column with additional information.

+ *

A structure that contains the permissions of the dashboard. You can use this structure + * for granting permissions by providing a list of IAM action information for each + * principal ARN.

+ *

To specify no permissions, omit the permissions list.

* @public */ - export interface TagColumnOperationMember { - ProjectOperation?: never; - FilterOperation?: never; - CreateColumnsOperation?: never; - RenameColumnOperation?: never; - CastColumnTypeOperation?: never; - TagColumnOperation: TagColumnOperation; - UntagColumnOperation?: never; - OverrideDatasetParameterOperation?: never; - $unknown?: never; - } + Permissions?: ResourcePermission[] | undefined; /** - *

A transform operation that removes tags associated with a column.

+ *

The entity that you are using as a source when you create the dashboard. In + * SourceEntity, you specify the type of object you're using as source. You + * can only create a dashboard from a template, so you use a SourceTemplate + * entity. If you need to create a dashboard from an analysis, first convert the analysis + * to a template by using the + * CreateTemplate + * + * API operation. For + * SourceTemplate, specify the Amazon Resource Name (ARN) of the source + * template. The SourceTemplateARN can contain any Amazon Web Services account and any + * Amazon QuickSight-supported Amazon Web Services Region.

+ *

Use the DataSetReferences entity within SourceTemplate to + * list the replacement datasets for the placeholders listed in the original. The schema in + * each dataset must match its placeholder.

+ *

Either a SourceEntity or a Definition must be provided in + * order for the request to be valid.

* @public */ - export interface UntagColumnOperationMember { - ProjectOperation?: never; - FilterOperation?: never; - CreateColumnsOperation?: never; - RenameColumnOperation?: never; - CastColumnTypeOperation?: never; - TagColumnOperation?: never; - UntagColumnOperation: UntagColumnOperation; - OverrideDatasetParameterOperation?: never; - $unknown?: never; - } + SourceEntity?: DashboardSourceEntity | undefined; /** - *

A transform operation that overrides the dataset parameter values that are defined in another dataset.

+ *

Contains a map of the key-value pairs for the resource tag or tags assigned to the + * dashboard.

* @public */ - export interface OverrideDatasetParameterOperationMember { - ProjectOperation?: never; - FilterOperation?: never; - CreateColumnsOperation?: never; - RenameColumnOperation?: never; - CastColumnTypeOperation?: never; - TagColumnOperation?: never; - UntagColumnOperation?: never; - OverrideDatasetParameterOperation: OverrideDatasetParameterOperation; - $unknown?: never; - } + Tags?: Tag[] | undefined; /** + *

A description for the first version of the dashboard being created.

* @public */ - export interface $UnknownMember { - ProjectOperation?: never; - FilterOperation?: never; - CreateColumnsOperation?: never; - RenameColumnOperation?: never; - CastColumnTypeOperation?: never; - TagColumnOperation?: never; - UntagColumnOperation?: never; - OverrideDatasetParameterOperation?: never; - $unknown: [string, any]; - } - - export interface Visitor { - ProjectOperation: (value: ProjectOperation) => T; - FilterOperation: (value: FilterOperation) => T; - CreateColumnsOperation: (value: CreateColumnsOperation) => T; - RenameColumnOperation: (value: RenameColumnOperation) => T; - CastColumnTypeOperation: (value: CastColumnTypeOperation) => T; - TagColumnOperation: (value: TagColumnOperation) => T; - UntagColumnOperation: (value: UntagColumnOperation) => T; - OverrideDatasetParameterOperation: (value: OverrideDatasetParameterOperation) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: TransformOperation, visitor: Visitor): T => { - if (value.ProjectOperation !== undefined) return visitor.ProjectOperation(value.ProjectOperation); - if (value.FilterOperation !== undefined) return visitor.FilterOperation(value.FilterOperation); - if (value.CreateColumnsOperation !== undefined) return visitor.CreateColumnsOperation(value.CreateColumnsOperation); - if (value.RenameColumnOperation !== undefined) return visitor.RenameColumnOperation(value.RenameColumnOperation); - if (value.CastColumnTypeOperation !== undefined) - return visitor.CastColumnTypeOperation(value.CastColumnTypeOperation); - if (value.TagColumnOperation !== undefined) return visitor.TagColumnOperation(value.TagColumnOperation); - if (value.UntagColumnOperation !== undefined) return visitor.UntagColumnOperation(value.UntagColumnOperation); - if (value.OverrideDatasetParameterOperation !== undefined) - return visitor.OverrideDatasetParameterOperation(value.OverrideDatasetParameterOperation); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; -} + VersionDescription?: string | undefined; -/** - *

Properties associated with the columns participating in a join.

- * @public - */ -export interface JoinKeyProperties { /** - *

A value that indicates that a row in a table is uniquely identified by the columns in - * a join key. This is used by Amazon QuickSight to optimize query performance.

+ *

Options for publishing the dashboard when you create it:

+ *
    + *
  • + *

    + * AvailabilityStatus for AdHocFilteringOption - This + * status can be either ENABLED or DISABLED. When this is + * set to DISABLED, Amazon QuickSight disables the left filter pane on the + * published dashboard, which can be used for ad hoc (one-time) filtering. This + * option is ENABLED by default.

    + *
  • + *
  • + *

    + * AvailabilityStatus for ExportToCSVOption - This + * status can be either ENABLED or DISABLED. The visual + * option to export data to .CSV format isn't enabled when this is set to + * DISABLED. This option is ENABLED by default.

    + *
  • + *
  • + *

    + * VisibilityState for SheetControlsOption - This + * visibility state can be either COLLAPSED or EXPANDED. + * This option is COLLAPSED by default.

    + *
  • + *
* @public */ - UniqueKey?: boolean | undefined; -} - -/** - * @public - * @enum - */ -export const JoinType = { - INNER: "INNER", - LEFT: "LEFT", - OUTER: "OUTER", - RIGHT: "RIGHT", -} as const; - -/** - * @public - */ -export type JoinType = (typeof JoinType)[keyof typeof JoinType]; + DashboardPublishOptions?: DashboardPublishOptions | undefined; -/** - *

The instructions associated with a join.

- * @public - */ -export interface JoinInstruction { /** - *

The operand on the left side of a join.

+ *

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If + * you add a value for this field, it overrides the value that is used in the source + * entity. The theme ARN must exist in the same Amazon Web Services account where you create the + * dashboard.

* @public */ - LeftOperand: string | undefined; + ThemeArn?: string | undefined; /** - *

The operand on the right side of a join.

+ *

The definition of a dashboard.

+ *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

+ *

Either a SourceEntity or a Definition must be provided in + * order for the request to be valid.

* @public */ - RightOperand: string | undefined; + Definition?: DashboardVersionDefinition | undefined; /** - *

Join key properties of the left operand.

+ *

The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.

* @public */ - LeftJoinKeyProperties?: JoinKeyProperties | undefined; + ValidationStrategy?: ValidationStrategy | undefined; /** - *

Join key properties of the right operand.

+ *

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

* @public */ - RightJoinKeyProperties?: JoinKeyProperties | undefined; + FolderArns?: string[] | undefined; /** - *

The type of join that it is.

+ *

A structure that contains the permissions of a shareable link to the dashboard.

* @public */ - Type: JoinType | undefined; + LinkSharingConfiguration?: LinkSharingConfiguration | undefined; /** - *

The join instructions provided in the ON clause of a join.

+ *

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

* @public */ - OnClause: string | undefined; + LinkEntities?: string[] | undefined; } /** - *

Information about the source of a logical table. This is a variant type structure. For - * this structure to be valid, only one of the attributes can be non-null.

* @public */ -export interface LogicalTableSource { +export interface CreateDashboardResponse { + /** + *

The ARN of the dashboard.

+ * @public + */ + Arn?: string | undefined; + /** - *

Specifies the result of a join of two logical tables.

+ *

The ARN of the dashboard, including the version number of the first version that is + * created.

* @public */ - JoinInstruction?: JoinInstruction | undefined; + VersionArn?: string | undefined; /** - *

Physical table ID.

+ *

The ID for the dashboard.

* @public */ - PhysicalTableId?: string | undefined; + DashboardId?: string | undefined; /** - *

The Amazon Resource Number (ARN) of the parent dataset.

+ *

The status of the dashboard creation request.

* @public */ - DataSetArn?: string | undefined; -} + CreationStatus?: ResourceStatus | undefined; -/** - *

A logical table is a unit that joins and that data - * transformations operate on. A logical table has a source, which can be either a physical - * table or result of a join. When a logical table points to a physical table, the logical - * table acts as a mutable copy of that physical table through transform operations.

- * @public - */ -export interface LogicalTable { /** - *

A display name for the logical table.

+ *

The HTTP status of the request.

* @public */ - Alias: string | undefined; + Status?: number | undefined; /** - *

Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - DataTransforms?: TransformOperation[] | undefined; + RequestId?: string | undefined; +} +/** + *

The default values of a date time parameter.

+ * @public + */ +export interface DateTimeDatasetParameterDefaultValues { /** - *

Source of this logical table.

+ *

A list of static default values for a given date time parameter.

* @public */ - Source: LogicalTableSource | undefined; + StaticValues?: Date[] | undefined; } /** * @public * @enum */ -export const InputColumnDataType = { - BIT: "BIT", - BOOLEAN: "BOOLEAN", - DATETIME: "DATETIME", - DECIMAL: "DECIMAL", - INTEGER: "INTEGER", - JSON: "JSON", - STRING: "STRING", +export const DatasetParameterValueType = { + MULTI_VALUED: "MULTI_VALUED", + SINGLE_VALUED: "SINGLE_VALUED", } as const; /** * @public */ -export type InputColumnDataType = (typeof InputColumnDataType)[keyof typeof InputColumnDataType]; +export type DatasetParameterValueType = (typeof DatasetParameterValueType)[keyof typeof DatasetParameterValueType]; /** - *

Metadata for a column that is used as the input of a transform operation.

+ *

A date time parameter for a dataset.

* @public */ -export interface InputColumn { - /** - *

The name of this column in the underlying data source.

- * @public - */ - Name: string | undefined; - - /** - *

The data type of the column.

- * @public - */ - Type: InputColumnDataType | undefined; - +export interface DateTimeDatasetParameter { /** - *

The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.

+ *

An identifier for the parameter that is created in the dataset.

* @public */ - SubType?: ColumnDataSubType | undefined; -} + Id: string | undefined; -/** - *

A physical table type built from the results of the custom SQL query.

- * @public - */ -export interface CustomSql { /** - *

The Amazon Resource Name (ARN) of the data source.

+ *

The name of the date time parameter that is created in the dataset.

* @public */ - DataSourceArn: string | undefined; + Name: string | undefined; /** - *

A display name for the SQL query result.

+ *

The value type of the dataset parameter. Valid values are single value or multi value.

* @public */ - Name: string | undefined; + ValueType: DatasetParameterValueType | undefined; /** - *

The SQL query.

+ *

The time granularity of the date time parameter.

* @public */ - SqlQuery: string | undefined; + TimeGranularity?: TimeGranularity | undefined; /** - *

The column schema from the SQL query result set.

+ *

A list of default values for a given date time parameter. This structure only accepts static values.

* @public */ - Columns?: InputColumn[] | undefined; + DefaultValues?: DateTimeDatasetParameterDefaultValues | undefined; } /** - *

A physical table type for relational data sources.

+ *

The default values of a decimal parameter.

* @public */ -export interface RelationalTable { +export interface DecimalDatasetParameterDefaultValues { /** - *

The Amazon Resource Name (ARN) for the data source.

+ *

A list of static default values for a given decimal parameter.

* @public */ - DataSourceArn: string | undefined; + StaticValues?: number[] | undefined; +} +/** + *

A decimal parameter for a dataset.

+ * @public + */ +export interface DecimalDatasetParameter { /** - *

The catalog associated with a table.

+ *

An identifier for the decimal parameter created in the dataset.

* @public */ - Catalog?: string | undefined; + Id: string | undefined; /** - *

The schema name. This name applies to certain relational database engines.

+ *

The name of the decimal parameter that is created in the dataset.

* @public */ - Schema?: string | undefined; + Name: string | undefined; /** - *

The name of the relational table.

+ *

The value type of the dataset parameter. Valid values are single value or multi value.

* @public */ - Name: string | undefined; + ValueType: DatasetParameterValueType | undefined; /** - *

The column schema of the table.

+ *

A list of default values for a given decimal parameter. This structure only accepts static values.

* @public */ - InputColumns: InputColumn[] | undefined; + DefaultValues?: DecimalDatasetParameterDefaultValues | undefined; } /** - * @public - * @enum - */ -export const FileFormat = { - CLF: "CLF", - CSV: "CSV", - ELF: "ELF", - JSON: "JSON", - TSV: "TSV", - XLSX: "XLSX", -} as const; - -/** - * @public - */ -export type FileFormat = (typeof FileFormat)[keyof typeof FileFormat]; - -/** - * @public - * @enum - */ -export const TextQualifier = { - DOUBLE_QUOTE: "DOUBLE_QUOTE", - SINGLE_QUOTE: "SINGLE_QUOTE", -} as const; - -/** + *

The default values of an integer parameter.

* @public */ -export type TextQualifier = (typeof TextQualifier)[keyof typeof TextQualifier]; +export interface IntegerDatasetParameterDefaultValues { + /** + *

A list of static default values for a given integer parameter.

+ * @public + */ + StaticValues?: number[] | undefined; +} /** - *

Information about the format for a source file or files.

+ *

An integer parameter for a dataset.

* @public */ -export interface UploadSettings { +export interface IntegerDatasetParameter { /** - *

File format.

+ *

An identifier for the integer parameter created in the dataset.

* @public */ - Format?: FileFormat | undefined; + Id: string | undefined; /** - *

A row number to start reading data from.

+ *

The name of the integer parameter that is created in the dataset.

* @public */ - StartFromRow?: number | undefined; + Name: string | undefined; /** - *

Whether the file has a header row, or the files each have a header row.

+ *

The value type of the dataset parameter. Valid values are single value or multi value.

* @public */ - ContainsHeader?: boolean | undefined; + ValueType: DatasetParameterValueType | undefined; /** - *

Text qualifier.

+ *

A list of default values for a given integer parameter. This structure only accepts static values.

* @public */ - TextQualifier?: TextQualifier | undefined; + DefaultValues?: IntegerDatasetParameterDefaultValues | undefined; +} +/** + *

The default values of a string parameter.

+ * @public + */ +export interface StringDatasetParameterDefaultValues { /** - *

The delimiter between values in the file.

+ *

A list of static default values for a given string parameter.

* @public */ - Delimiter?: string | undefined; + StaticValues?: string[] | undefined; } /** - *

A physical table type for an S3 data source.

+ *

A string parameter for a dataset.

* @public */ -export interface S3Source { +export interface StringDatasetParameter { + /** + *

An identifier for the string parameter that is created in the dataset.

+ * @public + */ + Id: string | undefined; + /** - *

The Amazon Resource Name (ARN) for the data source.

+ *

The name of the string parameter that is created in the dataset.

* @public */ - DataSourceArn: string | undefined; + Name: string | undefined; /** - *

Information about the format for the S3 source file or files.

+ *

The value type of the dataset parameter. Valid values are single value or multi value.

* @public */ - UploadSettings?: UploadSettings | undefined; + ValueType: DatasetParameterValueType | undefined; /** - *

A physical table type for an S3 data source.

- * - *

For files that aren't JSON, only STRING data types are supported in input columns.

- *
+ *

A list of default values for a given string dataset parameter type. This structure only accepts static values.

* @public */ - InputColumns: InputColumn[] | undefined; + DefaultValues?: StringDatasetParameterDefaultValues | undefined; } /** - *

A view of a data source that contains information about the shape of the data in the - * underlying source. This is a variant type structure. For this structure to be valid, - * only one of the attributes can be non-null.

- * @public - */ -export type PhysicalTable = - | PhysicalTable.CustomSqlMember - | PhysicalTable.RelationalTableMember - | PhysicalTable.S3SourceMember - | PhysicalTable.$UnknownMember; - -/** + *

A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.

* @public */ -export namespace PhysicalTable { +export interface DatasetParameter { /** - *

A physical table type for relational data sources.

+ *

A string parameter that is created in the dataset.

* @public */ - export interface RelationalTableMember { - RelationalTable: RelationalTable; - CustomSql?: never; - S3Source?: never; - $unknown?: never; - } + StringDatasetParameter?: StringDatasetParameter | undefined; /** - *

A physical table type built from the results of the custom SQL query.

+ *

A decimal parameter that is created in the dataset.

* @public */ - export interface CustomSqlMember { - RelationalTable?: never; - CustomSql: CustomSql; - S3Source?: never; - $unknown?: never; - } + DecimalDatasetParameter?: DecimalDatasetParameter | undefined; /** - *

A physical table type for as S3 data source.

+ *

An integer parameter that is created in the dataset.

* @public */ - export interface S3SourceMember { - RelationalTable?: never; - CustomSql?: never; - S3Source: S3Source; - $unknown?: never; - } + IntegerDatasetParameter?: IntegerDatasetParameter | undefined; /** + *

A date time parameter that is created in the dataset.

* @public */ - export interface $UnknownMember { - RelationalTable?: never; - CustomSql?: never; - S3Source?: never; - $unknown: [string, any]; - } - - export interface Visitor { - RelationalTable: (value: RelationalTable) => T; - CustomSql: (value: CustomSql) => T; - S3Source: (value: S3Source) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: PhysicalTable, visitor: Visitor): T => { - if (value.RelationalTable !== undefined) return visitor.RelationalTable(value.RelationalTable); - if (value.CustomSql !== undefined) return visitor.CustomSql(value.CustomSql); - if (value.S3Source !== undefined) return visitor.S3Source(value.S3Source); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + DateTimeDatasetParameter?: DateTimeDatasetParameter | undefined; } -/** - * @public - * @enum - */ -export const RowLevelPermissionFormatVersion = { - VERSION_1: "VERSION_1", - VERSION_2: "VERSION_2", -} as const; - -/** - * @public - */ -export type RowLevelPermissionFormatVersion = - (typeof RowLevelPermissionFormatVersion)[keyof typeof RowLevelPermissionFormatVersion]; - -/** - * @public - * @enum - */ -export const RowLevelPermissionPolicy = { - DENY_ACCESS: "DENY_ACCESS", - GRANT_ACCESS: "GRANT_ACCESS", -} as const; - -/** - * @public - */ -export type RowLevelPermissionPolicy = (typeof RowLevelPermissionPolicy)[keyof typeof RowLevelPermissionPolicy]; - /** * @internal */ @@ -8997,48 +8949,3 @@ export const CreateDashboardRequestFilterSensitiveLog = (obj: CreateDashboardReq ...obj, ...(obj.Parameters && { Parameters: _ParametersFilterSensitiveLog(obj.Parameters) }), }); - -/** - * @internal - */ -export const FilterOperationFilterSensitiveLog = (obj: FilterOperation): any => ({ - ...obj, - ...(obj.ConditionExpression && { ConditionExpression: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const TagColumnOperationFilterSensitiveLog = (obj: TagColumnOperation): any => ({ - ...obj, - ...(obj.Tags && { Tags: obj.Tags.map((item) => ColumnTagFilterSensitiveLog(item)) }), -}); - -/** - * @internal - */ -export const TransformOperationFilterSensitiveLog = (obj: TransformOperation): any => { - if (obj.ProjectOperation !== undefined) return { ProjectOperation: obj.ProjectOperation }; - if (obj.FilterOperation !== undefined) - return { FilterOperation: FilterOperationFilterSensitiveLog(obj.FilterOperation) }; - if (obj.CreateColumnsOperation !== undefined) - return { CreateColumnsOperation: CreateColumnsOperationFilterSensitiveLog(obj.CreateColumnsOperation) }; - if (obj.RenameColumnOperation !== undefined) return { RenameColumnOperation: obj.RenameColumnOperation }; - if (obj.CastColumnTypeOperation !== undefined) return { CastColumnTypeOperation: obj.CastColumnTypeOperation }; - if (obj.TagColumnOperation !== undefined) - return { TagColumnOperation: TagColumnOperationFilterSensitiveLog(obj.TagColumnOperation) }; - if (obj.UntagColumnOperation !== undefined) return { UntagColumnOperation: obj.UntagColumnOperation }; - if (obj.OverrideDatasetParameterOperation !== undefined) - return { OverrideDatasetParameterOperation: obj.OverrideDatasetParameterOperation }; - if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; -}; - -/** - * @internal - */ -export const LogicalTableFilterSensitiveLog = (obj: LogicalTable): any => ({ - ...obj, - ...(obj.DataTransforms && { - DataTransforms: obj.DataTransforms.map((item) => TransformOperationFilterSensitiveLog(item)), - }), -}); diff --git a/clients/client-quicksight/src/models/models_3.ts b/clients/client-quicksight/src/models/models_3.ts index c6c79bc61a04..a2014452b5a6 100644 --- a/clients/client-quicksight/src/models/models_3.ts +++ b/clients/client-quicksight/src/models/models_3.ts @@ -47,6 +47,10 @@ import { AssignmentStatus, AuthorSpecifiedAggregation, BorderStyle, + BrandDefinition, + BrandDetail, + Capabilities, + CastColumnTypeOperation, CategoryFilterFunction, CategoryFilterType, CellValueSynonym, @@ -58,27 +62,24 @@ import { ColumnGroupSchema, ColumnLevelPermissionRule, ColumnSchema, + ColumnTag, + ColumnTagFilterSensitiveLog, + ColumnTagName, ComparativeOrder, ConstantType, + CreateColumnsOperation, + CreateColumnsOperationFilterSensitiveLog, DashboardPublishOptions, DashboardVersionDefinition, - DataSetImportMode, DatasetParameter, DataSetReference, - DataSetUsageConfiguration, DataSourceParameters, DisplayFormat, DisplayFormatOptions, - FieldFolder, FilterClass, FilterOperator, LinkSharingConfiguration, - LogicalTable, - LogicalTableFilterSensitiveLog, - PhysicalTable, ResourcePermission, - RowLevelPermissionFormatVersion, - RowLevelPermissionPolicy, ServiceType, SheetDefinition, SnapshotFile, @@ -92,980 +93,1057 @@ import { import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException"; /** - * @public - * @enum - */ -export const Status = { - DISABLED: "DISABLED", - ENABLED: "ENABLED", -} as const; - -/** - * @public - */ -export type Status = (typeof Status)[keyof typeof Status]; - -/** - *

Information about a dataset that contains permissions for row-level security (RLS). - * The permissions dataset maps fields to users or groups. For more information, see - * Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User - * Guide.

- *

The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is - * not supported for new RLS datasets.

+ *

The usage configuration to apply to child datasets that reference this dataset as a source.

* @public */ -export interface RowLevelPermissionDataSet { +export interface DataSetUsageConfiguration { /** - *

The namespace associated with the dataset that contains permissions for RLS.

+ *

An option that controls whether a child dataset of a direct query can use this dataset as a source.

* @public */ - Namespace?: string | undefined; + DisableUseAsDirectQuerySource?: boolean | undefined; /** - *

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

+ *

An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

* @public */ - Arn: string | undefined; + DisableUseAsImportedSource?: boolean | undefined; +} +/** + *

A FieldFolder element is a folder that contains fields and nested subfolders.

+ * @public + */ +export interface FieldFolder { /** - *

The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS - * is included for backward compatibility only.

+ *

The description for a field folder.

* @public */ - PermissionPolicy: RowLevelPermissionPolicy | undefined; + description?: string | undefined; /** - *

The user or group rules associated with the dataset that contains permissions for RLS.

- *

By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

+ *

A folder has a list of columns. A column can only be in one folder.

* @public */ - FormatVersion?: RowLevelPermissionFormatVersion | undefined; + columns?: string[] | undefined; +} + +/** + * @public + * @enum + */ +export const DataSetImportMode = { + DIRECT_QUERY: "DIRECT_QUERY", + SPICE: "SPICE", +} as const; + +/** + * @public + */ +export type DataSetImportMode = (typeof DataSetImportMode)[keyof typeof DataSetImportMode]; +/** + *

A transform operation that filters rows based on a condition.

+ * @public + */ +export interface FilterOperation { /** - *

The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

+ *

An expression that must evaluate to a Boolean value. Rows for which the expression + * evaluates to true are kept in the dataset.

* @public */ - Status?: Status | undefined; + ConditionExpression: string | undefined; } /** - *

A set of rules associated with a tag.

+ *

The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.

* @public */ -export interface RowLevelPermissionTagRule { +export interface NewDefaultValues { /** - *

The unique key for a tag.

+ *

A list of static default values for a given string parameter.

* @public */ - TagKey: string | undefined; + StringStaticValues?: string[] | undefined; /** - *

The column name that a tag key is assigned to.

+ *

A list of static default values for a given decimal parameter.

* @public */ - ColumnName: string | undefined; + DecimalStaticValues?: number[] | undefined; /** - *

A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.

+ *

A list of static default values for a given date time parameter.

* @public */ - TagMultiValueDelimiter?: string | undefined; + DateTimeStaticValues?: Date[] | undefined; /** - *

A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.

+ *

A list of static default values for a given integer parameter.

* @public */ - MatchAllValue?: string | undefined; + IntegerStaticValues?: number[] | undefined; } /** - *

The configuration of tags on a dataset to set row-level security.

+ *

A transform operation that overrides the dataset parameter values that are defined in another dataset.

* @public */ -export interface RowLevelPermissionTagConfiguration { +export interface OverrideDatasetParameterOperation { /** - *

The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

+ *

The name of the parameter to be overridden with different values.

* @public */ - Status?: Status | undefined; + ParameterName: string | undefined; /** - *

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

+ *

The new name for the parameter.

* @public */ - TagRules: RowLevelPermissionTagRule[] | undefined; + NewParameterName?: string | undefined; /** - *

A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.

+ *

The new default values for the parameter.

* @public */ - TagRuleConfigurations?: string[][] | undefined; + NewDefaultValues?: NewDefaultValues | undefined; } /** + *

A transform operation that projects columns. Operations that come after a projection + * can only refer to projected columns.

* @public */ -export interface CreateDataSetRequest { +export interface ProjectOperation { /** - *

The Amazon Web Services account ID.

+ *

Projected columns.

* @public */ - AwsAccountId: string | undefined; + ProjectedColumns: string[] | undefined; +} +/** + *

A transform operation that renames a column.

+ * @public + */ +export interface RenameColumnOperation { /** - *

An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The name of the column to be renamed.

* @public */ - DataSetId: string | undefined; + ColumnName: string | undefined; /** - *

The display name for the dataset.

+ *

The new name for the column.

* @public */ - Name: string | undefined; + NewColumnName: string | undefined; +} +/** + *

A transform operation that tags a column with additional information.

+ * @public + */ +export interface TagColumnOperation { /** - *

Declares the physical tables that are available in the underlying data sources.

+ *

The column that this operation acts on.

* @public */ - PhysicalTableMap: Record | undefined; + ColumnName: string | undefined; /** - *

Configures the combination and transformation of the data from the physical tables.

+ *

The dataset column tag, currently only used for geospatial type tagging.

+ * + *

This is not tags for the Amazon Web Services tagging feature.

+ *
* @public */ - LogicalTableMap?: Record | undefined; + Tags: ColumnTag[] | undefined; +} +/** + *

A transform operation that removes tags associated with a column.

+ * @public + */ +export interface UntagColumnOperation { /** - *

Indicates whether you want to import the data into SPICE.

+ *

The column that this operation acts on.

* @public */ - ImportMode: DataSetImportMode | undefined; + ColumnName: string | undefined; /** - *

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

+ *

The column tags to remove from this column.

* @public */ - ColumnGroups?: ColumnGroup[] | undefined; + TagNames: ColumnTagName[] | undefined; +} + +/** + *

A data transformation on a logical table. This is a variant type structure. For this + * structure to be valid, only one of the attributes can be non-null.

+ * @public + */ +export type TransformOperation = + | TransformOperation.CastColumnTypeOperationMember + | TransformOperation.CreateColumnsOperationMember + | TransformOperation.FilterOperationMember + | TransformOperation.OverrideDatasetParameterOperationMember + | TransformOperation.ProjectOperationMember + | TransformOperation.RenameColumnOperationMember + | TransformOperation.TagColumnOperationMember + | TransformOperation.UntagColumnOperationMember + | TransformOperation.$UnknownMember; +/** + * @public + */ +export namespace TransformOperation { /** - *

The folder that contains fields and nested subfolders for your dataset.

+ *

An operation that projects columns. Operations that come after a projection can only + * refer to projected columns.

* @public */ - FieldFolders?: Record | undefined; + export interface ProjectOperationMember { + ProjectOperation: ProjectOperation; + FilterOperation?: never; + CreateColumnsOperation?: never; + RenameColumnOperation?: never; + CastColumnTypeOperation?: never; + TagColumnOperation?: never; + UntagColumnOperation?: never; + OverrideDatasetParameterOperation?: never; + $unknown?: never; + } /** - *

A list of resource permissions on the dataset.

+ *

An operation that filters rows based on some condition.

* @public */ - Permissions?: ResourcePermission[] | undefined; + export interface FilterOperationMember { + ProjectOperation?: never; + FilterOperation: FilterOperation; + CreateColumnsOperation?: never; + RenameColumnOperation?: never; + CastColumnTypeOperation?: never; + TagColumnOperation?: never; + UntagColumnOperation?: never; + OverrideDatasetParameterOperation?: never; + $unknown?: never; + } /** - *

The row-level security configuration for the data that you want to create.

+ *

An operation that creates calculated columns. Columns created in one such operation + * form a lexical closure.

* @public */ - RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; + export interface CreateColumnsOperationMember { + ProjectOperation?: never; + FilterOperation?: never; + CreateColumnsOperation: CreateColumnsOperation; + RenameColumnOperation?: never; + CastColumnTypeOperation?: never; + TagColumnOperation?: never; + UntagColumnOperation?: never; + OverrideDatasetParameterOperation?: never; + $unknown?: never; + } /** - *

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

+ *

An operation that renames a column.

* @public */ - RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration | undefined; + export interface RenameColumnOperationMember { + ProjectOperation?: never; + FilterOperation?: never; + CreateColumnsOperation?: never; + RenameColumnOperation: RenameColumnOperation; + CastColumnTypeOperation?: never; + TagColumnOperation?: never; + UntagColumnOperation?: never; + OverrideDatasetParameterOperation?: never; + $unknown?: never; + } /** - *

A set of one or more definitions of a - * ColumnLevelPermissionRule - * .

+ *

A transform operation that casts a column to a different type.

* @public */ - ColumnLevelPermissionRules?: ColumnLevelPermissionRule[] | undefined; + export interface CastColumnTypeOperationMember { + ProjectOperation?: never; + FilterOperation?: never; + CreateColumnsOperation?: never; + RenameColumnOperation?: never; + CastColumnTypeOperation: CastColumnTypeOperation; + TagColumnOperation?: never; + UntagColumnOperation?: never; + OverrideDatasetParameterOperation?: never; + $unknown?: never; + } /** - *

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

+ *

An operation that tags a column with additional information.

* @public */ - Tags?: Tag[] | undefined; + export interface TagColumnOperationMember { + ProjectOperation?: never; + FilterOperation?: never; + CreateColumnsOperation?: never; + RenameColumnOperation?: never; + CastColumnTypeOperation?: never; + TagColumnOperation: TagColumnOperation; + UntagColumnOperation?: never; + OverrideDatasetParameterOperation?: never; + $unknown?: never; + } /** - *

The usage configuration to apply to child datasets that reference this dataset as a source.

+ *

A transform operation that removes tags associated with a column.

* @public */ - DataSetUsageConfiguration?: DataSetUsageConfiguration | undefined; + export interface UntagColumnOperationMember { + ProjectOperation?: never; + FilterOperation?: never; + CreateColumnsOperation?: never; + RenameColumnOperation?: never; + CastColumnTypeOperation?: never; + TagColumnOperation?: never; + UntagColumnOperation: UntagColumnOperation; + OverrideDatasetParameterOperation?: never; + $unknown?: never; + } /** - *

The parameter declarations of the dataset.

+ *

A transform operation that overrides the dataset parameter values that are defined in another dataset.

* @public */ - DatasetParameters?: DatasetParameter[] | undefined; + export interface OverrideDatasetParameterOperationMember { + ProjectOperation?: never; + FilterOperation?: never; + CreateColumnsOperation?: never; + RenameColumnOperation?: never; + CastColumnTypeOperation?: never; + TagColumnOperation?: never; + UntagColumnOperation?: never; + OverrideDatasetParameterOperation: OverrideDatasetParameterOperation; + $unknown?: never; + } /** - *

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

* @public */ - FolderArns?: string[] | undefined; + export interface $UnknownMember { + ProjectOperation?: never; + FilterOperation?: never; + CreateColumnsOperation?: never; + RenameColumnOperation?: never; + CastColumnTypeOperation?: never; + TagColumnOperation?: never; + UntagColumnOperation?: never; + OverrideDatasetParameterOperation?: never; + $unknown: [string, any]; + } + + export interface Visitor { + ProjectOperation: (value: ProjectOperation) => T; + FilterOperation: (value: FilterOperation) => T; + CreateColumnsOperation: (value: CreateColumnsOperation) => T; + RenameColumnOperation: (value: RenameColumnOperation) => T; + CastColumnTypeOperation: (value: CastColumnTypeOperation) => T; + TagColumnOperation: (value: TagColumnOperation) => T; + UntagColumnOperation: (value: UntagColumnOperation) => T; + OverrideDatasetParameterOperation: (value: OverrideDatasetParameterOperation) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: TransformOperation, visitor: Visitor): T => { + if (value.ProjectOperation !== undefined) return visitor.ProjectOperation(value.ProjectOperation); + if (value.FilterOperation !== undefined) return visitor.FilterOperation(value.FilterOperation); + if (value.CreateColumnsOperation !== undefined) return visitor.CreateColumnsOperation(value.CreateColumnsOperation); + if (value.RenameColumnOperation !== undefined) return visitor.RenameColumnOperation(value.RenameColumnOperation); + if (value.CastColumnTypeOperation !== undefined) + return visitor.CastColumnTypeOperation(value.CastColumnTypeOperation); + if (value.TagColumnOperation !== undefined) return visitor.TagColumnOperation(value.TagColumnOperation); + if (value.UntagColumnOperation !== undefined) return visitor.UntagColumnOperation(value.UntagColumnOperation); + if (value.OverrideDatasetParameterOperation !== undefined) + return visitor.OverrideDatasetParameterOperation(value.OverrideDatasetParameterOperation); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** + *

Properties associated with the columns participating in a join.

* @public */ -export interface CreateDataSetResponse { +export interface JoinKeyProperties { /** - *

The Amazon Resource Name (ARN) of the dataset.

+ *

A value that indicates that a row in a table is uniquely identified by the columns in + * a join key. This is used by Amazon QuickSight to optimize query performance.

* @public */ - Arn?: string | undefined; + UniqueKey?: boolean | undefined; +} + +/** + * @public + * @enum + */ +export const JoinType = { + INNER: "INNER", + LEFT: "LEFT", + OUTER: "OUTER", + RIGHT: "RIGHT", +} as const; + +/** + * @public + */ +export type JoinType = (typeof JoinType)[keyof typeof JoinType]; +/** + *

The instructions associated with a join.

+ * @public + */ +export interface JoinInstruction { /** - *

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The operand on the left side of a join.

* @public */ - DataSetId?: string | undefined; + LeftOperand: string | undefined; /** - *

The ARN for the ingestion, which is triggered as a result of dataset creation if the import - * mode is SPICE.

+ *

The operand on the right side of a join.

* @public */ - IngestionArn?: string | undefined; + RightOperand: string | undefined; /** - *

The ID of the ingestion, which is triggered as a result of dataset creation if the import - * mode is SPICE.

+ *

Join key properties of the left operand.

* @public */ - IngestionId?: string | undefined; + LeftJoinKeyProperties?: JoinKeyProperties | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

Join key properties of the right operand.

* @public */ - RequestId?: string | undefined; + RightJoinKeyProperties?: JoinKeyProperties | undefined; /** - *

The HTTP status of the request.

+ *

The type of join that it is.

* @public */ - Status?: number | undefined; + Type: JoinType | undefined; + + /** + *

The join instructions provided in the ON clause of a join.

+ * @public + */ + OnClause: string | undefined; } /** - *

The combination of user name and password that are used as credentials.

+ *

Information about the source of a logical table. This is a variant type structure. For + * this structure to be valid, only one of the attributes can be non-null.

* @public */ -export interface CredentialPair { +export interface LogicalTableSource { /** - *

User name.

+ *

Specifies the result of a join of two logical tables.

* @public */ - Username: string | undefined; + JoinInstruction?: JoinInstruction | undefined; /** - *

Password.

+ *

Physical table ID.

* @public */ - Password: string | undefined; + PhysicalTableId?: string | undefined; /** - *

A set of alternate data source parameters that you want to share for these - * credentials. The credentials are applied in tandem with the data source parameters when - * you copy a data source by using a create or update request. The API operation compares - * the DataSourceParameters structure that's in the request with the - * structures in the AlternateDataSourceParameters allow list. If the - * structures are an exact match, the request is allowed to use the new data source with - * the existing credentials. If the AlternateDataSourceParameters list is - * null, the DataSourceParameters originally used with these - * Credentials is automatically allowed.

+ *

The Amazon Resource Number (ARN) of the parent dataset.

* @public */ - AlternateDataSourceParameters?: DataSourceParameters[] | undefined; + DataSetArn?: string | undefined; } /** - *

Data source credentials. This is a variant type structure. For this structure to be - * valid, only one of the attributes can be non-null.

+ *

A logical table is a unit that joins and that data + * transformations operate on. A logical table has a source, which can be either a physical + * table or result of a join. When a logical table points to a physical table, the logical + * table acts as a mutable copy of that physical table through transform operations.

* @public */ -export interface DataSourceCredentials { +export interface LogicalTable { /** - *

Credential pair. For more information, see - * - * CredentialPair - * .

+ *

A display name for the logical table.

* @public */ - CredentialPair?: CredentialPair | undefined; + Alias: string | undefined; /** - *

The Amazon Resource Name (ARN) of a data source that has the credential pair that you - * want to use. When CopySourceArn is not null, the credential pair from the - * data source in the ARN is used as the credentials for the - * DataSourceCredentials structure.

+ *

Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.

* @public */ - CopySourceArn?: string | undefined; + DataTransforms?: TransformOperation[] | undefined; /** - *

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

+ *

Source of this logical table.

* @public */ - SecretArn?: string | undefined; + Source: LogicalTableSource | undefined; } /** * @public * @enum */ -export const DataSourceType = { - ADOBE_ANALYTICS: "ADOBE_ANALYTICS", - AMAZON_ELASTICSEARCH: "AMAZON_ELASTICSEARCH", - AMAZON_OPENSEARCH: "AMAZON_OPENSEARCH", - ATHENA: "ATHENA", - AURORA: "AURORA", - AURORA_POSTGRESQL: "AURORA_POSTGRESQL", - AWS_IOT_ANALYTICS: "AWS_IOT_ANALYTICS", - BIGQUERY: "BIGQUERY", - DATABRICKS: "DATABRICKS", - EXASOL: "EXASOL", - GITHUB: "GITHUB", - JIRA: "JIRA", - MARIADB: "MARIADB", - MYSQL: "MYSQL", - ORACLE: "ORACLE", - POSTGRESQL: "POSTGRESQL", - PRESTO: "PRESTO", - REDSHIFT: "REDSHIFT", - S3: "S3", - SALESFORCE: "SALESFORCE", - SERVICENOW: "SERVICENOW", - SNOWFLAKE: "SNOWFLAKE", - SPARK: "SPARK", - SQLSERVER: "SQLSERVER", - STARBURST: "STARBURST", - TERADATA: "TERADATA", - TIMESTREAM: "TIMESTREAM", - TRINO: "TRINO", - TWITTER: "TWITTER", +export const InputColumnDataType = { + BIT: "BIT", + BOOLEAN: "BOOLEAN", + DATETIME: "DATETIME", + DECIMAL: "DECIMAL", + INTEGER: "INTEGER", + JSON: "JSON", + STRING: "STRING", } as const; /** * @public */ -export type DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType]; +export type InputColumnDataType = (typeof InputColumnDataType)[keyof typeof InputColumnDataType]; /** + *

Metadata for a column that is used as the input of a transform operation.

* @public */ -export interface CreateDataSourceRequest { +export interface InputColumn { /** - *

The Amazon Web Services account ID.

+ *

The name of this column in the underlying data source.

* @public */ - AwsAccountId: string | undefined; + Name: string | undefined; /** - *

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The data type of the column.

* @public */ - DataSourceId: string | undefined; + Type: InputColumnDataType | undefined; /** - *

A display name for the data source.

+ *

The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.

* @public */ - Name: string | undefined; + SubType?: ColumnDataSubType | undefined; +} +/** + *

A physical table type built from the results of the custom SQL query.

+ * @public + */ +export interface CustomSql { /** - *

The type of the data source. To return a - * list of all data sources, use ListDataSources.

- *

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

+ *

The Amazon Resource Name (ARN) of the data source.

* @public */ - Type: DataSourceType | undefined; + DataSourceArn: string | undefined; /** - *

The parameters that Amazon QuickSight uses to connect to your underlying source.

+ *

A display name for the SQL query result.

* @public */ - DataSourceParameters?: DataSourceParameters | undefined; - - /** - *

The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only - * credentials based on user name and password are supported.

- * @public - */ - Credentials?: DataSourceCredentials | undefined; - - /** - *

A list of resource permissions on the data source.

- * @public - */ - Permissions?: ResourcePermission[] | undefined; - - /** - *

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to - * your underlying source.

- * @public - */ - VpcConnectionProperties?: VpcConnectionProperties | undefined; - - /** - *

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

- * @public - */ - SslProperties?: SslProperties | undefined; + Name: string | undefined; /** - *

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

+ *

The SQL query.

* @public */ - Tags?: Tag[] | undefined; + SqlQuery: string | undefined; /** - *

When you create the data source, Amazon QuickSight adds the data source to these folders.

+ *

The column schema from the SQL query result set.

* @public */ - FolderArns?: string[] | undefined; + Columns?: InputColumn[] | undefined; } /** + *

A physical table type for relational data sources.

* @public */ -export interface CreateDataSourceResponse { +export interface RelationalTable { /** - *

The Amazon Resource Name (ARN) of the data source.

- * @public - */ - Arn?: string | undefined; - - /** - *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The Amazon Resource Name (ARN) for the data source.

* @public */ - DataSourceId?: string | undefined; + DataSourceArn: string | undefined; /** - *

The status of creating the data source.

+ *

The catalog associated with a table.

* @public */ - CreationStatus?: ResourceStatus | undefined; + Catalog?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The schema name. This name applies to certain relational database engines.

* @public */ - RequestId?: string | undefined; + Schema?: string | undefined; /** - *

The HTTP status of the request.

+ *

The name of the relational table.

* @public */ - Status?: number | undefined; -} + Name: string | undefined; -/** - *

The customer managed key that is registered to your Amazon QuickSight account is unavailable.

- * @public - */ -export class CustomerManagedKeyUnavailableException extends __BaseException { - readonly name: "CustomerManagedKeyUnavailableException" = "CustomerManagedKeyUnavailableException"; - readonly $fault: "client" = "client"; - Message?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The column schema of the table.

* @public */ - RequestId?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "CustomerManagedKeyUnavailableException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, CustomerManagedKeyUnavailableException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } + InputColumns: InputColumn[] | undefined; } /** * @public * @enum */ -export const FolderType = { - RESTRICTED: "RESTRICTED", - SHARED: "SHARED", +export const FileFormat = { + CLF: "CLF", + CSV: "CSV", + ELF: "ELF", + JSON: "JSON", + TSV: "TSV", + XLSX: "XLSX", } as const; /** * @public */ -export type FolderType = (typeof FolderType)[keyof typeof FolderType]; +export type FileFormat = (typeof FileFormat)[keyof typeof FileFormat]; /** * @public * @enum */ -export const SharingModel = { - ACCOUNT: "ACCOUNT", - NAMESPACE: "NAMESPACE", +export const TextQualifier = { + DOUBLE_QUOTE: "DOUBLE_QUOTE", + SINGLE_QUOTE: "SINGLE_QUOTE", } as const; /** * @public */ -export type SharingModel = (typeof SharingModel)[keyof typeof SharingModel]; +export type TextQualifier = (typeof TextQualifier)[keyof typeof TextQualifier]; /** + *

Information about the format for a source file or files.

* @public */ -export interface CreateFolderRequest { +export interface UploadSettings { /** - *

The ID for the Amazon Web Services account where you want to create the folder.

+ *

File format.

* @public */ - AwsAccountId: string | undefined; + Format?: FileFormat | undefined; /** - *

The ID of the folder.

+ *

A row number to start reading data from.

* @public */ - FolderId: string | undefined; + StartFromRow?: number | undefined; /** - *

The name of the folder.

+ *

Whether the file has a header row, or the files each have a header row.

* @public */ - Name?: string | undefined; + ContainsHeader?: boolean | undefined; /** - *

The type of folder. By default, folderType is SHARED.

+ *

Text qualifier.

* @public */ - FolderType?: FolderType | undefined; + TextQualifier?: TextQualifier | undefined; /** - *

The Amazon Resource Name (ARN) for the parent folder.

- *

- * ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

+ *

The delimiter between values in the file.

* @public */ - ParentFolderArn?: string | undefined; + Delimiter?: string | undefined; +} +/** + *

A physical table type for an S3 data source.

+ * @public + */ +export interface S3Source { /** - *

A structure that describes the principals and the resource-level permissions of a folder.

- *

To specify no permissions, omit Permissions.

+ *

The Amazon Resource Name (ARN) for the data source.

* @public */ - Permissions?: ResourcePermission[] | undefined; + DataSourceArn: string | undefined; /** - *

Tags for the folder.

+ *

Information about the format for the S3 source file or files.

* @public */ - Tags?: Tag[] | undefined; + UploadSettings?: UploadSettings | undefined; /** - *

An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

+ *

A physical table type for an S3 data source.

+ * + *

For files that aren't JSON, only STRING data types are supported in input columns.

+ *
* @public */ - SharingModel?: SharingModel | undefined; + InputColumns: InputColumn[] | undefined; } /** + *

A view of a data source that contains information about the shape of the data in the + * underlying source. This is a variant type structure. For this structure to be valid, + * only one of the attributes can be non-null.

* @public */ -export interface CreateFolderResponse { +export type PhysicalTable = + | PhysicalTable.CustomSqlMember + | PhysicalTable.RelationalTableMember + | PhysicalTable.S3SourceMember + | PhysicalTable.$UnknownMember; + +/** + * @public + */ +export namespace PhysicalTable { /** - *

The HTTP status of the request.

+ *

A physical table type for relational data sources.

* @public */ - Status?: number | undefined; + export interface RelationalTableMember { + RelationalTable: RelationalTable; + CustomSql?: never; + S3Source?: never; + $unknown?: never; + } /** - *

The Amazon Resource Name (ARN) for the newly created folder.

+ *

A physical table type built from the results of the custom SQL query.

* @public */ - Arn?: string | undefined; + export interface CustomSqlMember { + RelationalTable?: never; + CustomSql: CustomSql; + S3Source?: never; + $unknown?: never; + } /** - *

The folder ID for the newly created folder.

+ *

A physical table type for as S3 data source.

* @public */ - FolderId?: string | undefined; + export interface S3SourceMember { + RelationalTable?: never; + CustomSql?: never; + S3Source: S3Source; + $unknown?: never; + } /** - *

The request ID for the newly created folder.

* @public */ - RequestId?: string | undefined; + export interface $UnknownMember { + RelationalTable?: never; + CustomSql?: never; + S3Source?: never; + $unknown: [string, any]; + } + + export interface Visitor { + RelationalTable: (value: RelationalTable) => T; + CustomSql: (value: CustomSql) => T; + S3Source: (value: S3Source) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: PhysicalTable, visitor: Visitor): T => { + if (value.RelationalTable !== undefined) return visitor.RelationalTable(value.RelationalTable); + if (value.CustomSql !== undefined) return visitor.CustomSql(value.CustomSql); + if (value.S3Source !== undefined) return visitor.S3Source(value.S3Source); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** * @public * @enum */ -export const MemberType = { - ANALYSIS: "ANALYSIS", - DASHBOARD: "DASHBOARD", - DATASET: "DATASET", - DATASOURCE: "DATASOURCE", - TOPIC: "TOPIC", +export const RowLevelPermissionFormatVersion = { + VERSION_1: "VERSION_1", + VERSION_2: "VERSION_2", } as const; /** * @public */ -export type MemberType = (typeof MemberType)[keyof typeof MemberType]; +export type RowLevelPermissionFormatVersion = + (typeof RowLevelPermissionFormatVersion)[keyof typeof RowLevelPermissionFormatVersion]; /** * @public + * @enum */ -export interface CreateFolderMembershipRequest { - /** - *

The ID for the Amazon Web Services account that contains the folder.

- * @public - */ - AwsAccountId: string | undefined; +export const RowLevelPermissionPolicy = { + DENY_ACCESS: "DENY_ACCESS", + GRANT_ACCESS: "GRANT_ACCESS", +} as const; - /** - *

The ID of the folder.

- * @public - */ - FolderId: string | undefined; +/** + * @public + */ +export type RowLevelPermissionPolicy = (typeof RowLevelPermissionPolicy)[keyof typeof RowLevelPermissionPolicy]; - /** - *

The ID of the asset that you want to add to the folder.

- * @public - */ - MemberId: string | undefined; +/** + * @public + * @enum + */ +export const Status = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", +} as const; - /** - *

The member type of the asset that you want to add to a folder.

- * @public - */ - MemberType: MemberType | undefined; -} +/** + * @public + */ +export type Status = (typeof Status)[keyof typeof Status]; /** - *

An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.

+ *

Information about a dataset that contains permissions for row-level security (RLS). + * The permissions dataset maps fields to users or groups. For more information, see + * Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User + * Guide.

+ *

The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is + * not supported for new RLS datasets.

* @public */ -export interface FolderMember { +export interface RowLevelPermissionDataSet { /** - *

The ID of an asset in the folder.

+ *

The namespace associated with the dataset that contains permissions for RLS.

* @public */ - MemberId?: string | undefined; + Namespace?: string | undefined; /** - *

The type of asset that it is.

+ *

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

* @public */ - MemberType?: MemberType | undefined; -} + Arn: string | undefined; -/** - * @public - */ -export interface CreateFolderMembershipResponse { /** - *

The HTTP status of the request.

+ *

The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS + * is included for backward compatibility only.

* @public */ - Status?: number | undefined; + PermissionPolicy: RowLevelPermissionPolicy | undefined; /** - *

Information about the member in the folder.

+ *

The user or group rules associated with the dataset that contains permissions for RLS.

+ *

By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

* @public */ - FolderMember?: FolderMember | undefined; + FormatVersion?: RowLevelPermissionFormatVersion | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

* @public */ - RequestId?: string | undefined; + Status?: Status | undefined; } /** - *

The request object for this operation.

+ *

A set of rules associated with a tag.

* @public */ -export interface CreateGroupRequest { +export interface RowLevelPermissionTagRule { /** - *

A name for the group that you want to create.

+ *

The unique key for a tag.

* @public */ - GroupName: string | undefined; + TagKey: string | undefined; /** - *

A description for the group that you want to create.

+ *

The column name that a tag key is assigned to.

* @public */ - Description?: string | undefined; + ColumnName: string | undefined; /** - *

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the - * Amazon Web Services account that contains your Amazon QuickSight account.

+ *

A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.

* @public */ - AwsAccountId: string | undefined; + TagMultiValueDelimiter?: string | undefined; /** - *

The namespace that you want the group to be a part of.

+ *

A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.

* @public */ - Namespace: string | undefined; + MatchAllValue?: string | undefined; } /** - *

A group in Amazon QuickSight consists of a set of users. You can - * use groups to make it easier to manage access and security.

+ *

The configuration of tags on a dataset to set row-level security.

* @public */ -export interface Group { - /** - *

The Amazon Resource Name (ARN) for the group.

- * @public - */ - Arn?: string | undefined; - +export interface RowLevelPermissionTagConfiguration { /** - *

The name of the group.

+ *

The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

* @public */ - GroupName?: string | undefined; + Status?: Status | undefined; /** - *

The group description.

+ *

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

* @public */ - Description?: string | undefined; + TagRules: RowLevelPermissionTagRule[] | undefined; /** - *

The principal ID of the group.

+ *

A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.

* @public */ - PrincipalId?: string | undefined; + TagRuleConfigurations?: string[][] | undefined; } /** - *

The response object for this operation.

* @public */ -export interface CreateGroupResponse { +export interface CreateDataSetRequest { /** - *

The name of the group.

+ *

The Amazon Web Services account ID.

* @public */ - Group?: Group | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; - - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; -} - -/** - * @public - */ -export interface CreateGroupMembershipRequest { - /** - *

The name of the user that you want to add to the group membership.

+ *

An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - MemberName: string | undefined; + DataSetId: string | undefined; /** - *

The name of the group that you want to add the user to.

+ *

The display name for the dataset.

* @public */ - GroupName: string | undefined; + Name: string | undefined; /** - *

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the - * Amazon Web Services account that contains your Amazon QuickSight account.

+ *

Declares the physical tables that are available in the underlying data sources.

* @public */ - AwsAccountId: string | undefined; + PhysicalTableMap: Record | undefined; /** - *

The namespace that you want the user to be a part of.

+ *

Configures the combination and transformation of the data from the physical tables.

* @public */ - Namespace: string | undefined; -} + LogicalTableMap?: Record | undefined; -/** - *

A member of an Amazon QuickSight group. Currently, group members must be users. Groups - * can't be members of another group. .

- * @public - */ -export interface GroupMember { /** - *

The Amazon Resource Name (ARN) for the group member (user).

+ *

Indicates whether you want to import the data into SPICE.

* @public */ - Arn?: string | undefined; + ImportMode: DataSetImportMode | undefined; /** - *

The name of the group member (user).

+ *

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

* @public */ - MemberName?: string | undefined; -} + ColumnGroups?: ColumnGroup[] | undefined; -/** - * @public - */ -export interface CreateGroupMembershipResponse { /** - *

The group member.

+ *

The folder that contains fields and nested subfolders for your dataset.

* @public */ - GroupMember?: GroupMember | undefined; + FieldFolders?: Record | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

A list of resource permissions on the dataset.

* @public */ - RequestId?: string | undefined; + Permissions?: ResourcePermission[] | undefined; /** - *

The HTTP status of the request.

+ *

The row-level security configuration for the data that you want to create.

* @public */ - Status?: number | undefined; -} + RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; -/** - * @public - */ -export interface CreateIAMPolicyAssignmentRequest { /** - *

The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.

+ *

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

* @public */ - AwsAccountId: string | undefined; + RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration | undefined; /** - *

The name of the assignment, also called a rule. - * The - * name - * must be unique within the - * Amazon Web Services account.

+ *

A set of one or more definitions of a + * ColumnLevelPermissionRule + * .

* @public */ - AssignmentName: string | undefined; + ColumnLevelPermissionRules?: ColumnLevelPermissionRule[] | undefined; /** - *

The status of the assignment. Possible values are as follows:

- *
    - *
  • - *

    - * ENABLED - Anything specified in this assignment is used when - * creating the data source.

    - *
  • - *
  • - *

    - * DISABLED - This assignment isn't used when creating the data - * source.

    - *
  • - *
  • - *

    - * DRAFT - This assignment is an unfinished draft and isn't used - * when creating the data source.

    - *
  • - *
+ *

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

* @public */ - AssignmentStatus: AssignmentStatus | undefined; + Tags?: Tag[] | undefined; /** - *

The ARN for the IAM policy to apply to the Amazon QuickSight users and - * groups specified in this assignment.

+ *

The usage configuration to apply to child datasets that reference this dataset as a source.

* @public */ - PolicyArn?: string | undefined; + DataSetUsageConfiguration?: DataSetUsageConfiguration | undefined; /** - *

The Amazon QuickSight users, groups, or both that you want to assign the policy - * to.

+ *

The parameter declarations of the dataset.

* @public */ - Identities?: Record | undefined; + DatasetParameters?: DatasetParameter[] | undefined; /** - *

The namespace that contains the assignment.

+ *

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

* @public */ - Namespace: string | undefined; + FolderArns?: string[] | undefined; } /** * @public */ -export interface CreateIAMPolicyAssignmentResponse { - /** - *

The name of the assignment. - * The - * name must be unique within the Amazon Web Services account.

- * @public - */ - AssignmentName?: string | undefined; - +export interface CreateDataSetResponse { /** - *

The ID for the assignment.

+ *

The Amazon Resource Name (ARN) of the dataset.

* @public */ - AssignmentId?: string | undefined; + Arn?: string | undefined; /** - *

The status of the assignment. Possible values are as follows:

- *
    - *
  • - *

    - * ENABLED - Anything specified in this assignment is used when - * creating the data source.

    - *
  • - *
  • - *

    - * DISABLED - This assignment isn't used when creating the data - * source.

    - *
  • - *
  • - *

    - * DRAFT - This assignment is an unfinished draft and isn't used - * when creating the data source.

    - *
  • - *
+ *

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - AssignmentStatus?: AssignmentStatus | undefined; + DataSetId?: string | undefined; /** - *

The ARN for the IAM policy that is applied to the Amazon QuickSight - * users and groups specified in this assignment.

+ *

The ARN for the ingestion, which is triggered as a result of dataset creation if the import + * mode is SPICE.

* @public */ - PolicyArn?: string | undefined; + IngestionArn?: string | undefined; /** - *

The Amazon QuickSight users, groups, or both that the IAM policy is - * assigned to.

+ *

The ID of the ingestion, which is triggered as a result of dataset creation if the import + * mode is SPICE.

* @public */ - Identities?: Record | undefined; + IngestionId?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -1081,200 +1159,205 @@ export interface CreateIAMPolicyAssignmentResponse { } /** - * @public - * @enum - */ -export const IngestionType = { - FULL_REFRESH: "FULL_REFRESH", - INCREMENTAL_REFRESH: "INCREMENTAL_REFRESH", -} as const; - -/** - * @public - */ -export type IngestionType = (typeof IngestionType)[keyof typeof IngestionType]; - -/** + *

The combination of user name and password that are used as credentials.

* @public */ -export interface CreateIngestionRequest { - /** - *

The ID of the dataset used in the ingestion.

- * @public - */ - DataSetId: string | undefined; - +export interface CredentialPair { /** - *

An ID for the ingestion.

+ *

User name.

* @public */ - IngestionId: string | undefined; + Username: string | undefined; /** - *

The Amazon Web Services account ID.

+ *

Password.

* @public */ - AwsAccountId: string | undefined; + Password: string | undefined; /** - *

The type of ingestion that you want to create.

+ *

A set of alternate data source parameters that you want to share for these + * credentials. The credentials are applied in tandem with the data source parameters when + * you copy a data source by using a create or update request. The API operation compares + * the DataSourceParameters structure that's in the request with the + * structures in the AlternateDataSourceParameters allow list. If the + * structures are an exact match, the request is allowed to use the new data source with + * the existing credentials. If the AlternateDataSourceParameters list is + * null, the DataSourceParameters originally used with these + * Credentials is automatically allowed.

* @public */ - IngestionType?: IngestionType | undefined; + AlternateDataSourceParameters?: DataSourceParameters[] | undefined; } /** - * @public - * @enum - */ -export const IngestionStatus = { - CANCELLED: "CANCELLED", - COMPLETED: "COMPLETED", - FAILED: "FAILED", - INITIALIZED: "INITIALIZED", - QUEUED: "QUEUED", - RUNNING: "RUNNING", -} as const; - -/** - * @public - */ -export type IngestionStatus = (typeof IngestionStatus)[keyof typeof IngestionStatus]; - -/** + *

Data source credentials. This is a variant type structure. For this structure to be + * valid, only one of the attributes can be non-null.

* @public */ -export interface CreateIngestionResponse { +export interface DataSourceCredentials { /** - *

The Amazon Resource Name (ARN) for the data ingestion.

+ *

Credential pair. For more information, see + * + * CredentialPair + * .

* @public */ - Arn?: string | undefined; + CredentialPair?: CredentialPair | undefined; /** - *

An ID for the ingestion.

+ *

The Amazon Resource Name (ARN) of a data source that has the credential pair that you + * want to use. When CopySourceArn is not null, the credential pair from the + * data source in the ARN is used as the credentials for the + * DataSourceCredentials structure.

* @public */ - IngestionId?: string | undefined; + CopySourceArn?: string | undefined; /** - *

The ingestion status.

+ *

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

* @public */ - IngestionStatus?: IngestionStatus | undefined; - - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; - - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; -} + SecretArn?: string | undefined; +} /** * @public * @enum */ -export const IdentityStore = { - QUICKSIGHT: "QUICKSIGHT", +export const DataSourceType = { + ADOBE_ANALYTICS: "ADOBE_ANALYTICS", + AMAZON_ELASTICSEARCH: "AMAZON_ELASTICSEARCH", + AMAZON_OPENSEARCH: "AMAZON_OPENSEARCH", + ATHENA: "ATHENA", + AURORA: "AURORA", + AURORA_POSTGRESQL: "AURORA_POSTGRESQL", + AWS_IOT_ANALYTICS: "AWS_IOT_ANALYTICS", + BIGQUERY: "BIGQUERY", + DATABRICKS: "DATABRICKS", + EXASOL: "EXASOL", + GITHUB: "GITHUB", + JIRA: "JIRA", + MARIADB: "MARIADB", + MYSQL: "MYSQL", + ORACLE: "ORACLE", + POSTGRESQL: "POSTGRESQL", + PRESTO: "PRESTO", + REDSHIFT: "REDSHIFT", + S3: "S3", + SALESFORCE: "SALESFORCE", + SERVICENOW: "SERVICENOW", + SNOWFLAKE: "SNOWFLAKE", + SPARK: "SPARK", + SQLSERVER: "SQLSERVER", + STARBURST: "STARBURST", + TERADATA: "TERADATA", + TIMESTREAM: "TIMESTREAM", + TRINO: "TRINO", + TWITTER: "TWITTER", } as const; /** * @public */ -export type IdentityStore = (typeof IdentityStore)[keyof typeof IdentityStore]; +export type DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType]; /** * @public */ -export interface CreateNamespaceRequest { +export interface CreateDataSourceRequest { /** - *

The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.

+ *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** - *

The name that you want to use to describe the new namespace.

+ *

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - Namespace: string | undefined; + DataSourceId: string | undefined; /** - *

Specifies the type of your user identity directory. Currently, this supports users - * with an identity type of QUICKSIGHT.

+ *

A display name for the data source.

* @public */ - IdentityStore: IdentityStore | undefined; + Name: string | undefined; /** - *

The tags that you want to associate with the namespace that you're creating.

+ *

The type of the data source. To return a + * list of all data sources, use ListDataSources.

+ *

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

* @public */ - Tags?: Tag[] | undefined; -} + Type: DataSourceType | undefined; -/** - * @public - * @enum - */ -export const NamespaceStatus = { - CREATED: "CREATED", - CREATING: "CREATING", - DELETING: "DELETING", - NON_RETRYABLE_FAILURE: "NON_RETRYABLE_FAILURE", - RETRYABLE_FAILURE: "RETRYABLE_FAILURE", -} as const; + /** + *

The parameters that Amazon QuickSight uses to connect to your underlying source.

+ * @public + */ + DataSourceParameters?: DataSourceParameters | undefined; -/** - * @public - */ -export type NamespaceStatus = (typeof NamespaceStatus)[keyof typeof NamespaceStatus]; + /** + *

The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only + * credentials based on user name and password are supported.

+ * @public + */ + Credentials?: DataSourceCredentials | undefined; -/** - * @public - */ -export interface CreateNamespaceResponse { /** - *

The ARN of the Amazon QuickSight namespace you created.

+ *

A list of resource permissions on the data source.

* @public */ - Arn?: string | undefined; + Permissions?: ResourcePermission[] | undefined; /** - *

The name of the new namespace that you created.

+ *

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to + * your underlying source.

* @public */ - Name?: string | undefined; + VpcConnectionProperties?: VpcConnectionProperties | undefined; /** - *

The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace. - * This is set to the region that you run CreateNamespace in.

+ *

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

* @public */ - CapacityRegion?: string | undefined; + SslProperties?: SslProperties | undefined; /** - *

The status of the creation of the namespace. This is an asynchronous process. A status - * of CREATED means that your namespace is ready to use. If an error occurs, - * it indicates if the process is retryable or non-retryable. In - * the case of a non-retryable error, refer to the error message for follow-up - * tasks.

+ *

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

* @public */ - CreationStatus?: NamespaceStatus | undefined; + Tags?: Tag[] | undefined; /** - *

Specifies the type of your user identity directory. Currently, this supports users - * with an identity type of QUICKSIGHT.

+ *

When you create the data source, Amazon QuickSight adds the data source to these folders.

* @public */ - IdentityStore?: IdentityStore | undefined; + FolderArns?: string[] | undefined; +} + +/** + * @public + */ +export interface CreateDataSourceResponse { + /** + *

The Amazon Resource Name (ARN) of the data source.

+ * @public + */ + Arn?: string | undefined; + + /** + *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ * @public + */ + DataSourceId?: string | undefined; + + /** + *

The status of creating the data source.

+ * @public + */ + CreationStatus?: ResourceStatus | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -1289,191 +1372,122 @@ export interface CreateNamespaceResponse { Status?: number | undefined; } +/** + *

The customer managed key that is registered to your Amazon QuickSight account is unavailable.

+ * @public + */ +export class CustomerManagedKeyUnavailableException extends __BaseException { + readonly name: "CustomerManagedKeyUnavailableException" = "CustomerManagedKeyUnavailableException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType) { + super({ + name: "CustomerManagedKeyUnavailableException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, CustomerManagedKeyUnavailableException.prototype); + this.Message = opts.Message; + this.RequestId = opts.RequestId; + } +} + /** * @public * @enum */ -export const RefreshInterval = { - DAILY: "DAILY", - HOURLY: "HOURLY", - MINUTE15: "MINUTE15", - MINUTE30: "MINUTE30", - MONTHLY: "MONTHLY", - WEEKLY: "WEEKLY", +export const FolderType = { + RESTRICTED: "RESTRICTED", + SHARED: "SHARED", } as const; /** * @public */ -export type RefreshInterval = (typeof RefreshInterval)[keyof typeof RefreshInterval]; +export type FolderType = (typeof FolderType)[keyof typeof FolderType]; /** * @public * @enum */ -export const DayOfWeek = { - FRIDAY: "FRIDAY", - MONDAY: "MONDAY", - SATURDAY: "SATURDAY", - SUNDAY: "SUNDAY", - THURSDAY: "THURSDAY", - TUESDAY: "TUESDAY", - WEDNESDAY: "WEDNESDAY", +export const SharingModel = { + ACCOUNT: "ACCOUNT", + NAMESPACE: "NAMESPACE", } as const; /** * @public */ -export type DayOfWeek = (typeof DayOfWeek)[keyof typeof DayOfWeek]; +export type SharingModel = (typeof SharingModel)[keyof typeof SharingModel]; /** - *

The refresh on entity for weekly or monthly schedules.

* @public */ -export interface ScheduleRefreshOnEntity { +export interface CreateFolderRequest { /** - *

The day of the week that you want to schedule a refresh on.

+ *

The ID for the Amazon Web Services account where you want to create the folder.

* @public */ - DayOfWeek?: DayOfWeek | undefined; + AwsAccountId: string | undefined; /** - *

The day of the month that you want to schedule refresh on.

+ *

The ID of the folder.

* @public */ - DayOfMonth?: string | undefined; -} + FolderId: string | undefined; -/** - *

Specifies the interval between each scheduled refresh of a dataset.

- * @public - */ -export interface RefreshFrequency { /** - *

The interval between scheduled refreshes. Valid values are as follows:

- *
    - *
  • - *

    - * MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

    - *
  • - *
  • - *

    - * MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

    - *
  • - *
  • - *

    - * HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.

    - *
  • - *
  • - *

    - * DAILY: The dataset refreshes every day.

    - *
  • - *
  • - *

    - * WEEKLY: The dataset refreshes every week.

    - *
  • - *
  • - *

    - * MONTHLY: The dataset refreshes every month.

    - *
  • - *
+ *

The name of the folder.

* @public */ - Interval: RefreshInterval | undefined; + Name?: string | undefined; /** - *

The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

+ *

The type of folder. By default, folderType is SHARED.

* @public */ - RefreshOnDay?: ScheduleRefreshOnEntity | undefined; + FolderType?: FolderType | undefined; /** - *

The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().

+ *

The Amazon Resource Name (ARN) for the parent folder.

+ *

+ * ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

* @public */ - Timezone?: string | undefined; + ParentFolderArn?: string | undefined; /** - *

The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.

+ *

A structure that describes the principals and the resource-level permissions of a folder.

+ *

To specify no permissions, omit Permissions.

* @public */ - TimeOfTheDay?: string | undefined; -} - -/** - *

The refresh schedule of a dataset.

- * @public - */ -export interface RefreshSchedule { - /** - *

An identifier for the refresh schedule.

- * @public - */ - ScheduleId: string | undefined; - - /** - *

The frequency for the refresh schedule.

- * @public - */ - ScheduleFrequency: RefreshFrequency | undefined; - - /** - *

Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

- * @public - */ - StartAfterDateTime?: Date | undefined; - - /** - *

The type of refresh that a datset undergoes. Valid values are as follows:

- *
    - *
  • - *

    - * FULL_REFRESH: A complete refresh of a dataset.

    - *
  • - *
  • - *

    - * INCREMENTAL_REFRESH: A partial refresh of some rows of a dataset, based on the time window specified.

    - *
  • - *
- *

For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.

- * @public - */ - RefreshType: IngestionType | undefined; - - /** - *

The Amazon Resource Name (ARN) for the refresh schedule.

- * @public - */ - Arn?: string | undefined; -} - -/** - * @public - */ -export interface CreateRefreshScheduleRequest { - /** - *

The ID of the dataset.

- * @public - */ - DataSetId: string | undefined; + Permissions?: ResourcePermission[] | undefined; /** - *

The Amazon Web Services account ID.

+ *

Tags for the folder.

* @public */ - AwsAccountId: string | undefined; + Tags?: Tag[] | undefined; /** - *

The refresh schedule.

+ *

An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

* @public */ - Schedule: RefreshSchedule | undefined; + SharingModel?: SharingModel | undefined; } /** * @public */ -export interface CreateRefreshScheduleResponse { +export interface CreateFolderResponse { /** *

The HTTP status of the request.

* @public @@ -1481,4253 +1495,3989 @@ export interface CreateRefreshScheduleResponse { Status?: number | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The Amazon Resource Name (ARN) for the newly created folder.

* @public */ - RequestId?: string | undefined; + Arn?: string | undefined; /** - *

The ID of the refresh schedule.

+ *

The folder ID for the newly created folder.

* @public */ - ScheduleId?: string | undefined; + FolderId?: string | undefined; /** - *

The Amazon Resource Name (ARN) for the refresh schedule.

+ *

The request ID for the newly created folder.

* @public */ - Arn?: string | undefined; + RequestId?: string | undefined; } /** * @public * @enum */ -export const Role = { - ADMIN: "ADMIN", - ADMIN_PRO: "ADMIN_PRO", - AUTHOR: "AUTHOR", - AUTHOR_PRO: "AUTHOR_PRO", - READER: "READER", - READER_PRO: "READER_PRO", +export const MemberType = { + ANALYSIS: "ANALYSIS", + DASHBOARD: "DASHBOARD", + DATASET: "DATASET", + DATASOURCE: "DATASOURCE", + TOPIC: "TOPIC", } as const; /** * @public */ -export type Role = (typeof Role)[keyof typeof Role]; +export type MemberType = (typeof MemberType)[keyof typeof MemberType]; /** * @public */ -export interface CreateRoleMembershipRequest { +export interface CreateFolderMembershipRequest { /** - *

The name of the group that you want to add to the role.

+ *

The ID for the Amazon Web Services account that contains the folder.

* @public */ - MemberName: string | undefined; + AwsAccountId: string | undefined; /** - *

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

+ *

The ID of the folder.

* @public */ - AwsAccountId: string | undefined; + FolderId: string | undefined; /** - *

The namespace that the role belongs to.

+ *

The ID of the asset that you want to add to the folder.

* @public */ - Namespace: string | undefined; + MemberId: string | undefined; /** - *

The role that you want to add a group to.

+ *

The member type of the asset that you want to add to a folder.

* @public */ - Role: Role | undefined; + MemberType: MemberType | undefined; } /** + *

An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.

* @public */ -export interface CreateRoleMembershipResponse { - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; - +export interface FolderMember { /** - *

The HTTP status of the request.

+ *

The ID of an asset in the folder.

* @public */ - Status?: number | undefined; -} + MemberId?: string | undefined; -/** - *

Dataset schema.

- * @public - */ -export interface DataSetSchema { /** - *

A structure containing the list of column schemas.

+ *

The type of asset that it is.

* @public */ - ColumnSchemaList?: ColumnSchema[] | undefined; + MemberType?: MemberType | undefined; } /** - *

Dataset configuration.

* @public */ -export interface DataSetConfiguration { +export interface CreateFolderMembershipResponse { /** - *

Placeholder.

+ *

The HTTP status of the request.

* @public */ - Placeholder?: string | undefined; + Status?: number | undefined; /** - *

Dataset schema.

+ *

Information about the member in the folder.

* @public */ - DataSetSchema?: DataSetSchema | undefined; + FolderMember?: FolderMember | undefined; /** - *

A structure containing the list of column group schemas.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - ColumnGroupSchemaList?: ColumnGroupSchema[] | undefined; + RequestId?: string | undefined; } /** - *

The detailed definition of a template.

+ *

The request object for this operation.

* @public */ -export interface TemplateVersionDefinition { - /** - *

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

- * @public - */ - DataSetConfigurations: DataSetConfiguration[] | undefined; - +export interface CreateGroupRequest { /** - *

An array of sheet definitions for a template.

+ *

A name for the group that you want to create.

* @public */ - Sheets?: SheetDefinition[] | undefined; + GroupName: string | undefined; /** - *

An array of calculated field definitions for the template.

+ *

A description for the group that you want to create.

* @public */ - CalculatedFields?: CalculatedField[] | undefined; + Description?: string | undefined; /** - *

An array of parameter declarations for a template.

- *

- * Parameters are named variables that can transfer a value for use by an action or an object.

- *

For more information, see Parameters in Amazon QuickSight in the - * Amazon QuickSight User Guide. - *

+ *

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the + * Amazon Web Services account that contains your Amazon QuickSight account.

* @public */ - ParameterDeclarations?: ParameterDeclaration[] | undefined; + AwsAccountId: string | undefined; /** - *

Filter definitions for a template.

- *

For more information, see Filtering Data in the Amazon QuickSight User Guide. - *

+ *

The namespace that you want the group to be a part of.

* @public */ - FilterGroups?: FilterGroup[] | undefined; + Namespace: string | undefined; +} +/** + *

A group in Amazon QuickSight consists of a set of users. You can + * use groups to make it easier to manage access and security.

+ * @public + */ +export interface Group { /** - *

An array of template-level column - * configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

+ *

The Amazon Resource Name (ARN) for the group.

* @public */ - ColumnConfigurations?: ColumnConfiguration[] | undefined; + Arn?: string | undefined; /** - *

The configuration for default analysis settings.

+ *

The name of the group.

* @public */ - AnalysisDefaults?: AnalysisDefaults | undefined; + GroupName?: string | undefined; /** - *

An array of option definitions for a template.

+ *

The group description.

* @public */ - Options?: AssetOptions | undefined; + Description?: string | undefined; /** - *

A structure that describes the query execution options.

+ *

The principal ID of the group.

* @public */ - QueryExecutionOptions?: QueryExecutionOptions | undefined; + PrincipalId?: string | undefined; } /** - *

The source analysis of the template.

+ *

The response object for this operation.

* @public */ -export interface TemplateSourceAnalysis { +export interface CreateGroupResponse { /** - *

The Amazon Resource Name (ARN) of the resource.

+ *

The name of the group.

* @public */ - Arn: string | undefined; + Group?: Group | undefined; /** - *

A structure containing information about the dataset references used as placeholders - * in the template.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - DataSetReferences: DataSetReference[] | undefined; -} + RequestId?: string | undefined; -/** - *

The source template of the template.

- * @public - */ -export interface TemplateSourceTemplate { /** - *

The Amazon Resource Name (ARN) of the resource.

+ *

The HTTP status of the request.

* @public */ - Arn: string | undefined; + Status?: number | undefined; } /** - *

The source entity of the template.

* @public */ -export interface TemplateSourceEntity { +export interface CreateGroupMembershipRequest { /** - *

The source analysis, if it is based on an analysis.

+ *

The name of the user that you want to add to the group membership.

* @public */ - SourceAnalysis?: TemplateSourceAnalysis | undefined; + MemberName: string | undefined; /** - *

The source template, if it is based on an template.

+ *

The name of the group that you want to add the user to.

* @public */ - SourceTemplate?: TemplateSourceTemplate | undefined; -} + GroupName: string | undefined; -/** - * @public - */ -export interface CreateTemplateRequest { /** - *

The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

+ *

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the + * Amazon Web Services account that contains your Amazon QuickSight account.

* @public */ AwsAccountId: string | undefined; /** - *

An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in - * each Amazon Web Services account.

+ *

The namespace that you want the user to be a part of.

* @public */ - TemplateId: string | undefined; - - /** - *

A display name for the template.

- * @public - */ - Name?: string | undefined; - - /** - *

A list of resource permissions to be set on the template.

- * @public - */ - Permissions?: ResourcePermission[] | undefined; + Namespace: string | undefined; +} +/** + *

A member of an Amazon QuickSight group. Currently, group members must be users. Groups + * can't be members of another group. .

+ * @public + */ +export interface GroupMember { /** - *

The entity that you are using as a source when you create the template. In - * SourceEntity, you specify the type of object you're using as source: - * SourceTemplate for a template or SourceAnalysis for an - * analysis. Both of these require an Amazon Resource Name (ARN). For - * SourceTemplate, specify the ARN of the source template. For - * SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate - * ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

- *

Use the DataSetReferences entity within SourceTemplate or - * SourceAnalysis to list the replacement datasets for the placeholders listed - * in the original. The schema in each dataset must match its placeholder.

- *

Either a SourceEntity or a Definition must be provided in - * order for the request to be valid.

+ *

The Amazon Resource Name (ARN) for the group member (user).

* @public */ - SourceEntity?: TemplateSourceEntity | undefined; + Arn?: string | undefined; /** - *

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

+ *

The name of the group member (user).

* @public */ - Tags?: Tag[] | undefined; + MemberName?: string | undefined; +} +/** + * @public + */ +export interface CreateGroupMembershipResponse { /** - *

A description of the current template version being created. This API operation creates the - * first version of the template. Every time UpdateTemplate is called, a new - * version is created. Each version of the template maintains a description of the version - * in the VersionDescription field.

+ *

The group member.

* @public */ - VersionDescription?: string | undefined; + GroupMember?: GroupMember | undefined; /** - *

The definition of a template.

- *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

- *

Either a SourceEntity or a Definition must be provided in - * order for the request to be valid.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Definition?: TemplateVersionDefinition | undefined; + RequestId?: string | undefined; /** - *

TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.

+ *

The HTTP status of the request.

* @public */ - ValidationStrategy?: ValidationStrategy | undefined; + Status?: number | undefined; } /** * @public */ -export interface CreateTemplateResponse { +export interface CreateIAMPolicyAssignmentRequest { /** - *

The ARN for the template.

+ *

The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.

* @public */ - Arn?: string | undefined; + AwsAccountId: string | undefined; /** - *

The ARN for the template, including the version information of - * the first version.

+ *

The name of the assignment, also called a rule. + * The + * name + * must be unique within the + * Amazon Web Services account.

* @public */ - VersionArn?: string | undefined; + AssignmentName: string | undefined; /** - *

The ID of the template.

+ *

The status of the assignment. Possible values are as follows:

+ *
    + *
  • + *

    + * ENABLED - Anything specified in this assignment is used when + * creating the data source.

    + *
  • + *
  • + *

    + * DISABLED - This assignment isn't used when creating the data + * source.

    + *
  • + *
  • + *

    + * DRAFT - This assignment is an unfinished draft and isn't used + * when creating the data source.

    + *
  • + *
* @public */ - TemplateId?: string | undefined; + AssignmentStatus: AssignmentStatus | undefined; /** - *

The template creation status.

+ *

The ARN for the IAM policy to apply to the Amazon QuickSight users and + * groups specified in this assignment.

* @public */ - CreationStatus?: ResourceStatus | undefined; + PolicyArn?: string | undefined; /** - *

The HTTP status of the request.

+ *

The Amazon QuickSight users, groups, or both that you want to assign the policy + * to.

* @public */ - Status?: number | undefined; + Identities?: Record | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The namespace that contains the assignment.

* @public */ - RequestId?: string | undefined; + Namespace: string | undefined; } /** * @public */ -export interface CreateTemplateAliasRequest { +export interface CreateIAMPolicyAssignmentResponse { /** - *

The ID of the Amazon Web Services account that contains the template that you creating an alias for.

+ *

The name of the assignment. + * The + * name must be unique within the Amazon Web Services account.

* @public */ - AwsAccountId: string | undefined; + AssignmentName?: string | undefined; /** - *

An ID for the template.

+ *

The ID for the assignment.

* @public */ - TemplateId: string | undefined; + AssignmentId?: string | undefined; /** - *

The name that you want to give to the template alias that you're creating. Don't start the - * alias name with the $ character. Alias names that start with $ - * are reserved by Amazon QuickSight.

+ *

The status of the assignment. Possible values are as follows:

+ *
    + *
  • + *

    + * ENABLED - Anything specified in this assignment is used when + * creating the data source.

    + *
  • + *
  • + *

    + * DISABLED - This assignment isn't used when creating the data + * source.

    + *
  • + *
  • + *

    + * DRAFT - This assignment is an unfinished draft and isn't used + * when creating the data source.

    + *
  • + *
* @public */ - AliasName: string | undefined; + AssignmentStatus?: AssignmentStatus | undefined; /** - *

The version number of the template.

+ *

The ARN for the IAM policy that is applied to the Amazon QuickSight + * users and groups specified in this assignment.

* @public */ - TemplateVersionNumber: number | undefined; -} + PolicyArn?: string | undefined; -/** - *

The template alias.

- * @public - */ -export interface TemplateAlias { /** - *

The display name of the template alias.

+ *

The Amazon QuickSight users, groups, or both that the IAM policy is + * assigned to.

* @public */ - AliasName?: string | undefined; + Identities?: Record | undefined; /** - *

The Amazon Resource Name (ARN) of the template alias.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Arn?: string | undefined; + RequestId?: string | undefined; /** - *

The version number of the template alias.

+ *

The HTTP status of the request.

* @public */ - TemplateVersionNumber?: number | undefined; + Status?: number | undefined; } /** * @public + * @enum */ -export interface CreateTemplateAliasResponse { - /** - *

Information about the template alias.

- * @public - */ - TemplateAlias?: TemplateAlias | undefined; - - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; +export const IngestionType = { + FULL_REFRESH: "FULL_REFRESH", + INCREMENTAL_REFRESH: "INCREMENTAL_REFRESH", +} as const; - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; -} +/** + * @public + */ +export type IngestionType = (typeof IngestionType)[keyof typeof IngestionType]; /** - *

The theme colors that are used for data colors in charts. The colors description is a - * hexadecimal color code that consists of six alphanumerical characters, prefixed with - * #, for example #37BFF5.

* @public */ -export interface DataColorPalette { +export interface CreateIngestionRequest { /** - *

The hexadecimal codes for the colors.

+ *

The ID of the dataset used in the ingestion.

* @public */ - Colors?: string[] | undefined; + DataSetId: string | undefined; /** - *

The minimum and maximum hexadecimal codes that describe a color gradient.

+ *

An ID for the ingestion.

* @public */ - MinMaxGradient?: string[] | undefined; + IngestionId: string | undefined; /** - *

The hexadecimal code of a color that applies to charts where a lack of data is - * highlighted.

+ *

The Amazon Web Services account ID.

* @public */ - EmptyFillColor?: string | undefined; -} + AwsAccountId: string | undefined; -/** - *

Display options related to tiles on a sheet.

- * @public - */ -export interface TileStyle { /** - *

The border around a tile.

+ *

The type of ingestion that you want to create.

* @public */ - Border?: BorderStyle | undefined; + IngestionType?: IngestionType | undefined; } /** - *

The display options for gutter spacing between tiles on a sheet.

* @public + * @enum */ -export interface GutterStyle { - /** - *

This Boolean value controls whether to display a gutter space between sheet tiles. - *

- * @public - */ - Show?: boolean | undefined; -} +export const IngestionStatus = { + CANCELLED: "CANCELLED", + COMPLETED: "COMPLETED", + FAILED: "FAILED", + INITIALIZED: "INITIALIZED", + QUEUED: "QUEUED", + RUNNING: "RUNNING", +} as const; /** - *

The display options for margins around the outside edge of sheets.

* @public */ -export interface MarginStyle { - /** - *

This Boolean value controls whether to display sheet margins.

- * @public - */ - Show?: boolean | undefined; -} +export type IngestionStatus = (typeof IngestionStatus)[keyof typeof IngestionStatus]; /** - *

The display options for the layout of tiles on a sheet.

* @public */ -export interface TileLayoutStyle { +export interface CreateIngestionResponse { /** - *

The gutter settings that apply between tiles.

+ *

The Amazon Resource Name (ARN) for the data ingestion.

* @public */ - Gutter?: GutterStyle | undefined; + Arn?: string | undefined; /** - *

The margin settings that apply around the outside edge of sheets.

+ *

An ID for the ingestion.

* @public */ - Margin?: MarginStyle | undefined; -} + IngestionId?: string | undefined; -/** - *

The theme display options for sheets.

- * @public - */ -export interface SheetStyle { /** - *

The display options for tiles.

+ *

The ingestion status.

* @public */ - Tile?: TileStyle | undefined; + IngestionStatus?: IngestionStatus | undefined; /** - *

The layout options for tiles.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - TileLayout?: TileLayoutStyle | undefined; -} + RequestId?: string | undefined; -/** - *

Determines the font settings.

- * @public - */ -export interface Font { /** - *

Determines the font family settings.

+ *

The HTTP status of the request.

* @public */ - FontFamily?: string | undefined; + Status?: number | undefined; } /** - *

Determines the typography options.

* @public + * @enum */ -export interface Typography { - /** - *

Determines the list of font families.

- * @public - */ - FontFamilies?: Font[] | undefined; -} +export const IdentityStore = { + QUICKSIGHT: "QUICKSIGHT", +} as const; /** - *

The theme colors that apply to UI and to charts, excluding data colors. The colors - * description is a hexadecimal color code that consists of six alphanumerical characters, - * prefixed with #, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User - * Guide. - *

* @public */ -export interface UIColorPalette { - /** - *

The color of text and other foreground elements that appear over the primary - * background regions, such as grid lines, borders, table banding, icons, and so on.

- * @public - */ - PrimaryForeground?: string | undefined; +export type IdentityStore = (typeof IdentityStore)[keyof typeof IdentityStore]; +/** + * @public + */ +export interface CreateNamespaceRequest { /** - *

The background color that applies to visuals and other high emphasis UI.

+ *

The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.

* @public */ - PrimaryBackground?: string | undefined; + AwsAccountId: string | undefined; /** - *

The foreground color that applies to any sheet title, sheet control text, or UI that - * appears over the secondary background.

+ *

The name that you want to use to describe the new namespace.

* @public */ - SecondaryForeground?: string | undefined; + Namespace: string | undefined; /** - *

The background color that applies to the sheet background and sheet controls.

+ *

Specifies the type of your user identity directory. Currently, this supports users + * with an identity type of QUICKSIGHT.

* @public */ - SecondaryBackground?: string | undefined; + IdentityStore: IdentityStore | undefined; /** - *

This color is that applies to selected states and buttons.

+ *

The tags that you want to associate with the namespace that you're creating.

* @public */ - Accent?: string | undefined; + Tags?: Tag[] | undefined; +} - /** - *

The foreground color that applies to any text or other elements that appear over the - * accent color.

- * @public - */ - AccentForeground?: string | undefined; +/** + * @public + * @enum + */ +export const NamespaceStatus = { + CREATED: "CREATED", + CREATING: "CREATING", + DELETING: "DELETING", + NON_RETRYABLE_FAILURE: "NON_RETRYABLE_FAILURE", + RETRYABLE_FAILURE: "RETRYABLE_FAILURE", +} as const; - /** - *

The color that applies to error messages.

- * @public - */ - Danger?: string | undefined; +/** + * @public + */ +export type NamespaceStatus = (typeof NamespaceStatus)[keyof typeof NamespaceStatus]; +/** + * @public + */ +export interface CreateNamespaceResponse { /** - *

The foreground color that applies to any text or other elements that appear over the - * error color.

+ *

The ARN of the Amazon QuickSight namespace you created.

* @public */ - DangerForeground?: string | undefined; + Arn?: string | undefined; /** - *

This color that applies to warning and informational messages.

+ *

The name of the new namespace that you created.

* @public */ - Warning?: string | undefined; + Name?: string | undefined; /** - *

The foreground color that applies to any text or other elements that appear over the - * warning color.

+ *

The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace. + * This is set to the region that you run CreateNamespace in.

* @public */ - WarningForeground?: string | undefined; + CapacityRegion?: string | undefined; /** - *

The color that applies to success messages, for example the check mark for a - * successful download.

+ *

The status of the creation of the namespace. This is an asynchronous process. A status + * of CREATED means that your namespace is ready to use. If an error occurs, + * it indicates if the process is retryable or non-retryable. In + * the case of a non-retryable error, refer to the error message for follow-up + * tasks.

* @public */ - Success?: string | undefined; + CreationStatus?: NamespaceStatus | undefined; /** - *

The foreground color that applies to any text or other elements that appear over the - * success color.

+ *

Specifies the type of your user identity directory. Currently, this supports users + * with an identity type of QUICKSIGHT.

* @public */ - SuccessForeground?: string | undefined; + IdentityStore?: IdentityStore | undefined; /** - *

The color that applies to the names of fields that are identified as - * dimensions.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Dimension?: string | undefined; + RequestId?: string | undefined; /** - *

The foreground color that applies to any text or other elements that appear over the - * dimension color.

+ *

The HTTP status of the request.

* @public */ - DimensionForeground?: string | undefined; + Status?: number | undefined; +} + +/** + * @public + * @enum + */ +export const RefreshInterval = { + DAILY: "DAILY", + HOURLY: "HOURLY", + MINUTE15: "MINUTE15", + MINUTE30: "MINUTE30", + MONTHLY: "MONTHLY", + WEEKLY: "WEEKLY", +} as const; + +/** + * @public + */ +export type RefreshInterval = (typeof RefreshInterval)[keyof typeof RefreshInterval]; + +/** + * @public + * @enum + */ +export const DayOfWeek = { + FRIDAY: "FRIDAY", + MONDAY: "MONDAY", + SATURDAY: "SATURDAY", + SUNDAY: "SUNDAY", + THURSDAY: "THURSDAY", + TUESDAY: "TUESDAY", + WEDNESDAY: "WEDNESDAY", +} as const; + +/** + * @public + */ +export type DayOfWeek = (typeof DayOfWeek)[keyof typeof DayOfWeek]; +/** + *

The refresh on entity for weekly or monthly schedules.

+ * @public + */ +export interface ScheduleRefreshOnEntity { /** - *

The color that applies to the names of fields that are identified as measures.

+ *

The day of the week that you want to schedule a refresh on.

* @public */ - Measure?: string | undefined; + DayOfWeek?: DayOfWeek | undefined; /** - *

The foreground color that applies to any text or other elements that appear over the - * measure color.

+ *

The day of the month that you want to schedule refresh on.

* @public */ - MeasureForeground?: string | undefined; + DayOfMonth?: string | undefined; } /** - *

The theme configuration. This configuration contains all of the display properties for - * a theme.

+ *

Specifies the interval between each scheduled refresh of a dataset.

* @public */ -export interface ThemeConfiguration { +export interface RefreshFrequency { /** - *

Color properties that apply to chart data colors.

+ *

The interval between scheduled refreshes. Valid values are as follows:

+ *
    + *
  • + *

    + * MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

    + *
  • + *
  • + *

    + * MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

    + *
  • + *
  • + *

    + * HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.

    + *
  • + *
  • + *

    + * DAILY: The dataset refreshes every day.

    + *
  • + *
  • + *

    + * WEEKLY: The dataset refreshes every week.

    + *
  • + *
  • + *

    + * MONTHLY: The dataset refreshes every month.

    + *
  • + *
* @public */ - DataColorPalette?: DataColorPalette | undefined; + Interval: RefreshInterval | undefined; /** - *

Color properties that apply to the UI and to charts, excluding the colors that apply - * to data.

+ *

The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

* @public */ - UIColorPalette?: UIColorPalette | undefined; + RefreshOnDay?: ScheduleRefreshOnEntity | undefined; /** - *

Display options related to sheets.

+ *

The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().

* @public */ - Sheet?: SheetStyle | undefined; + Timezone?: string | undefined; /** - *

Determines the typography options.

+ *

The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.

* @public */ - Typography?: Typography | undefined; + TimeOfTheDay?: string | undefined; } /** + *

The refresh schedule of a dataset.

* @public */ -export interface CreateThemeRequest { +export interface RefreshSchedule { /** - *

The ID of the Amazon Web Services account where you want to store the new theme.

+ *

An identifier for the refresh schedule.

* @public */ - AwsAccountId: string | undefined; + ScheduleId: string | undefined; /** - *

An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in - * each Amazon Web Services account.

+ *

The frequency for the refresh schedule.

* @public */ - ThemeId: string | undefined; + ScheduleFrequency: RefreshFrequency | undefined; /** - *

A display name for the theme.

+ *

Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

* @public */ - Name: string | undefined; + StartAfterDateTime?: Date | undefined; /** - *

The ID of the theme that a custom theme will inherit from. All themes inherit from one of - * the starting themes defined by Amazon QuickSight. For a list of the starting themes, use - * ListThemes or choose Themes from - * within an analysis.

+ *

The type of refresh that a datset undergoes. Valid values are as follows:

+ *
    + *
  • + *

    + * FULL_REFRESH: A complete refresh of a dataset.

    + *
  • + *
  • + *

    + * INCREMENTAL_REFRESH: A partial refresh of some rows of a dataset, based on the time window specified.

    + *
  • + *
+ *

For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.

* @public */ - BaseThemeId: string | undefined; + RefreshType: IngestionType | undefined; /** - *

A description of the first version of the theme that you're creating. Every time - * UpdateTheme is called, a new version is created. Each version of the - * theme has a description of the version in the VersionDescription - * field.

+ *

The Amazon Resource Name (ARN) for the refresh schedule.

* @public */ - VersionDescription?: string | undefined; + Arn?: string | undefined; +} +/** + * @public + */ +export interface CreateRefreshScheduleRequest { /** - *

The theme configuration, which contains the theme display properties.

+ *

The ID of the dataset.

* @public */ - Configuration: ThemeConfiguration | undefined; + DataSetId: string | undefined; /** - *

A valid grouping of resource permissions to apply to the new theme. - *

+ *

The Amazon Web Services account ID.

* @public */ - Permissions?: ResourcePermission[] | undefined; + AwsAccountId: string | undefined; /** - *

A map of the key-value pairs for the resource tag or tags that you want to add to the - * resource.

+ *

The refresh schedule.

* @public */ - Tags?: Tag[] | undefined; + Schedule: RefreshSchedule | undefined; } /** * @public */ -export interface CreateThemeResponse { +export interface CreateRefreshScheduleResponse { /** - *

The Amazon Resource Name (ARN) for the theme.

+ *

The HTTP status of the request.

* @public */ - Arn?: string | undefined; + Status?: number | undefined; /** - *

The Amazon Resource Name (ARN) for the new theme.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - VersionArn?: string | undefined; + RequestId?: string | undefined; /** - *

The ID of the theme.

+ *

The ID of the refresh schedule.

* @public */ - ThemeId?: string | undefined; + ScheduleId?: string | undefined; /** - *

The theme creation status.

+ *

The Amazon Resource Name (ARN) for the refresh schedule.

* @public */ - CreationStatus?: ResourceStatus | undefined; + Arn?: string | undefined; +} - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; +/** + * @public + * @enum + */ +export const Role = { + ADMIN: "ADMIN", + ADMIN_PRO: "ADMIN_PRO", + AUTHOR: "AUTHOR", + AUTHOR_PRO: "AUTHOR_PRO", + READER: "READER", + READER_PRO: "READER_PRO", +} as const; - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; -} +/** + * @public + */ +export type Role = (typeof Role)[keyof typeof Role]; /** * @public */ -export interface CreateThemeAliasRequest { +export interface CreateRoleMembershipRequest { /** - *

The ID of the Amazon Web Services account that contains the theme for the new theme alias.

+ *

The name of the group that you want to add to the role.

* @public */ - AwsAccountId: string | undefined; + MemberName: string | undefined; /** - *

An ID for the theme alias.

+ *

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

* @public */ - ThemeId: string | undefined; + AwsAccountId: string | undefined; /** - *

The name that you want to give to the theme alias that you are creating. The - * alias name can't begin with a $. Alias names that start with $ - * are reserved by Amazon QuickSight.

+ *

The namespace that the role belongs to.

* @public */ - AliasName: string | undefined; + Namespace: string | undefined; /** - *

The version number of the theme.

+ *

The role that you want to add a group to.

* @public */ - ThemeVersionNumber: number | undefined; + Role: Role | undefined; } /** - *

An alias for a theme.

* @public */ -export interface ThemeAlias { - /** - *

The Amazon Resource Name (ARN) of the theme alias.

- * @public - */ - Arn?: string | undefined; - +export interface CreateRoleMembershipResponse { /** - *

The display name of the theme alias.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AliasName?: string | undefined; + RequestId?: string | undefined; /** - *

The version number of the theme alias.

+ *

The HTTP status of the request.

* @public */ - ThemeVersionNumber?: number | undefined; + Status?: number | undefined; } /** + *

Dataset schema.

* @public */ -export interface CreateThemeAliasResponse { +export interface DataSetSchema { /** - *

Information about the theme alias.

+ *

A structure containing the list of column schemas.

* @public */ - ThemeAlias?: ThemeAlias | undefined; + ColumnSchemaList?: ColumnSchema[] | undefined; +} +/** + *

Dataset configuration.

+ * @public + */ +export interface DataSetConfiguration { /** - *

The HTTP status of the request.

+ *

Placeholder.

* @public */ - Status?: number | undefined; + Placeholder?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

Dataset schema.

* @public */ - RequestId?: string | undefined; -} + DataSetSchema?: DataSetSchema | undefined; -/** - *

Configuration options for a Topic.

- * @public - */ -export interface TopicConfigOptions { /** - *

Enables Amazon Q Business Insights for a Topic.

+ *

A structure containing the list of column group schemas.

* @public */ - QBusinessInsightsEnabled?: boolean | undefined; + ColumnGroupSchemaList?: ColumnGroupSchema[] | undefined; } /** - * @public - * @enum - */ -export const DefaultAggregation = { - AVERAGE: "AVERAGE", - COUNT: "COUNT", - DISTINCT_COUNT: "DISTINCT_COUNT", - MAX: "MAX", - MEDIAN: "MEDIAN", - MIN: "MIN", - STDEV: "STDEV", - STDEVP: "STDEVP", - SUM: "SUM", - VAR: "VAR", - VARP: "VARP", -} as const; - -/** - * @public - */ -export type DefaultAggregation = (typeof DefaultAggregation)[keyof typeof DefaultAggregation]; - -/** - *

A structure that represents a default formatting definition.

+ *

The detailed definition of a template.

* @public */ -export interface DefaultFormatting { +export interface TemplateVersionDefinition { /** - *

The display format. Valid values for this structure are AUTO, - * PERCENT, CURRENCY, NUMBER, DATE, and - * STRING.

+ *

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

* @public */ - DisplayFormat?: DisplayFormat | undefined; + DataSetConfigurations: DataSetConfiguration[] | undefined; /** - *

The additional options for display formatting.

+ *

An array of sheet definitions for a template.

* @public */ - DisplayFormatOptions?: DisplayFormatOptions | undefined; -} + Sheets?: SheetDefinition[] | undefined; -/** - *

A structure that represents a semantic type.

- * @public - */ -export interface SemanticType { /** - *

The semantic type name.

+ *

An array of calculated field definitions for the template.

* @public */ - TypeName?: string | undefined; + CalculatedFields?: CalculatedField[] | undefined; /** - *

The semantic type sub type name.

+ *

An array of parameter declarations for a template.

+ *

+ * Parameters are named variables that can transfer a value for use by an action or an object.

+ *

For more information, see Parameters in Amazon QuickSight in the + * Amazon QuickSight User Guide. + *

* @public */ - SubTypeName?: string | undefined; + ParameterDeclarations?: ParameterDeclaration[] | undefined; /** - *

The semantic type parameters.

+ *

Filter definitions for a template.

+ *

For more information, see Filtering Data in the Amazon QuickSight User Guide. + *

* @public */ - TypeParameters?: Record | undefined; + FilterGroups?: FilterGroup[] | undefined; /** - *

The semantic type truthy cell value.

+ *

An array of template-level column + * configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

* @public */ - TruthyCellValue?: string | undefined; + ColumnConfigurations?: ColumnConfiguration[] | undefined; /** - *

The other names or aliases for the true cell value.

+ *

The configuration for default analysis settings.

* @public */ - TruthyCellValueSynonyms?: string[] | undefined; + AnalysisDefaults?: AnalysisDefaults | undefined; /** - *

The semantic type falsey cell value.

+ *

An array of option definitions for a template.

* @public */ - FalseyCellValue?: string | undefined; + Options?: AssetOptions | undefined; /** - *

The other names or aliases for the false cell value.

+ *

A structure that describes the query execution options.

* @public */ - FalseyCellValueSynonyms?: string[] | undefined; + QueryExecutionOptions?: QueryExecutionOptions | undefined; } /** - *

A structure that represents a calculated field.

+ *

The source analysis of the template.

* @public */ -export interface TopicCalculatedField { +export interface TemplateSourceAnalysis { /** - *

The calculated field name.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ - CalculatedFieldName: string | undefined; + Arn: string | undefined; /** - *

The calculated field description.

- * @public - */ - CalculatedFieldDescription?: string | undefined; - - /** - *

The calculated field expression.

+ *

A structure containing information about the dataset references used as placeholders + * in the template.

* @public */ - Expression: string | undefined; + DataSetReferences: DataSetReference[] | undefined; +} +/** + *

The source template of the template.

+ * @public + */ +export interface TemplateSourceTemplate { /** - *

The other names or aliases for the calculated field.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ - CalculatedFieldSynonyms?: string[] | undefined; + Arn: string | undefined; +} +/** + *

The source entity of the template.

+ * @public + */ +export interface TemplateSourceEntity { /** - *

A boolean value that indicates if a calculated field is included in the topic.

+ *

The source analysis, if it is based on an analysis.

* @public */ - IsIncludedInTopic?: boolean | undefined; + SourceAnalysis?: TemplateSourceAnalysis | undefined; /** - *

A Boolean value that indicates if a calculated field is visible in the autocomplete.

+ *

The source template, if it is based on an template.

* @public */ - DisableIndexing?: boolean | undefined; + SourceTemplate?: TemplateSourceTemplate | undefined; +} +/** + * @public + */ +export interface CreateTemplateRequest { /** - *

The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.

+ *

The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

* @public */ - ColumnDataRole?: ColumnDataRole | undefined; + AwsAccountId: string | undefined; /** - *

The level of time precision that is used to aggregate DateTime values.

+ *

An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in + * each Amazon Web Services account.

* @public */ - TimeGranularity?: TopicTimeGranularity | undefined; + TemplateId: string | undefined; /** - *

The default formatting definition.

+ *

A display name for the template.

* @public */ - DefaultFormatting?: DefaultFormatting | undefined; + Name?: string | undefined; /** - *

The default aggregation. Valid values for this structure are SUM, - * MAX, MIN, COUNT, - * DISTINCT_COUNT, - * and AVERAGE.

+ *

A list of resource permissions to be set on the template.

* @public */ - Aggregation?: DefaultAggregation | undefined; + Permissions?: ResourcePermission[] | undefined; /** - *

The order in which data is displayed for the calculated field when - * it's used in a comparative context.

+ *

The entity that you are using as a source when you create the template. In + * SourceEntity, you specify the type of object you're using as source: + * SourceTemplate for a template or SourceAnalysis for an + * analysis. Both of these require an Amazon Resource Name (ARN). For + * SourceTemplate, specify the ARN of the source template. For + * SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate + * ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

+ *

Use the DataSetReferences entity within SourceTemplate or + * SourceAnalysis to list the replacement datasets for the placeholders listed + * in the original. The schema in each dataset must match its placeholder.

+ *

Either a SourceEntity or a Definition must be provided in + * order for the request to be valid.

* @public */ - ComparativeOrder?: ComparativeOrder | undefined; + SourceEntity?: TemplateSourceEntity | undefined; /** - *

The semantic type.

+ *

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

* @public */ - SemanticType?: SemanticType | undefined; + Tags?: Tag[] | undefined; /** - *

The list of aggregation types that are allowed for the calculated field. Valid values - * for this structure are COUNT, DISTINCT_COUNT, MIN, - * MAX, MEDIAN, SUM, AVERAGE, - * STDEV, STDEVP, VAR, - * VARP, and PERCENTILE.

+ *

A description of the current template version being created. This API operation creates the + * first version of the template. Every time UpdateTemplate is called, a new + * version is created. Each version of the template maintains a description of the version + * in the VersionDescription field.

* @public */ - AllowedAggregations?: AuthorSpecifiedAggregation[] | undefined; + VersionDescription?: string | undefined; /** - *

The list of aggregation types that are not allowed for the calculated field. Valid - * values for this structure are COUNT, DISTINCT_COUNT, - * MIN, MAX, MEDIAN, SUM, - * AVERAGE, STDEV, STDEVP, VAR, - * VARP, and PERCENTILE.

+ *

The definition of a template.

+ *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

+ *

Either a SourceEntity or a Definition must be provided in + * order for the request to be valid.

* @public */ - NotAllowedAggregations?: AuthorSpecifiedAggregation[] | undefined; + Definition?: TemplateVersionDefinition | undefined; /** - *

A Boolean value that indicates whether to never aggregate calculated field in filters.

+ *

TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.

* @public */ - NeverAggregateInFilter?: boolean | undefined; + ValidationStrategy?: ValidationStrategy | undefined; +} +/** + * @public + */ +export interface CreateTemplateResponse { /** - *

The other - * names or aliases for the calculated field cell value.

+ *

The ARN for the template.

* @public */ - CellValueSynonyms?: CellValueSynonym[] | undefined; + Arn?: string | undefined; /** - *

The non additive for the table style target.

+ *

The ARN for the template, including the version information of + * the first version.

* @public */ - NonAdditive?: boolean | undefined; -} + VersionArn?: string | undefined; -/** - *

Represents a column in a dataset.

- * @public - */ -export interface TopicColumn { /** - *

The name of the column.

+ *

The ID of the template.

* @public */ - ColumnName: string | undefined; + TemplateId?: string | undefined; /** - *

A user-friendly name for the column.

+ *

The template creation status.

* @public */ - ColumnFriendlyName?: string | undefined; + CreationStatus?: ResourceStatus | undefined; /** - *

A description of the column and its contents.

+ *

The HTTP status of the request.

* @public */ - ColumnDescription?: string | undefined; + Status?: number | undefined; /** - *

The other names or aliases for the column.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - ColumnSynonyms?: string[] | undefined; + RequestId?: string | undefined; +} +/** + * @public + */ +export interface CreateTemplateAliasRequest { /** - *

The role of the column in the data. Valid values are DIMENSION and MEASURE.

+ *

The ID of the Amazon Web Services account that contains the template that you creating an alias for.

* @public */ - ColumnDataRole?: ColumnDataRole | undefined; + AwsAccountId: string | undefined; /** - *

The type of aggregation that is performed on the column data when - * it's queried.

+ *

An ID for the template.

* @public */ - Aggregation?: DefaultAggregation | undefined; + TemplateId: string | undefined; /** - *

A Boolean value that indicates whether the column is included in the query results.

+ *

The name that you want to give to the template alias that you're creating. Don't start the + * alias name with the $ character. Alias names that start with $ + * are reserved by Amazon QuickSight.

* @public */ - IsIncludedInTopic?: boolean | undefined; + AliasName: string | undefined; /** - *

A Boolean value that indicates whether the column shows in the autocomplete functionality.

+ *

The version number of the template.

* @public */ - DisableIndexing?: boolean | undefined; + TemplateVersionNumber: number | undefined; +} +/** + *

The template alias.

+ * @public + */ +export interface TemplateAlias { /** - *

The order in which data is displayed for the column when - * it's used in a comparative context.

+ *

The display name of the template alias.

* @public */ - ComparativeOrder?: ComparativeOrder | undefined; + AliasName?: string | undefined; /** - *

The semantic type of data contained in the column.

+ *

The Amazon Resource Name (ARN) of the template alias.

* @public */ - SemanticType?: SemanticType | undefined; + Arn?: string | undefined; /** - *

The level of time precision that is used to aggregate DateTime values.

+ *

The version number of the template alias.

* @public */ - TimeGranularity?: TopicTimeGranularity | undefined; + TemplateVersionNumber?: number | undefined; +} +/** + * @public + */ +export interface CreateTemplateAliasResponse { /** - *

The list of aggregation types that are allowed for the column. Valid values for this - * structure are COUNT, DISTINCT_COUNT, MIN, - * MAX, MEDIAN, SUM, AVERAGE, - * STDEV, STDEVP, VAR, - * VARP, - * and PERCENTILE.

+ *

Information about the template alias.

* @public */ - AllowedAggregations?: AuthorSpecifiedAggregation[] | undefined; + TemplateAlias?: TemplateAlias | undefined; /** - *

The list of aggregation types that are not allowed for the column. Valid values for this - * structure are COUNT, DISTINCT_COUNT, MIN, - * MAX, MEDIAN, SUM, AVERAGE, - * STDEV, STDEVP, VAR, - * VARP, - * and PERCENTILE.

+ *

The HTTP status of the request.

* @public */ - NotAllowedAggregations?: AuthorSpecifiedAggregation[] | undefined; + Status?: number | undefined; /** - *

The default formatting used for values in the column.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - DefaultFormatting?: DefaultFormatting | undefined; + RequestId?: string | undefined; +} +/** + *

The theme colors that are used for data colors in charts. The colors description is a + * hexadecimal color code that consists of six alphanumerical characters, prefixed with + * #, for example #37BFF5.

+ * @public + */ +export interface DataColorPalette { /** - *

A Boolean - * value that indicates whether to aggregate the column data when - * it's used in a filter context.

+ *

The hexadecimal codes for the colors.

* @public */ - NeverAggregateInFilter?: boolean | undefined; + Colors?: string[] | undefined; /** - *

The other names or aliases for the column cell value.

+ *

The minimum and maximum hexadecimal codes that describe a color gradient.

* @public */ - CellValueSynonyms?: CellValueSynonym[] | undefined; + MinMaxGradient?: string[] | undefined; /** - *

The non additive value for the column.

+ *

The hexadecimal code of a color that applies to charts where a lack of data is + * highlighted.

* @public */ - NonAdditive?: boolean | undefined; + EmptyFillColor?: string | undefined; } /** - *

A structure that represents a data aggregation.

+ *

Display options related to tiles on a sheet.

* @public */ -export interface DataAggregation { +export interface TileStyle { /** - *

The level of time precision that is used to aggregate DateTime values.

+ *

The border around a tile.

* @public */ - DatasetRowDateGranularity?: TopicTimeGranularity | undefined; + Border?: BorderStyle | undefined; +} +/** + *

The display options for gutter spacing between tiles on a sheet.

+ * @public + */ +export interface GutterStyle { /** - *

The column name for the default date.

+ *

This Boolean value controls whether to display a gutter space between sheet tiles. + *

* @public */ - DefaultDateColumnName?: string | undefined; + Show?: boolean | undefined; } /** - *

A constant used in a category filter.

+ *

The display options for margins around the outside edge of sheets.

* @public */ -export interface TopicCategoryFilterConstant { +export interface MarginStyle { /** - *

The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE.

+ *

This Boolean value controls whether to display sheet margins.

* @public */ - ConstantType?: ConstantType | undefined; + Show?: boolean | undefined; +} +/** + *

The display options for the layout of tiles on a sheet.

+ * @public + */ +export interface TileLayoutStyle { /** - *

A singular constant used in a category filter. This element is used to specify a single value for the constant.

+ *

The gutter settings that apply between tiles.

* @public */ - SingularConstant?: string | undefined; + Gutter?: GutterStyle | undefined; /** - *

A collective constant used in a category filter. This element is used to specify a list of values for the constant.

+ *

The margin settings that apply around the outside edge of sheets.

* @public */ - CollectiveConstant?: CollectiveConstant | undefined; + Margin?: MarginStyle | undefined; } /** - *

A structure that represents a category filter.

+ *

The theme display options for sheets.

* @public */ -export interface TopicCategoryFilter { +export interface SheetStyle { /** - *

The category filter function. Valid values for this structure are EXACT and CONTAINS.

+ *

The display options for tiles.

* @public */ - CategoryFilterFunction?: CategoryFilterFunction | undefined; + Tile?: TileStyle | undefined; /** - *

The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.

+ *

The layout options for tiles.

* @public */ - CategoryFilterType?: CategoryFilterType | undefined; + TileLayout?: TileLayoutStyle | undefined; +} +/** + *

Determines the font settings.

+ * @public + */ +export interface Font { /** - *

The constant used in a category filter.

+ *

Determines the font family settings.

* @public */ - Constant?: TopicCategoryFilterConstant | undefined; + FontFamily?: string | undefined; +} +/** + *

Determines the typography options.

+ * @public + */ +export interface Typography { /** - *

A Boolean value that indicates if the filter is inverse.

+ *

Determines the list of font families.

* @public */ - Inverse?: boolean | undefined; + FontFamilies?: Font[] | undefined; } /** - *

A structure that represents a range constant.

+ *

The theme colors that apply to UI and to charts, excluding data colors. The colors + * description is a hexadecimal color code that consists of six alphanumerical characters, + * prefixed with #, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User + * Guide. + *

* @public */ -export interface RangeConstant { +export interface UIColorPalette { /** - *

The minimum value for a range constant.

+ *

The color of text and other foreground elements that appear over the primary + * background regions, such as grid lines, borders, table banding, icons, and so on.

* @public */ - Minimum?: string | undefined; + PrimaryForeground?: string | undefined; /** - *

The maximum value for a range constant.

+ *

The background color that applies to visuals and other high emphasis UI.

* @public */ - Maximum?: string | undefined; -} + PrimaryBackground?: string | undefined; -/** - *

A constant value that is used in a range filter to specify the endpoints of the range.

- * @public - */ -export interface TopicRangeFilterConstant { /** - *

The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE.

+ *

The foreground color that applies to any sheet title, sheet control text, or UI that + * appears over the secondary background.

* @public */ - ConstantType?: ConstantType | undefined; + SecondaryForeground?: string | undefined; /** - *

The value of the constant that is used to specify the endpoints of a range filter.

+ *

The background color that applies to the sheet background and sheet controls.

* @public */ - RangeConstant?: RangeConstant | undefined; -} + SecondaryBackground?: string | undefined; -/** - *

A filter used to restrict data based on a range of dates or times.

- * @public - */ -export interface TopicDateRangeFilter { /** - *

A Boolean value that indicates whether the date range filter should include the boundary values. If - * set to true, the filter includes the start and end dates. If set to false, the filter - * excludes them.

+ *

This color is that applies to selected states and buttons.

* @public */ - Inclusive?: boolean | undefined; + Accent?: string | undefined; /** - *

The constant used in a date range filter.

+ *

The foreground color that applies to any text or other elements that appear over the + * accent color.

* @public */ - Constant?: TopicRangeFilterConstant | undefined; -} - -/** - * @public - * @enum - */ -export const NamedFilterType = { - CATEGORY_FILTER: "CATEGORY_FILTER", - DATE_RANGE_FILTER: "DATE_RANGE_FILTER", - NUMERIC_EQUALITY_FILTER: "NUMERIC_EQUALITY_FILTER", - NUMERIC_RANGE_FILTER: "NUMERIC_RANGE_FILTER", - RELATIVE_DATE_FILTER: "RELATIVE_DATE_FILTER", -} as const; - -/** - * @public - */ -export type NamedFilterType = (typeof NamedFilterType)[keyof typeof NamedFilterType]; - -/** - * @public - * @enum - */ -export const NamedFilterAggType = { - AVERAGE: "AVERAGE", - COUNT: "COUNT", - DISTINCT_COUNT: "DISTINCT_COUNT", - MAX: "MAX", - MEDIAN: "MEDIAN", - MIN: "MIN", - NO_AGGREGATION: "NO_AGGREGATION", - STDEV: "STDEV", - STDEVP: "STDEVP", - SUM: "SUM", - VAR: "VAR", - VARP: "VARP", -} as const; - -/** - * @public - */ -export type NamedFilterAggType = (typeof NamedFilterAggType)[keyof typeof NamedFilterAggType]; + AccentForeground?: string | undefined; -/** - *

A structure that represents a singular filter constant, used in filters to specify a single value to match against.

- * @public - */ -export interface TopicSingularFilterConstant { /** - *

The type of the singular filter constant. Valid values for this structure are SINGULAR.

+ *

The color that applies to error messages.

* @public */ - ConstantType?: ConstantType | undefined; + Danger?: string | undefined; /** - *

The value of the singular filter constant.

+ *

The foreground color that applies to any text or other elements that appear over the + * error color.

* @public */ - SingularConstant?: string | undefined; -} + DangerForeground?: string | undefined; -/** - *

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value matches the specified value.

- * @public - */ -export interface TopicNumericEqualityFilter { /** - *

The constant used in a numeric equality filter.

+ *

This color that applies to warning and informational messages.

* @public */ - Constant?: TopicSingularFilterConstant | undefined; + Warning?: string | undefined; /** - *

An aggregation function that specifies how to calculate the value of a numeric field for - * a topic. Valid values for this structure are NO_AGGREGATION, SUM, - * AVERAGE, COUNT, DISTINCT_COUNT, MAX, - * MEDIAN, MIN, STDEV, STDEVP, - * VAR, - * and VARP.

+ *

The foreground color that applies to any text or other elements that appear over the + * warning color.

* @public */ - Aggregation?: NamedFilterAggType | undefined; -} + WarningForeground?: string | undefined; -/** - *

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value falls within the specified range.

- * @public - */ -export interface TopicNumericRangeFilter { /** - *

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. - * If set to true, topics whose numeric field value is equal to the endpoint values will be - * included in the filter. If set to false, topics whose numeric field value is equal to the - * endpoint values will be excluded from the filter.

+ *

The color that applies to success messages, for example the check mark for a + * successful download.

* @public */ - Inclusive?: boolean | undefined; + Success?: string | undefined; /** - *

The constant used in a - * numeric range filter.

+ *

The foreground color that applies to any text or other elements that appear over the + * success color.

* @public */ - Constant?: TopicRangeFilterConstant | undefined; + SuccessForeground?: string | undefined; /** - *

An aggregation function that specifies how to calculate the value of a numeric field for - * a topic, Valid values for this structure are NO_AGGREGATION, SUM, - * AVERAGE, COUNT, DISTINCT_COUNT, MAX, - * MEDIAN, MIN, STDEV, STDEVP, - * VAR, - * and VARP.

+ *

The color that applies to the names of fields that are identified as + * dimensions.

* @public */ - Aggregation?: NamedFilterAggType | undefined; -} - -/** - * @public - * @enum - */ -export const TopicRelativeDateFilterFunction = { - LAST: "LAST", - NEXT: "NEXT", - NOW: "NOW", - PREVIOUS: "PREVIOUS", - THIS: "THIS", -} as const; - -/** - * @public - */ -export type TopicRelativeDateFilterFunction = - (typeof TopicRelativeDateFilterFunction)[keyof typeof TopicRelativeDateFilterFunction]; + Dimension?: string | undefined; -/** - *

A structure that represents a relative date filter.

- * @public - */ -export interface TopicRelativeDateFilter { /** - *

The level of time precision that is used to aggregate DateTime values.

+ *

The foreground color that applies to any text or other elements that appear over the + * dimension color.

* @public */ - TimeGranularity?: TopicTimeGranularity | undefined; + DimensionForeground?: string | undefined; /** - *

The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are BEFORE, AFTER, and BETWEEN.

+ *

The color that applies to the names of fields that are identified as measures.

* @public */ - RelativeDateFilterFunction?: TopicRelativeDateFilterFunction | undefined; + Measure?: string | undefined; /** - *

The constant used in a - * relative date filter.

+ *

The foreground color that applies to any text or other elements that appear over the + * measure color.

* @public */ - Constant?: TopicSingularFilterConstant | undefined; + MeasureForeground?: string | undefined; } /** - *

A structure that represents a filter used to select items for a topic.

+ *

The theme configuration. This configuration contains all of the display properties for + * a theme.

* @public */ -export interface TopicFilter { +export interface ThemeConfiguration { /** - *

A description of the filter used to select items for a topic.

+ *

Color properties that apply to chart data colors.

* @public */ - FilterDescription?: string | undefined; + DataColorPalette?: DataColorPalette | undefined; /** - *

The class of the filter. Valid values for this structure are - * ENFORCED_VALUE_FILTER, - * CONDITIONAL_VALUE_FILTER, - * and NAMED_VALUE_FILTER.

- * @public - */ - FilterClass?: FilterClass | undefined; - - /** - *

The name of the filter.

+ *

Color properties that apply to the UI and to charts, excluding the colors that apply + * to data.

* @public */ - FilterName: string | undefined; + UIColorPalette?: UIColorPalette | undefined; /** - *

The other names or aliases for the filter.

+ *

Display options related to sheets.

* @public */ - FilterSynonyms?: string[] | undefined; + Sheet?: SheetStyle | undefined; /** - *

The name of the field that the filter operates on.

+ *

Determines the typography options.

* @public */ - OperandFieldName: string | undefined; + Typography?: Typography | undefined; +} +/** + * @public + */ +export interface CreateThemeRequest { /** - *

The type of the filter. Valid values for this structure are - * CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, - * NUMERIC_RANGE_FILTER, - * DATE_RANGE_FILTER, - * and RELATIVE_DATE_FILTER.

+ *

The ID of the Amazon Web Services account where you want to store the new theme.

* @public */ - FilterType?: NamedFilterType | undefined; + AwsAccountId: string | undefined; /** - *

The category filter that is associated with this filter.

+ *

An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in + * each Amazon Web Services account.

* @public */ - CategoryFilter?: TopicCategoryFilter | undefined; + ThemeId: string | undefined; /** - *

The numeric equality filter.

+ *

A display name for the theme.

* @public */ - NumericEqualityFilter?: TopicNumericEqualityFilter | undefined; + Name: string | undefined; /** - *

The numeric range filter.

+ *

The ID of the theme that a custom theme will inherit from. All themes inherit from one of + * the starting themes defined by Amazon QuickSight. For a list of the starting themes, use + * ListThemes or choose Themes from + * within an analysis.

* @public */ - NumericRangeFilter?: TopicNumericRangeFilter | undefined; + BaseThemeId: string | undefined; /** - *

The date range filter.

+ *

A description of the first version of the theme that you're creating. Every time + * UpdateTheme is called, a new version is created. Each version of the + * theme has a description of the version in the VersionDescription + * field.

* @public */ - DateRangeFilter?: TopicDateRangeFilter | undefined; + VersionDescription?: string | undefined; /** - *

The relative date filter.

+ *

The theme configuration, which contains the theme display properties.

* @public */ - RelativeDateFilter?: TopicRelativeDateFilter | undefined; -} - -/** - * @public - * @enum - */ -export const NamedEntityAggType = { - AVERAGE: "AVERAGE", - COUNT: "COUNT", - CUSTOM: "CUSTOM", - DISTINCT_COUNT: "DISTINCT_COUNT", - MAX: "MAX", - MEDIAN: "MEDIAN", - MIN: "MIN", - PERCENTILE: "PERCENTILE", - STDEV: "STDEV", - STDEVP: "STDEVP", - SUM: "SUM", - VAR: "VAR", - VARP: "VARP", -} as const; - -/** - * @public - */ -export type NamedEntityAggType = (typeof NamedEntityAggType)[keyof typeof NamedEntityAggType]; + Configuration: ThemeConfiguration | undefined; -/** - *

A structure that represents a metric.

- * @public - */ -export interface NamedEntityDefinitionMetric { /** - *

The aggregation of a named entity. Valid values for this structure are SUM, - * MIN, MAX, COUNT, AVERAGE, - * DISTINCT_COUNT, STDEV, STDEVP, VAR, - * VARP, PERCENTILE, - * MEDIAN, - * and CUSTOM.

+ *

A valid grouping of resource permissions to apply to the new theme. + *

* @public */ - Aggregation?: NamedEntityAggType | undefined; + Permissions?: ResourcePermission[] | undefined; /** - *

The additional parameters for an aggregation function.

+ *

A map of the key-value pairs for the resource tag or tags that you want to add to the + * resource.

* @public */ - AggregationFunctionParameters?: Record | undefined; + Tags?: Tag[] | undefined; } /** - * @public - * @enum - */ -export const PropertyRole = { - ID: "ID", - PRIMARY: "PRIMARY", -} as const; - -/** - * @public - */ -export type PropertyRole = (typeof PropertyRole)[keyof typeof PropertyRole]; - -/** - * @public - * @enum - */ -export const PropertyUsage = { - DIMENSION: "DIMENSION", - INHERIT: "INHERIT", - MEASURE: "MEASURE", -} as const; - -/** - * @public - */ -export type PropertyUsage = (typeof PropertyUsage)[keyof typeof PropertyUsage]; - -/** - *

A structure that represents a named entity.

* @public */ -export interface NamedEntityDefinition { - /** - *

The name of the entity.

- * @public - */ - FieldName?: string | undefined; - - /** - *

The property name to be used for the named entity.

- * @public - */ - PropertyName?: string | undefined; - +export interface CreateThemeResponse { /** - *

The property role. Valid values for this structure are PRIMARY and ID.

+ *

The Amazon Resource Name (ARN) for the theme.

* @public */ - PropertyRole?: PropertyRole | undefined; + Arn?: string | undefined; /** - *

The property usage. Valid values for this structure are INHERIT, - * DIMENSION, - * and MEASURE.

+ *

The Amazon Resource Name (ARN) for the new theme.

* @public */ - PropertyUsage?: PropertyUsage | undefined; + VersionArn?: string | undefined; /** - *

The definition of a metric.

+ *

The ID of the theme.

* @public */ - Metric?: NamedEntityDefinitionMetric | undefined; -} + ThemeId?: string | undefined; -/** - *

A structure that represents a semantic entity type.

- * @public - */ -export interface SemanticEntityType { /** - *

The semantic entity type name.

+ *

The theme creation status.

* @public */ - TypeName?: string | undefined; + CreationStatus?: ResourceStatus | undefined; /** - *

The semantic entity sub type name.

+ *

The HTTP status of the request.

* @public */ - SubTypeName?: string | undefined; + Status?: number | undefined; /** - *

The semantic entity type parameters.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - TypeParameters?: Record | undefined; + RequestId?: string | undefined; } /** - *

A structure that represents a named entity.

* @public */ -export interface TopicNamedEntity { - /** - *

The name of the named entity.

- * @public - */ - EntityName: string | undefined; - +export interface CreateThemeAliasRequest { /** - *

The description of the named entity.

+ *

The ID of the Amazon Web Services account that contains the theme for the new theme alias.

* @public */ - EntityDescription?: string | undefined; + AwsAccountId: string | undefined; /** - *

The other - * names or aliases for the named entity.

+ *

An ID for the theme alias.

* @public */ - EntitySynonyms?: string[] | undefined; + ThemeId: string | undefined; /** - *

The type of named entity that a topic represents.

+ *

The name that you want to give to the theme alias that you are creating. The + * alias name can't begin with a $. Alias names that start with $ + * are reserved by Amazon QuickSight.

* @public */ - SemanticEntityType?: SemanticEntityType | undefined; + AliasName: string | undefined; /** - *

The definition of a named entity.

+ *

The version number of the theme.

* @public */ - Definition?: NamedEntityDefinition[] | undefined; + ThemeVersionNumber: number | undefined; } /** - *

A structure that represents a dataset.

+ *

An alias for a theme.

* @public */ -export interface DatasetMetadata { +export interface ThemeAlias { /** - *

The Amazon Resource Name (ARN) of the dataset.

+ *

The Amazon Resource Name (ARN) of the theme alias.

* @public */ - DatasetArn: string | undefined; + Arn?: string | undefined; /** - *

The name of the dataset.

+ *

The display name of the theme alias.

* @public */ - DatasetName?: string | undefined; + AliasName?: string | undefined; /** - *

The description of the dataset.

+ *

The version number of the theme alias.

* @public */ - DatasetDescription?: string | undefined; + ThemeVersionNumber?: number | undefined; +} +/** + * @public + */ +export interface CreateThemeAliasResponse { /** - *

The definition of a data aggregation.

+ *

Information about the theme alias.

* @public */ - DataAggregation?: DataAggregation | undefined; + ThemeAlias?: ThemeAlias | undefined; /** - *

The list of filter definitions.

+ *

The HTTP status of the request.

* @public */ - Filters?: TopicFilter[] | undefined; + Status?: number | undefined; /** - *

The list of column definitions.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Columns?: TopicColumn[] | undefined; + RequestId?: string | undefined; +} +/** + *

Configuration options for a Topic.

+ * @public + */ +export interface TopicConfigOptions { /** - *

The list of calculated field definitions.

+ *

Enables Amazon Q Business Insights for a Topic.

* @public */ - CalculatedFields?: TopicCalculatedField[] | undefined; - - /** - *

The list of named entities definitions.

- * @public - */ - NamedEntities?: TopicNamedEntity[] | undefined; -} + QBusinessInsightsEnabled?: boolean | undefined; +} /** * @public * @enum */ -export const TopicUserExperienceVersion = { - LEGACY: "LEGACY", - NEW_READER_EXPERIENCE: "NEW_READER_EXPERIENCE", +export const DefaultAggregation = { + AVERAGE: "AVERAGE", + COUNT: "COUNT", + DISTINCT_COUNT: "DISTINCT_COUNT", + MAX: "MAX", + MEDIAN: "MEDIAN", + MIN: "MIN", + STDEV: "STDEV", + STDEVP: "STDEVP", + SUM: "SUM", + VAR: "VAR", + VARP: "VARP", } as const; /** * @public */ -export type TopicUserExperienceVersion = (typeof TopicUserExperienceVersion)[keyof typeof TopicUserExperienceVersion]; +export type DefaultAggregation = (typeof DefaultAggregation)[keyof typeof DefaultAggregation]; /** - *

A structure that describes the details of a topic, such as its name, description, and associated data sets.

+ *

A structure that represents a default formatting definition.

* @public */ -export interface TopicDetails { +export interface DefaultFormatting { /** - *

The name of the topic.

+ *

The display format. Valid values for this structure are AUTO, + * PERCENT, CURRENCY, NUMBER, DATE, and + * STRING.

* @public */ - Name?: string | undefined; + DisplayFormat?: DisplayFormat | undefined; /** - *

The description of the topic.

+ *

The additional options for display formatting.

* @public */ - Description?: string | undefined; + DisplayFormatOptions?: DisplayFormatOptions | undefined; +} +/** + *

A structure that represents a semantic type.

+ * @public + */ +export interface SemanticType { /** - *

The user experience version of a topic.

+ *

The semantic type name.

* @public */ - UserExperienceVersion?: TopicUserExperienceVersion | undefined; + TypeName?: string | undefined; /** - *

The data sets that the topic is associated with.

+ *

The semantic type sub type name.

* @public */ - DataSets?: DatasetMetadata[] | undefined; + SubTypeName?: string | undefined; /** - *

Configuration options for a Topic.

+ *

The semantic type parameters.

* @public */ - ConfigOptions?: TopicConfigOptions | undefined; -} + TypeParameters?: Record | undefined; -/** - * @public - */ -export interface CreateTopicRequest { /** - *

The ID of the Amazon Web Services account that you want to create a topic in.

+ *

The semantic type truthy cell value.

* @public */ - AwsAccountId: string | undefined; + TruthyCellValue?: string | undefined; /** - *

The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The other names or aliases for the true cell value.

* @public */ - TopicId: string | undefined; + TruthyCellValueSynonyms?: string[] | undefined; /** - *

The definition of a topic to create.

+ *

The semantic type falsey cell value.

* @public */ - Topic: TopicDetails | undefined; + FalseyCellValue?: string | undefined; /** - *

Contains a map of the key-value pairs for the resource tag or tags that are assigned to - * the dataset.

+ *

The other names or aliases for the false cell value.

* @public */ - Tags?: Tag[] | undefined; + FalseyCellValueSynonyms?: string[] | undefined; } /** + *

A structure that represents a calculated field.

* @public */ -export interface CreateTopicResponse { +export interface TopicCalculatedField { /** - *

The Amazon Resource Name (ARN) of the topic.

+ *

The calculated field name.

* @public */ - Arn?: string | undefined; + CalculatedFieldName: string | undefined; /** - *

The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region - * for each Amazon Web Services account.

+ *

The calculated field description.

* @public */ - TopicId?: string | undefined; + CalculatedFieldDescription?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the topic refresh.

+ *

The calculated field expression.

* @public */ - RefreshArn?: string | undefined; + Expression: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The other names or aliases for the calculated field.

* @public */ - RequestId?: string | undefined; + CalculatedFieldSynonyms?: string[] | undefined; /** - *

The HTTP status of the request.

+ *

A boolean value that indicates if a calculated field is included in the topic.

* @public */ - Status?: number | undefined; -} - -/** - * @public - * @enum - */ -export const TopicScheduleType = { - DAILY: "DAILY", - HOURLY: "HOURLY", - MONTHLY: "MONTHLY", - WEEKLY: "WEEKLY", -} as const; + IsIncludedInTopic?: boolean | undefined; -/** - * @public - */ -export type TopicScheduleType = (typeof TopicScheduleType)[keyof typeof TopicScheduleType]; + /** + *

A Boolean value that indicates if a calculated field is visible in the autocomplete.

+ * @public + */ + DisableIndexing?: boolean | undefined; -/** - *

A structure that represents a topic refresh schedule.

- * @public - */ -export interface TopicRefreshSchedule { /** - *

A Boolean value that controls whether to schedule is enabled.

+ *

The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.

* @public */ - IsEnabled: boolean | undefined; + ColumnDataRole?: ColumnDataRole | undefined; /** - *

A Boolean value that controls whether to schedule runs at the same schedule that is specified in - * SPICE dataset.

+ *

The level of time precision that is used to aggregate DateTime values.

* @public */ - BasedOnSpiceSchedule: boolean | undefined; + TimeGranularity?: TopicTimeGranularity | undefined; /** - *

The starting date and time for the refresh schedule.

+ *

The default formatting definition.

* @public */ - StartingAt?: Date | undefined; + DefaultFormatting?: DefaultFormatting | undefined; /** - *

The timezone that you want the refresh schedule to use.

+ *

The default aggregation. Valid values for this structure are SUM, + * MAX, MIN, COUNT, + * DISTINCT_COUNT, + * and AVERAGE.

* @public */ - Timezone?: string | undefined; + Aggregation?: DefaultAggregation | undefined; /** - *

The time of day when the refresh should run, for - * example, Monday-Sunday.

+ *

The order in which data is displayed for the calculated field when + * it's used in a comparative context.

* @public */ - RepeatAt?: string | undefined; + ComparativeOrder?: ComparativeOrder | undefined; /** - *

The type of refresh schedule. Valid values for this structure are HOURLY, - * DAILY, - * WEEKLY, - * and MONTHLY.

+ *

The semantic type.

* @public */ - TopicScheduleType?: TopicScheduleType | undefined; -} + SemanticType?: SemanticType | undefined; -/** - * @public - */ -export interface CreateTopicRefreshScheduleRequest { /** - *

The ID of the Amazon Web Services account that contains the topic - * you're creating a refresh schedule for.

+ *

The list of aggregation types that are allowed for the calculated field. Valid values + * for this structure are COUNT, DISTINCT_COUNT, MIN, + * MAX, MEDIAN, SUM, AVERAGE, + * STDEV, STDEVP, VAR, + * VARP, and PERCENTILE.

* @public */ - AwsAccountId: string | undefined; + AllowedAggregations?: AuthorSpecifiedAggregation[] | undefined; /** - *

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The list of aggregation types that are not allowed for the calculated field. Valid + * values for this structure are COUNT, DISTINCT_COUNT, + * MIN, MAX, MEDIAN, SUM, + * AVERAGE, STDEV, STDEVP, VAR, + * VARP, and PERCENTILE.

* @public */ - TopicId: string | undefined; + NotAllowedAggregations?: AuthorSpecifiedAggregation[] | undefined; /** - *

The Amazon Resource Name (ARN) of the dataset.

+ *

A Boolean value that indicates whether to never aggregate calculated field in filters.

* @public */ - DatasetArn: string | undefined; + NeverAggregateInFilter?: boolean | undefined; /** - *

The name of the dataset.

+ *

The other + * names or aliases for the calculated field cell value.

* @public */ - DatasetName?: string | undefined; + CellValueSynonyms?: CellValueSynonym[] | undefined; /** - *

The definition of a refresh schedule.

+ *

The non additive for the table style target.

* @public */ - RefreshSchedule: TopicRefreshSchedule | undefined; + NonAdditive?: boolean | undefined; } /** + *

Represents a column in a dataset.

* @public */ -export interface CreateTopicRefreshScheduleResponse { +export interface TopicColumn { /** - *

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The name of the column.

* @public */ - TopicId?: string | undefined; + ColumnName: string | undefined; /** - *

The Amazon Resource Name (ARN) of the topic.

+ *

A user-friendly name for the column.

* @public */ - TopicArn?: string | undefined; + ColumnFriendlyName?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the dataset.

+ *

A description of the column and its contents.

* @public */ - DatasetArn?: string | undefined; + ColumnDescription?: string | undefined; /** - *

The HTTP status of the request.

+ *

The other names or aliases for the column.

* @public */ - Status?: number | undefined; + ColumnSynonyms?: string[] | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The role of the column in the data. Valid values are DIMENSION and MEASURE.

* @public */ - RequestId?: string | undefined; -} + ColumnDataRole?: ColumnDataRole | undefined; -/** - * @public - */ -export interface CreateVPCConnectionRequest { /** - *

The Amazon Web Services account ID of the account where you want to create a new VPC - * connection.

+ *

The type of aggregation that is performed on the column data when + * it's queried.

* @public */ - AwsAccountId: string | undefined; + Aggregation?: DefaultAggregation | undefined; /** - *

The ID of the VPC connection that - * you're creating. This ID is a unique identifier for each Amazon Web Services Region in an - * Amazon Web Services account.

+ *

A Boolean value that indicates whether the column is included in the query results.

* @public */ - VPCConnectionId: string | undefined; + IsIncludedInTopic?: boolean | undefined; /** - *

The display name for the VPC connection.

+ *

A Boolean value that indicates whether the column shows in the autocomplete functionality.

* @public */ - Name: string | undefined; + DisableIndexing?: boolean | undefined; /** - *

A list of subnet IDs for the VPC connection.

+ *

The order in which data is displayed for the column when + * it's used in a comparative context.

* @public */ - SubnetIds: string[] | undefined; + ComparativeOrder?: ComparativeOrder | undefined; /** - *

A list of security group IDs for the VPC connection.

+ *

The semantic type of data contained in the column.

* @public */ - SecurityGroupIds: string[] | undefined; + SemanticType?: SemanticType | undefined; /** - *

A list of IP addresses of DNS resolver endpoints for the VPC connection.

+ *

The level of time precision that is used to aggregate DateTime values.

* @public */ - DnsResolvers?: string[] | undefined; + TimeGranularity?: TopicTimeGranularity | undefined; /** - *

The IAM role to associate with the VPC connection.

- * @public - */ - RoleArn: string | undefined; - - /** - *

A map of the key-value pairs for the resource tag or tags assigned to the VPC - * connection.

- * @public - */ - Tags?: Tag[] | undefined; -} - -/** - * @public - * @enum - */ -export const VPCConnectionAvailabilityStatus = { - AVAILABLE: "AVAILABLE", - PARTIALLY_AVAILABLE: "PARTIALLY_AVAILABLE", - UNAVAILABLE: "UNAVAILABLE", -} as const; - -/** - * @public - */ -export type VPCConnectionAvailabilityStatus = - (typeof VPCConnectionAvailabilityStatus)[keyof typeof VPCConnectionAvailabilityStatus]; - -/** - * @public - * @enum - */ -export const VPCConnectionResourceStatus = { - CREATION_FAILED: "CREATION_FAILED", - CREATION_IN_PROGRESS: "CREATION_IN_PROGRESS", - CREATION_SUCCESSFUL: "CREATION_SUCCESSFUL", - DELETED: "DELETED", - DELETION_FAILED: "DELETION_FAILED", - DELETION_IN_PROGRESS: "DELETION_IN_PROGRESS", - UPDATE_FAILED: "UPDATE_FAILED", - UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS", - UPDATE_SUCCESSFUL: "UPDATE_SUCCESSFUL", -} as const; - -/** - * @public - */ -export type VPCConnectionResourceStatus = - (typeof VPCConnectionResourceStatus)[keyof typeof VPCConnectionResourceStatus]; - -/** - * @public - */ -export interface CreateVPCConnectionResponse { - /** - *

The Amazon Resource Name (ARN) of the VPC connection.

+ *

The list of aggregation types that are allowed for the column. Valid values for this + * structure are COUNT, DISTINCT_COUNT, MIN, + * MAX, MEDIAN, SUM, AVERAGE, + * STDEV, STDEVP, VAR, + * VARP, + * and PERCENTILE.

* @public */ - Arn?: string | undefined; + AllowedAggregations?: AuthorSpecifiedAggregation[] | undefined; /** - *

The ID for the VPC connection that - * you're creating. This ID is unique per Amazon Web Services Region for each Amazon Web Services - * account.

+ *

The list of aggregation types that are not allowed for the column. Valid values for this + * structure are COUNT, DISTINCT_COUNT, MIN, + * MAX, MEDIAN, SUM, AVERAGE, + * STDEV, STDEVP, VAR, + * VARP, + * and PERCENTILE.

* @public */ - VPCConnectionId?: string | undefined; + NotAllowedAggregations?: AuthorSpecifiedAggregation[] | undefined; /** - *

The status of the creation of the VPC connection.

+ *

The default formatting used for values in the column.

* @public */ - CreationStatus?: VPCConnectionResourceStatus | undefined; + DefaultFormatting?: DefaultFormatting | undefined; /** - *

The availability status of the VPC connection.

+ *

A Boolean + * value that indicates whether to aggregate the column data when + * it's used in a filter context.

* @public */ - AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; + NeverAggregateInFilter?: boolean | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The other names or aliases for the column cell value.

* @public */ - RequestId?: string | undefined; + CellValueSynonyms?: CellValueSynonym[] | undefined; /** - *

The HTTP status of the request.

+ *

The non additive value for the column.

* @public */ - Status?: number | undefined; + NonAdditive?: boolean | undefined; } /** - * @public - * @enum - */ -export const DashboardErrorType = { - ACCESS_DENIED: "ACCESS_DENIED", - COLUMN_GEOGRAPHIC_ROLE_MISMATCH: "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", - COLUMN_REPLACEMENT_MISSING: "COLUMN_REPLACEMENT_MISSING", - COLUMN_TYPE_MISMATCH: "COLUMN_TYPE_MISMATCH", - DATA_SET_NOT_FOUND: "DATA_SET_NOT_FOUND", - INTERNAL_FAILURE: "INTERNAL_FAILURE", - PARAMETER_NOT_FOUND: "PARAMETER_NOT_FOUND", - PARAMETER_TYPE_INVALID: "PARAMETER_TYPE_INVALID", - PARAMETER_VALUE_INCOMPATIBLE: "PARAMETER_VALUE_INCOMPATIBLE", - SOURCE_NOT_FOUND: "SOURCE_NOT_FOUND", -} as const; - -/** - * @public - */ -export type DashboardErrorType = (typeof DashboardErrorType)[keyof typeof DashboardErrorType]; - -/** - *

Dashboard error.

+ *

A structure that represents a data aggregation.

* @public */ -export interface DashboardError { - /** - *

Type.

- * @public - */ - Type?: DashboardErrorType | undefined; - +export interface DataAggregation { /** - *

Message.

+ *

The level of time precision that is used to aggregate DateTime values.

* @public */ - Message?: string | undefined; + DatasetRowDateGranularity?: TopicTimeGranularity | undefined; /** - *

Lists the violated entities that caused the dashboard error.

+ *

The column name for the default date.

* @public */ - ViolatedEntities?: Entity[] | undefined; + DefaultDateColumnName?: string | undefined; } /** - *

Dashboard version.

+ *

A constant used in a category filter.

* @public */ -export interface DashboardVersion { - /** - *

The time that this dashboard version was created.

- * @public - */ - CreatedTime?: Date | undefined; - - /** - *

Errors associated with this dashboard version.

- * @public - */ - Errors?: DashboardError[] | undefined; - - /** - *

Version number for this version of the dashboard.

- * @public - */ - VersionNumber?: number | undefined; - +export interface TopicCategoryFilterConstant { /** - *

The HTTP status of the request.

+ *

The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE.

* @public */ - Status?: ResourceStatus | undefined; + ConstantType?: ConstantType | undefined; /** - *

The Amazon Resource Name (ARN) of the resource.

+ *

A singular constant used in a category filter. This element is used to specify a single value for the constant.

* @public */ - Arn?: string | undefined; + SingularConstant?: string | undefined; /** - *

Source entity ARN.

+ *

A collective constant used in a category filter. This element is used to specify a list of values for the constant.

* @public */ - SourceEntityArn?: string | undefined; + CollectiveConstant?: CollectiveConstant | undefined; +} +/** + *

A structure that represents a category filter.

+ * @public + */ +export interface TopicCategoryFilter { /** - *

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this - * version of the dashboard.

+ *

The category filter function. Valid values for this structure are EXACT and CONTAINS.

* @public */ - DataSetArns?: string[] | undefined; + CategoryFilterFunction?: CategoryFilterFunction | undefined; /** - *

Description.

+ *

The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.

* @public */ - Description?: string | undefined; + CategoryFilterType?: CategoryFilterType | undefined; /** - *

The ARN of the theme associated with a version of the dashboard.

+ *

The constant used in a category filter.

* @public */ - ThemeArn?: string | undefined; + Constant?: TopicCategoryFilterConstant | undefined; /** - *

A list of the associated sheets with the unique identifier and name of each sheet.

+ *

A Boolean value that indicates if the filter is inverse.

* @public */ - Sheets?: Sheet[] | undefined; + Inverse?: boolean | undefined; } /** - *

Dashboard.

+ *

A structure that represents a range constant.

* @public */ -export interface Dashboard { - /** - *

Dashboard ID.

- * @public - */ - DashboardId?: string | undefined; - - /** - *

The Amazon Resource Name (ARN) of the resource.

- * @public - */ - Arn?: string | undefined; - +export interface RangeConstant { /** - *

A display name for the dashboard.

+ *

The minimum value for a range constant.

* @public */ - Name?: string | undefined; + Minimum?: string | undefined; /** - *

Version.

+ *

The maximum value for a range constant.

* @public */ - Version?: DashboardVersion | undefined; + Maximum?: string | undefined; +} +/** + *

A constant value that is used in a range filter to specify the endpoints of the range.

+ * @public + */ +export interface TopicRangeFilterConstant { /** - *

The time that this dashboard was created.

+ *

The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE.

* @public */ - CreatedTime?: Date | undefined; + ConstantType?: ConstantType | undefined; /** - *

The last time that this dashboard was published.

+ *

The value of the constant that is used to specify the endpoints of a range filter.

* @public */ - LastPublishedTime?: Date | undefined; + RangeConstant?: RangeConstant | undefined; +} +/** + *

A filter used to restrict data based on a range of dates or times.

+ * @public + */ +export interface TopicDateRangeFilter { /** - *

The last time that this dashboard was updated.

+ *

A Boolean value that indicates whether the date range filter should include the boundary values. If + * set to true, the filter includes the start and end dates. If set to false, the filter + * excludes them.

* @public */ - LastUpdatedTime?: Date | undefined; + Inclusive?: boolean | undefined; /** - *

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

+ *

The constant used in a date range filter.

* @public */ - LinkEntities?: string[] | undefined; + Constant?: TopicRangeFilterConstant | undefined; } /** * @public * @enum */ -export const DashboardFilterAttribute = { - DASHBOARD_NAME: "DASHBOARD_NAME", - DIRECT_QUICKSIGHT_OWNER: "DIRECT_QUICKSIGHT_OWNER", - DIRECT_QUICKSIGHT_SOLE_OWNER: "DIRECT_QUICKSIGHT_SOLE_OWNER", - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER", - QUICKSIGHT_OWNER: "QUICKSIGHT_OWNER", - QUICKSIGHT_USER: "QUICKSIGHT_USER", - QUICKSIGHT_VIEWER_OR_OWNER: "QUICKSIGHT_VIEWER_OR_OWNER", +export const NamedFilterType = { + CATEGORY_FILTER: "CATEGORY_FILTER", + DATE_RANGE_FILTER: "DATE_RANGE_FILTER", + NUMERIC_EQUALITY_FILTER: "NUMERIC_EQUALITY_FILTER", + NUMERIC_RANGE_FILTER: "NUMERIC_RANGE_FILTER", + RELATIVE_DATE_FILTER: "RELATIVE_DATE_FILTER", } as const; /** * @public */ -export type DashboardFilterAttribute = (typeof DashboardFilterAttribute)[keyof typeof DashboardFilterAttribute]; +export type NamedFilterType = (typeof NamedFilterType)[keyof typeof NamedFilterType]; /** - *

A filter that you apply when searching for dashboards.

* @public + * @enum */ -export interface DashboardSearchFilter { - /** - *

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

- *

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

- *

If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DASHBOARD_NAME.

- * @public - */ - Operator: FilterOperator | undefined; - - /** - *

The name of the value that you want to use as a filter, for example, "Name": - * "QUICKSIGHT_OWNER".

- *

Valid values are defined as follows:

- *
    - *
  • - *

    - * QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the dashboards's owners or viewers are returned. Implicit permissions from folders or groups are considered.

    - *
  • - *
  • - *

    - * QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are considered.

    - *
  • - *
  • - *

    - * DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as the only owner of the dashboard are returned. Implicit permissions from folders or groups are not considered.

    - *
  • - *
  • - *

    - * DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are not considered.

    - *
  • - *
  • - *

    - * DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners or viewers of the dashboards are returned. Implicit permissions from folders or groups are not considered.

    - *
  • - *
  • - *

    - * DASHBOARD_NAME: Any dashboards whose names have a substring match to this value will be returned.

    - *
  • - *
- * @public - */ - Name?: DashboardFilterAttribute | undefined; - - /** - *

The value of the named item, in this case QUICKSIGHT_USER, that you want - * to use as a filter, for example, "Value": - * "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

- * @public - */ - Value?: string | undefined; -} +export const NamedFilterAggType = { + AVERAGE: "AVERAGE", + COUNT: "COUNT", + DISTINCT_COUNT: "DISTINCT_COUNT", + MAX: "MAX", + MEDIAN: "MEDIAN", + MIN: "MIN", + NO_AGGREGATION: "NO_AGGREGATION", + STDEV: "STDEV", + STDEVP: "STDEVP", + SUM: "SUM", + VAR: "VAR", + VARP: "VARP", +} as const; /** - *

Dashboard summary.

* @public */ -export interface DashboardSummary { - /** - *

The Amazon Resource Name (ARN) of the resource.

- * @public - */ - Arn?: string | undefined; - - /** - *

Dashboard ID.

- * @public - */ - DashboardId?: string | undefined; - - /** - *

A display name for the dashboard.

- * @public - */ - Name?: string | undefined; - - /** - *

The time that this dashboard was created.

- * @public - */ - CreatedTime?: Date | undefined; - - /** - *

The last time that this dashboard was updated.

- * @public - */ - LastUpdatedTime?: Date | undefined; +export type NamedFilterAggType = (typeof NamedFilterAggType)[keyof typeof NamedFilterAggType]; +/** + *

A structure that represents a singular filter constant, used in filters to specify a single value to match against.

+ * @public + */ +export interface TopicSingularFilterConstant { /** - *

Published version number.

+ *

The type of the singular filter constant. Valid values for this structure are SINGULAR.

* @public */ - PublishedVersionNumber?: number | undefined; + ConstantType?: ConstantType | undefined; /** - *

The last time that this dashboard was published.

+ *

The value of the singular filter constant.

* @public */ - LastPublishedTime?: Date | undefined; + SingularConstant?: string | undefined; } /** - *

Dashboard version summary.

+ *

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value matches the specified value.

* @public */ -export interface DashboardVersionSummary { - /** - *

The Amazon Resource Name (ARN) of the resource.

- * @public - */ - Arn?: string | undefined; - +export interface TopicNumericEqualityFilter { /** - *

The time that this dashboard version was created.

+ *

The constant used in a numeric equality filter.

* @public */ - CreatedTime?: Date | undefined; + Constant?: TopicSingularFilterConstant | undefined; /** - *

Version number.

+ *

An aggregation function that specifies how to calculate the value of a numeric field for + * a topic. Valid values for this structure are NO_AGGREGATION, SUM, + * AVERAGE, COUNT, DISTINCT_COUNT, MAX, + * MEDIAN, MIN, STDEV, STDEVP, + * VAR, + * and VARP.

* @public */ - VersionNumber?: number | undefined; + Aggregation?: NamedFilterAggType | undefined; +} +/** + *

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value falls within the specified range.

+ * @public + */ +export interface TopicNumericRangeFilter { /** - *

The HTTP status of the request.

+ *

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. + * If set to true, topics whose numeric field value is equal to the endpoint values will be + * included in the filter. If set to false, topics whose numeric field value is equal to the + * endpoint values will be excluded from the filter.

* @public */ - Status?: ResourceStatus | undefined; + Inclusive?: boolean | undefined; /** - *

Source entity ARN.

+ *

The constant used in a + * numeric range filter.

* @public */ - SourceEntityArn?: string | undefined; + Constant?: TopicRangeFilterConstant | undefined; /** - *

Description.

+ *

An aggregation function that specifies how to calculate the value of a numeric field for + * a topic, Valid values for this structure are NO_AGGREGATION, SUM, + * AVERAGE, COUNT, DISTINCT_COUNT, MAX, + * MEDIAN, MIN, STDEV, STDEVP, + * VAR, + * and VARP.

* @public */ - Description?: string | undefined; + Aggregation?: NamedFilterAggType | undefined; } /** - *

Output column.

* @public + * @enum */ -export interface OutputColumn { - /** - *

The display name of the column..

- * @public - */ - Name?: string | undefined; +export const TopicRelativeDateFilterFunction = { + LAST: "LAST", + NEXT: "NEXT", + NOW: "NOW", + PREVIOUS: "PREVIOUS", + THIS: "THIS", +} as const; + +/** + * @public + */ +export type TopicRelativeDateFilterFunction = + (typeof TopicRelativeDateFilterFunction)[keyof typeof TopicRelativeDateFilterFunction]; +/** + *

A structure that represents a relative date filter.

+ * @public + */ +export interface TopicRelativeDateFilter { /** - *

A description for a column.

+ *

The level of time precision that is used to aggregate DateTime values.

* @public */ - Description?: string | undefined; + TimeGranularity?: TopicTimeGranularity | undefined; /** - *

The data type of the column.

+ *

The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are BEFORE, AFTER, and BETWEEN.

* @public */ - Type?: ColumnDataType | undefined; + RelativeDateFilterFunction?: TopicRelativeDateFilterFunction | undefined; /** - *

The sub data type of the column.

+ *

The constant used in a + * relative date filter.

* @public */ - SubType?: ColumnDataSubType | undefined; + Constant?: TopicSingularFilterConstant | undefined; } /** - *

Dataset.

+ *

A structure that represents a filter used to select items for a topic.

* @public */ -export interface DataSet { +export interface TopicFilter { /** - *

The Amazon Resource Name (ARN) of the resource.

+ *

A description of the filter used to select items for a topic.

* @public */ - Arn?: string | undefined; + FilterDescription?: string | undefined; /** - *

The ID of the dataset.

+ *

The class of the filter. Valid values for this structure are + * ENFORCED_VALUE_FILTER, + * CONDITIONAL_VALUE_FILTER, + * and NAMED_VALUE_FILTER.

* @public */ - DataSetId?: string | undefined; + FilterClass?: FilterClass | undefined; /** - *

A display name for the dataset.

+ *

The name of the filter.

* @public */ - Name?: string | undefined; + FilterName: string | undefined; /** - *

The time that this dataset was created.

+ *

The other names or aliases for the filter.

* @public */ - CreatedTime?: Date | undefined; + FilterSynonyms?: string[] | undefined; /** - *

The last time that this dataset was updated.

+ *

The name of the field that the filter operates on.

* @public */ - LastUpdatedTime?: Date | undefined; + OperandFieldName: string | undefined; /** - *

Declares the physical tables that are available in the underlying data sources.

+ *

The type of the filter. Valid values for this structure are + * CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, + * NUMERIC_RANGE_FILTER, + * DATE_RANGE_FILTER, + * and RELATIVE_DATE_FILTER.

* @public */ - PhysicalTableMap?: Record | undefined; + FilterType?: NamedFilterType | undefined; /** - *

Configures the combination and transformation of the data from the physical - * tables.

+ *

The category filter that is associated with this filter.

* @public */ - LogicalTableMap?: Record | undefined; + CategoryFilter?: TopicCategoryFilter | undefined; /** - *

The list of columns after all transforms. These columns are available in templates, - * analyses, and dashboards.

+ *

The numeric equality filter.

* @public */ - OutputColumns?: OutputColumn[] | undefined; + NumericEqualityFilter?: TopicNumericEqualityFilter | undefined; /** - *

A value that indicates whether you want to import the data into SPICE.

+ *

The numeric range filter.

* @public */ - ImportMode?: DataSetImportMode | undefined; + NumericRangeFilter?: TopicNumericRangeFilter | undefined; /** - *

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't - * imported into SPICE.

+ *

The date range filter.

* @public */ - ConsumedSpiceCapacityInBytes?: number | undefined; + DateRangeFilter?: TopicDateRangeFilter | undefined; /** - *

Groupings of columns that work together in certain Amazon QuickSight features. - * Currently, only geospatial hierarchy is supported.

- * @public - */ - ColumnGroups?: ColumnGroup[] | undefined; - - /** - *

The folder that contains fields and nested subfolders for your dataset.

- * @public - */ - FieldFolders?: Record | undefined; - - /** - *

The row-level security configuration for the dataset.

+ *

The relative date filter.

* @public */ - RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; + RelativeDateFilter?: TopicRelativeDateFilter | undefined; +} - /** - *

The element you can use to define tags for row-level security.

- * @public - */ - RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration | undefined; +/** + * @public + * @enum + */ +export const NamedEntityAggType = { + AVERAGE: "AVERAGE", + COUNT: "COUNT", + CUSTOM: "CUSTOM", + DISTINCT_COUNT: "DISTINCT_COUNT", + MAX: "MAX", + MEDIAN: "MEDIAN", + MIN: "MIN", + PERCENTILE: "PERCENTILE", + STDEV: "STDEV", + STDEVP: "STDEVP", + SUM: "SUM", + VAR: "VAR", + VARP: "VARP", +} as const; - /** - *

A set of one or more definitions of a - * ColumnLevelPermissionRule - * .

- * @public - */ - ColumnLevelPermissionRules?: ColumnLevelPermissionRule[] | undefined; +/** + * @public + */ +export type NamedEntityAggType = (typeof NamedEntityAggType)[keyof typeof NamedEntityAggType]; +/** + *

A structure that represents a metric.

+ * @public + */ +export interface NamedEntityDefinitionMetric { /** - *

The usage configuration to apply to child datasets that reference this dataset as a source.

+ *

The aggregation of a named entity. Valid values for this structure are SUM, + * MIN, MAX, COUNT, AVERAGE, + * DISTINCT_COUNT, STDEV, STDEVP, VAR, + * VARP, PERCENTILE, + * MEDIAN, + * and CUSTOM.

* @public */ - DataSetUsageConfiguration?: DataSetUsageConfiguration | undefined; + Aggregation?: NamedEntityAggType | undefined; /** - *

The parameters that are declared in a dataset.

+ *

The additional parameters for an aggregation function.

* @public */ - DatasetParameters?: DatasetParameter[] | undefined; + AggregationFunctionParameters?: Record | undefined; } /** * @public * @enum */ -export const DataSetFilterAttribute = { - DATASET_NAME: "DATASET_NAME", - DIRECT_QUICKSIGHT_OWNER: "DIRECT_QUICKSIGHT_OWNER", - DIRECT_QUICKSIGHT_SOLE_OWNER: "DIRECT_QUICKSIGHT_SOLE_OWNER", - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER", - QUICKSIGHT_OWNER: "QUICKSIGHT_OWNER", - QUICKSIGHT_VIEWER_OR_OWNER: "QUICKSIGHT_VIEWER_OR_OWNER", +export const PropertyRole = { + ID: "ID", + PRIMARY: "PRIMARY", } as const; /** * @public */ -export type DataSetFilterAttribute = (typeof DataSetFilterAttribute)[keyof typeof DataSetFilterAttribute]; +export type PropertyRole = (typeof PropertyRole)[keyof typeof PropertyRole]; /** * @public * @enum */ -export const LookbackWindowSizeUnit = { - DAY: "DAY", - HOUR: "HOUR", - WEEK: "WEEK", +export const PropertyUsage = { + DIMENSION: "DIMENSION", + INHERIT: "INHERIT", + MEASURE: "MEASURE", } as const; /** * @public */ -export type LookbackWindowSizeUnit = (typeof LookbackWindowSizeUnit)[keyof typeof LookbackWindowSizeUnit]; +export type PropertyUsage = (typeof PropertyUsage)[keyof typeof PropertyUsage]; /** - *

The lookback window setup of an incremental refresh configuration.

+ *

A structure that represents a named entity.

* @public */ -export interface LookbackWindow { +export interface NamedEntityDefinition { /** - *

The name of the lookback window column.

+ *

The name of the entity.

* @public */ - ColumnName: string | undefined; + FieldName?: string | undefined; /** - *

The lookback window column size.

+ *

The property name to be used for the named entity.

* @public */ - Size: number | undefined; + PropertyName?: string | undefined; /** - *

The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.

+ *

The property role. Valid values for this structure are PRIMARY and ID.

* @public */ - SizeUnit: LookbackWindowSizeUnit | undefined; -} + PropertyRole?: PropertyRole | undefined; -/** - *

The incremental refresh configuration for a dataset.

- * @public - */ -export interface IncrementalRefresh { /** - *

The lookback window setup for an incremental refresh configuration.

+ *

The property usage. Valid values for this structure are INHERIT, + * DIMENSION, + * and MEASURE.

* @public */ - LookbackWindow: LookbackWindow | undefined; -} + PropertyUsage?: PropertyUsage | undefined; -/** - *

The refresh configuration of a dataset.

- * @public - */ -export interface RefreshConfiguration { /** - *

The incremental refresh for the dataset.

+ *

The definition of a metric.

* @public */ - IncrementalRefresh: IncrementalRefresh | undefined; + Metric?: NamedEntityDefinitionMetric | undefined; } /** - *

The refresh properties of a dataset.

+ *

A structure that represents a semantic entity type.

* @public */ -export interface DataSetRefreshProperties { +export interface SemanticEntityType { /** - *

The refresh configuration for a dataset.

+ *

The semantic entity type name.

* @public */ - RefreshConfiguration: RefreshConfiguration | undefined; + TypeName?: string | undefined; + + /** + *

The semantic entity sub type name.

+ * @public + */ + SubTypeName?: string | undefined; + + /** + *

The semantic entity type parameters.

+ * @public + */ + TypeParameters?: Record | undefined; } /** - *

A filter that you apply when searching for datasets.

+ *

A structure that represents a named entity.

* @public */ -export interface DataSetSearchFilter { +export interface TopicNamedEntity { /** - *

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

- *

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose datasets you want to search in the "Value" field. For example, "Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1".

- *

If you set the value to "StringLike", you need to provide the name of the datasets you are searching for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASET_NAME.

+ *

The name of the named entity.

* @public */ - Operator: FilterOperator | undefined; + EntityName: string | undefined; /** - *

The name of the value that you want to use as a filter, for example, "Name": - * "QUICKSIGHT_OWNER".

- *

Valid values are defined as follows:

- *
    - *
  • - *

    - * QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the dataset owners or viewers are returned. Implicit permissions from folders or groups are considered.

    - *
  • - *
  • - *

    - * QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners of the dataset are returned. Implicit permissions from folders or groups are considered.

    - *
  • - *
  • - *

    - * DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as the only owner of the dataset are returned. Implicit permissions from folders or groups are not considered.

    - *
  • - *
  • - *

    - * DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners if the dataset are returned. Implicit permissions from folders or groups are not considered.

    - *
  • - *
  • - *

    - * DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners or viewers of the dataset are returned. Implicit permissions from folders or groups are not considered.

    - *
  • - *
  • - *

    - * DATASET_NAME: Any datasets whose names have a substring match to this value will be returned.

    - *
  • - *
+ *

The description of the named entity.

* @public */ - Name: DataSetFilterAttribute | undefined; + EntityDescription?: string | undefined; /** - *

The value of the named item, in this case QUICKSIGHT_OWNER, that you want - * to use as a filter, for example, "Value": - * "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

+ *

The other + * names or aliases for the named entity.

* @public */ - Value: string | undefined; + EntitySynonyms?: string[] | undefined; + + /** + *

The type of named entity that a topic represents.

+ * @public + */ + SemanticEntityType?: SemanticEntityType | undefined; + + /** + *

The definition of a named entity.

+ * @public + */ + Definition?: NamedEntityDefinition[] | undefined; } /** - *

Dataset summary.

+ *

A structure that represents a dataset.

* @public */ -export interface DataSetSummary { +export interface DatasetMetadata { /** *

The Amazon Resource Name (ARN) of the dataset.

* @public */ - Arn?: string | undefined; - - /** - *

The ID of the dataset.

- * @public - */ - DataSetId?: string | undefined; + DatasetArn: string | undefined; /** - *

A display name for the dataset.

+ *

The name of the dataset.

* @public */ - Name?: string | undefined; + DatasetName?: string | undefined; /** - *

The time that this dataset was created.

+ *

The description of the dataset.

* @public */ - CreatedTime?: Date | undefined; + DatasetDescription?: string | undefined; /** - *

The last time that this dataset was updated.

+ *

The definition of a data aggregation.

* @public */ - LastUpdatedTime?: Date | undefined; + DataAggregation?: DataAggregation | undefined; /** - *

A value that indicates whether you want to import the data into SPICE.

+ *

The list of filter definitions.

* @public */ - ImportMode?: DataSetImportMode | undefined; + Filters?: TopicFilter[] | undefined; /** - *

The row-level security configuration for the dataset.

+ *

The list of column definitions.

* @public */ - RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; + Columns?: TopicColumn[] | undefined; /** - *

Whether or not the row level permission tags are applied.

+ *

The list of calculated field definitions.

* @public */ - RowLevelPermissionTagConfigurationApplied?: boolean | undefined; + CalculatedFields?: TopicCalculatedField[] | undefined; /** - *

A value that indicates if the dataset has column level permission configured.

+ *

The list of named entities definitions.

* @public */ - ColumnLevelPermissionRulesApplied?: boolean | undefined; + NamedEntities?: TopicNamedEntity[] | undefined; } /** * @public * @enum */ -export const DataSourceErrorInfoType = { - ACCESS_DENIED: "ACCESS_DENIED", - CONFLICT: "CONFLICT", - COPY_SOURCE_NOT_FOUND: "COPY_SOURCE_NOT_FOUND", - ENGINE_VERSION_NOT_SUPPORTED: "ENGINE_VERSION_NOT_SUPPORTED", - GENERIC_SQL_FAILURE: "GENERIC_SQL_FAILURE", - TIMEOUT: "TIMEOUT", - UNKNOWN: "UNKNOWN", - UNKNOWN_HOST: "UNKNOWN_HOST", +export const TopicUserExperienceVersion = { + LEGACY: "LEGACY", + NEW_READER_EXPERIENCE: "NEW_READER_EXPERIENCE", } as const; /** * @public */ -export type DataSourceErrorInfoType = (typeof DataSourceErrorInfoType)[keyof typeof DataSourceErrorInfoType]; +export type TopicUserExperienceVersion = (typeof TopicUserExperienceVersion)[keyof typeof TopicUserExperienceVersion]; /** - *

Error information for the data source creation or update.

+ *

A structure that describes the details of a topic, such as its name, description, and associated data sets.

* @public */ -export interface DataSourceErrorInfo { - /** - *

Error type.

- * @public - */ - Type?: DataSourceErrorInfoType | undefined; - +export interface TopicDetails { /** - *

Error message.

+ *

The name of the topic.

* @public */ - Message?: string | undefined; -} + Name?: string | undefined; -/** - *

The structure of a data source.

- * @public - */ -export interface DataSource { /** - *

The Amazon Resource Name (ARN) of the data source.

+ *

The description of the topic.

* @public */ - Arn?: string | undefined; + Description?: string | undefined; /** - *

The ID of the data source. This ID is unique per Amazon Web Services Region for each - * Amazon Web Services account.

+ *

The user experience version of a topic.

* @public */ - DataSourceId?: string | undefined; + UserExperienceVersion?: TopicUserExperienceVersion | undefined; /** - *

A display name for the data source.

+ *

The data sets that the topic is associated with.

* @public */ - Name?: string | undefined; + DataSets?: DatasetMetadata[] | undefined; /** - *

The type of the data source. This type indicates which database engine the data source - * connects to.

+ *

Configuration options for a Topic.

* @public */ - Type?: DataSourceType | undefined; + ConfigOptions?: TopicConfigOptions | undefined; +} +/** + * @public + */ +export interface CreateTopicRequest { /** - *

The HTTP status of the request.

+ *

The ID of the Amazon Web Services account that you want to create a topic in.

* @public */ - Status?: ResourceStatus | undefined; + AwsAccountId: string | undefined; /** - *

The time that this data source was created.

+ *

The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - CreatedTime?: Date | undefined; + TopicId: string | undefined; /** - *

The last time that this data source was updated.

+ *

The definition of a topic to create.

* @public */ - LastUpdatedTime?: Date | undefined; + Topic: TopicDetails | undefined; /** - *

The parameters that Amazon QuickSight uses to connect to your underlying source. This - * is a variant type structure. For this structure to be valid, only one of the attributes - * can be non-null.

+ *

Contains a map of the key-value pairs for the resource tag or tags that are assigned to + * the dataset.

* @public */ - DataSourceParameters?: DataSourceParameters | undefined; + Tags?: Tag[] | undefined; +} +/** + * @public + */ +export interface CreateTopicResponse { /** - *

A set of alternate data source parameters that you want to share for the credentials - * stored with this data source. The credentials are applied in tandem with the data source - * parameters when you copy a data source by using a create or update request. The API - * operation compares the DataSourceParameters structure that's in the request - * with the structures in the AlternateDataSourceParameters allow list. If the - * structures are an exact match, the request is allowed to use the credentials from this - * existing data source. If the AlternateDataSourceParameters list is null, - * the Credentials originally used with this DataSourceParameters - * are automatically allowed.

+ *

The Amazon Resource Name (ARN) of the topic.

* @public */ - AlternateDataSourceParameters?: DataSourceParameters[] | undefined; + Arn?: string | undefined; /** - *

The VPC connection information. You need to use this parameter only when you want - * Amazon QuickSight to use a VPC connection when connecting to your underlying source.

+ *

The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region + * for each Amazon Web Services account.

* @public */ - VpcConnectionProperties?: VpcConnectionProperties | undefined; + TopicId?: string | undefined; /** - *

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your - * underlying source.

+ *

The Amazon Resource Name (ARN) of the topic refresh.

* @public */ - SslProperties?: SslProperties | undefined; + RefreshArn?: string | undefined; /** - *

Error information from the last update or the creation of the data source.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - ErrorInfo?: DataSourceErrorInfo | undefined; + RequestId?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

+ *

The HTTP status of the request.

* @public */ - SecretArn?: string | undefined; + Status?: number | undefined; } /** * @public * @enum */ -export const DataSourceFilterAttribute = { - DATASOURCE_NAME: "DATASOURCE_NAME", - DIRECT_QUICKSIGHT_OWNER: "DIRECT_QUICKSIGHT_OWNER", - DIRECT_QUICKSIGHT_SOLE_OWNER: "DIRECT_QUICKSIGHT_SOLE_OWNER", - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER", +export const TopicScheduleType = { + DAILY: "DAILY", + HOURLY: "HOURLY", + MONTHLY: "MONTHLY", + WEEKLY: "WEEKLY", } as const; /** * @public */ -export type DataSourceFilterAttribute = (typeof DataSourceFilterAttribute)[keyof typeof DataSourceFilterAttribute]; +export type TopicScheduleType = (typeof TopicScheduleType)[keyof typeof TopicScheduleType]; /** - *

A filter that you apply when searching for data sources.

+ *

A structure that represents a topic refresh schedule.

* @public */ -export interface DataSourceSearchFilter { +export interface TopicRefreshSchedule { /** - *

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

- *

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose data sources you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

- *

If you set the value to "StringLike", you need to provide the name of the data sources you are searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASOURCE_NAME.

+ *

A Boolean value that controls whether to schedule is enabled.

* @public */ - Operator: FilterOperator | undefined; + IsEnabled: boolean | undefined; /** - *

The name of the value that you want to use as a filter, for example, "Name": - * "DIRECT_QUICKSIGHT_OWNER".

- *

Valid values are defined as follows:

- *
    - *
  • - *

    - * DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners or viewers of the data sources are returned. Implicit permissions from folders or groups are not considered.

    - *
  • - *
  • - *

    - * DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners if the data source are returned. Implicit permissions from folders or groups are not considered.

    - *
  • - *
  • - *

    - * DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as the only owner of the data source are returned. Implicit permissions from folders or groups are not considered.

    - *
  • - *
  • - *

    - * DATASOURCE_NAME: Any data sources whose names have a substring match to the provided value are returned.

    - *
  • - *
+ *

A Boolean value that controls whether to schedule runs at the same schedule that is specified in + * SPICE dataset.

* @public */ - Name: DataSourceFilterAttribute | undefined; + BasedOnSpiceSchedule: boolean | undefined; /** - *

The value of the named item, for example DIRECT_QUICKSIGHT_OWNER, that you want - * to use as a filter, for example, "Value": - * "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

+ *

The starting date and time for the refresh schedule.

* @public */ - Value: string | undefined; -} + StartingAt?: Date | undefined; -/** - *

A DataSourceSummary object that returns a summary of a data source.

- * @public - */ -export interface DataSourceSummary { /** - *

The arn of the datasource.

+ *

The timezone that you want the refresh schedule to use.

* @public */ - Arn?: string | undefined; + Timezone?: string | undefined; /** - *

The unique ID of the data source.

+ *

The time of day when the refresh should run, for + * example, Monday-Sunday.

* @public */ - DataSourceId?: string | undefined; + RepeatAt?: string | undefined; /** - *

The name of the data source.

+ *

The type of refresh schedule. Valid values for this structure are HOURLY, + * DAILY, + * WEEKLY, + * and MONTHLY.

* @public */ - Name?: string | undefined; + TopicScheduleType?: TopicScheduleType | undefined; +} +/** + * @public + */ +export interface CreateTopicRefreshScheduleRequest { /** - *

The type of the data source.

+ *

The ID of the Amazon Web Services account that contains the topic + * you're creating a refresh schedule for.

* @public */ - Type?: DataSourceType | undefined; + AwsAccountId: string | undefined; /** - *

The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.

+ *

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - CreatedTime?: Date | undefined; + TopicId: string | undefined; /** - *

The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.

+ *

The Amazon Resource Name (ARN) of the dataset.

* @public */ - LastUpdatedTime?: Date | undefined; -} + DatasetArn: string | undefined; -/** - * @public - */ -export interface DeleteAccountCustomizationRequest { /** - *

The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in - * this Amazon Web Services Region.

+ *

The name of the dataset.

* @public */ - AwsAccountId: string | undefined; + DatasetName?: string | undefined; /** - *

The Amazon QuickSight namespace that you're deleting the customizations from.

+ *

The definition of a refresh schedule.

* @public */ - Namespace?: string | undefined; + RefreshSchedule: TopicRefreshSchedule | undefined; } /** * @public */ -export interface DeleteAccountCustomizationResponse { +export interface CreateTopicRefreshScheduleResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - RequestId?: string | undefined; + TopicId?: string | undefined; /** - *

The HTTP status of the request.

+ *

The Amazon Resource Name (ARN) of the topic.

* @public */ - Status?: number | undefined; -} + TopicArn?: string | undefined; -/** - * @public - */ -export interface DeleteAccountSubscriptionRequest { /** - *

The Amazon Web Services account ID of the account that you want to delete.

+ *

The Amazon Resource Name (ARN) of the dataset.

* @public */ - AwsAccountId: string | undefined; -} + DatasetArn?: string | undefined; -/** - * @public - */ -export interface DeleteAccountSubscriptionResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

The HTTP status of the request.

* @public */ - RequestId?: string | undefined; + Status?: number | undefined; /** - *

The HTTP status of the request.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Status?: number | undefined; + RequestId?: string | undefined; } /** * @public */ -export interface DeleteAnalysisRequest { +export interface CreateVPCConnectionRequest { /** - *

The ID of the Amazon Web Services account where you want to delete an analysis.

+ *

The Amazon Web Services account ID of the account where you want to create a new VPC + * connection.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the analysis that you're deleting.

+ *

The ID of the VPC connection that + * you're creating. This ID is a unique identifier for each Amazon Web Services Region in an + * Amazon Web Services account.

* @public */ - AnalysisId: string | undefined; - - /** - *

A value that specifies the number of days that Amazon QuickSight waits before it deletes the - * analysis. You can't use this parameter with the ForceDeleteWithoutRecovery - * option in the same API call. The default value is 30.

- * @public - */ - RecoveryWindowInDays?: number | undefined; + VPCConnectionId: string | undefined; /** - *

This option defaults to the value NoForceDeleteWithoutRecovery. To - * immediately delete the analysis, add the ForceDeleteWithoutRecovery option. - * You can't restore an analysis after it's deleted.

+ *

The display name for the VPC connection.

* @public */ - ForceDeleteWithoutRecovery?: boolean | undefined; -} + Name: string | undefined; -/** - * @public - */ -export interface DeleteAnalysisResponse { /** - *

The HTTP status of the request.

+ *

A list of subnet IDs for the VPC connection.

* @public */ - Status?: number | undefined; + SubnetIds: string[] | undefined; /** - *

The Amazon Resource Name (ARN) of the deleted analysis.

+ *

A list of security group IDs for the VPC connection.

* @public */ - Arn?: string | undefined; + SecurityGroupIds: string[] | undefined; /** - *

The ID of the deleted analysis.

+ *

A list of IP addresses of DNS resolver endpoints for the VPC connection.

* @public */ - AnalysisId?: string | undefined; + DnsResolvers?: string[] | undefined; /** - *

The date and time that the analysis is scheduled to be deleted.

+ *

The IAM role to associate with the VPC connection.

* @public */ - DeletionTime?: Date | undefined; + RoleArn: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

A map of the key-value pairs for the resource tag or tags assigned to the VPC + * connection.

* @public */ - RequestId?: string | undefined; + Tags?: Tag[] | undefined; } /** * @public + * @enum */ -export interface DeleteDashboardRequest { - /** - *

The ID of the Amazon Web Services account that contains the dashboard that you're - * deleting.

- * @public - */ - AwsAccountId: string | undefined; +export const VPCConnectionAvailabilityStatus = { + AVAILABLE: "AVAILABLE", + PARTIALLY_AVAILABLE: "PARTIALLY_AVAILABLE", + UNAVAILABLE: "UNAVAILABLE", +} as const; - /** - *

The ID for the dashboard.

- * @public - */ - DashboardId: string | undefined; +/** + * @public + */ +export type VPCConnectionAvailabilityStatus = + (typeof VPCConnectionAvailabilityStatus)[keyof typeof VPCConnectionAvailabilityStatus]; - /** - *

The version number of the dashboard. If the version number property is provided, only - * the specified version of the dashboard is deleted.

- * @public - */ - VersionNumber?: number | undefined; -} +/** + * @public + * @enum + */ +export const VPCConnectionResourceStatus = { + CREATION_FAILED: "CREATION_FAILED", + CREATION_IN_PROGRESS: "CREATION_IN_PROGRESS", + CREATION_SUCCESSFUL: "CREATION_SUCCESSFUL", + DELETED: "DELETED", + DELETION_FAILED: "DELETION_FAILED", + DELETION_IN_PROGRESS: "DELETION_IN_PROGRESS", + UPDATE_FAILED: "UPDATE_FAILED", + UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS", + UPDATE_SUCCESSFUL: "UPDATE_SUCCESSFUL", +} as const; /** * @public */ -export interface DeleteDashboardResponse { +export type VPCConnectionResourceStatus = + (typeof VPCConnectionResourceStatus)[keyof typeof VPCConnectionResourceStatus]; + +/** + * @public + */ +export interface CreateVPCConnectionResponse { /** - *

The HTTP status of the request.

+ *

The Amazon Resource Name (ARN) of the VPC connection.

* @public */ - Status?: number | undefined; + Arn?: string | undefined; /** - *

The Secure Socket Layer (SSL) properties that apply for the resource.

+ *

The ID for the VPC connection that + * you're creating. This ID is unique per Amazon Web Services Region for each Amazon Web Services + * account.

* @public */ - Arn?: string | undefined; + VPCConnectionId?: string | undefined; /** - *

The ID of the dashboard.

+ *

The status of the creation of the VPC connection.

* @public */ - DashboardId?: string | undefined; + CreationStatus?: VPCConnectionResourceStatus | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The availability status of the VPC connection.

* @public */ - RequestId?: string | undefined; -} + AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; -/** - * @public - */ -export interface DeleteDataSetRequest { /** - *

The Amazon Web Services account ID.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AwsAccountId: string | undefined; + RequestId?: string | undefined; /** - *

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The HTTP status of the request.

* @public */ - DataSetId: string | undefined; + Status?: number | undefined; } /** + *

The custom permissions profile.

* @public */ -export interface DeleteDataSetResponse { +export interface CustomPermissions { /** - *

The Amazon Resource Name (ARN) of the dataset.

+ *

The Amazon Resource Name (ARN) of the custom permissions profile.

* @public */ Arn?: string | undefined; /** - *

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

- * @public - */ - DataSetId?: string | undefined; - - /** - *

The Amazon Web Services request ID for this operation.

+ *

The name of the custom permissions profile.

* @public */ - RequestId?: string | undefined; + CustomPermissionsName?: string | undefined; /** - *

The HTTP status of the request.

+ *

A set of actions in the custom permissions profile.

* @public */ - Status?: number | undefined; + Capabilities?: Capabilities | undefined; } /** * @public + * @enum */ -export interface DeleteDataSetRefreshPropertiesRequest { +export const DashboardErrorType = { + ACCESS_DENIED: "ACCESS_DENIED", + COLUMN_GEOGRAPHIC_ROLE_MISMATCH: "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", + COLUMN_REPLACEMENT_MISSING: "COLUMN_REPLACEMENT_MISSING", + COLUMN_TYPE_MISMATCH: "COLUMN_TYPE_MISMATCH", + DATA_SET_NOT_FOUND: "DATA_SET_NOT_FOUND", + INTERNAL_FAILURE: "INTERNAL_FAILURE", + PARAMETER_NOT_FOUND: "PARAMETER_NOT_FOUND", + PARAMETER_TYPE_INVALID: "PARAMETER_TYPE_INVALID", + PARAMETER_VALUE_INCOMPATIBLE: "PARAMETER_VALUE_INCOMPATIBLE", + SOURCE_NOT_FOUND: "SOURCE_NOT_FOUND", +} as const; + +/** + * @public + */ +export type DashboardErrorType = (typeof DashboardErrorType)[keyof typeof DashboardErrorType]; + +/** + *

Dashboard error.

+ * @public + */ +export interface DashboardError { /** - *

The Amazon Web Services account ID.

+ *

Type.

* @public */ - AwsAccountId: string | undefined; + Type?: DashboardErrorType | undefined; /** - *

The ID of the dataset.

+ *

Message.

* @public */ - DataSetId: string | undefined; + Message?: string | undefined; + + /** + *

Lists the violated entities that caused the dashboard error.

+ * @public + */ + ViolatedEntities?: Entity[] | undefined; } /** + *

Dashboard version.

* @public */ -export interface DeleteDataSetRefreshPropertiesResponse { +export interface DashboardVersion { /** - *

The Amazon Web Services request ID for this operation.

+ *

The time that this dashboard version was created.

* @public */ - RequestId?: string | undefined; + CreatedTime?: Date | undefined; /** - *

The HTTP status of the request.

+ *

Errors associated with this dashboard version.

* @public */ - Status?: number | undefined; -} + Errors?: DashboardError[] | undefined; -/** - * @public - */ -export interface DeleteDataSourceRequest { /** - *

The Amazon Web Services account ID.

+ *

Version number for this version of the dashboard.

* @public */ - AwsAccountId: string | undefined; + VersionNumber?: number | undefined; /** - *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The HTTP status of the request.

* @public */ - DataSourceId: string | undefined; -} + Status?: ResourceStatus | undefined; -/** - * @public - */ -export interface DeleteDataSourceResponse { /** - *

The Amazon Resource Name (ARN) of the data source that you deleted.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ Arn?: string | undefined; /** - *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

Source entity ARN.

* @public */ - DataSourceId?: string | undefined; + SourceEntityArn?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this + * version of the dashboard.

* @public */ - RequestId?: string | undefined; + DataSetArns?: string[] | undefined; /** - *

The HTTP status of the request.

+ *

Description.

* @public */ - Status?: number | undefined; -} + Description?: string | undefined; -/** - * @public - */ -export interface DeleteFolderRequest { /** - *

The ID for the Amazon Web Services account that contains the folder.

+ *

The ARN of the theme associated with a version of the dashboard.

* @public */ - AwsAccountId: string | undefined; + ThemeArn?: string | undefined; /** - *

The ID of the folder.

+ *

A list of the associated sheets with the unique identifier and name of each sheet.

* @public */ - FolderId: string | undefined; + Sheets?: Sheet[] | undefined; } /** + *

Dashboard.

* @public */ -export interface DeleteFolderResponse { +export interface Dashboard { /** - *

The HTTP status of the request.

+ *

Dashboard ID.

* @public */ - Status?: number | undefined; + DashboardId?: string | undefined; /** - *

The Amazon Resource Name of the deleted folder.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ Arn?: string | undefined; /** - *

The ID of the folder.

+ *

A display name for the dashboard.

* @public */ - FolderId?: string | undefined; + Name?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

Version.

* @public */ - RequestId?: string | undefined; -} + Version?: DashboardVersion | undefined; -/** - * @public - */ -export interface DeleteFolderMembershipRequest { /** - *

The ID for the Amazon Web Services account that contains the folder.

+ *

The time that this dashboard was created.

* @public */ - AwsAccountId: string | undefined; + CreatedTime?: Date | undefined; /** - *

The Folder ID.

+ *

The last time that this dashboard was published.

* @public */ - FolderId: string | undefined; + LastPublishedTime?: Date | undefined; /** - *

The ID of the asset that you want to delete.

+ *

The last time that this dashboard was updated.

* @public */ - MemberId: string | undefined; + LastUpdatedTime?: Date | undefined; /** - *

The member type of the asset that you want to delete from a folder.

+ *

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

* @public */ - MemberType: MemberType | undefined; + LinkEntities?: string[] | undefined; } /** * @public + * @enum */ -export interface DeleteFolderMembershipResponse { - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; +export const DashboardFilterAttribute = { + DASHBOARD_NAME: "DASHBOARD_NAME", + DIRECT_QUICKSIGHT_OWNER: "DIRECT_QUICKSIGHT_OWNER", + DIRECT_QUICKSIGHT_SOLE_OWNER: "DIRECT_QUICKSIGHT_SOLE_OWNER", + DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER", + QUICKSIGHT_OWNER: "QUICKSIGHT_OWNER", + QUICKSIGHT_USER: "QUICKSIGHT_USER", + QUICKSIGHT_VIEWER_OR_OWNER: "QUICKSIGHT_VIEWER_OR_OWNER", +} as const; - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; -} +/** + * @public + */ +export type DashboardFilterAttribute = (typeof DashboardFilterAttribute)[keyof typeof DashboardFilterAttribute]; /** + *

A filter that you apply when searching for dashboards.

* @public */ -export interface DeleteGroupRequest { +export interface DashboardSearchFilter { /** - *

The name of the group that you want to delete.

+ *

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

+ *

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

+ *

If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DASHBOARD_NAME.

* @public */ - GroupName: string | undefined; + Operator: FilterOperator | undefined; /** - *

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the - * Amazon Web Services account that contains your Amazon QuickSight account.

+ *

The name of the value that you want to use as a filter, for example, "Name": + * "QUICKSIGHT_OWNER".

+ *

Valid values are defined as follows:

+ *
    + *
  • + *

    + * QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the dashboards's owners or viewers are returned. Implicit permissions from folders or groups are considered.

    + *
  • + *
  • + *

    + * QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are considered.

    + *
  • + *
  • + *

    + * DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as the only owner of the dashboard are returned. Implicit permissions from folders or groups are not considered.

    + *
  • + *
  • + *

    + * DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are not considered.

    + *
  • + *
  • + *

    + * DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners or viewers of the dashboards are returned. Implicit permissions from folders or groups are not considered.

    + *
  • + *
  • + *

    + * DASHBOARD_NAME: Any dashboards whose names have a substring match to this value will be returned.

    + *
  • + *
* @public */ - AwsAccountId: string | undefined; + Name?: DashboardFilterAttribute | undefined; /** - *

The namespace of the group that you want to delete.

+ *

The value of the named item, in this case QUICKSIGHT_USER, that you want + * to use as a filter, for example, "Value": + * "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

* @public */ - Namespace: string | undefined; + Value?: string | undefined; } /** + *

Dashboard summary.

* @public */ -export interface DeleteGroupResponse { - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; - +export interface DashboardSummary { /** - *

The HTTP status of the request.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ - Status?: number | undefined; -} + Arn?: string | undefined; -/** - * @public - */ -export interface DeleteGroupMembershipRequest { /** - *

The name of the user that you want to delete from the group membership.

+ *

Dashboard ID.

* @public */ - MemberName: string | undefined; + DashboardId?: string | undefined; /** - *

The name of the group that you want to delete the user from.

+ *

A display name for the dashboard.

* @public */ - GroupName: string | undefined; + Name?: string | undefined; /** - *

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the - * Amazon Web Services account that contains your Amazon QuickSight account.

+ *

The time that this dashboard was created.

* @public */ - AwsAccountId: string | undefined; + CreatedTime?: Date | undefined; /** - *

The namespace of the group that you want to remove a user from.

+ *

The last time that this dashboard was updated.

* @public */ - Namespace: string | undefined; -} + LastUpdatedTime?: Date | undefined; -/** - * @public - */ -export interface DeleteGroupMembershipResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

Published version number.

* @public */ - RequestId?: string | undefined; + PublishedVersionNumber?: number | undefined; /** - *

The HTTP status of the request.

+ *

The last time that this dashboard was published.

* @public */ - Status?: number | undefined; + LastPublishedTime?: Date | undefined; } /** + *

Dashboard version summary.

* @public */ -export interface DeleteIAMPolicyAssignmentRequest { +export interface DashboardVersionSummary { /** - *

The Amazon Web Services account ID where you want to delete the IAM - * policy assignment.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ - AwsAccountId: string | undefined; + Arn?: string | undefined; /** - *

The name of the assignment.

+ *

The time that this dashboard version was created.

* @public */ - AssignmentName: string | undefined; + CreatedTime?: Date | undefined; /** - *

The namespace that contains the assignment.

+ *

Version number.

* @public */ - Namespace: string | undefined; -} + VersionNumber?: number | undefined; -/** - * @public - */ -export interface DeleteIAMPolicyAssignmentResponse { /** - *

The name of the assignment.

+ *

The HTTP status of the request.

* @public */ - AssignmentName?: string | undefined; + Status?: ResourceStatus | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

Source entity ARN.

* @public */ - RequestId?: string | undefined; + SourceEntityArn?: string | undefined; /** - *

The HTTP status of the request.

+ *

Description.

* @public */ - Status?: number | undefined; + Description?: string | undefined; } /** + *

Output column.

* @public */ -export interface DeleteIdentityPropagationConfigRequest { +export interface OutputColumn { /** - *

The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from.

+ *

The display name of the column..

* @public */ - AwsAccountId: string | undefined; + Name?: string | undefined; /** - *

The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.

+ *

A description for a column.

* @public */ - Service: ServiceType | undefined; -} + Description?: string | undefined; -/** - * @public - */ -export interface DeleteIdentityPropagationConfigResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

The data type of the column.

* @public */ - RequestId?: string | undefined; + Type?: ColumnDataType | undefined; /** - *

The HTTP status of the request.

+ *

The sub data type of the column.

* @public */ - Status?: number | undefined; + SubType?: ColumnDataSubType | undefined; } /** + *

Dataset.

* @public */ -export interface DeleteNamespaceRequest { +export interface DataSet { /** - *

The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ - AwsAccountId: string | undefined; + Arn?: string | undefined; /** - *

The namespace that you want to delete.

+ *

The ID of the dataset.

* @public */ - Namespace: string | undefined; -} + DataSetId?: string | undefined; -/** - * @public - */ -export interface DeleteNamespaceResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

A display name for the dataset.

* @public */ - RequestId?: string | undefined; + Name?: string | undefined; /** - *

The HTTP status of the request.

+ *

The time that this dataset was created.

* @public */ - Status?: number | undefined; -} + CreatedTime?: Date | undefined; -/** - * @public - */ -export interface DeleteRefreshScheduleRequest { /** - *

The ID of the dataset.

+ *

The last time that this dataset was updated.

* @public */ - DataSetId: string | undefined; + LastUpdatedTime?: Date | undefined; /** - *

The Amazon Web Services account ID.

+ *

Declares the physical tables that are available in the underlying data sources.

* @public */ - AwsAccountId: string | undefined; + PhysicalTableMap?: Record | undefined; /** - *

The ID of the refresh schedule.

+ *

Configures the combination and transformation of the data from the physical + * tables.

* @public */ - ScheduleId: string | undefined; -} + LogicalTableMap?: Record | undefined; -/** - * @public - */ -export interface DeleteRefreshScheduleResponse { /** - *

The HTTP status of the request.

+ *

The list of columns after all transforms. These columns are available in templates, + * analyses, and dashboards.

* @public */ - Status?: number | undefined; + OutputColumns?: OutputColumn[] | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

A value that indicates whether you want to import the data into SPICE.

* @public */ - RequestId?: string | undefined; + ImportMode?: DataSetImportMode | undefined; /** - *

The ID of the refresh schedule.

+ *

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't + * imported into SPICE.

* @public */ - ScheduleId?: string | undefined; - - /** - *

The Amazon Resource Name (ARN) for the refresh schedule.

- * @public - */ - Arn?: string | undefined; -} + ConsumedSpiceCapacityInBytes?: number | undefined; -/** - * @public - */ -export interface DeleteRoleCustomPermissionRequest { /** - *

The role that you want to remove permissions from.

+ *

Groupings of columns that work together in certain Amazon QuickSight features. + * Currently, only geospatial hierarchy is supported.

* @public */ - Role: Role | undefined; + ColumnGroups?: ColumnGroup[] | undefined; /** - *

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the - * Amazon Web Services account that contains your Amazon QuickSight account.

+ *

The folder that contains fields and nested subfolders for your dataset.

* @public */ - AwsAccountId: string | undefined; + FieldFolders?: Record | undefined; /** - *

The namespace that includes the role.

+ *

The row-level security configuration for the dataset.

* @public */ - Namespace: string | undefined; -} + RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; -/** - * @public - */ -export interface DeleteRoleCustomPermissionResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

The element you can use to define tags for row-level security.

* @public */ - RequestId?: string | undefined; + RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration | undefined; /** - *

The HTTP status of the request.

+ *

A set of one or more definitions of a + * ColumnLevelPermissionRule + * .

* @public */ - Status?: number | undefined; -} + ColumnLevelPermissionRules?: ColumnLevelPermissionRule[] | undefined; -/** - * @public - */ -export interface DeleteRoleMembershipRequest { /** - *

The name of the group.

+ *

The usage configuration to apply to child datasets that reference this dataset as a source.

* @public */ - MemberName: string | undefined; + DataSetUsageConfiguration?: DataSetUsageConfiguration | undefined; /** - *

The role that you want to remove permissions from.

+ *

The parameters that are declared in a dataset.

* @public */ - Role: Role | undefined; + DatasetParameters?: DatasetParameter[] | undefined; +} - /** - *

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

- * @public - */ - AwsAccountId: string | undefined; +/** + * @public + * @enum + */ +export const DataSetFilterAttribute = { + DATASET_NAME: "DATASET_NAME", + DIRECT_QUICKSIGHT_OWNER: "DIRECT_QUICKSIGHT_OWNER", + DIRECT_QUICKSIGHT_SOLE_OWNER: "DIRECT_QUICKSIGHT_SOLE_OWNER", + DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER", + QUICKSIGHT_OWNER: "QUICKSIGHT_OWNER", + QUICKSIGHT_VIEWER_OR_OWNER: "QUICKSIGHT_VIEWER_OR_OWNER", +} as const; - /** - *

The namespace that contains the role.

- * @public - */ - Namespace: string | undefined; -} +/** + * @public + */ +export type DataSetFilterAttribute = (typeof DataSetFilterAttribute)[keyof typeof DataSetFilterAttribute]; /** * @public + * @enum */ -export interface DeleteRoleMembershipResponse { - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; +export const LookbackWindowSizeUnit = { + DAY: "DAY", + HOUR: "HOUR", + WEEK: "WEEK", +} as const; - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; -} +/** + * @public + */ +export type LookbackWindowSizeUnit = (typeof LookbackWindowSizeUnit)[keyof typeof LookbackWindowSizeUnit]; /** + *

The lookback window setup of an incremental refresh configuration.

* @public */ -export interface DeleteTemplateRequest { +export interface LookbackWindow { /** - *

The ID of the Amazon Web Services account that contains the template that you're deleting.

+ *

The name of the lookback window column.

* @public */ - AwsAccountId: string | undefined; + ColumnName: string | undefined; /** - *

An ID for the template you want to delete.

+ *

The lookback window column size.

* @public */ - TemplateId: string | undefined; + Size: number | undefined; /** - *

Specifies the version of the template that you want to delete. - * If you don't provide a version number, DeleteTemplate deletes all versions of the template. - *

+ *

The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.

* @public */ - VersionNumber?: number | undefined; + SizeUnit: LookbackWindowSizeUnit | undefined; } /** + *

The incremental refresh configuration for a dataset.

* @public */ -export interface DeleteTemplateResponse { - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; - +export interface IncrementalRefresh { /** - *

The Amazon Resource Name (ARN) of the resource.

+ *

The lookback window setup for an incremental refresh configuration.

* @public */ - Arn?: string | undefined; + LookbackWindow: LookbackWindow | undefined; +} +/** + *

The refresh configuration of a dataset.

+ * @public + */ +export interface RefreshConfiguration { /** - *

An ID for the template.

+ *

The incremental refresh for the dataset.

* @public */ - TemplateId?: string | undefined; + IncrementalRefresh: IncrementalRefresh | undefined; +} +/** + *

The refresh properties of a dataset.

+ * @public + */ +export interface DataSetRefreshProperties { /** - *

The HTTP status of the request.

+ *

The refresh configuration for a dataset.

* @public */ - Status?: number | undefined; + RefreshConfiguration: RefreshConfiguration | undefined; } /** + *

A filter that you apply when searching for datasets.

* @public */ -export interface DeleteTemplateAliasRequest { +export interface DataSetSearchFilter { /** - *

The ID of the Amazon Web Services account that contains the item to delete.

+ *

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

+ *

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose datasets you want to search in the "Value" field. For example, "Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1".

+ *

If you set the value to "StringLike", you need to provide the name of the datasets you are searching for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASET_NAME.

* @public */ - AwsAccountId: string | undefined; + Operator: FilterOperator | undefined; /** - *

The ID for the template that the specified alias is for.

+ *

The name of the value that you want to use as a filter, for example, "Name": + * "QUICKSIGHT_OWNER".

+ *

Valid values are defined as follows:

+ *
    + *
  • + *

    + * QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the dataset owners or viewers are returned. Implicit permissions from folders or groups are considered.

    + *
  • + *
  • + *

    + * QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners of the dataset are returned. Implicit permissions from folders or groups are considered.

    + *
  • + *
  • + *

    + * DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as the only owner of the dataset are returned. Implicit permissions from folders or groups are not considered.

    + *
  • + *
  • + *

    + * DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners if the dataset are returned. Implicit permissions from folders or groups are not considered.

    + *
  • + *
  • + *

    + * DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners or viewers of the dataset are returned. Implicit permissions from folders or groups are not considered.

    + *
  • + *
  • + *

    + * DATASET_NAME: Any datasets whose names have a substring match to this value will be returned.

    + *
  • + *
* @public */ - TemplateId: string | undefined; + Name: DataSetFilterAttribute | undefined; /** - *

The name for the template alias. To delete a specific alias, you delete the version that the - * alias points to. You can specify the alias name, or specify the latest version of the - * template by providing the keyword $LATEST in the AliasName - * parameter.

+ *

The value of the named item, in this case QUICKSIGHT_OWNER, that you want + * to use as a filter, for example, "Value": + * "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

* @public */ - AliasName: string | undefined; + Value: string | undefined; } /** + *

Dataset summary.

* @public */ -export interface DeleteTemplateAliasResponse { +export interface DataSetSummary { /** - *

The HTTP status of the request.

+ *

The Amazon Resource Name (ARN) of the dataset.

* @public */ - Status?: number | undefined; + Arn?: string | undefined; /** - *

An ID for the template associated with the deletion.

+ *

The ID of the dataset.

* @public */ - TemplateId?: string | undefined; + DataSetId?: string | undefined; /** - *

The name for the template alias.

+ *

A display name for the dataset.

* @public */ - AliasName?: string | undefined; + Name?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the template you want to delete.

+ *

The time that this dataset was created.

* @public */ - Arn?: string | undefined; + CreatedTime?: Date | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The last time that this dataset was updated.

* @public */ - RequestId?: string | undefined; -} + LastUpdatedTime?: Date | undefined; -/** - * @public - */ -export interface DeleteThemeRequest { /** - *

The ID of the Amazon Web Services account that contains the theme that you're deleting.

+ *

A value that indicates whether you want to import the data into SPICE.

* @public */ - AwsAccountId: string | undefined; + ImportMode?: DataSetImportMode | undefined; /** - *

An ID for the theme that you want to delete.

+ *

The row-level security configuration for the dataset.

* @public */ - ThemeId: string | undefined; + RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; /** - *

The version of the theme that you want to delete.

- *

- * Note: If you don't provide a version number, you're - * using this call to DeleteTheme to delete all versions of the theme.

+ *

Whether or not the row level permission tags are applied.

* @public */ - VersionNumber?: number | undefined; + RowLevelPermissionTagConfigurationApplied?: boolean | undefined; + + /** + *

A value that indicates if the dataset has column level permission configured.

+ * @public + */ + ColumnLevelPermissionRulesApplied?: boolean | undefined; } /** * @public + * @enum */ -export interface DeleteThemeResponse { - /** - *

The Amazon Resource Name (ARN) of the resource.

- * @public - */ - Arn?: string | undefined; +export const DataSourceErrorInfoType = { + ACCESS_DENIED: "ACCESS_DENIED", + CONFLICT: "CONFLICT", + COPY_SOURCE_NOT_FOUND: "COPY_SOURCE_NOT_FOUND", + ENGINE_VERSION_NOT_SUPPORTED: "ENGINE_VERSION_NOT_SUPPORTED", + GENERIC_SQL_FAILURE: "GENERIC_SQL_FAILURE", + TIMEOUT: "TIMEOUT", + UNKNOWN: "UNKNOWN", + UNKNOWN_HOST: "UNKNOWN_HOST", +} as const; - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; +/** + * @public + */ +export type DataSourceErrorInfoType = (typeof DataSourceErrorInfoType)[keyof typeof DataSourceErrorInfoType]; +/** + *

Error information for the data source creation or update.

+ * @public + */ +export interface DataSourceErrorInfo { /** - *

The HTTP status of the request.

+ *

Error type.

* @public */ - Status?: number | undefined; + Type?: DataSourceErrorInfoType | undefined; /** - *

An ID for the theme.

+ *

Error message.

* @public */ - ThemeId?: string | undefined; + Message?: string | undefined; } /** + *

The structure of a data source.

* @public */ -export interface DeleteThemeAliasRequest { - /** - *

The ID of the Amazon Web Services account that contains the theme alias to delete.

- * @public - */ - AwsAccountId: string | undefined; - +export interface DataSource { /** - *

The ID for the theme that the specified alias is for.

+ *

The Amazon Resource Name (ARN) of the data source.

* @public */ - ThemeId: string | undefined; + Arn?: string | undefined; /** - *

The unique name for the theme alias to delete.

+ *

The ID of the data source. This ID is unique per Amazon Web Services Region for each + * Amazon Web Services account.

* @public */ - AliasName: string | undefined; -} + DataSourceId?: string | undefined; -/** - * @public - */ -export interface DeleteThemeAliasResponse { /** - *

The name for the theme alias.

+ *

A display name for the data source.

* @public */ - AliasName?: string | undefined; + Name?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the theme resource using the deleted alias.

+ *

The type of the data source. This type indicates which database engine the data source + * connects to.

* @public */ - Arn?: string | undefined; + Type?: DataSourceType | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The HTTP status of the request.

* @public */ - RequestId?: string | undefined; + Status?: ResourceStatus | undefined; /** - *

The HTTP status of the request.

+ *

The time that this data source was created.

* @public */ - Status?: number | undefined; + CreatedTime?: Date | undefined; /** - *

An ID for the theme associated with the deletion.

+ *

The last time that this data source was updated.

* @public */ - ThemeId?: string | undefined; -} + LastUpdatedTime?: Date | undefined; -/** - * @public - */ -export interface DeleteTopicRequest { /** - *

The ID of the Amazon Web Services account that contains the topic that you want to - * delete.

+ *

The parameters that Amazon QuickSight uses to connect to your underlying source. This + * is a variant type structure. For this structure to be valid, only one of the attributes + * can be non-null.

* @public */ - AwsAccountId: string | undefined; + DataSourceParameters?: DataSourceParameters | undefined; /** - *

The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

A set of alternate data source parameters that you want to share for the credentials + * stored with this data source. The credentials are applied in tandem with the data source + * parameters when you copy a data source by using a create or update request. The API + * operation compares the DataSourceParameters structure that's in the request + * with the structures in the AlternateDataSourceParameters allow list. If the + * structures are an exact match, the request is allowed to use the credentials from this + * existing data source. If the AlternateDataSourceParameters list is null, + * the Credentials originally used with this DataSourceParameters + * are automatically allowed.

* @public */ - TopicId: string | undefined; -} + AlternateDataSourceParameters?: DataSourceParameters[] | undefined; -/** - * @public - */ -export interface DeleteTopicResponse { /** - *

The Amazon Resource Name (ARN) of the topic.

+ *

The VPC connection information. You need to use this parameter only when you want + * Amazon QuickSight to use a VPC connection when connecting to your underlying source.

* @public */ - Arn?: string | undefined; + VpcConnectionProperties?: VpcConnectionProperties | undefined; /** - *

The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your + * underlying source.

* @public */ - TopicId?: string | undefined; + SslProperties?: SslProperties | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

Error information from the last update or the creation of the data source.

* @public */ - RequestId?: string | undefined; + ErrorInfo?: DataSourceErrorInfo | undefined; /** - *

The HTTP status of the request.

+ *

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

* @public */ - Status?: number | undefined; + SecretArn?: string | undefined; } +/** + * @public + * @enum + */ +export const DataSourceFilterAttribute = { + DATASOURCE_NAME: "DATASOURCE_NAME", + DIRECT_QUICKSIGHT_OWNER: "DIRECT_QUICKSIGHT_OWNER", + DIRECT_QUICKSIGHT_SOLE_OWNER: "DIRECT_QUICKSIGHT_SOLE_OWNER", + DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER", +} as const; + /** * @public */ -export interface DeleteTopicRefreshScheduleRequest { +export type DataSourceFilterAttribute = (typeof DataSourceFilterAttribute)[keyof typeof DataSourceFilterAttribute]; + +/** + *

A filter that you apply when searching for data sources.

+ * @public + */ +export interface DataSourceSearchFilter { /** - *

The Amazon Web Services account ID.

+ *

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

+ *

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose data sources you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

+ *

If you set the value to "StringLike", you need to provide the name of the data sources you are searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASOURCE_NAME.

* @public */ - AwsAccountId: string | undefined; + Operator: FilterOperator | undefined; /** - *

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The name of the value that you want to use as a filter, for example, "Name": + * "DIRECT_QUICKSIGHT_OWNER".

+ *

Valid values are defined as follows:

+ *
    + *
  • + *

    + * DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners or viewers of the data sources are returned. Implicit permissions from folders or groups are not considered.

    + *
  • + *
  • + *

    + * DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners if the data source are returned. Implicit permissions from folders or groups are not considered.

    + *
  • + *
  • + *

    + * DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as the only owner of the data source are returned. Implicit permissions from folders or groups are not considered.

    + *
  • + *
  • + *

    + * DATASOURCE_NAME: Any data sources whose names have a substring match to the provided value are returned.

    + *
  • + *
* @public */ - TopicId: string | undefined; + Name: DataSourceFilterAttribute | undefined; /** - *

The ID of the dataset.

+ *

The value of the named item, for example DIRECT_QUICKSIGHT_OWNER, that you want + * to use as a filter, for example, "Value": + * "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

* @public */ - DatasetId: string | undefined; + Value: string | undefined; } /** + *

A DataSourceSummary object that returns a summary of a data source.

* @public */ -export interface DeleteTopicRefreshScheduleResponse { +export interface DataSourceSummary { /** - *

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The arn of the datasource.

* @public */ - TopicId?: string | undefined; + Arn?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the topic.

+ *

The unique ID of the data source.

* @public */ - TopicArn?: string | undefined; + DataSourceId?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the dataset.

+ *

The name of the data source.

* @public */ - DatasetArn?: string | undefined; + Name?: string | undefined; /** - *

The HTTP status of the request.

+ *

The type of the data source.

* @public */ - Status?: number | undefined; + Type?: DataSourceType | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.

* @public */ - RequestId?: string | undefined; -} + CreatedTime?: Date | undefined; -/** - * @public - */ -export interface DeleteUserRequest { /** - *

The name of the user that you want to delete.

+ *

The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.

* @public */ - UserName: string | undefined; + LastUpdatedTime?: Date | undefined; +} +/** + * @public + */ +export interface DeleteAccountCustomizationRequest { /** - *

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the - * Amazon Web Services account that contains your Amazon QuickSight account.

+ *

The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in + * this Amazon Web Services Region.

* @public */ AwsAccountId: string | undefined; /** - *

The namespace. Currently, you should set this to default.

+ *

The Amazon QuickSight namespace that you're deleting the customizations from.

* @public */ - Namespace: string | undefined; + Namespace?: string | undefined; } /** * @public */ -export interface DeleteUserResponse { +export interface DeleteAccountCustomizationResponse { /** *

The Amazon Web Services request ID for this operation.

* @public @@ -5742,34 +5492,20 @@ export interface DeleteUserResponse { } /** - *

* @public */ -export interface DeleteUserByPrincipalIdRequest { - /** - *

The principal ID of the user.

- * @public - */ - PrincipalId: string | undefined; - +export interface DeleteAccountSubscriptionRequest { /** - *

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the - * Amazon Web Services account that contains your Amazon QuickSight account.

+ *

The Amazon Web Services account ID of the account that you want to delete.

* @public */ AwsAccountId: string | undefined; - - /** - *

The namespace. Currently, you should set this to default.

- * @public - */ - Namespace: string | undefined; } /** * @public */ -export interface DeleteUserByPrincipalIdResponse { +export interface DeleteAccountSubscriptionResponse { /** *

The Amazon Web Services request ID for this operation.

* @public @@ -5786,161 +5522,247 @@ export interface DeleteUserByPrincipalIdResponse { /** * @public */ -export interface DeleteVPCConnectionRequest { +export interface DeleteAnalysisRequest { /** - *

The Amazon Web Services account ID of the account where you want to delete a VPC - * connection.

+ *

The ID of the Amazon Web Services account where you want to delete an analysis.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an - * Amazon Web Services account.

+ *

The ID of the analysis that you're deleting.

* @public */ - VPCConnectionId: string | undefined; + AnalysisId: string | undefined; + + /** + *

A value that specifies the number of days that Amazon QuickSight waits before it deletes the + * analysis. You can't use this parameter with the ForceDeleteWithoutRecovery + * option in the same API call. The default value is 30.

+ * @public + */ + RecoveryWindowInDays?: number | undefined; + + /** + *

This option defaults to the value NoForceDeleteWithoutRecovery. To + * immediately delete the analysis, add the ForceDeleteWithoutRecovery option. + * You can't restore an analysis after it's deleted.

+ * @public + */ + ForceDeleteWithoutRecovery?: boolean | undefined; } /** * @public */ -export interface DeleteVPCConnectionResponse { +export interface DeleteAnalysisResponse { /** - *

The Amazon Resource Name (ARN) of the deleted VPC connection.

+ *

The HTTP status of the request.

* @public */ - Arn?: string | undefined; + Status?: number | undefined; /** - *

The ID of the VPC connection that - * you're creating. This ID is a unique identifier for each Amazon Web Services Region in an - * Amazon Web Services account.

+ *

The Amazon Resource Name (ARN) of the deleted analysis.

* @public */ - VPCConnectionId?: string | undefined; + Arn?: string | undefined; /** - *

The deletion status of the VPC connection.

+ *

The ID of the deleted analysis.

* @public */ - DeletionStatus?: VPCConnectionResourceStatus | undefined; + AnalysisId?: string | undefined; /** - *

The availability status of the VPC connection.

+ *

The date and time that the analysis is scheduled to be deleted.

* @public */ - AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; + DeletionTime?: Date | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; +} +/** + * @public + */ +export interface DeleteBrandRequest { /** - *

The HTTP status of the request.

+ *

The ID of the Amazon Web Services account that owns the brand.

* @public */ - Status?: number | undefined; + AwsAccountId: string | undefined; + + /** + *

The ID of the Amazon QuickSight brand.

+ * @public + */ + BrandId: string | undefined; } /** * @public */ -export interface DescribeAccountCustomizationRequest { +export interface DeleteBrandResponse { /** - *

The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations - * for.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AwsAccountId: string | undefined; + RequestId?: string | undefined; +} +/** + * @public + */ +export interface DeleteBrandAssignmentRequest { /** - *

The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations - * for.

+ *

The ID of the Amazon Web Services account that owns the brand assignment.

* @public */ - Namespace?: string | undefined; + AwsAccountId: string | undefined; +} +/** + * @public + */ +export interface DeleteBrandAssignmentResponse { /** - *

The Resolved flag works with the other parameters to determine which view - * of Amazon QuickSight customizations is returned. You can add this flag to your command to use - * the same view that Amazon QuickSight uses to identify which customizations to apply to the - * console. Omit this flag, or set it to no-resolved, to reveal customizations - * that are configured at different levels.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Resolved?: boolean | undefined; + RequestId?: string | undefined; } /** * @public */ -export interface DescribeAccountCustomizationResponse { +export interface DeleteCustomPermissionsRequest { /** - *

The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.

+ *

The ID of the Amazon Web Services account that contains the custom permissions profile that you want to delete.

* @public */ - Arn?: string | undefined; + AwsAccountId: string | undefined; /** - *

The ID for the Amazon Web Services account that you're describing.

+ *

The name of the custom permissions profile that you want to delete.

* @public */ - AwsAccountId?: string | undefined; + CustomPermissionsName: string | undefined; +} +/** + * @public + */ +export interface DeleteCustomPermissionsResponse { /** - *

The Amazon QuickSight namespace that you're describing.

+ *

The HTTP status of the request.

* @public */ - Namespace?: string | undefined; + Status?: number | undefined; /** - *

The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.

+ *

The Amazon Resource Name (ARN) of the custom permissions profile.

* @public */ - AccountCustomization?: AccountCustomization | undefined; + Arn?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; +} + +/** + * @public + */ +export interface DeleteDashboardRequest { + /** + *

The ID of the Amazon Web Services account that contains the dashboard that you're + * deleting.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID for the dashboard.

+ * @public + */ + DashboardId: string | undefined; + + /** + *

The version number of the dashboard. If the version number property is provided, only + * the specified version of the dashboard is deleted.

+ * @public + */ + VersionNumber?: number | undefined; +} +/** + * @public + */ +export interface DeleteDashboardResponse { /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; + + /** + *

The Secure Socket Layer (SSL) properties that apply for the resource.

+ * @public + */ + Arn?: string | undefined; + + /** + *

The ID of the dashboard.

+ * @public + */ + DashboardId?: string | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; } /** * @public */ -export interface DescribeAccountSettingsRequest { +export interface DeleteDataSetRequest { /** - *

The ID for the Amazon Web Services account that contains the settings that you want to list.

+ *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; + + /** + *

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ * @public + */ + DataSetId: string | undefined; } /** * @public */ -export interface DescribeAccountSettingsResponse { +export interface DeleteDataSetResponse { /** - *

The Amazon QuickSight settings for this Amazon Web Services account. This information - * includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or - * Enterprise) and the notification email for the Amazon QuickSight subscription.

- *

In the QuickSight console, the Amazon QuickSight subscription is sometimes referred to - * as a QuickSight "account" even though it's technically not an account by - * itself. Instead, it's a subscription to the Amazon QuickSight service for your - * Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.

+ *

The Amazon Resource Name (ARN) of the dataset.

* @public */ - AccountSettings?: AccountSettings | undefined; + Arn?: string | undefined; + + /** + *

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ * @public + */ + DataSetId?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -5958,371 +5780,296 @@ export interface DescribeAccountSettingsResponse { /** * @public */ -export interface DescribeAccountSubscriptionRequest { +export interface DeleteDataSetRefreshPropertiesRequest { /** - *

The Amazon Web Services account ID associated with your Amazon QuickSight account.

+ *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; + + /** + *

The ID of the dataset.

+ * @public + */ + DataSetId: string | undefined; } /** * @public */ -export interface DescribeAccountSubscriptionResponse { +export interface DeleteDataSetRefreshPropertiesResponse { /** - *

A structure that contains the following elements:

- *
    - *
  • - *

    Your Amazon QuickSight account name.

    - *
  • - *
  • - *

    The edition of Amazon QuickSight that your account is using.

    - *
  • - *
  • - *

    The notification email address that is associated with the Amazon QuickSight - * account. - *

    - *
  • - *
  • - *

    The authentication type of the Amazon QuickSight account.

    - *
  • - *
  • - *

    The status of the Amazon QuickSight account's subscription.

    - *
  • - *
+ *

The Amazon Web Services request ID for this operation.

* @public */ - AccountInfo?: AccountInfo | undefined; + RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; - - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; } /** * @public */ -export interface DescribeAnalysisRequest { +export interface DeleteDataSourceRequest { /** - *

The ID of the Amazon Web Services account that contains the analysis. You must be using the - * Amazon Web Services account that the analysis is in.

+ *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the analysis that you're describing. The ID is part of the URL of the - * analysis.

+ *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - AnalysisId: string | undefined; + DataSourceId: string | undefined; } /** * @public */ -export interface DescribeAnalysisResponse { +export interface DeleteDataSourceResponse { /** - *

A metadata structure that contains summary information for the analysis that you're - * describing.

+ *

The Amazon Resource Name (ARN) of the data source that you deleted.

* @public */ - Analysis?: Analysis | undefined; + Arn?: string | undefined; /** - *

The HTTP status of the request.

+ *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - Status?: number | undefined; + DataSourceId?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; } /** * @public */ -export interface DescribeAnalysisDefinitionRequest { +export interface DeleteFolderRequest { /** - *

The ID of the Amazon Web Services account that contains the analysis. You must be using the - * Amazon Web Services account that the analysis is in.

+ *

The ID for the Amazon Web Services account that contains the folder.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the analysis that you're describing. The ID is part of the URL of the - * analysis.

+ *

The ID of the folder.

* @public */ - AnalysisId: string | undefined; + FolderId: string | undefined; } /** * @public */ -export interface DescribeAnalysisDefinitionResponse { +export interface DeleteFolderResponse { /** - *

The ID of the analysis described.

+ *

The HTTP status of the request.

* @public */ - AnalysisId?: string | undefined; + Status?: number | undefined; /** - *

The descriptive name of the analysis.

+ *

The Amazon Resource Name of the deleted folder.

* @public */ - Name?: string | undefined; + Arn?: string | undefined; /** - *

Errors associated with the analysis.

+ *

The ID of the folder.

* @public */ - Errors?: AnalysisError[] | undefined; + FolderId?: string | undefined; /** - *

Status associated with the analysis.

- *
    - *
  • - *

    - * CREATION_IN_PROGRESS - *

    - *
  • - *
  • - *

    - * CREATION_SUCCESSFUL - *

    - *
  • - *
  • - *

    - * CREATION_FAILED - *

    - *
  • - *
  • - *

    - * UPDATE_IN_PROGRESS - *

    - *
  • - *
  • - *

    - * UPDATE_SUCCESSFUL - *

    - *
  • - *
  • - *

    - * UPDATE_FAILED - *

    - *
  • - *
  • - *

    - * DELETED - *

    - *
  • - *
+ *

The Amazon Web Services request ID for this operation.

* @public */ - ResourceStatus?: ResourceStatus | undefined; + RequestId?: string | undefined; +} +/** + * @public + */ +export interface DeleteFolderMembershipRequest { /** - *

The ARN of the theme of the analysis.

+ *

The ID for the Amazon Web Services account that contains the folder.

* @public */ - ThemeArn?: string | undefined; + AwsAccountId: string | undefined; /** - *

The definition of an analysis.

- *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

+ *

The Folder ID.

* @public */ - Definition?: AnalysisDefinition | undefined; + FolderId: string | undefined; /** - *

The HTTP status of the request.

+ *

The ID of the asset that you want to delete.

* @public */ - Status?: number | undefined; + MemberId: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The member type of the asset that you want to delete from a folder.

* @public */ - RequestId?: string | undefined; + MemberType: MemberType | undefined; } /** * @public */ -export interface DescribeAnalysisPermissionsRequest { +export interface DeleteFolderMembershipResponse { /** - *

The ID of the Amazon Web Services account that contains the analysis whose permissions you're - * describing. You must be using the Amazon Web Services account that the analysis is in.

+ *

The HTTP status of the request.

* @public */ - AwsAccountId: string | undefined; + Status?: number | undefined; /** - *

The ID of the analysis whose permissions you're describing. The ID is part of the - * analysis URL.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AnalysisId: string | undefined; + RequestId?: string | undefined; } /** * @public */ -export interface DescribeAnalysisPermissionsResponse { - /** - *

The ID of the analysis whose permissions you're describing.

- * @public - */ - AnalysisId?: string | undefined; - - /** - *

The Amazon Resource Name (ARN) of the analysis whose permissions you're - * describing.

- * @public - */ - AnalysisArn?: string | undefined; - +export interface DeleteGroupRequest { /** - *

A structure that describes the principals and the resource-level permissions on an - * analysis.

+ *

The name of the group that you want to delete.

* @public */ - Permissions?: ResourcePermission[] | undefined; + GroupName: string | undefined; /** - *

The HTTP status of the request.

+ *

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the + * Amazon Web Services account that contains your Amazon QuickSight account.

* @public */ - Status?: number | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The namespace of the group that you want to delete.

* @public */ - RequestId?: string | undefined; + Namespace: string | undefined; } /** * @public */ -export interface DescribeAssetBundleExportJobRequest { +export interface DeleteGroupResponse { /** - *

The ID of the Amazon Web Services account the export job is executed in.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AwsAccountId: string | undefined; + RequestId?: string | undefined; /** - *

The ID of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

+ *

The HTTP status of the request.

* @public */ - AssetBundleExportJobId: string | undefined; + Status?: number | undefined; } -/** - * @public - * @enum - */ -export const IncludeFolderMembers = { - NONE: "NONE", - ONE_LEVEL: "ONE_LEVEL", - RECURSE: "RECURSE", -} as const; - -/** - * @public - */ -export type IncludeFolderMembers = (typeof IncludeFolderMembers)[keyof typeof IncludeFolderMembers]; - /** * @public */ -export interface DescribeAssetBundleExportJobResponse { - /** - *

Indicates the status of a job through its queuing and execution.

- *

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

- * @public - */ - JobStatus?: AssetBundleExportJobStatus | undefined; - +export interface DeleteGroupMembershipRequest { /** - *

The URL to download the exported asset bundle data from.

- *

This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed.

- *

The downloaded asset bundle is a zip file named assetbundle-\{jobId\}.qs. The file has a .qs extension.

- *

This URL can't be used in a StartAssetBundleImportJob API call and should only be used for download purposes.

+ *

The name of the user that you want to delete from the group membership.

* @public */ - DownloadUrl?: string | undefined; + MemberName: string | undefined; /** - *

An array of error records that describes any failures that occurred during the export job processing.

- *

Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

+ *

The name of the group that you want to delete the user from.

* @public */ - Errors?: AssetBundleExportJobError[] | undefined; + GroupName: string | undefined; /** - *

The Amazon Resource Name (ARN) for the export job.

+ *

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the + * Amazon Web Services account that contains your Amazon QuickSight account.

* @public */ - Arn?: string | undefined; + AwsAccountId: string | undefined; /** - *

The time that the export job was created.

+ *

The namespace of the group that you want to remove a user from.

* @public */ - CreatedTime?: Date | undefined; + Namespace: string | undefined; +} +/** + * @public + */ +export interface DeleteGroupMembershipResponse { /** - *

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AssetBundleExportJobId?: string | undefined; + RequestId?: string | undefined; /** - *

The ID of the Amazon Web Services account that the export job was executed in.

+ *

The HTTP status of the request.

* @public */ - AwsAccountId?: string | undefined; + Status?: number | undefined; +} +/** + * @public + */ +export interface DeleteIAMPolicyAssignmentRequest { /** - *

A list of resource ARNs that exported with the job.

+ *

The Amazon Web Services account ID where you want to delete the IAM + * policy assignment.

* @public */ - ResourceArns?: string[] | undefined; + AwsAccountId: string | undefined; /** - *

The include dependencies flag.

+ *

The name of the assignment.

* @public */ - IncludeAllDependencies?: boolean | undefined; + AssignmentName: string | undefined; /** - *

The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.

+ *

The namespace that contains the assignment.

* @public */ - ExportFormat?: AssetBundleExportFormat | undefined; + Namespace: string | undefined; +} +/** + * @public + */ +export interface DeleteIAMPolicyAssignmentResponse { /** - *

The CloudFormation override property configuration for the export job.

+ *

The name of the assignment.

* @public */ - CloudFormationOverridePropertyConfiguration?: AssetBundleCloudFormationOverridePropertyConfiguration | undefined; + AssignmentName?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -6331,155 +6078,160 @@ export interface DescribeAssetBundleExportJobResponse { RequestId?: string | undefined; /** - *

The HTTP status of the response.

+ *

The HTTP status of the request.

* @public */ Status?: number | undefined; +} +/** + * @public + */ +export interface DeleteIdentityPropagationConfigRequest { /** - *

The include permissions flag.

+ *

The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from.

* @public */ - IncludePermissions?: boolean | undefined; + AwsAccountId: string | undefined; /** - *

The include tags flag.

+ *

The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.

* @public */ - IncludeTags?: boolean | undefined; + Service: ServiceType | undefined; +} +/** + * @public + */ +export interface DeleteIdentityPropagationConfigResponse { /** - *

The validation strategy that is used to export the analysis or dashboard.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - ValidationStrategy?: AssetBundleExportJobValidationStrategy | undefined; + RequestId?: string | undefined; /** - *

An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

- *

This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

+ *

The HTTP status of the request.

* @public */ - Warnings?: AssetBundleExportJobWarning[] | undefined; + Status?: number | undefined; +} +/** + * @public + */ +export interface DeleteNamespaceRequest { /** - *

The include folder memberships flag.

+ *

The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.

* @public */ - IncludeFolderMemberships?: boolean | undefined; + AwsAccountId: string | undefined; /** - *

A setting that determines whether folder members are included.

+ *

The namespace that you want to delete.

* @public */ - IncludeFolderMembers?: IncludeFolderMembers | undefined; + Namespace: string | undefined; } /** * @public */ -export interface DescribeAssetBundleImportJobRequest { +export interface DeleteNamespaceResponse { /** - *

The ID of the Amazon Web Services account the import job was executed in.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AwsAccountId: string | undefined; + RequestId?: string | undefined; /** - *

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

+ *

The HTTP status of the request.

* @public */ - AssetBundleImportJobId: string | undefined; + Status?: number | undefined; } /** * @public */ -export interface DescribeAssetBundleImportJobResponse { +export interface DeleteRefreshScheduleRequest { /** - *

Indicates the status of a job through its queuing and execution.

- *

Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values:

- *
    - *
  • - *

    - * SUCCESSFUL - *

    - *
  • - *
  • - *

    - * FAILED - *

    - *
  • - *
  • - *

    - * FAILED_ROLLBACK_COMPLETED - *

    - *
  • - *
  • - *

    - * FAILED_ROLLBACK_ERROR - *

    - *
  • - *
+ *

The ID of the dataset.

* @public */ - JobStatus?: AssetBundleImportJobStatus | undefined; + DataSetId: string | undefined; /** - *

An array of error records that describes any failures that occurred during the export job processing.

- *

Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

+ *

The Amazon Web Services account ID.

* @public */ - Errors?: AssetBundleImportJobError[] | undefined; + AwsAccountId: string | undefined; /** - *

An array of error records that describes any failures that occurred while an import job was attempting a rollback.

- *

Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

+ *

The ID of the refresh schedule.

* @public */ - RollbackErrors?: AssetBundleImportJobError[] | undefined; + ScheduleId: string | undefined; +} +/** + * @public + */ +export interface DeleteRefreshScheduleResponse { /** - *

The Amazon Resource Name (ARN) for the import job.

+ *

The HTTP status of the request.

* @public */ - Arn?: string | undefined; + Status?: number | undefined; /** - *

The time that the import job was created.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - CreatedTime?: Date | undefined; + RequestId?: string | undefined; /** - *

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

+ *

The ID of the refresh schedule.

* @public */ - AssetBundleImportJobId?: string | undefined; + ScheduleId?: string | undefined; /** - *

The ID of the Amazon Web Services account the import job was executed in.

+ *

The Amazon Resource Name (ARN) for the refresh schedule.

* @public */ - AwsAccountId?: string | undefined; + Arn?: string | undefined; +} +/** + * @public + */ +export interface DeleteRoleCustomPermissionRequest { /** - *

The source of the asset bundle zip file that contains the data that is imported by the job.

+ *

The role that you want to remove permissions from.

* @public */ - AssetBundleImportSource?: AssetBundleImportSourceDescription | undefined; + Role: Role | undefined; /** - *

Optional overrides that are applied to the resource configuration before import.

+ *

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the + * Amazon Web Services account that contains your Amazon QuickSight account.

* @public */ - OverrideParameters?: AssetBundleImportJobOverrideParameters | undefined; + AwsAccountId: string | undefined; /** - *

The failure action for the import job.

+ *

The namespace that includes the role.

* @public */ - FailureAction?: AssetBundleImportFailureAction | undefined; + Namespace: string | undefined; +} +/** + * @public + */ +export interface DeleteRoleCustomPermissionResponse { /** *

The Amazon Web Services request ID for this operation.

* @public @@ -6487,280 +6239,214 @@ export interface DescribeAssetBundleImportJobResponse { RequestId?: string | undefined; /** - *

The HTTP status of the response.

+ *

The HTTP status of the request.

* @public */ Status?: number | undefined; +} +/** + * @public + */ +export interface DeleteRoleMembershipRequest { /** - *

Optional permission overrides that are applied to the resource configuration before import.

+ *

The name of the group.

* @public */ - OverridePermissions?: AssetBundleImportJobOverridePermissions | undefined; + MemberName: string | undefined; /** - *

Optional tag overrides that are applied to the resource configuration before import.

+ *

The role that you want to remove permissions from.

* @public */ - OverrideTags?: AssetBundleImportJobOverrideTags | undefined; + Role: Role | undefined; /** - *

An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.

+ *

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

* @public */ - OverrideValidationStrategy?: AssetBundleImportJobOverrideValidationStrategy | undefined; + AwsAccountId: string | undefined; /** - *

An array of warning records that describe all permitted errors that are encountered during the import job.

+ *

The namespace that contains the role.

* @public */ - Warnings?: AssetBundleImportJobWarning[] | undefined; + Namespace: string | undefined; } /** * @public */ -export interface DescribeDashboardRequest { - /** - *

The ID of the Amazon Web Services account that contains the dashboard that you're - * describing.

- * @public - */ - AwsAccountId: string | undefined; - - /** - *

The ID for the dashboard.

- * @public - */ - DashboardId: string | undefined; - +export interface DeleteRoleMembershipResponse { /** - *

The version number for the dashboard. If a version number isn't passed, the - * latest published dashboard version is described.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - VersionNumber?: number | undefined; + RequestId?: string | undefined; /** - *

The alias name.

+ *

The HTTP status of the request.

* @public */ - AliasName?: string | undefined; + Status?: number | undefined; } /** * @public */ -export interface DescribeDashboardResponse { +export interface DeleteTemplateRequest { /** - *

Information about the dashboard.

+ *

The ID of the Amazon Web Services account that contains the template that you're deleting.

* @public */ - Dashboard?: Dashboard | undefined; + AwsAccountId: string | undefined; /** - *

The HTTP status of this request.

+ *

An ID for the template you want to delete.

* @public */ - Status?: number | undefined; + TemplateId: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

Specifies the version of the template that you want to delete. + * If you don't provide a version number, DeleteTemplate deletes all versions of the template. + *

* @public */ - RequestId?: string | undefined; + VersionNumber?: number | undefined; } /** * @public */ -export interface DescribeDashboardDefinitionRequest { +export interface DeleteTemplateResponse { /** - *

The ID of the Amazon Web Services account that contains the dashboard that you're - * describing.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AwsAccountId: string | undefined; + RequestId?: string | undefined; /** - *

The ID for the dashboard.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ - DashboardId: string | undefined; + Arn?: string | undefined; /** - *

The version number for the dashboard. If a version number isn't passed, the - * latest published dashboard version is described.

+ *

An ID for the template.

* @public */ - VersionNumber?: number | undefined; + TemplateId?: string | undefined; /** - *

The alias name.

+ *

The HTTP status of the request.

* @public */ - AliasName?: string | undefined; + Status?: number | undefined; } /** * @public */ -export interface DescribeDashboardDefinitionResponse { +export interface DeleteTemplateAliasRequest { /** - *

The ID of the dashboard described.

+ *

The ID of the Amazon Web Services account that contains the item to delete.

* @public */ - DashboardId?: string | undefined; + AwsAccountId: string | undefined; /** - *

Errors associated with this dashboard version.

+ *

The ID for the template that the specified alias is for.

* @public */ - Errors?: DashboardError[] | undefined; + TemplateId: string | undefined; /** - *

The display name of the dashboard.

+ *

The name for the template alias. To delete a specific alias, you delete the version that the + * alias points to. You can specify the alias name, or specify the latest version of the + * template by providing the keyword $LATEST in the AliasName + * parameter.

* @public */ - Name?: string | undefined; + AliasName: string | undefined; +} +/** + * @public + */ +export interface DeleteTemplateAliasResponse { /** - *

Status associated with the dashboard version.

- *
    - *
  • - *

    - * CREATION_IN_PROGRESS - *

    - *
  • - *
  • - *

    - * CREATION_SUCCESSFUL - *

    - *
  • - *
  • - *

    - * CREATION_FAILED - *

    - *
  • - *
  • - *

    - * UPDATE_IN_PROGRESS - *

    - *
  • - *
  • - *

    - * UPDATE_SUCCESSFUL - *

    - *
  • - *
  • - *

    - * UPDATE_FAILED - *

    - *
  • - *
  • - *

    - * DELETED - *

    - *
  • - *
+ *

The HTTP status of the request.

* @public */ - ResourceStatus?: ResourceStatus | undefined; + Status?: number | undefined; /** - *

The ARN of the theme of the dashboard.

+ *

An ID for the template associated with the deletion.

* @public */ - ThemeArn?: string | undefined; + TemplateId?: string | undefined; /** - *

The definition of a dashboard.

- *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

+ *

The name for the template alias.

* @public */ - Definition?: DashboardVersionDefinition | undefined; + AliasName?: string | undefined; /** - *

The HTTP status of the request.

+ *

The Amazon Resource Name (ARN) of the template you want to delete.

* @public */ - Status?: number | undefined; + Arn?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; +} +/** + * @public + */ +export interface DeleteThemeRequest { /** - *

Options for publishing the dashboard:

- *
    - *
  • - *

    - * AvailabilityStatus for AdHocFilteringOption - This - * status can be either ENABLED or DISABLED. When this is - * set to DISABLED, Amazon QuickSight disables the left filter pane on the - * published dashboard, which can be used for ad hoc (one-time) filtering. This - * option is ENABLED by default.

    - *
  • - *
  • - *

    - * AvailabilityStatus for ExportToCSVOption - This - * status can be either ENABLED or DISABLED. The visual - * option to export data to .CSV format isn't enabled when this is set to - * DISABLED. This option is ENABLED by default.

    - *
  • - *
  • - *

    - * VisibilityState for SheetControlsOption - This - * visibility state can be either COLLAPSED or EXPANDED. - * This option is COLLAPSED by default.

    - *
  • - *
+ *

The ID of the Amazon Web Services account that contains the theme that you're deleting.

* @public */ - DashboardPublishOptions?: DashboardPublishOptions | undefined; -} + AwsAccountId: string | undefined; -/** - * @public - */ -export interface DescribeDashboardPermissionsRequest { /** - *

The ID of the Amazon Web Services account that contains the dashboard that you're describing - * permissions for.

+ *

An ID for the theme that you want to delete.

* @public */ - AwsAccountId: string | undefined; + ThemeId: string | undefined; /** - *

The ID for the dashboard, also added to the IAM policy.

+ *

The version of the theme that you want to delete.

+ *

+ * Note: If you don't provide a version number, you're + * using this call to DeleteTheme to delete all versions of the theme.

* @public */ - DashboardId: string | undefined; + VersionNumber?: number | undefined; } /** * @public */ -export interface DescribeDashboardPermissionsResponse { - /** - *

The ID for the dashboard.

- * @public - */ - DashboardId?: string | undefined; - +export interface DeleteThemeResponse { /** - *

The Amazon Resource Name (ARN) of the dashboard.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ - DashboardArn?: string | undefined; + Arn?: string | undefined; /** - *

A structure that contains the permissions for the dashboard.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Permissions?: ResourcePermission[] | undefined; + RequestId?: string | undefined; /** *

The HTTP status of the request.

@@ -6769,327 +6455,285 @@ export interface DescribeDashboardPermissionsResponse { Status?: number | undefined; /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; - - /** - *

A structure that contains the configuration of a shareable link that grants access to - * the dashboard. Your users can use the link to view and interact with the dashboard, if - * the dashboard has been shared with them. For more information about sharing dashboards, - * see Sharing Dashboards.

+ *

An ID for the theme.

* @public */ - LinkSharingConfiguration?: LinkSharingConfiguration | undefined; + ThemeId?: string | undefined; } /** * @public */ -export interface DescribeDashboardSnapshotJobRequest { +export interface DeleteThemeAliasRequest { /** - *

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

+ *

The ID of the Amazon Web Services account that contains the theme alias to delete.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the dashboard that you have started a snapshot job for.

+ *

The ID for the theme that the specified alias is for.

* @public */ - DashboardId: string | undefined; + ThemeId: string | undefined; /** - *

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

+ *

The unique name for the theme alias to delete.

* @public */ - SnapshotJobId: string | undefined; + AliasName: string | undefined; } /** - * @public - * @enum - */ -export const SnapshotJobStatus = { - COMPLETED: "COMPLETED", - FAILED: "FAILED", - QUEUED: "QUEUED", - RUNNING: "RUNNING", -} as const; - -/** - * @public - */ -export type SnapshotJobStatus = (typeof SnapshotJobStatus)[keyof typeof SnapshotJobStatus]; - -/** - *

A structure that contains information on the Amazon S3 destinations of the generated snapshot.

* @public */ -export interface SnapshotDestinationConfiguration { +export interface DeleteThemeAliasResponse { /** - *

- * A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 S3DestinationConfiguration. - *

+ *

The name for the theme alias.

* @public */ - S3Destinations?: SnapshotS3DestinationConfiguration[] | undefined; -} + AliasName?: string | undefined; -/** - *

A structure that contains the information on the snapshot files.

- * @public - */ -export interface SnapshotFileGroup { /** - *

A list of SnapshotFile objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time.

+ *

The Amazon Resource Name (ARN) of the theme resource using the deleted alias.

* @public */ - Files?: SnapshotFile[] | undefined; -} + Arn?: string | undefined; -/** - *

Describes the configuration of the dashboard snapshot.

- * @public - */ -export interface SnapshotConfiguration { /** - *

A list of SnapshotJobResultFileGroup objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup configurations.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - FileGroups: SnapshotFileGroup[] | undefined; + RequestId?: string | undefined; /** - *

A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.

+ *

The HTTP status of the request.

* @public */ - DestinationConfiguration?: SnapshotDestinationConfiguration | undefined; + Status?: number | undefined; /** - *

A list of Amazon QuickSight parameters and the list's override values.

+ *

An ID for the theme associated with the deletion.

* @public */ - Parameters?: _Parameters | undefined; + ThemeId?: string | undefined; } /** - *

Use this structure to redact sensitive information that you provide about an anonymous user from the snapshot.

* @public */ -export interface SnapshotAnonymousUserRedacted { +export interface DeleteTopicRequest { /** - *

The tag keys for the RowLevelPermissionTags.

+ *

The ID of the Amazon Web Services account that contains the topic that you want to + * delete.

* @public */ - RowLevelPermissionTagKeys?: string[] | undefined; -} + AwsAccountId: string | undefined; -/** - *

A structure that contains information about the users that the dashboard snapshot is generated for. Sensitive user information is excluded. - *

- * @public - */ -export interface SnapshotUserConfigurationRedacted { /** - *

- * An array of records that describe anonymous users that the dashboard snapshot is generated for. Sensitive user information is excluded. - *

+ *

The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - AnonymousUsers?: SnapshotAnonymousUserRedacted[] | undefined; + TopicId: string | undefined; } /** * @public */ -export interface DescribeDashboardSnapshotJobResponse { +export interface DeleteTopicResponse { /** - *

- * The ID of the Amazon Web Services account that the dashboard snapshot job is executed in. - *

+ *

The Amazon Resource Name (ARN) of the topic.

* @public */ - AwsAccountId?: string | undefined; + Arn?: string | undefined; /** - *

The ID of the dashboard that you have started a snapshot job for.

+ *

The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - DashboardId?: string | undefined; + TopicId?: string | undefined; /** - *

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - SnapshotJobId?: string | undefined; + RequestId?: string | undefined; /** - *

The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

+ *

The HTTP status of the request.

* @public */ - UserConfiguration?: SnapshotUserConfigurationRedacted | undefined; + Status?: number | undefined; +} +/** + * @public + */ +export interface DeleteTopicRefreshScheduleRequest { /** - *

The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

+ *

The Amazon Web Services account ID.

* @public */ - SnapshotConfiguration?: SnapshotConfiguration | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

+ *

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - Arn?: string | undefined; + TopicId: string | undefined; /** - *

Indicates the status of a job. The status updates as the job executes. This shows one of the following values.

- *
    - *
  • - *

    - * COMPLETED - The job was completed successfully.

    - *
  • - *
  • - *

    - * FAILED - The job failed to execute.

    - *
  • - *
  • - *

    - * QUEUED - The job is queued and hasn't started yet.

    - *
  • - *
  • - *

    - * RUNNING - The job is still running.

    - *
  • - *
+ *

The ID of the dataset.

* @public */ - JobStatus?: SnapshotJobStatus | undefined; + DatasetId: string | undefined; +} +/** + * @public + */ +export interface DeleteTopicRefreshScheduleResponse { /** - *

- * The time that the snapshot job was created. - *

+ *

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - CreatedTime?: Date | undefined; + TopicId?: string | undefined; /** - *

- * The time that the snapshot job status was last updated. - *

+ *

The Amazon Resource Name (ARN) of the topic.

* @public */ - LastUpdatedTime?: Date | undefined; + TopicArn?: string | undefined; /** - *

- * The Amazon Web Services request ID for this operation. - *

+ *

The Amazon Resource Name (ARN) of the dataset.

* @public */ - RequestId?: string | undefined; + DatasetArn?: string | undefined; /** - *

The HTTP status of the request

+ *

The HTTP status of the request.

* @public */ Status?: number | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; } /** * @public */ -export interface DescribeDashboardSnapshotJobResultRequest { +export interface DeleteUserRequest { /** - *

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

+ *

The name of the user that you want to delete.

* @public */ - AwsAccountId: string | undefined; + UserName: string | undefined; /** - *

The ID of the dashboard that you have started a snapshot job for.

+ *

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the + * Amazon Web Services account that contains your Amazon QuickSight account.

* @public */ - DashboardId: string | undefined; + AwsAccountId: string | undefined; /** - *

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

+ *

The namespace. Currently, you should set this to default.

* @public */ - SnapshotJobId: string | undefined; + Namespace: string | undefined; } /** - *

An object that contains information on the error that caused the snapshot job to fail.

* @public */ -export interface SnapshotJobErrorInfo { +export interface DeleteUserResponse { /** - *

The error message.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - ErrorMessage?: string | undefined; + RequestId?: string | undefined; /** - *

The error type.

+ *

The HTTP status of the request.

* @public */ - ErrorType?: string | undefined; + Status?: number | undefined; } /** - *

An object that provides information on the result of a snapshot job. This object provides information about the job, the job status, and the location of the generated file.

+ *

* @public */ -export interface SnapshotJobResult { +export interface DeleteUserByPrincipalIdRequest { /** - *

A list of AnonymousUserSnapshotJobResult objects that contain information on anonymous users and their user configurations. This data provided by you when you make a StartDashboardSnapshotJob API call.

+ *

The principal ID of the user.

* @public */ - AnonymousUsers?: AnonymousUserSnapshotJobResult[] | undefined; -} + PrincipalId: string | undefined; -/** - * @public - */ -export interface DescribeDashboardSnapshotJobResultResponse { /** - *

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

+ *

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the + * Amazon Web Services account that contains your Amazon QuickSight account.

* @public */ - Arn?: string | undefined; + AwsAccountId: string | undefined; /** - *

Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

+ *

The namespace. Currently, you should set this to default.

* @public */ - JobStatus?: SnapshotJobStatus | undefined; + Namespace: string | undefined; +} + +/** + * @public + */ +export interface DeleteUserByPrincipalIdResponse { + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; /** - *

The time that a snapshot job was created.

+ *

The HTTP status of the request.

* @public */ - CreatedTime?: Date | undefined; + Status?: number | undefined; +} +/** + * @public + */ +export interface DeleteUserCustomPermissionRequest { /** - *

The time that a snapshot job status was last updated.

+ *

The username of the user that you want to remove custom permissions from.

* @public */ - LastUpdatedTime?: Date | undefined; + UserName: string | undefined; /** - *

The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.

+ *

The ID of the Amazon Web Services account that contains the custom permission configuration that you want to delete.

* @public */ - Result?: SnapshotJobResult | undefined; + AwsAccountId: string | undefined; /** - *

Displays information for the error that caused a job to fail.

+ *

The namespace that the user belongs to.

* @public */ - ErrorInfo?: SnapshotJobErrorInfo | undefined; + Namespace: string | undefined; +} +/** + * @public + */ +export interface DeleteUserCustomPermissionResponse { /** *

The Amazon Web Services request ID for this operation.

* @public @@ -7097,7 +6741,7 @@ export interface DescribeDashboardSnapshotJobResultResponse { RequestId?: string | undefined; /** - *

The HTTP status of the request

+ *

The HTTP status of the request.

* @public */ Status?: number | undefined; @@ -7106,29 +6750,51 @@ export interface DescribeDashboardSnapshotJobResultResponse { /** * @public */ -export interface DescribeDataSetRequest { +export interface DeleteVPCConnectionRequest { /** - *

The Amazon Web Services account ID.

+ *

The Amazon Web Services account ID of the account where you want to delete a VPC + * connection.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an + * Amazon Web Services account.

* @public */ - DataSetId: string | undefined; + VPCConnectionId: string | undefined; } /** * @public */ -export interface DescribeDataSetResponse { +export interface DeleteVPCConnectionResponse { /** - *

Information on the dataset.

+ *

The Amazon Resource Name (ARN) of the deleted VPC connection.

* @public */ - DataSet?: DataSet | undefined; + Arn?: string | undefined; + + /** + *

The ID of the VPC connection that + * you're creating. This ID is a unique identifier for each Amazon Web Services Region in an + * Amazon Web Services account.

+ * @public + */ + VPCConnectionId?: string | undefined; + + /** + *

The deletion status of the VPC connection.

+ * @public + */ + DeletionStatus?: VPCConnectionResourceStatus | undefined; + + /** + *

The availability status of the VPC connection.

+ * @public + */ + AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -7146,41 +6812,59 @@ export interface DescribeDataSetResponse { /** * @public */ -export interface DescribeDataSetPermissionsRequest { +export interface DescribeAccountCustomizationRequest { /** - *

The Amazon Web Services account ID.

+ *

The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations + * for.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations + * for.

* @public */ - DataSetId: string | undefined; + Namespace?: string | undefined; + + /** + *

The Resolved flag works with the other parameters to determine which view + * of Amazon QuickSight customizations is returned. You can add this flag to your command to use + * the same view that Amazon QuickSight uses to identify which customizations to apply to the + * console. Omit this flag, or set it to no-resolved, to reveal customizations + * that are configured at different levels.

+ * @public + */ + Resolved?: boolean | undefined; } /** * @public */ -export interface DescribeDataSetPermissionsResponse { +export interface DescribeAccountCustomizationResponse { /** - *

The Amazon Resource Name (ARN) of the dataset.

+ *

The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.

* @public */ - DataSetArn?: string | undefined; + Arn?: string | undefined; /** - *

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The ID for the Amazon Web Services account that you're describing.

* @public */ - DataSetId?: string | undefined; + AwsAccountId?: string | undefined; /** - *

A list of resource permissions on the dataset.

+ *

The Amazon QuickSight namespace that you're describing.

* @public */ - Permissions?: ResourcePermission[] | undefined; + Namespace?: string | undefined; + + /** + *

The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.

+ * @public + */ + AccountCustomization?: AccountCustomization | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -7198,496 +6882,567 @@ export interface DescribeDataSetPermissionsResponse { /** * @public */ -export interface DescribeDataSetRefreshPropertiesRequest { +export interface DescribeAccountSettingsRequest { /** - *

The Amazon Web Services account ID.

+ *

The ID for the Amazon Web Services account that contains the settings that you want to list.

* @public */ AwsAccountId: string | undefined; - - /** - *

The ID of the dataset.

- * @public - */ - DataSetId: string | undefined; } /** * @public */ -export interface DescribeDataSetRefreshPropertiesResponse { +export interface DescribeAccountSettingsResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

The Amazon QuickSight settings for this Amazon Web Services account. This information + * includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or + * Enterprise) and the notification email for the Amazon QuickSight subscription.

+ *

In the QuickSight console, the Amazon QuickSight subscription is sometimes referred to + * as a QuickSight "account" even though it's technically not an account by + * itself. Instead, it's a subscription to the Amazon QuickSight service for your + * Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.

* @public */ - RequestId?: string | undefined; + AccountSettings?: AccountSettings | undefined; /** - *

The HTTP status of the request.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Status?: number | undefined; + RequestId?: string | undefined; /** - *

The dataset refresh properties.

+ *

The HTTP status of the request.

* @public */ - DataSetRefreshProperties?: DataSetRefreshProperties | undefined; + Status?: number | undefined; } /** * @public */ -export interface DescribeDataSourceRequest { +export interface DescribeAccountSubscriptionRequest { /** - *

The Amazon Web Services account ID.

+ *

The Amazon Web Services account ID associated with your Amazon QuickSight account.

* @public */ AwsAccountId: string | undefined; - - /** - *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

- * @public - */ - DataSourceId: string | undefined; } /** * @public */ -export interface DescribeDataSourceResponse { +export interface DescribeAccountSubscriptionResponse { /** - *

The information on the data source.

+ *

A structure that contains the following elements:

+ *
    + *
  • + *

    Your Amazon QuickSight account name.

    + *
  • + *
  • + *

    The edition of Amazon QuickSight that your account is using.

    + *
  • + *
  • + *

    The notification email address that is associated with the Amazon QuickSight + * account. + *

    + *
  • + *
  • + *

    The authentication type of the Amazon QuickSight account.

    + *
  • + *
  • + *

    The status of the Amazon QuickSight account's subscription.

    + *
  • + *
* @public */ - DataSource?: DataSource | undefined; + AccountInfo?: AccountInfo | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The HTTP status of the request.

* @public */ - RequestId?: string | undefined; + Status?: number | undefined; /** - *

The HTTP status of the request.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Status?: number | undefined; + RequestId?: string | undefined; } /** * @public */ -export interface DescribeDataSourcePermissionsRequest { +export interface DescribeAnalysisRequest { /** - *

The Amazon Web Services account ID.

+ *

The ID of the Amazon Web Services account that contains the analysis. You must be using the + * Amazon Web Services account that the analysis is in.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The ID of the analysis that you're describing. The ID is part of the URL of the + * analysis.

* @public */ - DataSourceId: string | undefined; + AnalysisId: string | undefined; } /** * @public */ -export interface DescribeDataSourcePermissionsResponse { - /** - *

The Amazon Resource Name (ARN) of the data source.

- * @public - */ - DataSourceArn?: string | undefined; - +export interface DescribeAnalysisResponse { /** - *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

A metadata structure that contains summary information for the analysis that you're + * describing.

* @public */ - DataSourceId?: string | undefined; + Analysis?: Analysis | undefined; /** - *

A list of resource permissions on the data source.

+ *

The HTTP status of the request.

* @public */ - Permissions?: ResourcePermission[] | undefined; + Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; - - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; } /** * @public */ -export interface DescribeFolderRequest { +export interface DescribeAnalysisDefinitionRequest { /** - *

The ID for the Amazon Web Services account that contains the folder.

+ *

The ID of the Amazon Web Services account that contains the analysis. You must be using the + * Amazon Web Services account that the analysis is in.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the folder.

+ *

The ID of the analysis that you're describing. The ID is part of the URL of the + * analysis.

* @public */ - FolderId: string | undefined; + AnalysisId: string | undefined; } /** - *

A folder in Amazon QuickSight.

* @public */ -export interface Folder { +export interface DescribeAnalysisDefinitionResponse { /** - *

The ID of the folder.

+ *

The ID of the analysis described.

* @public */ - FolderId?: string | undefined; + AnalysisId?: string | undefined; /** - *

The Amazon Resource Name (ARN) for the folder.

+ *

The descriptive name of the analysis.

* @public */ - Arn?: string | undefined; + Name?: string | undefined; /** - *

A display name for the folder.

+ *

Errors associated with the analysis.

* @public */ - Name?: string | undefined; + Errors?: AnalysisError[] | undefined; /** - *

The type of folder it is.

+ *

Status associated with the analysis.

+ *
    + *
  • + *

    + * CREATION_IN_PROGRESS + *

    + *
  • + *
  • + *

    + * CREATION_SUCCESSFUL + *

    + *
  • + *
  • + *

    + * CREATION_FAILED + *

    + *
  • + *
  • + *

    + * UPDATE_IN_PROGRESS + *

    + *
  • + *
  • + *

    + * UPDATE_SUCCESSFUL + *

    + *
  • + *
  • + *

    + * UPDATE_FAILED + *

    + *
  • + *
  • + *

    + * DELETED + *

    + *
  • + *
* @public */ - FolderType?: FolderType | undefined; + ResourceStatus?: ResourceStatus | undefined; /** - *

An array of ancestor ARN strings for the folder.

+ *

The ARN of the theme of the analysis.

* @public */ - FolderPath?: string[] | undefined; + ThemeArn?: string | undefined; /** - *

The time that the folder was created.

+ *

The definition of an analysis.

+ *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

* @public */ - CreatedTime?: Date | undefined; + Definition?: AnalysisDefinition | undefined; /** - *

The time that the folder was last updated.

+ *

The HTTP status of the request.

* @public */ - LastUpdatedTime?: Date | undefined; + Status?: number | undefined; /** - *

The sharing scope of the folder.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - SharingModel?: SharingModel | undefined; + RequestId?: string | undefined; } /** * @public */ -export interface DescribeFolderResponse { - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; - +export interface DescribeAnalysisPermissionsRequest { /** - *

Information about the folder.

+ *

The ID of the Amazon Web Services account that contains the analysis whose permissions you're + * describing. You must be using the Amazon Web Services account that the analysis is in.

* @public */ - Folder?: Folder | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The ID of the analysis whose permissions you're describing. The ID is part of the + * analysis URL.

* @public */ - RequestId?: string | undefined; + AnalysisId: string | undefined; } /** * @public */ -export interface DescribeFolderPermissionsRequest { +export interface DescribeAnalysisPermissionsResponse { /** - *

The ID for the Amazon Web Services account that contains the folder.

+ *

The ID of the analysis whose permissions you're describing.

* @public */ - AwsAccountId: string | undefined; + AnalysisId?: string | undefined; /** - *

The ID of the folder.

+ *

The Amazon Resource Name (ARN) of the analysis whose permissions you're + * describing.

* @public */ - FolderId: string | undefined; + AnalysisArn?: string | undefined; /** - *

The namespace of the folder whose permissions you want described.

+ *

A structure that describes the principals and the resource-level permissions on an + * analysis.

* @public */ - Namespace?: string | undefined; + Permissions?: ResourcePermission[] | undefined; /** - *

The maximum number of results to be returned per request.

+ *

The HTTP status of the request.

* @public */ - MaxResults?: number | undefined; + Status?: number | undefined; /** - *

A pagination token for the next set of results.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - NextToken?: string | undefined; + RequestId?: string | undefined; } /** * @public */ -export interface DescribeFolderPermissionsResponse { +export interface DescribeAssetBundleExportJobRequest { /** - *

The HTTP status of the request.

+ *

The ID of the Amazon Web Services account the export job is executed in.

* @public */ - Status?: number | undefined; + AwsAccountId: string | undefined; /** - *

The ID of the folder.

+ *

The ID of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

* @public */ - FolderId?: string | undefined; + AssetBundleExportJobId: string | undefined; +} + +/** + * @public + * @enum + */ +export const IncludeFolderMembers = { + NONE: "NONE", + ONE_LEVEL: "ONE_LEVEL", + RECURSE: "RECURSE", +} as const; + +/** + * @public + */ +export type IncludeFolderMembers = (typeof IncludeFolderMembers)[keyof typeof IncludeFolderMembers]; +/** + * @public + */ +export interface DescribeAssetBundleExportJobResponse { /** - *

The Amazon Resource Name (ARN) for the folder.

+ *

Indicates the status of a job through its queuing and execution.

+ *

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

* @public */ - Arn?: string | undefined; + JobStatus?: AssetBundleExportJobStatus | undefined; /** - *

Information about the permissions on the folder.

+ *

The URL to download the exported asset bundle data from.

+ *

This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed.

+ *

The downloaded asset bundle is a zip file named assetbundle-\{jobId\}.qs. The file has a .qs extension.

+ *

This URL can't be used in a StartAssetBundleImportJob API call and should only be used for download purposes.

* @public */ - Permissions?: ResourcePermission[] | undefined; + DownloadUrl?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

An array of error records that describes any failures that occurred during the export job processing.

+ *

Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

* @public */ - RequestId?: string | undefined; + Errors?: AssetBundleExportJobError[] | undefined; /** - *

The pagination token for the next set of results, or null if there are no more results.

+ *

The Amazon Resource Name (ARN) for the export job.

* @public */ - NextToken?: string | undefined; -} + Arn?: string | undefined; -/** - *

The NextToken value isn't valid.

- * @public - */ -export class InvalidNextTokenException extends __BaseException { - readonly name: "InvalidNextTokenException" = "InvalidNextTokenException"; - readonly $fault: "client" = "client"; - Message?: string | undefined; /** - *

The Amazon Web Services request ID for this request.

+ *

The time that the export job was created.

* @public */ - RequestId?: string | undefined; + CreatedTime?: Date | undefined; + /** - * @internal + *

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "InvalidNextTokenException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, InvalidNextTokenException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } -} + AssetBundleExportJobId?: string | undefined; -/** - * @public - */ -export interface DescribeFolderResolvedPermissionsRequest { /** - *

The ID for the Amazon Web Services account that contains the folder.

+ *

The ID of the Amazon Web Services account that the export job was executed in.

* @public */ - AwsAccountId: string | undefined; + AwsAccountId?: string | undefined; /** - *

The ID of the folder.

+ *

A list of resource ARNs that exported with the job.

* @public */ - FolderId: string | undefined; + ResourceArns?: string[] | undefined; /** - *

The namespace of the folder whose permissions you want described.

+ *

The include dependencies flag.

* @public */ - Namespace?: string | undefined; + IncludeAllDependencies?: boolean | undefined; /** - *

The maximum number of results to be returned per request.

+ *

The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.

* @public */ - MaxResults?: number | undefined; + ExportFormat?: AssetBundleExportFormat | undefined; /** - *

A pagination token for the next set of results.

+ *

The CloudFormation override property configuration for the export job.

* @public */ - NextToken?: string | undefined; -} + CloudFormationOverridePropertyConfiguration?: AssetBundleCloudFormationOverridePropertyConfiguration | undefined; -/** - * @public - */ -export interface DescribeFolderResolvedPermissionsResponse { /** - *

The HTTP status of the request.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Status?: number | undefined; + RequestId?: string | undefined; /** - *

The ID of the folder.

+ *

The HTTP status of the response.

* @public */ - FolderId?: string | undefined; + Status?: number | undefined; /** - *

The Amazon Resource Name (ARN) of the folder.

+ *

The include permissions flag.

* @public */ - Arn?: string | undefined; + IncludePermissions?: boolean | undefined; /** - *

Information about the permissions for the folder.

+ *

The include tags flag.

* @public */ - Permissions?: ResourcePermission[] | undefined; + IncludeTags?: boolean | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The validation strategy that is used to export the analysis or dashboard.

* @public */ - RequestId?: string | undefined; + ValidationStrategy?: AssetBundleExportJobValidationStrategy | undefined; /** - *

A pagination token for the next set of results, or null if there are no more results.

+ *

An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

+ *

This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

* @public */ - NextToken?: string | undefined; -} + Warnings?: AssetBundleExportJobWarning[] | undefined; -/** - * @public - */ -export interface DescribeGroupRequest { /** - *

The name of the group that you want to describe.

+ *

The include folder memberships flag.

* @public */ - GroupName: string | undefined; + IncludeFolderMemberships?: boolean | undefined; /** - *

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the - * Amazon Web Services account that contains your Amazon QuickSight account.

+ *

A setting that determines whether folder members are included.

+ * @public + */ + IncludeFolderMembers?: IncludeFolderMembers | undefined; +} + +/** + * @public + */ +export interface DescribeAssetBundleImportJobRequest { + /** + *

The ID of the Amazon Web Services account the import job was executed in.

* @public */ AwsAccountId: string | undefined; /** - *

The namespace of the group that you want described.

+ *

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

* @public */ - Namespace: string | undefined; + AssetBundleImportJobId: string | undefined; } /** * @public */ -export interface DescribeGroupResponse { +export interface DescribeAssetBundleImportJobResponse { /** - *

The name of the group.

+ *

Indicates the status of a job through its queuing and execution.

+ *

Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values:

+ *
    + *
  • + *

    + * SUCCESSFUL + *

    + *
  • + *
  • + *

    + * FAILED + *

    + *
  • + *
  • + *

    + * FAILED_ROLLBACK_COMPLETED + *

    + *
  • + *
  • + *

    + * FAILED_ROLLBACK_ERROR + *

    + *
  • + *
* @public */ - Group?: Group | undefined; + JobStatus?: AssetBundleImportJobStatus | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

An array of error records that describes any failures that occurred during the export job processing.

+ *

Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

* @public */ - RequestId?: string | undefined; + Errors?: AssetBundleImportJobError[] | undefined; /** - *

The HTTP status of the request.

+ *

An array of error records that describes any failures that occurred while an import job was attempting a rollback.

+ *

Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

* @public */ - Status?: number | undefined; -} + RollbackErrors?: AssetBundleImportJobError[] | undefined; -/** - * @public - */ -export interface DescribeGroupMembershipRequest { /** - *

The user name of the user that you want to search for.

+ *

The Amazon Resource Name (ARN) for the import job.

* @public */ - MemberName: string | undefined; + Arn?: string | undefined; /** - *

The name of the group that you want to search.

+ *

The time that the import job was created.

* @public */ - GroupName: string | undefined; + CreatedTime?: Date | undefined; /** - *

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the - * Amazon Web Services account that contains your Amazon QuickSight account.

+ *

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

* @public */ - AwsAccountId: string | undefined; + AssetBundleImportJobId?: string | undefined; /** - *

The namespace that includes the group you are searching within.

+ *

The ID of the Amazon Web Services account the import job was executed in.

* @public */ - Namespace: string | undefined; -} + AwsAccountId?: string | undefined; -/** - * @public - */ -export interface DescribeGroupMembershipResponse { /** - *

A member of an Amazon QuickSight group. Currently, group members must be users. Groups - * can't be members of another group. .

+ *

The source of the asset bundle zip file that contains the data that is imported by the job.

* @public */ - GroupMember?: GroupMember | undefined; + AssetBundleImportSource?: AssetBundleImportSourceDescription | undefined; + + /** + *

Optional overrides that are applied to the resource configuration before import.

+ * @public + */ + OverrideParameters?: AssetBundleImportJobOverrideParameters | undefined; + + /** + *

The failure action for the import job.

+ * @public + */ + FailureAction?: AssetBundleImportFailureAction | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -7696,88 +7451,97 @@ export interface DescribeGroupMembershipResponse { RequestId?: string | undefined; /** - *

The HTTP status of the request.

+ *

The HTTP status of the response.

* @public */ Status?: number | undefined; -} -/** - * @public - */ -export interface DescribeIAMPolicyAssignmentRequest { /** - *

The ID of the Amazon Web Services account that contains the assignment that you want to - * describe.

+ *

Optional permission overrides that are applied to the resource configuration before import.

* @public */ - AwsAccountId: string | undefined; + OverridePermissions?: AssetBundleImportJobOverridePermissions | undefined; /** - *

The name of the assignment, also called a rule.

+ *

Optional tag overrides that are applied to the resource configuration before import.

* @public */ - AssignmentName: string | undefined; + OverrideTags?: AssetBundleImportJobOverrideTags | undefined; /** - *

The namespace that contains the assignment.

+ *

An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.

* @public */ - Namespace: string | undefined; + OverrideValidationStrategy?: AssetBundleImportJobOverrideValidationStrategy | undefined; + + /** + *

An array of warning records that describe all permitted errors that are encountered during the import job.

+ * @public + */ + Warnings?: AssetBundleImportJobWarning[] | undefined; } /** - *

An Identity and Access Management (IAM) policy assignment.

* @public */ -export interface IAMPolicyAssignment { +export interface DescribeBrandRequest { /** - *

The Amazon Web Services account ID.

+ *

The ID of the Amazon Web Services account that owns the brand.

* @public */ - AwsAccountId?: string | undefined; + AwsAccountId: string | undefined; /** - *

Assignment ID.

+ *

The ID of the Amazon QuickSight brand.

* @public */ - AssignmentId?: string | undefined; + BrandId: string | undefined; /** - *

Assignment name.

+ *

The ID of the specific version. The default value is the latest version.

* @public */ - AssignmentName?: string | undefined; + VersionId?: string | undefined; +} +/** + * @public + */ +export interface DescribeBrandResponse { /** - *

The Amazon Resource Name (ARN) for the IAM policy.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - PolicyArn?: string | undefined; + RequestId?: string | undefined; /** - *

Identities.

+ *

The details of the brand.

* @public */ - Identities?: Record | undefined; + BrandDetail?: BrandDetail | undefined; /** - *

Assignment status.

+ *

The definition of the brand.

* @public */ - AssignmentStatus?: AssignmentStatus | undefined; + BrandDefinition?: BrandDefinition | undefined; } /** * @public */ -export interface DescribeIAMPolicyAssignmentResponse { +export interface DescribeBrandAssignmentRequest { /** - *

Information describing the IAM policy assignment.

+ *

The ID of the Amazon Web Services account that owns the brand assignment.

* @public */ - IAMPolicyAssignment?: IAMPolicyAssignment | undefined; + AwsAccountId: string | undefined; +} +/** + * @public + */ +export interface DescribeBrandAssignmentResponse { /** *

The Amazon Web Services request ID for this operation.

* @public @@ -7785,514 +7549,664 @@ export interface DescribeIAMPolicyAssignmentResponse { RequestId?: string | undefined; /** - *

The HTTP status of the request.

+ *

The Amazon Resource Name (ARN) of the brand.

* @public */ - Status?: number | undefined; + BrandArn?: string | undefined; } /** * @public */ -export interface DescribeIngestionRequest { +export interface DescribeBrandPublishedVersionRequest { /** - *

The Amazon Web Services account ID.

+ *

The ID of the Amazon Web Services account that owns the brand.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the dataset used in the ingestion.

+ *

The ID of the Amazon QuickSight brand.

* @public */ - DataSetId: string | undefined; + BrandId: string | undefined; +} +/** + * @public + */ +export interface DescribeBrandPublishedVersionResponse { /** - *

An ID for the ingestion.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - IngestionId: string | undefined; + RequestId?: string | undefined; + + /** + *

The details of the brand.

+ * @public + */ + BrandDetail?: BrandDetail | undefined; + + /** + *

The definition of the brand.

+ * @public + */ + BrandDefinition?: BrandDefinition | undefined; } /** * @public - * @enum */ -export const IngestionErrorType = { - ACCOUNT_CAPACITY_LIMIT_EXCEEDED: "ACCOUNT_CAPACITY_LIMIT_EXCEEDED", - CONNECTION_FAILURE: "CONNECTION_FAILURE", - CURSOR_NOT_ENABLED: "CURSOR_NOT_ENABLED", - CUSTOMER_ERROR: "CUSTOMER_ERROR", - DATA_SET_DELETED: "DATA_SET_DELETED", - DATA_SET_NOT_SPICE: "DATA_SET_NOT_SPICE", - DATA_SET_SIZE_LIMIT_EXCEEDED: "DATA_SET_SIZE_LIMIT_EXCEEDED", - DATA_SOURCE_AUTH_FAILED: "DATA_SOURCE_AUTH_FAILED", - DATA_SOURCE_CONNECTION_FAILED: "DATA_SOURCE_CONNECTION_FAILED", - DATA_SOURCE_NOT_FOUND: "DATA_SOURCE_NOT_FOUND", - DATA_TOLERANCE_EXCEPTION: "DATA_TOLERANCE_EXCEPTION", - DUPLICATE_COLUMN_NAMES_FOUND: "DUPLICATE_COLUMN_NAMES_FOUND", - ELASTICSEARCH_CURSOR_NOT_ENABLED: "ELASTICSEARCH_CURSOR_NOT_ENABLED", - FAILURE_TO_ASSUME_ROLE: "FAILURE_TO_ASSUME_ROLE", - FAILURE_TO_PROCESS_JSON_FILE: "FAILURE_TO_PROCESS_JSON_FILE", - IAM_ROLE_NOT_AVAILABLE: "IAM_ROLE_NOT_AVAILABLE", - INGESTION_CANCELED: "INGESTION_CANCELED", - INGESTION_SUPERSEDED: "INGESTION_SUPERSEDED", - INTERNAL_SERVICE_ERROR: "INTERNAL_SERVICE_ERROR", - INVALID_DATAPREP_SYNTAX: "INVALID_DATAPREP_SYNTAX", - INVALID_DATA_SOURCE_CONFIG: "INVALID_DATA_SOURCE_CONFIG", - INVALID_DATE_FORMAT: "INVALID_DATE_FORMAT", - IOT_DATA_SET_FILE_EMPTY: "IOT_DATA_SET_FILE_EMPTY", - IOT_FILE_NOT_FOUND: "IOT_FILE_NOT_FOUND", - OAUTH_TOKEN_FAILURE: "OAUTH_TOKEN_FAILURE", - PASSWORD_AUTHENTICATION_FAILURE: "PASSWORD_AUTHENTICATION_FAILURE", - PERMISSION_DENIED: "PERMISSION_DENIED", - PERMISSION_NOT_FOUND: "PERMISSION_NOT_FOUND", - QUERY_TIMEOUT: "QUERY_TIMEOUT", - REFRESH_SUPPRESSED_BY_EDIT: "REFRESH_SUPPRESSED_BY_EDIT", - ROW_SIZE_LIMIT_EXCEEDED: "ROW_SIZE_LIMIT_EXCEEDED", - S3_FILE_INACCESSIBLE: "S3_FILE_INACCESSIBLE", - S3_MANIFEST_ERROR: "S3_MANIFEST_ERROR", - S3_UPLOADED_FILE_DELETED: "S3_UPLOADED_FILE_DELETED", - SOURCE_API_LIMIT_EXCEEDED_FAILURE: "SOURCE_API_LIMIT_EXCEEDED_FAILURE", - SOURCE_RESOURCE_LIMIT_EXCEEDED: "SOURCE_RESOURCE_LIMIT_EXCEEDED", - SPICE_TABLE_NOT_FOUND: "SPICE_TABLE_NOT_FOUND", - SQL_EXCEPTION: "SQL_EXCEPTION", - SQL_INVALID_PARAMETER_VALUE: "SQL_INVALID_PARAMETER_VALUE", - SQL_NUMERIC_OVERFLOW: "SQL_NUMERIC_OVERFLOW", - SQL_SCHEMA_MISMATCH_ERROR: "SQL_SCHEMA_MISMATCH_ERROR", - SQL_TABLE_NOT_FOUND: "SQL_TABLE_NOT_FOUND", - SSL_CERTIFICATE_VALIDATION_FAILURE: "SSL_CERTIFICATE_VALIDATION_FAILURE", - UNRESOLVABLE_HOST: "UNRESOLVABLE_HOST", - UNROUTABLE_HOST: "UNROUTABLE_HOST", -} as const; +export interface DescribeCustomPermissionsRequest { + /** + *

The ID of the Amazon Web Services account that contains the custom permissions profile that you want described.

+ * @public + */ + AwsAccountId: string | undefined; -/** - * @public - */ -export type IngestionErrorType = (typeof IngestionErrorType)[keyof typeof IngestionErrorType]; + /** + *

The name of the custom permissions profile to describe.

+ * @public + */ + CustomPermissionsName: string | undefined; +} /** - *

Error information for the SPICE ingestion of a dataset.

* @public */ -export interface ErrorInfo { +export interface DescribeCustomPermissionsResponse { /** - *

Error type.

+ *

The HTTP status of the request.

* @public */ - Type?: IngestionErrorType | undefined; + Status?: number | undefined; /** - *

Error message.

+ *

The custom permissions profile.

* @public */ - Message?: string | undefined; + CustomPermissions?: CustomPermissions | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; } /** - *

Information about a queued dataset SPICE ingestion.

* @public */ -export interface QueueInfo { +export interface DescribeDashboardRequest { /** - *

The ID of the queued ingestion.

+ *

The ID of the Amazon Web Services account that contains the dashboard that you're + * describing.

* @public */ - WaitingOnIngestion: string | undefined; + AwsAccountId: string | undefined; /** - *

The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing - * ingestion to complete.

+ *

The ID for the dashboard.

* @public */ - QueuedIngestion: string | undefined; + DashboardId: string | undefined; + + /** + *

The version number for the dashboard. If a version number isn't passed, the + * latest published dashboard version is described.

+ * @public + */ + VersionNumber?: number | undefined; + + /** + *

The alias name.

+ * @public + */ + AliasName?: string | undefined; } /** * @public - * @enum */ -export const IngestionRequestSource = { - MANUAL: "MANUAL", - SCHEDULED: "SCHEDULED", -} as const; +export interface DescribeDashboardResponse { + /** + *

Information about the dashboard.

+ * @public + */ + Dashboard?: Dashboard | undefined; -/** - * @public - */ -export type IngestionRequestSource = (typeof IngestionRequestSource)[keyof typeof IngestionRequestSource]; + /** + *

The HTTP status of this request.

+ * @public + */ + Status?: number | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; +} /** * @public - * @enum */ -export const IngestionRequestType = { - EDIT: "EDIT", - FULL_REFRESH: "FULL_REFRESH", - INCREMENTAL_REFRESH: "INCREMENTAL_REFRESH", - INITIAL_INGESTION: "INITIAL_INGESTION", -} as const; +export interface DescribeDashboardDefinitionRequest { + /** + *

The ID of the Amazon Web Services account that contains the dashboard that you're + * describing.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID for the dashboard.

+ * @public + */ + DashboardId: string | undefined; + + /** + *

The version number for the dashboard. If a version number isn't passed, the + * latest published dashboard version is described.

+ * @public + */ + VersionNumber?: number | undefined; + + /** + *

The alias name.

+ * @public + */ + AliasName?: string | undefined; +} /** * @public */ -export type IngestionRequestType = (typeof IngestionRequestType)[keyof typeof IngestionRequestType]; +export interface DescribeDashboardDefinitionResponse { + /** + *

The ID of the dashboard described.

+ * @public + */ + DashboardId?: string | undefined; + + /** + *

Errors associated with this dashboard version.

+ * @public + */ + Errors?: DashboardError[] | undefined; + + /** + *

The display name of the dashboard.

+ * @public + */ + Name?: string | undefined; + + /** + *

Status associated with the dashboard version.

+ *
    + *
  • + *

    + * CREATION_IN_PROGRESS + *

    + *
  • + *
  • + *

    + * CREATION_SUCCESSFUL + *

    + *
  • + *
  • + *

    + * CREATION_FAILED + *

    + *
  • + *
  • + *

    + * UPDATE_IN_PROGRESS + *

    + *
  • + *
  • + *

    + * UPDATE_SUCCESSFUL + *

    + *
  • + *
  • + *

    + * UPDATE_FAILED + *

    + *
  • + *
  • + *

    + * DELETED + *

    + *
  • + *
+ * @public + */ + ResourceStatus?: ResourceStatus | undefined; + + /** + *

The ARN of the theme of the dashboard.

+ * @public + */ + ThemeArn?: string | undefined; + + /** + *

The definition of a dashboard.

+ *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

+ * @public + */ + Definition?: DashboardVersionDefinition | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

Options for publishing the dashboard:

+ *
    + *
  • + *

    + * AvailabilityStatus for AdHocFilteringOption - This + * status can be either ENABLED or DISABLED. When this is + * set to DISABLED, Amazon QuickSight disables the left filter pane on the + * published dashboard, which can be used for ad hoc (one-time) filtering. This + * option is ENABLED by default.

    + *
  • + *
  • + *

    + * AvailabilityStatus for ExportToCSVOption - This + * status can be either ENABLED or DISABLED. The visual + * option to export data to .CSV format isn't enabled when this is set to + * DISABLED. This option is ENABLED by default.

    + *
  • + *
  • + *

    + * VisibilityState for SheetControlsOption - This + * visibility state can be either COLLAPSED or EXPANDED. + * This option is COLLAPSED by default.

    + *
  • + *
+ * @public + */ + DashboardPublishOptions?: DashboardPublishOptions | undefined; +} /** - *

Information about rows for a data set SPICE ingestion.

* @public */ -export interface RowInfo { - /** - *

The number of rows that were ingested.

- * @public - */ - RowsIngested?: number | undefined; - +export interface DescribeDashboardPermissionsRequest { /** - *

The number of rows that were not ingested.

+ *

The ID of the Amazon Web Services account that contains the dashboard that you're describing + * permissions for.

* @public */ - RowsDropped?: number | undefined; + AwsAccountId: string | undefined; /** - *

The total number of rows in the dataset.

+ *

The ID for the dashboard, also added to the IAM policy.

* @public */ - TotalRowsInDataset?: number | undefined; + DashboardId: string | undefined; } /** - *

Information about the SPICE ingestion for a dataset.

* @public */ -export interface Ingestion { +export interface DescribeDashboardPermissionsResponse { /** - *

The Amazon Resource Name (ARN) of the resource.

+ *

The ID for the dashboard.

* @public */ - Arn: string | undefined; + DashboardId?: string | undefined; /** - *

Ingestion ID.

+ *

The Amazon Resource Name (ARN) of the dashboard.

* @public */ - IngestionId?: string | undefined; + DashboardArn?: string | undefined; /** - *

Ingestion status.

+ *

A structure that contains the permissions for the dashboard.

* @public */ - IngestionStatus: IngestionStatus | undefined; + Permissions?: ResourcePermission[] | undefined; /** - *

Error information for this ingestion.

+ *

The HTTP status of the request.

* @public */ - ErrorInfo?: ErrorInfo | undefined; + Status?: number | undefined; /** - *

Information about rows for a data set SPICE ingestion.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - RowInfo?: RowInfo | undefined; + RequestId?: string | undefined; /** - *

Information about a queued dataset SPICE ingestion.

+ *

A structure that contains the configuration of a shareable link that grants access to + * the dashboard. Your users can use the link to view and interact with the dashboard, if + * the dashboard has been shared with them. For more information about sharing dashboards, + * see Sharing Dashboards.

* @public */ - QueueInfo?: QueueInfo | undefined; + LinkSharingConfiguration?: LinkSharingConfiguration | undefined; +} +/** + * @public + */ +export interface DescribeDashboardSnapshotJobRequest { /** - *

The time that this ingestion started.

+ *

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

* @public */ - CreatedTime: Date | undefined; + AwsAccountId: string | undefined; /** - *

The time that this ingestion took, measured in seconds.

+ *

The ID of the dashboard that you have started a snapshot job for.

* @public */ - IngestionTimeInSeconds?: number | undefined; + DashboardId: string | undefined; /** - *

The size of the data ingested, in bytes.

+ *

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

* @public */ - IngestionSizeInBytes?: number | undefined; + SnapshotJobId: string | undefined; +} + +/** + * @public + * @enum + */ +export const SnapshotJobStatus = { + COMPLETED: "COMPLETED", + FAILED: "FAILED", + QUEUED: "QUEUED", + RUNNING: "RUNNING", +} as const; + +/** + * @public + */ +export type SnapshotJobStatus = (typeof SnapshotJobStatus)[keyof typeof SnapshotJobStatus]; +/** + *

A structure that contains information on the Amazon S3 destinations of the generated snapshot.

+ * @public + */ +export interface SnapshotDestinationConfiguration { /** - *

Event source for this ingestion.

+ *

+ * A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 S3DestinationConfiguration. + *

* @public */ - RequestSource?: IngestionRequestSource | undefined; + S3Destinations?: SnapshotS3DestinationConfiguration[] | undefined; +} +/** + *

A structure that contains the information on the snapshot files.

+ * @public + */ +export interface SnapshotFileGroup { /** - *

Type of this ingestion.

+ *

A list of SnapshotFile objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time.

* @public */ - RequestType?: IngestionRequestType | undefined; + Files?: SnapshotFile[] | undefined; } /** + *

Describes the configuration of the dashboard snapshot.

* @public */ -export interface DescribeIngestionResponse { +export interface SnapshotConfiguration { /** - *

Information about the ingestion.

+ *

A list of SnapshotJobResultFileGroup objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup configurations.

* @public */ - Ingestion?: Ingestion | undefined; + FileGroups: SnapshotFileGroup[] | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.

* @public */ - RequestId?: string | undefined; + DestinationConfiguration?: SnapshotDestinationConfiguration | undefined; /** - *

The HTTP status of the request.

+ *

A list of Amazon QuickSight parameters and the list's override values.

* @public */ - Status?: number | undefined; + Parameters?: _Parameters | undefined; } /** + *

Use this structure to redact sensitive information that you provide about an anonymous user from the snapshot.

* @public */ -export interface DescribeIpRestrictionRequest { +export interface SnapshotAnonymousUserRedacted { /** - *

The ID of the Amazon Web Services account that contains the IP rules.

+ *

The tag keys for the RowLevelPermissionTags.

* @public */ - AwsAccountId: string | undefined; + RowLevelPermissionTagKeys?: string[] | undefined; +} + +/** + *

A structure that contains information about the users that the dashboard snapshot is generated for. Sensitive user information is excluded. + *

+ * @public + */ +export interface SnapshotUserConfigurationRedacted { + /** + *

+ * An array of records that describe anonymous users that the dashboard snapshot is generated for. Sensitive user information is excluded. + *

+ * @public + */ + AnonymousUsers?: SnapshotAnonymousUserRedacted[] | undefined; } /** * @public */ -export interface DescribeIpRestrictionResponse { +export interface DescribeDashboardSnapshotJobResponse { /** - *

The ID of the Amazon Web Services account that contains the IP rules.

+ *

+ * The ID of the Amazon Web Services account that the dashboard snapshot job is executed in. + *

* @public */ AwsAccountId?: string | undefined; /** - *

A map that describes the IP rules with CIDR range and description.

+ *

The ID of the dashboard that you have started a snapshot job for.

* @public */ - IpRestrictionRuleMap?: Record | undefined; + DashboardId?: string | undefined; /** - *

A map of allowed VPC IDs and their rule descriptions.

+ *

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

* @public */ - VpcIdRestrictionRuleMap?: Record | undefined; + SnapshotJobId?: string | undefined; /** - *

A map of allowed VPC endpoint IDs and their rule descriptions.

+ *

The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

* @public */ - VpcEndpointIdRestrictionRuleMap?: Record | undefined; + UserConfiguration?: SnapshotUserConfigurationRedacted | undefined; /** - *

A value that specifies whether IP rules are turned on.

+ *

The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

* @public */ - Enabled?: boolean | undefined; + SnapshotConfiguration?: SnapshotConfiguration | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

* @public */ - RequestId?: string | undefined; + Arn?: string | undefined; /** - *

The HTTP status of the request. - *

+ *

Indicates the status of a job. The status updates as the job executes. This shows one of the following values.

+ *
    + *
  • + *

    + * COMPLETED - The job was completed successfully.

    + *
  • + *
  • + *

    + * FAILED - The job failed to execute.

    + *
  • + *
  • + *

    + * QUEUED - The job is queued and hasn't started yet.

    + *
  • + *
  • + *

    + * RUNNING - The job is still running.

    + *
  • + *
* @public */ - Status?: number | undefined; -} + JobStatus?: SnapshotJobStatus | undefined; -/** - * @public - */ -export interface DescribeKeyRegistrationRequest { /** - *

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.

+ *

+ * The time that the snapshot job was created. + *

* @public */ - AwsAccountId: string | undefined; + CreatedTime?: Date | undefined; /** - *

Determines whether the request returns the default key only.

+ *

+ * The time that the snapshot job status was last updated. + *

* @public */ - DefaultKeyOnly?: boolean | undefined; -} + LastUpdatedTime?: Date | undefined; -/** - *

A customer managed key structure that contains the information listed below:

- *
    - *
  • - *

    - * KeyArn - The ARN of a KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.

    - *
  • - *
  • - *

    - * DefaultKey - Indicates whether the current key is set as the default key for encryption and decryption use.

    - *
  • - *
- * @public - */ -export interface RegisteredCustomerManagedKey { /** - *

The ARN of the KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.

+ *

+ * The Amazon Web Services request ID for this operation. + *

* @public */ - KeyArn?: string | undefined; + RequestId?: string | undefined; /** - *

Indicates whether a RegisteredCustomerManagedKey is set as the default key for encryption and decryption use.

+ *

The HTTP status of the request

* @public */ - DefaultKey?: boolean | undefined; + Status?: number | undefined; } /** * @public */ -export interface DescribeKeyRegistrationResponse { - /** - *

The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request.

- * @public - */ - AwsAccountId?: string | undefined; - +export interface DescribeDashboardSnapshotJobResultRequest { /** - *

A list of RegisteredCustomerManagedKey objects in a Amazon QuickSight account.

+ *

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

* @public */ - KeyRegistration?: RegisteredCustomerManagedKey[] | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The ID of the dashboard that you have started a snapshot job for.

* @public */ - RequestId?: string | undefined; + DashboardId: string | undefined; /** - *

The HTTP status of the request.

+ *

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

* @public */ - Status?: number | undefined; + SnapshotJobId: string | undefined; } /** + *

An object that contains information on the error that caused the snapshot job to fail.

* @public */ -export interface DescribeNamespaceRequest { +export interface SnapshotJobErrorInfo { /** - *

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

+ *

The error message.

* @public */ - AwsAccountId: string | undefined; + ErrorMessage?: string | undefined; /** - *

The namespace that you want to describe.

+ *

The error type.

* @public */ - Namespace: string | undefined; + ErrorType?: string | undefined; } /** - * @public - * @enum - */ -export const NamespaceErrorType = { - INTERNAL_SERVICE_ERROR: "INTERNAL_SERVICE_ERROR", - PERMISSION_DENIED: "PERMISSION_DENIED", -} as const; - -/** - * @public - */ -export type NamespaceErrorType = (typeof NamespaceErrorType)[keyof typeof NamespaceErrorType]; - -/** - *

Errors that occur during namespace creation.

+ *

An object that provides information on the result of a snapshot job. This object provides information about the job, the job status, and the location of the generated file.

* @public */ -export interface NamespaceError { - /** - *

The error type.

- * @public - */ - Type?: NamespaceErrorType | undefined; - +export interface SnapshotJobResult { /** - *

The message for the error.

+ *

A list of AnonymousUserSnapshotJobResult objects that contain information on anonymous users and their user configurations. This data provided by you when you make a StartDashboardSnapshotJob API call.

* @public */ - Message?: string | undefined; + AnonymousUsers?: AnonymousUserSnapshotJobResult[] | undefined; } /** - *

The error type.

- * @public - */ -export interface NamespaceInfoV2 { - /** - *

The name of the error.

- * @public - */ - Name?: string | undefined; - + * @public + */ +export interface DescribeDashboardSnapshotJobResultResponse { /** - *

The namespace ARN.

+ *

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

* @public */ Arn?: string | undefined; /** - *

The namespace Amazon Web Services Region.

+ *

Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

* @public */ - CapacityRegion?: string | undefined; + JobStatus?: SnapshotJobStatus | undefined; /** - *

The creation status of a namespace that is not yet completely created.

+ *

The time that a snapshot job was created.

* @public */ - CreationStatus?: NamespaceStatus | undefined; + CreatedTime?: Date | undefined; /** - *

The identity store used for the namespace.

+ *

The time that a snapshot job status was last updated.

* @public */ - IdentityStore?: IdentityStore | undefined; + LastUpdatedTime?: Date | undefined; /** - *

An error that occurred when the namespace was created.

+ *

The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.

* @public */ - NamespaceError?: NamespaceError | undefined; -} + Result?: SnapshotJobResult | undefined; -/** - * @public - */ -export interface DescribeNamespaceResponse { /** - *

The information about the namespace that you're describing. The response includes - * the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also - * works for namespaces that are in the process of being created. For incomplete namespaces, - * this API operation lists the namespace error types and messages associated with the creation process.

+ *

Displays information for the error that caused a job to fail.

* @public */ - Namespace?: NamespaceInfoV2 | undefined; + ErrorInfo?: SnapshotJobErrorInfo | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -8301,7 +8215,7 @@ export interface DescribeNamespaceResponse { RequestId?: string | undefined; /** - *

The HTTP status of the request.

+ *

The HTTP status of the request

* @public */ Status?: number | undefined; @@ -8310,37 +8224,29 @@ export interface DescribeNamespaceResponse { /** * @public */ -export interface DescribeQPersonalizationConfigurationRequest { +export interface DescribeDataSetRequest { /** - *

The ID of the Amazon Web Services account that contains the personalization configuration that the user wants described.

+ *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; -} - -/** - * @public - * @enum - */ -export const PersonalizationMode = { - DISABLED: "DISABLED", - ENABLED: "ENABLED", -} as const; -/** - * @public - */ -export type PersonalizationMode = (typeof PersonalizationMode)[keyof typeof PersonalizationMode]; + /** + *

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ * @public + */ + DataSetId: string | undefined; +} /** * @public */ -export interface DescribeQPersonalizationConfigurationResponse { +export interface DescribeDataSetResponse { /** - *

A value that indicates whether personalization is enabled or not.

+ *

Information on the dataset.

* @public */ - PersonalizationMode?: PersonalizationMode | undefined; + DataSet?: DataSet | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -8358,7 +8264,7 @@ export interface DescribeQPersonalizationConfigurationResponse { /** * @public */ -export interface DescribeRefreshScheduleRequest { +export interface DescribeDataSetPermissionsRequest { /** *

The Amazon Web Services account ID.

* @public @@ -8366,33 +8272,33 @@ export interface DescribeRefreshScheduleRequest { AwsAccountId: string | undefined; /** - *

The ID of the dataset.

+ *

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ DataSetId: string | undefined; - - /** - *

The ID of the refresh schedule.

- * @public - */ - ScheduleId: string | undefined; } /** * @public */ -export interface DescribeRefreshScheduleResponse { +export interface DescribeDataSetPermissionsResponse { /** - *

The refresh schedule.

+ *

The Amazon Resource Name (ARN) of the dataset.

* @public */ - RefreshSchedule?: RefreshSchedule | undefined; + DataSetArn?: string | undefined; /** - *

The HTTP status of the request.

+ *

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - Status?: number | undefined; + DataSetId?: string | undefined; + + /** + *

A list of resource permissions on the dataset.

+ * @public + */ + Permissions?: ResourcePermission[] | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -8401,45 +8307,33 @@ export interface DescribeRefreshScheduleResponse { RequestId?: string | undefined; /** - *

The Amazon Resource Name (ARN) for the refresh schedule.

+ *

The HTTP status of the request.

* @public */ - Arn?: string | undefined; + Status?: number | undefined; } /** * @public */ -export interface DescribeRoleCustomPermissionRequest { - /** - *

The name of the role whose permissions you want described.

- * @public - */ - Role: Role | undefined; - +export interface DescribeDataSetRefreshPropertiesRequest { /** - *

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

+ *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** - *

The namespace that contains the role.

+ *

The ID of the dataset.

* @public */ - Namespace: string | undefined; + DataSetId: string | undefined; } /** * @public */ -export interface DescribeRoleCustomPermissionResponse { - /** - *

The name of the custom permission that is described.

- * @public - */ - CustomPermissionsName?: string | undefined; - +export interface DescribeDataSetRefreshPropertiesResponse { /** *

The Amazon Web Services request ID for this operation.

* @public @@ -8451,295 +8345,192 @@ export interface DescribeRoleCustomPermissionResponse { * @public */ Status?: number | undefined; + + /** + *

The dataset refresh properties.

+ * @public + */ + DataSetRefreshProperties?: DataSetRefreshProperties | undefined; } /** * @public */ -export interface DescribeTemplateRequest { +export interface DescribeDataSourceRequest { /** - *

The ID of the Amazon Web Services account that contains the template that you're describing.

+ *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the template.

- * @public - */ - TemplateId: string | undefined; - - /** - *

(Optional) The number for the version to describe. If a VersionNumber parameter - * value isn't provided, the latest version of the template is described.

- * @public - */ - VersionNumber?: number | undefined; - - /** - *

The alias of the template that you want to describe. If you name a specific alias, you - * describe the version that the alias points to. You can specify the latest version of the - * template by providing the keyword $LATEST in the AliasName - * parameter. The keyword $PUBLISHED doesn't apply to templates.

+ *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - AliasName?: string | undefined; + DataSourceId: string | undefined; } /** - * @public - * @enum - */ -export const TemplateErrorType = { - ACCESS_DENIED: "ACCESS_DENIED", - DATA_SET_NOT_FOUND: "DATA_SET_NOT_FOUND", - INTERNAL_FAILURE: "INTERNAL_FAILURE", - SOURCE_NOT_FOUND: "SOURCE_NOT_FOUND", -} as const; - -/** - * @public - */ -export type TemplateErrorType = (typeof TemplateErrorType)[keyof typeof TemplateErrorType]; - -/** - *

List of errors that occurred when the template version creation failed.

* @public */ -export interface TemplateError { +export interface DescribeDataSourceResponse { /** - *

Type of error.

+ *

The information on the data source.

* @public */ - Type?: TemplateErrorType | undefined; + DataSource?: DataSource | undefined; /** - *

Description of the error type.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Message?: string | undefined; + RequestId?: string | undefined; /** - *

An error path that shows which entities caused the template error.

+ *

The HTTP status of the request.

* @public */ - ViolatedEntities?: Entity[] | undefined; + Status?: number | undefined; } /** - *

A version of a template.

* @public */ -export interface TemplateVersion { - /** - *

The time that this template version was created.

- * @public - */ - CreatedTime?: Date | undefined; - - /** - *

Errors associated with this template version.

- * @public - */ - Errors?: TemplateError[] | undefined; - +export interface DescribeDataSourcePermissionsRequest { /** - *

The version number of the template version.

+ *

The Amazon Web Services account ID.

* @public */ - VersionNumber?: number | undefined; + AwsAccountId: string | undefined; /** - *

The status that is associated with the template.

- *
    - *
  • - *

    - * CREATION_IN_PROGRESS - *

    - *
  • - *
  • - *

    - * CREATION_SUCCESSFUL - *

    - *
  • - *
  • - *

    - * CREATION_FAILED - *

    - *
  • - *
  • - *

    - * UPDATE_IN_PROGRESS - *

    - *
  • - *
  • - *

    - * UPDATE_SUCCESSFUL - *

    - *
  • - *
  • - *

    - * UPDATE_FAILED - *

    - *
  • - *
  • - *

    - * DELETED - *

    - *
  • - *
+ *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - Status?: ResourceStatus | undefined; + DataSourceId: string | undefined; +} +/** + * @public + */ +export interface DescribeDataSourcePermissionsResponse { /** - *

Schema of the dataset identified by the placeholder. Any dashboard created from this - * template should be bound to new datasets matching the same schema described through this - * API operation.

+ *

The Amazon Resource Name (ARN) of the data source.

* @public */ - DataSetConfigurations?: DataSetConfiguration[] | undefined; + DataSourceArn?: string | undefined; /** - *

The description of the template.

+ *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - Description?: string | undefined; + DataSourceId?: string | undefined; /** - *

The Amazon Resource Name (ARN) of an analysis or template that was used to create this - * template.

+ *

A list of resource permissions on the data source.

* @public */ - SourceEntityArn?: string | undefined; + Permissions?: ResourcePermission[] | undefined; /** - *

The ARN of the theme associated with this version of the template.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - ThemeArn?: string | undefined; + RequestId?: string | undefined; /** - *

A list of the associated sheets with the unique identifier and name of each sheet.

+ *

The HTTP status of the request.

* @public */ - Sheets?: Sheet[] | undefined; + Status?: number | undefined; } /** - *

A template object. A template is an entity in Amazon QuickSight that - * encapsulates the metadata required to create an analysis and that you can use to create - * a dashboard. A template adds a layer of abstraction by using placeholders to replace the - * dataset associated with an analysis. You can use templates to create dashboards by - * replacing dataset placeholders with datasets that follow the same schema that was used - * to create the source analysis and template.

- *

You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to - * create a template or a dashboard from an existing template.

* @public */ -export interface Template { - /** - *

The Amazon Resource Name (ARN) of the template.

- * @public - */ - Arn?: string | undefined; - - /** - *

The display name of the template.

- * @public - */ - Name?: string | undefined; - +export interface DescribeFolderRequest { /** - *

A structure describing the versions of the template.

+ *

The ID for the Amazon Web Services account that contains the folder.

* @public */ - Version?: TemplateVersion | undefined; + AwsAccountId: string | undefined; /** - *

The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The ID of the folder.

* @public */ - TemplateId?: string | undefined; + FolderId: string | undefined; +} +/** + *

A folder in Amazon QuickSight.

+ * @public + */ +export interface Folder { /** - *

Time when this was last updated.

+ *

The ID of the folder.

* @public */ - LastUpdatedTime?: Date | undefined; + FolderId?: string | undefined; /** - *

Time when this was created.

+ *

The Amazon Resource Name (ARN) for the folder.

* @public */ - CreatedTime?: Date | undefined; -} + Arn?: string | undefined; -/** - * @public - */ -export interface DescribeTemplateResponse { /** - *

The template structure for the object you want to describe.

+ *

A display name for the folder.

* @public */ - Template?: Template | undefined; + Name?: string | undefined; /** - *

The HTTP status of the request.

+ *

The type of folder it is.

* @public */ - Status?: number | undefined; + FolderType?: FolderType | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

An array of ancestor ARN strings for the folder.

* @public */ - RequestId?: string | undefined; -} + FolderPath?: string[] | undefined; -/** - * @public - */ -export interface DescribeTemplateAliasRequest { /** - *

The ID of the Amazon Web Services account that contains the template alias that you're - * describing.

+ *

The time that the folder was created.

* @public */ - AwsAccountId: string | undefined; + CreatedTime?: Date | undefined; /** - *

The ID for the template.

+ *

The time that the folder was last updated.

* @public */ - TemplateId: string | undefined; + LastUpdatedTime?: Date | undefined; /** - *

The name of the template alias that you want to describe. If you name a specific alias, you - * describe the version that the alias points to. You can specify the latest version of the - * template by providing the keyword $LATEST in the AliasName - * parameter. The keyword $PUBLISHED doesn't apply to templates.

+ *

The sharing scope of the folder.

* @public */ - AliasName: string | undefined; + SharingModel?: SharingModel | undefined; } /** * @public */ -export interface DescribeTemplateAliasResponse { +export interface DescribeFolderResponse { /** - *

Information about the template alias.

+ *

The HTTP status of the request.

* @public */ - TemplateAlias?: TemplateAlias | undefined; + Status?: number | undefined; /** - *

The HTTP status of the request.

+ *

Information about the folder.

* @public */ - Status?: number | undefined; + Folder?: Folder | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -8751,162 +8542,166 @@ export interface DescribeTemplateAliasResponse { /** * @public */ -export interface DescribeTemplateDefinitionRequest { +export interface DescribeFolderPermissionsRequest { /** - *

The ID of the Amazon Web Services account that contains the template. You must be using the - * Amazon Web Services account that the template is in.

+ *

The ID for the Amazon Web Services account that contains the folder.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the template that you're describing.

+ *

The ID of the folder.

* @public */ - TemplateId: string | undefined; + FolderId: string | undefined; /** - *

The version number of the template.

+ *

The namespace of the folder whose permissions you want described.

* @public */ - VersionNumber?: number | undefined; + Namespace?: string | undefined; /** - *

The alias of the template that you want to describe. If you name a specific alias, you - * describe the version that the alias points to. You can specify the latest version of the - * template by providing the keyword $LATEST in the AliasName - * parameter. The keyword $PUBLISHED doesn't apply to templates.

+ *

The maximum number of results to be returned per request.

* @public */ - AliasName?: string | undefined; + MaxResults?: number | undefined; + + /** + *

A pagination token for the next set of results.

+ * @public + */ + NextToken?: string | undefined; } /** * @public */ -export interface DescribeTemplateDefinitionResponse { +export interface DescribeFolderPermissionsResponse { /** - *

The descriptive name of the template.

+ *

The HTTP status of the request.

* @public */ - Name?: string | undefined; + Status?: number | undefined; /** - *

The ID of the template described.

+ *

The ID of the folder.

* @public */ - TemplateId?: string | undefined; + FolderId?: string | undefined; /** - *

Errors associated with the template version.

+ *

The Amazon Resource Name (ARN) for the folder.

* @public */ - Errors?: TemplateError[] | undefined; + Arn?: string | undefined; /** - *

Status associated with the template.

- *
    - *
  • - *

    - * CREATION_IN_PROGRESS - *

    - *
  • - *
  • - *

    - * CREATION_SUCCESSFUL - *

    - *
  • - *
  • - *

    - * CREATION_FAILED - *

    - *
  • - *
  • - *

    - * UPDATE_IN_PROGRESS - *

    - *
  • - *
  • - *

    - * UPDATE_SUCCESSFUL - *

    - *
  • - *
  • - *

    - * UPDATE_FAILED - *

    - *
  • - *
  • - *

    - * DELETED - *

    - *
  • - *
+ *

Information about the permissions on the folder.

* @public */ - ResourceStatus?: ResourceStatus | undefined; + Permissions?: ResourcePermission[] | undefined; /** - *

The ARN of the theme of the template.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - ThemeArn?: string | undefined; + RequestId?: string | undefined; /** - *

The definition of the template.

- *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

+ *

The pagination token for the next set of results, or null if there are no more results.

* @public */ - Definition?: TemplateVersionDefinition | undefined; + NextToken?: string | undefined; +} +/** + *

The NextToken value isn't valid.

+ * @public + */ +export class InvalidNextTokenException extends __BaseException { + readonly name: "InvalidNextTokenException" = "InvalidNextTokenException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; /** - *

The HTTP status of the request.

+ *

The Amazon Web Services request ID for this request.

* @public */ - Status?: number | undefined; - + RequestId?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

- * @public + * @internal */ - RequestId?: string | undefined; + constructor(opts: __ExceptionOptionType) { + super({ + name: "InvalidNextTokenException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, InvalidNextTokenException.prototype); + this.Message = opts.Message; + this.RequestId = opts.RequestId; + } } /** * @public */ -export interface DescribeTemplatePermissionsRequest { +export interface DescribeFolderResolvedPermissionsRequest { /** - *

The ID of the Amazon Web Services account that contains the template that you're describing.

+ *

The ID for the Amazon Web Services account that contains the folder.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the template.

+ *

The ID of the folder.

* @public */ - TemplateId: string | undefined; + FolderId: string | undefined; + + /** + *

The namespace of the folder whose permissions you want described.

+ * @public + */ + Namespace?: string | undefined; + + /** + *

The maximum number of results to be returned per request.

+ * @public + */ + MaxResults?: number | undefined; + + /** + *

A pagination token for the next set of results.

+ * @public + */ + NextToken?: string | undefined; } /** * @public */ -export interface DescribeTemplatePermissionsResponse { +export interface DescribeFolderResolvedPermissionsResponse { /** - *

The ID for the template.

+ *

The HTTP status of the request.

* @public */ - TemplateId?: string | undefined; + Status?: number | undefined; /** - *

The Amazon Resource Name (ARN) of the template.

+ *

The ID of the folder.

* @public */ - TemplateArn?: string | undefined; + FolderId?: string | undefined; /** - *

A list of resource permissions to be set on the template.

+ *

The Amazon Resource Name (ARN) of the folder.

+ * @public + */ + Arn?: string | undefined; + + /** + *

Information about the permissions for the folder.

* @public */ Permissions?: ResourcePermission[] | undefined; @@ -8918,387 +8713,490 @@ export interface DescribeTemplatePermissionsResponse { RequestId?: string | undefined; /** - *

The HTTP status of the request.

+ *

A pagination token for the next set of results, or null if there are no more results.

* @public */ - Status?: number | undefined; + NextToken?: string | undefined; } /** * @public */ -export interface DescribeThemeRequest { - /** - *

The ID of the Amazon Web Services account that contains the theme that you're describing.

- * @public - */ - AwsAccountId: string | undefined; - +export interface DescribeGroupRequest { /** - *

The ID for the theme.

+ *

The name of the group that you want to describe.

* @public */ - ThemeId: string | undefined; + GroupName: string | undefined; /** - *

The version number for the version to describe. If a VersionNumber parameter - * value isn't provided, the latest version of the theme is described.

+ *

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the + * Amazon Web Services account that contains your Amazon QuickSight account.

* @public */ - VersionNumber?: number | undefined; + AwsAccountId: string | undefined; /** - *

The alias of the theme that you want to describe. If you name a specific alias, you - * describe the version that the alias points to. You can specify the latest version of the - * theme by providing the keyword $LATEST in the AliasName - * parameter. The keyword $PUBLISHED doesn't apply to themes.

+ *

The namespace of the group that you want described.

* @public */ - AliasName?: string | undefined; + Namespace: string | undefined; } -/** - * @public - * @enum - */ -export const ThemeType = { - ALL: "ALL", - CUSTOM: "CUSTOM", - QUICKSIGHT: "QUICKSIGHT", -} as const; - /** * @public */ -export type ThemeType = (typeof ThemeType)[keyof typeof ThemeType]; +export interface DescribeGroupResponse { + /** + *

The name of the group.

+ * @public + */ + Group?: Group | undefined; -/** - * @public - * @enum - */ -export const ThemeErrorType = { - INTERNAL_FAILURE: "INTERNAL_FAILURE", -} as const; + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; -/** - * @public - */ -export type ThemeErrorType = (typeof ThemeErrorType)[keyof typeof ThemeErrorType]; + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; +} /** - *

Theme error.

* @public */ -export interface ThemeError { +export interface DescribeGroupMembershipRequest { /** - *

The type of error.

+ *

The user name of the user that you want to search for.

* @public */ - Type?: ThemeErrorType | undefined; + MemberName: string | undefined; /** - *

The error message.

+ *

The name of the group that you want to search.

* @public */ - Message?: string | undefined; -} + GroupName: string | undefined; -/** - *

A version of a theme.

- * @public - */ -export interface ThemeVersion { /** - *

The version number of the theme.

+ *

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the + * Amazon Web Services account that contains your Amazon QuickSight account.

* @public */ - VersionNumber?: number | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Resource Name (ARN) of the resource.

+ *

The namespace that includes the group you are searching within.

* @public */ - Arn?: string | undefined; + Namespace: string | undefined; +} +/** + * @public + */ +export interface DescribeGroupMembershipResponse { /** - *

The description of the theme.

+ *

A member of an Amazon QuickSight group. Currently, group members must be users. Groups + * can't be members of another group. .

* @public */ - Description?: string | undefined; + GroupMember?: GroupMember | undefined; /** - *

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All - * themes initially inherit from a default Amazon QuickSight theme.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - BaseThemeId?: string | undefined; + RequestId?: string | undefined; /** - *

The date and time that this theme version was created.

+ *

The HTTP status of the request.

* @public */ - CreatedTime?: Date | undefined; + Status?: number | undefined; +} +/** + * @public + */ +export interface DescribeIAMPolicyAssignmentRequest { /** - *

The theme configuration, which contains all the theme display properties.

+ *

The ID of the Amazon Web Services account that contains the assignment that you want to + * describe.

* @public */ - Configuration?: ThemeConfiguration | undefined; + AwsAccountId: string | undefined; /** - *

Errors associated with the theme.

+ *

The name of the assignment, also called a rule.

* @public */ - Errors?: ThemeError[] | undefined; + AssignmentName: string | undefined; /** - *

The status of the theme version.

+ *

The namespace that contains the assignment.

* @public */ - Status?: ResourceStatus | undefined; + Namespace: string | undefined; } /** - *

Summary information about a theme.

+ *

An Identity and Access Management (IAM) policy assignment.

* @public */ -export interface Theme { - /** - *

The Amazon Resource Name (ARN) of the theme.

- * @public - */ - Arn?: string | undefined; - +export interface IAMPolicyAssignment { /** - *

The name that the user gives to the theme.

+ *

The Amazon Web Services account ID.

* @public */ - Name?: string | undefined; + AwsAccountId?: string | undefined; /** - *

The identifier that the user gives to the theme.

+ *

Assignment ID.

* @public */ - ThemeId?: string | undefined; + AssignmentId?: string | undefined; /** - *

A version of a theme.

+ *

Assignment name.

* @public */ - Version?: ThemeVersion | undefined; + AssignmentName?: string | undefined; /** - *

The date and time that the theme was created.

+ *

The Amazon Resource Name (ARN) for the IAM policy.

* @public */ - CreatedTime?: Date | undefined; + PolicyArn?: string | undefined; /** - *

The date and time that the theme was last updated.

+ *

Identities.

* @public */ - LastUpdatedTime?: Date | undefined; + Identities?: Record | undefined; /** - *

The type of theme, based on how it was created. Valid values include: - * QUICKSIGHT and CUSTOM.

+ *

Assignment status.

* @public */ - Type?: ThemeType | undefined; + AssignmentStatus?: AssignmentStatus | undefined; } /** * @public */ -export interface DescribeThemeResponse { +export interface DescribeIAMPolicyAssignmentResponse { /** - *

The information about the theme that you are describing.

+ *

Information describing the IAM policy assignment.

* @public */ - Theme?: Theme | undefined; + IAMPolicyAssignment?: IAMPolicyAssignment | undefined; /** - *

The HTTP status of the request.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Status?: number | undefined; + RequestId?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The HTTP status of the request.

* @public */ - RequestId?: string | undefined; + Status?: number | undefined; } /** * @public */ -export interface DescribeThemeAliasRequest { +export interface DescribeIngestionRequest { /** - *

The ID of the Amazon Web Services account that contains the theme alias that you're - * describing.

+ *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the theme.

+ *

The ID of the dataset used in the ingestion.

* @public */ - ThemeId: string | undefined; + DataSetId: string | undefined; /** - *

The name of the theme alias that you want to describe.

+ *

An ID for the ingestion.

* @public */ - AliasName: string | undefined; + IngestionId: string | undefined; } /** * @public + * @enum */ -export interface DescribeThemeAliasResponse { - /** - *

Information about the theme alias.

- * @public - */ - ThemeAlias?: ThemeAlias | undefined; +export const IngestionErrorType = { + ACCOUNT_CAPACITY_LIMIT_EXCEEDED: "ACCOUNT_CAPACITY_LIMIT_EXCEEDED", + CONNECTION_FAILURE: "CONNECTION_FAILURE", + CURSOR_NOT_ENABLED: "CURSOR_NOT_ENABLED", + CUSTOMER_ERROR: "CUSTOMER_ERROR", + DATA_SET_DELETED: "DATA_SET_DELETED", + DATA_SET_NOT_SPICE: "DATA_SET_NOT_SPICE", + DATA_SET_SIZE_LIMIT_EXCEEDED: "DATA_SET_SIZE_LIMIT_EXCEEDED", + DATA_SOURCE_AUTH_FAILED: "DATA_SOURCE_AUTH_FAILED", + DATA_SOURCE_CONNECTION_FAILED: "DATA_SOURCE_CONNECTION_FAILED", + DATA_SOURCE_NOT_FOUND: "DATA_SOURCE_NOT_FOUND", + DATA_TOLERANCE_EXCEPTION: "DATA_TOLERANCE_EXCEPTION", + DUPLICATE_COLUMN_NAMES_FOUND: "DUPLICATE_COLUMN_NAMES_FOUND", + ELASTICSEARCH_CURSOR_NOT_ENABLED: "ELASTICSEARCH_CURSOR_NOT_ENABLED", + FAILURE_TO_ASSUME_ROLE: "FAILURE_TO_ASSUME_ROLE", + FAILURE_TO_PROCESS_JSON_FILE: "FAILURE_TO_PROCESS_JSON_FILE", + IAM_ROLE_NOT_AVAILABLE: "IAM_ROLE_NOT_AVAILABLE", + INGESTION_CANCELED: "INGESTION_CANCELED", + INGESTION_SUPERSEDED: "INGESTION_SUPERSEDED", + INTERNAL_SERVICE_ERROR: "INTERNAL_SERVICE_ERROR", + INVALID_DATAPREP_SYNTAX: "INVALID_DATAPREP_SYNTAX", + INVALID_DATA_SOURCE_CONFIG: "INVALID_DATA_SOURCE_CONFIG", + INVALID_DATE_FORMAT: "INVALID_DATE_FORMAT", + IOT_DATA_SET_FILE_EMPTY: "IOT_DATA_SET_FILE_EMPTY", + IOT_FILE_NOT_FOUND: "IOT_FILE_NOT_FOUND", + OAUTH_TOKEN_FAILURE: "OAUTH_TOKEN_FAILURE", + PASSWORD_AUTHENTICATION_FAILURE: "PASSWORD_AUTHENTICATION_FAILURE", + PERMISSION_DENIED: "PERMISSION_DENIED", + PERMISSION_NOT_FOUND: "PERMISSION_NOT_FOUND", + QUERY_TIMEOUT: "QUERY_TIMEOUT", + REFRESH_SUPPRESSED_BY_EDIT: "REFRESH_SUPPRESSED_BY_EDIT", + ROW_SIZE_LIMIT_EXCEEDED: "ROW_SIZE_LIMIT_EXCEEDED", + S3_FILE_INACCESSIBLE: "S3_FILE_INACCESSIBLE", + S3_MANIFEST_ERROR: "S3_MANIFEST_ERROR", + S3_UPLOADED_FILE_DELETED: "S3_UPLOADED_FILE_DELETED", + SOURCE_API_LIMIT_EXCEEDED_FAILURE: "SOURCE_API_LIMIT_EXCEEDED_FAILURE", + SOURCE_RESOURCE_LIMIT_EXCEEDED: "SOURCE_RESOURCE_LIMIT_EXCEEDED", + SPICE_TABLE_NOT_FOUND: "SPICE_TABLE_NOT_FOUND", + SQL_EXCEPTION: "SQL_EXCEPTION", + SQL_INVALID_PARAMETER_VALUE: "SQL_INVALID_PARAMETER_VALUE", + SQL_NUMERIC_OVERFLOW: "SQL_NUMERIC_OVERFLOW", + SQL_SCHEMA_MISMATCH_ERROR: "SQL_SCHEMA_MISMATCH_ERROR", + SQL_TABLE_NOT_FOUND: "SQL_TABLE_NOT_FOUND", + SSL_CERTIFICATE_VALIDATION_FAILURE: "SSL_CERTIFICATE_VALIDATION_FAILURE", + UNRESOLVABLE_HOST: "UNRESOLVABLE_HOST", + UNROUTABLE_HOST: "UNROUTABLE_HOST", +} as const; + +/** + * @public + */ +export type IngestionErrorType = (typeof IngestionErrorType)[keyof typeof IngestionErrorType]; +/** + *

Error information for the SPICE ingestion of a dataset.

+ * @public + */ +export interface ErrorInfo { /** - *

The HTTP status of the request.

+ *

Error type.

* @public */ - Status?: number | undefined; + Type?: IngestionErrorType | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

Error message.

* @public */ - RequestId?: string | undefined; + Message?: string | undefined; } /** + *

Information about a queued dataset SPICE ingestion.

* @public */ -export interface DescribeThemePermissionsRequest { +export interface QueueInfo { /** - *

The ID of the Amazon Web Services account that contains the theme that you're describing.

+ *

The ID of the queued ingestion.

* @public */ - AwsAccountId: string | undefined; + WaitingOnIngestion: string | undefined; /** - *

The ID for the theme that you want to describe permissions for.

+ *

The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing + * ingestion to complete.

* @public */ - ThemeId: string | undefined; + QueuedIngestion: string | undefined; } /** + * @public + * @enum + */ +export const IngestionRequestSource = { + MANUAL: "MANUAL", + SCHEDULED: "SCHEDULED", +} as const; + +/** + * @public + */ +export type IngestionRequestSource = (typeof IngestionRequestSource)[keyof typeof IngestionRequestSource]; + +/** + * @public + * @enum + */ +export const IngestionRequestType = { + EDIT: "EDIT", + FULL_REFRESH: "FULL_REFRESH", + INCREMENTAL_REFRESH: "INCREMENTAL_REFRESH", + INITIAL_INGESTION: "INITIAL_INGESTION", +} as const; + +/** + * @public + */ +export type IngestionRequestType = (typeof IngestionRequestType)[keyof typeof IngestionRequestType]; + +/** + *

Information about rows for a data set SPICE ingestion.

* @public */ -export interface DescribeThemePermissionsResponse { +export interface RowInfo { /** - *

The ID for the theme.

+ *

The number of rows that were ingested.

* @public */ - ThemeId?: string | undefined; + RowsIngested?: number | undefined; /** - *

The Amazon Resource Name (ARN) of the theme.

+ *

The number of rows that were not ingested.

* @public */ - ThemeArn?: string | undefined; + RowsDropped?: number | undefined; /** - *

A list of resource permissions set on the theme.

+ *

The total number of rows in the dataset.

* @public */ - Permissions?: ResourcePermission[] | undefined; + TotalRowsInDataset?: number | undefined; +} +/** + *

Information about the SPICE ingestion for a dataset.

+ * @public + */ +export interface Ingestion { /** - *

The Amazon Web Services request ID for this operation.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ - RequestId?: string | undefined; + Arn: string | undefined; /** - *

The HTTP status of the request.

+ *

Ingestion ID.

* @public */ - Status?: number | undefined; -} + IngestionId?: string | undefined; -/** - * @public - */ -export interface DescribeTopicRequest { /** - *

The Amazon Web Services account ID.

+ *

Ingestion status.

* @public */ - AwsAccountId: string | undefined; + IngestionStatus: IngestionStatus | undefined; /** - *

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

Error information for this ingestion.

* @public */ - TopicId: string | undefined; -} + ErrorInfo?: ErrorInfo | undefined; -/** - * @public - */ -export interface DescribeTopicResponse { /** - *

The Amazon Resource Name (ARN) of the topic.

+ *

Information about rows for a data set SPICE ingestion.

* @public */ - Arn?: string | undefined; + RowInfo?: RowInfo | undefined; /** - *

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

Information about a queued dataset SPICE ingestion.

* @public */ - TopicId?: string | undefined; + QueueInfo?: QueueInfo | undefined; /** - *

The definition of a topic.

+ *

The time that this ingestion started.

* @public */ - Topic?: TopicDetails | undefined; + CreatedTime: Date | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The time that this ingestion took, measured in seconds.

* @public */ - RequestId?: string | undefined; + IngestionTimeInSeconds?: number | undefined; /** - *

The HTTP status of the request.

+ *

The size of the data ingested, in bytes.

* @public */ - Status?: number | undefined; -} + IngestionSizeInBytes?: number | undefined; -/** - * @public - */ -export interface DescribeTopicPermissionsRequest { /** - *

The ID of the Amazon Web Services account that contains the topic that you want - * described.

+ *

Event source for this ingestion.

* @public */ - AwsAccountId: string | undefined; + RequestSource?: IngestionRequestSource | undefined; /** - *

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

Type of this ingestion.

* @public */ - TopicId: string | undefined; + RequestType?: IngestionRequestType | undefined; } +/** + * @internal + */ +export const FilterOperationFilterSensitiveLog = (obj: FilterOperation): any => ({ + ...obj, + ...(obj.ConditionExpression && { ConditionExpression: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const TagColumnOperationFilterSensitiveLog = (obj: TagColumnOperation): any => ({ + ...obj, + ...(obj.Tags && { Tags: obj.Tags.map((item) => ColumnTagFilterSensitiveLog(item)) }), +}); + +/** + * @internal + */ +export const TransformOperationFilterSensitiveLog = (obj: TransformOperation): any => { + if (obj.ProjectOperation !== undefined) return { ProjectOperation: obj.ProjectOperation }; + if (obj.FilterOperation !== undefined) + return { FilterOperation: FilterOperationFilterSensitiveLog(obj.FilterOperation) }; + if (obj.CreateColumnsOperation !== undefined) + return { CreateColumnsOperation: CreateColumnsOperationFilterSensitiveLog(obj.CreateColumnsOperation) }; + if (obj.RenameColumnOperation !== undefined) return { RenameColumnOperation: obj.RenameColumnOperation }; + if (obj.CastColumnTypeOperation !== undefined) return { CastColumnTypeOperation: obj.CastColumnTypeOperation }; + if (obj.TagColumnOperation !== undefined) + return { TagColumnOperation: TagColumnOperationFilterSensitiveLog(obj.TagColumnOperation) }; + if (obj.UntagColumnOperation !== undefined) return { UntagColumnOperation: obj.UntagColumnOperation }; + if (obj.OverrideDatasetParameterOperation !== undefined) + return { OverrideDatasetParameterOperation: obj.OverrideDatasetParameterOperation }; + if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; +}; + +/** + * @internal + */ +export const LogicalTableFilterSensitiveLog = (obj: LogicalTable): any => ({ + ...obj, + ...(obj.DataTransforms && { + DataTransforms: obj.DataTransforms.map((item) => TransformOperationFilterSensitiveLog(item)), + }), +}); + /** * @internal */ @@ -9623,17 +9521,3 @@ export const DescribeDataSetResponseFilterSensitiveLog = (obj: DescribeDataSetRe ...obj, ...(obj.DataSet && { DataSet: DataSetFilterSensitiveLog(obj.DataSet) }), }); - -/** - * @internal - */ -export const DescribeTemplateDefinitionResponseFilterSensitiveLog = (obj: DescribeTemplateDefinitionResponse): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const DescribeTopicResponseFilterSensitiveLog = (obj: DescribeTopicResponse): any => ({ - ...obj, -}); diff --git a/clients/client-quicksight/src/models/models_4.ts b/clients/client-quicksight/src/models/models_4.ts index c97abe6e291d..6a0eb47e1eb0 100644 --- a/clients/client-quicksight/src/models/models_4.ts +++ b/clients/client-quicksight/src/models/models_4.ts @@ -1,7 +1,7 @@ // smithy-typescript generated code import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client"; -import { AccountCustomization, ActiveIAMPolicyAssignment, ResourceStatus } from "./models_0"; +import { AccountCustomization, ActiveIAMPolicyAssignment, Entity, ResourceStatus, Sheet } from "./models_0"; import { _Parameters, @@ -26,22 +26,20 @@ import { AssignmentStatus, AuthorizedTargetsByService, BookmarksConfigurations, + BrandDefinition, + BrandDetail, + BrandSummary, + Capabilities, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DashboardVisualId, - DataSetImportMode, DatasetParameter, - DataSetUsageConfiguration, DataSourceParameters, - FieldFolder, FilterOperator, LinkSharingConfiguration, - LogicalTable, - LogicalTableFilterSensitiveLog, - PhysicalTable, ResourcePermission, ServiceType, SharedViewConfigurations, @@ -55,46 +53,1317 @@ import { VpcConnectionProperties, } from "./models_2"; -import { - DashboardSearchFilter, - DashboardSummary, - DashboardVersionSummary, - DataSetRefreshProperties, - DataSetSearchFilter, - DataSetSummary, - DataSource, - DataSourceCredentials, - DataSourceSearchFilter, - DataSourceSummary, - FolderType, - Group, - GroupMember, - IncludeFolderMembers, - Ingestion, - NamespaceInfoV2, - PersonalizationMode, - RefreshSchedule, - RegisteredCustomerManagedKey, - Role, - RowLevelPermissionDataSet, - RowLevelPermissionTagConfiguration, - RowLevelPermissionTagConfigurationFilterSensitiveLog, - SharingModel, - SnapshotConfiguration, - TemplateAlias, - TemplateSourceEntity, - TemplateVersionDefinition, - ThemeAlias, - ThemeConfiguration, - ThemeType, - TopicDetails, - TopicRefreshSchedule, - TopicUserExperienceVersion, - VPCConnectionAvailabilityStatus, - VPCConnectionResourceStatus, -} from "./models_3"; +import { + CustomPermissions, + DashboardSearchFilter, + DashboardSummary, + DashboardVersionSummary, + DataSetConfiguration, + DataSetImportMode, + DataSetRefreshProperties, + DataSetSearchFilter, + DataSetSummary, + DataSetUsageConfiguration, + DataSource, + DataSourceCredentials, + DataSourceSearchFilter, + DataSourceSummary, + FieldFolder, + FolderType, + Group, + GroupMember, + IdentityStore, + IncludeFolderMembers, + Ingestion, + LogicalTable, + LogicalTableFilterSensitiveLog, + NamespaceStatus, + PhysicalTable, + RefreshSchedule, + Role, + RowLevelPermissionDataSet, + RowLevelPermissionTagConfiguration, + RowLevelPermissionTagConfigurationFilterSensitiveLog, + SharingModel, + SnapshotConfiguration, + TemplateAlias, + TemplateSourceEntity, + TemplateVersionDefinition, + ThemeAlias, + ThemeConfiguration, + TopicDetails, + TopicRefreshSchedule, + TopicUserExperienceVersion, + VPCConnectionAvailabilityStatus, + VPCConnectionResourceStatus, +} from "./models_3"; + +import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException"; + +/** + * @public + */ +export interface DescribeIngestionResponse { + /** + *

Information about the ingestion.

+ * @public + */ + Ingestion?: Ingestion | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; +} + +/** + * @public + */ +export interface DescribeIpRestrictionRequest { + /** + *

The ID of the Amazon Web Services account that contains the IP rules.

+ * @public + */ + AwsAccountId: string | undefined; +} + +/** + * @public + */ +export interface DescribeIpRestrictionResponse { + /** + *

The ID of the Amazon Web Services account that contains the IP rules.

+ * @public + */ + AwsAccountId?: string | undefined; + + /** + *

A map that describes the IP rules with CIDR range and description.

+ * @public + */ + IpRestrictionRuleMap?: Record | undefined; + + /** + *

A map of allowed VPC IDs and their rule descriptions.

+ * @public + */ + VpcIdRestrictionRuleMap?: Record | undefined; + + /** + *

A map of allowed VPC endpoint IDs and their rule descriptions.

+ * @public + */ + VpcEndpointIdRestrictionRuleMap?: Record | undefined; + + /** + *

A value that specifies whether IP rules are turned on.

+ * @public + */ + Enabled?: boolean | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The HTTP status of the request. + *

+ * @public + */ + Status?: number | undefined; +} + +/** + * @public + */ +export interface DescribeKeyRegistrationRequest { + /** + *

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

Determines whether the request returns the default key only.

+ * @public + */ + DefaultKeyOnly?: boolean | undefined; +} + +/** + *

A customer managed key structure that contains the information listed below:

+ *
    + *
  • + *

    + * KeyArn - The ARN of a KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.

    + *
  • + *
  • + *

    + * DefaultKey - Indicates whether the current key is set as the default key for encryption and decryption use.

    + *
  • + *
+ * @public + */ +export interface RegisteredCustomerManagedKey { + /** + *

The ARN of the KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.

+ * @public + */ + KeyArn?: string | undefined; + + /** + *

Indicates whether a RegisteredCustomerManagedKey is set as the default key for encryption and decryption use.

+ * @public + */ + DefaultKey?: boolean | undefined; +} + +/** + * @public + */ +export interface DescribeKeyRegistrationResponse { + /** + *

The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request.

+ * @public + */ + AwsAccountId?: string | undefined; + + /** + *

A list of RegisteredCustomerManagedKey objects in a Amazon QuickSight account.

+ * @public + */ + KeyRegistration?: RegisteredCustomerManagedKey[] | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; +} + +/** + * @public + */ +export interface DescribeNamespaceRequest { + /** + *

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The namespace that you want to describe.

+ * @public + */ + Namespace: string | undefined; +} + +/** + * @public + * @enum + */ +export const NamespaceErrorType = { + INTERNAL_SERVICE_ERROR: "INTERNAL_SERVICE_ERROR", + PERMISSION_DENIED: "PERMISSION_DENIED", +} as const; + +/** + * @public + */ +export type NamespaceErrorType = (typeof NamespaceErrorType)[keyof typeof NamespaceErrorType]; + +/** + *

Errors that occur during namespace creation.

+ * @public + */ +export interface NamespaceError { + /** + *

The error type.

+ * @public + */ + Type?: NamespaceErrorType | undefined; + + /** + *

The message for the error.

+ * @public + */ + Message?: string | undefined; +} + +/** + *

The error type.

+ * @public + */ +export interface NamespaceInfoV2 { + /** + *

The name of the error.

+ * @public + */ + Name?: string | undefined; + + /** + *

The namespace ARN.

+ * @public + */ + Arn?: string | undefined; + + /** + *

The namespace Amazon Web Services Region.

+ * @public + */ + CapacityRegion?: string | undefined; + + /** + *

The creation status of a namespace that is not yet completely created.

+ * @public + */ + CreationStatus?: NamespaceStatus | undefined; + + /** + *

The identity store used for the namespace.

+ * @public + */ + IdentityStore?: IdentityStore | undefined; + + /** + *

An error that occurred when the namespace was created.

+ * @public + */ + NamespaceError?: NamespaceError | undefined; +} + +/** + * @public + */ +export interface DescribeNamespaceResponse { + /** + *

The information about the namespace that you're describing. The response includes + * the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also + * works for namespaces that are in the process of being created. For incomplete namespaces, + * this API operation lists the namespace error types and messages associated with the creation process.

+ * @public + */ + Namespace?: NamespaceInfoV2 | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; +} + +/** + * @public + */ +export interface DescribeQPersonalizationConfigurationRequest { + /** + *

The ID of the Amazon Web Services account that contains the personalization configuration that the user wants described.

+ * @public + */ + AwsAccountId: string | undefined; +} + +/** + * @public + * @enum + */ +export const PersonalizationMode = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", +} as const; + +/** + * @public + */ +export type PersonalizationMode = (typeof PersonalizationMode)[keyof typeof PersonalizationMode]; + +/** + * @public + */ +export interface DescribeQPersonalizationConfigurationResponse { + /** + *

A value that indicates whether personalization is enabled or not.

+ * @public + */ + PersonalizationMode?: PersonalizationMode | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; +} + +/** + * @public + */ +export interface DescribeRefreshScheduleRequest { + /** + *

The Amazon Web Services account ID.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID of the dataset.

+ * @public + */ + DataSetId: string | undefined; + + /** + *

The ID of the refresh schedule.

+ * @public + */ + ScheduleId: string | undefined; +} + +/** + * @public + */ +export interface DescribeRefreshScheduleResponse { + /** + *

The refresh schedule.

+ * @public + */ + RefreshSchedule?: RefreshSchedule | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) for the refresh schedule.

+ * @public + */ + Arn?: string | undefined; +} + +/** + * @public + */ +export interface DescribeRoleCustomPermissionRequest { + /** + *

The name of the role whose permissions you want described.

+ * @public + */ + Role: Role | undefined; + + /** + *

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The namespace that contains the role.

+ * @public + */ + Namespace: string | undefined; +} + +/** + * @public + */ +export interface DescribeRoleCustomPermissionResponse { + /** + *

The name of the custom permission that is described.

+ * @public + */ + CustomPermissionsName?: string | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; +} + +/** + * @public + */ +export interface DescribeTemplateRequest { + /** + *

The ID of the Amazon Web Services account that contains the template that you're describing.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID for the template.

+ * @public + */ + TemplateId: string | undefined; + + /** + *

(Optional) The number for the version to describe. If a VersionNumber parameter + * value isn't provided, the latest version of the template is described.

+ * @public + */ + VersionNumber?: number | undefined; + + /** + *

The alias of the template that you want to describe. If you name a specific alias, you + * describe the version that the alias points to. You can specify the latest version of the + * template by providing the keyword $LATEST in the AliasName + * parameter. The keyword $PUBLISHED doesn't apply to templates.

+ * @public + */ + AliasName?: string | undefined; +} + +/** + * @public + * @enum + */ +export const TemplateErrorType = { + ACCESS_DENIED: "ACCESS_DENIED", + DATA_SET_NOT_FOUND: "DATA_SET_NOT_FOUND", + INTERNAL_FAILURE: "INTERNAL_FAILURE", + SOURCE_NOT_FOUND: "SOURCE_NOT_FOUND", +} as const; + +/** + * @public + */ +export type TemplateErrorType = (typeof TemplateErrorType)[keyof typeof TemplateErrorType]; + +/** + *

List of errors that occurred when the template version creation failed.

+ * @public + */ +export interface TemplateError { + /** + *

Type of error.

+ * @public + */ + Type?: TemplateErrorType | undefined; + + /** + *

Description of the error type.

+ * @public + */ + Message?: string | undefined; + + /** + *

An error path that shows which entities caused the template error.

+ * @public + */ + ViolatedEntities?: Entity[] | undefined; +} + +/** + *

A version of a template.

+ * @public + */ +export interface TemplateVersion { + /** + *

The time that this template version was created.

+ * @public + */ + CreatedTime?: Date | undefined; + + /** + *

Errors associated with this template version.

+ * @public + */ + Errors?: TemplateError[] | undefined; + + /** + *

The version number of the template version.

+ * @public + */ + VersionNumber?: number | undefined; + + /** + *

The status that is associated with the template.

+ *
    + *
  • + *

    + * CREATION_IN_PROGRESS + *

    + *
  • + *
  • + *

    + * CREATION_SUCCESSFUL + *

    + *
  • + *
  • + *

    + * CREATION_FAILED + *

    + *
  • + *
  • + *

    + * UPDATE_IN_PROGRESS + *

    + *
  • + *
  • + *

    + * UPDATE_SUCCESSFUL + *

    + *
  • + *
  • + *

    + * UPDATE_FAILED + *

    + *
  • + *
  • + *

    + * DELETED + *

    + *
  • + *
+ * @public + */ + Status?: ResourceStatus | undefined; + + /** + *

Schema of the dataset identified by the placeholder. Any dashboard created from this + * template should be bound to new datasets matching the same schema described through this + * API operation.

+ * @public + */ + DataSetConfigurations?: DataSetConfiguration[] | undefined; + + /** + *

The description of the template.

+ * @public + */ + Description?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of an analysis or template that was used to create this + * template.

+ * @public + */ + SourceEntityArn?: string | undefined; + + /** + *

The ARN of the theme associated with this version of the template.

+ * @public + */ + ThemeArn?: string | undefined; + + /** + *

A list of the associated sheets with the unique identifier and name of each sheet.

+ * @public + */ + Sheets?: Sheet[] | undefined; +} + +/** + *

A template object. A template is an entity in Amazon QuickSight that + * encapsulates the metadata required to create an analysis and that you can use to create + * a dashboard. A template adds a layer of abstraction by using placeholders to replace the + * dataset associated with an analysis. You can use templates to create dashboards by + * replacing dataset placeholders with datasets that follow the same schema that was used + * to create the source analysis and template.

+ *

You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to + * create a template or a dashboard from an existing template.

+ * @public + */ +export interface Template { + /** + *

The Amazon Resource Name (ARN) of the template.

+ * @public + */ + Arn?: string | undefined; + + /** + *

The display name of the template.

+ * @public + */ + Name?: string | undefined; + + /** + *

A structure describing the versions of the template.

+ * @public + */ + Version?: TemplateVersion | undefined; + + /** + *

The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.

+ * @public + */ + TemplateId?: string | undefined; + + /** + *

Time when this was last updated.

+ * @public + */ + LastUpdatedTime?: Date | undefined; + + /** + *

Time when this was created.

+ * @public + */ + CreatedTime?: Date | undefined; +} + +/** + * @public + */ +export interface DescribeTemplateResponse { + /** + *

The template structure for the object you want to describe.

+ * @public + */ + Template?: Template | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; +} + +/** + * @public + */ +export interface DescribeTemplateAliasRequest { + /** + *

The ID of the Amazon Web Services account that contains the template alias that you're + * describing.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID for the template.

+ * @public + */ + TemplateId: string | undefined; + + /** + *

The name of the template alias that you want to describe. If you name a specific alias, you + * describe the version that the alias points to. You can specify the latest version of the + * template by providing the keyword $LATEST in the AliasName + * parameter. The keyword $PUBLISHED doesn't apply to templates.

+ * @public + */ + AliasName: string | undefined; +} + +/** + * @public + */ +export interface DescribeTemplateAliasResponse { + /** + *

Information about the template alias.

+ * @public + */ + TemplateAlias?: TemplateAlias | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; +} + +/** + * @public + */ +export interface DescribeTemplateDefinitionRequest { + /** + *

The ID of the Amazon Web Services account that contains the template. You must be using the + * Amazon Web Services account that the template is in.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID of the template that you're describing.

+ * @public + */ + TemplateId: string | undefined; + + /** + *

The version number of the template.

+ * @public + */ + VersionNumber?: number | undefined; + + /** + *

The alias of the template that you want to describe. If you name a specific alias, you + * describe the version that the alias points to. You can specify the latest version of the + * template by providing the keyword $LATEST in the AliasName + * parameter. The keyword $PUBLISHED doesn't apply to templates.

+ * @public + */ + AliasName?: string | undefined; +} + +/** + * @public + */ +export interface DescribeTemplateDefinitionResponse { + /** + *

The descriptive name of the template.

+ * @public + */ + Name?: string | undefined; + + /** + *

The ID of the template described.

+ * @public + */ + TemplateId?: string | undefined; + + /** + *

Errors associated with the template version.

+ * @public + */ + Errors?: TemplateError[] | undefined; + + /** + *

Status associated with the template.

+ *
    + *
  • + *

    + * CREATION_IN_PROGRESS + *

    + *
  • + *
  • + *

    + * CREATION_SUCCESSFUL + *

    + *
  • + *
  • + *

    + * CREATION_FAILED + *

    + *
  • + *
  • + *

    + * UPDATE_IN_PROGRESS + *

    + *
  • + *
  • + *

    + * UPDATE_SUCCESSFUL + *

    + *
  • + *
  • + *

    + * UPDATE_FAILED + *

    + *
  • + *
  • + *

    + * DELETED + *

    + *
  • + *
+ * @public + */ + ResourceStatus?: ResourceStatus | undefined; + + /** + *

The ARN of the theme of the template.

+ * @public + */ + ThemeArn?: string | undefined; + + /** + *

The definition of the template.

+ *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

+ * @public + */ + Definition?: TemplateVersionDefinition | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; +} + +/** + * @public + */ +export interface DescribeTemplatePermissionsRequest { + /** + *

The ID of the Amazon Web Services account that contains the template that you're describing.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID for the template.

+ * @public + */ + TemplateId: string | undefined; +} + +/** + * @public + */ +export interface DescribeTemplatePermissionsResponse { + /** + *

The ID for the template.

+ * @public + */ + TemplateId?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the template.

+ * @public + */ + TemplateArn?: string | undefined; + + /** + *

A list of resource permissions to be set on the template.

+ * @public + */ + Permissions?: ResourcePermission[] | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; +} + +/** + * @public + */ +export interface DescribeThemeRequest { + /** + *

The ID of the Amazon Web Services account that contains the theme that you're describing.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID for the theme.

+ * @public + */ + ThemeId: string | undefined; + + /** + *

The version number for the version to describe. If a VersionNumber parameter + * value isn't provided, the latest version of the theme is described.

+ * @public + */ + VersionNumber?: number | undefined; + + /** + *

The alias of the theme that you want to describe. If you name a specific alias, you + * describe the version that the alias points to. You can specify the latest version of the + * theme by providing the keyword $LATEST in the AliasName + * parameter. The keyword $PUBLISHED doesn't apply to themes.

+ * @public + */ + AliasName?: string | undefined; +} + +/** + * @public + * @enum + */ +export const ThemeType = { + ALL: "ALL", + CUSTOM: "CUSTOM", + QUICKSIGHT: "QUICKSIGHT", +} as const; + +/** + * @public + */ +export type ThemeType = (typeof ThemeType)[keyof typeof ThemeType]; + +/** + * @public + * @enum + */ +export const ThemeErrorType = { + INTERNAL_FAILURE: "INTERNAL_FAILURE", +} as const; + +/** + * @public + */ +export type ThemeErrorType = (typeof ThemeErrorType)[keyof typeof ThemeErrorType]; + +/** + *

Theme error.

+ * @public + */ +export interface ThemeError { + /** + *

The type of error.

+ * @public + */ + Type?: ThemeErrorType | undefined; + + /** + *

The error message.

+ * @public + */ + Message?: string | undefined; +} + +/** + *

A version of a theme.

+ * @public + */ +export interface ThemeVersion { + /** + *

The version number of the theme.

+ * @public + */ + VersionNumber?: number | undefined; + + /** + *

The Amazon Resource Name (ARN) of the resource.

+ * @public + */ + Arn?: string | undefined; + + /** + *

The description of the theme.

+ * @public + */ + Description?: string | undefined; + + /** + *

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All + * themes initially inherit from a default Amazon QuickSight theme.

+ * @public + */ + BaseThemeId?: string | undefined; + + /** + *

The date and time that this theme version was created.

+ * @public + */ + CreatedTime?: Date | undefined; + + /** + *

The theme configuration, which contains all the theme display properties.

+ * @public + */ + Configuration?: ThemeConfiguration | undefined; + + /** + *

Errors associated with the theme.

+ * @public + */ + Errors?: ThemeError[] | undefined; + + /** + *

The status of the theme version.

+ * @public + */ + Status?: ResourceStatus | undefined; +} + +/** + *

Summary information about a theme.

+ * @public + */ +export interface Theme { + /** + *

The Amazon Resource Name (ARN) of the theme.

+ * @public + */ + Arn?: string | undefined; + + /** + *

The name that the user gives to the theme.

+ * @public + */ + Name?: string | undefined; + + /** + *

The identifier that the user gives to the theme.

+ * @public + */ + ThemeId?: string | undefined; + + /** + *

A version of a theme.

+ * @public + */ + Version?: ThemeVersion | undefined; + + /** + *

The date and time that the theme was created.

+ * @public + */ + CreatedTime?: Date | undefined; + + /** + *

The date and time that the theme was last updated.

+ * @public + */ + LastUpdatedTime?: Date | undefined; + + /** + *

The type of theme, based on how it was created. Valid values include: + * QUICKSIGHT and CUSTOM.

+ * @public + */ + Type?: ThemeType | undefined; +} + +/** + * @public + */ +export interface DescribeThemeResponse { + /** + *

The information about the theme that you are describing.

+ * @public + */ + Theme?: Theme | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; +} + +/** + * @public + */ +export interface DescribeThemeAliasRequest { + /** + *

The ID of the Amazon Web Services account that contains the theme alias that you're + * describing.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID for the theme.

+ * @public + */ + ThemeId: string | undefined; + + /** + *

The name of the theme alias that you want to describe.

+ * @public + */ + AliasName: string | undefined; +} + +/** + * @public + */ +export interface DescribeThemeAliasResponse { + /** + *

Information about the theme alias.

+ * @public + */ + ThemeAlias?: ThemeAlias | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; +} -import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException"; +/** + * @public + */ +export interface DescribeThemePermissionsRequest { + /** + *

The ID of the Amazon Web Services account that contains the theme that you're describing.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID for the theme that you want to describe permissions for.

+ * @public + */ + ThemeId: string | undefined; +} + +/** + * @public + */ +export interface DescribeThemePermissionsResponse { + /** + *

The ID for the theme.

+ * @public + */ + ThemeId?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the theme.

+ * @public + */ + ThemeArn?: string | undefined; + + /** + *

A list of resource permissions set on the theme.

+ * @public + */ + Permissions?: ResourcePermission[] | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; +} + +/** + * @public + */ +export interface DescribeTopicRequest { + /** + *

The Amazon Web Services account ID.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ * @public + */ + TopicId: string | undefined; +} + +/** + * @public + */ +export interface DescribeTopicResponse { + /** + *

The Amazon Resource Name (ARN) of the topic.

+ * @public + */ + Arn?: string | undefined; + + /** + *

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ * @public + */ + TopicId?: string | undefined; + + /** + *

The definition of a topic.

+ * @public + */ + Topic?: TopicDetails | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; +} + +/** + * @public + */ +export interface DescribeTopicPermissionsRequest { + /** + *

The ID of the Amazon Web Services account that contains the topic that you want + * described.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ * @public + */ + TopicId: string | undefined; +} /** * @public @@ -1720,51 +2989,127 @@ export interface IAMPolicyAssignmentSummary { } /** - *

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

* @public */ -export class InvalidRequestException extends __BaseException { - readonly name: "InvalidRequestException" = "InvalidRequestException"; - readonly $fault: "client" = "client"; - Message?: string | undefined; +export interface ListAnalysesRequest { /** - *

The Amazon Web Services request ID for this request.

+ *

The ID of the Amazon Web Services account that contains the analyses.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

A pagination token that can be used in a subsequent request.

+ * @public + */ + NextToken?: string | undefined; + + /** + *

The maximum number of results to return.

+ * @public + */ + MaxResults?: number | undefined; +} + +/** + * @public + */ +export interface ListAnalysesResponse { + /** + *

Metadata describing each of the analyses that are listed.

+ * @public + */ + AnalysisSummaryList?: AnalysisSummary[] | undefined; + + /** + *

A pagination token that can be used in a subsequent request.

+ * @public + */ + NextToken?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; +} + +/** + * @public + */ +export interface ListAssetBundleExportJobsRequest { /** - * @internal + *

The ID of the Amazon Web Services account that the export jobs were executed in.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "InvalidRequestException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, InvalidRequestException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } + AwsAccountId: string | undefined; + + /** + *

The token for the next set of results, or null if there are no more results.

+ * @public + */ + NextToken?: string | undefined; + + /** + *

The maximum number of results to be returned per request.

+ * @public + */ + MaxResults?: number | undefined; } /** * @public */ -export interface ListAnalysesRequest { +export interface ListAssetBundleExportJobsResponse { + /** + *

A list of export job summaries.

+ * @public + */ + AssetBundleExportJobSummaryList?: AssetBundleExportJobSummary[] | undefined; + + /** + *

The token for the next set of results, or null if there are no more results.

+ * @public + */ + NextToken?: string | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; +} + +/** + * @public + */ +export interface ListAssetBundleImportJobsRequest { /** - *

The ID of the Amazon Web Services account that contains the analyses.

+ *

The ID of the Amazon Web Services account that the import jobs were executed in.

* @public */ AwsAccountId: string | undefined; /** - *

A pagination token that can be used in a subsequent request.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ NextToken?: string | undefined; /** - *

The maximum number of results to return.

+ *

The maximum number of results to be returned per request.

* @public */ MaxResults?: number | undefined; @@ -1773,65 +3118,59 @@ export interface ListAnalysesRequest { /** * @public */ -export interface ListAnalysesResponse { +export interface ListAssetBundleImportJobsResponse { /** - *

Metadata describing each of the analyses that are listed.

+ *

A list of import job summaries.

* @public */ - AnalysisSummaryList?: AnalysisSummary[] | undefined; + AssetBundleImportJobSummaryList?: AssetBundleImportJobSummary[] | undefined; /** - *

A pagination token that can be used in a subsequent request.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ NextToken?: string | undefined; /** - *

The HTTP status of the request.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Status?: number | undefined; + RequestId?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The HTTP status of the response.

* @public */ - RequestId?: string | undefined; + Status?: number | undefined; } /** * @public */ -export interface ListAssetBundleExportJobsRequest { +export interface ListBrandsRequest { /** - *

The ID of the Amazon Web Services account that the export jobs were executed in.

+ *

The ID of the Amazon Web Services account that owns the brands that you want to list.

* @public */ AwsAccountId: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The maximum number of results to be returned in a single request.

* @public */ - NextToken?: string | undefined; + MaxResults?: number | undefined; /** - *

The maximum number of results to be returned per request.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - MaxResults?: number | undefined; + NextToken?: string | undefined; } /** * @public */ -export interface ListAssetBundleExportJobsResponse { - /** - *

A list of export job summaries.

- * @public - */ - AssetBundleExportJobSummaryList?: AssetBundleExportJobSummary[] | undefined; - +export interface ListBrandsResponse { /** *

The token for the next set of results, or null if there are no more results.

* @public @@ -1839,68 +3178,63 @@ export interface ListAssetBundleExportJobsResponse { NextToken?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; - - /** - *

The HTTP status of the request.

+ *

A list of all brands in your Amazon Web Services account. This structure provides basic + * information about each brand.

* @public */ - Status?: number | undefined; + Brands?: BrandSummary[] | undefined; } /** * @public */ -export interface ListAssetBundleImportJobsRequest { +export interface ListCustomPermissionsRequest { /** - *

The ID of the Amazon Web Services account that the import jobs were executed in.

+ *

The ID of the Amazon Web Services account that contains the custom permissions profiles that you want to list.

* @public */ AwsAccountId: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The maximum number of results to return.

* @public */ - NextToken?: string | undefined; + MaxResults?: number | undefined; /** - *

The maximum number of results to be returned per request.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - MaxResults?: number | undefined; + NextToken?: string | undefined; } /** * @public */ -export interface ListAssetBundleImportJobsResponse { +export interface ListCustomPermissionsResponse { /** - *

A list of import job summaries.

+ *

The HTTP status of the request.

* @public */ - AssetBundleImportJobSummaryList?: AssetBundleImportJobSummary[] | undefined; + Status?: number | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

A list of custom permissions profiles.

* @public */ - NextToken?: string | undefined; + CustomPermissionsList?: CustomPermissions[] | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - RequestId?: string | undefined; + NextToken?: string | undefined; /** - *

The HTTP status of the response.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Status?: number | undefined; + RequestId?: string | undefined; } /** @@ -5191,6 +6525,172 @@ export interface UpdateAnalysisPermissionsResponse { Status?: number | undefined; } +/** + * @public + */ +export interface UpdateBrandRequest { + /** + *

The ID of the Amazon Web Services account that owns the brand.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID of the Amazon QuickSight brand.

+ * @public + */ + BrandId: string | undefined; + + /** + *

The definition of the brand.

+ * @public + */ + BrandDefinition?: BrandDefinition | undefined; +} + +/** + * @public + */ +export interface UpdateBrandResponse { + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The details of the brand.

+ * @public + */ + BrandDetail?: BrandDetail | undefined; + + /** + *

The definition of the brand.

+ * @public + */ + BrandDefinition?: BrandDefinition | undefined; +} + +/** + * @public + */ +export interface UpdateBrandAssignmentRequest { + /** + *

The ID of the Amazon Web Services account that owns the brand assignment.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the brand.

+ * @public + */ + BrandArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateBrandAssignmentResponse { + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the brand.

+ * @public + */ + BrandArn?: string | undefined; +} + +/** + * @public + */ +export interface UpdateBrandPublishedVersionRequest { + /** + *

The ID of the Amazon Web Services account that owns the brand.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID of the Amazon QuickSight brand.

+ * @public + */ + BrandId: string | undefined; + + /** + *

The ID of the published version.

+ * @public + */ + VersionId: string | undefined; +} + +/** + * @public + */ +export interface UpdateBrandPublishedVersionResponse { + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The ID of the published version.

+ * @public + */ + VersionId?: string | undefined; +} + +/** + * @public + */ +export interface UpdateCustomPermissionsRequest { + /** + *

The ID of the Amazon Web Services account that contains the custom permissions profile that you want to update.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The name of the custom permissions profile that you want to update.

+ * @public + */ + CustomPermissionsName: string | undefined; + + /** + *

A set of actions to include in the custom permissions profile.

+ * @public + */ + Capabilities?: Capabilities | undefined; +} + +/** + * @public + */ +export interface UpdateCustomPermissionsResponse { + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; + + /** + *

The Amazon Resource Name (ARN) of the custom permissions profile.

+ * @public + */ + Arn?: string | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; +} + /** * @public */ @@ -7307,6 +8807,52 @@ export interface UpdateUserResponse { Status?: number | undefined; } +/** + * @public + */ +export interface UpdateUserCustomPermissionRequest { + /** + *

The username of the user that you want to update custom permissions for.

+ * @public + */ + UserName: string | undefined; + + /** + *

The ID of the Amazon Web Services account that contains the custom permission configuration that you want to update.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The namespace that the user belongs to.

+ * @public + */ + Namespace: string | undefined; + + /** + *

The name of the custom permissions that you want to update.

+ * @public + */ + CustomPermissionsName: string | undefined; +} + +/** + * @public + */ +export interface UpdateUserCustomPermissionResponse { + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; +} + /** * @public */ @@ -7576,6 +9122,20 @@ export interface ListTopicReviewedAnswersResponse { RequestId?: string | undefined; } +/** + * @internal + */ +export const DescribeTemplateDefinitionResponseFilterSensitiveLog = (obj: DescribeTemplateDefinitionResponse): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DescribeTopicResponseFilterSensitiveLog = (obj: DescribeTopicResponse): any => ({ + ...obj, +}); + /** * @internal */ diff --git a/clients/client-quicksight/src/pagination/ListBrandsPaginator.ts b/clients/client-quicksight/src/pagination/ListBrandsPaginator.ts new file mode 100644 index 000000000000..c137438b7139 --- /dev/null +++ b/clients/client-quicksight/src/pagination/ListBrandsPaginator.ts @@ -0,0 +1,20 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { ListBrandsCommand, ListBrandsCommandInput, ListBrandsCommandOutput } from "../commands/ListBrandsCommand"; +import { QuickSightClient } from "../QuickSightClient"; +import { QuickSightPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListBrands: ( + config: QuickSightPaginationConfiguration, + input: ListBrandsCommandInput, + ...rest: any[] +) => Paginator = createPaginator< + QuickSightPaginationConfiguration, + ListBrandsCommandInput, + ListBrandsCommandOutput +>(QuickSightClient, ListBrandsCommand, "NextToken", "NextToken", "MaxResults"); diff --git a/clients/client-quicksight/src/pagination/ListCustomPermissionsPaginator.ts b/clients/client-quicksight/src/pagination/ListCustomPermissionsPaginator.ts new file mode 100644 index 000000000000..3baf7e887838 --- /dev/null +++ b/clients/client-quicksight/src/pagination/ListCustomPermissionsPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListCustomPermissionsCommand, + ListCustomPermissionsCommandInput, + ListCustomPermissionsCommandOutput, +} from "../commands/ListCustomPermissionsCommand"; +import { QuickSightClient } from "../QuickSightClient"; +import { QuickSightPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListCustomPermissions: ( + config: QuickSightPaginationConfiguration, + input: ListCustomPermissionsCommandInput, + ...rest: any[] +) => Paginator = createPaginator< + QuickSightPaginationConfiguration, + ListCustomPermissionsCommandInput, + ListCustomPermissionsCommandOutput +>(QuickSightClient, ListCustomPermissionsCommand, "NextToken", "NextToken", "MaxResults"); diff --git a/clients/client-quicksight/src/pagination/index.ts b/clients/client-quicksight/src/pagination/index.ts index bcec1e961918..159aa2685f12 100644 --- a/clients/client-quicksight/src/pagination/index.ts +++ b/clients/client-quicksight/src/pagination/index.ts @@ -6,6 +6,8 @@ export * from "./Interfaces"; export * from "./ListAnalysesPaginator"; export * from "./ListAssetBundleExportJobsPaginator"; export * from "./ListAssetBundleImportJobsPaginator"; +export * from "./ListBrandsPaginator"; +export * from "./ListCustomPermissionsPaginator"; export * from "./ListDashboardVersionsPaginator"; export * from "./ListDashboardsPaginator"; export * from "./ListDataSetsPaginator"; diff --git a/clients/client-quicksight/src/protocols/Aws_restJson1.ts b/clients/client-quicksight/src/protocols/Aws_restJson1.ts index 82dc9ca73196..d669524c3d06 100644 --- a/clients/client-quicksight/src/protocols/Aws_restJson1.ts +++ b/clients/client-quicksight/src/protocols/Aws_restJson1.ts @@ -51,6 +51,11 @@ import { CreateAccountSubscriptionCommandOutput, } from "../commands/CreateAccountSubscriptionCommand"; import { CreateAnalysisCommandInput, CreateAnalysisCommandOutput } from "../commands/CreateAnalysisCommand"; +import { CreateBrandCommandInput, CreateBrandCommandOutput } from "../commands/CreateBrandCommand"; +import { + CreateCustomPermissionsCommandInput, + CreateCustomPermissionsCommandOutput, +} from "../commands/CreateCustomPermissionsCommand"; import { CreateDashboardCommandInput, CreateDashboardCommandOutput } from "../commands/CreateDashboardCommand"; import { CreateDataSetCommandInput, CreateDataSetCommandOutput } from "../commands/CreateDataSetCommand"; import { CreateDataSourceCommandInput, CreateDataSourceCommandOutput } from "../commands/CreateDataSourceCommand"; @@ -103,6 +108,15 @@ import { DeleteAccountSubscriptionCommandOutput, } from "../commands/DeleteAccountSubscriptionCommand"; import { DeleteAnalysisCommandInput, DeleteAnalysisCommandOutput } from "../commands/DeleteAnalysisCommand"; +import { + DeleteBrandAssignmentCommandInput, + DeleteBrandAssignmentCommandOutput, +} from "../commands/DeleteBrandAssignmentCommand"; +import { DeleteBrandCommandInput, DeleteBrandCommandOutput } from "../commands/DeleteBrandCommand"; +import { + DeleteCustomPermissionsCommandInput, + DeleteCustomPermissionsCommandOutput, +} from "../commands/DeleteCustomPermissionsCommand"; import { DeleteDashboardCommandInput, DeleteDashboardCommandOutput } from "../commands/DeleteDashboardCommand"; import { DeleteDataSetCommandInput, DeleteDataSetCommandOutput } from "../commands/DeleteDataSetCommand"; import { @@ -158,6 +172,10 @@ import { DeleteUserByPrincipalIdCommandOutput, } from "../commands/DeleteUserByPrincipalIdCommand"; import { DeleteUserCommandInput, DeleteUserCommandOutput } from "../commands/DeleteUserCommand"; +import { + DeleteUserCustomPermissionCommandInput, + DeleteUserCustomPermissionCommandOutput, +} from "../commands/DeleteUserCustomPermissionCommand"; import { DeleteVPCConnectionCommandInput, DeleteVPCConnectionCommandOutput, @@ -191,6 +209,19 @@ import { DescribeAssetBundleImportJobCommandInput, DescribeAssetBundleImportJobCommandOutput, } from "../commands/DescribeAssetBundleImportJobCommand"; +import { + DescribeBrandAssignmentCommandInput, + DescribeBrandAssignmentCommandOutput, +} from "../commands/DescribeBrandAssignmentCommand"; +import { DescribeBrandCommandInput, DescribeBrandCommandOutput } from "../commands/DescribeBrandCommand"; +import { + DescribeBrandPublishedVersionCommandInput, + DescribeBrandPublishedVersionCommandOutput, +} from "../commands/DescribeBrandPublishedVersionCommand"; +import { + DescribeCustomPermissionsCommandInput, + DescribeCustomPermissionsCommandOutput, +} from "../commands/DescribeCustomPermissionsCommand"; import { DescribeDashboardCommandInput, DescribeDashboardCommandOutput } from "../commands/DescribeDashboardCommand"; import { DescribeDashboardDefinitionCommandInput, @@ -321,6 +352,11 @@ import { ListAssetBundleImportJobsCommandInput, ListAssetBundleImportJobsCommandOutput, } from "../commands/ListAssetBundleImportJobsCommand"; +import { ListBrandsCommandInput, ListBrandsCommandOutput } from "../commands/ListBrandsCommand"; +import { + ListCustomPermissionsCommandInput, + ListCustomPermissionsCommandOutput, +} from "../commands/ListCustomPermissionsCommand"; import { ListDashboardsCommandInput, ListDashboardsCommandOutput } from "../commands/ListDashboardsCommand"; import { ListDashboardVersionsCommandInput, @@ -432,6 +468,19 @@ import { UpdateAnalysisPermissionsCommandInput, UpdateAnalysisPermissionsCommandOutput, } from "../commands/UpdateAnalysisPermissionsCommand"; +import { + UpdateBrandAssignmentCommandInput, + UpdateBrandAssignmentCommandOutput, +} from "../commands/UpdateBrandAssignmentCommand"; +import { UpdateBrandCommandInput, UpdateBrandCommandOutput } from "../commands/UpdateBrandCommand"; +import { + UpdateBrandPublishedVersionCommandInput, + UpdateBrandPublishedVersionCommandOutput, +} from "../commands/UpdateBrandPublishedVersionCommand"; +import { + UpdateCustomPermissionsCommandInput, + UpdateCustomPermissionsCommandOutput, +} from "../commands/UpdateCustomPermissionsCommand"; import { UpdateDashboardCommandInput, UpdateDashboardCommandOutput } from "../commands/UpdateDashboardCommand"; import { UpdateDashboardLinksCommandInput, @@ -522,6 +571,10 @@ import { UpdateTopicRefreshScheduleCommandOutput, } from "../commands/UpdateTopicRefreshScheduleCommand"; import { UpdateUserCommandInput, UpdateUserCommandOutput } from "../commands/UpdateUserCommand"; +import { + UpdateUserCustomPermissionCommandInput, + UpdateUserCustomPermissionCommandOutput, +} from "../commands/UpdateUserCustomPermissionCommand"; import { UpdateVPCConnectionCommandInput, UpdateVPCConnectionCommandOutput, @@ -1023,6 +1076,7 @@ import { AnonymousUserEmbeddingExperienceConfiguration, AnonymousUserGenerativeQnAEmbeddingConfiguration, AnonymousUserQSearchBarEmbeddingConfiguration, + ApplicationTheme, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportJobAnalysisOverrideProperties, AssetBundleExportJobAnalysisPropertyToOverride, @@ -1083,7 +1137,13 @@ import { BigQueryParameters, BookmarksConfigurations, BorderStyle, + BrandColorPalette, + BrandDefinition, + BrandDetail, + BrandElementStyle, + BrandSummary, CalculatedColumn, + Capabilities, CastColumnTypeOperation, CellValueSynonym, CollectiveConstant, @@ -1102,7 +1162,6 @@ import { ContributionAnalysisFactor, ContributionAnalysisTimeRanges, CreateColumnsOperation, - CustomSql, DashboardPublishOptions, DashboardSourceEntity, DashboardSourceTemplate, @@ -1115,7 +1174,6 @@ import { DataPointTooltipOption, DatasetParameter, DataSetReference, - DataSetUsageConfiguration, DataSourceParameters, DateTimeDatasetParameter, DateTimeDatasetParameterDefaultValues, @@ -1128,51 +1186,46 @@ import { ExportHiddenFieldsOption, ExportToCSVOption, ExportWithHiddenFieldsOption, - FieldFolder, FilterAggMetrics, - FilterOperation, GeoSpatialColumnGroup, Identifier, IdentityCenterConfiguration, - InputColumn, + ImageConfiguration, + ImageSetConfiguration, + ImageSource, IntegerDatasetParameter, IntegerDatasetParameterDefaultValues, IntegerParameter, InternalFailureException, + InternalServerException, InvalidParameterValueException, + InvalidRequestException, JiraParameters, - JoinInstruction, - JoinKeyProperties, LimitExceededException, LinkSharingConfiguration, - LogicalTable, - LogicalTableSource, + LogoConfiguration, + LogoSetConfiguration, ManifestFileLocation, MariaDbParameters, MySqlParameters, NamedEntityRef, + NavbarStyle, NegativeFormat, - NewDefaultValues, OAuthParameters, OracleParameters, - OverrideDatasetParameterOperation, - PhysicalTable, + Palette, PostgreSqlParameters, PreconditionNotMetException, PrestoParameters, - ProjectOperation, RdsParameters, RedshiftIAMParameters, RedshiftParameters, - RelationalTable, - RenameColumnOperation, ResourceExistsException, ResourceNotFoundException, ResourcePermission, ResourceUnavailableException, S3BucketConfiguration, S3Parameters, - S3Source, ServiceNowParameters, SharedViewConfigurations, SheetControlsOption, @@ -1191,7 +1244,6 @@ import { StringDatasetParameterDefaultValues, StringParameter, Tag, - TagColumnOperation, TeradataParameters, ThrottlingException, TopicConstantValue, @@ -1203,14 +1255,11 @@ import { TopicIRMetric, TopicSortClause, TopicTemplate, - TransformOperation, TreeMapConfiguration, TreeMapVisual, TrinoParameters, TwitterParameters, UnsupportedUserEditionException, - UntagColumnOperation, - UploadSettings, ValidationStrategy, Visual, VisualAxisSortOption, @@ -1234,6 +1283,7 @@ import { import { CredentialPair, CustomerManagedKeyUnavailableException, + CustomSql, Dashboard, DashboardSearchFilter, DashboardSummary, @@ -1248,29 +1298,43 @@ import { DataSetSchema, DataSetSearchFilter, DataSetSummary, + DataSetUsageConfiguration, DataSource, DataSourceCredentials, DataSourceSearchFilter, DataSourceSummary, DefaultFormatting, + FieldFolder, + FilterOperation, Folder, Font, GutterStyle, IncrementalRefresh, Ingestion, + InputColumn, InvalidNextTokenException, + JoinInstruction, + JoinKeyProperties, + LogicalTable, + LogicalTableSource, LookbackWindow, MarginStyle, NamedEntityDefinition, NamedEntityDefinitionMetric, + NewDefaultValues, + OverrideDatasetParameterOperation, + PhysicalTable, + ProjectOperation, RangeConstant, RefreshConfiguration, RefreshFrequency, RefreshSchedule, - RegisteredCustomerManagedKey, + RelationalTable, + RenameColumnOperation, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, RowLevelPermissionTagRule, + S3Source, ScheduleRefreshOnEntity, SemanticEntityType, SemanticType, @@ -1278,15 +1342,12 @@ import { SnapshotConfiguration, SnapshotDestinationConfiguration, SnapshotFileGroup, - Template, + TagColumnOperation, TemplateSourceAnalysis, TemplateSourceEntity, TemplateSourceTemplate, - TemplateVersion, TemplateVersionDefinition, - Theme, ThemeConfiguration, - ThemeVersion, TileLayoutStyle, TileStyle, TopicCalculatedField, @@ -1304,8 +1365,11 @@ import { TopicRefreshSchedule, TopicRelativeDateFilter, TopicSingularFilterConstant, + TransformOperation, Typography, UIColorPalette, + UntagColumnOperation, + UploadSettings, } from "../models/models_3"; import { CreateTopicReviewedAnswer, @@ -1314,8 +1378,8 @@ import { FolderSummary, GroupSearchFilter, IdentityTypeNotSupportedException, - InvalidRequestException, QuickSightUserNotFoundException, + RegisteredCustomerManagedKey, RegisteredUserConsoleFeatureConfigurations, RegisteredUserDashboardEmbeddingConfiguration, RegisteredUserDashboardFeatureConfigurations, @@ -1329,9 +1393,13 @@ import { SnapshotAnonymousUser, SnapshotUserConfiguration, StatePersistenceConfigurations, + Template, TemplateSummary, + TemplateVersion, TemplateVersionSummary, + Theme, ThemeSummary, + ThemeVersion, ThemeVersionSummary, TopicRefreshScheduleSummary, TopicReviewedAnswer, @@ -1507,6 +1575,56 @@ export const se_CreateAnalysisCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1CreateBrandCommand + */ +export const se_CreateBrandCommand = async ( + input: CreateBrandCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = { + "content-type": "application/json", + }; + b.bp("/accounts/{AwsAccountId}/brands/{BrandId}"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + b.p("BrandId", () => input.BrandId!, "{BrandId}", false); + let body: any; + body = JSON.stringify( + take(input, { + BrandDefinition: (_) => _json(_), + Tags: (_) => _json(_), + }) + ); + b.m("POST").h(headers).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1CreateCustomPermissionsCommand + */ +export const se_CreateCustomPermissionsCommand = async ( + input: CreateCustomPermissionsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = { + "content-type": "application/json", + }; + b.bp("/accounts/{AwsAccountId}/custom-permissions"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + let body: any; + body = JSON.stringify( + take(input, { + Capabilities: (_) => _json(_), + CustomPermissionsName: [], + Tags: (_) => _json(_), + }) + ); + b.m("POST").h(headers).b(body); + return b.build(); +}; + /** * serializeAws_restJson1CreateDashboardCommand */ @@ -2069,6 +2187,56 @@ export const se_DeleteAnalysisCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1DeleteBrandCommand + */ +export const se_DeleteBrandCommand = async ( + input: DeleteBrandCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/accounts/{AwsAccountId}/brands/{BrandId}"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + b.p("BrandId", () => input.BrandId!, "{BrandId}", false); + let body: any; + b.m("DELETE").h(headers).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1DeleteBrandAssignmentCommand + */ +export const se_DeleteBrandAssignmentCommand = async ( + input: DeleteBrandAssignmentCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/accounts/{AwsAccountId}/brandassignments"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + let body: any; + b.m("DELETE").h(headers).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1DeleteCustomPermissionsCommand + */ +export const se_DeleteCustomPermissionsCommand = async ( + input: DeleteCustomPermissionsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/accounts/{AwsAccountId}/custom-permissions/{CustomPermissionsName}"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + b.p("CustomPermissionsName", () => input.CustomPermissionsName!, "{CustomPermissionsName}", false); + let body: any; + b.m("DELETE").h(headers).b(body); + return b.build(); +}; + /** * serializeAws_restJson1DeleteDashboardCommand */ @@ -2467,6 +2635,24 @@ export const se_DeleteUserByPrincipalIdCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1DeleteUserCustomPermissionCommand + */ +export const se_DeleteUserCustomPermissionCommand = async ( + input: DeleteUserCustomPermissionCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/custom-permission"); + b.p("UserName", () => input.UserName!, "{UserName}", false); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + b.p("Namespace", () => input.Namespace!, "{Namespace}", false); + let body: any; + b.m("DELETE").h(headers).b(body); + return b.build(); +}; + /** * serializeAws_restJson1DeleteVPCConnectionCommand */ @@ -2621,6 +2807,76 @@ export const se_DescribeAssetBundleImportJobCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1DescribeBrandCommand + */ +export const se_DescribeBrandCommand = async ( + input: DescribeBrandCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/accounts/{AwsAccountId}/brands/{BrandId}"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + b.p("BrandId", () => input.BrandId!, "{BrandId}", false); + const query: any = map({ + [_vI]: [, input[_VI]!], + }); + let body: any; + b.m("GET").h(headers).q(query).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1DescribeBrandAssignmentCommand + */ +export const se_DescribeBrandAssignmentCommand = async ( + input: DescribeBrandAssignmentCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/accounts/{AwsAccountId}/brandassignments"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + let body: any; + b.m("GET").h(headers).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1DescribeBrandPublishedVersionCommand + */ +export const se_DescribeBrandPublishedVersionCommand = async ( + input: DescribeBrandPublishedVersionCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/accounts/{AwsAccountId}/brands/{BrandId}/publishedversion"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + b.p("BrandId", () => input.BrandId!, "{BrandId}", false); + let body: any; + b.m("GET").h(headers).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1DescribeCustomPermissionsCommand + */ +export const se_DescribeCustomPermissionsCommand = async ( + input: DescribeCustomPermissionsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/accounts/{AwsAccountId}/custom-permissions/{CustomPermissionsName}"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + b.p("CustomPermissionsName", () => input.CustomPermissionsName!, "{CustomPermissionsName}", false); + let body: any; + b.m("GET").h(headers).b(body); + return b.build(); +}; + /** * serializeAws_restJson1DescribeDashboardCommand */ @@ -3439,6 +3695,46 @@ export const se_ListAssetBundleImportJobsCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1ListBrandsCommand + */ +export const se_ListBrandsCommand = async ( + input: ListBrandsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/accounts/{AwsAccountId}/brands"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + const query: any = map({ + [_mr]: [() => input.MaxResults !== void 0, () => input[_MR]!.toString()], + [_nt]: [, input[_NT]!], + }); + let body: any; + b.m("GET").h(headers).q(query).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1ListCustomPermissionsCommand + */ +export const se_ListCustomPermissionsCommand = async ( + input: ListCustomPermissionsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/accounts/{AwsAccountId}/custom-permissions"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + const query: any = map({ + [_mr]: [() => input.MaxResults !== void 0, () => input[_MR]!.toString()], + [_nt]: [, input[_NT]!], + }); + let body: any; + b.m("GET").h(headers).q(query).b(body); + return b.build(); +}; + /** * serializeAws_restJson1ListDashboardsCommand */ @@ -4511,30 +4807,23 @@ export const se_UpdateAnalysisPermissionsCommand = async ( }; /** - * serializeAws_restJson1UpdateDashboardCommand + * serializeAws_restJson1UpdateBrandCommand */ -export const se_UpdateDashboardCommand = async ( - input: UpdateDashboardCommandInput, +export const se_UpdateBrandCommand = async ( + input: UpdateBrandCommandInput, context: __SerdeContext ): Promise<__HttpRequest> => { const b = rb(input, context); const headers: any = { "content-type": "application/json", }; - b.bp("/accounts/{AwsAccountId}/dashboards/{DashboardId}"); + b.bp("/accounts/{AwsAccountId}/brands/{BrandId}"); b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); - b.p("DashboardId", () => input.DashboardId!, "{DashboardId}", false); + b.p("BrandId", () => input.BrandId!, "{BrandId}", false); let body: any; body = JSON.stringify( take(input, { - DashboardPublishOptions: (_) => _json(_), - Definition: (_) => se_DashboardVersionDefinition(_, context), - Name: [], - Parameters: (_) => se__Parameters(_, context), - SourceEntity: (_) => _json(_), - ThemeArn: [], - ValidationStrategy: (_) => _json(_), - VersionDescription: [], + BrandDefinition: (_) => _json(_), }) ); b.m("PUT").h(headers).b(body); @@ -4542,23 +4831,22 @@ export const se_UpdateDashboardCommand = async ( }; /** - * serializeAws_restJson1UpdateDashboardLinksCommand + * serializeAws_restJson1UpdateBrandAssignmentCommand */ -export const se_UpdateDashboardLinksCommand = async ( - input: UpdateDashboardLinksCommandInput, +export const se_UpdateBrandAssignmentCommand = async ( + input: UpdateBrandAssignmentCommandInput, context: __SerdeContext ): Promise<__HttpRequest> => { const b = rb(input, context); const headers: any = { "content-type": "application/json", }; - b.bp("/accounts/{AwsAccountId}/dashboards/{DashboardId}/linked-entities"); + b.bp("/accounts/{AwsAccountId}/brandassignments"); b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); - b.p("DashboardId", () => input.DashboardId!, "{DashboardId}", false); let body: any; body = JSON.stringify( take(input, { - LinkEntities: (_) => _json(_), + BrandArn: [], }) ); b.m("PUT").h(headers).b(body); @@ -4566,9 +4854,112 @@ export const se_UpdateDashboardLinksCommand = async ( }; /** - * serializeAws_restJson1UpdateDashboardPermissionsCommand + * serializeAws_restJson1UpdateBrandPublishedVersionCommand */ -export const se_UpdateDashboardPermissionsCommand = async ( +export const se_UpdateBrandPublishedVersionCommand = async ( + input: UpdateBrandPublishedVersionCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = { + "content-type": "application/json", + }; + b.bp("/accounts/{AwsAccountId}/brands/{BrandId}/publishedversion"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + b.p("BrandId", () => input.BrandId!, "{BrandId}", false); + let body: any; + body = JSON.stringify( + take(input, { + VersionId: [], + }) + ); + b.m("PUT").h(headers).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1UpdateCustomPermissionsCommand + */ +export const se_UpdateCustomPermissionsCommand = async ( + input: UpdateCustomPermissionsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = { + "content-type": "application/json", + }; + b.bp("/accounts/{AwsAccountId}/custom-permissions/{CustomPermissionsName}"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + b.p("CustomPermissionsName", () => input.CustomPermissionsName!, "{CustomPermissionsName}", false); + let body: any; + body = JSON.stringify( + take(input, { + Capabilities: (_) => _json(_), + }) + ); + b.m("PUT").h(headers).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1UpdateDashboardCommand + */ +export const se_UpdateDashboardCommand = async ( + input: UpdateDashboardCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = { + "content-type": "application/json", + }; + b.bp("/accounts/{AwsAccountId}/dashboards/{DashboardId}"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + b.p("DashboardId", () => input.DashboardId!, "{DashboardId}", false); + let body: any; + body = JSON.stringify( + take(input, { + DashboardPublishOptions: (_) => _json(_), + Definition: (_) => se_DashboardVersionDefinition(_, context), + Name: [], + Parameters: (_) => se__Parameters(_, context), + SourceEntity: (_) => _json(_), + ThemeArn: [], + ValidationStrategy: (_) => _json(_), + VersionDescription: [], + }) + ); + b.m("PUT").h(headers).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1UpdateDashboardLinksCommand + */ +export const se_UpdateDashboardLinksCommand = async ( + input: UpdateDashboardLinksCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = { + "content-type": "application/json", + }; + b.bp("/accounts/{AwsAccountId}/dashboards/{DashboardId}/linked-entities"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + b.p("DashboardId", () => input.DashboardId!, "{DashboardId}", false); + let body: any; + body = JSON.stringify( + take(input, { + LinkEntities: (_) => _json(_), + }) + ); + b.m("PUT").h(headers).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1UpdateDashboardPermissionsCommand + */ +export const se_UpdateDashboardPermissionsCommand = async ( input: UpdateDashboardPermissionsCommandInput, context: __SerdeContext ): Promise<__HttpRequest> => { @@ -5274,6 +5665,31 @@ export const se_UpdateUserCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1UpdateUserCustomPermissionCommand + */ +export const se_UpdateUserCustomPermissionCommand = async ( + input: UpdateUserCustomPermissionCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = { + "content-type": "application/json", + }; + b.bp("/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/custom-permission"); + b.p("UserName", () => input.UserName!, "{UserName}", false); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + b.p("Namespace", () => input.Namespace!, "{Namespace}", false); + let body: any; + body = JSON.stringify( + take(input, { + CustomPermissionsName: [], + }) + ); + b.m("PUT").h(headers).b(body); + return b.build(); +}; + /** * serializeAws_restJson1UpdateVPCConnectionCommand */ @@ -5464,6 +5880,52 @@ export const de_CreateAnalysisCommand = async ( return contents; }; +/** + * deserializeAws_restJson1CreateBrandCommand + */ +export const de_CreateBrandCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + BrandDefinition: _json, + BrandDetail: (_) => de_BrandDetail(_, context), + RequestId: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + +/** + * deserializeAws_restJson1CreateCustomPermissionsCommand + */ +export const de_CreateCustomPermissionsCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + Arn: __expectString, + RequestId: __expectString, + Status: __expectInt32, + }); + Object.assign(contents, doc); + return contents; +}; + /** * deserializeAws_restJson1CreateDashboardCommand */ @@ -6044,6 +6506,71 @@ export const de_DeleteAnalysisCommand = async ( return contents; }; +/** + * deserializeAws_restJson1DeleteBrandCommand + */ +export const de_DeleteBrandCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + RequestId: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + +/** + * deserializeAws_restJson1DeleteBrandAssignmentCommand + */ +export const de_DeleteBrandAssignmentCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + RequestId: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + +/** + * deserializeAws_restJson1DeleteCustomPermissionsCommand + */ +export const de_DeleteCustomPermissionsCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + Arn: __expectString, + RequestId: __expectString, + Status: __expectInt32, + }); + Object.assign(contents, doc); + return contents; +}; + /** * deserializeAws_restJson1DeleteDashboardCommand */ @@ -6594,6 +7121,30 @@ export const de_DeleteUserByPrincipalIdCommand = async ( return contents; }; +/** + * deserializeAws_restJson1DeleteUserCustomPermissionCommand + */ +export const de_DeleteUserCustomPermissionCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + RequestId: __expectString, + }); + Object.assign(contents, doc); + map(contents, { + Status: [, output.statusCode], + }); + return contents; +}; + /** * deserializeAws_restJson1DeleteVPCConnectionCommand */ @@ -6812,24 +7363,130 @@ export const de_DescribeAssetBundleExportJobCommand = async ( IncludeTags: __expectBoolean, JobStatus: __expectString, RequestId: __expectString, - ResourceArns: _json, - ValidationStrategy: _json, - Warnings: _json, + ResourceArns: _json, + ValidationStrategy: _json, + Warnings: _json, + }); + Object.assign(contents, doc); + map(contents, { + Status: [, output.statusCode], + }); + return contents; +}; + +/** + * deserializeAws_restJson1DescribeAssetBundleImportJobCommand + */ +export const de_DescribeAssetBundleImportJobCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + Arn: __expectString, + AssetBundleImportJobId: __expectString, + AssetBundleImportSource: _json, + AwsAccountId: __expectString, + CreatedTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + Errors: _json, + FailureAction: __expectString, + JobStatus: __expectString, + OverrideParameters: (_) => de_AssetBundleImportJobOverrideParameters(_, context), + OverridePermissions: _json, + OverrideTags: _json, + OverrideValidationStrategy: _json, + RequestId: __expectString, + RollbackErrors: _json, + Warnings: _json, + }); + Object.assign(contents, doc); + map(contents, { + Status: [, output.statusCode], + }); + return contents; +}; + +/** + * deserializeAws_restJson1DescribeBrandCommand + */ +export const de_DescribeBrandCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + BrandDefinition: _json, + BrandDetail: (_) => de_BrandDetail(_, context), + RequestId: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + +/** + * deserializeAws_restJson1DescribeBrandAssignmentCommand + */ +export const de_DescribeBrandAssignmentCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + BrandArn: __expectString, + RequestId: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + +/** + * deserializeAws_restJson1DescribeBrandPublishedVersionCommand + */ +export const de_DescribeBrandPublishedVersionCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + BrandDefinition: _json, + BrandDetail: (_) => de_BrandDetail(_, context), + RequestId: __expectString, }); Object.assign(contents, doc); - map(contents, { - Status: [, output.statusCode], - }); return contents; }; /** - * deserializeAws_restJson1DescribeAssetBundleImportJobCommand + * deserializeAws_restJson1DescribeCustomPermissionsCommand */ -export const de_DescribeAssetBundleImportJobCommand = async ( +export const de_DescribeCustomPermissionsCommand = async ( output: __HttpResponse, context: __SerdeContext -): Promise => { +): Promise => { if (output.statusCode !== 200 && output.statusCode >= 300) { return de_CommandError(output, context); } @@ -6838,26 +7495,11 @@ export const de_DescribeAssetBundleImportJobCommand = async ( }); const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); const doc = take(data, { - Arn: __expectString, - AssetBundleImportJobId: __expectString, - AssetBundleImportSource: _json, - AwsAccountId: __expectString, - CreatedTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), - Errors: _json, - FailureAction: __expectString, - JobStatus: __expectString, - OverrideParameters: (_) => de_AssetBundleImportJobOverrideParameters(_, context), - OverridePermissions: _json, - OverrideTags: _json, - OverrideValidationStrategy: _json, + CustomPermissions: _json, RequestId: __expectString, - RollbackErrors: _json, - Warnings: _json, + Status: __expectInt32, }); Object.assign(contents, doc); - map(contents, { - Status: [, output.statusCode], - }); return contents; }; @@ -7986,6 +8628,54 @@ export const de_ListAssetBundleImportJobsCommand = async ( return contents; }; +/** + * deserializeAws_restJson1ListBrandsCommand + */ +export const de_ListBrandsCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + Brands: (_) => de_BrandSummaryList(_, context), + NextToken: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + +/** + * deserializeAws_restJson1ListCustomPermissionsCommand + */ +export const de_ListCustomPermissionsCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + CustomPermissionsList: _json, + NextToken: __expectString, + RequestId: __expectString, + }); + Object.assign(contents, doc); + map(contents, { + Status: [, output.statusCode], + }); + return contents; +}; + /** * deserializeAws_restJson1ListDashboardsCommand */ @@ -9229,6 +9919,96 @@ export const de_UpdateAnalysisPermissionsCommand = async ( return contents; }; +/** + * deserializeAws_restJson1UpdateBrandCommand + */ +export const de_UpdateBrandCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + BrandDefinition: _json, + BrandDetail: (_) => de_BrandDetail(_, context), + RequestId: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + +/** + * deserializeAws_restJson1UpdateBrandAssignmentCommand + */ +export const de_UpdateBrandAssignmentCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + BrandArn: __expectString, + RequestId: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + +/** + * deserializeAws_restJson1UpdateBrandPublishedVersionCommand + */ +export const de_UpdateBrandPublishedVersionCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + RequestId: __expectString, + VersionId: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + +/** + * deserializeAws_restJson1UpdateCustomPermissionsCommand + */ +export const de_UpdateCustomPermissionsCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + Arn: __expectString, + RequestId: __expectString, + Status: __expectInt32, + }); + Object.assign(contents, doc); + return contents; +}; + /** * deserializeAws_restJson1UpdateDashboardCommand */ @@ -10006,6 +10786,30 @@ export const de_UpdateUserCommand = async ( return contents; }; +/** + * deserializeAws_restJson1UpdateUserCustomPermissionCommand + */ +export const de_UpdateUserCustomPermissionCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + RequestId: __expectString, + }); + Object.assign(contents, doc); + map(contents, { + Status: [, output.statusCode], + }); + return contents; +}; + /** * deserializeAws_restJson1UpdateVPCConnectionCommand */ @@ -10077,6 +10881,12 @@ const de_CommandError = async (output: __HttpResponse, context: __SerdeContext): case "UnsupportedUserEditionException": case "com.amazonaws.quicksight#UnsupportedUserEditionException": throw await de_UnsupportedUserEditionExceptionRes(parsedOutput, context); + case "InternalServerException": + case "com.amazonaws.quicksight#InternalServerException": + throw await de_InternalServerExceptionRes(parsedOutput, context); + case "InvalidRequestException": + case "com.amazonaws.quicksight#InvalidRequestException": + throw await de_InvalidRequestExceptionRes(parsedOutput, context); case "CustomerManagedKeyUnavailableException": case "com.amazonaws.quicksight#CustomerManagedKeyUnavailableException": throw await de_CustomerManagedKeyUnavailableExceptionRes(parsedOutput, context); @@ -10101,9 +10911,6 @@ const de_CommandError = async (output: __HttpResponse, context: __SerdeContext): case "IdentityTypeNotSupportedException": case "com.amazonaws.quicksight#IdentityTypeNotSupportedException": throw await de_IdentityTypeNotSupportedExceptionRes(parsedOutput, context); - case "InvalidRequestException": - case "com.amazonaws.quicksight#InvalidRequestException": - throw await de_InvalidRequestExceptionRes(parsedOutput, context); default: const parsedBody = parsedOutput.body; return throwDefaultError({ @@ -10259,6 +11066,26 @@ const de_InternalFailureExceptionRes = async ( return __decorateServiceException(exception, parsedOutput.body); }; +/** + * deserializeAws_restJson1InternalServerExceptionRes + */ +const de_InternalServerExceptionRes = async ( + parsedOutput: any, + context: __SerdeContext +): Promise => { + const contents: any = map({}); + const data: any = parsedOutput.body; + const doc = take(data, { + Message: __expectString, + }); + Object.assign(contents, doc); + const exception = new InternalServerException({ + $metadata: deserializeMetadata(parsedOutput), + ...contents, + }); + return __decorateServiceException(exception, parsedOutput.body); +}; + /** * deserializeAws_restJson1InvalidNextTokenExceptionRes */ @@ -10638,6 +11465,8 @@ const se_AnalysisDefinition = (input: AnalysisDefinition, context: __SerdeContex // se_AnswerIds omitted. +// se_ApplicationTheme omitted. + /** * serializeAws_restJson1ArcAxisConfiguration */ @@ -11270,6 +12099,12 @@ const se_BoxPlotVisual = (input: BoxPlotVisual, context: __SerdeContext): any => }); }; +// se_BrandColorPalette omitted. + +// se_BrandDefinition omitted. + +// se_BrandElementStyle omitted. + // se_CalculatedColumn omitted. // se_CalculatedColumnList omitted. @@ -11282,6 +12117,8 @@ const se_BoxPlotVisual = (input: BoxPlotVisual, context: __SerdeContext): any => // se_CalculatedMeasureField omitted. +// se_Capabilities omitted. + // se_CascadingControlConfiguration omitted. // se_CascadingControlSource omitted. @@ -13107,6 +13944,12 @@ const se_HistogramVisual = (input: HistogramVisual, context: __SerdeContext): an // se_IdentityNameList omitted. +// se_ImageConfiguration omitted. + +// se_ImageSetConfiguration omitted. + +// se_ImageSource omitted. + // se_IncrementalRefresh omitted. /** @@ -13488,6 +14331,10 @@ const se_LogicalTableMap = (input: Record, context: __Serd // se_LogicalTableSource omitted. +// se_LogoConfiguration omitted. + +// se_LogoSetConfiguration omitted. + // se_LongFormatText omitted. // se_LookbackWindow omitted. @@ -13569,6 +14416,8 @@ const se_MetricComparisonComputation = (input: MetricComparisonComputation, cont // se_NamedEntityRef omitted. +// se_NavbarStyle omitted. + // se_NegativeFormat omitted. // se_NegativeValueConfiguration omitted. @@ -13720,6 +14569,8 @@ const se_OverrideDatasetParameterOperation = ( // se_PaginationConfiguration omitted. +// se_Palette omitted. + // se_PanelConfiguration omitted. // se_PanelTitleOptions omitted. @@ -15860,6 +16711,8 @@ const de_AnalysisSummaryList = (output: any, context: __SerdeContext): AnalysisS // de_AnonymousUserSnapshotJobResultList omitted. +// de_ApplicationTheme omitted. + /** * deserializeAws_restJson1ArcAxisConfiguration */ @@ -16558,6 +17411,56 @@ const de_BoxPlotVisual = (output: any, context: __SerdeContext): BoxPlotVisual = }) as any; }; +// de_BrandColorPalette omitted. + +// de_BrandDefinition omitted. + +/** + * deserializeAws_restJson1BrandDetail + */ +const de_BrandDetail = (output: any, context: __SerdeContext): BrandDetail => { + return take(output, { + Arn: __expectString, + BrandId: __expectString, + BrandStatus: __expectString, + CreatedTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + Errors: _json, + LastUpdatedTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + Logo: _json, + VersionId: __expectString, + VersionStatus: __expectString, + }) as any; +}; + +// de_BrandElementStyle omitted. + +/** + * deserializeAws_restJson1BrandSummary + */ +const de_BrandSummary = (output: any, context: __SerdeContext): BrandSummary => { + return take(output, { + Arn: __expectString, + BrandId: __expectString, + BrandName: __expectString, + BrandStatus: __expectString, + CreatedTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + Description: __expectString, + LastUpdatedTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + }) as any; +}; + +/** + * deserializeAws_restJson1BrandSummaryList + */ +const de_BrandSummaryList = (output: any, context: __SerdeContext): BrandSummary[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_BrandSummary(entry, context); + }); + return retVal; +}; + // de_CalculatedColumn omitted. // de_CalculatedColumnList omitted. @@ -16570,6 +17473,8 @@ const de_BoxPlotVisual = (output: any, context: __SerdeContext): BoxPlotVisual = // de_CalculatedMeasureField omitted. +// de_Capabilities omitted. + // de_CascadingControlConfiguration omitted. // de_CascadingControlSource omitted. @@ -16959,6 +17864,10 @@ const de_CustomParameterValues = (output: any, context: __SerdeContext): CustomP }) as any; }; +// de_CustomPermissions omitted. + +// de_CustomPermissionsList omitted. + // de_CustomSql omitted. /** @@ -17668,6 +18577,8 @@ const de_EmptyVisual = (output: any, context: __SerdeContext): EmptyVisual => { // de_ErrorInfo omitted. +// de_ErrorList omitted. + // de_ExasolParameters omitted. // de_ExcludePeriodConfiguration omitted. @@ -18640,6 +19551,16 @@ const de_HistogramVisual = (output: any, context: __SerdeContext): HistogramVisu // de_IdentityNameList omitted. +// de_Image omitted. + +// de_ImageConfiguration omitted. + +// de_ImageSet omitted. + +// de_ImageSetConfiguration omitted. + +// de_ImageSource omitted. + // de_IncrementalRefresh omitted. /** @@ -19058,6 +19979,14 @@ const de_LogicalTableMap = (output: any, context: __SerdeContext): RecordAn empty object that represents that the AllSheets option is the chosen value for the FilterScopeConfiguration parameter. This structure applies the filter to all visuals on all sheets of an Analysis, Dashboard, or Template.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" } }, + "com.amazonaws.quicksight#AltText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[ -ÿ]+$" + } + }, "com.amazonaws.quicksight#AmazonElasticsearchParameters": { "type": "structure", "members": { @@ -1267,6 +1277,26 @@ "target": "com.amazonaws.quicksight#AnswerId" } }, + "com.amazonaws.quicksight#ApplicationTheme": { + "type": "structure", + "members": { + "BrandColorPalette": { + "target": "com.amazonaws.quicksight#BrandColorPalette", + "traits": { + "smithy.api#documentation": "

The color palette.

" + } + }, + "BrandElementStyle": { + "target": "com.amazonaws.quicksight#BrandElementStyle", + "traits": { + "smithy.api#documentation": "

The element style.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The application theme.

" + } + }, "com.amazonaws.quicksight#ArcAxisConfiguration": { "type": "structure", "members": { @@ -5254,6 +5284,292 @@ "smithy.api#documentation": "

A box plot.

\n

For more information, see Using box plots in the Amazon QuickSight User Guide.

" } }, + "com.amazonaws.quicksight#BrandColorPalette": { + "type": "structure", + "members": { + "Primary": { + "target": "com.amazonaws.quicksight#Palette", + "traits": { + "smithy.api#documentation": "

The primary color.

" + } + }, + "Secondary": { + "target": "com.amazonaws.quicksight#Palette", + "traits": { + "smithy.api#documentation": "

The secondary color.

" + } + }, + "Accent": { + "target": "com.amazonaws.quicksight#Palette", + "traits": { + "smithy.api#documentation": "

The color that is used for accent elements.

" + } + }, + "Measure": { + "target": "com.amazonaws.quicksight#Palette", + "traits": { + "smithy.api#documentation": "

The color that is used for measure elements.

" + } + }, + "Dimension": { + "target": "com.amazonaws.quicksight#Palette", + "traits": { + "smithy.api#documentation": "

The color that is used for dimension elements.

" + } + }, + "Success": { + "target": "com.amazonaws.quicksight#Palette", + "traits": { + "smithy.api#documentation": "

The color that is used for success elements.

" + } + }, + "Info": { + "target": "com.amazonaws.quicksight#Palette", + "traits": { + "smithy.api#documentation": "

The color that is used for info elements.

" + } + }, + "Warning": { + "target": "com.amazonaws.quicksight#Palette", + "traits": { + "smithy.api#documentation": "

The color that is used for warning elements.

" + } + }, + "Danger": { + "target": "com.amazonaws.quicksight#Palette", + "traits": { + "smithy.api#documentation": "

The color that is used for danger elements.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The color palette.

" + } + }, + "com.amazonaws.quicksight#BrandDefinition": { + "type": "structure", + "members": { + "BrandName": { + "target": "com.amazonaws.quicksight#Name", + "traits": { + "smithy.api#documentation": "

The name of the brand.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.quicksight#Description", + "traits": { + "smithy.api#documentation": "

The description of the brand.

" + } + }, + "ApplicationTheme": { + "target": "com.amazonaws.quicksight#ApplicationTheme", + "traits": { + "smithy.api#documentation": "

The application theme of the brand.

" + } + }, + "LogoConfiguration": { + "target": "com.amazonaws.quicksight#LogoConfiguration", + "traits": { + "smithy.api#documentation": "

The logo configuration of the brand.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition of the brand.

" + } + }, + "com.amazonaws.quicksight#BrandDetail": { + "type": "structure", + "members": { + "BrandId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon QuickSight brand.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the brand.

" + } + }, + "BrandStatus": { + "target": "com.amazonaws.quicksight#BrandStatus", + "traits": { + "smithy.api#documentation": "

The status of the brand.

" + } + }, + "CreatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the brand was created.

" + } + }, + "LastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time the brand was updated.

" + } + }, + "VersionId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the version.

" + } + }, + "VersionStatus": { + "target": "com.amazonaws.quicksight#BrandVersionStatus", + "traits": { + "smithy.api#documentation": "

The status of the version.

" + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#ErrorList", + "traits": { + "smithy.api#documentation": "

A list of errors that occurred during the most recent brand operation.

" + } + }, + "Logo": { + "target": "com.amazonaws.quicksight#Logo", + "traits": { + "smithy.api#documentation": "

The logo details.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of the brand.

" + } + }, + "com.amazonaws.quicksight#BrandElementStyle": { + "type": "structure", + "members": { + "NavbarStyle": { + "target": "com.amazonaws.quicksight#NavbarStyle", + "traits": { + "smithy.api#documentation": "

The navigation bar style.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The element style.

" + } + }, + "com.amazonaws.quicksight#BrandStatus": { + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "CREATE_SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_SUCCEEDED" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.quicksight#BrandSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the brand.

" + } + }, + "BrandId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon QuickSight brand.

" + } + }, + "BrandName": { + "target": "com.amazonaws.quicksight#Name", + "traits": { + "smithy.api#documentation": "

The name of the brand.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#Description", + "traits": { + "smithy.api#documentation": "

The description of the brand.

" + } + }, + "BrandStatus": { + "target": "com.amazonaws.quicksight#BrandStatus", + "traits": { + "smithy.api#documentation": "

The status of the brand.

" + } + }, + "CreatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the brand was created.

" + } + }, + "LastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the brand was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the brand.

" + } + }, + "com.amazonaws.quicksight#BrandSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#BrandSummary" + } + }, + "com.amazonaws.quicksight#BrandVersionStatus": { + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "CREATE_SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_SUCCEEDED" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + } + } + }, "com.amazonaws.quicksight#CIDR": { "type": "string", "traits": { @@ -5489,6 +5805,127 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#Capabilities": { + "type": "structure", + "members": { + "ExportToCsv": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to export to CSV files.

" + } + }, + "ExportToExcel": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to export to Excel files.

" + } + }, + "CreateAndUpdateThemes": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to export to Create and Update themes.

" + } + }, + "AddOrRunAnomalyDetectionForAnalyses": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to add or run anomaly detection.

" + } + }, + "ShareAnalyses": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to share analyses.

" + } + }, + "CreateAndUpdateDatasets": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to create and update datasets.

" + } + }, + "ShareDatasets": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to share datasets.

" + } + }, + "SubscribeDashboardEmailReports": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to subscribe to email reports.

" + } + }, + "CreateAndUpdateDashboardEmailReports": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to create and update email reports.

" + } + }, + "ShareDashboards": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to share dashboards.

" + } + }, + "CreateAndUpdateThresholdAlerts": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to create and update threshold alerts.

" + } + }, + "RenameSharedFolders": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to rename shared folders.

" + } + }, + "CreateSharedFolders": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to create shared folders.

" + } + }, + "CreateAndUpdateDataSources": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to create and update data sources.

" + } + }, + "ShareDataSources": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to share data sources.

" + } + }, + "ViewAccountSPICECapacity": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to view account SPICE capacity.

" + } + }, + "CreateSPICEDataset": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to create a SPICE dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of actions that correspond to Amazon QuickSight permissions.

" + } + }, + "com.amazonaws.quicksight#CapabilityState": { + "type": "enum", + "members": { + "DENY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY" + } + } + } + }, "com.amazonaws.quicksight#CascadingControlConfiguration": { "type": "structure", "members": { @@ -8116,6 +8553,105 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#CreateBrand": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateBrandRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateBrandResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalServerException" + }, + { + "target": "com.amazonaws.quicksight#InvalidRequestException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon QuickSight brand.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/brands/{BrandId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateBrandRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the brand.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BrandId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon QuickSight brand.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BrandDefinition": { + "target": "com.amazonaws.quicksight#BrandDefinition", + "traits": { + "smithy.api#documentation": "

The definition of the brand.

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A map of the key-value pairs that are assigned to the brand.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateBrandResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "BrandDetail": { + "target": "com.amazonaws.quicksight#BrandDetail", + "traits": { + "smithy.api#documentation": "

The details of the brand.

" + } + }, + "BrandDefinition": { + "target": "com.amazonaws.quicksight#BrandDefinition", + "traits": { + "smithy.api#documentation": "

The definition of the brand.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#CreateColumnsOperation": { "type": "structure", "members": { @@ -8131,6 +8667,117 @@ "smithy.api#documentation": "

A transform operation that creates calculated columns. Columns created in one such\n operation form a lexical closure.

" } }, + "com.amazonaws.quicksight#CreateCustomPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateCustomPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateCustomPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a custom permissions profile.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/custom-permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateCustomPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that you want to create the custom permissions profile in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#CustomPermissionsName", + "traits": { + "smithy.api#documentation": "

The name of the custom permissions profile that you want to create.

", + "smithy.api#required": {} + } + }, + "Capabilities": { + "target": "com.amazonaws.quicksight#Capabilities", + "traits": { + "smithy.api#documentation": "

A set of actions to include in the custom permissions profile.

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

The tags to associate with the custom permissions profile.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateCustomPermissionsResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom permissions profile.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#CreateDashboard": { "type": "operation", "input": { @@ -11234,6 +11881,48 @@ "smithy.api#documentation": "

The customized parameter values.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" } }, + "com.amazonaws.quicksight#CustomPermissions": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom permissions profile.

" + } + }, + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#CustomPermissionsName", + "traits": { + "smithy.api#documentation": "

The name of the custom permissions profile.

" + } + }, + "Capabilities": { + "target": "com.amazonaws.quicksight#Capabilities", + "traits": { + "smithy.api#documentation": "

A set of actions in the custom permissions profile.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The custom permissions profile.

" + } + }, + "com.amazonaws.quicksight#CustomPermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CustomPermissions" + } + }, + "com.amazonaws.quicksight#CustomPermissionsName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9+=,.@_-]+$" + } + }, "com.amazonaws.quicksight#CustomSql": { "type": "structure", "members": { @@ -15361,6 +16050,247 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#DeleteBrand": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteBrandRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteBrandResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalServerException" + }, + { + "target": "com.amazonaws.quicksight#InvalidRequestException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon QuickSight brand.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/brands/{BrandId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.quicksight#DeleteBrandAssignment": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteBrandAssignmentRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteBrandAssignmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalServerException" + }, + { + "target": "com.amazonaws.quicksight#InvalidRequestException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a brand assignment.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/brandassignments", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.quicksight#DeleteBrandAssignmentRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the brand assignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteBrandAssignmentResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteBrandRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the brand.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BrandId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon QuickSight brand.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteBrandResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteCustomPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteCustomPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteCustomPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a custom permissions profile.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/custom-permissions/{CustomPermissionsName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteCustomPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the custom permissions profile that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#CustomPermissionsName", + "traits": { + "smithy.api#documentation": "

The name of the custom permissions profile that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteCustomPermissionsResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom permissions profile.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DeleteDashboard": { "type": "operation", "input": { @@ -17462,6 +18392,103 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#DeleteUserCustomPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteUserCustomPermissionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteUserCustomPermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a custom permissions profile from a user.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/custom-permission", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteUserCustomPermissionRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

The username of the user that you want to remove custom permissions from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the custom permission configuration that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that the user belongs to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteUserCustomPermissionResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DeleteUserRequest": { "type": "structure", "members": { @@ -18561,6 +19588,351 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#DescribeBrand": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeBrandRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeBrandResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalServerException" + }, + { + "target": "com.amazonaws.quicksight#InvalidRequestException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a brand.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/brands/{BrandId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeBrandAssignment": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeBrandAssignmentRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeBrandAssignmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalServerException" + }, + { + "target": "com.amazonaws.quicksight#InvalidRequestException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a brand assignment.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/brandassignments", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeBrandAssignmentRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the brand assignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeBrandAssignmentResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "BrandArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the brand.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeBrandPublishedVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeBrandPublishedVersionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeBrandPublishedVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalServerException" + }, + { + "target": "com.amazonaws.quicksight#InvalidRequestException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the published version of the brand.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/brands/{BrandId}/publishedversion", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeBrandPublishedVersionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the brand.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BrandId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon QuickSight brand.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeBrandPublishedVersionResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "BrandDetail": { + "target": "com.amazonaws.quicksight#BrandDetail", + "traits": { + "smithy.api#documentation": "

The details of the brand.

" + } + }, + "BrandDefinition": { + "target": "com.amazonaws.quicksight#BrandDefinition", + "traits": { + "smithy.api#documentation": "

The definition of the brand.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeBrandRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the brand.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BrandId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon QuickSight brand.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the specific version. The default value is the latest version.

", + "smithy.api#httpQuery": "versionId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeBrandResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "BrandDetail": { + "target": "com.amazonaws.quicksight#BrandDetail", + "traits": { + "smithy.api#documentation": "

The details of the brand.

" + } + }, + "BrandDefinition": { + "target": "com.amazonaws.quicksight#BrandDefinition", + "traits": { + "smithy.api#documentation": "

The definition of the brand.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeCustomPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeCustomPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeCustomPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a custom permissions profile.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/custom-permissions/{CustomPermissionsName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeCustomPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the custom permissions profile that you want described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#CustomPermissionsName", + "traits": { + "smithy.api#documentation": "

The name of the custom permissions profile to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeCustomPermissionsResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "CustomPermissions": { + "target": "com.amazonaws.quicksight#CustomPermissions", + "traits": { + "smithy.api#documentation": "

The custom permissions profile.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DescribeDashboard": { "type": "operation", "input": { @@ -22311,6 +23683,16 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[ -ÿ]+$" + } + }, "com.amazonaws.quicksight#DestinationParameterValueConfiguration": { "type": "structure", "members": { @@ -22823,6 +24205,15 @@ "smithy.api#documentation": "

Error information for the SPICE ingestion of a dataset.

" } }, + "com.amazonaws.quicksight#ErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ErrorMessage" + } + }, + "com.amazonaws.quicksight#ErrorMessage": { + "type": "string" + }, "com.amazonaws.quicksight#ExasolParameters": { "type": "structure", "members": { @@ -27971,6 +29362,102 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.quicksight#Image": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.quicksight#ImageSource", + "traits": { + "smithy.api#documentation": "

The source of the logo image.

" + } + }, + "GeneratedImageUrl": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The URL that points to the generated logo image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The logo image.

" + } + }, + "com.amazonaws.quicksight#ImageConfiguration": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.quicksight#ImageSource", + "traits": { + "smithy.api#documentation": "

The source of the image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The logo image configuration.

" + } + }, + "com.amazonaws.quicksight#ImageSet": { + "type": "structure", + "members": { + "Original": { + "target": "com.amazonaws.quicksight#Image", + "traits": { + "smithy.api#documentation": "

The original image.

", + "smithy.api#required": {} + } + }, + "Height64": { + "target": "com.amazonaws.quicksight#Image", + "traits": { + "smithy.api#documentation": "

The image with the height set to 64 pixels.

" + } + }, + "Height32": { + "target": "com.amazonaws.quicksight#Image", + "traits": { + "smithy.api#documentation": "

The image with the height set to 32 pixels.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The image set.

" + } + }, + "com.amazonaws.quicksight#ImageSetConfiguration": { + "type": "structure", + "members": { + "Original": { + "target": "com.amazonaws.quicksight#ImageConfiguration", + "traits": { + "smithy.api#documentation": "

The original image.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The image set configuration.

" + } + }, + "com.amazonaws.quicksight#ImageSource": { + "type": "union", + "members": { + "PublicUrl": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The public URL that points to the source image.

" + } + }, + "S3Uri": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI that points to the source image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source of the image.

" + } + }, "com.amazonaws.quicksight#IncludeFolderMembers": { "type": "enum", "members": { @@ -28891,6 +30378,22 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.quicksight#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An internal service exception.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, "com.amazonaws.quicksight#InvalidNextTokenException": { "type": "structure", "members": { @@ -30464,13 +31967,117 @@ "smithy.api#input": {} } }, - "com.amazonaws.quicksight#ListAssetBundleExportJobsResponse": { + "com.amazonaws.quicksight#ListAssetBundleExportJobsResponse": { + "type": "structure", + "members": { + "AssetBundleExportJobSummaryList": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobSummaryList", + "traits": { + "smithy.api#documentation": "

A list of export job summaries.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListAssetBundleImportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListAssetBundleImportJobsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListAssetBundleImportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/asset-bundle-import-jobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AssetBundleImportJobSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListAssetBundleImportJobsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that the import jobs were executed in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListAssetBundleImportJobsResponse": { "type": "structure", "members": { - "AssetBundleExportJobSummaryList": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobSummaryList", + "AssetBundleImportJobSummaryList": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobSummaryList", "traits": { - "smithy.api#documentation": "

A list of export job summaries.

" + "smithy.api#documentation": "

A list of import job summaries.

" } }, "NextToken": { @@ -30489,7 +32096,7 @@ "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#documentation": "

The HTTP status of the response.

", "smithy.api#httpResponseCode": {} } } @@ -30498,103 +32105,86 @@ "smithy.api#output": {} } }, - "com.amazonaws.quicksight#ListAssetBundleImportJobs": { + "com.amazonaws.quicksight#ListBrands": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#ListAssetBundleImportJobsRequest" + "target": "com.amazonaws.quicksight#ListBrandsRequest" }, "output": { - "target": "com.amazonaws.quicksight#ListAssetBundleImportJobsResponse" + "target": "com.amazonaws.quicksight#ListBrandsResponse" }, "errors": [ { "target": "com.amazonaws.quicksight#AccessDeniedException" }, { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" + "target": "com.amazonaws.quicksight#InternalServerException" }, { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" + "target": "com.amazonaws.quicksight#InvalidRequestException" }, { "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" } ], "traits": { - "smithy.api#documentation": "

Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.

", + "smithy.api#documentation": "

Lists all brands in an Amazon QuickSight account.

", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/asset-bundle-import-jobs", + "uri": "/accounts/{AwsAccountId}/brands", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "AssetBundleImportJobSummaryList", + "items": "Brands", "pageSize": "MaxResults" } } }, - "com.amazonaws.quicksight#ListAssetBundleImportJobsRequest": { + "com.amazonaws.quicksight#ListBrandsRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that the import jobs were executed in.

", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the brands that you want to list.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned in a single request.

", + "smithy.api#httpQuery": "max-results" + } + }, "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", "smithy.api#httpQuery": "next-token" } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.quicksight#ListAssetBundleImportJobsResponse": { + "com.amazonaws.quicksight#ListBrandsResponse": { "type": "structure", "members": { - "AssetBundleImportJobSummaryList": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobSummaryList", - "traits": { - "smithy.api#documentation": "

A list of import job summaries.

" - } - }, "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "Brands": { + "target": "com.amazonaws.quicksight#BrandSummaryList", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the response.

", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "

A list of all brands in your Amazon Web Services account. This structure provides basic\n\t information about each brand.

" } } }, @@ -30662,6 +32252,116 @@ "smithy.api#documentation": "

The configuration of the Select all options in a list control.

" } }, + "com.amazonaws.quicksight#ListCustomPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListCustomPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListCustomPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all the custom permissions profiles.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/custom-permissions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CustomPermissionsList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListCustomPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the custom permissions profiles that you want to list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListCustomPermissionsResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "CustomPermissionsList": { + "target": "com.amazonaws.quicksight#CustomPermissionsList", + "traits": { + "smithy.api#documentation": "

A list of custom permissions profiles.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#ListDashboardVersions": { "type": "operation", "input": { @@ -34029,6 +35729,92 @@ "smithy.api#documentation": "

Information about the source of a logical table. This is a variant type structure. For\n this structure to be valid, only one of the attributes can be non-null.

" } }, + "com.amazonaws.quicksight#Logo": { + "type": "structure", + "members": { + "AltText": { + "target": "com.amazonaws.quicksight#AltText", + "traits": { + "smithy.api#documentation": "

The alt text for the logo.

", + "smithy.api#required": {} + } + }, + "LogoSet": { + "target": "com.amazonaws.quicksight#LogoSet", + "traits": { + "smithy.api#documentation": "

A set of configured logos.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The logo configuration.

" + } + }, + "com.amazonaws.quicksight#LogoConfiguration": { + "type": "structure", + "members": { + "AltText": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The alt text for the logo.

", + "smithy.api#required": {} + } + }, + "LogoSet": { + "target": "com.amazonaws.quicksight#LogoSetConfiguration", + "traits": { + "smithy.api#documentation": "

A set of configured logos.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The logo configuration.

" + } + }, + "com.amazonaws.quicksight#LogoSet": { + "type": "structure", + "members": { + "Primary": { + "target": "com.amazonaws.quicksight#ImageSet", + "traits": { + "smithy.api#documentation": "

The primary logo.

", + "smithy.api#required": {} + } + }, + "Favicon": { + "target": "com.amazonaws.quicksight#ImageSet", + "traits": { + "smithy.api#documentation": "

The favicon logo.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of logos.

" + } + }, + "com.amazonaws.quicksight#LogoSetConfiguration": { + "type": "structure", + "members": { + "Primary": { + "target": "com.amazonaws.quicksight#ImageSetConfiguration", + "traits": { + "smithy.api#documentation": "

The primary logo.

", + "smithy.api#required": {} + } + }, + "Favicon": { + "target": "com.amazonaws.quicksight#ImageSetConfiguration", + "traits": { + "smithy.api#documentation": "

The favicon logo.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The logo set configuration.

" + } + }, "com.amazonaws.quicksight#Long": { "type": "long", "traits": { @@ -34562,6 +36348,16 @@ "smithy.api#documentation": "

The parameters for MySQL.

" } }, + "com.amazonaws.quicksight#Name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[ -ÿ]+$" + } + }, "com.amazonaws.quicksight#NamedEntityAggType": { "type": "enum", "members": { @@ -34976,6 +36772,26 @@ } } }, + "com.amazonaws.quicksight#NavbarStyle": { + "type": "structure", + "members": { + "GlobalNavbar": { + "target": "com.amazonaws.quicksight#Palette", + "traits": { + "smithy.api#documentation": "

The global navigation bar style.

" + } + }, + "ContextualNavbar": { + "target": "com.amazonaws.quicksight#Palette", + "traits": { + "smithy.api#documentation": "

The contextual navigation bar style.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The navigation bar style.

" + } + }, "com.amazonaws.quicksight#NegativeFormat": { "type": "structure", "members": { @@ -35991,6 +37807,26 @@ "smithy.api#documentation": "

The pagination configuration for a table visual or boxplot.

" } }, + "com.amazonaws.quicksight#Palette": { + "type": "structure", + "members": { + "Foreground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color.

" + } + }, + "Background": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The background color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The color palette.

" + } + }, "com.amazonaws.quicksight#PanelBorderStyle": { "type": "enum", "members": { @@ -38504,6 +40340,12 @@ { "target": "com.amazonaws.quicksight#CreateAnalysis" }, + { + "target": "com.amazonaws.quicksight#CreateBrand" + }, + { + "target": "com.amazonaws.quicksight#CreateCustomPermissions" + }, { "target": "com.amazonaws.quicksight#CreateDashboard" }, @@ -38570,6 +40412,15 @@ { "target": "com.amazonaws.quicksight#DeleteAnalysis" }, + { + "target": "com.amazonaws.quicksight#DeleteBrand" + }, + { + "target": "com.amazonaws.quicksight#DeleteBrandAssignment" + }, + { + "target": "com.amazonaws.quicksight#DeleteCustomPermissions" + }, { "target": "com.amazonaws.quicksight#DeleteDashboard" }, @@ -38636,6 +40487,9 @@ { "target": "com.amazonaws.quicksight#DeleteUserByPrincipalId" }, + { + "target": "com.amazonaws.quicksight#DeleteUserCustomPermission" + }, { "target": "com.amazonaws.quicksight#DeleteVPCConnection" }, @@ -38663,6 +40517,18 @@ { "target": "com.amazonaws.quicksight#DescribeAssetBundleImportJob" }, + { + "target": "com.amazonaws.quicksight#DescribeBrand" + }, + { + "target": "com.amazonaws.quicksight#DescribeBrandAssignment" + }, + { + "target": "com.amazonaws.quicksight#DescribeBrandPublishedVersion" + }, + { + "target": "com.amazonaws.quicksight#DescribeCustomPermissions" + }, { "target": "com.amazonaws.quicksight#DescribeDashboard" }, @@ -38792,6 +40658,12 @@ { "target": "com.amazonaws.quicksight#ListAssetBundleImportJobs" }, + { + "target": "com.amazonaws.quicksight#ListBrands" + }, + { + "target": "com.amazonaws.quicksight#ListCustomPermissions" + }, { "target": "com.amazonaws.quicksight#ListDashboards" }, @@ -38936,6 +40808,18 @@ { "target": "com.amazonaws.quicksight#UpdateAnalysisPermissions" }, + { + "target": "com.amazonaws.quicksight#UpdateBrand" + }, + { + "target": "com.amazonaws.quicksight#UpdateBrandAssignment" + }, + { + "target": "com.amazonaws.quicksight#UpdateBrandPublishedVersion" + }, + { + "target": "com.amazonaws.quicksight#UpdateCustomPermissions" + }, { "target": "com.amazonaws.quicksight#UpdateDashboard" }, @@ -39026,6 +40910,9 @@ { "target": "com.amazonaws.quicksight#UpdateUser" }, + { + "target": "com.amazonaws.quicksight#UpdateUserCustomPermission" + }, { "target": "com.amazonaws.quicksight#UpdateVPCConnection" } @@ -52182,6 +54069,370 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#UpdateBrand": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateBrandRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateBrandResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalServerException" + }, + { + "target": "com.amazonaws.quicksight#InvalidRequestException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a brand.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/brands/{BrandId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.quicksight#UpdateBrandAssignment": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateBrandAssignmentRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateBrandAssignmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalServerException" + }, + { + "target": "com.amazonaws.quicksight#InvalidRequestException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a brand assignment.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/brandassignments", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.quicksight#UpdateBrandAssignmentRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the brand assignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BrandArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the brand.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateBrandAssignmentResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "BrandArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the brand.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateBrandPublishedVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateBrandPublishedVersionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateBrandPublishedVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalServerException" + }, + { + "target": "com.amazonaws.quicksight#InvalidRequestException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the published version of a brand.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/brands/{BrandId}/publishedversion", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.quicksight#UpdateBrandPublishedVersionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the brand.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BrandId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon QuickSight brand.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the published version.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateBrandPublishedVersionResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "VersionId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the published version.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateBrandRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the brand.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BrandId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon QuickSight brand.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BrandDefinition": { + "target": "com.amazonaws.quicksight#BrandDefinition", + "traits": { + "smithy.api#documentation": "

The definition of the brand.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateBrandResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "BrandDetail": { + "target": "com.amazonaws.quicksight#BrandDetail", + "traits": { + "smithy.api#documentation": "

The details of the brand.

" + } + }, + "BrandDefinition": { + "target": "com.amazonaws.quicksight#BrandDefinition", + "traits": { + "smithy.api#documentation": "

The definition of the brand.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateCustomPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateCustomPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateCustomPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a custom permissions profile.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/custom-permissions/{CustomPermissionsName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateCustomPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the custom permissions profile that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#CustomPermissionsName", + "traits": { + "smithy.api#documentation": "

The name of the custom permissions profile that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Capabilities": { + "target": "com.amazonaws.quicksight#Capabilities", + "traits": { + "smithy.api#documentation": "

A set of actions to include in the custom permissions profile.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateCustomPermissionsResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom permissions profile.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#UpdateDashboard": { "type": "operation", "input": { @@ -55549,6 +57800,110 @@ } } }, + "com.amazonaws.quicksight#UpdateUserCustomPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateUserCustomPermissionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateUserCustomPermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a custom permissions profile for a user.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/custom-permission", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateUserCustomPermissionRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

The username of the user that you want to update custom permissions for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the custom permission configuration that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that the user belongs to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#CustomPermissionsName", + "traits": { + "smithy.api#documentation": "

The name of the custom permissions that you want to update.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateUserCustomPermissionResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#UpdateUserRequest": { "type": "structure", "members": {