From df75ca51f2eb797ebabba6b751d0ef7c92724654 Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 22 Nov 2024 19:18:07 +0000 Subject: [PATCH] feat(client-quicksight): This release includes: Update APIs to support Image, Layer Map, font customization, and Plugin Visual. Add Identity center related information in ListNamsespace API. Update API for restrictedFolder support in topics and add API for SearchTopics, Describe/Update DashboardsQA Configration. --- clients/client-quicksight/README.md | 24 + clients/client-quicksight/src/QuickSight.ts | 63 + .../client-quicksight/src/QuickSightClient.ts | 15 + .../BatchCreateTopicReviewedAnswerCommand.ts | 2 +- .../CreateAccountCustomizationCommand.ts | 2 +- .../CreateAccountSubscriptionCommand.ts | 2 +- .../src/commands/CreateAnalysisCommand.ts | 439 +- .../src/commands/CreateBrandCommand.ts | 2 +- .../CreateCustomPermissionsCommand.ts | 2 +- .../src/commands/CreateDashboardCommand.ts | 439 +- .../src/commands/CreateTemplateCommand.ts | 437 +- .../src/commands/CreateTopicCommand.ts | 3 + .../src/commands/DescribeAnalysisCommand.ts | 87 +- .../DescribeAnalysisDefinitionCommand.ts | 437 +- .../DescribeAssetBundleExportJobCommand.ts | 4 +- .../DescribeAssetBundleImportJobCommand.ts | 2 +- .../DescribeBrandAssignmentCommand.ts | 2 +- .../src/commands/DescribeBrandCommand.ts | 2 +- .../DescribeBrandPublishedVersionCommand.ts | 2 +- .../DescribeCustomPermissionsCommand.ts | 2 +- .../src/commands/DescribeDashboardCommand.ts | 87 +- .../DescribeDashboardDefinitionCommand.ts | 439 +- .../DescribeDashboardPermissionsCommand.ts | 2 +- .../DescribeDashboardSnapshotJobCommand.ts | 2 +- ...scribeDashboardSnapshotJobResultCommand.ts | 2 +- ...escribeDashboardsQAConfigurationCommand.ts | 123 + .../src/commands/DescribeDataSetCommand.ts | 2 +- .../DescribeDataSetPermissionsCommand.ts | 2 +- ...DescribeDataSetRefreshPropertiesCommand.ts | 2 +- .../src/commands/DescribeDataSourceCommand.ts | 2 +- .../DescribeDataSourcePermissionsCommand.ts | 2 +- .../src/commands/DescribeFolderCommand.ts | 2 +- .../DescribeFolderPermissionsCommand.ts | 2 +- ...escribeFolderResolvedPermissionsCommand.ts | 2 +- .../src/commands/DescribeGroupCommand.ts | 2 +- .../DescribeGroupMembershipCommand.ts | 2 +- .../DescribeIAMPolicyAssignmentCommand.ts | 2 +- .../src/commands/DescribeIngestionCommand.ts | 3 +- .../src/commands/DescribeNamespaceCommand.ts | 2 + .../src/commands/DescribeTemplateCommand.ts | 87 +- .../DescribeTemplateDefinitionCommand.ts | 437 +- .../src/commands/ListNamespacesCommand.ts | 2 + .../ListTopicReviewedAnswersCommand.ts | 4 +- .../src/commands/SearchTopicsCommand.ts | 132 + .../src/commands/UpdateAnalysisCommand.ts | 437 +- .../src/commands/UpdateDashboardCommand.ts | 437 +- .../UpdateDashboardsQAConfigurationCommand.ts | 121 + .../UpdateDataSetPermissionsCommand.ts | 3 +- .../src/commands/UpdateDataSourceCommand.ts | 2 +- .../UpdateDataSourcePermissionsCommand.ts | 2 +- .../src/commands/UpdateFolderCommand.ts | 2 +- .../UpdateFolderPermissionsCommand.ts | 2 +- .../src/commands/UpdateGroupCommand.ts | 2 +- .../UpdateIAMPolicyAssignmentCommand.ts | 2 +- .../UpdateIdentityPropagationConfigCommand.ts | 2 +- .../commands/UpdateIpRestrictionCommand.ts | 2 +- .../commands/UpdateKeyRegistrationCommand.ts | 2 +- .../UpdatePublicSharingSettingsCommand.ts | 2 +- ...ateQPersonalizationConfigurationCommand.ts | 2 +- .../commands/UpdateRefreshScheduleCommand.ts | 2 +- .../UpdateRoleCustomPermissionCommand.ts | 2 +- ...UpdateSPICECapacityConfigurationCommand.ts | 2 +- .../commands/UpdateTemplateAliasCommand.ts | 2 +- .../src/commands/UpdateTemplateCommand.ts | 439 +- .../UpdateTemplatePermissionsCommand.ts | 2 +- .../src/commands/UpdateThemeAliasCommand.ts | 2 +- .../src/commands/UpdateThemeCommand.ts | 2 +- .../commands/UpdateThemePermissionsCommand.ts | 2 +- .../src/commands/UpdateTopicCommand.ts | 2 +- .../commands/UpdateTopicPermissionsCommand.ts | 2 +- .../UpdateTopicRefreshScheduleCommand.ts | 2 +- .../src/commands/UpdateUserCommand.ts | 2 +- .../UpdateUserCustomPermissionCommand.ts | 2 +- .../commands/UpdateVPCConnectionCommand.ts | 2 +- .../client-quicksight/src/commands/index.ts | 3 + clients/client-quicksight/src/models/index.ts | 1 + .../client-quicksight/src/models/models_0.ts | 1371 ++- .../client-quicksight/src/models/models_1.ts | 7782 +++++++------ .../client-quicksight/src/models/models_2.ts | 9866 ++++++++--------- .../client-quicksight/src/models/models_3.ts | 9270 ++++++++-------- .../client-quicksight/src/models/models_4.ts | 8166 +++++++------- .../client-quicksight/src/models/models_5.ts | 2044 ++++ .../src/pagination/SearchTopicsPaginator.ts | 24 + .../client-quicksight/src/pagination/index.ts | 1 + .../src/protocols/Aws_restJson1.ts | 1947 +++- .../sdk-codegen/aws-models/quicksight.json | 2649 ++++- 86 files changed, 29006 insertions(+), 18917 deletions(-) create mode 100644 clients/client-quicksight/src/commands/DescribeDashboardsQAConfigurationCommand.ts create mode 100644 clients/client-quicksight/src/commands/SearchTopicsCommand.ts create mode 100644 clients/client-quicksight/src/commands/UpdateDashboardsQAConfigurationCommand.ts create mode 100644 clients/client-quicksight/src/models/models_5.ts create mode 100644 clients/client-quicksight/src/pagination/SearchTopicsPaginator.ts diff --git a/clients/client-quicksight/README.md b/clients/client-quicksight/README.md index b4d513b0d9f4..e7156d19045f 100644 --- a/clients/client-quicksight/README.md +++ b/clients/client-quicksight/README.md @@ -799,6 +799,14 @@ DescribeDashboardSnapshotJobResult [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DescribeDashboardSnapshotJobResultCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeDashboardSnapshotJobResultCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeDashboardSnapshotJobResultCommandOutput/) + +
+ +DescribeDashboardsQAConfiguration + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DescribeDashboardsQAConfigurationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeDashboardsQAConfigurationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeDashboardsQAConfigurationCommandOutput/) +
@@ -1423,6 +1431,14 @@ SearchGroups [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/SearchGroupsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/SearchGroupsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/SearchGroupsCommandOutput/) +
+
+ +SearchTopics + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/SearchTopicsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/SearchTopicsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/SearchTopicsCommandOutput/) +
@@ -1567,6 +1583,14 @@ UpdateDashboardPublishedVersion [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateDashboardPublishedVersionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateDashboardPublishedVersionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateDashboardPublishedVersionCommandOutput/) +
+
+ +UpdateDashboardsQAConfiguration + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateDashboardsQAConfigurationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateDashboardsQAConfigurationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateDashboardsQAConfigurationCommandOutput/) +
diff --git a/clients/client-quicksight/src/QuickSight.ts b/clients/client-quicksight/src/QuickSight.ts index 83d2d326ccf4..c6ee37bf3b98 100644 --- a/clients/client-quicksight/src/QuickSight.ts +++ b/clients/client-quicksight/src/QuickSight.ts @@ -336,6 +336,11 @@ import { DescribeDashboardSnapshotJobResultCommandInput, DescribeDashboardSnapshotJobResultCommandOutput, } from "./commands/DescribeDashboardSnapshotJobResultCommand"; +import { + DescribeDashboardsQAConfigurationCommand, + DescribeDashboardsQAConfigurationCommandInput, + DescribeDashboardsQAConfigurationCommandOutput, +} from "./commands/DescribeDashboardsQAConfigurationCommand"; import { DescribeDataSetCommand, DescribeDataSetCommandInput, @@ -702,6 +707,11 @@ import { SearchGroupsCommandInput, SearchGroupsCommandOutput, } from "./commands/SearchGroupsCommand"; +import { + SearchTopicsCommand, + SearchTopicsCommandInput, + SearchTopicsCommandOutput, +} from "./commands/SearchTopicsCommand"; import { StartAssetBundleExportJobCommand, StartAssetBundleExportJobCommandInput, @@ -784,6 +794,11 @@ import { UpdateDashboardPublishedVersionCommandInput, UpdateDashboardPublishedVersionCommandOutput, } from "./commands/UpdateDashboardPublishedVersionCommand"; +import { + UpdateDashboardsQAConfigurationCommand, + UpdateDashboardsQAConfigurationCommandInput, + UpdateDashboardsQAConfigurationCommandOutput, +} from "./commands/UpdateDashboardsQAConfigurationCommand"; import { UpdateDataSetCommand, UpdateDataSetCommandInput, @@ -985,6 +1000,7 @@ const commands = { DescribeDashboardPermissionsCommand, DescribeDashboardSnapshotJobCommand, DescribeDashboardSnapshotJobResultCommand, + DescribeDashboardsQAConfigurationCommand, DescribeDataSetCommand, DescribeDataSetPermissionsCommand, DescribeDataSetRefreshPropertiesCommand, @@ -1063,6 +1079,7 @@ const commands = { SearchDataSourcesCommand, SearchFoldersCommand, SearchGroupsCommand, + SearchTopicsCommand, StartAssetBundleExportJobCommand, StartAssetBundleImportJobCommand, StartDashboardSnapshotJobCommand, @@ -1081,6 +1098,7 @@ const commands = { UpdateDashboardLinksCommand, UpdateDashboardPermissionsCommand, UpdateDashboardPublishedVersionCommand, + UpdateDashboardsQAConfigurationCommand, UpdateDataSetCommand, UpdateDataSetPermissionsCommand, UpdateDataSourceCommand, @@ -2256,6 +2274,23 @@ export interface QuickSight { cb: (err: any, data?: DescribeDashboardSnapshotJobResultCommandOutput) => void ): void; + /** + * @see {@link DescribeDashboardsQAConfigurationCommand} + */ + describeDashboardsQAConfiguration( + args: DescribeDashboardsQAConfigurationCommandInput, + options?: __HttpHandlerOptions + ): Promise; + describeDashboardsQAConfiguration( + args: DescribeDashboardsQAConfigurationCommandInput, + cb: (err: any, data?: DescribeDashboardsQAConfigurationCommandOutput) => void + ): void; + describeDashboardsQAConfiguration( + args: DescribeDashboardsQAConfigurationCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DescribeDashboardsQAConfigurationCommandOutput) => void + ): void; + /** * @see {@link DescribeDataSetCommand} */ @@ -3456,6 +3491,17 @@ export interface QuickSight { cb: (err: any, data?: SearchGroupsCommandOutput) => void ): void; + /** + * @see {@link SearchTopicsCommand} + */ + searchTopics(args: SearchTopicsCommandInput, options?: __HttpHandlerOptions): Promise; + searchTopics(args: SearchTopicsCommandInput, cb: (err: any, data?: SearchTopicsCommandOutput) => void): void; + searchTopics( + args: SearchTopicsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: SearchTopicsCommandOutput) => void + ): void; + /** * @see {@link StartAssetBundleExportJobCommand} */ @@ -3738,6 +3784,23 @@ export interface QuickSight { cb: (err: any, data?: UpdateDashboardPublishedVersionCommandOutput) => void ): void; + /** + * @see {@link UpdateDashboardsQAConfigurationCommand} + */ + updateDashboardsQAConfiguration( + args: UpdateDashboardsQAConfigurationCommandInput, + options?: __HttpHandlerOptions + ): Promise; + updateDashboardsQAConfiguration( + args: UpdateDashboardsQAConfigurationCommandInput, + cb: (err: any, data?: UpdateDashboardsQAConfigurationCommandOutput) => void + ): void; + updateDashboardsQAConfiguration( + args: UpdateDashboardsQAConfigurationCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: UpdateDashboardsQAConfigurationCommandOutput) => void + ): void; + /** * @see {@link UpdateDataSetCommand} */ diff --git a/clients/client-quicksight/src/QuickSightClient.ts b/clients/client-quicksight/src/QuickSightClient.ts index e38f9552c33c..182b459342d0 100644 --- a/clients/client-quicksight/src/QuickSightClient.ts +++ b/clients/client-quicksight/src/QuickSightClient.ts @@ -259,6 +259,10 @@ import { DescribeDashboardSnapshotJobResultCommandInput, DescribeDashboardSnapshotJobResultCommandOutput, } from "./commands/DescribeDashboardSnapshotJobResultCommand"; +import { + DescribeDashboardsQAConfigurationCommandInput, + DescribeDashboardsQAConfigurationCommandOutput, +} from "./commands/DescribeDashboardsQAConfigurationCommand"; import { DescribeDataSetCommandInput, DescribeDataSetCommandOutput } from "./commands/DescribeDataSetCommand"; import { DescribeDataSetPermissionsCommandInput, @@ -457,6 +461,7 @@ import { SearchDataSetsCommandInput, SearchDataSetsCommandOutput } from "./comma import { SearchDataSourcesCommandInput, SearchDataSourcesCommandOutput } from "./commands/SearchDataSourcesCommand"; import { SearchFoldersCommandInput, SearchFoldersCommandOutput } from "./commands/SearchFoldersCommand"; import { SearchGroupsCommandInput, SearchGroupsCommandOutput } from "./commands/SearchGroupsCommand"; +import { SearchTopicsCommandInput, SearchTopicsCommandOutput } from "./commands/SearchTopicsCommand"; import { StartAssetBundleExportJobCommandInput, StartAssetBundleExportJobCommandOutput, @@ -514,6 +519,10 @@ import { UpdateDashboardPublishedVersionCommandInput, UpdateDashboardPublishedVersionCommandOutput, } from "./commands/UpdateDashboardPublishedVersionCommand"; +import { + UpdateDashboardsQAConfigurationCommandInput, + UpdateDashboardsQAConfigurationCommandOutput, +} from "./commands/UpdateDashboardsQAConfigurationCommand"; import { UpdateDataSetCommandInput, UpdateDataSetCommandOutput } from "./commands/UpdateDataSetCommand"; import { UpdateDataSetPermissionsCommandInput, @@ -688,6 +697,7 @@ export type ServiceInputTypes = | DescribeDashboardPermissionsCommandInput | DescribeDashboardSnapshotJobCommandInput | DescribeDashboardSnapshotJobResultCommandInput + | DescribeDashboardsQAConfigurationCommandInput | DescribeDataSetCommandInput | DescribeDataSetPermissionsCommandInput | DescribeDataSetRefreshPropertiesCommandInput @@ -766,6 +776,7 @@ export type ServiceInputTypes = | SearchDataSourcesCommandInput | SearchFoldersCommandInput | SearchGroupsCommandInput + | SearchTopicsCommandInput | StartAssetBundleExportJobCommandInput | StartAssetBundleImportJobCommandInput | StartDashboardSnapshotJobCommandInput @@ -784,6 +795,7 @@ export type ServiceInputTypes = | UpdateDashboardLinksCommandInput | UpdateDashboardPermissionsCommandInput | UpdateDashboardPublishedVersionCommandInput + | UpdateDashboardsQAConfigurationCommandInput | UpdateDataSetCommandInput | UpdateDataSetPermissionsCommandInput | UpdateDataSourceCommandInput @@ -891,6 +903,7 @@ export type ServiceOutputTypes = | DescribeDashboardPermissionsCommandOutput | DescribeDashboardSnapshotJobCommandOutput | DescribeDashboardSnapshotJobResultCommandOutput + | DescribeDashboardsQAConfigurationCommandOutput | DescribeDataSetCommandOutput | DescribeDataSetPermissionsCommandOutput | DescribeDataSetRefreshPropertiesCommandOutput @@ -969,6 +982,7 @@ export type ServiceOutputTypes = | SearchDataSourcesCommandOutput | SearchFoldersCommandOutput | SearchGroupsCommandOutput + | SearchTopicsCommandOutput | StartAssetBundleExportJobCommandOutput | StartAssetBundleImportJobCommandOutput | StartDashboardSnapshotJobCommandOutput @@ -987,6 +1001,7 @@ export type ServiceOutputTypes = | UpdateDashboardLinksCommandOutput | UpdateDashboardPermissionsCommandOutput | UpdateDashboardPublishedVersionCommandOutput + | UpdateDashboardsQAConfigurationCommandOutput | UpdateDataSetCommandOutput | UpdateDataSetPermissionsCommandOutput | UpdateDataSourceCommandOutput diff --git a/clients/client-quicksight/src/commands/BatchCreateTopicReviewedAnswerCommand.ts b/clients/client-quicksight/src/commands/BatchCreateTopicReviewedAnswerCommand.ts index 26b62e238998..24a25f4d0bd0 100644 --- a/clients/client-quicksight/src/commands/BatchCreateTopicReviewedAnswerCommand.ts +++ b/clients/client-quicksight/src/commands/BatchCreateTopicReviewedAnswerCommand.ts @@ -9,7 +9,7 @@ import { BatchCreateTopicReviewedAnswerResponse } from "../models/models_2"; import { BatchCreateTopicReviewedAnswerRequest, BatchCreateTopicReviewedAnswerRequestFilterSensitiveLog, -} from "../models/models_4"; +} from "../models/models_5"; import { de_BatchCreateTopicReviewedAnswerCommand, se_BatchCreateTopicReviewedAnswerCommand, diff --git a/clients/client-quicksight/src/commands/CreateAccountCustomizationCommand.ts b/clients/client-quicksight/src/commands/CreateAccountCustomizationCommand.ts index 3caeee0c9178..31ce615e16b1 100644 --- a/clients/client-quicksight/src/commands/CreateAccountCustomizationCommand.ts +++ b/clients/client-quicksight/src/commands/CreateAccountCustomizationCommand.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 { CreateAccountCustomizationRequest, CreateAccountCustomizationResponse } from "../models/models_2"; +import { CreateAccountCustomizationRequest, CreateAccountCustomizationResponse } from "../models/models_3"; import { de_CreateAccountCustomizationCommand, se_CreateAccountCustomizationCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/CreateAccountSubscriptionCommand.ts b/clients/client-quicksight/src/commands/CreateAccountSubscriptionCommand.ts index d05c40ddbbb7..53e96e5db2e4 100644 --- a/clients/client-quicksight/src/commands/CreateAccountSubscriptionCommand.ts +++ b/clients/client-quicksight/src/commands/CreateAccountSubscriptionCommand.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 { CreateAccountSubscriptionRequest, CreateAccountSubscriptionResponse } from "../models/models_2"; +import { CreateAccountSubscriptionRequest, CreateAccountSubscriptionResponse } from "../models/models_3"; import { de_CreateAccountSubscriptionCommand, se_CreateAccountSubscriptionCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/CreateAnalysisCommand.ts b/clients/client-quicksight/src/commands/CreateAnalysisCommand.ts index e6b7d42f2cdc..1c1225b750ae 100644 --- a/clients/client-quicksight/src/commands/CreateAnalysisCommand.ts +++ b/clients/client-quicksight/src/commands/CreateAnalysisCommand.ts @@ -9,7 +9,7 @@ import { CreateAnalysisRequest, CreateAnalysisRequestFilterSensitiveLog, CreateAnalysisResponse, -} from "../models/models_2"; +} from "../models/models_3"; import { de_CreateAnalysisCommand, se_CreateAnalysisCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; @@ -128,6 +128,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * FontConfiguration: { // FontConfiguration * FontSize: { // FontSize * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -135,6 +136,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -163,6 +165,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -170,6 +173,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -213,6 +217,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -220,6 +225,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -261,6 +267,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -268,6 +275,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -291,6 +299,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -298,6 +307,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -1146,6 +1156,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * ], * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * PivotTableVisual: { // PivotTableVisual * VisualId: "STRING_VALUE", // required @@ -1610,6 +1621,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * ], * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * BarChartVisual: { // BarChartVisual * VisualId: "STRING_VALUE", // required @@ -1958,6 +1970,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { // DataLabelOptions * Visibility: "HIDDEN" || "VISIBLE", @@ -2217,6 +2230,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * KPIVisual: { // KPIVisual * VisualId: "STRING_VALUE", // required @@ -2540,6 +2554,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * PieChartVisual: { // PieChartVisual * VisualId: "STRING_VALUE", // required @@ -2654,6 +2669,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -2832,6 +2848,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * GaugeChartVisual: { // GaugeChartVisual * VisualId: "STRING_VALUE", // required @@ -2952,6 +2969,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * ], * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * LineChartVisual: { // LineChartVisual * VisualId: "STRING_VALUE", // required @@ -3230,6 +3248,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -3366,6 +3385,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * HeatMapVisual: { // HeatMapVisual * VisualId: "STRING_VALUE", // required @@ -3412,6 +3432,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -3496,6 +3517,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * }, * ], * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * TreeMapVisual: { // TreeMapVisual * VisualId: "STRING_VALUE", // required @@ -3541,6 +3563,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: "", * Tooltip: "", @@ -3548,6 +3571,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * GeospatialMapVisual: { // GeospatialMapVisual * VisualId: "STRING_VALUE", // required @@ -3608,6 +3632,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * }, * ColumnHierarchies: "", * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * FilledMapVisual: { // FilledMapVisual * VisualId: "STRING_VALUE", // required @@ -3657,6 +3682,284 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * }, * ColumnHierarchies: "", * Actions: "", + * VisualContentAltText: "STRING_VALUE", + * }, + * LayerMapVisual: { // LayerMapVisual + * VisualId: "STRING_VALUE", // required + * Title: "", + * Subtitle: "", + * ChartConfiguration: { // GeospatialLayerMapConfiguration + * Legend: "", + * MapLayers: [ // GeospatialMapLayerList + * { // GeospatialLayerItem + * LayerId: "STRING_VALUE", // required + * LayerType: "POINT" || "LINE" || "POLYGON", + * DataSource: { // GeospatialDataSourceItem + * StaticFileDataSource: { // GeospatialStaticFileSource + * StaticFileId: "STRING_VALUE", // required + * }, + * }, + * Label: "STRING_VALUE", + * Visibility: "HIDDEN" || "VISIBLE", + * LayerDefinition: { // GeospatialLayerDefinition + * PointLayer: { // GeospatialPointLayer + * Style: { // GeospatialPointStyle + * CircleSymbolStyle: { // GeospatialCircleSymbolStyle + * FillColor: { // GeospatialColor + * Solid: { // GeospatialSolidColor + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { // GeospatialGradientColor + * StepColors: [ // GeospatialGradientStepColorList // required + * { // GeospatialGradientStepColor + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { // GeospatialNullDataSettings + * SymbolStyle: { // GeospatialNullSymbolStyle + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { // GeospatialCategoricalColor + * CategoryDataColors: [ // GeospatialCategoricalDataColorList // required + * { // GeospatialCategoricalDataColor + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeWidth: { // GeospatialLineWidth + * LineWidth: Number("double"), + * }, + * CircleRadius: { // GeospatialCircleRadius + * Radius: Number("double"), + * }, + * }, + * }, + * }, + * LineLayer: { // GeospatialLineLayer + * Style: { // GeospatialLineStyle + * LineSymbolStyle: { // GeospatialLineSymbolStyle + * FillColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * LineWidth: { + * LineWidth: Number("double"), + * }, + * }, + * }, + * }, + * PolygonLayer: { // GeospatialPolygonLayer + * Style: { // GeospatialPolygonStyle + * PolygonSymbolStyle: { // GeospatialPolygonSymbolStyle + * FillColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeWidth: { + * LineWidth: Number("double"), + * }, + * }, + * }, + * }, + * }, + * Tooltip: "", + * JoinDefinition: { // GeospatialLayerJoinDefinition + * ShapeKeyField: "STRING_VALUE", + * DatasetKeyField: { + * FieldId: "STRING_VALUE", // required + * Column: "", // required + * FormatConfiguration: { + * StringFormatConfiguration: "", + * NumberFormatConfiguration: "", + * DateTimeFormatConfiguration: "", + * }, + * }, + * ColorField: { // GeospatialLayerColorField + * ColorDimensionsFields: [ // GeospatialLayerDimensionFieldList + * "", + * ], + * ColorValuesFields: [ // GeospatialLayerMeasureFieldList + * "", + * ], + * }, + * }, + * Actions: [ // LayerCustomActionList + * { // LayerCustomAction + * CustomActionId: "STRING_VALUE", // required + * Name: "STRING_VALUE", // required + * Status: "ENABLED" || "DISABLED", + * Trigger: "DATA_POINT_CLICK" || "DATA_POINT_MENU", // required + * ActionOperations: [ // LayerCustomActionOperationList // required + * { // LayerCustomActionOperation + * FilterOperation: "", + * NavigationOperation: "", + * URLOperation: "", + * SetParametersOperation: "", + * }, + * ], + * }, + * ], + * }, + * ], + * MapState: { // GeospatialMapState + * Bounds: { + * North: Number("double"), // required + * South: Number("double"), // required + * West: Number("double"), // required + * East: Number("double"), // required + * }, + * MapNavigation: "ENABLED" || "DISABLED", + * }, + * MapStyle: { // GeospatialMapStyle + * BaseMapStyle: "LIGHT_GRAY" || "DARK_GRAY" || "STREET" || "IMAGERY", + * BackgroundColor: "STRING_VALUE", + * BaseMapVisibility: "HIDDEN" || "VISIBLE", + * }, + * Interactions: "", + * }, + * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * FunnelChartVisual: { // FunnelChartVisual * VisualId: "STRING_VALUE", // required @@ -3694,6 +3997,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * ScatterPlotVisual: { // ScatterPlotVisual * VisualId: "STRING_VALUE", // required @@ -3731,6 +4035,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * ComboChartVisual: { // ComboChartVisual * VisualId: "STRING_VALUE", // required @@ -3807,6 +4112,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * BoxPlotVisual: { // BoxPlotVisual * VisualId: "STRING_VALUE", // required @@ -3882,6 +4188,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * WaterfallVisual: { // WaterfallVisual * VisualId: "STRING_VALUE", // required @@ -3920,6 +4227,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * HistogramVisual: { // HistogramVisual * VisualId: "STRING_VALUE", // required @@ -3953,6 +4261,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * Interactions: "", * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * WordCloudVisual: { // WordCloudVisual * VisualId: "STRING_VALUE", // required @@ -3986,6 +4295,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * InsightVisual: { // InsightVisual * VisualId: "STRING_VALUE", // required @@ -4078,6 +4388,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * }, * Actions: "", * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * SankeyDiagramVisual: { // SankeyDiagramVisual * VisualId: "STRING_VALUE", // required @@ -4100,6 +4411,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * Interactions: "", * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * CustomContentVisual: { // CustomContentVisual * VisualId: "STRING_VALUE", // required @@ -4113,6 +4425,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * }, * Actions: "", * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * EmptyVisual: { // EmptyVisual * VisualId: "STRING_VALUE", // required @@ -4164,6 +4477,52 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", + * }, + * PluginVisual: { // PluginVisual + * VisualId: "STRING_VALUE", // required + * PluginArn: "STRING_VALUE", // required + * Title: "", + * Subtitle: "", + * ChartConfiguration: { // PluginVisualConfiguration + * FieldWells: [ // PluginVisualFieldWells + * { // PluginVisualFieldWell + * AxisName: "GROUP_BY" || "VALUE", + * Dimensions: "", + * Measures: "", + * Unaggregated: [ + * { + * FieldId: "STRING_VALUE", // required + * Column: "", // required + * FormatConfiguration: { + * StringFormatConfiguration: "", + * NumberFormatConfiguration: "", + * DateTimeFormatConfiguration: "", + * }, + * }, + * ], + * }, + * ], + * VisualOptions: { // PluginVisualOptions + * VisualProperties: [ // PluginVisualPropertiesList + * { // PluginVisualProperty + * Name: "STRING_VALUE", + * Value: "STRING_VALUE", + * }, + * ], + * }, + * SortConfiguration: { // PluginVisualSortConfiguration + * PluginVisualTableQuerySort: { // PluginVisualTableQuerySort + * RowSort: [ + * "", + * ], + * ItemsLimitConfiguration: { // PluginVisualItemsLimitConfiguration + * ItemsLimit: Number("long"), + * }, + * }, + * }, + * }, + * VisualContentAltText: "STRING_VALUE", * }, * }, * ], @@ -4173,6 +4532,46 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * Content: "STRING_VALUE", * }, * ], + * Images: [ // SheetImageList + * { // SheetImage + * SheetImageId: "STRING_VALUE", // required + * Source: { // SheetImageSource + * SheetImageStaticFileSource: { // SheetImageStaticFileSource + * StaticFileId: "STRING_VALUE", // required + * }, + * }, + * Scaling: { // SheetImageScalingConfiguration + * ScalingType: "SCALE_TO_WIDTH" || "SCALE_TO_HEIGHT" || "SCALE_TO_CONTAINER" || "SCALE_NONE", + * }, + * Tooltip: { // SheetImageTooltipConfiguration + * TooltipText: { // SheetImageTooltipText + * PlainText: "STRING_VALUE", + * }, + * Visibility: "HIDDEN" || "VISIBLE", + * }, + * ImageContentAltText: "STRING_VALUE", + * Interactions: { // ImageInteractionOptions + * ImageMenuOption: { // ImageMenuOption + * AvailabilityStatus: "ENABLED" || "DISABLED", + * }, + * }, + * Actions: [ // ImageCustomActionList + * { // ImageCustomAction + * CustomActionId: "STRING_VALUE", // required + * Name: "STRING_VALUE", // required + * Status: "ENABLED" || "DISABLED", + * Trigger: "CLICK" || "MENU", // required + * ActionOperations: [ // ImageCustomActionOperationList // required + * { // ImageCustomActionOperation + * NavigationOperation: "", + * URLOperation: "", + * SetParametersOperation: "", + * }, + * ], + * }, + * ], + * }, + * ], * Layouts: [ // LayoutList * { // Layout * Configuration: { // LayoutConfiguration @@ -4180,7 +4579,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * Elements: [ // GridLayoutElementList // required * { // GridLayoutElement * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * ColumnIndex: Number("int"), * ColumnSpan: Number("int"), // required * RowIndex: Number("int"), @@ -4198,7 +4597,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * Elements: [ // FreeFromLayoutElementList // required * { // FreeFormLayoutElement * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * XAxisLocation: "STRING_VALUE", // required * YAxisLocation: "STRING_VALUE", // required * Width: "STRING_VALUE", // required @@ -4244,7 +4643,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * Elements: [ // required * { * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * XAxisLocation: "STRING_VALUE", // required * YAxisLocation: "STRING_VALUE", // required * Width: "STRING_VALUE", // required @@ -4384,7 +4783,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * Elements: [ // required * { * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * ColumnIndex: Number("int"), * ColumnSpan: Number("int"), // required * RowIndex: Number("int"), @@ -5052,6 +5451,36 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * QueryExecutionOptions: { // QueryExecutionOptions * QueryExecutionMode: "AUTO" || "MANUAL", * }, + * StaticFiles: [ // StaticFileList + * { // StaticFile + * ImageStaticFile: { // ImageStaticFile + * StaticFileId: "STRING_VALUE", // required + * Source: { // StaticFileSource + * UrlOptions: { // StaticFileUrlSourceOptions + * Url: "STRING_VALUE", // required + * }, + * S3Options: { // StaticFileS3SourceOptions + * BucketName: "STRING_VALUE", // required + * ObjectKey: "STRING_VALUE", // required + * Region: "STRING_VALUE", // required + * }, + * }, + * }, + * SpatialStaticFile: { // SpatialStaticFile + * StaticFileId: "STRING_VALUE", // required + * Source: { + * UrlOptions: { + * Url: "STRING_VALUE", // required + * }, + * S3Options: { + * BucketName: "STRING_VALUE", // required + * ObjectKey: "STRING_VALUE", // required + * Region: "STRING_VALUE", // required + * }, + * }, + * }, + * }, + * ], * }, * ValidationStrategy: { // ValidationStrategy * Mode: "STRICT" || "LENIENT", // required diff --git a/clients/client-quicksight/src/commands/CreateBrandCommand.ts b/clients/client-quicksight/src/commands/CreateBrandCommand.ts index 6a4a373e968a..c57818ceef07 100644 --- a/clients/client-quicksight/src/commands/CreateBrandCommand.ts +++ b/clients/client-quicksight/src/commands/CreateBrandCommand.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 { CreateBrandRequest, CreateBrandResponse } from "../models/models_2"; +import { CreateBrandRequest, CreateBrandResponse } from "../models/models_3"; import { de_CreateBrandCommand, se_CreateBrandCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/CreateCustomPermissionsCommand.ts b/clients/client-quicksight/src/commands/CreateCustomPermissionsCommand.ts index 3ec166bcd2e9..36f8ea253859 100644 --- a/clients/client-quicksight/src/commands/CreateCustomPermissionsCommand.ts +++ b/clients/client-quicksight/src/commands/CreateCustomPermissionsCommand.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 { CreateCustomPermissionsRequest, CreateCustomPermissionsResponse } from "../models/models_2"; +import { CreateCustomPermissionsRequest, CreateCustomPermissionsResponse } from "../models/models_3"; import { de_CreateCustomPermissionsCommand, se_CreateCustomPermissionsCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/CreateDashboardCommand.ts b/clients/client-quicksight/src/commands/CreateDashboardCommand.ts index c17e57f50f74..062dbf81e42b 100644 --- a/clients/client-quicksight/src/commands/CreateDashboardCommand.ts +++ b/clients/client-quicksight/src/commands/CreateDashboardCommand.ts @@ -9,7 +9,7 @@ import { CreateDashboardRequest, CreateDashboardRequestFilterSensitiveLog, CreateDashboardResponse, -} from "../models/models_2"; +} from "../models/models_3"; import { de_CreateDashboardCommand, se_CreateDashboardCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; @@ -174,6 +174,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * FontConfiguration: { // FontConfiguration * FontSize: { // FontSize * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -181,6 +182,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -209,6 +211,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -216,6 +219,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -259,6 +263,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -266,6 +271,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -307,6 +313,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -314,6 +321,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -337,6 +345,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -344,6 +353,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -1192,6 +1202,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * ], * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * PivotTableVisual: { // PivotTableVisual * VisualId: "STRING_VALUE", // required @@ -1656,6 +1667,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * ], * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * BarChartVisual: { // BarChartVisual * VisualId: "STRING_VALUE", // required @@ -2004,6 +2016,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { // DataLabelOptions * Visibility: "HIDDEN" || "VISIBLE", @@ -2263,6 +2276,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * KPIVisual: { // KPIVisual * VisualId: "STRING_VALUE", // required @@ -2586,6 +2600,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * PieChartVisual: { // PieChartVisual * VisualId: "STRING_VALUE", // required @@ -2700,6 +2715,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -2876,6 +2892,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * GaugeChartVisual: { // GaugeChartVisual * VisualId: "STRING_VALUE", // required @@ -2996,6 +3013,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * ], * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * LineChartVisual: { // LineChartVisual * VisualId: "STRING_VALUE", // required @@ -3274,6 +3292,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -3410,6 +3429,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * HeatMapVisual: { // HeatMapVisual * VisualId: "STRING_VALUE", // required @@ -3456,6 +3476,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -3540,6 +3561,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * }, * ], * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * TreeMapVisual: { // TreeMapVisual * VisualId: "STRING_VALUE", // required @@ -3585,6 +3607,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: "", * Tooltip: "", @@ -3592,6 +3615,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * GeospatialMapVisual: { // GeospatialMapVisual * VisualId: "STRING_VALUE", // required @@ -3652,6 +3676,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * }, * ColumnHierarchies: "", * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * FilledMapVisual: { // FilledMapVisual * VisualId: "STRING_VALUE", // required @@ -3701,6 +3726,284 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * }, * ColumnHierarchies: "", * Actions: "", + * VisualContentAltText: "STRING_VALUE", + * }, + * LayerMapVisual: { // LayerMapVisual + * VisualId: "STRING_VALUE", // required + * Title: "", + * Subtitle: "", + * ChartConfiguration: { // GeospatialLayerMapConfiguration + * Legend: "", + * MapLayers: [ // GeospatialMapLayerList + * { // GeospatialLayerItem + * LayerId: "STRING_VALUE", // required + * LayerType: "POINT" || "LINE" || "POLYGON", + * DataSource: { // GeospatialDataSourceItem + * StaticFileDataSource: { // GeospatialStaticFileSource + * StaticFileId: "STRING_VALUE", // required + * }, + * }, + * Label: "STRING_VALUE", + * Visibility: "HIDDEN" || "VISIBLE", + * LayerDefinition: { // GeospatialLayerDefinition + * PointLayer: { // GeospatialPointLayer + * Style: { // GeospatialPointStyle + * CircleSymbolStyle: { // GeospatialCircleSymbolStyle + * FillColor: { // GeospatialColor + * Solid: { // GeospatialSolidColor + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { // GeospatialGradientColor + * StepColors: [ // GeospatialGradientStepColorList // required + * { // GeospatialGradientStepColor + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { // GeospatialNullDataSettings + * SymbolStyle: { // GeospatialNullSymbolStyle + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { // GeospatialCategoricalColor + * CategoryDataColors: [ // GeospatialCategoricalDataColorList // required + * { // GeospatialCategoricalDataColor + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeWidth: { // GeospatialLineWidth + * LineWidth: Number("double"), + * }, + * CircleRadius: { // GeospatialCircleRadius + * Radius: Number("double"), + * }, + * }, + * }, + * }, + * LineLayer: { // GeospatialLineLayer + * Style: { // GeospatialLineStyle + * LineSymbolStyle: { // GeospatialLineSymbolStyle + * FillColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * LineWidth: { + * LineWidth: Number("double"), + * }, + * }, + * }, + * }, + * PolygonLayer: { // GeospatialPolygonLayer + * Style: { // GeospatialPolygonStyle + * PolygonSymbolStyle: { // GeospatialPolygonSymbolStyle + * FillColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeWidth: { + * LineWidth: Number("double"), + * }, + * }, + * }, + * }, + * }, + * Tooltip: "", + * JoinDefinition: { // GeospatialLayerJoinDefinition + * ShapeKeyField: "STRING_VALUE", + * DatasetKeyField: { + * FieldId: "STRING_VALUE", // required + * Column: "", // required + * FormatConfiguration: { + * StringFormatConfiguration: "", + * NumberFormatConfiguration: "", + * DateTimeFormatConfiguration: "", + * }, + * }, + * ColorField: { // GeospatialLayerColorField + * ColorDimensionsFields: [ // GeospatialLayerDimensionFieldList + * "", + * ], + * ColorValuesFields: [ // GeospatialLayerMeasureFieldList + * "", + * ], + * }, + * }, + * Actions: [ // LayerCustomActionList + * { // LayerCustomAction + * CustomActionId: "STRING_VALUE", // required + * Name: "STRING_VALUE", // required + * Status: "ENABLED" || "DISABLED", + * Trigger: "DATA_POINT_CLICK" || "DATA_POINT_MENU", // required + * ActionOperations: [ // LayerCustomActionOperationList // required + * { // LayerCustomActionOperation + * FilterOperation: "", + * NavigationOperation: "", + * URLOperation: "", + * SetParametersOperation: "", + * }, + * ], + * }, + * ], + * }, + * ], + * MapState: { // GeospatialMapState + * Bounds: { + * North: Number("double"), // required + * South: Number("double"), // required + * West: Number("double"), // required + * East: Number("double"), // required + * }, + * MapNavigation: "ENABLED" || "DISABLED", + * }, + * MapStyle: { // GeospatialMapStyle + * BaseMapStyle: "LIGHT_GRAY" || "DARK_GRAY" || "STREET" || "IMAGERY", + * BackgroundColor: "STRING_VALUE", + * BaseMapVisibility: "HIDDEN" || "VISIBLE", + * }, + * Interactions: "", + * }, + * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * FunnelChartVisual: { // FunnelChartVisual * VisualId: "STRING_VALUE", // required @@ -3738,6 +4041,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * ScatterPlotVisual: { // ScatterPlotVisual * VisualId: "STRING_VALUE", // required @@ -3775,6 +4079,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * ComboChartVisual: { // ComboChartVisual * VisualId: "STRING_VALUE", // required @@ -3851,6 +4156,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * BoxPlotVisual: { // BoxPlotVisual * VisualId: "STRING_VALUE", // required @@ -3926,6 +4232,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * WaterfallVisual: { // WaterfallVisual * VisualId: "STRING_VALUE", // required @@ -3964,6 +4271,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * HistogramVisual: { // HistogramVisual * VisualId: "STRING_VALUE", // required @@ -3997,6 +4305,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Interactions: "", * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * WordCloudVisual: { // WordCloudVisual * VisualId: "STRING_VALUE", // required @@ -4030,6 +4339,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * InsightVisual: { // InsightVisual * VisualId: "STRING_VALUE", // required @@ -4122,6 +4432,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * }, * Actions: "", * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * SankeyDiagramVisual: { // SankeyDiagramVisual * VisualId: "STRING_VALUE", // required @@ -4144,6 +4455,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Interactions: "", * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * CustomContentVisual: { // CustomContentVisual * VisualId: "STRING_VALUE", // required @@ -4157,6 +4469,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * }, * Actions: "", * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * EmptyVisual: { // EmptyVisual * VisualId: "STRING_VALUE", // required @@ -4208,6 +4521,52 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", + * }, + * PluginVisual: { // PluginVisual + * VisualId: "STRING_VALUE", // required + * PluginArn: "STRING_VALUE", // required + * Title: "", + * Subtitle: "", + * ChartConfiguration: { // PluginVisualConfiguration + * FieldWells: [ // PluginVisualFieldWells + * { // PluginVisualFieldWell + * AxisName: "GROUP_BY" || "VALUE", + * Dimensions: "", + * Measures: "", + * Unaggregated: [ + * { + * FieldId: "STRING_VALUE", // required + * Column: "", // required + * FormatConfiguration: { + * StringFormatConfiguration: "", + * NumberFormatConfiguration: "", + * DateTimeFormatConfiguration: "", + * }, + * }, + * ], + * }, + * ], + * VisualOptions: { // PluginVisualOptions + * VisualProperties: [ // PluginVisualPropertiesList + * { // PluginVisualProperty + * Name: "STRING_VALUE", + * Value: "STRING_VALUE", + * }, + * ], + * }, + * SortConfiguration: { // PluginVisualSortConfiguration + * PluginVisualTableQuerySort: { // PluginVisualTableQuerySort + * RowSort: [ + * "", + * ], + * ItemsLimitConfiguration: { // PluginVisualItemsLimitConfiguration + * ItemsLimit: Number("long"), + * }, + * }, + * }, + * }, + * VisualContentAltText: "STRING_VALUE", * }, * }, * ], @@ -4217,6 +4576,46 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Content: "STRING_VALUE", * }, * ], + * Images: [ // SheetImageList + * { // SheetImage + * SheetImageId: "STRING_VALUE", // required + * Source: { // SheetImageSource + * SheetImageStaticFileSource: { // SheetImageStaticFileSource + * StaticFileId: "STRING_VALUE", // required + * }, + * }, + * Scaling: { // SheetImageScalingConfiguration + * ScalingType: "SCALE_TO_WIDTH" || "SCALE_TO_HEIGHT" || "SCALE_TO_CONTAINER" || "SCALE_NONE", + * }, + * Tooltip: { // SheetImageTooltipConfiguration + * TooltipText: { // SheetImageTooltipText + * PlainText: "STRING_VALUE", + * }, + * Visibility: "HIDDEN" || "VISIBLE", + * }, + * ImageContentAltText: "STRING_VALUE", + * Interactions: { // ImageInteractionOptions + * ImageMenuOption: { // ImageMenuOption + * AvailabilityStatus: "ENABLED" || "DISABLED", + * }, + * }, + * Actions: [ // ImageCustomActionList + * { // ImageCustomAction + * CustomActionId: "STRING_VALUE", // required + * Name: "STRING_VALUE", // required + * Status: "ENABLED" || "DISABLED", + * Trigger: "CLICK" || "MENU", // required + * ActionOperations: [ // ImageCustomActionOperationList // required + * { // ImageCustomActionOperation + * NavigationOperation: "", + * URLOperation: "", + * SetParametersOperation: "", + * }, + * ], + * }, + * ], + * }, + * ], * Layouts: [ // LayoutList * { // Layout * Configuration: { // LayoutConfiguration @@ -4224,7 +4623,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Elements: [ // GridLayoutElementList // required * { // GridLayoutElement * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * ColumnIndex: Number("int"), * ColumnSpan: Number("int"), // required * RowIndex: Number("int"), @@ -4242,7 +4641,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Elements: [ // FreeFromLayoutElementList // required * { // FreeFormLayoutElement * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * XAxisLocation: "STRING_VALUE", // required * YAxisLocation: "STRING_VALUE", // required * Width: "STRING_VALUE", // required @@ -4288,7 +4687,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Elements: [ // required * { * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * XAxisLocation: "STRING_VALUE", // required * YAxisLocation: "STRING_VALUE", // required * Width: "STRING_VALUE", // required @@ -4428,7 +4827,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Elements: [ // required * { * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * ColumnIndex: Number("int"), * ColumnSpan: Number("int"), // required * RowIndex: Number("int"), @@ -5093,6 +5492,36 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * Timezone: "STRING_VALUE", * WeekStart: "SUNDAY" || "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY", * }, + * StaticFiles: [ // StaticFileList + * { // StaticFile + * ImageStaticFile: { // ImageStaticFile + * StaticFileId: "STRING_VALUE", // required + * Source: { // StaticFileSource + * UrlOptions: { // StaticFileUrlSourceOptions + * Url: "STRING_VALUE", // required + * }, + * S3Options: { // StaticFileS3SourceOptions + * BucketName: "STRING_VALUE", // required + * ObjectKey: "STRING_VALUE", // required + * Region: "STRING_VALUE", // required + * }, + * }, + * }, + * SpatialStaticFile: { // SpatialStaticFile + * StaticFileId: "STRING_VALUE", // required + * Source: { + * UrlOptions: { + * Url: "STRING_VALUE", // required + * }, + * S3Options: { + * BucketName: "STRING_VALUE", // required + * ObjectKey: "STRING_VALUE", // required + * Region: "STRING_VALUE", // required + * }, + * }, + * }, + * }, + * ], * }, * ValidationStrategy: { // ValidationStrategy * Mode: "STRICT" || "LENIENT", // required diff --git a/clients/client-quicksight/src/commands/CreateTemplateCommand.ts b/clients/client-quicksight/src/commands/CreateTemplateCommand.ts index cf499fea68d3..b09fcd8eb8dd 100644 --- a/clients/client-quicksight/src/commands/CreateTemplateCommand.ts +++ b/clients/client-quicksight/src/commands/CreateTemplateCommand.ts @@ -122,6 +122,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * FontConfiguration: { // FontConfiguration * FontSize: { // FontSize * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -129,6 +130,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -157,6 +159,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -164,6 +167,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -207,6 +211,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -214,6 +219,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -255,6 +261,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -262,6 +269,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -285,6 +293,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -292,6 +301,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -1140,6 +1150,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * ], * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * PivotTableVisual: { // PivotTableVisual * VisualId: "STRING_VALUE", // required @@ -1604,6 +1615,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * ], * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * BarChartVisual: { // BarChartVisual * VisualId: "STRING_VALUE", // required @@ -1952,6 +1964,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { // DataLabelOptions * Visibility: "HIDDEN" || "VISIBLE", @@ -2211,6 +2224,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * KPIVisual: { // KPIVisual * VisualId: "STRING_VALUE", // required @@ -2534,6 +2548,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * PieChartVisual: { // PieChartVisual * VisualId: "STRING_VALUE", // required @@ -2648,6 +2663,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -2826,6 +2842,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * GaugeChartVisual: { // GaugeChartVisual * VisualId: "STRING_VALUE", // required @@ -2946,6 +2963,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * ], * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * LineChartVisual: { // LineChartVisual * VisualId: "STRING_VALUE", // required @@ -3224,6 +3242,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -3360,6 +3379,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * HeatMapVisual: { // HeatMapVisual * VisualId: "STRING_VALUE", // required @@ -3406,6 +3426,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -3490,6 +3511,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * }, * ], * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * TreeMapVisual: { // TreeMapVisual * VisualId: "STRING_VALUE", // required @@ -3535,6 +3557,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: "", * Tooltip: "", @@ -3542,6 +3565,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * GeospatialMapVisual: { // GeospatialMapVisual * VisualId: "STRING_VALUE", // required @@ -3602,6 +3626,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * }, * ColumnHierarchies: "", * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * FilledMapVisual: { // FilledMapVisual * VisualId: "STRING_VALUE", // required @@ -3651,6 +3676,284 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * }, * ColumnHierarchies: "", * Actions: "", + * VisualContentAltText: "STRING_VALUE", + * }, + * LayerMapVisual: { // LayerMapVisual + * VisualId: "STRING_VALUE", // required + * Title: "", + * Subtitle: "", + * ChartConfiguration: { // GeospatialLayerMapConfiguration + * Legend: "", + * MapLayers: [ // GeospatialMapLayerList + * { // GeospatialLayerItem + * LayerId: "STRING_VALUE", // required + * LayerType: "POINT" || "LINE" || "POLYGON", + * DataSource: { // GeospatialDataSourceItem + * StaticFileDataSource: { // GeospatialStaticFileSource + * StaticFileId: "STRING_VALUE", // required + * }, + * }, + * Label: "STRING_VALUE", + * Visibility: "HIDDEN" || "VISIBLE", + * LayerDefinition: { // GeospatialLayerDefinition + * PointLayer: { // GeospatialPointLayer + * Style: { // GeospatialPointStyle + * CircleSymbolStyle: { // GeospatialCircleSymbolStyle + * FillColor: { // GeospatialColor + * Solid: { // GeospatialSolidColor + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { // GeospatialGradientColor + * StepColors: [ // GeospatialGradientStepColorList // required + * { // GeospatialGradientStepColor + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { // GeospatialNullDataSettings + * SymbolStyle: { // GeospatialNullSymbolStyle + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { // GeospatialCategoricalColor + * CategoryDataColors: [ // GeospatialCategoricalDataColorList // required + * { // GeospatialCategoricalDataColor + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeWidth: { // GeospatialLineWidth + * LineWidth: Number("double"), + * }, + * CircleRadius: { // GeospatialCircleRadius + * Radius: Number("double"), + * }, + * }, + * }, + * }, + * LineLayer: { // GeospatialLineLayer + * Style: { // GeospatialLineStyle + * LineSymbolStyle: { // GeospatialLineSymbolStyle + * FillColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * LineWidth: { + * LineWidth: Number("double"), + * }, + * }, + * }, + * }, + * PolygonLayer: { // GeospatialPolygonLayer + * Style: { // GeospatialPolygonStyle + * PolygonSymbolStyle: { // GeospatialPolygonSymbolStyle + * FillColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeWidth: { + * LineWidth: Number("double"), + * }, + * }, + * }, + * }, + * }, + * Tooltip: "", + * JoinDefinition: { // GeospatialLayerJoinDefinition + * ShapeKeyField: "STRING_VALUE", + * DatasetKeyField: { + * FieldId: "STRING_VALUE", // required + * Column: "", // required + * FormatConfiguration: { + * StringFormatConfiguration: "", + * NumberFormatConfiguration: "", + * DateTimeFormatConfiguration: "", + * }, + * }, + * ColorField: { // GeospatialLayerColorField + * ColorDimensionsFields: [ // GeospatialLayerDimensionFieldList + * "", + * ], + * ColorValuesFields: [ // GeospatialLayerMeasureFieldList + * "", + * ], + * }, + * }, + * Actions: [ // LayerCustomActionList + * { // LayerCustomAction + * CustomActionId: "STRING_VALUE", // required + * Name: "STRING_VALUE", // required + * Status: "ENABLED" || "DISABLED", + * Trigger: "DATA_POINT_CLICK" || "DATA_POINT_MENU", // required + * ActionOperations: [ // LayerCustomActionOperationList // required + * { // LayerCustomActionOperation + * FilterOperation: "", + * NavigationOperation: "", + * URLOperation: "", + * SetParametersOperation: "", + * }, + * ], + * }, + * ], + * }, + * ], + * MapState: { // GeospatialMapState + * Bounds: { + * North: Number("double"), // required + * South: Number("double"), // required + * West: Number("double"), // required + * East: Number("double"), // required + * }, + * MapNavigation: "ENABLED" || "DISABLED", + * }, + * MapStyle: { // GeospatialMapStyle + * BaseMapStyle: "LIGHT_GRAY" || "DARK_GRAY" || "STREET" || "IMAGERY", + * BackgroundColor: "STRING_VALUE", + * BaseMapVisibility: "HIDDEN" || "VISIBLE", + * }, + * Interactions: "", + * }, + * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * FunnelChartVisual: { // FunnelChartVisual * VisualId: "STRING_VALUE", // required @@ -3688,6 +3991,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * ScatterPlotVisual: { // ScatterPlotVisual * VisualId: "STRING_VALUE", // required @@ -3725,6 +4029,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * ComboChartVisual: { // ComboChartVisual * VisualId: "STRING_VALUE", // required @@ -3801,6 +4106,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * BoxPlotVisual: { // BoxPlotVisual * VisualId: "STRING_VALUE", // required @@ -3876,6 +4182,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * WaterfallVisual: { // WaterfallVisual * VisualId: "STRING_VALUE", // required @@ -3914,6 +4221,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * HistogramVisual: { // HistogramVisual * VisualId: "STRING_VALUE", // required @@ -3947,6 +4255,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * Interactions: "", * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * WordCloudVisual: { // WordCloudVisual * VisualId: "STRING_VALUE", // required @@ -3980,6 +4289,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * InsightVisual: { // InsightVisual * VisualId: "STRING_VALUE", // required @@ -4072,6 +4382,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * }, * Actions: "", * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * SankeyDiagramVisual: { // SankeyDiagramVisual * VisualId: "STRING_VALUE", // required @@ -4094,6 +4405,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * Interactions: "", * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * CustomContentVisual: { // CustomContentVisual * VisualId: "STRING_VALUE", // required @@ -4107,6 +4419,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * }, * Actions: "", * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * EmptyVisual: { // EmptyVisual * VisualId: "STRING_VALUE", // required @@ -4158,6 +4471,52 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", + * }, + * PluginVisual: { // PluginVisual + * VisualId: "STRING_VALUE", // required + * PluginArn: "STRING_VALUE", // required + * Title: "", + * Subtitle: "", + * ChartConfiguration: { // PluginVisualConfiguration + * FieldWells: [ // PluginVisualFieldWells + * { // PluginVisualFieldWell + * AxisName: "GROUP_BY" || "VALUE", + * Dimensions: "", + * Measures: "", + * Unaggregated: [ + * { + * FieldId: "STRING_VALUE", // required + * Column: "", // required + * FormatConfiguration: { + * StringFormatConfiguration: "", + * NumberFormatConfiguration: "", + * DateTimeFormatConfiguration: "", + * }, + * }, + * ], + * }, + * ], + * VisualOptions: { // PluginVisualOptions + * VisualProperties: [ // PluginVisualPropertiesList + * { // PluginVisualProperty + * Name: "STRING_VALUE", + * Value: "STRING_VALUE", + * }, + * ], + * }, + * SortConfiguration: { // PluginVisualSortConfiguration + * PluginVisualTableQuerySort: { // PluginVisualTableQuerySort + * RowSort: [ + * "", + * ], + * ItemsLimitConfiguration: { // PluginVisualItemsLimitConfiguration + * ItemsLimit: Number("long"), + * }, + * }, + * }, + * }, + * VisualContentAltText: "STRING_VALUE", * }, * }, * ], @@ -4167,6 +4526,46 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * Content: "STRING_VALUE", * }, * ], + * Images: [ // SheetImageList + * { // SheetImage + * SheetImageId: "STRING_VALUE", // required + * Source: { // SheetImageSource + * SheetImageStaticFileSource: { // SheetImageStaticFileSource + * StaticFileId: "STRING_VALUE", // required + * }, + * }, + * Scaling: { // SheetImageScalingConfiguration + * ScalingType: "SCALE_TO_WIDTH" || "SCALE_TO_HEIGHT" || "SCALE_TO_CONTAINER" || "SCALE_NONE", + * }, + * Tooltip: { // SheetImageTooltipConfiguration + * TooltipText: { // SheetImageTooltipText + * PlainText: "STRING_VALUE", + * }, + * Visibility: "HIDDEN" || "VISIBLE", + * }, + * ImageContentAltText: "STRING_VALUE", + * Interactions: { // ImageInteractionOptions + * ImageMenuOption: { // ImageMenuOption + * AvailabilityStatus: "ENABLED" || "DISABLED", + * }, + * }, + * Actions: [ // ImageCustomActionList + * { // ImageCustomAction + * CustomActionId: "STRING_VALUE", // required + * Name: "STRING_VALUE", // required + * Status: "ENABLED" || "DISABLED", + * Trigger: "CLICK" || "MENU", // required + * ActionOperations: [ // ImageCustomActionOperationList // required + * { // ImageCustomActionOperation + * NavigationOperation: "", + * URLOperation: "", + * SetParametersOperation: "", + * }, + * ], + * }, + * ], + * }, + * ], * Layouts: [ // LayoutList * { // Layout * Configuration: { // LayoutConfiguration @@ -4174,7 +4573,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * Elements: [ // GridLayoutElementList // required * { // GridLayoutElement * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * ColumnIndex: Number("int"), * ColumnSpan: Number("int"), // required * RowIndex: Number("int"), @@ -4192,7 +4591,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * Elements: [ // FreeFromLayoutElementList // required * { // FreeFormLayoutElement * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * XAxisLocation: "STRING_VALUE", // required * YAxisLocation: "STRING_VALUE", // required * Width: "STRING_VALUE", // required @@ -4238,7 +4637,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * Elements: [ // required * { * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * XAxisLocation: "STRING_VALUE", // required * YAxisLocation: "STRING_VALUE", // required * Width: "STRING_VALUE", // required @@ -4378,7 +4777,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * Elements: [ // required * { * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * ColumnIndex: Number("int"), * ColumnSpan: Number("int"), // required * RowIndex: Number("int"), @@ -5046,6 +5445,36 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * QueryExecutionOptions: { // QueryExecutionOptions * QueryExecutionMode: "AUTO" || "MANUAL", * }, + * StaticFiles: [ // StaticFileList + * { // StaticFile + * ImageStaticFile: { // ImageStaticFile + * StaticFileId: "STRING_VALUE", // required + * Source: { // StaticFileSource + * UrlOptions: { // StaticFileUrlSourceOptions + * Url: "STRING_VALUE", // required + * }, + * S3Options: { // StaticFileS3SourceOptions + * BucketName: "STRING_VALUE", // required + * ObjectKey: "STRING_VALUE", // required + * Region: "STRING_VALUE", // required + * }, + * }, + * }, + * SpatialStaticFile: { // SpatialStaticFile + * StaticFileId: "STRING_VALUE", // required + * Source: { + * UrlOptions: { + * Url: "STRING_VALUE", // required + * }, + * S3Options: { + * BucketName: "STRING_VALUE", // required + * ObjectKey: "STRING_VALUE", // required + * Region: "STRING_VALUE", // required + * }, + * }, + * }, + * }, + * ], * }, * ValidationStrategy: { // ValidationStrategy * Mode: "STRICT" || "LENIENT", // required diff --git a/clients/client-quicksight/src/commands/CreateTopicCommand.ts b/clients/client-quicksight/src/commands/CreateTopicCommand.ts index f933aed55001..f664a0d4ef8a 100644 --- a/clients/client-quicksight/src/commands/CreateTopicCommand.ts +++ b/clients/client-quicksight/src/commands/CreateTopicCommand.ts @@ -295,6 +295,9 @@ export interface CreateTopicCommandOutput extends CreateTopicResponse, __Metadat * Value: "STRING_VALUE", // required * }, * ], + * FolderArns: [ // FolderArnList + * "STRING_VALUE", + * ], * }; * const command = new CreateTopicCommand(input); * const response = await client.send(command); diff --git a/clients/client-quicksight/src/commands/DescribeAnalysisCommand.ts b/clients/client-quicksight/src/commands/DescribeAnalysisCommand.ts index d1514621635d..fc16355dc18c 100644 --- a/clients/client-quicksight/src/commands/DescribeAnalysisCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeAnalysisCommand.ts @@ -5,7 +5,11 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeAnalysisRequest, DescribeAnalysisResponse } from "../models/models_3"; +import { + DescribeAnalysisRequest, + DescribeAnalysisResponse, + DescribeAnalysisResponseFilterSensitiveLog, +} from "../models/models_3"; import { de_DescribeAnalysisCommand, se_DescribeAnalysisCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; @@ -68,6 +72,85 @@ export interface DescribeAnalysisCommandOutput extends DescribeAnalysisResponse, * // { // Sheet * // SheetId: "STRING_VALUE", * // Name: "STRING_VALUE", + * // Images: [ // SheetImageList + * // { // SheetImage + * // SheetImageId: "STRING_VALUE", // required + * // Source: { // SheetImageSource + * // SheetImageStaticFileSource: { // SheetImageStaticFileSource + * // StaticFileId: "STRING_VALUE", // required + * // }, + * // }, + * // Scaling: { // SheetImageScalingConfiguration + * // ScalingType: "SCALE_TO_WIDTH" || "SCALE_TO_HEIGHT" || "SCALE_TO_CONTAINER" || "SCALE_NONE", + * // }, + * // Tooltip: { // SheetImageTooltipConfiguration + * // TooltipText: { // SheetImageTooltipText + * // PlainText: "STRING_VALUE", + * // }, + * // Visibility: "HIDDEN" || "VISIBLE", + * // }, + * // ImageContentAltText: "STRING_VALUE", + * // Interactions: { // ImageInteractionOptions + * // ImageMenuOption: { // ImageMenuOption + * // AvailabilityStatus: "ENABLED" || "DISABLED", + * // }, + * // }, + * // Actions: [ // ImageCustomActionList + * // { // ImageCustomAction + * // CustomActionId: "STRING_VALUE", // required + * // Name: "STRING_VALUE", // required + * // Status: "ENABLED" || "DISABLED", + * // Trigger: "CLICK" || "MENU", // required + * // ActionOperations: [ // ImageCustomActionOperationList // required + * // { // ImageCustomActionOperation + * // NavigationOperation: { // CustomActionNavigationOperation + * // LocalNavigationConfiguration: { // LocalNavigationConfiguration + * // TargetSheetId: "STRING_VALUE", // required + * // }, + * // }, + * // URLOperation: { // CustomActionURLOperation + * // URLTemplate: "STRING_VALUE", // required + * // URLTarget: "NEW_TAB" || "NEW_WINDOW" || "SAME_TAB", // required + * // }, + * // SetParametersOperation: { // CustomActionSetParametersOperation + * // ParameterValueConfigurations: [ // SetParameterValueConfigurationList // required + * // { // SetParameterValueConfiguration + * // DestinationParameterName: "STRING_VALUE", // required + * // Value: { // DestinationParameterValueConfiguration + * // CustomValuesConfiguration: { // CustomValuesConfiguration + * // IncludeNullValue: true || false, + * // CustomValues: { // CustomParameterValues + * // StringValues: [ // StringDefaultValueList + * // "STRING_VALUE", + * // ], + * // IntegerValues: [ // IntegerDefaultValueList + * // Number("long"), + * // ], + * // DecimalValues: [ // DecimalDefaultValueList + * // Number("double"), + * // ], + * // DateTimeValues: [ // DateTimeDefaultValueList + * // new Date("TIMESTAMP"), + * // ], + * // }, + * // }, + * // SelectAllValueOptions: "ALL_VALUES", + * // SourceParameterName: "STRING_VALUE", + * // SourceField: "STRING_VALUE", + * // SourceColumn: { // ColumnIdentifier + * // DataSetIdentifier: "STRING_VALUE", // required + * // ColumnName: "STRING_VALUE", // required + * // }, + * // }, + * // }, + * // ], + * // }, + * // }, + * // ], + * // }, + * // ], + * // }, + * // ], * // }, * // ], * // }, @@ -129,7 +212,7 @@ export class DescribeAnalysisCommand extends $Command }) .s("QuickSight_20180401", "DescribeAnalysis", {}) .n("QuickSightClient", "DescribeAnalysisCommand") - .f(void 0, void 0) + .f(void 0, DescribeAnalysisResponseFilterSensitiveLog) .ser(se_DescribeAnalysisCommand) .de(de_DescribeAnalysisCommand) .build() { diff --git a/clients/client-quicksight/src/commands/DescribeAnalysisDefinitionCommand.ts b/clients/client-quicksight/src/commands/DescribeAnalysisDefinitionCommand.ts index be7de865ac78..67d3bbe661d7 100644 --- a/clients/client-quicksight/src/commands/DescribeAnalysisDefinitionCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeAnalysisDefinitionCommand.ts @@ -94,6 +94,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // FontConfiguration: { // FontConfiguration * // FontSize: { // FontSize * // Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * // Absolute: "STRING_VALUE", * // }, * // FontDecoration: "UNDERLINE" || "NONE", * // FontColor: "STRING_VALUE", @@ -101,6 +102,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // Name: "NORMAL" || "BOLD", * // }, * // FontStyle: "NORMAL" || "ITALIC", + * // FontFamily: "STRING_VALUE", * // }, * // CustomLabel: "STRING_VALUE", * // }, @@ -129,6 +131,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // FontConfiguration: { * // FontSize: { * // Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * // Absolute: "STRING_VALUE", * // }, * // FontDecoration: "UNDERLINE" || "NONE", * // FontColor: "STRING_VALUE", @@ -136,6 +139,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // Name: "NORMAL" || "BOLD", * // }, * // FontStyle: "NORMAL" || "ITALIC", + * // FontFamily: "STRING_VALUE", * // }, * // CustomLabel: "STRING_VALUE", * // }, @@ -179,6 +183,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // FontConfiguration: { * // FontSize: { * // Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * // Absolute: "STRING_VALUE", * // }, * // FontDecoration: "UNDERLINE" || "NONE", * // FontColor: "STRING_VALUE", @@ -186,6 +191,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // Name: "NORMAL" || "BOLD", * // }, * // FontStyle: "NORMAL" || "ITALIC", + * // FontFamily: "STRING_VALUE", * // }, * // CustomLabel: "STRING_VALUE", * // }, @@ -227,6 +233,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // FontConfiguration: { * // FontSize: { * // Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * // Absolute: "STRING_VALUE", * // }, * // FontDecoration: "UNDERLINE" || "NONE", * // FontColor: "STRING_VALUE", @@ -234,6 +241,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // Name: "NORMAL" || "BOLD", * // }, * // FontStyle: "NORMAL" || "ITALIC", + * // FontFamily: "STRING_VALUE", * // }, * // CustomLabel: "STRING_VALUE", * // }, @@ -257,6 +265,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // FontConfiguration: { * // FontSize: { * // Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * // Absolute: "STRING_VALUE", * // }, * // FontDecoration: "UNDERLINE" || "NONE", * // FontColor: "STRING_VALUE", @@ -264,6 +273,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // Name: "NORMAL" || "BOLD", * // }, * // FontStyle: "NORMAL" || "ITALIC", + * // FontFamily: "STRING_VALUE", * // }, * // CustomLabel: "STRING_VALUE", * // }, @@ -1112,6 +1122,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // ], * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // PivotTableVisual: { // PivotTableVisual * // VisualId: "STRING_VALUE", // required @@ -1576,6 +1587,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // ], * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // BarChartVisual: { // BarChartVisual * // VisualId: "STRING_VALUE", // required @@ -1924,6 +1936,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * // Width: "STRING_VALUE", * // Height: "STRING_VALUE", + * // ValueFontConfiguration: "", * // }, * // DataLabels: { // DataLabelOptions * // Visibility: "HIDDEN" || "VISIBLE", @@ -2183,6 +2196,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // }, * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // KPIVisual: { // KPIVisual * // VisualId: "STRING_VALUE", // required @@ -2506,6 +2520,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // }, * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // PieChartVisual: { // PieChartVisual * // VisualId: "STRING_VALUE", // required @@ -2620,6 +2635,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * // Width: "STRING_VALUE", * // Height: "STRING_VALUE", + * // ValueFontConfiguration: "", * // }, * // DataLabels: { * // Visibility: "HIDDEN" || "VISIBLE", @@ -2798,6 +2814,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // }, * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // GaugeChartVisual: { // GaugeChartVisual * // VisualId: "STRING_VALUE", // required @@ -2918,6 +2935,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // ], * // }, * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // LineChartVisual: { // LineChartVisual * // VisualId: "STRING_VALUE", // required @@ -3196,6 +3214,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * // Width: "STRING_VALUE", * // Height: "STRING_VALUE", + * // ValueFontConfiguration: "", * // }, * // DataLabels: { * // Visibility: "HIDDEN" || "VISIBLE", @@ -3332,6 +3351,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // }, * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // HeatMapVisual: { // HeatMapVisual * // VisualId: "STRING_VALUE", // required @@ -3378,6 +3398,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * // Width: "STRING_VALUE", * // Height: "STRING_VALUE", + * // ValueFontConfiguration: "", * // }, * // DataLabels: { * // Visibility: "HIDDEN" || "VISIBLE", @@ -3462,6 +3483,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // }, * // ], * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // TreeMapVisual: { // TreeMapVisual * // VisualId: "STRING_VALUE", // required @@ -3507,6 +3529,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * // Width: "STRING_VALUE", * // Height: "STRING_VALUE", + * // ValueFontConfiguration: "", * // }, * // DataLabels: "", * // Tooltip: "", @@ -3514,6 +3537,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // GeospatialMapVisual: { // GeospatialMapVisual * // VisualId: "STRING_VALUE", // required @@ -3574,6 +3598,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // }, * // ColumnHierarchies: "", * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // FilledMapVisual: { // FilledMapVisual * // VisualId: "STRING_VALUE", // required @@ -3623,6 +3648,284 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // }, * // ColumnHierarchies: "", * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", + * // }, + * // LayerMapVisual: { // LayerMapVisual + * // VisualId: "STRING_VALUE", // required + * // Title: "", + * // Subtitle: "", + * // ChartConfiguration: { // GeospatialLayerMapConfiguration + * // Legend: "", + * // MapLayers: [ // GeospatialMapLayerList + * // { // GeospatialLayerItem + * // LayerId: "STRING_VALUE", // required + * // LayerType: "POINT" || "LINE" || "POLYGON", + * // DataSource: { // GeospatialDataSourceItem + * // StaticFileDataSource: { // GeospatialStaticFileSource + * // StaticFileId: "STRING_VALUE", // required + * // }, + * // }, + * // Label: "STRING_VALUE", + * // Visibility: "HIDDEN" || "VISIBLE", + * // LayerDefinition: { // GeospatialLayerDefinition + * // PointLayer: { // GeospatialPointLayer + * // Style: { // GeospatialPointStyle + * // CircleSymbolStyle: { // GeospatialCircleSymbolStyle + * // FillColor: { // GeospatialColor + * // Solid: { // GeospatialSolidColor + * // Color: "STRING_VALUE", // required + * // State: "ENABLED" || "DISABLED", + * // }, + * // Gradient: { // GeospatialGradientColor + * // StepColors: [ // GeospatialGradientStepColorList // required + * // { // GeospatialGradientStepColor + * // Color: "STRING_VALUE", // required + * // DataValue: Number("double"), // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: { // GeospatialNullDataSettings + * // SymbolStyle: { // GeospatialNullSymbolStyle + * // FillColor: "STRING_VALUE", + * // StrokeColor: "STRING_VALUE", + * // StrokeWidth: Number("double"), + * // }, + * // }, + * // DefaultOpacity: Number("double"), + * // }, + * // Categorical: { // GeospatialCategoricalColor + * // CategoryDataColors: [ // GeospatialCategoricalDataColorList // required + * // { // GeospatialCategoricalDataColor + * // Color: "STRING_VALUE", // required + * // DataValue: "STRING_VALUE", // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: { + * // SymbolStyle: { + * // FillColor: "STRING_VALUE", + * // StrokeColor: "STRING_VALUE", + * // StrokeWidth: Number("double"), + * // }, + * // }, + * // DefaultOpacity: Number("double"), + * // }, + * // }, + * // StrokeColor: { + * // Solid: { + * // Color: "STRING_VALUE", // required + * // State: "ENABLED" || "DISABLED", + * // }, + * // Gradient: { + * // StepColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: Number("double"), // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: { + * // SymbolStyle: { + * // FillColor: "STRING_VALUE", + * // StrokeColor: "STRING_VALUE", + * // StrokeWidth: Number("double"), + * // }, + * // }, + * // DefaultOpacity: Number("double"), + * // }, + * // Categorical: { + * // CategoryDataColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: "STRING_VALUE", // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: { + * // SymbolStyle: { + * // FillColor: "STRING_VALUE", + * // StrokeColor: "STRING_VALUE", + * // StrokeWidth: Number("double"), + * // }, + * // }, + * // DefaultOpacity: Number("double"), + * // }, + * // }, + * // StrokeWidth: { // GeospatialLineWidth + * // LineWidth: Number("double"), + * // }, + * // CircleRadius: { // GeospatialCircleRadius + * // Radius: Number("double"), + * // }, + * // }, + * // }, + * // }, + * // LineLayer: { // GeospatialLineLayer + * // Style: { // GeospatialLineStyle + * // LineSymbolStyle: { // GeospatialLineSymbolStyle + * // FillColor: { + * // Solid: { + * // Color: "STRING_VALUE", // required + * // State: "ENABLED" || "DISABLED", + * // }, + * // Gradient: { + * // StepColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: Number("double"), // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: { + * // SymbolStyle: { + * // FillColor: "STRING_VALUE", + * // StrokeColor: "STRING_VALUE", + * // StrokeWidth: Number("double"), + * // }, + * // }, + * // DefaultOpacity: Number("double"), + * // }, + * // Categorical: { + * // CategoryDataColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: "STRING_VALUE", // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: "", + * // DefaultOpacity: Number("double"), + * // }, + * // }, + * // LineWidth: { + * // LineWidth: Number("double"), + * // }, + * // }, + * // }, + * // }, + * // PolygonLayer: { // GeospatialPolygonLayer + * // Style: { // GeospatialPolygonStyle + * // PolygonSymbolStyle: { // GeospatialPolygonSymbolStyle + * // FillColor: { + * // Solid: { + * // Color: "STRING_VALUE", // required + * // State: "ENABLED" || "DISABLED", + * // }, + * // Gradient: { + * // StepColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: Number("double"), // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: "", + * // DefaultOpacity: Number("double"), + * // }, + * // Categorical: { + * // CategoryDataColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: "STRING_VALUE", // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: "", + * // DefaultOpacity: Number("double"), + * // }, + * // }, + * // StrokeColor: { + * // Solid: { + * // Color: "STRING_VALUE", // required + * // State: "ENABLED" || "DISABLED", + * // }, + * // Gradient: { + * // StepColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: Number("double"), // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: "", + * // DefaultOpacity: Number("double"), + * // }, + * // Categorical: { + * // CategoryDataColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: "STRING_VALUE", // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: "", + * // DefaultOpacity: Number("double"), + * // }, + * // }, + * // StrokeWidth: { + * // LineWidth: Number("double"), + * // }, + * // }, + * // }, + * // }, + * // }, + * // Tooltip: "", + * // JoinDefinition: { // GeospatialLayerJoinDefinition + * // ShapeKeyField: "STRING_VALUE", + * // DatasetKeyField: { + * // FieldId: "STRING_VALUE", // required + * // Column: "", // required + * // FormatConfiguration: { + * // StringFormatConfiguration: "", + * // NumberFormatConfiguration: "", + * // DateTimeFormatConfiguration: "", + * // }, + * // }, + * // ColorField: { // GeospatialLayerColorField + * // ColorDimensionsFields: [ // GeospatialLayerDimensionFieldList + * // "", + * // ], + * // ColorValuesFields: [ // GeospatialLayerMeasureFieldList + * // "", + * // ], + * // }, + * // }, + * // Actions: [ // LayerCustomActionList + * // { // LayerCustomAction + * // CustomActionId: "STRING_VALUE", // required + * // Name: "STRING_VALUE", // required + * // Status: "ENABLED" || "DISABLED", + * // Trigger: "DATA_POINT_CLICK" || "DATA_POINT_MENU", // required + * // ActionOperations: [ // LayerCustomActionOperationList // required + * // { // LayerCustomActionOperation + * // FilterOperation: "", + * // NavigationOperation: "", + * // URLOperation: "", + * // SetParametersOperation: "", + * // }, + * // ], + * // }, + * // ], + * // }, + * // ], + * // MapState: { // GeospatialMapState + * // Bounds: { + * // North: Number("double"), // required + * // South: Number("double"), // required + * // West: Number("double"), // required + * // East: Number("double"), // required + * // }, + * // MapNavigation: "ENABLED" || "DISABLED", + * // }, + * // MapStyle: { // GeospatialMapStyle + * // BaseMapStyle: "LIGHT_GRAY" || "DARK_GRAY" || "STREET" || "IMAGERY", + * // BackgroundColor: "STRING_VALUE", + * // BaseMapVisibility: "HIDDEN" || "VISIBLE", + * // }, + * // Interactions: "", + * // }, + * // DataSetIdentifier: "STRING_VALUE", // required + * // VisualContentAltText: "STRING_VALUE", * // }, * // FunnelChartVisual: { // FunnelChartVisual * // VisualId: "STRING_VALUE", // required @@ -3660,6 +3963,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // ScatterPlotVisual: { // ScatterPlotVisual * // VisualId: "STRING_VALUE", // required @@ -3697,6 +4001,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // ComboChartVisual: { // ComboChartVisual * // VisualId: "STRING_VALUE", // required @@ -3773,6 +4078,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // BoxPlotVisual: { // BoxPlotVisual * // VisualId: "STRING_VALUE", // required @@ -3848,6 +4154,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // WaterfallVisual: { // WaterfallVisual * // VisualId: "STRING_VALUE", // required @@ -3886,6 +4193,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // HistogramVisual: { // HistogramVisual * // VisualId: "STRING_VALUE", // required @@ -3919,6 +4227,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // Interactions: "", * // }, * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // WordCloudVisual: { // WordCloudVisual * // VisualId: "STRING_VALUE", // required @@ -3952,6 +4261,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // InsightVisual: { // InsightVisual * // VisualId: "STRING_VALUE", // required @@ -4044,6 +4354,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // }, * // Actions: "", * // DataSetIdentifier: "STRING_VALUE", // required + * // VisualContentAltText: "STRING_VALUE", * // }, * // SankeyDiagramVisual: { // SankeyDiagramVisual * // VisualId: "STRING_VALUE", // required @@ -4066,6 +4377,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // Interactions: "", * // }, * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // CustomContentVisual: { // CustomContentVisual * // VisualId: "STRING_VALUE", // required @@ -4079,6 +4391,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // }, * // Actions: "", * // DataSetIdentifier: "STRING_VALUE", // required + * // VisualContentAltText: "STRING_VALUE", * // }, * // EmptyVisual: { // EmptyVisual * // VisualId: "STRING_VALUE", // required @@ -4130,6 +4443,52 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", + * // }, + * // PluginVisual: { // PluginVisual + * // VisualId: "STRING_VALUE", // required + * // PluginArn: "STRING_VALUE", // required + * // Title: "", + * // Subtitle: "", + * // ChartConfiguration: { // PluginVisualConfiguration + * // FieldWells: [ // PluginVisualFieldWells + * // { // PluginVisualFieldWell + * // AxisName: "GROUP_BY" || "VALUE", + * // Dimensions: "", + * // Measures: "", + * // Unaggregated: [ + * // { + * // FieldId: "STRING_VALUE", // required + * // Column: "", // required + * // FormatConfiguration: { + * // StringFormatConfiguration: "", + * // NumberFormatConfiguration: "", + * // DateTimeFormatConfiguration: "", + * // }, + * // }, + * // ], + * // }, + * // ], + * // VisualOptions: { // PluginVisualOptions + * // VisualProperties: [ // PluginVisualPropertiesList + * // { // PluginVisualProperty + * // Name: "STRING_VALUE", + * // Value: "STRING_VALUE", + * // }, + * // ], + * // }, + * // SortConfiguration: { // PluginVisualSortConfiguration + * // PluginVisualTableQuerySort: { // PluginVisualTableQuerySort + * // RowSort: [ + * // "", + * // ], + * // ItemsLimitConfiguration: { // PluginVisualItemsLimitConfiguration + * // ItemsLimit: Number("long"), + * // }, + * // }, + * // }, + * // }, + * // VisualContentAltText: "STRING_VALUE", * // }, * // }, * // ], @@ -4139,6 +4498,46 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // Content: "STRING_VALUE", * // }, * // ], + * // Images: [ // SheetImageList + * // { // SheetImage + * // SheetImageId: "STRING_VALUE", // required + * // Source: { // SheetImageSource + * // SheetImageStaticFileSource: { // SheetImageStaticFileSource + * // StaticFileId: "STRING_VALUE", // required + * // }, + * // }, + * // Scaling: { // SheetImageScalingConfiguration + * // ScalingType: "SCALE_TO_WIDTH" || "SCALE_TO_HEIGHT" || "SCALE_TO_CONTAINER" || "SCALE_NONE", + * // }, + * // Tooltip: { // SheetImageTooltipConfiguration + * // TooltipText: { // SheetImageTooltipText + * // PlainText: "STRING_VALUE", + * // }, + * // Visibility: "HIDDEN" || "VISIBLE", + * // }, + * // ImageContentAltText: "STRING_VALUE", + * // Interactions: { // ImageInteractionOptions + * // ImageMenuOption: { // ImageMenuOption + * // AvailabilityStatus: "ENABLED" || "DISABLED", + * // }, + * // }, + * // Actions: [ // ImageCustomActionList + * // { // ImageCustomAction + * // CustomActionId: "STRING_VALUE", // required + * // Name: "STRING_VALUE", // required + * // Status: "ENABLED" || "DISABLED", + * // Trigger: "CLICK" || "MENU", // required + * // ActionOperations: [ // ImageCustomActionOperationList // required + * // { // ImageCustomActionOperation + * // NavigationOperation: "", + * // URLOperation: "", + * // SetParametersOperation: "", + * // }, + * // ], + * // }, + * // ], + * // }, + * // ], * // Layouts: [ // LayoutList * // { // Layout * // Configuration: { // LayoutConfiguration @@ -4146,7 +4545,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // Elements: [ // GridLayoutElementList // required * // { // GridLayoutElement * // ElementId: "STRING_VALUE", // required - * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * // ColumnIndex: Number("int"), * // ColumnSpan: Number("int"), // required * // RowIndex: Number("int"), @@ -4164,7 +4563,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // Elements: [ // FreeFromLayoutElementList // required * // { // FreeFormLayoutElement * // ElementId: "STRING_VALUE", // required - * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * // XAxisLocation: "STRING_VALUE", // required * // YAxisLocation: "STRING_VALUE", // required * // Width: "STRING_VALUE", // required @@ -4210,7 +4609,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // Elements: [ // required * // { * // ElementId: "STRING_VALUE", // required - * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * // XAxisLocation: "STRING_VALUE", // required * // YAxisLocation: "STRING_VALUE", // required * // Width: "STRING_VALUE", // required @@ -4350,7 +4749,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // Elements: [ // required * // { * // ElementId: "STRING_VALUE", // required - * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * // ColumnIndex: Number("int"), * // ColumnSpan: Number("int"), // required * // RowIndex: Number("int"), @@ -5018,6 +5417,36 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // QueryExecutionOptions: { // QueryExecutionOptions * // QueryExecutionMode: "AUTO" || "MANUAL", * // }, + * // StaticFiles: [ // StaticFileList + * // { // StaticFile + * // ImageStaticFile: { // ImageStaticFile + * // StaticFileId: "STRING_VALUE", // required + * // Source: { // StaticFileSource + * // UrlOptions: { // StaticFileUrlSourceOptions + * // Url: "STRING_VALUE", // required + * // }, + * // S3Options: { // StaticFileS3SourceOptions + * // BucketName: "STRING_VALUE", // required + * // ObjectKey: "STRING_VALUE", // required + * // Region: "STRING_VALUE", // required + * // }, + * // }, + * // }, + * // SpatialStaticFile: { // SpatialStaticFile + * // StaticFileId: "STRING_VALUE", // required + * // Source: { + * // UrlOptions: { + * // Url: "STRING_VALUE", // required + * // }, + * // S3Options: { + * // BucketName: "STRING_VALUE", // required + * // ObjectKey: "STRING_VALUE", // required + * // Region: "STRING_VALUE", // required + * // }, + * // }, + * // }, + * // }, + * // ], * // }, * // Status: Number("int"), * // RequestId: "STRING_VALUE", diff --git a/clients/client-quicksight/src/commands/DescribeAssetBundleExportJobCommand.ts b/clients/client-quicksight/src/commands/DescribeAssetBundleExportJobCommand.ts index 37453b6d57a3..11398ce2df4f 100644 --- a/clients/client-quicksight/src/commands/DescribeAssetBundleExportJobCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeAssetBundleExportJobCommand.ts @@ -5,11 +5,11 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribeAssetBundleExportJobRequest } from "../models/models_3"; import { - DescribeAssetBundleExportJobRequest, DescribeAssetBundleExportJobResponse, DescribeAssetBundleExportJobResponseFilterSensitiveLog, -} from "../models/models_3"; +} from "../models/models_4"; import { de_DescribeAssetBundleExportJobCommand, se_DescribeAssetBundleExportJobCommand, diff --git a/clients/client-quicksight/src/commands/DescribeAssetBundleImportJobCommand.ts b/clients/client-quicksight/src/commands/DescribeAssetBundleImportJobCommand.ts index ab99e5c74954..b4a66fff34b9 100644 --- a/clients/client-quicksight/src/commands/DescribeAssetBundleImportJobCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeAssetBundleImportJobCommand.ts @@ -9,7 +9,7 @@ import { DescribeAssetBundleImportJobRequest, DescribeAssetBundleImportJobResponse, DescribeAssetBundleImportJobResponseFilterSensitiveLog, -} from "../models/models_3"; +} from "../models/models_4"; import { de_DescribeAssetBundleImportJobCommand, se_DescribeAssetBundleImportJobCommand, diff --git a/clients/client-quicksight/src/commands/DescribeBrandAssignmentCommand.ts b/clients/client-quicksight/src/commands/DescribeBrandAssignmentCommand.ts index 2f9a844a0157..c50915e2125a 100644 --- a/clients/client-quicksight/src/commands/DescribeBrandAssignmentCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeBrandAssignmentCommand.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 { DescribeBrandAssignmentRequest, DescribeBrandAssignmentResponse } from "../models/models_3"; +import { DescribeBrandAssignmentRequest, DescribeBrandAssignmentResponse } from "../models/models_4"; import { de_DescribeBrandAssignmentCommand, se_DescribeBrandAssignmentCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeBrandCommand.ts b/clients/client-quicksight/src/commands/DescribeBrandCommand.ts index e72709c02226..dc26bcf92348 100644 --- a/clients/client-quicksight/src/commands/DescribeBrandCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeBrandCommand.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 { DescribeBrandRequest, DescribeBrandResponse } from "../models/models_3"; +import { DescribeBrandRequest, DescribeBrandResponse } from "../models/models_4"; import { de_DescribeBrandCommand, se_DescribeBrandCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeBrandPublishedVersionCommand.ts b/clients/client-quicksight/src/commands/DescribeBrandPublishedVersionCommand.ts index 8b40ec74aaf6..4091a910f7d5 100644 --- a/clients/client-quicksight/src/commands/DescribeBrandPublishedVersionCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeBrandPublishedVersionCommand.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 { DescribeBrandPublishedVersionRequest, DescribeBrandPublishedVersionResponse } from "../models/models_3"; +import { DescribeBrandPublishedVersionRequest, DescribeBrandPublishedVersionResponse } from "../models/models_4"; import { de_DescribeBrandPublishedVersionCommand, se_DescribeBrandPublishedVersionCommand, diff --git a/clients/client-quicksight/src/commands/DescribeCustomPermissionsCommand.ts b/clients/client-quicksight/src/commands/DescribeCustomPermissionsCommand.ts index 2221941bb311..aa283b8c7c90 100644 --- a/clients/client-quicksight/src/commands/DescribeCustomPermissionsCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeCustomPermissionsCommand.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 { DescribeCustomPermissionsRequest, DescribeCustomPermissionsResponse } from "../models/models_3"; +import { DescribeCustomPermissionsRequest, DescribeCustomPermissionsResponse } from "../models/models_4"; import { de_DescribeCustomPermissionsCommand, se_DescribeCustomPermissionsCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeDashboardCommand.ts b/clients/client-quicksight/src/commands/DescribeDashboardCommand.ts index 0f169225bfa1..d6b8f5b6dfd0 100644 --- a/clients/client-quicksight/src/commands/DescribeDashboardCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeDashboardCommand.ts @@ -5,7 +5,11 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeDashboardRequest, DescribeDashboardResponse } from "../models/models_3"; +import { + DescribeDashboardRequest, + DescribeDashboardResponse, + DescribeDashboardResponseFilterSensitiveLog, +} from "../models/models_4"; import { de_DescribeDashboardCommand, se_DescribeDashboardCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; @@ -74,6 +78,85 @@ export interface DescribeDashboardCommandOutput extends DescribeDashboardRespons * // { // Sheet * // SheetId: "STRING_VALUE", * // Name: "STRING_VALUE", + * // Images: [ // SheetImageList + * // { // SheetImage + * // SheetImageId: "STRING_VALUE", // required + * // Source: { // SheetImageSource + * // SheetImageStaticFileSource: { // SheetImageStaticFileSource + * // StaticFileId: "STRING_VALUE", // required + * // }, + * // }, + * // Scaling: { // SheetImageScalingConfiguration + * // ScalingType: "SCALE_TO_WIDTH" || "SCALE_TO_HEIGHT" || "SCALE_TO_CONTAINER" || "SCALE_NONE", + * // }, + * // Tooltip: { // SheetImageTooltipConfiguration + * // TooltipText: { // SheetImageTooltipText + * // PlainText: "STRING_VALUE", + * // }, + * // Visibility: "HIDDEN" || "VISIBLE", + * // }, + * // ImageContentAltText: "STRING_VALUE", + * // Interactions: { // ImageInteractionOptions + * // ImageMenuOption: { // ImageMenuOption + * // AvailabilityStatus: "ENABLED" || "DISABLED", + * // }, + * // }, + * // Actions: [ // ImageCustomActionList + * // { // ImageCustomAction + * // CustomActionId: "STRING_VALUE", // required + * // Name: "STRING_VALUE", // required + * // Status: "ENABLED" || "DISABLED", + * // Trigger: "CLICK" || "MENU", // required + * // ActionOperations: [ // ImageCustomActionOperationList // required + * // { // ImageCustomActionOperation + * // NavigationOperation: { // CustomActionNavigationOperation + * // LocalNavigationConfiguration: { // LocalNavigationConfiguration + * // TargetSheetId: "STRING_VALUE", // required + * // }, + * // }, + * // URLOperation: { // CustomActionURLOperation + * // URLTemplate: "STRING_VALUE", // required + * // URLTarget: "NEW_TAB" || "NEW_WINDOW" || "SAME_TAB", // required + * // }, + * // SetParametersOperation: { // CustomActionSetParametersOperation + * // ParameterValueConfigurations: [ // SetParameterValueConfigurationList // required + * // { // SetParameterValueConfiguration + * // DestinationParameterName: "STRING_VALUE", // required + * // Value: { // DestinationParameterValueConfiguration + * // CustomValuesConfiguration: { // CustomValuesConfiguration + * // IncludeNullValue: true || false, + * // CustomValues: { // CustomParameterValues + * // StringValues: [ // StringDefaultValueList + * // "STRING_VALUE", + * // ], + * // IntegerValues: [ // IntegerDefaultValueList + * // Number("long"), + * // ], + * // DecimalValues: [ // DecimalDefaultValueList + * // Number("double"), + * // ], + * // DateTimeValues: [ // DateTimeDefaultValueList + * // new Date("TIMESTAMP"), + * // ], + * // }, + * // }, + * // SelectAllValueOptions: "ALL_VALUES", + * // SourceParameterName: "STRING_VALUE", + * // SourceField: "STRING_VALUE", + * // SourceColumn: { // ColumnIdentifier + * // DataSetIdentifier: "STRING_VALUE", // required + * // ColumnName: "STRING_VALUE", // required + * // }, + * // }, + * // }, + * // ], + * // }, + * // }, + * // ], + * // }, + * // ], + * // }, + * // ], * // }, * // ], * // }, @@ -142,7 +225,7 @@ export class DescribeDashboardCommand extends $Command }) .s("QuickSight_20180401", "DescribeDashboard", {}) .n("QuickSightClient", "DescribeDashboardCommand") - .f(void 0, void 0) + .f(void 0, DescribeDashboardResponseFilterSensitiveLog) .ser(se_DescribeDashboardCommand) .de(de_DescribeDashboardCommand) .build() { diff --git a/clients/client-quicksight/src/commands/DescribeDashboardDefinitionCommand.ts b/clients/client-quicksight/src/commands/DescribeDashboardDefinitionCommand.ts index c88f40c9849f..813bd995ba6b 100644 --- a/clients/client-quicksight/src/commands/DescribeDashboardDefinitionCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeDashboardDefinitionCommand.ts @@ -9,7 +9,7 @@ import { DescribeDashboardDefinitionRequest, DescribeDashboardDefinitionResponse, DescribeDashboardDefinitionResponseFilterSensitiveLog, -} from "../models/models_3"; +} from "../models/models_4"; import { de_DescribeDashboardDefinitionCommand, se_DescribeDashboardDefinitionCommand, @@ -101,6 +101,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // FontConfiguration: { // FontConfiguration * // FontSize: { // FontSize * // Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * // Absolute: "STRING_VALUE", * // }, * // FontDecoration: "UNDERLINE" || "NONE", * // FontColor: "STRING_VALUE", @@ -108,6 +109,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // Name: "NORMAL" || "BOLD", * // }, * // FontStyle: "NORMAL" || "ITALIC", + * // FontFamily: "STRING_VALUE", * // }, * // CustomLabel: "STRING_VALUE", * // }, @@ -136,6 +138,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // FontConfiguration: { * // FontSize: { * // Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * // Absolute: "STRING_VALUE", * // }, * // FontDecoration: "UNDERLINE" || "NONE", * // FontColor: "STRING_VALUE", @@ -143,6 +146,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // Name: "NORMAL" || "BOLD", * // }, * // FontStyle: "NORMAL" || "ITALIC", + * // FontFamily: "STRING_VALUE", * // }, * // CustomLabel: "STRING_VALUE", * // }, @@ -186,6 +190,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // FontConfiguration: { * // FontSize: { * // Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * // Absolute: "STRING_VALUE", * // }, * // FontDecoration: "UNDERLINE" || "NONE", * // FontColor: "STRING_VALUE", @@ -193,6 +198,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // Name: "NORMAL" || "BOLD", * // }, * // FontStyle: "NORMAL" || "ITALIC", + * // FontFamily: "STRING_VALUE", * // }, * // CustomLabel: "STRING_VALUE", * // }, @@ -234,6 +240,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // FontConfiguration: { * // FontSize: { * // Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * // Absolute: "STRING_VALUE", * // }, * // FontDecoration: "UNDERLINE" || "NONE", * // FontColor: "STRING_VALUE", @@ -241,6 +248,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // Name: "NORMAL" || "BOLD", * // }, * // FontStyle: "NORMAL" || "ITALIC", + * // FontFamily: "STRING_VALUE", * // }, * // CustomLabel: "STRING_VALUE", * // }, @@ -264,6 +272,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // FontConfiguration: { * // FontSize: { * // Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * // Absolute: "STRING_VALUE", * // }, * // FontDecoration: "UNDERLINE" || "NONE", * // FontColor: "STRING_VALUE", @@ -271,6 +280,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // Name: "NORMAL" || "BOLD", * // }, * // FontStyle: "NORMAL" || "ITALIC", + * // FontFamily: "STRING_VALUE", * // }, * // CustomLabel: "STRING_VALUE", * // }, @@ -1119,6 +1129,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // ], * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // PivotTableVisual: { // PivotTableVisual * // VisualId: "STRING_VALUE", // required @@ -1583,6 +1594,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // ], * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // BarChartVisual: { // BarChartVisual * // VisualId: "STRING_VALUE", // required @@ -1931,6 +1943,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * // Width: "STRING_VALUE", * // Height: "STRING_VALUE", + * // ValueFontConfiguration: "", * // }, * // DataLabels: { // DataLabelOptions * // Visibility: "HIDDEN" || "VISIBLE", @@ -2190,6 +2203,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // }, * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // KPIVisual: { // KPIVisual * // VisualId: "STRING_VALUE", // required @@ -2513,6 +2527,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // }, * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // PieChartVisual: { // PieChartVisual * // VisualId: "STRING_VALUE", // required @@ -2627,6 +2642,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * // Width: "STRING_VALUE", * // Height: "STRING_VALUE", + * // ValueFontConfiguration: "", * // }, * // DataLabels: { * // Visibility: "HIDDEN" || "VISIBLE", @@ -2805,6 +2821,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // }, * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // GaugeChartVisual: { // GaugeChartVisual * // VisualId: "STRING_VALUE", // required @@ -2925,6 +2942,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // ], * // }, * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // LineChartVisual: { // LineChartVisual * // VisualId: "STRING_VALUE", // required @@ -3203,6 +3221,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * // Width: "STRING_VALUE", * // Height: "STRING_VALUE", + * // ValueFontConfiguration: "", * // }, * // DataLabels: { * // Visibility: "HIDDEN" || "VISIBLE", @@ -3339,6 +3358,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // }, * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // HeatMapVisual: { // HeatMapVisual * // VisualId: "STRING_VALUE", // required @@ -3385,6 +3405,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * // Width: "STRING_VALUE", * // Height: "STRING_VALUE", + * // ValueFontConfiguration: "", * // }, * // DataLabels: { * // Visibility: "HIDDEN" || "VISIBLE", @@ -3469,6 +3490,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // }, * // ], * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // TreeMapVisual: { // TreeMapVisual * // VisualId: "STRING_VALUE", // required @@ -3514,6 +3536,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * // Width: "STRING_VALUE", * // Height: "STRING_VALUE", + * // ValueFontConfiguration: "", * // }, * // DataLabels: "", * // Tooltip: "", @@ -3521,6 +3544,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // GeospatialMapVisual: { // GeospatialMapVisual * // VisualId: "STRING_VALUE", // required @@ -3581,6 +3605,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // }, * // ColumnHierarchies: "", * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // FilledMapVisual: { // FilledMapVisual * // VisualId: "STRING_VALUE", // required @@ -3630,6 +3655,284 @@ export interface DescribeDashboardDefinitionCommandOutput * // }, * // ColumnHierarchies: "", * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", + * // }, + * // LayerMapVisual: { // LayerMapVisual + * // VisualId: "STRING_VALUE", // required + * // Title: "", + * // Subtitle: "", + * // ChartConfiguration: { // GeospatialLayerMapConfiguration + * // Legend: "", + * // MapLayers: [ // GeospatialMapLayerList + * // { // GeospatialLayerItem + * // LayerId: "STRING_VALUE", // required + * // LayerType: "POINT" || "LINE" || "POLYGON", + * // DataSource: { // GeospatialDataSourceItem + * // StaticFileDataSource: { // GeospatialStaticFileSource + * // StaticFileId: "STRING_VALUE", // required + * // }, + * // }, + * // Label: "STRING_VALUE", + * // Visibility: "HIDDEN" || "VISIBLE", + * // LayerDefinition: { // GeospatialLayerDefinition + * // PointLayer: { // GeospatialPointLayer + * // Style: { // GeospatialPointStyle + * // CircleSymbolStyle: { // GeospatialCircleSymbolStyle + * // FillColor: { // GeospatialColor + * // Solid: { // GeospatialSolidColor + * // Color: "STRING_VALUE", // required + * // State: "ENABLED" || "DISABLED", + * // }, + * // Gradient: { // GeospatialGradientColor + * // StepColors: [ // GeospatialGradientStepColorList // required + * // { // GeospatialGradientStepColor + * // Color: "STRING_VALUE", // required + * // DataValue: Number("double"), // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: { // GeospatialNullDataSettings + * // SymbolStyle: { // GeospatialNullSymbolStyle + * // FillColor: "STRING_VALUE", + * // StrokeColor: "STRING_VALUE", + * // StrokeWidth: Number("double"), + * // }, + * // }, + * // DefaultOpacity: Number("double"), + * // }, + * // Categorical: { // GeospatialCategoricalColor + * // CategoryDataColors: [ // GeospatialCategoricalDataColorList // required + * // { // GeospatialCategoricalDataColor + * // Color: "STRING_VALUE", // required + * // DataValue: "STRING_VALUE", // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: { + * // SymbolStyle: { + * // FillColor: "STRING_VALUE", + * // StrokeColor: "STRING_VALUE", + * // StrokeWidth: Number("double"), + * // }, + * // }, + * // DefaultOpacity: Number("double"), + * // }, + * // }, + * // StrokeColor: { + * // Solid: { + * // Color: "STRING_VALUE", // required + * // State: "ENABLED" || "DISABLED", + * // }, + * // Gradient: { + * // StepColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: Number("double"), // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: { + * // SymbolStyle: { + * // FillColor: "STRING_VALUE", + * // StrokeColor: "STRING_VALUE", + * // StrokeWidth: Number("double"), + * // }, + * // }, + * // DefaultOpacity: Number("double"), + * // }, + * // Categorical: { + * // CategoryDataColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: "STRING_VALUE", // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: { + * // SymbolStyle: { + * // FillColor: "STRING_VALUE", + * // StrokeColor: "STRING_VALUE", + * // StrokeWidth: Number("double"), + * // }, + * // }, + * // DefaultOpacity: Number("double"), + * // }, + * // }, + * // StrokeWidth: { // GeospatialLineWidth + * // LineWidth: Number("double"), + * // }, + * // CircleRadius: { // GeospatialCircleRadius + * // Radius: Number("double"), + * // }, + * // }, + * // }, + * // }, + * // LineLayer: { // GeospatialLineLayer + * // Style: { // GeospatialLineStyle + * // LineSymbolStyle: { // GeospatialLineSymbolStyle + * // FillColor: { + * // Solid: { + * // Color: "STRING_VALUE", // required + * // State: "ENABLED" || "DISABLED", + * // }, + * // Gradient: { + * // StepColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: Number("double"), // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: { + * // SymbolStyle: { + * // FillColor: "STRING_VALUE", + * // StrokeColor: "STRING_VALUE", + * // StrokeWidth: Number("double"), + * // }, + * // }, + * // DefaultOpacity: Number("double"), + * // }, + * // Categorical: { + * // CategoryDataColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: "STRING_VALUE", // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: "", + * // DefaultOpacity: Number("double"), + * // }, + * // }, + * // LineWidth: { + * // LineWidth: Number("double"), + * // }, + * // }, + * // }, + * // }, + * // PolygonLayer: { // GeospatialPolygonLayer + * // Style: { // GeospatialPolygonStyle + * // PolygonSymbolStyle: { // GeospatialPolygonSymbolStyle + * // FillColor: { + * // Solid: { + * // Color: "STRING_VALUE", // required + * // State: "ENABLED" || "DISABLED", + * // }, + * // Gradient: { + * // StepColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: Number("double"), // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: "", + * // DefaultOpacity: Number("double"), + * // }, + * // Categorical: { + * // CategoryDataColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: "STRING_VALUE", // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: "", + * // DefaultOpacity: Number("double"), + * // }, + * // }, + * // StrokeColor: { + * // Solid: { + * // Color: "STRING_VALUE", // required + * // State: "ENABLED" || "DISABLED", + * // }, + * // Gradient: { + * // StepColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: Number("double"), // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: "", + * // DefaultOpacity: Number("double"), + * // }, + * // Categorical: { + * // CategoryDataColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: "STRING_VALUE", // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: "", + * // DefaultOpacity: Number("double"), + * // }, + * // }, + * // StrokeWidth: { + * // LineWidth: Number("double"), + * // }, + * // }, + * // }, + * // }, + * // }, + * // Tooltip: "", + * // JoinDefinition: { // GeospatialLayerJoinDefinition + * // ShapeKeyField: "STRING_VALUE", + * // DatasetKeyField: { + * // FieldId: "STRING_VALUE", // required + * // Column: "", // required + * // FormatConfiguration: { + * // StringFormatConfiguration: "", + * // NumberFormatConfiguration: "", + * // DateTimeFormatConfiguration: "", + * // }, + * // }, + * // ColorField: { // GeospatialLayerColorField + * // ColorDimensionsFields: [ // GeospatialLayerDimensionFieldList + * // "", + * // ], + * // ColorValuesFields: [ // GeospatialLayerMeasureFieldList + * // "", + * // ], + * // }, + * // }, + * // Actions: [ // LayerCustomActionList + * // { // LayerCustomAction + * // CustomActionId: "STRING_VALUE", // required + * // Name: "STRING_VALUE", // required + * // Status: "ENABLED" || "DISABLED", + * // Trigger: "DATA_POINT_CLICK" || "DATA_POINT_MENU", // required + * // ActionOperations: [ // LayerCustomActionOperationList // required + * // { // LayerCustomActionOperation + * // FilterOperation: "", + * // NavigationOperation: "", + * // URLOperation: "", + * // SetParametersOperation: "", + * // }, + * // ], + * // }, + * // ], + * // }, + * // ], + * // MapState: { // GeospatialMapState + * // Bounds: { + * // North: Number("double"), // required + * // South: Number("double"), // required + * // West: Number("double"), // required + * // East: Number("double"), // required + * // }, + * // MapNavigation: "ENABLED" || "DISABLED", + * // }, + * // MapStyle: { // GeospatialMapStyle + * // BaseMapStyle: "LIGHT_GRAY" || "DARK_GRAY" || "STREET" || "IMAGERY", + * // BackgroundColor: "STRING_VALUE", + * // BaseMapVisibility: "HIDDEN" || "VISIBLE", + * // }, + * // Interactions: "", + * // }, + * // DataSetIdentifier: "STRING_VALUE", // required + * // VisualContentAltText: "STRING_VALUE", * // }, * // FunnelChartVisual: { // FunnelChartVisual * // VisualId: "STRING_VALUE", // required @@ -3667,6 +3970,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // ScatterPlotVisual: { // ScatterPlotVisual * // VisualId: "STRING_VALUE", // required @@ -3704,6 +4008,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // ComboChartVisual: { // ComboChartVisual * // VisualId: "STRING_VALUE", // required @@ -3780,6 +4085,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // BoxPlotVisual: { // BoxPlotVisual * // VisualId: "STRING_VALUE", // required @@ -3855,6 +4161,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // WaterfallVisual: { // WaterfallVisual * // VisualId: "STRING_VALUE", // required @@ -3893,6 +4200,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // HistogramVisual: { // HistogramVisual * // VisualId: "STRING_VALUE", // required @@ -3926,6 +4234,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // Interactions: "", * // }, * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // WordCloudVisual: { // WordCloudVisual * // VisualId: "STRING_VALUE", // required @@ -3959,6 +4268,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // InsightVisual: { // InsightVisual * // VisualId: "STRING_VALUE", // required @@ -4051,6 +4361,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // }, * // Actions: "", * // DataSetIdentifier: "STRING_VALUE", // required + * // VisualContentAltText: "STRING_VALUE", * // }, * // SankeyDiagramVisual: { // SankeyDiagramVisual * // VisualId: "STRING_VALUE", // required @@ -4073,6 +4384,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // Interactions: "", * // }, * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // CustomContentVisual: { // CustomContentVisual * // VisualId: "STRING_VALUE", // required @@ -4086,6 +4398,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // }, * // Actions: "", * // DataSetIdentifier: "STRING_VALUE", // required + * // VisualContentAltText: "STRING_VALUE", * // }, * // EmptyVisual: { // EmptyVisual * // VisualId: "STRING_VALUE", // required @@ -4137,6 +4450,52 @@ export interface DescribeDashboardDefinitionCommandOutput * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", + * // }, + * // PluginVisual: { // PluginVisual + * // VisualId: "STRING_VALUE", // required + * // PluginArn: "STRING_VALUE", // required + * // Title: "", + * // Subtitle: "", + * // ChartConfiguration: { // PluginVisualConfiguration + * // FieldWells: [ // PluginVisualFieldWells + * // { // PluginVisualFieldWell + * // AxisName: "GROUP_BY" || "VALUE", + * // Dimensions: "", + * // Measures: "", + * // Unaggregated: [ + * // { + * // FieldId: "STRING_VALUE", // required + * // Column: "", // required + * // FormatConfiguration: { + * // StringFormatConfiguration: "", + * // NumberFormatConfiguration: "", + * // DateTimeFormatConfiguration: "", + * // }, + * // }, + * // ], + * // }, + * // ], + * // VisualOptions: { // PluginVisualOptions + * // VisualProperties: [ // PluginVisualPropertiesList + * // { // PluginVisualProperty + * // Name: "STRING_VALUE", + * // Value: "STRING_VALUE", + * // }, + * // ], + * // }, + * // SortConfiguration: { // PluginVisualSortConfiguration + * // PluginVisualTableQuerySort: { // PluginVisualTableQuerySort + * // RowSort: [ + * // "", + * // ], + * // ItemsLimitConfiguration: { // PluginVisualItemsLimitConfiguration + * // ItemsLimit: Number("long"), + * // }, + * // }, + * // }, + * // }, + * // VisualContentAltText: "STRING_VALUE", * // }, * // }, * // ], @@ -4146,6 +4505,46 @@ export interface DescribeDashboardDefinitionCommandOutput * // Content: "STRING_VALUE", * // }, * // ], + * // Images: [ // SheetImageList + * // { // SheetImage + * // SheetImageId: "STRING_VALUE", // required + * // Source: { // SheetImageSource + * // SheetImageStaticFileSource: { // SheetImageStaticFileSource + * // StaticFileId: "STRING_VALUE", // required + * // }, + * // }, + * // Scaling: { // SheetImageScalingConfiguration + * // ScalingType: "SCALE_TO_WIDTH" || "SCALE_TO_HEIGHT" || "SCALE_TO_CONTAINER" || "SCALE_NONE", + * // }, + * // Tooltip: { // SheetImageTooltipConfiguration + * // TooltipText: { // SheetImageTooltipText + * // PlainText: "STRING_VALUE", + * // }, + * // Visibility: "HIDDEN" || "VISIBLE", + * // }, + * // ImageContentAltText: "STRING_VALUE", + * // Interactions: { // ImageInteractionOptions + * // ImageMenuOption: { // ImageMenuOption + * // AvailabilityStatus: "ENABLED" || "DISABLED", + * // }, + * // }, + * // Actions: [ // ImageCustomActionList + * // { // ImageCustomAction + * // CustomActionId: "STRING_VALUE", // required + * // Name: "STRING_VALUE", // required + * // Status: "ENABLED" || "DISABLED", + * // Trigger: "CLICK" || "MENU", // required + * // ActionOperations: [ // ImageCustomActionOperationList // required + * // { // ImageCustomActionOperation + * // NavigationOperation: "", + * // URLOperation: "", + * // SetParametersOperation: "", + * // }, + * // ], + * // }, + * // ], + * // }, + * // ], * // Layouts: [ // LayoutList * // { // Layout * // Configuration: { // LayoutConfiguration @@ -4153,7 +4552,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // Elements: [ // GridLayoutElementList // required * // { // GridLayoutElement * // ElementId: "STRING_VALUE", // required - * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * // ColumnIndex: Number("int"), * // ColumnSpan: Number("int"), // required * // RowIndex: Number("int"), @@ -4171,7 +4570,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // Elements: [ // FreeFromLayoutElementList // required * // { // FreeFormLayoutElement * // ElementId: "STRING_VALUE", // required - * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * // XAxisLocation: "STRING_VALUE", // required * // YAxisLocation: "STRING_VALUE", // required * // Width: "STRING_VALUE", // required @@ -4217,7 +4616,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // Elements: [ // required * // { * // ElementId: "STRING_VALUE", // required - * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * // XAxisLocation: "STRING_VALUE", // required * // YAxisLocation: "STRING_VALUE", // required * // Width: "STRING_VALUE", // required @@ -4357,7 +4756,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // Elements: [ // required * // { * // ElementId: "STRING_VALUE", // required - * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * // ColumnIndex: Number("int"), * // ColumnSpan: Number("int"), // required * // RowIndex: Number("int"), @@ -5022,6 +5421,36 @@ export interface DescribeDashboardDefinitionCommandOutput * // Timezone: "STRING_VALUE", * // WeekStart: "SUNDAY" || "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY", * // }, + * // StaticFiles: [ // StaticFileList + * // { // StaticFile + * // ImageStaticFile: { // ImageStaticFile + * // StaticFileId: "STRING_VALUE", // required + * // Source: { // StaticFileSource + * // UrlOptions: { // StaticFileUrlSourceOptions + * // Url: "STRING_VALUE", // required + * // }, + * // S3Options: { // StaticFileS3SourceOptions + * // BucketName: "STRING_VALUE", // required + * // ObjectKey: "STRING_VALUE", // required + * // Region: "STRING_VALUE", // required + * // }, + * // }, + * // }, + * // SpatialStaticFile: { // SpatialStaticFile + * // StaticFileId: "STRING_VALUE", // required + * // Source: { + * // UrlOptions: { + * // Url: "STRING_VALUE", // required + * // }, + * // S3Options: { + * // BucketName: "STRING_VALUE", // required + * // ObjectKey: "STRING_VALUE", // required + * // Region: "STRING_VALUE", // required + * // }, + * // }, + * // }, + * // }, + * // ], * // }, * // Status: Number("int"), * // RequestId: "STRING_VALUE", diff --git a/clients/client-quicksight/src/commands/DescribeDashboardPermissionsCommand.ts b/clients/client-quicksight/src/commands/DescribeDashboardPermissionsCommand.ts index d49182847f81..a10b21e342dc 100644 --- a/clients/client-quicksight/src/commands/DescribeDashboardPermissionsCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeDashboardPermissionsCommand.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 { DescribeDashboardPermissionsRequest, DescribeDashboardPermissionsResponse } from "../models/models_3"; +import { DescribeDashboardPermissionsRequest, DescribeDashboardPermissionsResponse } from "../models/models_4"; import { de_DescribeDashboardPermissionsCommand, se_DescribeDashboardPermissionsCommand, diff --git a/clients/client-quicksight/src/commands/DescribeDashboardSnapshotJobCommand.ts b/clients/client-quicksight/src/commands/DescribeDashboardSnapshotJobCommand.ts index aa39d97eedb4..20394a10d340 100644 --- a/clients/client-quicksight/src/commands/DescribeDashboardSnapshotJobCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeDashboardSnapshotJobCommand.ts @@ -9,7 +9,7 @@ import { DescribeDashboardSnapshotJobRequest, DescribeDashboardSnapshotJobResponse, DescribeDashboardSnapshotJobResponseFilterSensitiveLog, -} from "../models/models_3"; +} from "../models/models_4"; import { de_DescribeDashboardSnapshotJobCommand, se_DescribeDashboardSnapshotJobCommand, diff --git a/clients/client-quicksight/src/commands/DescribeDashboardSnapshotJobResultCommand.ts b/clients/client-quicksight/src/commands/DescribeDashboardSnapshotJobResultCommand.ts index e7b3a1b27139..c31f0d347b19 100644 --- a/clients/client-quicksight/src/commands/DescribeDashboardSnapshotJobResultCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeDashboardSnapshotJobResultCommand.ts @@ -9,7 +9,7 @@ import { DescribeDashboardSnapshotJobResultRequest, DescribeDashboardSnapshotJobResultResponse, DescribeDashboardSnapshotJobResultResponseFilterSensitiveLog, -} from "../models/models_3"; +} from "../models/models_4"; import { de_DescribeDashboardSnapshotJobResultCommand, se_DescribeDashboardSnapshotJobResultCommand, diff --git a/clients/client-quicksight/src/commands/DescribeDashboardsQAConfigurationCommand.ts b/clients/client-quicksight/src/commands/DescribeDashboardsQAConfigurationCommand.ts new file mode 100644 index 000000000000..07bb038a3cfc --- /dev/null +++ b/clients/client-quicksight/src/commands/DescribeDashboardsQAConfigurationCommand.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 { + DescribeDashboardsQAConfigurationRequest, + DescribeDashboardsQAConfigurationResponse, +} from "../models/models_4"; +import { + de_DescribeDashboardsQAConfigurationCommand, + se_DescribeDashboardsQAConfigurationCommand, +} from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribeDashboardsQAConfigurationCommand}. + */ +export interface DescribeDashboardsQAConfigurationCommandInput extends DescribeDashboardsQAConfigurationRequest {} +/** + * @public + * + * The output of {@link DescribeDashboardsQAConfigurationCommand}. + */ +export interface DescribeDashboardsQAConfigurationCommandOutput + extends DescribeDashboardsQAConfigurationResponse, + __MetadataBearer {} + +/** + *

Describes an existing dashboard QA configuration.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeDashboardsQAConfigurationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeDashboardsQAConfigurationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // DescribeDashboardsQAConfigurationRequest + * AwsAccountId: "STRING_VALUE", // required + * }; + * const command = new DescribeDashboardsQAConfigurationCommand(input); + * const response = await client.send(command); + * // { // DescribeDashboardsQAConfigurationResponse + * // DashboardsQAStatus: "ENABLED" || "DISABLED", + * // RequestId: "STRING_VALUE", + * // Status: Number("int"), + * // }; + * + * ``` + * + * @param DescribeDashboardsQAConfigurationCommandInput - {@link DescribeDashboardsQAConfigurationCommandInput} + * @returns {@link DescribeDashboardsQAConfigurationCommandOutput} + * @see {@link DescribeDashboardsQAConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeDashboardsQAConfigurationCommandOutput} 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 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 DescribeDashboardsQAConfigurationCommand extends $Command + .classBuilder< + DescribeDashboardsQAConfigurationCommandInput, + DescribeDashboardsQAConfigurationCommandOutput, + 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", "DescribeDashboardsQAConfiguration", {}) + .n("QuickSightClient", "DescribeDashboardsQAConfigurationCommand") + .f(void 0, void 0) + .ser(se_DescribeDashboardsQAConfigurationCommand) + .de(de_DescribeDashboardsQAConfigurationCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribeDashboardsQAConfigurationRequest; + output: DescribeDashboardsQAConfigurationResponse; + }; + sdk: { + input: DescribeDashboardsQAConfigurationCommandInput; + output: DescribeDashboardsQAConfigurationCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/DescribeDataSetCommand.ts b/clients/client-quicksight/src/commands/DescribeDataSetCommand.ts index 7be0bc1e0bf6..2cca205e0e3f 100644 --- a/clients/client-quicksight/src/commands/DescribeDataSetCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeDataSetCommand.ts @@ -9,7 +9,7 @@ import { DescribeDataSetRequest, DescribeDataSetResponse, DescribeDataSetResponseFilterSensitiveLog, -} from "../models/models_3"; +} from "../models/models_4"; import { de_DescribeDataSetCommand, se_DescribeDataSetCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeDataSetPermissionsCommand.ts b/clients/client-quicksight/src/commands/DescribeDataSetPermissionsCommand.ts index 8c41d70aac82..62e73cfc1066 100644 --- a/clients/client-quicksight/src/commands/DescribeDataSetPermissionsCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeDataSetPermissionsCommand.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 { DescribeDataSetPermissionsRequest, DescribeDataSetPermissionsResponse } from "../models/models_3"; +import { DescribeDataSetPermissionsRequest, DescribeDataSetPermissionsResponse } from "../models/models_4"; import { de_DescribeDataSetPermissionsCommand, se_DescribeDataSetPermissionsCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeDataSetRefreshPropertiesCommand.ts b/clients/client-quicksight/src/commands/DescribeDataSetRefreshPropertiesCommand.ts index f666fc5855cf..8993885445fd 100644 --- a/clients/client-quicksight/src/commands/DescribeDataSetRefreshPropertiesCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeDataSetRefreshPropertiesCommand.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 { DescribeDataSetRefreshPropertiesRequest, DescribeDataSetRefreshPropertiesResponse } from "../models/models_3"; +import { DescribeDataSetRefreshPropertiesRequest, DescribeDataSetRefreshPropertiesResponse } from "../models/models_4"; import { de_DescribeDataSetRefreshPropertiesCommand, se_DescribeDataSetRefreshPropertiesCommand, diff --git a/clients/client-quicksight/src/commands/DescribeDataSourceCommand.ts b/clients/client-quicksight/src/commands/DescribeDataSourceCommand.ts index 4e32e7d8e263..bb0d70a87a12 100644 --- a/clients/client-quicksight/src/commands/DescribeDataSourceCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeDataSourceCommand.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 { DescribeDataSourceRequest, DescribeDataSourceResponse } from "../models/models_3"; +import { DescribeDataSourceRequest, DescribeDataSourceResponse } from "../models/models_4"; import { de_DescribeDataSourceCommand, se_DescribeDataSourceCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeDataSourcePermissionsCommand.ts b/clients/client-quicksight/src/commands/DescribeDataSourcePermissionsCommand.ts index 983561565f3c..99ebe1426e22 100644 --- a/clients/client-quicksight/src/commands/DescribeDataSourcePermissionsCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeDataSourcePermissionsCommand.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 { DescribeDataSourcePermissionsRequest, DescribeDataSourcePermissionsResponse } from "../models/models_3"; +import { DescribeDataSourcePermissionsRequest, DescribeDataSourcePermissionsResponse } from "../models/models_4"; import { de_DescribeDataSourcePermissionsCommand, se_DescribeDataSourcePermissionsCommand, diff --git a/clients/client-quicksight/src/commands/DescribeFolderCommand.ts b/clients/client-quicksight/src/commands/DescribeFolderCommand.ts index ebff72752462..bfce7ca98b56 100644 --- a/clients/client-quicksight/src/commands/DescribeFolderCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeFolderCommand.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 { DescribeFolderRequest, DescribeFolderResponse } from "../models/models_3"; +import { DescribeFolderRequest, DescribeFolderResponse } from "../models/models_4"; import { de_DescribeFolderCommand, se_DescribeFolderCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeFolderPermissionsCommand.ts b/clients/client-quicksight/src/commands/DescribeFolderPermissionsCommand.ts index b71d87ebde93..e5ab210ed26d 100644 --- a/clients/client-quicksight/src/commands/DescribeFolderPermissionsCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeFolderPermissionsCommand.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 { DescribeFolderPermissionsRequest, DescribeFolderPermissionsResponse } from "../models/models_3"; +import { DescribeFolderPermissionsRequest, DescribeFolderPermissionsResponse } from "../models/models_4"; import { de_DescribeFolderPermissionsCommand, se_DescribeFolderPermissionsCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeFolderResolvedPermissionsCommand.ts b/clients/client-quicksight/src/commands/DescribeFolderResolvedPermissionsCommand.ts index 9ee9e5a52216..638dec0a8f9f 100644 --- a/clients/client-quicksight/src/commands/DescribeFolderResolvedPermissionsCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeFolderResolvedPermissionsCommand.ts @@ -8,7 +8,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { DescribeFolderResolvedPermissionsRequest, DescribeFolderResolvedPermissionsResponse, -} from "../models/models_3"; +} from "../models/models_4"; import { de_DescribeFolderResolvedPermissionsCommand, se_DescribeFolderResolvedPermissionsCommand, diff --git a/clients/client-quicksight/src/commands/DescribeGroupCommand.ts b/clients/client-quicksight/src/commands/DescribeGroupCommand.ts index 1fe5ea155c7d..dd129dd50d2d 100644 --- a/clients/client-quicksight/src/commands/DescribeGroupCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeGroupCommand.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 { DescribeGroupRequest, DescribeGroupResponse } from "../models/models_3"; +import { DescribeGroupRequest, DescribeGroupResponse } from "../models/models_4"; import { de_DescribeGroupCommand, se_DescribeGroupCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeGroupMembershipCommand.ts b/clients/client-quicksight/src/commands/DescribeGroupMembershipCommand.ts index f98409933a01..17ff7f1d56bc 100644 --- a/clients/client-quicksight/src/commands/DescribeGroupMembershipCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeGroupMembershipCommand.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 { DescribeGroupMembershipRequest, DescribeGroupMembershipResponse } from "../models/models_3"; +import { DescribeGroupMembershipRequest, DescribeGroupMembershipResponse } from "../models/models_4"; import { de_DescribeGroupMembershipCommand, se_DescribeGroupMembershipCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeIAMPolicyAssignmentCommand.ts b/clients/client-quicksight/src/commands/DescribeIAMPolicyAssignmentCommand.ts index 041b56c18fcf..c0f0e1e690e6 100644 --- a/clients/client-quicksight/src/commands/DescribeIAMPolicyAssignmentCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeIAMPolicyAssignmentCommand.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 { DescribeIAMPolicyAssignmentRequest, DescribeIAMPolicyAssignmentResponse } from "../models/models_3"; +import { DescribeIAMPolicyAssignmentRequest, DescribeIAMPolicyAssignmentResponse } from "../models/models_4"; import { de_DescribeIAMPolicyAssignmentCommand, se_DescribeIAMPolicyAssignmentCommand, diff --git a/clients/client-quicksight/src/commands/DescribeIngestionCommand.ts b/clients/client-quicksight/src/commands/DescribeIngestionCommand.ts index d0962e089585..e9602b0869cb 100644 --- a/clients/client-quicksight/src/commands/DescribeIngestionCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeIngestionCommand.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 { DescribeIngestionRequest } from "../models/models_3"; -import { DescribeIngestionResponse } from "../models/models_4"; +import { DescribeIngestionRequest, 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/DescribeNamespaceCommand.ts b/clients/client-quicksight/src/commands/DescribeNamespaceCommand.ts index 5c98ef27b005..e45af0b4e034 100644 --- a/clients/client-quicksight/src/commands/DescribeNamespaceCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeNamespaceCommand.ts @@ -52,6 +52,8 @@ export interface DescribeNamespaceCommandOutput extends DescribeNamespaceRespons * // Type: "PERMISSION_DENIED" || "INTERNAL_SERVICE_ERROR", * // Message: "STRING_VALUE", * // }, + * // IamIdentityCenterApplicationArn: "STRING_VALUE", + * // IamIdentityCenterInstanceArn: "STRING_VALUE", * // }, * // RequestId: "STRING_VALUE", * // Status: Number("int"), diff --git a/clients/client-quicksight/src/commands/DescribeTemplateCommand.ts b/clients/client-quicksight/src/commands/DescribeTemplateCommand.ts index 5a9640db3779..603a13af7d2e 100644 --- a/clients/client-quicksight/src/commands/DescribeTemplateCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeTemplateCommand.ts @@ -5,7 +5,11 @@ 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_4"; +import { + DescribeTemplateRequest, + DescribeTemplateResponse, + DescribeTemplateResponseFilterSensitiveLog, +} from "../models/models_4"; import { de_DescribeTemplateCommand, se_DescribeTemplateCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; @@ -93,6 +97,85 @@ export interface DescribeTemplateCommandOutput extends DescribeTemplateResponse, * // { // Sheet * // SheetId: "STRING_VALUE", * // Name: "STRING_VALUE", + * // Images: [ // SheetImageList + * // { // SheetImage + * // SheetImageId: "STRING_VALUE", // required + * // Source: { // SheetImageSource + * // SheetImageStaticFileSource: { // SheetImageStaticFileSource + * // StaticFileId: "STRING_VALUE", // required + * // }, + * // }, + * // Scaling: { // SheetImageScalingConfiguration + * // ScalingType: "SCALE_TO_WIDTH" || "SCALE_TO_HEIGHT" || "SCALE_TO_CONTAINER" || "SCALE_NONE", + * // }, + * // Tooltip: { // SheetImageTooltipConfiguration + * // TooltipText: { // SheetImageTooltipText + * // PlainText: "STRING_VALUE", + * // }, + * // Visibility: "HIDDEN" || "VISIBLE", + * // }, + * // ImageContentAltText: "STRING_VALUE", + * // Interactions: { // ImageInteractionOptions + * // ImageMenuOption: { // ImageMenuOption + * // AvailabilityStatus: "ENABLED" || "DISABLED", + * // }, + * // }, + * // Actions: [ // ImageCustomActionList + * // { // ImageCustomAction + * // CustomActionId: "STRING_VALUE", // required + * // Name: "STRING_VALUE", // required + * // Status: "ENABLED" || "DISABLED", + * // Trigger: "CLICK" || "MENU", // required + * // ActionOperations: [ // ImageCustomActionOperationList // required + * // { // ImageCustomActionOperation + * // NavigationOperation: { // CustomActionNavigationOperation + * // LocalNavigationConfiguration: { // LocalNavigationConfiguration + * // TargetSheetId: "STRING_VALUE", // required + * // }, + * // }, + * // URLOperation: { // CustomActionURLOperation + * // URLTemplate: "STRING_VALUE", // required + * // URLTarget: "NEW_TAB" || "NEW_WINDOW" || "SAME_TAB", // required + * // }, + * // SetParametersOperation: { // CustomActionSetParametersOperation + * // ParameterValueConfigurations: [ // SetParameterValueConfigurationList // required + * // { // SetParameterValueConfiguration + * // DestinationParameterName: "STRING_VALUE", // required + * // Value: { // DestinationParameterValueConfiguration + * // CustomValuesConfiguration: { // CustomValuesConfiguration + * // IncludeNullValue: true || false, + * // CustomValues: { // CustomParameterValues + * // StringValues: [ // StringDefaultValueList + * // "STRING_VALUE", + * // ], + * // IntegerValues: [ // IntegerDefaultValueList + * // Number("long"), + * // ], + * // DecimalValues: [ // DecimalDefaultValueList + * // Number("double"), + * // ], + * // DateTimeValues: [ // DateTimeDefaultValueList + * // new Date("TIMESTAMP"), + * // ], + * // }, + * // }, + * // SelectAllValueOptions: "ALL_VALUES", + * // SourceParameterName: "STRING_VALUE", + * // SourceField: "STRING_VALUE", + * // SourceColumn: { // ColumnIdentifier + * // DataSetIdentifier: "STRING_VALUE", // required + * // ColumnName: "STRING_VALUE", // required + * // }, + * // }, + * // }, + * // ], + * // }, + * // }, + * // ], + * // }, + * // ], + * // }, + * // ], * // }, * // ], * // }, @@ -164,7 +247,7 @@ export class DescribeTemplateCommand extends $Command }) .s("QuickSight_20180401", "DescribeTemplate", {}) .n("QuickSightClient", "DescribeTemplateCommand") - .f(void 0, void 0) + .f(void 0, DescribeTemplateResponseFilterSensitiveLog) .ser(se_DescribeTemplateCommand) .de(de_DescribeTemplateCommand) .build() { diff --git a/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts b/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts index cc01676b32fd..2991cd475eb1 100644 --- a/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts @@ -114,6 +114,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // FontConfiguration: { // FontConfiguration * // FontSize: { // FontSize * // Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * // Absolute: "STRING_VALUE", * // }, * // FontDecoration: "UNDERLINE" || "NONE", * // FontColor: "STRING_VALUE", @@ -121,6 +122,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // Name: "NORMAL" || "BOLD", * // }, * // FontStyle: "NORMAL" || "ITALIC", + * // FontFamily: "STRING_VALUE", * // }, * // CustomLabel: "STRING_VALUE", * // }, @@ -149,6 +151,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // FontConfiguration: { * // FontSize: { * // Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * // Absolute: "STRING_VALUE", * // }, * // FontDecoration: "UNDERLINE" || "NONE", * // FontColor: "STRING_VALUE", @@ -156,6 +159,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // Name: "NORMAL" || "BOLD", * // }, * // FontStyle: "NORMAL" || "ITALIC", + * // FontFamily: "STRING_VALUE", * // }, * // CustomLabel: "STRING_VALUE", * // }, @@ -199,6 +203,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // FontConfiguration: { * // FontSize: { * // Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * // Absolute: "STRING_VALUE", * // }, * // FontDecoration: "UNDERLINE" || "NONE", * // FontColor: "STRING_VALUE", @@ -206,6 +211,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // Name: "NORMAL" || "BOLD", * // }, * // FontStyle: "NORMAL" || "ITALIC", + * // FontFamily: "STRING_VALUE", * // }, * // CustomLabel: "STRING_VALUE", * // }, @@ -247,6 +253,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // FontConfiguration: { * // FontSize: { * // Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * // Absolute: "STRING_VALUE", * // }, * // FontDecoration: "UNDERLINE" || "NONE", * // FontColor: "STRING_VALUE", @@ -254,6 +261,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // Name: "NORMAL" || "BOLD", * // }, * // FontStyle: "NORMAL" || "ITALIC", + * // FontFamily: "STRING_VALUE", * // }, * // CustomLabel: "STRING_VALUE", * // }, @@ -277,6 +285,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // FontConfiguration: { * // FontSize: { * // Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * // Absolute: "STRING_VALUE", * // }, * // FontDecoration: "UNDERLINE" || "NONE", * // FontColor: "STRING_VALUE", @@ -284,6 +293,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // Name: "NORMAL" || "BOLD", * // }, * // FontStyle: "NORMAL" || "ITALIC", + * // FontFamily: "STRING_VALUE", * // }, * // CustomLabel: "STRING_VALUE", * // }, @@ -1132,6 +1142,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // ], * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // PivotTableVisual: { // PivotTableVisual * // VisualId: "STRING_VALUE", // required @@ -1596,6 +1607,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // ], * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // BarChartVisual: { // BarChartVisual * // VisualId: "STRING_VALUE", // required @@ -1944,6 +1956,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * // Width: "STRING_VALUE", * // Height: "STRING_VALUE", + * // ValueFontConfiguration: "", * // }, * // DataLabels: { // DataLabelOptions * // Visibility: "HIDDEN" || "VISIBLE", @@ -2203,6 +2216,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // }, * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // KPIVisual: { // KPIVisual * // VisualId: "STRING_VALUE", // required @@ -2526,6 +2540,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // }, * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // PieChartVisual: { // PieChartVisual * // VisualId: "STRING_VALUE", // required @@ -2640,6 +2655,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * // Width: "STRING_VALUE", * // Height: "STRING_VALUE", + * // ValueFontConfiguration: "", * // }, * // DataLabels: { * // Visibility: "HIDDEN" || "VISIBLE", @@ -2818,6 +2834,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // }, * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // GaugeChartVisual: { // GaugeChartVisual * // VisualId: "STRING_VALUE", // required @@ -2938,6 +2955,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // ], * // }, * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // LineChartVisual: { // LineChartVisual * // VisualId: "STRING_VALUE", // required @@ -3216,6 +3234,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * // Width: "STRING_VALUE", * // Height: "STRING_VALUE", + * // ValueFontConfiguration: "", * // }, * // DataLabels: { * // Visibility: "HIDDEN" || "VISIBLE", @@ -3352,6 +3371,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // }, * // }, * // ], + * // VisualContentAltText: "STRING_VALUE", * // }, * // HeatMapVisual: { // HeatMapVisual * // VisualId: "STRING_VALUE", // required @@ -3398,6 +3418,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * // Width: "STRING_VALUE", * // Height: "STRING_VALUE", + * // ValueFontConfiguration: "", * // }, * // DataLabels: { * // Visibility: "HIDDEN" || "VISIBLE", @@ -3482,6 +3503,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // }, * // ], * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // TreeMapVisual: { // TreeMapVisual * // VisualId: "STRING_VALUE", // required @@ -3527,6 +3549,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * // Width: "STRING_VALUE", * // Height: "STRING_VALUE", + * // ValueFontConfiguration: "", * // }, * // DataLabels: "", * // Tooltip: "", @@ -3534,6 +3557,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // GeospatialMapVisual: { // GeospatialMapVisual * // VisualId: "STRING_VALUE", // required @@ -3594,6 +3618,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // }, * // ColumnHierarchies: "", * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // FilledMapVisual: { // FilledMapVisual * // VisualId: "STRING_VALUE", // required @@ -3643,6 +3668,284 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // }, * // ColumnHierarchies: "", * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", + * // }, + * // LayerMapVisual: { // LayerMapVisual + * // VisualId: "STRING_VALUE", // required + * // Title: "", + * // Subtitle: "", + * // ChartConfiguration: { // GeospatialLayerMapConfiguration + * // Legend: "", + * // MapLayers: [ // GeospatialMapLayerList + * // { // GeospatialLayerItem + * // LayerId: "STRING_VALUE", // required + * // LayerType: "POINT" || "LINE" || "POLYGON", + * // DataSource: { // GeospatialDataSourceItem + * // StaticFileDataSource: { // GeospatialStaticFileSource + * // StaticFileId: "STRING_VALUE", // required + * // }, + * // }, + * // Label: "STRING_VALUE", + * // Visibility: "HIDDEN" || "VISIBLE", + * // LayerDefinition: { // GeospatialLayerDefinition + * // PointLayer: { // GeospatialPointLayer + * // Style: { // GeospatialPointStyle + * // CircleSymbolStyle: { // GeospatialCircleSymbolStyle + * // FillColor: { // GeospatialColor + * // Solid: { // GeospatialSolidColor + * // Color: "STRING_VALUE", // required + * // State: "ENABLED" || "DISABLED", + * // }, + * // Gradient: { // GeospatialGradientColor + * // StepColors: [ // GeospatialGradientStepColorList // required + * // { // GeospatialGradientStepColor + * // Color: "STRING_VALUE", // required + * // DataValue: Number("double"), // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: { // GeospatialNullDataSettings + * // SymbolStyle: { // GeospatialNullSymbolStyle + * // FillColor: "STRING_VALUE", + * // StrokeColor: "STRING_VALUE", + * // StrokeWidth: Number("double"), + * // }, + * // }, + * // DefaultOpacity: Number("double"), + * // }, + * // Categorical: { // GeospatialCategoricalColor + * // CategoryDataColors: [ // GeospatialCategoricalDataColorList // required + * // { // GeospatialCategoricalDataColor + * // Color: "STRING_VALUE", // required + * // DataValue: "STRING_VALUE", // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: { + * // SymbolStyle: { + * // FillColor: "STRING_VALUE", + * // StrokeColor: "STRING_VALUE", + * // StrokeWidth: Number("double"), + * // }, + * // }, + * // DefaultOpacity: Number("double"), + * // }, + * // }, + * // StrokeColor: { + * // Solid: { + * // Color: "STRING_VALUE", // required + * // State: "ENABLED" || "DISABLED", + * // }, + * // Gradient: { + * // StepColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: Number("double"), // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: { + * // SymbolStyle: { + * // FillColor: "STRING_VALUE", + * // StrokeColor: "STRING_VALUE", + * // StrokeWidth: Number("double"), + * // }, + * // }, + * // DefaultOpacity: Number("double"), + * // }, + * // Categorical: { + * // CategoryDataColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: "STRING_VALUE", // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: { + * // SymbolStyle: { + * // FillColor: "STRING_VALUE", + * // StrokeColor: "STRING_VALUE", + * // StrokeWidth: Number("double"), + * // }, + * // }, + * // DefaultOpacity: Number("double"), + * // }, + * // }, + * // StrokeWidth: { // GeospatialLineWidth + * // LineWidth: Number("double"), + * // }, + * // CircleRadius: { // GeospatialCircleRadius + * // Radius: Number("double"), + * // }, + * // }, + * // }, + * // }, + * // LineLayer: { // GeospatialLineLayer + * // Style: { // GeospatialLineStyle + * // LineSymbolStyle: { // GeospatialLineSymbolStyle + * // FillColor: { + * // Solid: { + * // Color: "STRING_VALUE", // required + * // State: "ENABLED" || "DISABLED", + * // }, + * // Gradient: { + * // StepColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: Number("double"), // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: { + * // SymbolStyle: { + * // FillColor: "STRING_VALUE", + * // StrokeColor: "STRING_VALUE", + * // StrokeWidth: Number("double"), + * // }, + * // }, + * // DefaultOpacity: Number("double"), + * // }, + * // Categorical: { + * // CategoryDataColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: "STRING_VALUE", // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: "", + * // DefaultOpacity: Number("double"), + * // }, + * // }, + * // LineWidth: { + * // LineWidth: Number("double"), + * // }, + * // }, + * // }, + * // }, + * // PolygonLayer: { // GeospatialPolygonLayer + * // Style: { // GeospatialPolygonStyle + * // PolygonSymbolStyle: { // GeospatialPolygonSymbolStyle + * // FillColor: { + * // Solid: { + * // Color: "STRING_VALUE", // required + * // State: "ENABLED" || "DISABLED", + * // }, + * // Gradient: { + * // StepColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: Number("double"), // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: "", + * // DefaultOpacity: Number("double"), + * // }, + * // Categorical: { + * // CategoryDataColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: "STRING_VALUE", // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: "", + * // DefaultOpacity: Number("double"), + * // }, + * // }, + * // StrokeColor: { + * // Solid: { + * // Color: "STRING_VALUE", // required + * // State: "ENABLED" || "DISABLED", + * // }, + * // Gradient: { + * // StepColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: Number("double"), // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: "", + * // DefaultOpacity: Number("double"), + * // }, + * // Categorical: { + * // CategoryDataColors: [ // required + * // { + * // Color: "STRING_VALUE", // required + * // DataValue: "STRING_VALUE", // required + * // }, + * // ], + * // NullDataVisibility: "HIDDEN" || "VISIBLE", + * // NullDataSettings: "", + * // DefaultOpacity: Number("double"), + * // }, + * // }, + * // StrokeWidth: { + * // LineWidth: Number("double"), + * // }, + * // }, + * // }, + * // }, + * // }, + * // Tooltip: "", + * // JoinDefinition: { // GeospatialLayerJoinDefinition + * // ShapeKeyField: "STRING_VALUE", + * // DatasetKeyField: { + * // FieldId: "STRING_VALUE", // required + * // Column: "", // required + * // FormatConfiguration: { + * // StringFormatConfiguration: "", + * // NumberFormatConfiguration: "", + * // DateTimeFormatConfiguration: "", + * // }, + * // }, + * // ColorField: { // GeospatialLayerColorField + * // ColorDimensionsFields: [ // GeospatialLayerDimensionFieldList + * // "", + * // ], + * // ColorValuesFields: [ // GeospatialLayerMeasureFieldList + * // "", + * // ], + * // }, + * // }, + * // Actions: [ // LayerCustomActionList + * // { // LayerCustomAction + * // CustomActionId: "STRING_VALUE", // required + * // Name: "STRING_VALUE", // required + * // Status: "ENABLED" || "DISABLED", + * // Trigger: "DATA_POINT_CLICK" || "DATA_POINT_MENU", // required + * // ActionOperations: [ // LayerCustomActionOperationList // required + * // { // LayerCustomActionOperation + * // FilterOperation: "", + * // NavigationOperation: "", + * // URLOperation: "", + * // SetParametersOperation: "", + * // }, + * // ], + * // }, + * // ], + * // }, + * // ], + * // MapState: { // GeospatialMapState + * // Bounds: { + * // North: Number("double"), // required + * // South: Number("double"), // required + * // West: Number("double"), // required + * // East: Number("double"), // required + * // }, + * // MapNavigation: "ENABLED" || "DISABLED", + * // }, + * // MapStyle: { // GeospatialMapStyle + * // BaseMapStyle: "LIGHT_GRAY" || "DARK_GRAY" || "STREET" || "IMAGERY", + * // BackgroundColor: "STRING_VALUE", + * // BaseMapVisibility: "HIDDEN" || "VISIBLE", + * // }, + * // Interactions: "", + * // }, + * // DataSetIdentifier: "STRING_VALUE", // required + * // VisualContentAltText: "STRING_VALUE", * // }, * // FunnelChartVisual: { // FunnelChartVisual * // VisualId: "STRING_VALUE", // required @@ -3680,6 +3983,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // ScatterPlotVisual: { // ScatterPlotVisual * // VisualId: "STRING_VALUE", // required @@ -3717,6 +4021,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // ComboChartVisual: { // ComboChartVisual * // VisualId: "STRING_VALUE", // required @@ -3793,6 +4098,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // BoxPlotVisual: { // BoxPlotVisual * // VisualId: "STRING_VALUE", // required @@ -3868,6 +4174,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // WaterfallVisual: { // WaterfallVisual * // VisualId: "STRING_VALUE", // required @@ -3906,6 +4213,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // HistogramVisual: { // HistogramVisual * // VisualId: "STRING_VALUE", // required @@ -3939,6 +4247,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // Interactions: "", * // }, * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // WordCloudVisual: { // WordCloudVisual * // VisualId: "STRING_VALUE", // required @@ -3972,6 +4281,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // InsightVisual: { // InsightVisual * // VisualId: "STRING_VALUE", // required @@ -4064,6 +4374,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // }, * // Actions: "", * // DataSetIdentifier: "STRING_VALUE", // required + * // VisualContentAltText: "STRING_VALUE", * // }, * // SankeyDiagramVisual: { // SankeyDiagramVisual * // VisualId: "STRING_VALUE", // required @@ -4086,6 +4397,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // Interactions: "", * // }, * // Actions: "", + * // VisualContentAltText: "STRING_VALUE", * // }, * // CustomContentVisual: { // CustomContentVisual * // VisualId: "STRING_VALUE", // required @@ -4099,6 +4411,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // }, * // Actions: "", * // DataSetIdentifier: "STRING_VALUE", // required + * // VisualContentAltText: "STRING_VALUE", * // }, * // EmptyVisual: { // EmptyVisual * // VisualId: "STRING_VALUE", // required @@ -4150,6 +4463,52 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // }, * // Actions: "", * // ColumnHierarchies: "", + * // VisualContentAltText: "STRING_VALUE", + * // }, + * // PluginVisual: { // PluginVisual + * // VisualId: "STRING_VALUE", // required + * // PluginArn: "STRING_VALUE", // required + * // Title: "", + * // Subtitle: "", + * // ChartConfiguration: { // PluginVisualConfiguration + * // FieldWells: [ // PluginVisualFieldWells + * // { // PluginVisualFieldWell + * // AxisName: "GROUP_BY" || "VALUE", + * // Dimensions: "", + * // Measures: "", + * // Unaggregated: [ + * // { + * // FieldId: "STRING_VALUE", // required + * // Column: "", // required + * // FormatConfiguration: { + * // StringFormatConfiguration: "", + * // NumberFormatConfiguration: "", + * // DateTimeFormatConfiguration: "", + * // }, + * // }, + * // ], + * // }, + * // ], + * // VisualOptions: { // PluginVisualOptions + * // VisualProperties: [ // PluginVisualPropertiesList + * // { // PluginVisualProperty + * // Name: "STRING_VALUE", + * // Value: "STRING_VALUE", + * // }, + * // ], + * // }, + * // SortConfiguration: { // PluginVisualSortConfiguration + * // PluginVisualTableQuerySort: { // PluginVisualTableQuerySort + * // RowSort: [ + * // "", + * // ], + * // ItemsLimitConfiguration: { // PluginVisualItemsLimitConfiguration + * // ItemsLimit: Number("long"), + * // }, + * // }, + * // }, + * // }, + * // VisualContentAltText: "STRING_VALUE", * // }, * // }, * // ], @@ -4159,6 +4518,46 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // Content: "STRING_VALUE", * // }, * // ], + * // Images: [ // SheetImageList + * // { // SheetImage + * // SheetImageId: "STRING_VALUE", // required + * // Source: { // SheetImageSource + * // SheetImageStaticFileSource: { // SheetImageStaticFileSource + * // StaticFileId: "STRING_VALUE", // required + * // }, + * // }, + * // Scaling: { // SheetImageScalingConfiguration + * // ScalingType: "SCALE_TO_WIDTH" || "SCALE_TO_HEIGHT" || "SCALE_TO_CONTAINER" || "SCALE_NONE", + * // }, + * // Tooltip: { // SheetImageTooltipConfiguration + * // TooltipText: { // SheetImageTooltipText + * // PlainText: "STRING_VALUE", + * // }, + * // Visibility: "HIDDEN" || "VISIBLE", + * // }, + * // ImageContentAltText: "STRING_VALUE", + * // Interactions: { // ImageInteractionOptions + * // ImageMenuOption: { // ImageMenuOption + * // AvailabilityStatus: "ENABLED" || "DISABLED", + * // }, + * // }, + * // Actions: [ // ImageCustomActionList + * // { // ImageCustomAction + * // CustomActionId: "STRING_VALUE", // required + * // Name: "STRING_VALUE", // required + * // Status: "ENABLED" || "DISABLED", + * // Trigger: "CLICK" || "MENU", // required + * // ActionOperations: [ // ImageCustomActionOperationList // required + * // { // ImageCustomActionOperation + * // NavigationOperation: "", + * // URLOperation: "", + * // SetParametersOperation: "", + * // }, + * // ], + * // }, + * // ], + * // }, + * // ], * // Layouts: [ // LayoutList * // { // Layout * // Configuration: { // LayoutConfiguration @@ -4166,7 +4565,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // Elements: [ // GridLayoutElementList // required * // { // GridLayoutElement * // ElementId: "STRING_VALUE", // required - * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * // ColumnIndex: Number("int"), * // ColumnSpan: Number("int"), // required * // RowIndex: Number("int"), @@ -4184,7 +4583,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // Elements: [ // FreeFromLayoutElementList // required * // { // FreeFormLayoutElement * // ElementId: "STRING_VALUE", // required - * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * // XAxisLocation: "STRING_VALUE", // required * // YAxisLocation: "STRING_VALUE", // required * // Width: "STRING_VALUE", // required @@ -4230,7 +4629,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // Elements: [ // required * // { * // ElementId: "STRING_VALUE", // required - * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * // XAxisLocation: "STRING_VALUE", // required * // YAxisLocation: "STRING_VALUE", // required * // Width: "STRING_VALUE", // required @@ -4370,7 +4769,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // Elements: [ // required * // { * // ElementId: "STRING_VALUE", // required - * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * // ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * // ColumnIndex: Number("int"), * // ColumnSpan: Number("int"), // required * // RowIndex: Number("int"), @@ -5038,6 +5437,36 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // QueryExecutionOptions: { // QueryExecutionOptions * // QueryExecutionMode: "AUTO" || "MANUAL", * // }, + * // StaticFiles: [ // StaticFileList + * // { // StaticFile + * // ImageStaticFile: { // ImageStaticFile + * // StaticFileId: "STRING_VALUE", // required + * // Source: { // StaticFileSource + * // UrlOptions: { // StaticFileUrlSourceOptions + * // Url: "STRING_VALUE", // required + * // }, + * // S3Options: { // StaticFileS3SourceOptions + * // BucketName: "STRING_VALUE", // required + * // ObjectKey: "STRING_VALUE", // required + * // Region: "STRING_VALUE", // required + * // }, + * // }, + * // }, + * // SpatialStaticFile: { // SpatialStaticFile + * // StaticFileId: "STRING_VALUE", // required + * // Source: { + * // UrlOptions: { + * // Url: "STRING_VALUE", // required + * // }, + * // S3Options: { + * // BucketName: "STRING_VALUE", // required + * // ObjectKey: "STRING_VALUE", // required + * // Region: "STRING_VALUE", // required + * // }, + * // }, + * // }, + * // }, + * // ], * // }, * // Status: Number("int"), * // RequestId: "STRING_VALUE", diff --git a/clients/client-quicksight/src/commands/ListNamespacesCommand.ts b/clients/client-quicksight/src/commands/ListNamespacesCommand.ts index 9cba6d443f6d..02f122c46a9e 100644 --- a/clients/client-quicksight/src/commands/ListNamespacesCommand.ts +++ b/clients/client-quicksight/src/commands/ListNamespacesCommand.ts @@ -54,6 +54,8 @@ export interface ListNamespacesCommandOutput extends ListNamespacesResponse, __M * // Type: "PERMISSION_DENIED" || "INTERNAL_SERVICE_ERROR", * // Message: "STRING_VALUE", * // }, + * // IamIdentityCenterApplicationArn: "STRING_VALUE", + * // IamIdentityCenterInstanceArn: "STRING_VALUE", * // }, * // ], * // NextToken: "STRING_VALUE", diff --git a/clients/client-quicksight/src/commands/ListTopicReviewedAnswersCommand.ts b/clients/client-quicksight/src/commands/ListTopicReviewedAnswersCommand.ts index 15a865cadc24..1e424873b4eb 100644 --- a/clients/client-quicksight/src/commands/ListTopicReviewedAnswersCommand.ts +++ b/clients/client-quicksight/src/commands/ListTopicReviewedAnswersCommand.ts @@ -5,11 +5,11 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; +import { ListTopicReviewedAnswersRequest } from "../models/models_4"; import { - ListTopicReviewedAnswersRequest, ListTopicReviewedAnswersResponse, ListTopicReviewedAnswersResponseFilterSensitiveLog, -} from "../models/models_4"; +} from "../models/models_5"; import { de_ListTopicReviewedAnswersCommand, se_ListTopicReviewedAnswersCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/SearchTopicsCommand.ts b/clients/client-quicksight/src/commands/SearchTopicsCommand.ts new file mode 100644 index 000000000000..a60d76b43bfb --- /dev/null +++ b/clients/client-quicksight/src/commands/SearchTopicsCommand.ts @@ -0,0 +1,132 @@ +// 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 { SearchTopicsRequest, SearchTopicsResponse } from "../models/models_4"; +import { de_SearchTopicsCommand, se_SearchTopicsCommand } from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link SearchTopicsCommand}. + */ +export interface SearchTopicsCommandInput extends SearchTopicsRequest {} +/** + * @public + * + * The output of {@link SearchTopicsCommand}. + */ +export interface SearchTopicsCommandOutput extends SearchTopicsResponse, __MetadataBearer {} + +/** + *

Searches for any Q topic that exists in an Amazon QuickSight account.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, SearchTopicsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, SearchTopicsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // SearchTopicsRequest + * AwsAccountId: "STRING_VALUE", // required + * Filters: [ // TopicSearchFilterList // required + * { // TopicSearchFilter + * Operator: "StringEquals" || "StringLike", // required + * Name: "QUICKSIGHT_USER" || "QUICKSIGHT_VIEWER_OR_OWNER" || "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" || "QUICKSIGHT_OWNER" || "DIRECT_QUICKSIGHT_OWNER" || "DIRECT_QUICKSIGHT_SOLE_OWNER" || "TOPIC_NAME", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * NextToken: "STRING_VALUE", + * MaxResults: Number("int"), + * }; + * const command = new SearchTopicsCommand(input); + * const response = await client.send(command); + * // { // SearchTopicsResponse + * // TopicSummaryList: [ // TopicSummaries + * // { // TopicSummary + * // Arn: "STRING_VALUE", + * // TopicId: "STRING_VALUE", + * // Name: "STRING_VALUE", + * // UserExperienceVersion: "LEGACY" || "NEW_READER_EXPERIENCE", + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // Status: Number("int"), + * // RequestId: "STRING_VALUE", + * // }; + * + * ``` + * + * @param SearchTopicsCommandInput - {@link SearchTopicsCommandInput} + * @returns {@link SearchTopicsCommandOutput} + * @see {@link SearchTopicsCommandInput} for command's `input` shape. + * @see {@link SearchTopicsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link InternalFailureException} (server fault) + *

An internal failure occurred.

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

The NextToken value isn't valid.

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

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

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

One or more resources can't be found.

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

Access is throttled.

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

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.

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

Base exception class for all service exceptions from QuickSight service.

+ * + * @public + */ +export class SearchTopicsCommand extends $Command + .classBuilder< + SearchTopicsCommandInput, + SearchTopicsCommandOutput, + 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", "SearchTopics", {}) + .n("QuickSightClient", "SearchTopicsCommand") + .f(void 0, void 0) + .ser(se_SearchTopicsCommand) + .de(de_SearchTopicsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: SearchTopicsRequest; + output: SearchTopicsResponse; + }; + sdk: { + input: SearchTopicsCommandInput; + output: SearchTopicsCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/UpdateAnalysisCommand.ts b/clients/client-quicksight/src/commands/UpdateAnalysisCommand.ts index aed3d910c236..2a51bc68a404 100644 --- a/clients/client-quicksight/src/commands/UpdateAnalysisCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateAnalysisCommand.ts @@ -114,6 +114,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * FontConfiguration: { // FontConfiguration * FontSize: { // FontSize * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -121,6 +122,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -149,6 +151,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -156,6 +159,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -199,6 +203,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -206,6 +211,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -247,6 +253,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -254,6 +261,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -277,6 +285,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -284,6 +293,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -1132,6 +1142,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * ], * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * PivotTableVisual: { // PivotTableVisual * VisualId: "STRING_VALUE", // required @@ -1596,6 +1607,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * ], * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * BarChartVisual: { // BarChartVisual * VisualId: "STRING_VALUE", // required @@ -1944,6 +1956,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { // DataLabelOptions * Visibility: "HIDDEN" || "VISIBLE", @@ -2203,6 +2216,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * KPIVisual: { // KPIVisual * VisualId: "STRING_VALUE", // required @@ -2526,6 +2540,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * PieChartVisual: { // PieChartVisual * VisualId: "STRING_VALUE", // required @@ -2640,6 +2655,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -2818,6 +2834,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * GaugeChartVisual: { // GaugeChartVisual * VisualId: "STRING_VALUE", // required @@ -2938,6 +2955,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * ], * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * LineChartVisual: { // LineChartVisual * VisualId: "STRING_VALUE", // required @@ -3216,6 +3234,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -3352,6 +3371,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * HeatMapVisual: { // HeatMapVisual * VisualId: "STRING_VALUE", // required @@ -3398,6 +3418,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -3482,6 +3503,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * ], * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * TreeMapVisual: { // TreeMapVisual * VisualId: "STRING_VALUE", // required @@ -3527,6 +3549,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: "", * Tooltip: "", @@ -3534,6 +3557,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * GeospatialMapVisual: { // GeospatialMapVisual * VisualId: "STRING_VALUE", // required @@ -3594,6 +3618,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * ColumnHierarchies: "", * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * FilledMapVisual: { // FilledMapVisual * VisualId: "STRING_VALUE", // required @@ -3643,6 +3668,284 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * ColumnHierarchies: "", * Actions: "", + * VisualContentAltText: "STRING_VALUE", + * }, + * LayerMapVisual: { // LayerMapVisual + * VisualId: "STRING_VALUE", // required + * Title: "", + * Subtitle: "", + * ChartConfiguration: { // GeospatialLayerMapConfiguration + * Legend: "", + * MapLayers: [ // GeospatialMapLayerList + * { // GeospatialLayerItem + * LayerId: "STRING_VALUE", // required + * LayerType: "POINT" || "LINE" || "POLYGON", + * DataSource: { // GeospatialDataSourceItem + * StaticFileDataSource: { // GeospatialStaticFileSource + * StaticFileId: "STRING_VALUE", // required + * }, + * }, + * Label: "STRING_VALUE", + * Visibility: "HIDDEN" || "VISIBLE", + * LayerDefinition: { // GeospatialLayerDefinition + * PointLayer: { // GeospatialPointLayer + * Style: { // GeospatialPointStyle + * CircleSymbolStyle: { // GeospatialCircleSymbolStyle + * FillColor: { // GeospatialColor + * Solid: { // GeospatialSolidColor + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { // GeospatialGradientColor + * StepColors: [ // GeospatialGradientStepColorList // required + * { // GeospatialGradientStepColor + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { // GeospatialNullDataSettings + * SymbolStyle: { // GeospatialNullSymbolStyle + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { // GeospatialCategoricalColor + * CategoryDataColors: [ // GeospatialCategoricalDataColorList // required + * { // GeospatialCategoricalDataColor + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeWidth: { // GeospatialLineWidth + * LineWidth: Number("double"), + * }, + * CircleRadius: { // GeospatialCircleRadius + * Radius: Number("double"), + * }, + * }, + * }, + * }, + * LineLayer: { // GeospatialLineLayer + * Style: { // GeospatialLineStyle + * LineSymbolStyle: { // GeospatialLineSymbolStyle + * FillColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * LineWidth: { + * LineWidth: Number("double"), + * }, + * }, + * }, + * }, + * PolygonLayer: { // GeospatialPolygonLayer + * Style: { // GeospatialPolygonStyle + * PolygonSymbolStyle: { // GeospatialPolygonSymbolStyle + * FillColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeWidth: { + * LineWidth: Number("double"), + * }, + * }, + * }, + * }, + * }, + * Tooltip: "", + * JoinDefinition: { // GeospatialLayerJoinDefinition + * ShapeKeyField: "STRING_VALUE", + * DatasetKeyField: { + * FieldId: "STRING_VALUE", // required + * Column: "", // required + * FormatConfiguration: { + * StringFormatConfiguration: "", + * NumberFormatConfiguration: "", + * DateTimeFormatConfiguration: "", + * }, + * }, + * ColorField: { // GeospatialLayerColorField + * ColorDimensionsFields: [ // GeospatialLayerDimensionFieldList + * "", + * ], + * ColorValuesFields: [ // GeospatialLayerMeasureFieldList + * "", + * ], + * }, + * }, + * Actions: [ // LayerCustomActionList + * { // LayerCustomAction + * CustomActionId: "STRING_VALUE", // required + * Name: "STRING_VALUE", // required + * Status: "ENABLED" || "DISABLED", + * Trigger: "DATA_POINT_CLICK" || "DATA_POINT_MENU", // required + * ActionOperations: [ // LayerCustomActionOperationList // required + * { // LayerCustomActionOperation + * FilterOperation: "", + * NavigationOperation: "", + * URLOperation: "", + * SetParametersOperation: "", + * }, + * ], + * }, + * ], + * }, + * ], + * MapState: { // GeospatialMapState + * Bounds: { + * North: Number("double"), // required + * South: Number("double"), // required + * West: Number("double"), // required + * East: Number("double"), // required + * }, + * MapNavigation: "ENABLED" || "DISABLED", + * }, + * MapStyle: { // GeospatialMapStyle + * BaseMapStyle: "LIGHT_GRAY" || "DARK_GRAY" || "STREET" || "IMAGERY", + * BackgroundColor: "STRING_VALUE", + * BaseMapVisibility: "HIDDEN" || "VISIBLE", + * }, + * Interactions: "", + * }, + * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * FunnelChartVisual: { // FunnelChartVisual * VisualId: "STRING_VALUE", // required @@ -3680,6 +3983,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * ScatterPlotVisual: { // ScatterPlotVisual * VisualId: "STRING_VALUE", // required @@ -3717,6 +4021,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * ComboChartVisual: { // ComboChartVisual * VisualId: "STRING_VALUE", // required @@ -3793,6 +4098,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * BoxPlotVisual: { // BoxPlotVisual * VisualId: "STRING_VALUE", // required @@ -3868,6 +4174,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * WaterfallVisual: { // WaterfallVisual * VisualId: "STRING_VALUE", // required @@ -3906,6 +4213,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * HistogramVisual: { // HistogramVisual * VisualId: "STRING_VALUE", // required @@ -3939,6 +4247,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * Interactions: "", * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * WordCloudVisual: { // WordCloudVisual * VisualId: "STRING_VALUE", // required @@ -3972,6 +4281,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * InsightVisual: { // InsightVisual * VisualId: "STRING_VALUE", // required @@ -4064,6 +4374,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * Actions: "", * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * SankeyDiagramVisual: { // SankeyDiagramVisual * VisualId: "STRING_VALUE", // required @@ -4086,6 +4397,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * Interactions: "", * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * CustomContentVisual: { // CustomContentVisual * VisualId: "STRING_VALUE", // required @@ -4099,6 +4411,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * Actions: "", * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * EmptyVisual: { // EmptyVisual * VisualId: "STRING_VALUE", // required @@ -4150,6 +4463,52 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", + * }, + * PluginVisual: { // PluginVisual + * VisualId: "STRING_VALUE", // required + * PluginArn: "STRING_VALUE", // required + * Title: "", + * Subtitle: "", + * ChartConfiguration: { // PluginVisualConfiguration + * FieldWells: [ // PluginVisualFieldWells + * { // PluginVisualFieldWell + * AxisName: "GROUP_BY" || "VALUE", + * Dimensions: "", + * Measures: "", + * Unaggregated: [ + * { + * FieldId: "STRING_VALUE", // required + * Column: "", // required + * FormatConfiguration: { + * StringFormatConfiguration: "", + * NumberFormatConfiguration: "", + * DateTimeFormatConfiguration: "", + * }, + * }, + * ], + * }, + * ], + * VisualOptions: { // PluginVisualOptions + * VisualProperties: [ // PluginVisualPropertiesList + * { // PluginVisualProperty + * Name: "STRING_VALUE", + * Value: "STRING_VALUE", + * }, + * ], + * }, + * SortConfiguration: { // PluginVisualSortConfiguration + * PluginVisualTableQuerySort: { // PluginVisualTableQuerySort + * RowSort: [ + * "", + * ], + * ItemsLimitConfiguration: { // PluginVisualItemsLimitConfiguration + * ItemsLimit: Number("long"), + * }, + * }, + * }, + * }, + * VisualContentAltText: "STRING_VALUE", * }, * }, * ], @@ -4159,6 +4518,46 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * Content: "STRING_VALUE", * }, * ], + * Images: [ // SheetImageList + * { // SheetImage + * SheetImageId: "STRING_VALUE", // required + * Source: { // SheetImageSource + * SheetImageStaticFileSource: { // SheetImageStaticFileSource + * StaticFileId: "STRING_VALUE", // required + * }, + * }, + * Scaling: { // SheetImageScalingConfiguration + * ScalingType: "SCALE_TO_WIDTH" || "SCALE_TO_HEIGHT" || "SCALE_TO_CONTAINER" || "SCALE_NONE", + * }, + * Tooltip: { // SheetImageTooltipConfiguration + * TooltipText: { // SheetImageTooltipText + * PlainText: "STRING_VALUE", + * }, + * Visibility: "HIDDEN" || "VISIBLE", + * }, + * ImageContentAltText: "STRING_VALUE", + * Interactions: { // ImageInteractionOptions + * ImageMenuOption: { // ImageMenuOption + * AvailabilityStatus: "ENABLED" || "DISABLED", + * }, + * }, + * Actions: [ // ImageCustomActionList + * { // ImageCustomAction + * CustomActionId: "STRING_VALUE", // required + * Name: "STRING_VALUE", // required + * Status: "ENABLED" || "DISABLED", + * Trigger: "CLICK" || "MENU", // required + * ActionOperations: [ // ImageCustomActionOperationList // required + * { // ImageCustomActionOperation + * NavigationOperation: "", + * URLOperation: "", + * SetParametersOperation: "", + * }, + * ], + * }, + * ], + * }, + * ], * Layouts: [ // LayoutList * { // Layout * Configuration: { // LayoutConfiguration @@ -4166,7 +4565,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * Elements: [ // GridLayoutElementList // required * { // GridLayoutElement * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * ColumnIndex: Number("int"), * ColumnSpan: Number("int"), // required * RowIndex: Number("int"), @@ -4184,7 +4583,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * Elements: [ // FreeFromLayoutElementList // required * { // FreeFormLayoutElement * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * XAxisLocation: "STRING_VALUE", // required * YAxisLocation: "STRING_VALUE", // required * Width: "STRING_VALUE", // required @@ -4230,7 +4629,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * Elements: [ // required * { * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * XAxisLocation: "STRING_VALUE", // required * YAxisLocation: "STRING_VALUE", // required * Width: "STRING_VALUE", // required @@ -4370,7 +4769,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * Elements: [ // required * { * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * ColumnIndex: Number("int"), * ColumnSpan: Number("int"), // required * RowIndex: Number("int"), @@ -5038,6 +5437,36 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * QueryExecutionOptions: { // QueryExecutionOptions * QueryExecutionMode: "AUTO" || "MANUAL", * }, + * StaticFiles: [ // StaticFileList + * { // StaticFile + * ImageStaticFile: { // ImageStaticFile + * StaticFileId: "STRING_VALUE", // required + * Source: { // StaticFileSource + * UrlOptions: { // StaticFileUrlSourceOptions + * Url: "STRING_VALUE", // required + * }, + * S3Options: { // StaticFileS3SourceOptions + * BucketName: "STRING_VALUE", // required + * ObjectKey: "STRING_VALUE", // required + * Region: "STRING_VALUE", // required + * }, + * }, + * }, + * SpatialStaticFile: { // SpatialStaticFile + * StaticFileId: "STRING_VALUE", // required + * Source: { + * UrlOptions: { + * Url: "STRING_VALUE", // required + * }, + * S3Options: { + * BucketName: "STRING_VALUE", // required + * ObjectKey: "STRING_VALUE", // required + * Region: "STRING_VALUE", // required + * }, + * }, + * }, + * }, + * ], * }, * ValidationStrategy: { // ValidationStrategy * Mode: "STRICT" || "LENIENT", // required diff --git a/clients/client-quicksight/src/commands/UpdateDashboardCommand.ts b/clients/client-quicksight/src/commands/UpdateDashboardCommand.ts index 6f90e87bb361..8e5759c91524 100644 --- a/clients/client-quicksight/src/commands/UpdateDashboardCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateDashboardCommand.ts @@ -159,6 +159,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * FontConfiguration: { // FontConfiguration * FontSize: { // FontSize * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -166,6 +167,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -194,6 +196,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -201,6 +204,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -244,6 +248,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -251,6 +256,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -292,6 +298,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -299,6 +306,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -322,6 +330,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -329,6 +338,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -1177,6 +1187,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * ], * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * PivotTableVisual: { // PivotTableVisual * VisualId: "STRING_VALUE", // required @@ -1641,6 +1652,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * ], * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * BarChartVisual: { // BarChartVisual * VisualId: "STRING_VALUE", // required @@ -1989,6 +2001,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { // DataLabelOptions * Visibility: "HIDDEN" || "VISIBLE", @@ -2248,6 +2261,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * KPIVisual: { // KPIVisual * VisualId: "STRING_VALUE", // required @@ -2571,6 +2585,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * PieChartVisual: { // PieChartVisual * VisualId: "STRING_VALUE", // required @@ -2685,6 +2700,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -2861,6 +2877,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * GaugeChartVisual: { // GaugeChartVisual * VisualId: "STRING_VALUE", // required @@ -2981,6 +2998,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * ], * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * LineChartVisual: { // LineChartVisual * VisualId: "STRING_VALUE", // required @@ -3259,6 +3277,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -3395,6 +3414,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * HeatMapVisual: { // HeatMapVisual * VisualId: "STRING_VALUE", // required @@ -3441,6 +3461,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -3525,6 +3546,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * }, * ], * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * TreeMapVisual: { // TreeMapVisual * VisualId: "STRING_VALUE", // required @@ -3570,6 +3592,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: "", * Tooltip: "", @@ -3577,6 +3600,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * GeospatialMapVisual: { // GeospatialMapVisual * VisualId: "STRING_VALUE", // required @@ -3637,6 +3661,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * }, * ColumnHierarchies: "", * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * FilledMapVisual: { // FilledMapVisual * VisualId: "STRING_VALUE", // required @@ -3686,6 +3711,284 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * }, * ColumnHierarchies: "", * Actions: "", + * VisualContentAltText: "STRING_VALUE", + * }, + * LayerMapVisual: { // LayerMapVisual + * VisualId: "STRING_VALUE", // required + * Title: "", + * Subtitle: "", + * ChartConfiguration: { // GeospatialLayerMapConfiguration + * Legend: "", + * MapLayers: [ // GeospatialMapLayerList + * { // GeospatialLayerItem + * LayerId: "STRING_VALUE", // required + * LayerType: "POINT" || "LINE" || "POLYGON", + * DataSource: { // GeospatialDataSourceItem + * StaticFileDataSource: { // GeospatialStaticFileSource + * StaticFileId: "STRING_VALUE", // required + * }, + * }, + * Label: "STRING_VALUE", + * Visibility: "HIDDEN" || "VISIBLE", + * LayerDefinition: { // GeospatialLayerDefinition + * PointLayer: { // GeospatialPointLayer + * Style: { // GeospatialPointStyle + * CircleSymbolStyle: { // GeospatialCircleSymbolStyle + * FillColor: { // GeospatialColor + * Solid: { // GeospatialSolidColor + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { // GeospatialGradientColor + * StepColors: [ // GeospatialGradientStepColorList // required + * { // GeospatialGradientStepColor + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { // GeospatialNullDataSettings + * SymbolStyle: { // GeospatialNullSymbolStyle + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { // GeospatialCategoricalColor + * CategoryDataColors: [ // GeospatialCategoricalDataColorList // required + * { // GeospatialCategoricalDataColor + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeWidth: { // GeospatialLineWidth + * LineWidth: Number("double"), + * }, + * CircleRadius: { // GeospatialCircleRadius + * Radius: Number("double"), + * }, + * }, + * }, + * }, + * LineLayer: { // GeospatialLineLayer + * Style: { // GeospatialLineStyle + * LineSymbolStyle: { // GeospatialLineSymbolStyle + * FillColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * LineWidth: { + * LineWidth: Number("double"), + * }, + * }, + * }, + * }, + * PolygonLayer: { // GeospatialPolygonLayer + * Style: { // GeospatialPolygonStyle + * PolygonSymbolStyle: { // GeospatialPolygonSymbolStyle + * FillColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeWidth: { + * LineWidth: Number("double"), + * }, + * }, + * }, + * }, + * }, + * Tooltip: "", + * JoinDefinition: { // GeospatialLayerJoinDefinition + * ShapeKeyField: "STRING_VALUE", + * DatasetKeyField: { + * FieldId: "STRING_VALUE", // required + * Column: "", // required + * FormatConfiguration: { + * StringFormatConfiguration: "", + * NumberFormatConfiguration: "", + * DateTimeFormatConfiguration: "", + * }, + * }, + * ColorField: { // GeospatialLayerColorField + * ColorDimensionsFields: [ // GeospatialLayerDimensionFieldList + * "", + * ], + * ColorValuesFields: [ // GeospatialLayerMeasureFieldList + * "", + * ], + * }, + * }, + * Actions: [ // LayerCustomActionList + * { // LayerCustomAction + * CustomActionId: "STRING_VALUE", // required + * Name: "STRING_VALUE", // required + * Status: "ENABLED" || "DISABLED", + * Trigger: "DATA_POINT_CLICK" || "DATA_POINT_MENU", // required + * ActionOperations: [ // LayerCustomActionOperationList // required + * { // LayerCustomActionOperation + * FilterOperation: "", + * NavigationOperation: "", + * URLOperation: "", + * SetParametersOperation: "", + * }, + * ], + * }, + * ], + * }, + * ], + * MapState: { // GeospatialMapState + * Bounds: { + * North: Number("double"), // required + * South: Number("double"), // required + * West: Number("double"), // required + * East: Number("double"), // required + * }, + * MapNavigation: "ENABLED" || "DISABLED", + * }, + * MapStyle: { // GeospatialMapStyle + * BaseMapStyle: "LIGHT_GRAY" || "DARK_GRAY" || "STREET" || "IMAGERY", + * BackgroundColor: "STRING_VALUE", + * BaseMapVisibility: "HIDDEN" || "VISIBLE", + * }, + * Interactions: "", + * }, + * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * FunnelChartVisual: { // FunnelChartVisual * VisualId: "STRING_VALUE", // required @@ -3723,6 +4026,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * ScatterPlotVisual: { // ScatterPlotVisual * VisualId: "STRING_VALUE", // required @@ -3760,6 +4064,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * ComboChartVisual: { // ComboChartVisual * VisualId: "STRING_VALUE", // required @@ -3836,6 +4141,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * BoxPlotVisual: { // BoxPlotVisual * VisualId: "STRING_VALUE", // required @@ -3911,6 +4217,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * WaterfallVisual: { // WaterfallVisual * VisualId: "STRING_VALUE", // required @@ -3949,6 +4256,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * HistogramVisual: { // HistogramVisual * VisualId: "STRING_VALUE", // required @@ -3982,6 +4290,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Interactions: "", * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * WordCloudVisual: { // WordCloudVisual * VisualId: "STRING_VALUE", // required @@ -4015,6 +4324,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * InsightVisual: { // InsightVisual * VisualId: "STRING_VALUE", // required @@ -4107,6 +4417,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * }, * Actions: "", * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * SankeyDiagramVisual: { // SankeyDiagramVisual * VisualId: "STRING_VALUE", // required @@ -4129,6 +4440,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Interactions: "", * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * CustomContentVisual: { // CustomContentVisual * VisualId: "STRING_VALUE", // required @@ -4142,6 +4454,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * }, * Actions: "", * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * EmptyVisual: { // EmptyVisual * VisualId: "STRING_VALUE", // required @@ -4193,6 +4506,52 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", + * }, + * PluginVisual: { // PluginVisual + * VisualId: "STRING_VALUE", // required + * PluginArn: "STRING_VALUE", // required + * Title: "", + * Subtitle: "", + * ChartConfiguration: { // PluginVisualConfiguration + * FieldWells: [ // PluginVisualFieldWells + * { // PluginVisualFieldWell + * AxisName: "GROUP_BY" || "VALUE", + * Dimensions: "", + * Measures: "", + * Unaggregated: [ + * { + * FieldId: "STRING_VALUE", // required + * Column: "", // required + * FormatConfiguration: { + * StringFormatConfiguration: "", + * NumberFormatConfiguration: "", + * DateTimeFormatConfiguration: "", + * }, + * }, + * ], + * }, + * ], + * VisualOptions: { // PluginVisualOptions + * VisualProperties: [ // PluginVisualPropertiesList + * { // PluginVisualProperty + * Name: "STRING_VALUE", + * Value: "STRING_VALUE", + * }, + * ], + * }, + * SortConfiguration: { // PluginVisualSortConfiguration + * PluginVisualTableQuerySort: { // PluginVisualTableQuerySort + * RowSort: [ + * "", + * ], + * ItemsLimitConfiguration: { // PluginVisualItemsLimitConfiguration + * ItemsLimit: Number("long"), + * }, + * }, + * }, + * }, + * VisualContentAltText: "STRING_VALUE", * }, * }, * ], @@ -4202,6 +4561,46 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Content: "STRING_VALUE", * }, * ], + * Images: [ // SheetImageList + * { // SheetImage + * SheetImageId: "STRING_VALUE", // required + * Source: { // SheetImageSource + * SheetImageStaticFileSource: { // SheetImageStaticFileSource + * StaticFileId: "STRING_VALUE", // required + * }, + * }, + * Scaling: { // SheetImageScalingConfiguration + * ScalingType: "SCALE_TO_WIDTH" || "SCALE_TO_HEIGHT" || "SCALE_TO_CONTAINER" || "SCALE_NONE", + * }, + * Tooltip: { // SheetImageTooltipConfiguration + * TooltipText: { // SheetImageTooltipText + * PlainText: "STRING_VALUE", + * }, + * Visibility: "HIDDEN" || "VISIBLE", + * }, + * ImageContentAltText: "STRING_VALUE", + * Interactions: { // ImageInteractionOptions + * ImageMenuOption: { // ImageMenuOption + * AvailabilityStatus: "ENABLED" || "DISABLED", + * }, + * }, + * Actions: [ // ImageCustomActionList + * { // ImageCustomAction + * CustomActionId: "STRING_VALUE", // required + * Name: "STRING_VALUE", // required + * Status: "ENABLED" || "DISABLED", + * Trigger: "CLICK" || "MENU", // required + * ActionOperations: [ // ImageCustomActionOperationList // required + * { // ImageCustomActionOperation + * NavigationOperation: "", + * URLOperation: "", + * SetParametersOperation: "", + * }, + * ], + * }, + * ], + * }, + * ], * Layouts: [ // LayoutList * { // Layout * Configuration: { // LayoutConfiguration @@ -4209,7 +4608,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Elements: [ // GridLayoutElementList // required * { // GridLayoutElement * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * ColumnIndex: Number("int"), * ColumnSpan: Number("int"), // required * RowIndex: Number("int"), @@ -4227,7 +4626,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Elements: [ // FreeFromLayoutElementList // required * { // FreeFormLayoutElement * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * XAxisLocation: "STRING_VALUE", // required * YAxisLocation: "STRING_VALUE", // required * Width: "STRING_VALUE", // required @@ -4273,7 +4672,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Elements: [ // required * { * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * XAxisLocation: "STRING_VALUE", // required * YAxisLocation: "STRING_VALUE", // required * Width: "STRING_VALUE", // required @@ -4413,7 +4812,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Elements: [ // required * { * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * ColumnIndex: Number("int"), * ColumnSpan: Number("int"), // required * RowIndex: Number("int"), @@ -5078,6 +5477,36 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * Timezone: "STRING_VALUE", * WeekStart: "SUNDAY" || "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY", * }, + * StaticFiles: [ // StaticFileList + * { // StaticFile + * ImageStaticFile: { // ImageStaticFile + * StaticFileId: "STRING_VALUE", // required + * Source: { // StaticFileSource + * UrlOptions: { // StaticFileUrlSourceOptions + * Url: "STRING_VALUE", // required + * }, + * S3Options: { // StaticFileS3SourceOptions + * BucketName: "STRING_VALUE", // required + * ObjectKey: "STRING_VALUE", // required + * Region: "STRING_VALUE", // required + * }, + * }, + * }, + * SpatialStaticFile: { // SpatialStaticFile + * StaticFileId: "STRING_VALUE", // required + * Source: { + * UrlOptions: { + * Url: "STRING_VALUE", // required + * }, + * S3Options: { + * BucketName: "STRING_VALUE", // required + * ObjectKey: "STRING_VALUE", // required + * Region: "STRING_VALUE", // required + * }, + * }, + * }, + * }, + * ], * }, * ValidationStrategy: { // ValidationStrategy * Mode: "STRICT" || "LENIENT", // required diff --git a/clients/client-quicksight/src/commands/UpdateDashboardsQAConfigurationCommand.ts b/clients/client-quicksight/src/commands/UpdateDashboardsQAConfigurationCommand.ts new file mode 100644 index 000000000000..692d1d486100 --- /dev/null +++ b/clients/client-quicksight/src/commands/UpdateDashboardsQAConfigurationCommand.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 { UpdateDashboardsQAConfigurationRequest, UpdateDashboardsQAConfigurationResponse } from "../models/models_4"; +import { + de_UpdateDashboardsQAConfigurationCommand, + se_UpdateDashboardsQAConfigurationCommand, +} from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateDashboardsQAConfigurationCommand}. + */ +export interface UpdateDashboardsQAConfigurationCommandInput extends UpdateDashboardsQAConfigurationRequest {} +/** + * @public + * + * The output of {@link UpdateDashboardsQAConfigurationCommand}. + */ +export interface UpdateDashboardsQAConfigurationCommandOutput + extends UpdateDashboardsQAConfigurationResponse, + __MetadataBearer {} + +/** + *

Updates a Dashboard QA configuration.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateDashboardsQAConfigurationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateDashboardsQAConfigurationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // UpdateDashboardsQAConfigurationRequest + * AwsAccountId: "STRING_VALUE", // required + * DashboardsQAStatus: "ENABLED" || "DISABLED", // required + * }; + * const command = new UpdateDashboardsQAConfigurationCommand(input); + * const response = await client.send(command); + * // { // UpdateDashboardsQAConfigurationResponse + * // DashboardsQAStatus: "ENABLED" || "DISABLED", + * // RequestId: "STRING_VALUE", + * // Status: Number("int"), + * // }; + * + * ``` + * + * @param UpdateDashboardsQAConfigurationCommandInput - {@link UpdateDashboardsQAConfigurationCommandInput} + * @returns {@link UpdateDashboardsQAConfigurationCommandOutput} + * @see {@link UpdateDashboardsQAConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateDashboardsQAConfigurationCommandOutput} 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 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 UpdateDashboardsQAConfigurationCommand extends $Command + .classBuilder< + UpdateDashboardsQAConfigurationCommandInput, + UpdateDashboardsQAConfigurationCommandOutput, + 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", "UpdateDashboardsQAConfiguration", {}) + .n("QuickSightClient", "UpdateDashboardsQAConfigurationCommand") + .f(void 0, void 0) + .ser(se_UpdateDashboardsQAConfigurationCommand) + .de(de_UpdateDashboardsQAConfigurationCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateDashboardsQAConfigurationRequest; + output: UpdateDashboardsQAConfigurationResponse; + }; + sdk: { + input: UpdateDashboardsQAConfigurationCommandInput; + output: UpdateDashboardsQAConfigurationCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/UpdateDataSetPermissionsCommand.ts b/clients/client-quicksight/src/commands/UpdateDataSetPermissionsCommand.ts index 318ebeda016d..2b49e9ba7c54 100644 --- a/clients/client-quicksight/src/commands/UpdateDataSetPermissionsCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateDataSetPermissionsCommand.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 { UpdateDataSetPermissionsRequest, UpdateDataSetPermissionsResponse } from "../models/models_4"; +import { UpdateDataSetPermissionsRequest } from "../models/models_4"; +import { UpdateDataSetPermissionsResponse } from "../models/models_5"; import { de_UpdateDataSetPermissionsCommand, se_UpdateDataSetPermissionsCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateDataSourceCommand.ts b/clients/client-quicksight/src/commands/UpdateDataSourceCommand.ts index a4f9d9a7a8a0..91975557ab87 100644 --- a/clients/client-quicksight/src/commands/UpdateDataSourceCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateDataSourceCommand.ts @@ -9,7 +9,7 @@ import { UpdateDataSourceRequest, UpdateDataSourceRequestFilterSensitiveLog, UpdateDataSourceResponse, -} from "../models/models_4"; +} from "../models/models_5"; import { de_UpdateDataSourceCommand, se_UpdateDataSourceCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateDataSourcePermissionsCommand.ts b/clients/client-quicksight/src/commands/UpdateDataSourcePermissionsCommand.ts index b9b3b2c022e9..e37c2794a405 100644 --- a/clients/client-quicksight/src/commands/UpdateDataSourcePermissionsCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateDataSourcePermissionsCommand.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 { UpdateDataSourcePermissionsRequest, UpdateDataSourcePermissionsResponse } from "../models/models_4"; +import { UpdateDataSourcePermissionsRequest, UpdateDataSourcePermissionsResponse } from "../models/models_5"; import { de_UpdateDataSourcePermissionsCommand, se_UpdateDataSourcePermissionsCommand, diff --git a/clients/client-quicksight/src/commands/UpdateFolderCommand.ts b/clients/client-quicksight/src/commands/UpdateFolderCommand.ts index 3fe21e466178..5245f0859c99 100644 --- a/clients/client-quicksight/src/commands/UpdateFolderCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateFolderCommand.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 { UpdateFolderRequest, UpdateFolderResponse } from "../models/models_4"; +import { UpdateFolderRequest, UpdateFolderResponse } from "../models/models_5"; import { de_UpdateFolderCommand, se_UpdateFolderCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateFolderPermissionsCommand.ts b/clients/client-quicksight/src/commands/UpdateFolderPermissionsCommand.ts index 5f47e32bf1e1..1167abad33cb 100644 --- a/clients/client-quicksight/src/commands/UpdateFolderPermissionsCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateFolderPermissionsCommand.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 { UpdateFolderPermissionsRequest, UpdateFolderPermissionsResponse } from "../models/models_4"; +import { UpdateFolderPermissionsRequest, UpdateFolderPermissionsResponse } from "../models/models_5"; import { de_UpdateFolderPermissionsCommand, se_UpdateFolderPermissionsCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateGroupCommand.ts b/clients/client-quicksight/src/commands/UpdateGroupCommand.ts index 060d293bed63..fd2bd7c703ac 100644 --- a/clients/client-quicksight/src/commands/UpdateGroupCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateGroupCommand.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 { UpdateGroupRequest, UpdateGroupResponse } from "../models/models_4"; +import { UpdateGroupRequest, UpdateGroupResponse } from "../models/models_5"; import { de_UpdateGroupCommand, se_UpdateGroupCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateIAMPolicyAssignmentCommand.ts b/clients/client-quicksight/src/commands/UpdateIAMPolicyAssignmentCommand.ts index 47eb24ce21a4..b9257a65e198 100644 --- a/clients/client-quicksight/src/commands/UpdateIAMPolicyAssignmentCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateIAMPolicyAssignmentCommand.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 { UpdateIAMPolicyAssignmentRequest, UpdateIAMPolicyAssignmentResponse } from "../models/models_4"; +import { UpdateIAMPolicyAssignmentRequest, UpdateIAMPolicyAssignmentResponse } from "../models/models_5"; import { de_UpdateIAMPolicyAssignmentCommand, se_UpdateIAMPolicyAssignmentCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateIdentityPropagationConfigCommand.ts b/clients/client-quicksight/src/commands/UpdateIdentityPropagationConfigCommand.ts index b486f02557b5..237ed50d932b 100644 --- a/clients/client-quicksight/src/commands/UpdateIdentityPropagationConfigCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateIdentityPropagationConfigCommand.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 { UpdateIdentityPropagationConfigRequest, UpdateIdentityPropagationConfigResponse } from "../models/models_4"; +import { UpdateIdentityPropagationConfigRequest, UpdateIdentityPropagationConfigResponse } from "../models/models_5"; import { de_UpdateIdentityPropagationConfigCommand, se_UpdateIdentityPropagationConfigCommand, diff --git a/clients/client-quicksight/src/commands/UpdateIpRestrictionCommand.ts b/clients/client-quicksight/src/commands/UpdateIpRestrictionCommand.ts index 67049b067c4e..7bf4f4976c11 100644 --- a/clients/client-quicksight/src/commands/UpdateIpRestrictionCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateIpRestrictionCommand.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 { UpdateIpRestrictionRequest, UpdateIpRestrictionResponse } from "../models/models_4"; +import { UpdateIpRestrictionRequest, UpdateIpRestrictionResponse } from "../models/models_5"; import { de_UpdateIpRestrictionCommand, se_UpdateIpRestrictionCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateKeyRegistrationCommand.ts b/clients/client-quicksight/src/commands/UpdateKeyRegistrationCommand.ts index 1f170b0deec3..4ef20583f109 100644 --- a/clients/client-quicksight/src/commands/UpdateKeyRegistrationCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateKeyRegistrationCommand.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 { UpdateKeyRegistrationRequest, UpdateKeyRegistrationResponse } from "../models/models_4"; +import { UpdateKeyRegistrationRequest, UpdateKeyRegistrationResponse } from "../models/models_5"; import { de_UpdateKeyRegistrationCommand, se_UpdateKeyRegistrationCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdatePublicSharingSettingsCommand.ts b/clients/client-quicksight/src/commands/UpdatePublicSharingSettingsCommand.ts index 639af75f5dfe..14b6b539e8f4 100644 --- a/clients/client-quicksight/src/commands/UpdatePublicSharingSettingsCommand.ts +++ b/clients/client-quicksight/src/commands/UpdatePublicSharingSettingsCommand.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 { UpdatePublicSharingSettingsRequest, UpdatePublicSharingSettingsResponse } from "../models/models_4"; +import { UpdatePublicSharingSettingsRequest, UpdatePublicSharingSettingsResponse } from "../models/models_5"; import { de_UpdatePublicSharingSettingsCommand, se_UpdatePublicSharingSettingsCommand, diff --git a/clients/client-quicksight/src/commands/UpdateQPersonalizationConfigurationCommand.ts b/clients/client-quicksight/src/commands/UpdateQPersonalizationConfigurationCommand.ts index e92f128e80c9..f46b8916403a 100644 --- a/clients/client-quicksight/src/commands/UpdateQPersonalizationConfigurationCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateQPersonalizationConfigurationCommand.ts @@ -8,7 +8,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { UpdateQPersonalizationConfigurationRequest, UpdateQPersonalizationConfigurationResponse, -} from "../models/models_4"; +} from "../models/models_5"; import { de_UpdateQPersonalizationConfigurationCommand, se_UpdateQPersonalizationConfigurationCommand, diff --git a/clients/client-quicksight/src/commands/UpdateRefreshScheduleCommand.ts b/clients/client-quicksight/src/commands/UpdateRefreshScheduleCommand.ts index 14b5a1215c8e..62496eff6e19 100644 --- a/clients/client-quicksight/src/commands/UpdateRefreshScheduleCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateRefreshScheduleCommand.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 { UpdateRefreshScheduleRequest, UpdateRefreshScheduleResponse } from "../models/models_4"; +import { UpdateRefreshScheduleRequest, UpdateRefreshScheduleResponse } from "../models/models_5"; import { de_UpdateRefreshScheduleCommand, se_UpdateRefreshScheduleCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateRoleCustomPermissionCommand.ts b/clients/client-quicksight/src/commands/UpdateRoleCustomPermissionCommand.ts index 577789ad3134..1dfcfc51a0e7 100644 --- a/clients/client-quicksight/src/commands/UpdateRoleCustomPermissionCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateRoleCustomPermissionCommand.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 { UpdateRoleCustomPermissionRequest, UpdateRoleCustomPermissionResponse } from "../models/models_4"; +import { UpdateRoleCustomPermissionRequest, UpdateRoleCustomPermissionResponse } from "../models/models_5"; import { de_UpdateRoleCustomPermissionCommand, se_UpdateRoleCustomPermissionCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateSPICECapacityConfigurationCommand.ts b/clients/client-quicksight/src/commands/UpdateSPICECapacityConfigurationCommand.ts index b4a57596e6fd..1c796a7c1aee 100644 --- a/clients/client-quicksight/src/commands/UpdateSPICECapacityConfigurationCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateSPICECapacityConfigurationCommand.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 { UpdateSPICECapacityConfigurationRequest, UpdateSPICECapacityConfigurationResponse } from "../models/models_4"; +import { UpdateSPICECapacityConfigurationRequest, UpdateSPICECapacityConfigurationResponse } from "../models/models_5"; import { de_UpdateSPICECapacityConfigurationCommand, se_UpdateSPICECapacityConfigurationCommand, diff --git a/clients/client-quicksight/src/commands/UpdateTemplateAliasCommand.ts b/clients/client-quicksight/src/commands/UpdateTemplateAliasCommand.ts index f76c76b7f502..21d5766fb51d 100644 --- a/clients/client-quicksight/src/commands/UpdateTemplateAliasCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateTemplateAliasCommand.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 { UpdateTemplateAliasRequest, UpdateTemplateAliasResponse } from "../models/models_4"; +import { UpdateTemplateAliasRequest, UpdateTemplateAliasResponse } from "../models/models_5"; import { de_UpdateTemplateAliasCommand, se_UpdateTemplateAliasCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateTemplateCommand.ts b/clients/client-quicksight/src/commands/UpdateTemplateCommand.ts index 6570769574fa..c100a4355eab 100644 --- a/clients/client-quicksight/src/commands/UpdateTemplateCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateTemplateCommand.ts @@ -9,7 +9,7 @@ import { UpdateTemplateRequest, UpdateTemplateRequestFilterSensitiveLog, UpdateTemplateResponse, -} from "../models/models_4"; +} from "../models/models_5"; import { de_UpdateTemplateCommand, se_UpdateTemplateCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; @@ -101,6 +101,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * FontConfiguration: { // FontConfiguration * FontSize: { // FontSize * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -108,6 +109,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -136,6 +138,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -143,6 +146,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -186,6 +190,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -193,6 +198,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -234,6 +240,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -241,6 +248,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -264,6 +272,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", + * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", @@ -271,6 +280,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", + * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, @@ -1119,6 +1129,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * ], * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * PivotTableVisual: { // PivotTableVisual * VisualId: "STRING_VALUE", // required @@ -1583,6 +1594,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * ], * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * BarChartVisual: { // BarChartVisual * VisualId: "STRING_VALUE", // required @@ -1931,6 +1943,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { // DataLabelOptions * Visibility: "HIDDEN" || "VISIBLE", @@ -2190,6 +2203,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * KPIVisual: { // KPIVisual * VisualId: "STRING_VALUE", // required @@ -2513,6 +2527,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * PieChartVisual: { // PieChartVisual * VisualId: "STRING_VALUE", // required @@ -2627,6 +2642,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -2805,6 +2821,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * GaugeChartVisual: { // GaugeChartVisual * VisualId: "STRING_VALUE", // required @@ -2925,6 +2942,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * ], * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * LineChartVisual: { // LineChartVisual * VisualId: "STRING_VALUE", // required @@ -3203,6 +3221,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -3339,6 +3358,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * }, * }, * ], + * VisualContentAltText: "STRING_VALUE", * }, * HeatMapVisual: { // HeatMapVisual * VisualId: "STRING_VALUE", // required @@ -3385,6 +3405,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", @@ -3469,6 +3490,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * }, * ], * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * TreeMapVisual: { // TreeMapVisual * VisualId: "STRING_VALUE", // required @@ -3514,6 +3536,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", + * ValueFontConfiguration: "", * }, * DataLabels: "", * Tooltip: "", @@ -3521,6 +3544,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * GeospatialMapVisual: { // GeospatialMapVisual * VisualId: "STRING_VALUE", // required @@ -3581,6 +3605,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * }, * ColumnHierarchies: "", * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * FilledMapVisual: { // FilledMapVisual * VisualId: "STRING_VALUE", // required @@ -3630,6 +3655,284 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * }, * ColumnHierarchies: "", * Actions: "", + * VisualContentAltText: "STRING_VALUE", + * }, + * LayerMapVisual: { // LayerMapVisual + * VisualId: "STRING_VALUE", // required + * Title: "", + * Subtitle: "", + * ChartConfiguration: { // GeospatialLayerMapConfiguration + * Legend: "", + * MapLayers: [ // GeospatialMapLayerList + * { // GeospatialLayerItem + * LayerId: "STRING_VALUE", // required + * LayerType: "POINT" || "LINE" || "POLYGON", + * DataSource: { // GeospatialDataSourceItem + * StaticFileDataSource: { // GeospatialStaticFileSource + * StaticFileId: "STRING_VALUE", // required + * }, + * }, + * Label: "STRING_VALUE", + * Visibility: "HIDDEN" || "VISIBLE", + * LayerDefinition: { // GeospatialLayerDefinition + * PointLayer: { // GeospatialPointLayer + * Style: { // GeospatialPointStyle + * CircleSymbolStyle: { // GeospatialCircleSymbolStyle + * FillColor: { // GeospatialColor + * Solid: { // GeospatialSolidColor + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { // GeospatialGradientColor + * StepColors: [ // GeospatialGradientStepColorList // required + * { // GeospatialGradientStepColor + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { // GeospatialNullDataSettings + * SymbolStyle: { // GeospatialNullSymbolStyle + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { // GeospatialCategoricalColor + * CategoryDataColors: [ // GeospatialCategoricalDataColorList // required + * { // GeospatialCategoricalDataColor + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeWidth: { // GeospatialLineWidth + * LineWidth: Number("double"), + * }, + * CircleRadius: { // GeospatialCircleRadius + * Radius: Number("double"), + * }, + * }, + * }, + * }, + * LineLayer: { // GeospatialLineLayer + * Style: { // GeospatialLineStyle + * LineSymbolStyle: { // GeospatialLineSymbolStyle + * FillColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: { + * SymbolStyle: { + * FillColor: "STRING_VALUE", + * StrokeColor: "STRING_VALUE", + * StrokeWidth: Number("double"), + * }, + * }, + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * LineWidth: { + * LineWidth: Number("double"), + * }, + * }, + * }, + * }, + * PolygonLayer: { // GeospatialPolygonLayer + * Style: { // GeospatialPolygonStyle + * PolygonSymbolStyle: { // GeospatialPolygonSymbolStyle + * FillColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeColor: { + * Solid: { + * Color: "STRING_VALUE", // required + * State: "ENABLED" || "DISABLED", + * }, + * Gradient: { + * StepColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: Number("double"), // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * Categorical: { + * CategoryDataColors: [ // required + * { + * Color: "STRING_VALUE", // required + * DataValue: "STRING_VALUE", // required + * }, + * ], + * NullDataVisibility: "HIDDEN" || "VISIBLE", + * NullDataSettings: "", + * DefaultOpacity: Number("double"), + * }, + * }, + * StrokeWidth: { + * LineWidth: Number("double"), + * }, + * }, + * }, + * }, + * }, + * Tooltip: "", + * JoinDefinition: { // GeospatialLayerJoinDefinition + * ShapeKeyField: "STRING_VALUE", + * DatasetKeyField: { + * FieldId: "STRING_VALUE", // required + * Column: "", // required + * FormatConfiguration: { + * StringFormatConfiguration: "", + * NumberFormatConfiguration: "", + * DateTimeFormatConfiguration: "", + * }, + * }, + * ColorField: { // GeospatialLayerColorField + * ColorDimensionsFields: [ // GeospatialLayerDimensionFieldList + * "", + * ], + * ColorValuesFields: [ // GeospatialLayerMeasureFieldList + * "", + * ], + * }, + * }, + * Actions: [ // LayerCustomActionList + * { // LayerCustomAction + * CustomActionId: "STRING_VALUE", // required + * Name: "STRING_VALUE", // required + * Status: "ENABLED" || "DISABLED", + * Trigger: "DATA_POINT_CLICK" || "DATA_POINT_MENU", // required + * ActionOperations: [ // LayerCustomActionOperationList // required + * { // LayerCustomActionOperation + * FilterOperation: "", + * NavigationOperation: "", + * URLOperation: "", + * SetParametersOperation: "", + * }, + * ], + * }, + * ], + * }, + * ], + * MapState: { // GeospatialMapState + * Bounds: { + * North: Number("double"), // required + * South: Number("double"), // required + * West: Number("double"), // required + * East: Number("double"), // required + * }, + * MapNavigation: "ENABLED" || "DISABLED", + * }, + * MapStyle: { // GeospatialMapStyle + * BaseMapStyle: "LIGHT_GRAY" || "DARK_GRAY" || "STREET" || "IMAGERY", + * BackgroundColor: "STRING_VALUE", + * BaseMapVisibility: "HIDDEN" || "VISIBLE", + * }, + * Interactions: "", + * }, + * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * FunnelChartVisual: { // FunnelChartVisual * VisualId: "STRING_VALUE", // required @@ -3667,6 +3970,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * ScatterPlotVisual: { // ScatterPlotVisual * VisualId: "STRING_VALUE", // required @@ -3704,6 +4008,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * ComboChartVisual: { // ComboChartVisual * VisualId: "STRING_VALUE", // required @@ -3780,6 +4085,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * BoxPlotVisual: { // BoxPlotVisual * VisualId: "STRING_VALUE", // required @@ -3855,6 +4161,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * WaterfallVisual: { // WaterfallVisual * VisualId: "STRING_VALUE", // required @@ -3893,6 +4200,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * HistogramVisual: { // HistogramVisual * VisualId: "STRING_VALUE", // required @@ -3926,6 +4234,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * Interactions: "", * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * WordCloudVisual: { // WordCloudVisual * VisualId: "STRING_VALUE", // required @@ -3959,6 +4268,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", * }, * InsightVisual: { // InsightVisual * VisualId: "STRING_VALUE", // required @@ -4051,6 +4361,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * }, * Actions: "", * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * SankeyDiagramVisual: { // SankeyDiagramVisual * VisualId: "STRING_VALUE", // required @@ -4073,6 +4384,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * Interactions: "", * }, * Actions: "", + * VisualContentAltText: "STRING_VALUE", * }, * CustomContentVisual: { // CustomContentVisual * VisualId: "STRING_VALUE", // required @@ -4086,6 +4398,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * }, * Actions: "", * DataSetIdentifier: "STRING_VALUE", // required + * VisualContentAltText: "STRING_VALUE", * }, * EmptyVisual: { // EmptyVisual * VisualId: "STRING_VALUE", // required @@ -4137,6 +4450,52 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * }, * Actions: "", * ColumnHierarchies: "", + * VisualContentAltText: "STRING_VALUE", + * }, + * PluginVisual: { // PluginVisual + * VisualId: "STRING_VALUE", // required + * PluginArn: "STRING_VALUE", // required + * Title: "", + * Subtitle: "", + * ChartConfiguration: { // PluginVisualConfiguration + * FieldWells: [ // PluginVisualFieldWells + * { // PluginVisualFieldWell + * AxisName: "GROUP_BY" || "VALUE", + * Dimensions: "", + * Measures: "", + * Unaggregated: [ + * { + * FieldId: "STRING_VALUE", // required + * Column: "", // required + * FormatConfiguration: { + * StringFormatConfiguration: "", + * NumberFormatConfiguration: "", + * DateTimeFormatConfiguration: "", + * }, + * }, + * ], + * }, + * ], + * VisualOptions: { // PluginVisualOptions + * VisualProperties: [ // PluginVisualPropertiesList + * { // PluginVisualProperty + * Name: "STRING_VALUE", + * Value: "STRING_VALUE", + * }, + * ], + * }, + * SortConfiguration: { // PluginVisualSortConfiguration + * PluginVisualTableQuerySort: { // PluginVisualTableQuerySort + * RowSort: [ + * "", + * ], + * ItemsLimitConfiguration: { // PluginVisualItemsLimitConfiguration + * ItemsLimit: Number("long"), + * }, + * }, + * }, + * }, + * VisualContentAltText: "STRING_VALUE", * }, * }, * ], @@ -4146,6 +4505,46 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * Content: "STRING_VALUE", * }, * ], + * Images: [ // SheetImageList + * { // SheetImage + * SheetImageId: "STRING_VALUE", // required + * Source: { // SheetImageSource + * SheetImageStaticFileSource: { // SheetImageStaticFileSource + * StaticFileId: "STRING_VALUE", // required + * }, + * }, + * Scaling: { // SheetImageScalingConfiguration + * ScalingType: "SCALE_TO_WIDTH" || "SCALE_TO_HEIGHT" || "SCALE_TO_CONTAINER" || "SCALE_NONE", + * }, + * Tooltip: { // SheetImageTooltipConfiguration + * TooltipText: { // SheetImageTooltipText + * PlainText: "STRING_VALUE", + * }, + * Visibility: "HIDDEN" || "VISIBLE", + * }, + * ImageContentAltText: "STRING_VALUE", + * Interactions: { // ImageInteractionOptions + * ImageMenuOption: { // ImageMenuOption + * AvailabilityStatus: "ENABLED" || "DISABLED", + * }, + * }, + * Actions: [ // ImageCustomActionList + * { // ImageCustomAction + * CustomActionId: "STRING_VALUE", // required + * Name: "STRING_VALUE", // required + * Status: "ENABLED" || "DISABLED", + * Trigger: "CLICK" || "MENU", // required + * ActionOperations: [ // ImageCustomActionOperationList // required + * { // ImageCustomActionOperation + * NavigationOperation: "", + * URLOperation: "", + * SetParametersOperation: "", + * }, + * ], + * }, + * ], + * }, + * ], * Layouts: [ // LayoutList * { // Layout * Configuration: { // LayoutConfiguration @@ -4153,7 +4552,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * Elements: [ // GridLayoutElementList // required * { // GridLayoutElement * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * ColumnIndex: Number("int"), * ColumnSpan: Number("int"), // required * RowIndex: Number("int"), @@ -4171,7 +4570,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * Elements: [ // FreeFromLayoutElementList // required * { // FreeFormLayoutElement * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * XAxisLocation: "STRING_VALUE", // required * YAxisLocation: "STRING_VALUE", // required * Width: "STRING_VALUE", // required @@ -4217,7 +4616,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * Elements: [ // required * { * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * XAxisLocation: "STRING_VALUE", // required * YAxisLocation: "STRING_VALUE", // required * Width: "STRING_VALUE", // required @@ -4357,7 +4756,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * Elements: [ // required * { * ElementId: "STRING_VALUE", // required - * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX", // required + * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * ColumnIndex: Number("int"), * ColumnSpan: Number("int"), // required * RowIndex: Number("int"), @@ -5025,6 +5424,36 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * QueryExecutionOptions: { // QueryExecutionOptions * QueryExecutionMode: "AUTO" || "MANUAL", * }, + * StaticFiles: [ // StaticFileList + * { // StaticFile + * ImageStaticFile: { // ImageStaticFile + * StaticFileId: "STRING_VALUE", // required + * Source: { // StaticFileSource + * UrlOptions: { // StaticFileUrlSourceOptions + * Url: "STRING_VALUE", // required + * }, + * S3Options: { // StaticFileS3SourceOptions + * BucketName: "STRING_VALUE", // required + * ObjectKey: "STRING_VALUE", // required + * Region: "STRING_VALUE", // required + * }, + * }, + * }, + * SpatialStaticFile: { // SpatialStaticFile + * StaticFileId: "STRING_VALUE", // required + * Source: { + * UrlOptions: { + * Url: "STRING_VALUE", // required + * }, + * S3Options: { + * BucketName: "STRING_VALUE", // required + * ObjectKey: "STRING_VALUE", // required + * Region: "STRING_VALUE", // required + * }, + * }, + * }, + * }, + * ], * }, * ValidationStrategy: { // ValidationStrategy * Mode: "STRICT" || "LENIENT", // required diff --git a/clients/client-quicksight/src/commands/UpdateTemplatePermissionsCommand.ts b/clients/client-quicksight/src/commands/UpdateTemplatePermissionsCommand.ts index 14d598e20d48..dd31af3a7500 100644 --- a/clients/client-quicksight/src/commands/UpdateTemplatePermissionsCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateTemplatePermissionsCommand.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 { UpdateTemplatePermissionsRequest, UpdateTemplatePermissionsResponse } from "../models/models_4"; +import { UpdateTemplatePermissionsRequest, UpdateTemplatePermissionsResponse } from "../models/models_5"; import { de_UpdateTemplatePermissionsCommand, se_UpdateTemplatePermissionsCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateThemeAliasCommand.ts b/clients/client-quicksight/src/commands/UpdateThemeAliasCommand.ts index 26592e1732b4..83e556a6d4d3 100644 --- a/clients/client-quicksight/src/commands/UpdateThemeAliasCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateThemeAliasCommand.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 { UpdateThemeAliasRequest, UpdateThemeAliasResponse } from "../models/models_4"; +import { UpdateThemeAliasRequest, UpdateThemeAliasResponse } from "../models/models_5"; import { de_UpdateThemeAliasCommand, se_UpdateThemeAliasCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateThemeCommand.ts b/clients/client-quicksight/src/commands/UpdateThemeCommand.ts index 6959b1d82b33..8a021f1e5244 100644 --- a/clients/client-quicksight/src/commands/UpdateThemeCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateThemeCommand.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 { UpdateThemeRequest, UpdateThemeResponse } from "../models/models_4"; +import { UpdateThemeRequest, UpdateThemeResponse } from "../models/models_5"; import { de_UpdateThemeCommand, se_UpdateThemeCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateThemePermissionsCommand.ts b/clients/client-quicksight/src/commands/UpdateThemePermissionsCommand.ts index 52969bd0d82b..6be9eba002cd 100644 --- a/clients/client-quicksight/src/commands/UpdateThemePermissionsCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateThemePermissionsCommand.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 { UpdateThemePermissionsRequest, UpdateThemePermissionsResponse } from "../models/models_4"; +import { UpdateThemePermissionsRequest, UpdateThemePermissionsResponse } from "../models/models_5"; import { de_UpdateThemePermissionsCommand, se_UpdateThemePermissionsCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateTopicCommand.ts b/clients/client-quicksight/src/commands/UpdateTopicCommand.ts index e4b845baf75f..dd9d2cd825e2 100644 --- a/clients/client-quicksight/src/commands/UpdateTopicCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateTopicCommand.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 { UpdateTopicRequest, UpdateTopicRequestFilterSensitiveLog, UpdateTopicResponse } from "../models/models_4"; +import { UpdateTopicRequest, UpdateTopicRequestFilterSensitiveLog, UpdateTopicResponse } from "../models/models_5"; import { de_UpdateTopicCommand, se_UpdateTopicCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateTopicPermissionsCommand.ts b/clients/client-quicksight/src/commands/UpdateTopicPermissionsCommand.ts index ab032c004463..1f44a95ed0ba 100644 --- a/clients/client-quicksight/src/commands/UpdateTopicPermissionsCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateTopicPermissionsCommand.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 { UpdateTopicPermissionsRequest, UpdateTopicPermissionsResponse } from "../models/models_4"; +import { UpdateTopicPermissionsRequest, UpdateTopicPermissionsResponse } from "../models/models_5"; import { de_UpdateTopicPermissionsCommand, se_UpdateTopicPermissionsCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateTopicRefreshScheduleCommand.ts b/clients/client-quicksight/src/commands/UpdateTopicRefreshScheduleCommand.ts index 40b7edada3d3..9915097ba857 100644 --- a/clients/client-quicksight/src/commands/UpdateTopicRefreshScheduleCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateTopicRefreshScheduleCommand.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 { UpdateTopicRefreshScheduleRequest, UpdateTopicRefreshScheduleResponse } from "../models/models_4"; +import { UpdateTopicRefreshScheduleRequest, UpdateTopicRefreshScheduleResponse } from "../models/models_5"; import { de_UpdateTopicRefreshScheduleCommand, se_UpdateTopicRefreshScheduleCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateUserCommand.ts b/clients/client-quicksight/src/commands/UpdateUserCommand.ts index 938fd9623c5f..a217371be07a 100644 --- a/clients/client-quicksight/src/commands/UpdateUserCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateUserCommand.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 { UpdateUserRequest, UpdateUserResponse } from "../models/models_4"; +import { UpdateUserRequest, UpdateUserResponse } from "../models/models_5"; import { de_UpdateUserCommand, se_UpdateUserCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateUserCustomPermissionCommand.ts b/clients/client-quicksight/src/commands/UpdateUserCustomPermissionCommand.ts index 4daa4a473dea..1ee502c2bdab 100644 --- a/clients/client-quicksight/src/commands/UpdateUserCustomPermissionCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateUserCustomPermissionCommand.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 { UpdateUserCustomPermissionRequest, UpdateUserCustomPermissionResponse } from "../models/models_4"; +import { UpdateUserCustomPermissionRequest, UpdateUserCustomPermissionResponse } from "../models/models_5"; import { de_UpdateUserCustomPermissionCommand, se_UpdateUserCustomPermissionCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateVPCConnectionCommand.ts b/clients/client-quicksight/src/commands/UpdateVPCConnectionCommand.ts index ba890ddaa787..bc82d25c4c8a 100644 --- a/clients/client-quicksight/src/commands/UpdateVPCConnectionCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateVPCConnectionCommand.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 { UpdateVPCConnectionRequest, UpdateVPCConnectionResponse } from "../models/models_4"; +import { UpdateVPCConnectionRequest, UpdateVPCConnectionResponse } from "../models/models_5"; import { de_UpdateVPCConnectionCommand, se_UpdateVPCConnectionCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/index.ts b/clients/client-quicksight/src/commands/index.ts index 658430b64097..6eb0b18a4328 100644 --- a/clients/client-quicksight/src/commands/index.ts +++ b/clients/client-quicksight/src/commands/index.ts @@ -73,6 +73,7 @@ export * from "./DescribeDashboardDefinitionCommand"; export * from "./DescribeDashboardPermissionsCommand"; export * from "./DescribeDashboardSnapshotJobCommand"; export * from "./DescribeDashboardSnapshotJobResultCommand"; +export * from "./DescribeDashboardsQAConfigurationCommand"; export * from "./DescribeDataSetCommand"; export * from "./DescribeDataSetPermissionsCommand"; export * from "./DescribeDataSetRefreshPropertiesCommand"; @@ -151,6 +152,7 @@ export * from "./SearchDataSetsCommand"; export * from "./SearchDataSourcesCommand"; export * from "./SearchFoldersCommand"; export * from "./SearchGroupsCommand"; +export * from "./SearchTopicsCommand"; export * from "./StartAssetBundleExportJobCommand"; export * from "./StartAssetBundleImportJobCommand"; export * from "./StartDashboardSnapshotJobCommand"; @@ -169,6 +171,7 @@ export * from "./UpdateDashboardCommand"; export * from "./UpdateDashboardLinksCommand"; export * from "./UpdateDashboardPermissionsCommand"; export * from "./UpdateDashboardPublishedVersionCommand"; +export * from "./UpdateDashboardsQAConfigurationCommand"; export * from "./UpdateDataSetCommand"; export * from "./UpdateDataSetPermissionsCommand"; export * from "./UpdateDataSourceCommand"; diff --git a/clients/client-quicksight/src/models/index.ts b/clients/client-quicksight/src/models/index.ts index 7e44681d8eb4..bf524166707c 100644 --- a/clients/client-quicksight/src/models/index.ts +++ b/clients/client-quicksight/src/models/index.ts @@ -4,3 +4,4 @@ export * from "./models_1"; export * from "./models_2"; export * from "./models_3"; export * from "./models_4"; +export * from "./models_5"; diff --git a/clients/client-quicksight/src/models/models_0.ts b/clients/client-quicksight/src/models/models_0.ts index 9f93edb4214b..cf01e183dad9 100644 --- a/clients/client-quicksight/src/models/models_0.ts +++ b/clients/client-quicksight/src/models/models_0.ts @@ -723,6 +723,499 @@ export interface AnalysisError { ViolatedEntities?: Entity[] | undefined; } +/** + *

The navigation configuration for CustomActionNavigationOperation.

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

The sheet that is targeted for navigation in the same analysis.

+ * @public + */ + TargetSheetId: string | undefined; +} + +/** + *

The navigation operation that navigates between different sheets in the same analysis.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The configuration that chooses the navigation target.

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

The customized parameter values.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

A list of string-type parameter values.

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

A list of integer-type parameter values.

+ * @public + */ + IntegerValues?: number[] | undefined; + + /** + *

A list of decimal-type parameter values.

+ * @public + */ + DecimalValues?: number[] | undefined; + + /** + *

A list of datetime-type parameter values.

+ * @public + */ + DateTimeValues?: Date[] | undefined; +} + +/** + *

The configuration of custom values for the destination parameter in DestinationParameterValueConfiguration.

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

Includes the null value in custom action parameter values.

+ * @public + */ + IncludeNullValue?: boolean | undefined; + + /** + *

The customized parameter values.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

+ * @public + */ + CustomValues: CustomParameterValues | undefined; +} + +/** + * @public + * @enum + */ +export const SelectAllValueOptions = { + ALL_VALUES: "ALL_VALUES", +} as const; + +/** + * @public + */ +export type SelectAllValueOptions = (typeof SelectAllValueOptions)[keyof typeof SelectAllValueOptions]; + +/** + *

The configuration of destination parameter values.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration.

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

The configuration that selects all options.

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

The source parameter name of the destination parameter.

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

The source field ID of the destination parameter.

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

A column of a data set.

+ * @public + */ + SourceColumn?: ColumnIdentifier | undefined; +} + +/** + *

The configuration of adding parameters in action.

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

The destination parameter name of the SetParameterValueConfiguration.

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

The configuration of destination parameter values.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

+ * @public + */ + Value: DestinationParameterValueConfiguration | undefined; +} + +/** + *

The set parameter operation that sets parameters in custom action.

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

The parameter that determines the value configuration.

+ * @public + */ + ParameterValueConfigurations: SetParameterValueConfiguration[] | undefined; +} + +/** + * @public + * @enum + */ +export const URLTargetConfiguration = { + NEW_TAB: "NEW_TAB", + NEW_WINDOW: "NEW_WINDOW", + SAME_TAB: "SAME_TAB", +} as const; + +/** + * @public + */ +export type URLTargetConfiguration = (typeof URLTargetConfiguration)[keyof typeof URLTargetConfiguration]; + +/** + *

The URL operation that opens a link to another webpage.

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

THe URL link of the CustomActionURLOperation.

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

The target of the CustomActionURLOperation.

+ *

Valid values are defined as follows:

+ *
    + *
  • + *

    + * NEW_TAB: Opens the target URL in a new browser tab.

    + *
  • + *
  • + *

    + * NEW_WINDOW: Opens the target URL in a new browser window.

    + *
  • + *
  • + *

    + * SAME_TAB: Opens the target URL in the same browser tab.

    + *
  • + *
+ * @public + */ + URLTarget: URLTargetConfiguration | undefined; +} + +/** + *

The operation that is defined by the custom action.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The navigation operation that navigates between different sheets in the same analysis.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

+ * @public + */ + NavigationOperation?: CustomActionNavigationOperation | undefined; + + /** + *

The URL operation that opens a link to another webpage.

+ * @public + */ + URLOperation?: CustomActionURLOperation | undefined; + + /** + *

The set parameter operation that sets parameters in custom action.

+ * @public + */ + SetParametersOperation?: CustomActionSetParametersOperation | undefined; +} + +/** + * @public + * @enum + */ +export const WidgetStatus = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", +} as const; + +/** + * @public + */ +export type WidgetStatus = (typeof WidgetStatus)[keyof typeof WidgetStatus]; + +/** + * @public + * @enum + */ +export const ImageCustomActionTrigger = { + CLICK: "CLICK", + MENU: "MENU", +} as const; + +/** + * @public + */ +export type ImageCustomActionTrigger = (typeof ImageCustomActionTrigger)[keyof typeof ImageCustomActionTrigger]; + +/** + *

A custom action defined on an image.

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

The ID of the custom action.

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

The name of the custom action.

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

The status of the custom action.

+ * @public + */ + Status?: WidgetStatus | undefined; + + /** + *

The trigger of the VisualCustomAction.

+ *

Valid values are defined as follows:

+ *
    + *
  • + *

    + * CLICK: Initiates a custom action by a left pointer click on a data point.

    + *
  • + *
  • + *

    + * MENU: Initiates a custom action by right pointer click from the menu.

    + *
  • + *
+ * @public + */ + Trigger: ImageCustomActionTrigger | undefined; + + /** + *

A list of ImageCustomActionOperations.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

+ * @public + */ + ActionOperations: ImageCustomActionOperation[] | undefined; +} + +/** + *

The menu options for the interactions of an image.

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

The availability status of the image menu. If the value of this property is set to ENABLED, dashboard readers can interact with the image menu.

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

The general image interactions setup for image publish options.

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

The menu options for the image.

+ * @public + */ + ImageMenuOption?: ImageMenuOption | undefined; +} + +/** + * @public + * @enum + */ +export const SheetImageScalingType = { + SCALE_NONE: "SCALE_NONE", + SCALE_TO_CONTAINER: "SCALE_TO_CONTAINER", + SCALE_TO_HEIGHT: "SCALE_TO_HEIGHT", + SCALE_TO_WIDTH: "SCALE_TO_WIDTH", +} as const; + +/** + * @public + */ +export type SheetImageScalingType = (typeof SheetImageScalingType)[keyof typeof SheetImageScalingType]; + +/** + *

Determines how the image is scaled

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

The scaling option to use when fitting the image inside the container.

+ *

Valid values are defined as follows:

+ *
    + *
  • + *

    + * SCALE_TO_WIDTH: The image takes up the entire width of the container. The image aspect ratio is preserved.

    + *
  • + *
  • + *

    + * SCALE_TO_HEIGHT: The image takes up the entire height of the container. The image aspect ratio is preserved.

    + *
  • + *
  • + *

    + * SCALE_TO_CONTAINER: The image takes up the entire width and height of the container. The image aspect ratio is not preserved.

    + *
  • + *
  • + *

    + * SCALE_NONE: The image is displayed in its original size and is not scaled to the container.

    + *
  • + *
+ * @public + */ + ScalingType?: SheetImageScalingType | undefined; +} + +/** + *

The source of the static file that contains the image.

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

The ID of the static file that contains the image.

+ * @public + */ + StaticFileId: string | undefined; +} + +/** + *

The source of the image.

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

The source of the static file that contains the image.

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

The text that appears in the sheet image tooltip.

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

The plain text format.

+ * @public + */ + PlainText?: string | undefined; +} + +/** + * @public + * @enum + */ +export const Visibility = { + HIDDEN: "HIDDEN", + VISIBLE: "VISIBLE", +} as const; + +/** + * @public + */ +export type Visibility = (typeof Visibility)[keyof typeof Visibility]; + +/** + *

The tooltip configuration for a sheet image.

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

The text that appears in the tooltip.

+ * @public + */ + TooltipText?: SheetImageTooltipText | undefined; + + /** + *

The visibility of the tooltip.

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

An image that is located on a sheet.

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

The ID of the sheet image.

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

The source of the image.

+ * @public + */ + Source: SheetImageSource | undefined; + + /** + *

Determines how the image is scaled.

+ * @public + */ + Scaling?: SheetImageScalingConfiguration | undefined; + + /** + *

The tooltip to be shown when hovering over the image.

+ * @public + */ + Tooltip?: SheetImageTooltipConfiguration | undefined; + + /** + *

The alt text for the image.

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

The general image interactions setup for an image.

+ * @public + */ + Interactions?: ImageInteractionOptions | undefined; + + /** + *

A list of custom actions that are configured for an image.

+ * @public + */ + Actions?: ImageCustomAction[] | undefined; +} + /** *

A sheet, which is an object that contains a set of visuals that * are viewed together on one page in Amazon QuickSight. Every analysis and dashboard @@ -744,6 +1237,12 @@ export interface Sheet { * @public */ Name?: string | undefined; + + /** + *

A list of images on a sheet.

+ * @public + */ + Images?: SheetImage[] | undefined; } /** @@ -1298,20 +1797,6 @@ export const NumericSeparatorSymbol = { */ export type NumericSeparatorSymbol = (typeof NumericSeparatorSymbol)[keyof typeof NumericSeparatorSymbol]; -/** - * @public - * @enum - */ -export const Visibility = { - HIDDEN: "HIDDEN", - VISIBLE: "VISIBLE", -} as const; - -/** - * @public - */ -export type Visibility = (typeof Visibility)[keyof typeof Visibility]; - /** *

The options that determine the thousands separator configuration.

* @public @@ -1978,6 +2463,12 @@ export interface FontSize { * @public */ Relative?: RelativeFontSize | undefined; + + /** + *

The font size that you want to use in px.

+ * @public + */ + Absolute?: string | undefined; } /** @@ -2054,6 +2545,12 @@ export interface FontConfiguration { * @public */ FontStyle?: FontStyle | undefined; + + /** + *

The font family that you want to use.

+ * @public + */ + FontFamily?: string | undefined; } /** @@ -2971,20 +3468,6 @@ export interface AnchorDateConfiguration { ParameterName?: string | undefined; } -/** - * @public - * @enum - */ -export const WidgetStatus = { - DISABLED: "DISABLED", - ENABLED: "ENABLED", -} as const; - -/** - * @public - */ -export type WidgetStatus = (typeof WidgetStatus)[keyof typeof WidgetStatus]; - /** *

The exclude period of TimeRangeFilter or RelativeDatesFilter.

* @public @@ -4553,6 +5036,7 @@ export interface FreeFormLayoutElementBorderStyle { */ export const LayoutElementType = { FILTER_CONTROL: "FILTER_CONTROL", + IMAGE: "IMAGE", PARAMETER_CONTROL: "PARAMETER_CONTROL", TEXT_BOX: "TEXT_BOX", VISUAL: "VISUAL", @@ -5551,245 +6035,41 @@ export interface SameSheetTargetVisualConfiguration { *

* ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.

* - * - * @public - */ - TargetVisualOptions?: TargetVisualOptions | undefined; -} - -/** - *

The configuration of target visuals that you want to be filtered.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The configuration of the same-sheet target visuals that you want to be filtered.

- * @public - */ - SameSheetTargetVisualConfiguration?: SameSheetTargetVisualConfiguration | undefined; -} - -/** - *

The filter operation that filters data included in a visual or in an entire sheet.

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

The configuration that chooses the fields to be filtered.

- * @public - */ - SelectedFieldsConfiguration: FilterOperationSelectedFieldsConfiguration | undefined; - - /** - *

The configuration that chooses the target visuals to be filtered.

- * @public - */ - TargetVisualsConfiguration: FilterOperationTargetVisualsConfiguration | undefined; -} - -/** - *

The navigation configuration for CustomActionNavigationOperation.

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

The sheet that is targeted for navigation in the same analysis.

- * @public - */ - TargetSheetId: string | undefined; -} - -/** - *

The navigation operation that navigates between different sheets in the same analysis.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The configuration that chooses the navigation target.

- * @public - */ - LocalNavigationConfiguration?: LocalNavigationConfiguration | undefined; -} - -/** - *

The customized parameter values.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

A list of string-type parameter values.

- * @public - */ - StringValues?: string[] | undefined; - - /** - *

A list of integer-type parameter values.

- * @public - */ - IntegerValues?: number[] | undefined; - - /** - *

A list of decimal-type parameter values.

- * @public - */ - DecimalValues?: number[] | undefined; - - /** - *

A list of datetime-type parameter values.

- * @public - */ - DateTimeValues?: Date[] | undefined; -} - -/** - *

The configuration of custom values for the destination parameter in DestinationParameterValueConfiguration.

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

Includes the null value in custom action parameter values.

- * @public - */ - IncludeNullValue?: boolean | undefined; - - /** - *

The customized parameter values.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

- * @public - */ - CustomValues: CustomParameterValues | undefined; -} - -/** - * @public - * @enum - */ -export const SelectAllValueOptions = { - ALL_VALUES: "ALL_VALUES", -} as const; - -/** - * @public - */ -export type SelectAllValueOptions = (typeof SelectAllValueOptions)[keyof typeof SelectAllValueOptions]; - -/** - *

The configuration of destination parameter values.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration.

- * @public - */ - CustomValuesConfiguration?: CustomValuesConfiguration | undefined; - - /** - *

The configuration that selects all options.

- * @public - */ - SelectAllValueOptions?: SelectAllValueOptions | undefined; - - /** - *

The source parameter name of the destination parameter.

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

The source field ID of the destination parameter.

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

A column of a data set.

- * @public - */ - SourceColumn?: ColumnIdentifier | undefined; -} - -/** - *

The configuration of adding parameters in action.

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

The destination parameter name of the SetParameterValueConfiguration.

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

The configuration of destination parameter values.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

- * @public - */ - Value: DestinationParameterValueConfiguration | undefined; -} - -/** - *

The set parameter operation that sets parameters in custom action.

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

The parameter that determines the value configuration.

- * @public - */ - ParameterValueConfigurations: SetParameterValueConfiguration[] | undefined; -} - -/** - * @public - * @enum - */ -export const URLTargetConfiguration = { - NEW_TAB: "NEW_TAB", - NEW_WINDOW: "NEW_WINDOW", - SAME_TAB: "SAME_TAB", -} as const; + * + * @public + */ + TargetVisualOptions?: TargetVisualOptions | undefined; +} /** + *

The configuration of target visuals that you want to be filtered.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The configuration of the same-sheet target visuals that you want to be filtered.

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

The URL operation that opens a link to another webpage.

+ *

The filter operation that filters data included in a visual or in an entire sheet.

* @public */ -export interface CustomActionURLOperation { +export interface CustomActionFilterOperation { /** - *

THe URL link of the CustomActionURLOperation.

+ *

The configuration that chooses the fields to be filtered.

* @public */ - URLTemplate: string | undefined; + SelectedFieldsConfiguration: FilterOperationSelectedFieldsConfiguration | undefined; /** - *

The target of the CustomActionURLOperation.

- *

Valid values are defined as follows:

- *
    - *
  • - *

    - * NEW_TAB: Opens the target URL in a new browser tab.

    - *
  • - *
  • - *

    - * NEW_WINDOW: Opens the target URL in a new browser window.

    - *
  • - *
  • - *

    - * SAME_TAB: Opens the target URL in the same browser tab.

    - *
  • - *
+ *

The configuration that chooses the target visuals to be filtered.

* @public */ - URLTarget: URLTargetConfiguration | undefined; + TargetVisualsConfiguration: FilterOperationTargetVisualsConfiguration | undefined; } /** @@ -6940,6 +7220,12 @@ export interface LegendOptions { * @public */ Height?: string | undefined; + + /** + *

Configures the display properties of the given text.

+ * @public + */ + ValueFontConfiguration?: FontConfiguration | undefined; } /** @@ -7071,464 +7357,185 @@ export interface ReferenceLineDataConfiguration { * * @public */ - SeriesType?: ReferenceLineSeriesType | undefined; -} - -/** - *

The configuration for a custom label on a ReferenceLine.

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

The string text of the custom label.

- * @public - */ - CustomLabel: string | undefined; -} - -/** - * @public - * @enum - */ -export const ReferenceLineLabelHorizontalPosition = { - CENTER: "CENTER", - LEFT: "LEFT", - RIGHT: "RIGHT", -} as const; - -/** - * @public - */ -export type ReferenceLineLabelHorizontalPosition = - (typeof ReferenceLineLabelHorizontalPosition)[keyof typeof ReferenceLineLabelHorizontalPosition]; - -/** - * @public - * @enum - */ -export const ReferenceLineValueLabelRelativePosition = { - AFTER_CUSTOM_LABEL: "AFTER_CUSTOM_LABEL", - BEFORE_CUSTOM_LABEL: "BEFORE_CUSTOM_LABEL", -} as const; - -/** - * @public - */ -export type ReferenceLineValueLabelRelativePosition = - (typeof ReferenceLineValueLabelRelativePosition)[keyof typeof ReferenceLineValueLabelRelativePosition]; - -/** - *

The value label configuration of the label in a reference line.

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

The relative position of the value label. Choose one of the following options:

- *
    - *
  • - *

    - * BEFORE_CUSTOM_LABEL - *

    - *
  • - *
  • - *

    - * AFTER_CUSTOM_LABEL - *

    - *
  • - *
- * @public - */ - RelativePosition?: ReferenceLineValueLabelRelativePosition | undefined; - - /** - *

The format configuration of the value label.

- * @public - */ - FormatConfiguration?: NumericFormatConfiguration | undefined; -} - -/** - * @public - * @enum - */ -export const ReferenceLineLabelVerticalPosition = { - ABOVE: "ABOVE", - BELOW: "BELOW", -} as const; - -/** - * @public - */ -export type ReferenceLineLabelVerticalPosition = - (typeof ReferenceLineLabelVerticalPosition)[keyof typeof ReferenceLineLabelVerticalPosition]; - -/** - *

The label configuration of a reference line.

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

The value label configuration of the label in a reference line.

- * @public - */ - ValueLabelConfiguration?: ReferenceLineValueLabelConfiguration | undefined; - - /** - *

The custom label configuration of the label in a reference line.

- * @public - */ - CustomLabelConfiguration?: ReferenceLineCustomLabelConfiguration | undefined; - - /** - *

The font configuration of the label in a reference line.

- * @public - */ - FontConfiguration?: FontConfiguration | undefined; - - /** - *

The font color configuration of the label in a reference line.

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

The horizontal position configuration of the label in a reference line. Choose one of - * the following options:

- *
    - *
  • - *

    - * LEFT - *

    - *
  • - *
  • - *

    - * CENTER - *

    - *
  • - *
  • - *

    - * RIGHT - *

    - *
  • - *
- * @public - */ - HorizontalPosition?: ReferenceLineLabelHorizontalPosition | undefined; - - /** - *

The vertical position configuration of the label in a reference line. Choose one of the following options:

- *
    - *
  • - *

    - * ABOVE - *

    - *
  • - *
  • - *

    - * BELOW - *

    - *
  • - *
- * @public - */ - VerticalPosition?: ReferenceLineLabelVerticalPosition | undefined; -} - -/** - * @public - * @enum - */ -export const ReferenceLinePatternType = { - DASHED: "DASHED", - DOTTED: "DOTTED", - SOLID: "SOLID", -} as const; - -/** - * @public - */ -export type ReferenceLinePatternType = (typeof ReferenceLinePatternType)[keyof typeof ReferenceLinePatternType]; - -/** - *

The style configuration of the reference - * line.

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

The pattern type of the line style. Choose one of the following options:

- *
    - *
  • - *

    - * SOLID - *

    - *
  • - *
  • - *

    - * DASHED - *

    - *
  • - *
  • - *

    - * DOTTED - *

    - *
  • - *
- * @public - */ - Pattern?: ReferenceLinePatternType | undefined; - - /** - *

The hex color of the reference line.

- * @public - */ - Color?: string | undefined; -} - -/** - *

The reference line visual display options.

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

The status of the reference line. Choose one of the following options:

- *
    - *
  • - *

    - * ENABLE - *

    - *
  • - *
  • - *

    - * DISABLE - *

    - *
  • - *
- * @public - */ - Status?: WidgetStatus | undefined; - - /** - *

The data configuration of the reference line.

- * @public - */ - DataConfiguration: ReferenceLineDataConfiguration | undefined; - - /** - *

The style configuration of the reference line.

- * @public - */ - StyleConfiguration?: ReferenceLineStyleConfiguration | undefined; + SeriesType?: ReferenceLineSeriesType | undefined; +} +/** + *

The configuration for a custom label on a ReferenceLine.

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

The label configuration of the reference line.

+ *

The string text of the custom label.

* @public */ - LabelConfiguration?: ReferenceLineLabelConfiguration | undefined; + CustomLabel: string | undefined; } /** * @public * @enum */ -export const PanelBorderStyle = { - DASHED: "DASHED", - DOTTED: "DOTTED", - SOLID: "SOLID", +export const ReferenceLineLabelHorizontalPosition = { + CENTER: "CENTER", + LEFT: "LEFT", + RIGHT: "RIGHT", } as const; /** * @public */ -export type PanelBorderStyle = (typeof PanelBorderStyle)[keyof typeof PanelBorderStyle]; +export type ReferenceLineLabelHorizontalPosition = + (typeof ReferenceLineLabelHorizontalPosition)[keyof typeof ReferenceLineLabelHorizontalPosition]; /** * @public * @enum */ -export const HorizontalTextAlignment = { - AUTO: "AUTO", - CENTER: "CENTER", - LEFT: "LEFT", - RIGHT: "RIGHT", +export const ReferenceLineValueLabelRelativePosition = { + AFTER_CUSTOM_LABEL: "AFTER_CUSTOM_LABEL", + BEFORE_CUSTOM_LABEL: "BEFORE_CUSTOM_LABEL", } as const; /** * @public */ -export type HorizontalTextAlignment = (typeof HorizontalTextAlignment)[keyof typeof HorizontalTextAlignment]; +export type ReferenceLineValueLabelRelativePosition = + (typeof ReferenceLineValueLabelRelativePosition)[keyof typeof ReferenceLineValueLabelRelativePosition]; /** - *

The options that determine the title styles for each small multiples - * panel.

+ *

The value label configuration of the label in a reference line.

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

Determines whether or not panel titles are displayed.

- * @public - */ - Visibility?: Visibility | undefined; - +export interface ReferenceLineValueLabelConfiguration { /** - *

Configures the display properties of the given text.

+ *

The relative position of the value label. Choose one of the following options:

+ *
    + *
  • + *

    + * BEFORE_CUSTOM_LABEL + *

    + *
  • + *
  • + *

    + * AFTER_CUSTOM_LABEL + *

    + *
  • + *
* @public */ - FontConfiguration?: FontConfiguration | undefined; + RelativePosition?: ReferenceLineValueLabelRelativePosition | undefined; /** - *

Sets the horizontal text alignment of the title within each panel.

+ *

The format configuration of the value label.

* @public */ - HorizontalTextAlignment?: HorizontalTextAlignment | undefined; + FormatConfiguration?: NumericFormatConfiguration | undefined; } /** - *

A collection of options that configure how each panel displays in a small multiples chart.

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

Configures the title display within each small multiples panel.

- * @public - */ - Title?: PanelTitleOptions | undefined; - - /** - *

Determines whether or not each panel displays a border.

- * @public - */ - BorderVisibility?: Visibility | undefined; - - /** - *

Sets the line thickness of panel borders.

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

Sets the line style of panel borders.

- * @public - */ - BorderStyle?: PanelBorderStyle | undefined; - - /** - *

Sets the line color of panel borders.

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

Determines whether or not negative space between sibling panels is rendered.

- * @public - */ - GutterVisibility?: Visibility | undefined; - - /** - *

Sets the total amount of negative space to display between sibling panels.

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

Determines whether or not a background for each small multiples panel is rendered.

- * @public - */ - BackgroundVisibility?: Visibility | undefined; - - /** - *

Sets the background color for each panel.

- * @public - */ - BackgroundColor?: string | undefined; -} +export const ReferenceLineLabelVerticalPosition = { + ABOVE: "ABOVE", + BELOW: "BELOW", +} as const; /** * @public - * @enum */ -export const SmallMultiplesAxisPlacement = { - INSIDE: "INSIDE", - OUTSIDE: "OUTSIDE", -} as const; +export type ReferenceLineLabelVerticalPosition = + (typeof ReferenceLineLabelVerticalPosition)[keyof typeof ReferenceLineLabelVerticalPosition]; /** - * @public + * @internal */ -export type SmallMultiplesAxisPlacement = - (typeof SmallMultiplesAxisPlacement)[keyof typeof SmallMultiplesAxisPlacement]; +export const CustomParameterValuesFilterSensitiveLog = (obj: CustomParameterValues): any => ({ + ...obj, + ...(obj.StringValues && { StringValues: SENSITIVE_STRING }), + ...(obj.IntegerValues && { IntegerValues: SENSITIVE_STRING }), + ...(obj.DecimalValues && { DecimalValues: SENSITIVE_STRING }), + ...(obj.DateTimeValues && { DateTimeValues: SENSITIVE_STRING }), +}); /** - * @public - * @enum + * @internal */ -export const SmallMultiplesAxisScale = { - INDEPENDENT: "INDEPENDENT", - SHARED: "SHARED", -} as const; +export const CustomValuesConfigurationFilterSensitiveLog = (obj: CustomValuesConfiguration): any => ({ + ...obj, + ...(obj.CustomValues && { CustomValues: CustomParameterValuesFilterSensitiveLog(obj.CustomValues) }), +}); /** - * @public + * @internal */ -export type SmallMultiplesAxisScale = (typeof SmallMultiplesAxisScale)[keyof typeof SmallMultiplesAxisScale]; +export const DestinationParameterValueConfigurationFilterSensitiveLog = ( + obj: DestinationParameterValueConfiguration +): any => ({ + ...obj, + ...(obj.CustomValuesConfiguration && { + CustomValuesConfiguration: CustomValuesConfigurationFilterSensitiveLog(obj.CustomValuesConfiguration), + }), +}); /** - *

Configures the properties of a chart's axes that are used by small multiples panels.

- * @public + * @internal */ -export interface SmallMultiplesAxisProperties { - /** - *

Determines whether scale of the axes are shared or independent. The default value is SHARED.

- * @public - */ - Scale?: SmallMultiplesAxisScale | undefined; +export const SetParameterValueConfigurationFilterSensitiveLog = (obj: SetParameterValueConfiguration): any => ({ + ...obj, + ...(obj.Value && { Value: DestinationParameterValueConfigurationFilterSensitiveLog(obj.Value) }), +}); - /** - *

Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

- * @public - */ - Placement?: SmallMultiplesAxisPlacement | undefined; -} +/** + * @internal + */ +export const CustomActionSetParametersOperationFilterSensitiveLog = (obj: CustomActionSetParametersOperation): any => ({ + ...obj, + ...(obj.ParameterValueConfigurations && { + ParameterValueConfigurations: obj.ParameterValueConfigurations.map((item) => + SetParameterValueConfigurationFilterSensitiveLog(item) + ), + }), +}); /** - *

Options that determine the layout and display options of a chart's small multiples.

- * @public + * @internal */ -export interface SmallMultiplesOptions { - /** - *

Sets the maximum number of visible rows to display in the grid of small multiples panels.

- *

The default value is Auto, - * which automatically adjusts the rows in the grid - * to fit the overall layout and size of the given chart.

- * @public - */ - MaxVisibleRows?: number | undefined; +export const ImageCustomActionOperationFilterSensitiveLog = (obj: ImageCustomActionOperation): any => ({ + ...obj, + ...(obj.SetParametersOperation && { + SetParametersOperation: CustomActionSetParametersOperationFilterSensitiveLog(obj.SetParametersOperation), + }), +}); - /** - *

Sets the maximum number of visible columns to display in the grid of small multiples panels.

- *

The default is Auto, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

- * @public - */ - MaxVisibleColumns?: number | undefined; +/** + * @internal + */ +export const ImageCustomActionFilterSensitiveLog = (obj: ImageCustomAction): any => ({ + ...obj, +}); - /** - *

Configures the display options for each small multiples panel.

- * @public - */ - PanelConfiguration?: PanelConfiguration | undefined; +/** + * @internal + */ +export const SheetImageFilterSensitiveLog = (obj: SheetImage): any => ({ + ...obj, +}); - /** - *

The properties of a small multiples X axis.

- * @public - */ - XAxis?: SmallMultiplesAxisProperties | undefined; +/** + * @internal + */ +export const SheetFilterSensitiveLog = (obj: Sheet): any => ({ + ...obj, +}); - /** - *

The properties of a small multiples Y axis.

- * @public - */ - YAxis?: SmallMultiplesAxisProperties | undefined; -} +/** + * @internal + */ +export const AnalysisFilterSensitiveLog = (obj: Analysis): any => ({ + ...obj, +}); /** * @internal @@ -7948,57 +7955,6 @@ export const LayoutFilterSensitiveLog = (obj: Layout): any => ({ ...obj, }); -/** - * @internal - */ -export const CustomParameterValuesFilterSensitiveLog = (obj: CustomParameterValues): any => ({ - ...obj, - ...(obj.StringValues && { StringValues: SENSITIVE_STRING }), - ...(obj.IntegerValues && { IntegerValues: SENSITIVE_STRING }), - ...(obj.DecimalValues && { DecimalValues: SENSITIVE_STRING }), - ...(obj.DateTimeValues && { DateTimeValues: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const CustomValuesConfigurationFilterSensitiveLog = (obj: CustomValuesConfiguration): any => ({ - ...obj, - ...(obj.CustomValues && { CustomValues: CustomParameterValuesFilterSensitiveLog(obj.CustomValues) }), -}); - -/** - * @internal - */ -export const DestinationParameterValueConfigurationFilterSensitiveLog = ( - obj: DestinationParameterValueConfiguration -): any => ({ - ...obj, - ...(obj.CustomValuesConfiguration && { - CustomValuesConfiguration: CustomValuesConfigurationFilterSensitiveLog(obj.CustomValuesConfiguration), - }), -}); - -/** - * @internal - */ -export const SetParameterValueConfigurationFilterSensitiveLog = (obj: SetParameterValueConfiguration): any => ({ - ...obj, - ...(obj.Value && { Value: DestinationParameterValueConfigurationFilterSensitiveLog(obj.Value) }), -}); - -/** - * @internal - */ -export const CustomActionSetParametersOperationFilterSensitiveLog = (obj: CustomActionSetParametersOperation): any => ({ - ...obj, - ...(obj.ParameterValueConfigurations && { - ParameterValueConfigurations: obj.ParameterValueConfigurations.map((item) => - SetParameterValueConfigurationFilterSensitiveLog(item) - ), - }), -}); - /** * @internal */ @@ -8175,26 +8131,3 @@ export const ReferenceLineValueLabelConfigurationFilterSensitiveLog = ( FormatConfiguration: NumericFormatConfigurationFilterSensitiveLog(obj.FormatConfiguration), }), }); - -/** - * @internal - */ -export const ReferenceLineLabelConfigurationFilterSensitiveLog = (obj: ReferenceLineLabelConfiguration): any => ({ - ...obj, - ...(obj.ValueLabelConfiguration && { - ValueLabelConfiguration: ReferenceLineValueLabelConfigurationFilterSensitiveLog(obj.ValueLabelConfiguration), - }), -}); - -/** - * @internal - */ -export const ReferenceLineFilterSensitiveLog = (obj: ReferenceLine): any => ({ - ...obj, - ...(obj.DataConfiguration && { - DataConfiguration: ReferenceLineDataConfigurationFilterSensitiveLog(obj.DataConfiguration), - }), - ...(obj.LabelConfiguration && { - LabelConfiguration: ReferenceLineLabelConfigurationFilterSensitiveLog(obj.LabelConfiguration), - }), -}); diff --git a/clients/client-quicksight/src/models/models_1.ts b/clients/client-quicksight/src/models/models_1.ts index 28c91e8615c8..c580c0985dae 100644 --- a/clients/client-quicksight/src/models/models_1.ts +++ b/clients/client-quicksight/src/models/models_1.ts @@ -12,6 +12,11 @@ import { ColumnIdentifier, ColumnSort, ContributionAnalysisDefault, + CustomActionFilterOperation, + CustomActionNavigationOperation, + CustomActionSetParametersOperation, + CustomActionSetParametersOperationFilterSensitiveLog, + CustomActionURLOperation, DataLabelOptions, DataLabelOptionsFilterSensitiveLog, DataLabelPosition, @@ -19,7 +24,6 @@ import { FontConfiguration, FormatConfiguration, FormatConfigurationFilterSensitiveLog, - HorizontalTextAlignment, LegendOptions, MeasureField, MeasureFieldFilterSensitiveLog, @@ -27,12 +31,15 @@ import { NumberDisplayFormatConfigurationFilterSensitiveLog, PercentageDisplayFormatConfiguration, PercentageDisplayFormatConfigurationFilterSensitiveLog, - ReferenceLine, - ReferenceLineFilterSensitiveLog, - SmallMultiplesOptions, + ReferenceLineCustomLabelConfiguration, + ReferenceLineDataConfiguration, + ReferenceLineDataConfigurationFilterSensitiveLog, + ReferenceLineLabelHorizontalPosition, + ReferenceLineLabelVerticalPosition, + ReferenceLineValueLabelConfiguration, + ReferenceLineValueLabelConfigurationFilterSensitiveLog, SortDirection, TimeGranularity, - URLTargetConfiguration, Visibility, VisualCustomAction, VisualInteractionOptions, @@ -40,1344 +47,1434 @@ import { } from "./models_0"; /** + *

The label configuration of a reference line.

* @public - * @enum */ -export const OtherCategories = { - EXCLUDE: "EXCLUDE", - INCLUDE: "INCLUDE", -} as const; +export interface ReferenceLineLabelConfiguration { + /** + *

The value label configuration of the label in a reference line.

+ * @public + */ + ValueLabelConfiguration?: ReferenceLineValueLabelConfiguration | undefined; -/** - * @public - */ -export type OtherCategories = (typeof OtherCategories)[keyof typeof OtherCategories]; + /** + *

The custom label configuration of the label in a reference line.

+ * @public + */ + CustomLabelConfiguration?: ReferenceLineCustomLabelConfiguration | undefined; -/** - *

The limit configuration of the visual display for an axis.

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

The limit on how many items of a field are showed in the chart. For - * example, the number of slices that are displayed in a pie chart.

+ *

The font configuration of the label in a reference line.

* @public */ - ItemsLimit?: number | undefined; + FontConfiguration?: FontConfiguration | undefined; /** - *

The Show - * other of an axis in the chart. Choose one of the following options:

+ *

The font color configuration of the label in a reference line.

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

The horizontal position configuration of the label in a reference line. Choose one of + * the following options:

*
    *
  • *

    - * INCLUDE + * LEFT *

    *
  • *
  • *

    - * EXCLUDE + * CENTER + *

    + *
  • + *
  • + *

    + * RIGHT *

    *
  • *
* @public */ - OtherCategories?: OtherCategories | undefined; -} - -/** - *

The sort configuration for a field in a - * field well.

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

The sort configuration target field.

- * @public - */ - FieldId: string | undefined; + HorizontalPosition?: ReferenceLineLabelHorizontalPosition | undefined; /** - *

The sort direction. Choose one of the following - * options:

+ *

The vertical position configuration of the label in a reference line. Choose one of the following options:

*
    *
  • *

    - * ASC: Ascending

    + * ABOVE + *

    *
  • *
  • *

    - * DESC: Descending

    + * BELOW + *

    *
  • *
* @public */ - Direction: SortDirection | undefined; + VerticalPosition?: ReferenceLineLabelVerticalPosition | undefined; } /** - *

The field sort options in a chart configuration.

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

The sort configuration for a field in a field well.

- * @public - */ - FieldSort?: FieldSort | undefined; +export const ReferenceLinePatternType = { + DASHED: "DASHED", + DOTTED: "DOTTED", + SOLID: "SOLID", +} as const; - /** - *

The sort configuration for a column that is not used in a field well.

- * @public - */ - ColumnSort?: ColumnSort | undefined; -} +/** + * @public + */ +export type ReferenceLinePatternType = (typeof ReferenceLinePatternType)[keyof typeof ReferenceLinePatternType]; /** - *

sort-configuration-description

+ *

The style configuration of the reference + * line.

* @public */ -export interface BarChartSortConfiguration { +export interface ReferenceLineStyleConfiguration { /** - *

The sort configuration of category fields.

+ *

The pattern type of the line style. Choose one of the following options:

+ *
    + *
  • + *

    + * SOLID + *

    + *
  • + *
  • + *

    + * DASHED + *

    + *
  • + *
  • + *

    + * DOTTED + *

    + *
  • + *
* @public */ - CategorySort?: FieldSortOptions[] | undefined; + Pattern?: ReferenceLinePatternType | undefined; /** - *

The limit on the number of categories displayed in a bar chart.

+ *

The hex color of the reference line.

* @public */ - CategoryItemsLimit?: ItemsLimitConfiguration | undefined; + Color?: string | undefined; +} +/** + *

The reference line visual display options.

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

The sort configuration of color fields in a bar chart.

+ *

The status of the reference line. Choose one of the following options:

+ *
    + *
  • + *

    + * ENABLE + *

    + *
  • + *
  • + *

    + * DISABLE + *

    + *
  • + *
* @public */ - ColorSort?: FieldSortOptions[] | undefined; + Status?: WidgetStatus | undefined; /** - *

The limit on the number of values displayed in a bar chart.

+ *

The data configuration of the reference line.

* @public */ - ColorItemsLimit?: ItemsLimitConfiguration | undefined; + DataConfiguration: ReferenceLineDataConfiguration | undefined; /** - *

The sort configuration of the small multiples field.

+ *

The style configuration of the reference line.

* @public */ - SmallMultiplesSort?: FieldSortOptions[] | undefined; + StyleConfiguration?: ReferenceLineStyleConfiguration | undefined; /** - *

The limit on the number of small multiples panels that are displayed.

+ *

The label configuration of the reference line.

* @public */ - SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration | undefined; + LabelConfiguration?: ReferenceLineLabelConfiguration | undefined; } /** * @public * @enum */ -export const TooltipTarget = { - BAR: "BAR", - BOTH: "BOTH", - LINE: "LINE", +export const PanelBorderStyle = { + DASHED: "DASHED", + DOTTED: "DOTTED", + SOLID: "SOLID", } as const; /** * @public */ -export type TooltipTarget = (typeof TooltipTarget)[keyof typeof TooltipTarget]; +export type PanelBorderStyle = (typeof PanelBorderStyle)[keyof typeof PanelBorderStyle]; /** - *

The tooltip item for the columns that are not part of a field well.

* @public + * @enum */ -export interface ColumnTooltipItem { +export const HorizontalTextAlignment = { + AUTO: "AUTO", + CENTER: "CENTER", + LEFT: "LEFT", + RIGHT: "RIGHT", +} as const; + +/** + * @public + */ +export type HorizontalTextAlignment = (typeof HorizontalTextAlignment)[keyof typeof HorizontalTextAlignment]; + +/** + *

The options that determine the title styles for each small multiples + * panel.

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

The target column of the tooltip item.

+ *

Determines whether or not panel titles are displayed.

* @public */ - Column: ColumnIdentifier | undefined; + Visibility?: Visibility | undefined; /** - *

The label of the tooltip item.

+ *

Configures the display properties of the given text.

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

The visibility of the tooltip item.

+ *

Sets the horizontal text alignment of the title within each panel.

* @public */ - Visibility?: Visibility | undefined; + HorizontalTextAlignment?: HorizontalTextAlignment | undefined; +} +/** + *

A collection of options that configure how each panel displays in a small multiples chart.

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

The aggregation function of the column tooltip item.

+ *

Configures the title display within each small multiples panel.

* @public */ - Aggregation?: AggregationFunction | undefined; + Title?: PanelTitleOptions | undefined; /** - *

Determines the target of the column tooltip item in a combo chart visual.

+ *

Determines whether or not each panel displays a border.

* @public */ - TooltipTarget?: TooltipTarget | undefined; -} + BorderVisibility?: Visibility | undefined; -/** - *

The tooltip item for the fields.

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

The unique ID of the field that is targeted by the tooltip.

+ *

Sets the line thickness of panel borders.

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

The label of the tooltip item.

+ *

Sets the line style of panel borders.

* @public */ - Label?: string | undefined; + BorderStyle?: PanelBorderStyle | undefined; /** - *

The visibility of the tooltip item.

+ *

Sets the line color of panel borders.

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

Determines the target of the field tooltip item in a combo chart visual.

+ *

Determines whether or not negative space between sibling panels is rendered.

* @public */ - TooltipTarget?: TooltipTarget | undefined; -} + GutterVisibility?: Visibility | undefined; -/** - *

The tooltip.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The tooltip item for the fields.

+ *

Sets the total amount of negative space to display between sibling panels.

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

The tooltip item for the columns that are not part of a field well.

+ *

Determines whether or not a background for each small multiples panel is rendered.

* @public */ - ColumnTooltipItem?: ColumnTooltipItem | undefined; + BackgroundVisibility?: Visibility | undefined; + + /** + *

Sets the background color for each panel.

+ * @public + */ + BackgroundColor?: string | undefined; } /** * @public * @enum */ -export const TooltipTitleType = { - NONE: "NONE", - PRIMARY_VALUE: "PRIMARY_VALUE", +export const SmallMultiplesAxisPlacement = { + INSIDE: "INSIDE", + OUTSIDE: "OUTSIDE", } as const; /** * @public */ -export type TooltipTitleType = (typeof TooltipTitleType)[keyof typeof TooltipTitleType]; +export type SmallMultiplesAxisPlacement = + (typeof SmallMultiplesAxisPlacement)[keyof typeof SmallMultiplesAxisPlacement]; /** - *

The setup for the detailed tooltip.

* @public + * @enum */ -export interface FieldBasedTooltip { +export const SmallMultiplesAxisScale = { + INDEPENDENT: "INDEPENDENT", + SHARED: "SHARED", +} as const; + +/** + * @public + */ +export type SmallMultiplesAxisScale = (typeof SmallMultiplesAxisScale)[keyof typeof SmallMultiplesAxisScale]; + +/** + *

Configures the properties of a chart's axes that are used by small multiples panels.

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

The visibility of Show aggregations.

+ *

Determines whether scale of the axes are shared or independent. The default value is SHARED.

* @public */ - AggregationVisibility?: Visibility | undefined; + Scale?: SmallMultiplesAxisScale | undefined; /** - *

The type for the >tooltip title. Choose one of the following options:

- *
    - *
  • - *

    - * NONE: Doesn't use the primary value as the title.

    - *
  • - *
  • - *

    - * PRIMARY_VALUE: Uses primary value as the title.

    - *
  • - *
+ *

Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

* @public */ - TooltipTitleType?: TooltipTitleType | undefined; + Placement?: SmallMultiplesAxisPlacement | undefined; +} + +/** + *

Options that determine the layout and display options of a chart's small multiples.

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

Sets the maximum number of visible rows to display in the grid of small multiples panels.

+ *

The default value is Auto, + * which automatically adjusts the rows in the grid + * to fit the overall layout and size of the given chart.

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

The fields configuration in the - * tooltip.

+ *

Sets the maximum number of visible columns to display in the grid of small multiples panels.

+ *

The default is Auto, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

* @public */ - TooltipFields?: TooltipItem[] | undefined; + MaxVisibleColumns?: number | undefined; + + /** + *

Configures the display options for each small multiples panel.

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

The properties of a small multiples X axis.

+ * @public + */ + XAxis?: SmallMultiplesAxisProperties | undefined; + + /** + *

The properties of a small multiples Y axis.

+ * @public + */ + YAxis?: SmallMultiplesAxisProperties | undefined; } /** * @public * @enum */ -export const SelectedTooltipType = { - BASIC: "BASIC", - DETAILED: "DETAILED", +export const OtherCategories = { + EXCLUDE: "EXCLUDE", + INCLUDE: "INCLUDE", } as const; /** * @public */ -export type SelectedTooltipType = (typeof SelectedTooltipType)[keyof typeof SelectedTooltipType]; +export type OtherCategories = (typeof OtherCategories)[keyof typeof OtherCategories]; /** - *

The display options for the visual tooltip.

+ *

The limit configuration of the visual display for an axis.

* @public */ -export interface TooltipOptions { +export interface ItemsLimitConfiguration { /** - *

Determines whether or not the tooltip is visible.

+ *

The limit on how many items of a field are showed in the chart. For + * example, the number of slices that are displayed in a pie chart.

* @public */ - TooltipVisibility?: Visibility | undefined; + ItemsLimit?: number | undefined; /** - *

The selected type for the tooltip. Choose one of the following options:

+ *

The Show + * other of an axis in the chart. Choose one of the following options:

*
    *
  • *

    - * BASIC: A basic tooltip.

    + * INCLUDE + *

    *
  • *
  • *

    - * DETAILED: A detailed tooltip.

    + * EXCLUDE + *

    *
  • *
* @public */ - SelectedTooltipType?: SelectedTooltipType | undefined; - - /** - *

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

- * @public - */ - FieldBasedTooltip?: FieldBasedTooltip | undefined; + OtherCategories?: OtherCategories | undefined; } /** - * @public - * @enum - */ -export const PivotTableDataPathType = { - COUNT_METRIC_COLUMN: "COUNT_METRIC_COLUMN", - EMPTY_COLUMN_HEADER: "EMPTY_COLUMN_HEADER", - HIERARCHY_ROWS_LAYOUT_COLUMN: "HIERARCHY_ROWS_LAYOUT_COLUMN", - MULTIPLE_ROW_METRICS_COLUMN: "MULTIPLE_ROW_METRICS_COLUMN", -} as const; - -/** + *

The sort configuration for a field in a + * field well.

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

The sort configuration target field.

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

The type of the data path value.

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

The type of data path value utilized in a pivot table. Choose one of the following options:

+ *

The sort direction. Choose one of the following + * options:

*
    *
  • *

    - * HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY.

    - *
  • - *
  • - *

    - * MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.

    - *
  • - *
  • - *

    - * EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.

    + * ASC: Ascending

    *
  • *
  • *

    - * COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell.

    + * DESC: Descending

    *
  • *
* @public */ - PivotTableDataPathType?: PivotTableDataPathType | undefined; + Direction: SortDirection | undefined; } /** - *

The data path that needs to be sorted.

+ *

The field sort options in a chart configuration.

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

The field ID of the field that needs to be sorted.

- * @public - */ - FieldId?: string | undefined; - +export interface FieldSortOptions { /** - *

The actual value of the field that needs to be sorted.

+ *

The sort configuration for a field in a field well.

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

The type configuration of the field.

+ *

The sort configuration for a column that is not used in a field well.

* @public */ - DataPathType?: DataPathType | undefined; + ColumnSort?: ColumnSort | undefined; } /** - *

The color map that determines the color options for a particular element.

+ *

sort-configuration-description

* @public */ -export interface DataPathColor { +export interface BarChartSortConfiguration { /** - *

The element that the color needs to be applied to.

+ *

The sort configuration of category fields.

* @public */ - Element: DataPathValue | undefined; + CategorySort?: FieldSortOptions[] | undefined; /** - *

The color that needs to be applied to the element.

+ *

The limit on the number of categories displayed in a bar chart.

* @public */ - Color: string | undefined; + CategoryItemsLimit?: ItemsLimitConfiguration | undefined; /** - *

The time granularity of the field that the color needs to be applied to.

+ *

The sort configuration of color fields in a bar chart.

* @public */ - TimeGranularity?: TimeGranularity | undefined; -} + ColorSort?: FieldSortOptions[] | undefined; -/** - *

The visual display options for the visual palette.

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

The chart color options for the visual palette.

+ *

The limit on the number of values displayed in a bar chart.

* @public */ - ChartColor?: string | undefined; + ColorItemsLimit?: ItemsLimitConfiguration | undefined; /** - *

The color map options for the visual palette.

+ *

The sort configuration of the small multiples field.

* @public */ - ColorMap?: DataPathColor[] | undefined; + SmallMultiplesSort?: FieldSortOptions[] | undefined; + + /** + *

The limit on the number of small multiples panels that are displayed.

+ * @public + */ + SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration | undefined; } /** - *

The configuration of a BarChartVisual.

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

The field wells of the visual.

- * @public - */ - FieldWells?: BarChartFieldWells | undefined; +export const TooltipTarget = { + BAR: "BAR", + BOTH: "BOTH", + LINE: "LINE", +} as const; - /** - *

The sort configuration of a BarChartVisual.

- * @public - */ - SortConfiguration?: BarChartSortConfiguration | undefined; +/** + * @public + */ +export type TooltipTarget = (typeof TooltipTarget)[keyof typeof TooltipTarget]; +/** + *

The tooltip item for the columns that are not part of a field well.

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

The orientation of the bars in a bar chart visual. There are two valid values in this structure:

- *
    - *
  • - *

    - * HORIZONTAL: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.

    - *
  • - *
  • - *

    - * VERTICAL: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.

    - *
  • - *
+ *

The target column of the tooltip item.

* @public */ - Orientation?: BarChartOrientation | undefined; + Column: ColumnIdentifier | undefined; /** - *

Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.

+ *

The label of the tooltip item.

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

The palette (chart color) display setup of the visual.

+ *

The visibility of the tooltip item.

* @public */ - VisualPalette?: VisualPalette | undefined; + Visibility?: Visibility | undefined; /** - *

The small multiples setup for the visual.

+ *

The aggregation function of the column tooltip item.

* @public */ - SmallMultiplesOptions?: SmallMultiplesOptions | undefined; + Aggregation?: AggregationFunction | undefined; /** - *

The label display options (grid line, range, scale, axis step) for bar chart category.

+ *

Determines the target of the column tooltip item in a combo chart visual.

* @public */ - CategoryAxis?: AxisDisplayOptions | undefined; + TooltipTarget?: TooltipTarget | undefined; +} +/** + *

The tooltip item for the fields.

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

The label options (label text, label visibility and sort icon visibility) for a bar chart.

+ *

The unique ID of the field that is targeted by the tooltip.

* @public */ - CategoryLabelOptions?: ChartAxisLabelOptions | undefined; + FieldId: string | undefined; /** - *

The label display options (grid line, range, scale, axis step) for a bar chart value.

+ *

The label of the tooltip item.

* @public */ - ValueAxis?: AxisDisplayOptions | undefined; + Label?: string | undefined; /** - *

The label options (label text, label visibility and sort icon visibility) for a bar chart value.

+ *

The visibility of the tooltip item.

* @public */ - ValueLabelOptions?: ChartAxisLabelOptions | undefined; + Visibility?: Visibility | undefined; /** - *

The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

+ *

Determines the target of the field tooltip item in a combo chart visual.

* @public */ - ColorLabelOptions?: ChartAxisLabelOptions | undefined; + TooltipTarget?: TooltipTarget | undefined; +} +/** + *

The tooltip.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The legend display setup of the visual.

+ *

The tooltip item for the fields.

* @public */ - Legend?: LegendOptions | undefined; + FieldTooltipItem?: FieldTooltipItem | undefined; /** - *

The options that determine if visual data labels are displayed.

+ *

The tooltip item for the columns that are not part of a field well.

* @public */ - DataLabels?: DataLabelOptions | undefined; + ColumnTooltipItem?: ColumnTooltipItem | undefined; +} + +/** + * @public + * @enum + */ +export const TooltipTitleType = { + NONE: "NONE", + PRIMARY_VALUE: "PRIMARY_VALUE", +} as const; + +/** + * @public + */ +export type TooltipTitleType = (typeof TooltipTitleType)[keyof typeof TooltipTitleType]; +/** + *

The setup for the detailed tooltip.

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

The tooltip display setup of the visual.

+ *

The visibility of Show aggregations.

* @public */ - Tooltip?: TooltipOptions | undefined; + AggregationVisibility?: Visibility | undefined; /** - *

The reference line setup of the visual.

+ *

The type for the >tooltip title. Choose one of the following options:

+ *
    + *
  • + *

    + * NONE: Doesn't use the primary value as the title.

    + *
  • + *
  • + *

    + * PRIMARY_VALUE: Uses primary value as the title.

    + *
  • + *
* @public */ - ReferenceLines?: ReferenceLine[] | undefined; + TooltipTitleType?: TooltipTitleType | undefined; /** - *

The contribution analysis (anomaly configuration) setup of the visual.

+ *

The fields configuration in the + * tooltip.

* @public */ - ContributionAnalysisDefaults?: ContributionAnalysisDefault[] | undefined; - - /** - *

The general visual interactions setup for a visual.

- * @public - */ - Interactions?: VisualInteractionOptions | undefined; + TooltipFields?: TooltipItem[] | undefined; } /** - *

The category drill down filter.

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

The column that the filter is applied to.

- * @public - */ - Column: ColumnIdentifier | undefined; +export const SelectedTooltipType = { + BASIC: "BASIC", + DETAILED: "DETAILED", +} as const; - /** - *

A list of the string inputs that are the values of the category drill down filter.

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

The numeric equality type drill down filter.

+ *

The display options for the visual tooltip.

* @public */ -export interface NumericEqualityDrillDownFilter { +export interface TooltipOptions { /** - *

The column that the filter is applied to.

+ *

Determines whether or not the tooltip is visible.

* @public */ - Column: ColumnIdentifier | undefined; + TooltipVisibility?: Visibility | undefined; /** - *

The value of the double input numeric drill down filter.

+ *

The selected type for the tooltip. Choose one of the following options:

+ *
    + *
  • + *

    + * BASIC: A basic tooltip.

    + *
  • + *
  • + *

    + * DETAILED: A detailed tooltip.

    + *
  • + *
* @public */ - Value: number | undefined; + SelectedTooltipType?: SelectedTooltipType | undefined; + + /** + *

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

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

The time range drill down filter.

* @public + * @enum */ -export interface TimeRangeDrillDownFilter { +export const PivotTableDataPathType = { + COUNT_METRIC_COLUMN: "COUNT_METRIC_COLUMN", + EMPTY_COLUMN_HEADER: "EMPTY_COLUMN_HEADER", + HIERARCHY_ROWS_LAYOUT_COLUMN: "HIERARCHY_ROWS_LAYOUT_COLUMN", + MULTIPLE_ROW_METRICS_COLUMN: "MULTIPLE_ROW_METRICS_COLUMN", +} as const; + +/** + * @public + */ +export type PivotTableDataPathType = (typeof PivotTableDataPathType)[keyof typeof PivotTableDataPathType]; + +/** + *

The type of the data path value.

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

The column that the filter is applied to.

+ *

The type of data path value utilized in a pivot table. Choose one of the following options:

+ *
    + *
  • + *

    + * HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY.

    + *
  • + *
  • + *

    + * MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.

    + *
  • + *
  • + *

    + * EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.

    + *
  • + *
  • + *

    + * COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell.

    + *
  • + *
* @public */ - Column: ColumnIdentifier | undefined; + PivotTableDataPathType?: PivotTableDataPathType | undefined; +} +/** + *

The data path that needs to be sorted.

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

The minimum value for the filter value range.

+ *

The field ID of the field that needs to be sorted.

* @public */ - RangeMinimum: Date | undefined; + FieldId?: string | undefined; /** - *

The maximum value for the filter value range.

+ *

The actual value of the field that needs to be sorted.

* @public */ - RangeMaximum: Date | undefined; + FieldValue?: string | undefined; /** - *

The level of time precision that is used to aggregate DateTime values.

+ *

The type configuration of the field.

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

The drill down filter for the column hierarchies.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

+ *

The color map that determines the color options for a particular element.

* @public */ -export interface DrillDownFilter { +export interface DataPathColor { /** - *

The numeric equality type drill down filter. This filter is used for number type columns.

+ *

The element that the color needs to be applied to.

* @public */ - NumericEqualityFilter?: NumericEqualityDrillDownFilter | undefined; + Element: DataPathValue | undefined; /** - *

The category type drill down filter. This filter is used for string type columns.

+ *

The color that needs to be applied to the element.

* @public */ - CategoryFilter?: CategoryDrillDownFilter | undefined; + Color: string | undefined; /** - *

The time range drill down filter. This filter is used for date time columns.

+ *

The time granularity of the field that the color needs to be applied to.

* @public */ - TimeRangeFilter?: TimeRangeDrillDownFilter | undefined; + TimeGranularity?: TimeGranularity | undefined; } /** - *

The option that determines the hierarchy of any DateTime fields.

+ *

The visual display options for the visual palette.

* @public */ -export interface DateTimeHierarchy { +export interface VisualPalette { /** - *

The hierarchy ID of the DateTime hierarchy.

+ *

The chart color options for the visual palette.

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

The option that determines the drill down filters for the - * DateTime hierarchy.

+ *

The color map options for the visual palette.

* @public */ - DrillDownFilters?: DrillDownFilter[] | undefined; + ColorMap?: DataPathColor[] | undefined; } /** - *

The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.

+ *

The configuration of a BarChartVisual.

* @public */ -export interface ExplicitHierarchy { +export interface BarChartConfiguration { /** - *

The hierarchy ID of the explicit hierarchy.

+ *

The field wells of the visual.

* @public */ - HierarchyId: string | undefined; + FieldWells?: BarChartFieldWells | undefined; /** - *

The list of columns that define the explicit hierarchy.

+ *

The sort configuration of a BarChartVisual.

* @public */ - Columns: ColumnIdentifier[] | undefined; + SortConfiguration?: BarChartSortConfiguration | undefined; /** - *

The option that determines the drill down filters for the explicit hierarchy.

+ *

The orientation of the bars in a bar chart visual. There are two valid values in this structure:

+ *
    + *
  • + *

    + * HORIZONTAL: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.

    + *
  • + *
  • + *

    + * VERTICAL: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.

    + *
  • + *
* @public */ - DrillDownFilters?: DrillDownFilter[] | undefined; -} + Orientation?: BarChartOrientation | undefined; -/** - *

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

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

The hierarchy ID of the predefined hierarchy.

+ *

Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.

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

The list of columns that define the predefined hierarchy.

+ *

The palette (chart color) display setup of the visual.

* @public */ - Columns: ColumnIdentifier[] | undefined; + VisualPalette?: VisualPalette | undefined; /** - *

The option that determines the drill down filters for the predefined hierarchy.

+ *

The small multiples setup for the visual.

* @public */ - DrillDownFilters?: DrillDownFilter[] | undefined; -} + SmallMultiplesOptions?: SmallMultiplesOptions | undefined; -/** - *

The option that determines the hierarchy of the fields for a visual element.

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

The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.

+ *

The label display options (grid line, range, scale, axis step) for bar chart category.

* @public */ - ExplicitHierarchy?: ExplicitHierarchy | undefined; + CategoryAxis?: AxisDisplayOptions | undefined; /** - *

The option that determines the hierarchy of any DateTime fields.

+ *

The label options (label text, label visibility and sort icon visibility) for a bar chart.

* @public */ - DateTimeHierarchy?: DateTimeHierarchy | undefined; + CategoryLabelOptions?: ChartAxisLabelOptions | undefined; /** - *

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

+ *

The label display options (grid line, range, scale, axis step) for a bar chart value.

* @public */ - PredefinedHierarchy?: PredefinedHierarchy | undefined; -} + ValueAxis?: AxisDisplayOptions | undefined; -/** - *

The text format for a subtitle.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

Plain text format.

+ *

The label options (label text, label visibility and sort icon visibility) for a bar chart value.

* @public */ - PlainText?: string | undefined; + ValueLabelOptions?: ChartAxisLabelOptions | undefined; /** - *

Rich text. Examples of rich text include bold, underline, and italics.

+ *

The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

* @public */ - RichText?: string | undefined; -} + ColorLabelOptions?: ChartAxisLabelOptions | undefined; -/** - *

The subtitle label options for a visual.

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

The visibility of the subtitle label.

+ *

The legend display setup of the visual.

* @public */ - Visibility?: Visibility | undefined; + Legend?: LegendOptions | undefined; /** - *

The long text format of the subtitle label, such as plain text or rich text.

+ *

The options that determine if visual data labels are displayed.

* @public */ - FormatText?: LongFormatText | undefined; -} + DataLabels?: DataLabelOptions | undefined; -/** - *

The text format for the title.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

Plain text format.

+ *

The tooltip display setup of the visual.

* @public */ - PlainText?: string | undefined; + Tooltip?: TooltipOptions | undefined; /** - *

Rich text. Examples of rich text include bold, underline, and italics.

+ *

The reference line setup of the visual.

* @public */ - RichText?: string | undefined; -} + ReferenceLines?: ReferenceLine[] | undefined; -/** - *

The title label options for a visual.

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

The visibility of the title label.

+ *

The contribution analysis (anomaly configuration) setup of the visual.

* @public */ - Visibility?: Visibility | undefined; + ContributionAnalysisDefaults?: ContributionAnalysisDefault[] | undefined; /** - *

The short text format of the title label, such as plain text or rich text.

+ *

The general visual interactions setup for a visual.

* @public */ - FormatText?: ShortFormatText | undefined; + Interactions?: VisualInteractionOptions | undefined; } /** - *

A bar chart.

- *

The BarChartVisual structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:

- *
    - *
  • - *

    Horizontal bar chart

    - *
  • - *
  • - *

    Vertical bar chart

    - *
  • - *
  • - *

    Horizontal stacked bar chart

    - *
  • - *
  • - *

    Vertical stacked bar chart

    - *
  • - *
  • - *

    Horizontal stacked 100% bar chart

    - *
  • - *
  • - *

    Vertical stacked 100% bar chart

    - *
  • - *
- *

For more information, see Using bar charts in the Amazon QuickSight User Guide.

+ *

The category drill down filter.

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

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

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

The title that is displayed on the visual.

- * @public - */ - Title?: VisualTitleLabelOptions | undefined; - +export interface CategoryDrillDownFilter { /** - *

The subtitle that is displayed on the visual.

+ *

The column that the filter is applied to.

* @public */ - Subtitle?: VisualSubtitleLabelOptions | undefined; + Column: ColumnIdentifier | undefined; /** - *

The configuration settings of the visual.

+ *

A list of the string inputs that are the values of the category drill down filter.

* @public */ - ChartConfiguration?: BarChartConfiguration | undefined; + CategoryValues: string[] | undefined; +} +/** + *

The numeric equality type drill down filter.

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

The list of custom actions that are configured for a visual.

+ *

The column that the filter is applied to.

* @public */ - Actions?: VisualCustomAction[] | undefined; + Column: ColumnIdentifier | undefined; /** - *

The column hierarchy that is used during drill-downs and drill-ups.

+ *

The value of the double input numeric drill down filter.

* @public */ - ColumnHierarchies?: ColumnHierarchy[] | undefined; + Value: number | undefined; } /** - * @public - * @enum - */ -export const BoxPlotFillStyle = { - SOLID: "SOLID", - TRANSPARENT: "TRANSPARENT", -} as const; - -/** - * @public - */ -export type BoxPlotFillStyle = (typeof BoxPlotFillStyle)[keyof typeof BoxPlotFillStyle]; - -/** - *

The style options of the box plot.

+ *

The time range drill down filter.

* @public */ -export interface BoxPlotStyleOptions { +export interface TimeRangeDrillDownFilter { /** - *

The fill styles (solid, transparent) of the box plot.

+ *

The column that the filter is applied to.

* @public */ - FillStyle?: BoxPlotFillStyle | undefined; -} + Column: ColumnIdentifier | undefined; -/** - *

The options of a box plot visual.

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

The style options of the box plot.

+ *

The minimum value for the filter value range.

* @public */ - StyleOptions?: BoxPlotStyleOptions | undefined; + RangeMinimum: Date | undefined; /** - *

Determines the visibility of the outlier in a box plot.

+ *

The maximum value for the filter value range.

* @public */ - OutlierVisibility?: Visibility | undefined; + RangeMaximum: Date | undefined; /** - *

Determines the visibility of all data points of the box plot.

+ *

The level of time precision that is used to aggregate DateTime values.

* @public */ - AllDataPointsVisibility?: Visibility | undefined; + TimeGranularity: TimeGranularity | undefined; } /** - *

The aggregated field well for a box plot.

+ *

The drill down filter for the column hierarchies.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

* @public */ -export interface BoxPlotAggregatedFieldWells { +export interface DrillDownFilter { /** - *

The group by field well of a box plot chart. Values are grouped based on group by fields.

+ *

The numeric equality type drill down filter. This filter is used for number type columns.

* @public */ - GroupBy?: DimensionField[] | undefined; + NumericEqualityFilter?: NumericEqualityDrillDownFilter | undefined; /** - *

The value field well of a box plot chart. Values are aggregated based on group by fields.

+ *

The category type drill down filter. This filter is used for string type columns.

* @public */ - Values?: MeasureField[] | undefined; -} + CategoryFilter?: CategoryDrillDownFilter | undefined; -/** - *

The field wells of a BoxPlotVisual.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The aggregated field wells of a box plot.

+ *

The time range drill down filter. This filter is used for date time columns.

* @public */ - BoxPlotAggregatedFieldWells?: BoxPlotAggregatedFieldWells | undefined; + TimeRangeFilter?: TimeRangeDrillDownFilter | undefined; } /** - *

The pagination configuration for a table visual or boxplot.

+ *

The option that determines the hierarchy of any DateTime fields.

* @public */ -export interface PaginationConfiguration { +export interface DateTimeHierarchy { /** - *

Indicates how many items render in one page.

+ *

The hierarchy ID of the DateTime hierarchy.

* @public */ - PageSize: number | undefined; + HierarchyId: string | undefined; /** - *

Indicates the page number.

+ *

The option that determines the drill down filters for the + * DateTime hierarchy.

* @public */ - PageNumber: number | undefined; + DrillDownFilters?: DrillDownFilter[] | undefined; } /** - *

The sort configuration of a BoxPlotVisual.

+ *

The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.

* @public */ -export interface BoxPlotSortConfiguration { +export interface ExplicitHierarchy { /** - *

The sort configuration of a group by fields.

+ *

The hierarchy ID of the explicit hierarchy.

* @public */ - CategorySort?: FieldSortOptions[] | undefined; + HierarchyId: string | undefined; /** - *

The pagination configuration of a table visual or box plot.

+ *

The list of columns that define the explicit hierarchy.

* @public */ - PaginationConfiguration?: PaginationConfiguration | undefined; + Columns: ColumnIdentifier[] | undefined; + + /** + *

The option that determines the drill down filters for the explicit hierarchy.

+ * @public + */ + DrillDownFilters?: DrillDownFilter[] | undefined; } /** - *

The configuration of a BoxPlotVisual.

+ *

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

* @public */ -export interface BoxPlotChartConfiguration { +export interface PredefinedHierarchy { /** - *

The field wells of the visual.

+ *

The hierarchy ID of the predefined hierarchy.

* @public */ - FieldWells?: BoxPlotFieldWells | undefined; + HierarchyId: string | undefined; /** - *

The sort configuration of a BoxPlotVisual.

+ *

The list of columns that define the predefined hierarchy.

* @public */ - SortConfiguration?: BoxPlotSortConfiguration | undefined; + Columns: ColumnIdentifier[] | undefined; /** - *

The box plot chart options for a box plot visual

+ *

The option that determines the drill down filters for the predefined hierarchy.

* @public */ - BoxPlotOptions?: BoxPlotOptions | undefined; + DrillDownFilters?: DrillDownFilter[] | undefined; +} +/** + *

The option that determines the hierarchy of the fields for a visual element.

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

The label display options (grid line, range, scale, axis step) of a box plot category.

+ *

The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.

* @public */ - CategoryAxis?: AxisDisplayOptions | undefined; + ExplicitHierarchy?: ExplicitHierarchy | undefined; /** - *

The label options (label text, label visibility and sort Icon visibility) of a box plot category.

+ *

The option that determines the hierarchy of any DateTime fields.

* @public */ - CategoryLabelOptions?: ChartAxisLabelOptions | undefined; + DateTimeHierarchy?: DateTimeHierarchy | undefined; /** - *

The label display options (grid line, range, scale, axis step) of a box plot category.

+ *

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

* @public */ - PrimaryYAxisDisplayOptions?: AxisDisplayOptions | undefined; + PredefinedHierarchy?: PredefinedHierarchy | undefined; +} +/** + *

The text format for a subtitle.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The label options (label text, label visibility and sort icon visibility) of a box plot value.

+ *

Plain text format.

* @public */ - PrimaryYAxisLabelOptions?: ChartAxisLabelOptions | undefined; + PlainText?: string | undefined; /** - *

The options for the legend setup of a visual.

+ *

Rich text. Examples of rich text include bold, underline, and italics.

* @public */ - Legend?: LegendOptions | undefined; + RichText?: string | undefined; +} +/** + *

The subtitle label options for a visual.

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

The tooltip display setup of the visual.

+ *

The visibility of the subtitle label.

* @public */ - Tooltip?: TooltipOptions | undefined; + Visibility?: Visibility | undefined; /** - *

The reference line setup of the visual.

+ *

The long text format of the subtitle label, such as plain text or rich text.

* @public */ - ReferenceLines?: ReferenceLine[] | undefined; + FormatText?: LongFormatText | undefined; +} +/** + *

The text format for the title.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The palette (chart color) display setup of the visual.

+ *

Plain text format.

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

The general visual interactions setup for a visual.

+ *

Rich text. Examples of rich text include bold, underline, and italics.

* @public */ - Interactions?: VisualInteractionOptions | undefined; + RichText?: string | undefined; } /** - *

A box plot.

- *

For more information, see Using box plots in the Amazon QuickSight User Guide.

+ *

The title label options for a visual.

* @public */ -export interface BoxPlotVisual { +export interface VisualTitleLabelOptions { /** - *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

+ *

The visibility of the title label.

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

The title that is displayed on the visual.

+ *

The short text format of the title label, such as plain text or rich text.

* @public */ - Title?: VisualTitleLabelOptions | undefined; - - /** - *

The subtitle that is displayed on the visual.

- * @public - */ - Subtitle?: VisualSubtitleLabelOptions | undefined; - - /** - *

The configuration settings of the visual.

- * @public - */ - ChartConfiguration?: BoxPlotChartConfiguration | undefined; + FormatText?: ShortFormatText | undefined; +} +/** + *

A bar chart.

+ *

The BarChartVisual structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:

+ *
    + *
  • + *

    Horizontal bar chart

    + *
  • + *
  • + *

    Vertical bar chart

    + *
  • + *
  • + *

    Horizontal stacked bar chart

    + *
  • + *
  • + *

    Vertical stacked bar chart

    + *
  • + *
  • + *

    Horizontal stacked 100% bar chart

    + *
  • + *
  • + *

    Vertical stacked 100% bar chart

    + *
  • + *
+ *

For more information, see Using bar charts in the Amazon QuickSight User Guide.

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

The list of custom actions that are configured for a visual.

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

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

The column hierarchy that is used during drill-downs and drill-ups.

+ *

The title that is displayed on the visual.

* @public */ - ColumnHierarchies?: ColumnHierarchy[] | undefined; -} + Title?: VisualTitleLabelOptions | undefined; -/** - *

The aggregated field wells of a combo chart.

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

The aggregated category field wells of a combo chart.

+ *

The subtitle that is displayed on the visual.

* @public */ - Category?: DimensionField[] | undefined; + Subtitle?: VisualSubtitleLabelOptions | undefined; /** - *

The aggregated BarValues field well of a combo chart.

+ *

The configuration settings of the visual.

* @public */ - BarValues?: MeasureField[] | undefined; + ChartConfiguration?: BarChartConfiguration | undefined; /** - *

The aggregated colors field well of a combo chart.

+ *

The list of custom actions that are configured for a visual.

* @public */ - Colors?: DimensionField[] | undefined; + Actions?: VisualCustomAction[] | undefined; /** - *

The aggregated LineValues field well of a combo chart.

+ *

The column hierarchy that is used during drill-downs and drill-ups.

* @public */ - LineValues?: MeasureField[] | undefined; -} + ColumnHierarchies?: ColumnHierarchy[] | undefined; -/** - *

The field wells of the visual.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.

+ *

The alt text for the visual.

* @public */ - ComboChartAggregatedFieldWells?: ComboChartAggregatedFieldWells | undefined; + VisualContentAltText?: string | undefined; } /** * @public * @enum */ -export const SingleYAxisOption = { - PRIMARY_Y_AXIS: "PRIMARY_Y_AXIS", +export const BoxPlotFillStyle = { + SOLID: "SOLID", + TRANSPARENT: "TRANSPARENT", } as const; /** * @public */ -export type SingleYAxisOption = (typeof SingleYAxisOption)[keyof typeof SingleYAxisOption]; +export type BoxPlotFillStyle = (typeof BoxPlotFillStyle)[keyof typeof BoxPlotFillStyle]; /** - *

The options that are available for a single Y axis in a chart.

+ *

The style options of the box plot.

* @public */ -export interface YAxisOptions { +export interface BoxPlotStyleOptions { /** - *

The Y axis type to be used in the chart.

- *

If you choose PRIMARY_Y_AXIS, the primary Y Axis is located on the leftmost vertical axis of the chart.

+ *

The fill styles (solid, transparent) of the box plot.

* @public */ - YAxis: SingleYAxisOption | undefined; + FillStyle?: BoxPlotFillStyle | undefined; } /** - *

The settings of a chart's single axis configuration.

+ *

The options of a box plot visual.

* @public */ -export interface SingleAxisOptions { +export interface BoxPlotOptions { /** - *

The Y axis options of a single axis configuration.

+ *

The style options of the box plot.

* @public */ - YAxisOptions?: YAxisOptions | undefined; -} + StyleOptions?: BoxPlotStyleOptions | undefined; -/** - *

The sort configuration of a ComboChartVisual.

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

The sort configuration of the category field well in a combo chart.

+ *

Determines the visibility of the outlier in a box plot.

* @public */ - CategorySort?: FieldSortOptions[] | undefined; + OutlierVisibility?: Visibility | undefined; /** - *

The item limit configuration for the category field well of a combo chart.

+ *

Determines the visibility of all data points of the box plot.

* @public */ - CategoryItemsLimit?: ItemsLimitConfiguration | undefined; + AllDataPointsVisibility?: Visibility | undefined; +} +/** + *

The aggregated field well for a box plot.

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

The sort configuration of the color field well in a combo chart.

+ *

The group by field well of a box plot chart. Values are grouped based on group by fields.

* @public */ - ColorSort?: FieldSortOptions[] | undefined; + GroupBy?: DimensionField[] | undefined; /** - *

The item limit configuration of the color field well in a combo chart.

+ *

The value field well of a box plot chart. Values are aggregated based on group by fields.

* @public */ - ColorItemsLimit?: ItemsLimitConfiguration | undefined; + Values?: MeasureField[] | undefined; } /** - *

The configuration of a ComboChartVisual.

+ *

The field wells of a BoxPlotVisual.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The field wells of the visual.

- * @public - */ - FieldWells?: ComboChartFieldWells | undefined; - +export interface BoxPlotFieldWells { /** - *

The sort configuration of a ComboChartVisual.

+ *

The aggregated field wells of a box plot.

* @public */ - SortConfiguration?: ComboChartSortConfiguration | undefined; + BoxPlotAggregatedFieldWells?: BoxPlotAggregatedFieldWells | undefined; +} +/** + *

The pagination configuration for a table visual or boxplot.

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

Determines the bar arrangement in a combo chart. The following are valid values in this structure:

- *
    - *
  • - *

    - * CLUSTERED: For clustered bar combo charts.

    - *
  • - *
  • - *

    - * STACKED: For stacked bar combo charts.

    - *
  • - *
  • - *

    - * STACKED_PERCENT: Do not use. If you use this value, the operation returns a validation error.

    - *
  • - *
+ *

Indicates how many items render in one page.

* @public */ - BarsArrangement?: BarsArrangement | undefined; + PageSize: number | undefined; /** - *

The category axis of a combo chart.

+ *

Indicates the page number.

* @public */ - CategoryAxis?: AxisDisplayOptions | undefined; + PageNumber: number | undefined; +} +/** + *

The sort configuration of a BoxPlotVisual.

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

The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

+ *

The sort configuration of a group by fields.

* @public */ - CategoryLabelOptions?: ChartAxisLabelOptions | undefined; + CategorySort?: FieldSortOptions[] | undefined; /** - *

The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.

+ *

The pagination configuration of a table visual or box plot.

* @public */ - PrimaryYAxisDisplayOptions?: AxisDisplayOptions | undefined; + PaginationConfiguration?: PaginationConfiguration | undefined; +} +/** + *

The configuration of a BoxPlotVisual.

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

The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.

+ *

The field wells of the visual.

* @public */ - PrimaryYAxisLabelOptions?: ChartAxisLabelOptions | undefined; + FieldWells?: BoxPlotFieldWells | undefined; /** - *

The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.

+ *

The sort configuration of a BoxPlotVisual.

* @public */ - SecondaryYAxisDisplayOptions?: AxisDisplayOptions | undefined; + SortConfiguration?: BoxPlotSortConfiguration | undefined; /** - *

The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.

+ *

The box plot chart options for a box plot visual

* @public */ - SecondaryYAxisLabelOptions?: ChartAxisLabelOptions | undefined; + BoxPlotOptions?: BoxPlotOptions | undefined; /** - *

The settings of a chart's single axis configuration.

+ *

The label display options (grid line, range, scale, axis step) of a box plot category.

* @public */ - SingleAxisOptions?: SingleAxisOptions | undefined; + CategoryAxis?: AxisDisplayOptions | undefined; /** - *

The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.

+ *

The label options (label text, label visibility and sort Icon visibility) of a box plot category.

* @public */ - ColorLabelOptions?: ChartAxisLabelOptions | undefined; + CategoryLabelOptions?: ChartAxisLabelOptions | undefined; /** - *

The legend display setup of the visual.

+ *

The label display options (grid line, range, scale, axis step) of a box plot category.

* @public */ - Legend?: LegendOptions | undefined; + PrimaryYAxisDisplayOptions?: AxisDisplayOptions | undefined; /** - *

The options that determine if visual data labels are displayed.

- *

The data label options for a bar in a combo chart.

+ *

The label options (label text, label visibility and sort icon visibility) of a box plot value.

* @public */ - BarDataLabels?: DataLabelOptions | undefined; + PrimaryYAxisLabelOptions?: ChartAxisLabelOptions | undefined; /** - *

The options that determine if visual data labels are displayed.

- *

The data label options for a line in a combo chart.

+ *

The options for the legend setup of a visual.

* @public */ - LineDataLabels?: DataLabelOptions | undefined; + Legend?: LegendOptions | undefined; /** - *

The legend display setup of the visual.

+ *

The tooltip display setup of the visual.

* @public */ Tooltip?: TooltipOptions | undefined; @@ -1402,14 +1499,13 @@ export interface ComboChartConfiguration { } /** - *

A combo chart.

- *

The ComboChartVisual includes stacked bar combo charts and clustered bar combo charts

- *

For more information, see Using combo charts in the Amazon QuickSight User Guide.

+ *

A box plot.

+ *

For more information, see Using box plots in the Amazon QuickSight User Guide.

* @public */ -export interface ComboChartVisual { +export interface BoxPlotVisual { /** - *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

* @public */ VisualId: string | undefined; @@ -1430,7 +1526,7 @@ export interface ComboChartVisual { *

The configuration settings of the visual.

* @public */ - ChartConfiguration?: ComboChartConfiguration | undefined; + ChartConfiguration?: BoxPlotChartConfiguration | undefined; /** *

The list of custom actions that are configured for a visual.

@@ -1443,471 +1539,264 @@ export interface ComboChartVisual { * @public */ ColumnHierarchies?: ColumnHierarchy[] | undefined; -} -/** - * @public - * @enum - */ -export const CustomContentType = { - IMAGE: "IMAGE", - OTHER_EMBEDDED_CONTENT: "OTHER_EMBEDDED_CONTENT", -} as const; + /** + *

The alt text for the visual.

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

The aggregated field wells of a combo chart.

* @public */ -export type CustomContentType = (typeof CustomContentType)[keyof typeof CustomContentType]; - -/** - * @public - * @enum - */ -export const CustomContentImageScalingConfiguration = { - DO_NOT_SCALE: "DO_NOT_SCALE", - FIT_TO_HEIGHT: "FIT_TO_HEIGHT", - FIT_TO_WIDTH: "FIT_TO_WIDTH", - SCALE_TO_VISUAL: "SCALE_TO_VISUAL", -} as const; - -/** - * @public - */ -export type CustomContentImageScalingConfiguration = - (typeof CustomContentImageScalingConfiguration)[keyof typeof CustomContentImageScalingConfiguration]; - -/** - *

The configuration of a CustomContentVisual.

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

The input URL that links to the custom content that you want in the custom visual.

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

The content type of the custom content visual. You can use this to have the visual render as an image.

- * @public - */ - ContentType?: CustomContentType | undefined; - - /** - *

The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.

- * @public - */ - ImageScaling?: CustomContentImageScalingConfiguration | undefined; - - /** - *

The general visual interactions setup for a visual.

- * @public - */ - Interactions?: VisualInteractionOptions | undefined; -} - -/** - *

A visual that contains custom content.

- *

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

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

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

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

The title that is displayed on the visual.

- * @public - */ - Title?: VisualTitleLabelOptions | undefined; - - /** - *

The subtitle that is displayed on the visual.

- * @public - */ - Subtitle?: VisualSubtitleLabelOptions | undefined; - - /** - *

The configuration of a CustomContentVisual.

- * @public - */ - ChartConfiguration?: CustomContentConfiguration | undefined; - - /** - *

The list of custom actions that are configured for a visual.

- * @public - */ - Actions?: VisualCustomAction[] | undefined; - - /** - *

The dataset that is used to create the custom content visual. You can't create a visual without a dataset.

- * @public - */ - DataSetIdentifier: string | undefined; -} - -/** - *

An empty visual.

- *

Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Amazon QuickSight console is considered an EmptyVisual until a visual type is selected.

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

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

- * @public - */ - VisualId: string | undefined; - +export interface ComboChartAggregatedFieldWells { /** - *

The data set that is used in the empty visual. Every visual requires a dataset to render.

+ *

The aggregated category field wells of a combo chart.

* @public */ - DataSetIdentifier: string | undefined; + Category?: DimensionField[] | undefined; /** - *

The list of custom actions that are configured for a visual.

+ *

The aggregated BarValues field well of a combo chart.

* @public */ - Actions?: VisualCustomAction[] | undefined; -} + BarValues?: MeasureField[] | undefined; -/** - *

The aggregated field well of the filled map.

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

The aggregated location field well of the filled map. Values are grouped by location fields.

+ *

The aggregated colors field well of a combo chart.

* @public */ - Geospatial?: DimensionField[] | undefined; + Colors?: DimensionField[] | undefined; /** - *

The aggregated color field well of a filled map. Values are aggregated based on location fields.

+ *

The aggregated LineValues field well of a combo chart.

* @public */ - Values?: MeasureField[] | undefined; + LineValues?: MeasureField[] | undefined; } /** - *

The field wells of a FilledMapVisual.

+ *

The field wells of the visual.

*

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

* @public */ -export interface FilledMapFieldWells { +export interface ComboChartFieldWells { /** - *

The aggregated field well of the filled map.

+ *

The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.

* @public */ - FilledMapAggregatedFieldWells?: FilledMapAggregatedFieldWells | undefined; + ComboChartAggregatedFieldWells?: ComboChartAggregatedFieldWells | undefined; } /** * @public * @enum */ -export const BaseMapStyleType = { - DARK_GRAY: "DARK_GRAY", - IMAGERY: "IMAGERY", - LIGHT_GRAY: "LIGHT_GRAY", - STREET: "STREET", +export const SingleYAxisOption = { + PRIMARY_Y_AXIS: "PRIMARY_Y_AXIS", } as const; /** * @public */ -export type BaseMapStyleType = (typeof BaseMapStyleType)[keyof typeof BaseMapStyleType]; +export type SingleYAxisOption = (typeof SingleYAxisOption)[keyof typeof SingleYAxisOption]; /** - *

The map style options of the geospatial map.

+ *

The options that are available for a single Y axis in a chart.

* @public */ -export interface GeospatialMapStyleOptions { +export interface YAxisOptions { /** - *

The base map style of the geospatial map.

+ *

The Y axis type to be used in the chart.

+ *

If you choose PRIMARY_Y_AXIS, the primary Y Axis is located on the leftmost vertical axis of the chart.

* @public */ - BaseMapStyle?: BaseMapStyleType | undefined; + YAxis: SingleYAxisOption | undefined; } /** - *

The sort configuration of a FilledMapVisual.

+ *

The settings of a chart's single axis configuration.

* @public */ -export interface FilledMapSortConfiguration { +export interface SingleAxisOptions { /** - *

The sort configuration of the location fields.

+ *

The Y axis options of a single axis configuration.

* @public */ - CategorySort?: FieldSortOptions[] | undefined; + YAxisOptions?: YAxisOptions | undefined; } /** - *

The bound - * options (north, south, west, east) of the geospatial window options.

+ *

The sort configuration of a ComboChartVisual.

* @public */ -export interface GeospatialCoordinateBounds { +export interface ComboChartSortConfiguration { /** - *

The latitude of the north bound of the geospatial coordinate bounds.

+ *

The sort configuration of the category field well in a combo chart.

* @public */ - North: number | undefined; + CategorySort?: FieldSortOptions[] | undefined; /** - *

The latitude of the south bound of the geospatial coordinate bounds.

+ *

The item limit configuration for the category field well of a combo chart.

* @public */ - South: number | undefined; + CategoryItemsLimit?: ItemsLimitConfiguration | undefined; /** - *

The longitude of the west bound of the geospatial coordinate bounds.

+ *

The sort configuration of the color field well in a combo chart.

* @public */ - West: number | undefined; + ColorSort?: FieldSortOptions[] | undefined; /** - *

The longitude of the east bound of the geospatial coordinate bounds.

+ *

The item limit configuration of the color field well in a combo chart.

* @public */ - East: number | undefined; + ColorItemsLimit?: ItemsLimitConfiguration | undefined; } /** - * @public - * @enum - */ -export const MapZoomMode = { - AUTO: "AUTO", - MANUAL: "MANUAL", -} as const; - -/** - * @public - */ -export type MapZoomMode = (typeof MapZoomMode)[keyof typeof MapZoomMode]; - -/** - *

The window options of the geospatial map visual.

+ *

The configuration of a ComboChartVisual.

* @public */ -export interface GeospatialWindowOptions { +export interface ComboChartConfiguration { /** - *

The bounds options (north, south, west, east) of the geospatial window options.

+ *

The field wells of the visual.

* @public */ - Bounds?: GeospatialCoordinateBounds | undefined; + FieldWells?: ComboChartFieldWells | undefined; /** - *

The map zoom modes (manual, auto) of the geospatial window options.

+ *

The sort configuration of a ComboChartVisual.

* @public */ - MapZoomMode?: MapZoomMode | undefined; -} + SortConfiguration?: ComboChartSortConfiguration | undefined; -/** - *

The configuration for a FilledMapVisual.

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

The field wells of the visual.

+ *

Determines the bar arrangement in a combo chart. The following are valid values in this structure:

+ *
    + *
  • + *

    + * CLUSTERED: For clustered bar combo charts.

    + *
  • + *
  • + *

    + * STACKED: For stacked bar combo charts.

    + *
  • + *
  • + *

    + * STACKED_PERCENT: Do not use. If you use this value, the operation returns a validation error.

    + *
  • + *
* @public */ - FieldWells?: FilledMapFieldWells | undefined; + BarsArrangement?: BarsArrangement | undefined; /** - *

The sort configuration of a FilledMapVisual.

+ *

The category axis of a combo chart.

* @public */ - SortConfiguration?: FilledMapSortConfiguration | undefined; + CategoryAxis?: AxisDisplayOptions | undefined; /** - *

The legend display setup of the visual.

+ *

The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

* @public */ - Legend?: LegendOptions | undefined; + CategoryLabelOptions?: ChartAxisLabelOptions | undefined; /** - *

The tooltip display setup of the visual.

+ *

The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.

* @public */ - Tooltip?: TooltipOptions | undefined; + PrimaryYAxisDisplayOptions?: AxisDisplayOptions | undefined; /** - *

The window options of the filled map visual.

+ *

The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.

* @public */ - WindowOptions?: GeospatialWindowOptions | undefined; + PrimaryYAxisLabelOptions?: ChartAxisLabelOptions | undefined; /** - *

The map style options of the filled map visual.

+ *

The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.

* @public */ - MapStyleOptions?: GeospatialMapStyleOptions | undefined; + SecondaryYAxisDisplayOptions?: AxisDisplayOptions | undefined; /** - *

The general visual interactions setup for a visual.

+ *

The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.

* @public */ - Interactions?: VisualInteractionOptions | undefined; -} + SecondaryYAxisLabelOptions?: ChartAxisLabelOptions | undefined; -/** - *

Determines the gradient stop configuration.

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

Determines gradient offset value.

- * @public - */ - GradientOffset: number | undefined; - - /** - *

Determines the data value.

- * @public - */ - DataValue?: number | undefined; - - /** - *

Determines the color.

- * @public - */ - Color?: string | undefined; -} - -/** - *

Determines the gradient color settings.

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

The list of gradient color stops.

- * @public - */ - Stops?: GradientStop[] | undefined; -} - -/** - *

Formatting configuration for gradient color.

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

The expression that determines the formatting configuration for gradient color.

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

Determines the color.

- * @public - */ - Color: GradientColor | undefined; -} - -/** - *

Formatting configuration for solid color.

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

The expression that determines the formatting configuration for solid color.

+ *

The settings of a chart's single axis configuration.

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

Determines the color.

+ *

The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.

* @public */ - Color?: string | undefined; -} + ColorLabelOptions?: ChartAxisLabelOptions | undefined; -/** - *

The formatting configuration for the color.

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

Formatting configuration for solid color.

+ *

The legend display setup of the visual.

* @public */ - Solid?: ConditionalFormattingSolidColor | undefined; + Legend?: LegendOptions | undefined; /** - *

Formatting configuration for gradient color.

+ *

The options that determine if visual data labels are displayed.

+ *

The data label options for a bar in a combo chart.

* @public */ - Gradient?: ConditionalFormattingGradientColor | undefined; -} + BarDataLabels?: DataLabelOptions | undefined; -/** - *

The shape conditional formatting of a filled map visual.

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

The conditional formatting for the shape background color of a filled map visual.

+ *

The options that determine if visual data labels are displayed.

+ *

The data label options for a line in a combo chart.

* @public */ - BackgroundColor: ConditionalFormattingColor | undefined; -} + LineDataLabels?: DataLabelOptions | undefined; -/** - *

The conditional formatting that determines the shape of the filled map.

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

The field ID of the filled map shape.

+ *

The legend display setup of the visual.

* @public */ - FieldId: string | undefined; + Tooltip?: TooltipOptions | undefined; /** - *

The conditional formatting that determines the background color of a filled map's shape.

+ *

The reference line setup of the visual.

* @public */ - Format?: ShapeConditionalFormat | undefined; -} + ReferenceLines?: ReferenceLine[] | undefined; -/** - *

Conditional formatting options of a FilledMapVisual.

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

The conditional formatting that determines the shape of the filled map.

+ *

The palette (chart color) display setup of the visual.

* @public */ - Shape: FilledMapShapeConditionalFormatting | undefined; -} + VisualPalette?: VisualPalette | undefined; -/** - *

The conditional formatting of a FilledMapVisual.

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

Conditional formatting options of a FilledMapVisual.

+ *

The general visual interactions setup for a visual.

* @public */ - ConditionalFormattingOptions: FilledMapConditionalFormattingOption[] | undefined; + Interactions?: VisualInteractionOptions | undefined; } /** - *

A filled map.

- *

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

+ *

A combo chart.

+ *

The ComboChartVisual includes stacked bar combo charts and clustered bar combo charts

+ *

For more information, see Using combo charts in the Amazon QuickSight User Guide.

* @public */ -export interface FilledMapVisual { +export interface ComboChartVisual { /** - *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

* @public */ VisualId: string | undefined; @@ -1928,13 +1817,13 @@ export interface FilledMapVisual { *

The configuration settings of the visual.

* @public */ - ChartConfiguration?: FilledMapConfiguration | undefined; + ChartConfiguration?: ComboChartConfiguration | undefined; /** - *

The conditional formatting of a FilledMapVisual.

+ *

The list of custom actions that are configured for a visual.

* @public */ - ConditionalFormatting?: FilledMapConditionalFormatting | undefined; + Actions?: VisualCustomAction[] | undefined; /** *

The column hierarchy that is used during drill-downs and drill-ups.

@@ -1943,4520 +1832,4508 @@ export interface FilledMapVisual { ColumnHierarchies?: ColumnHierarchy[] | undefined; /** - *

The list of custom actions that are configured for a visual.

+ *

The alt text for the visual.

* @public */ - Actions?: VisualCustomAction[] | undefined; + VisualContentAltText?: string | undefined; } /** * @public * @enum */ -export const FunnelChartMeasureDataLabelStyle = { - PERCENTAGE_BY_FIRST_STAGE: "PERCENTAGE_BY_FIRST_STAGE", - PERCENTAGE_BY_PREVIOUS_STAGE: "PERCENTAGE_BY_PREVIOUS_STAGE", - VALUE_AND_PERCENTAGE_BY_FIRST_STAGE: "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE", - VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE: "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE", - VALUE_ONLY: "VALUE_ONLY", +export const CustomContentType = { + IMAGE: "IMAGE", + OTHER_EMBEDDED_CONTENT: "OTHER_EMBEDDED_CONTENT", } as const; /** * @public */ -export type FunnelChartMeasureDataLabelStyle = - (typeof FunnelChartMeasureDataLabelStyle)[keyof typeof FunnelChartMeasureDataLabelStyle]; +export type CustomContentType = (typeof CustomContentType)[keyof typeof CustomContentType]; /** - *

The options that determine the presentation of the data labels.

* @public + * @enum */ -export interface FunnelChartDataLabelOptions { +export const CustomContentImageScalingConfiguration = { + DO_NOT_SCALE: "DO_NOT_SCALE", + FIT_TO_HEIGHT: "FIT_TO_HEIGHT", + FIT_TO_WIDTH: "FIT_TO_WIDTH", + SCALE_TO_VISUAL: "SCALE_TO_VISUAL", +} as const; + +/** + * @public + */ +export type CustomContentImageScalingConfiguration = + (typeof CustomContentImageScalingConfiguration)[keyof typeof CustomContentImageScalingConfiguration]; + +/** + *

The configuration of a CustomContentVisual.

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

The visibility option that determines if data labels are displayed.

+ *

The input URL that links to the custom content that you want in the custom visual.

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

The visibility of the category labels within the data labels.

+ *

The content type of the custom content visual. You can use this to have the visual render as an image.

* @public */ - CategoryLabelVisibility?: Visibility | undefined; + ContentType?: CustomContentType | undefined; /** - *

The visibility of the measure labels within the data labels.

+ *

The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.

* @public */ - MeasureLabelVisibility?: Visibility | undefined; + ImageScaling?: CustomContentImageScalingConfiguration | undefined; /** - *

Determines the positioning of the data label relative to a section of the funnel.

+ *

The general visual interactions setup for a visual.

* @public */ - Position?: DataLabelPosition | undefined; + Interactions?: VisualInteractionOptions | undefined; +} +/** + *

A visual that contains custom content.

+ *

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

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

The font configuration for the data labels.

- *

Only the FontSize attribute of the font configuration is used for data labels.

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

* @public */ - LabelFontConfiguration?: FontConfiguration | undefined; + VisualId: string | undefined; /** - *

The color of the data label text.

+ *

The title that is displayed on the visual.

* @public */ - LabelColor?: string | undefined; + Title?: VisualTitleLabelOptions | undefined; /** - *

Determines the style of the metric labels.

+ *

The subtitle that is displayed on the visual.

* @public */ - MeasureDataLabelStyle?: FunnelChartMeasureDataLabelStyle | undefined; -} + Subtitle?: VisualSubtitleLabelOptions | undefined; -/** - *

The field well configuration of a FunnelChartVisual.

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

The category field wells of a funnel chart. Values are grouped by category fields.

+ *

The configuration of a CustomContentVisual.

* @public */ - Category?: DimensionField[] | undefined; + ChartConfiguration?: CustomContentConfiguration | undefined; /** - *

The value field wells of a funnel chart. Values are aggregated based on categories.

+ *

The list of custom actions that are configured for a visual.

* @public */ - Values?: MeasureField[] | undefined; -} + Actions?: VisualCustomAction[] | undefined; -/** - *

The field well configuration of a FunnelChartVisual.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The field well configuration of a FunnelChartVisual.

+ *

The dataset that is used to create the custom content visual. You can't create a visual without a dataset.

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

The alt text for the visual.

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

The sort configuration of a FunnelChartVisual.

+ *

An empty visual.

+ *

Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Amazon QuickSight console is considered an EmptyVisual until a visual type is selected.

* @public */ -export interface FunnelChartSortConfiguration { +export interface EmptyVisual { /** - *

The sort configuration of the category fields.

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

* @public */ - CategorySort?: FieldSortOptions[] | undefined; + VisualId: string | undefined; /** - *

The limit on the number of categories displayed.

+ *

The data set that is used in the empty visual. Every visual requires a dataset to render.

* @public */ - CategoryItemsLimit?: ItemsLimitConfiguration | undefined; -} + DataSetIdentifier: string | undefined; + + /** + *

The list of custom actions that are configured for a visual.

+ * @public + */ + Actions?: VisualCustomAction[] | undefined; +} /** - *

The configuration of a FunnelChartVisual.

+ *

The aggregated field well of the filled map.

* @public */ -export interface FunnelChartConfiguration { +export interface FilledMapAggregatedFieldWells { /** - *

The field well configuration of a FunnelChartVisual.

+ *

The aggregated location field well of the filled map. Values are grouped by location fields.

* @public */ - FieldWells?: FunnelChartFieldWells | undefined; + Geospatial?: DimensionField[] | undefined; /** - *

The sort configuration of a FunnelChartVisual.

+ *

The aggregated color field well of a filled map. Values are aggregated based on location fields.

* @public */ - SortConfiguration?: FunnelChartSortConfiguration | undefined; + Values?: MeasureField[] | undefined; +} +/** + *

The field wells of a FilledMapVisual.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The label options of the categories that are displayed in a FunnelChartVisual.

+ *

The aggregated field well of the filled map.

* @public */ - CategoryLabelOptions?: ChartAxisLabelOptions | undefined; + FilledMapAggregatedFieldWells?: FilledMapAggregatedFieldWells | undefined; +} + +/** + * @public + * @enum + */ +export const BaseMapStyleType = { + DARK_GRAY: "DARK_GRAY", + IMAGERY: "IMAGERY", + LIGHT_GRAY: "LIGHT_GRAY", + STREET: "STREET", +} as const; + +/** + * @public + */ +export type BaseMapStyleType = (typeof BaseMapStyleType)[keyof typeof BaseMapStyleType]; +/** + *

The map style options of the geospatial map.

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

The label options for the values that are displayed in a FunnelChartVisual.

+ *

The base map style of the geospatial map.

* @public */ - ValueLabelOptions?: ChartAxisLabelOptions | undefined; + BaseMapStyle?: BaseMapStyleType | undefined; +} +/** + *

The sort configuration of a FilledMapVisual.

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

The tooltip configuration of a FunnelChartVisual.

+ *

The sort configuration of the location fields.

* @public */ - Tooltip?: TooltipOptions | undefined; + CategorySort?: FieldSortOptions[] | undefined; +} +/** + *

The bound + * options (north, south, west, east) of the geospatial window options.

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

The options that determine the presentation of the data labels.

+ *

The latitude of the north bound of the geospatial coordinate bounds.

* @public */ - DataLabelOptions?: FunnelChartDataLabelOptions | undefined; + North: number | undefined; /** - *

The visual palette configuration of a FunnelChartVisual.

+ *

The latitude of the south bound of the geospatial coordinate bounds.

* @public */ - VisualPalette?: VisualPalette | undefined; + South: number | undefined; /** - *

The general visual interactions setup for a visual.

+ *

The longitude of the west bound of the geospatial coordinate bounds.

* @public */ - Interactions?: VisualInteractionOptions | undefined; + West: number | undefined; + + /** + *

The longitude of the east bound of the geospatial coordinate bounds.

+ * @public + */ + East: number | undefined; } /** - *

A funnel chart.

- *

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

* @public + * @enum */ -export interface FunnelChartVisual { +export const MapZoomMode = { + AUTO: "AUTO", + MANUAL: "MANUAL", +} as const; + +/** + * @public + */ +export type MapZoomMode = (typeof MapZoomMode)[keyof typeof MapZoomMode]; + +/** + *

The window options of the geospatial map visual.

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

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

+ *

The bounds options (north, south, west, east) of the geospatial window options.

* @public */ - VisualId: string | undefined; + Bounds?: GeospatialCoordinateBounds | undefined; /** - *

The title that is displayed on the visual.

+ *

The map zoom modes (manual, auto) of the geospatial window options.

* @public */ - Title?: VisualTitleLabelOptions | undefined; + MapZoomMode?: MapZoomMode | undefined; +} +/** + *

The configuration for a FilledMapVisual.

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

The subtitle that is displayed on the visual.

+ *

The field wells of the visual.

* @public */ - Subtitle?: VisualSubtitleLabelOptions | undefined; + FieldWells?: FilledMapFieldWells | undefined; /** - *

The configuration of a FunnelChartVisual.

+ *

The sort configuration of a FilledMapVisual.

* @public */ - ChartConfiguration?: FunnelChartConfiguration | undefined; + SortConfiguration?: FilledMapSortConfiguration | undefined; /** - *

The list of custom actions that are configured for a visual.

+ *

The legend display setup of the visual.

* @public */ - Actions?: VisualCustomAction[] | undefined; + Legend?: LegendOptions | undefined; /** - *

The column hierarchy that is used during drill-downs and drill-ups.

+ *

The tooltip display setup of the visual.

* @public */ - ColumnHierarchies?: ColumnHierarchy[] | undefined; -} + Tooltip?: TooltipOptions | undefined; -/** - *

The color configuration of a GaugeChartVisual.

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

The foreground color configuration of a GaugeChartVisual.

+ *

The window options of the filled map visual.

* @public */ - ForegroundColor?: string | undefined; + WindowOptions?: GeospatialWindowOptions | undefined; /** - *

The background color configuration of a GaugeChartVisual.

+ *

The map style options of the filled map visual.

* @public */ - BackgroundColor?: string | undefined; + MapStyleOptions?: GeospatialMapStyleOptions | undefined; + + /** + *

The general visual interactions setup for a visual.

+ * @public + */ + Interactions?: VisualInteractionOptions | undefined; } /** - *

The field well configuration of a GaugeChartVisual.

+ *

Determines the gradient stop configuration.

* @public */ -export interface GaugeChartFieldWells { +export interface GradientStop { /** - *

The value field wells of a GaugeChartVisual.

+ *

Determines gradient offset value.

* @public */ - Values?: MeasureField[] | undefined; + GradientOffset: number | undefined; /** - *

The target value field wells of a GaugeChartVisual.

+ *

Determines the data value.

* @public */ - TargetValues?: MeasureField[] | undefined; -} + DataValue?: number | undefined; -/** - * @public - * @enum - */ -export const ArcThicknessOptions = { - LARGE: "LARGE", - MEDIUM: "MEDIUM", - SMALL: "SMALL", -} as const; + /** + *

Determines the color.

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

Determines the gradient color settings.

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

The list of gradient color stops.

+ * @public + */ + Stops?: GradientStop[] | undefined; +} /** - *

The arc configuration of a GaugeChartVisual.

+ *

Formatting configuration for gradient color.

* @public */ -export interface ArcConfiguration { +export interface ConditionalFormattingGradientColor { /** - *

The option that determines the arc angle of a GaugeChartVisual.

+ *

The expression that determines the formatting configuration for gradient color.

* @public */ - ArcAngle?: number | undefined; + Expression: string | undefined; /** - *

The options that determine the arc thickness of a GaugeChartVisual.

+ *

Determines the color.

* @public */ - ArcThickness?: ArcThicknessOptions | undefined; + Color: GradientColor | undefined; } /** - *

The arc axis range of a GaugeChartVisual.

+ *

Formatting configuration for solid color.

* @public */ -export interface ArcAxisDisplayRange { +export interface ConditionalFormattingSolidColor { /** - *

The minimum value of the arc axis range.

+ *

The expression that determines the formatting configuration for solid color.

* @public */ - Min?: number | undefined; + Expression: string | undefined; /** - *

The maximum value of the arc axis range.

+ *

Determines the color.

* @public */ - Max?: number | undefined; + Color?: string | undefined; } /** - *

The arc axis configuration of a GaugeChartVisual.

+ *

The formatting configuration for the color.

* @public */ -export interface ArcAxisConfiguration { +export interface ConditionalFormattingColor { /** - *

The arc axis range of a GaugeChartVisual.

+ *

Formatting configuration for solid color.

* @public */ - Range?: ArcAxisDisplayRange | undefined; + Solid?: ConditionalFormattingSolidColor | undefined; /** - *

The reserved range of the arc axis.

+ *

Formatting configuration for gradient color.

* @public */ - ReserveRange?: number | undefined; + Gradient?: ConditionalFormattingGradientColor | undefined; } /** - *

The format of the comparison.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

+ *

The shape conditional formatting of a filled map visual.

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

The number display format.

- * @public - */ - NumberDisplayFormatConfiguration?: NumberDisplayFormatConfiguration | undefined; - +export interface ShapeConditionalFormat { /** - *

The percentage display format.

+ *

The conditional formatting for the shape background color of a filled map visual.

* @public */ - PercentageDisplayFormatConfiguration?: PercentageDisplayFormatConfiguration | undefined; + BackgroundColor: ConditionalFormattingColor | undefined; } /** + *

The conditional formatting that determines the shape of the filled map.

* @public - * @enum */ -export const ComparisonMethod = { - DIFFERENCE: "DIFFERENCE", - PERCENT: "PERCENT", - PERCENT_DIFFERENCE: "PERCENT_DIFFERENCE", -} as const; - -/** - * @public - */ -export type ComparisonMethod = (typeof ComparisonMethod)[keyof typeof ComparisonMethod]; - -/** - *

The comparison display configuration of a KPI or gauge chart.

- * @public - */ -export interface ComparisonConfiguration { +export interface FilledMapShapeConditionalFormatting { /** - *

The method of the comparison. Choose from the following options:

- *
    - *
  • - *

    - * DIFFERENCE - *

    - *
  • - *
  • - *

    - * PERCENT_DIFFERENCE - *

    - *
  • - *
  • - *

    - * PERCENT - *

    - *
  • - *
+ *

The field ID of the filled map shape.

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

The format of the comparison.

+ *

The conditional formatting that determines the background color of a filled map's shape.

* @public */ - ComparisonFormat?: ComparisonFormatConfiguration | undefined; + Format?: ShapeConditionalFormat | undefined; } /** + *

Conditional formatting options of a FilledMapVisual.

* @public - * @enum */ -export const PrimaryValueDisplayType = { - ACTUAL: "ACTUAL", - COMPARISON: "COMPARISON", - HIDDEN: "HIDDEN", -} as const; +export interface FilledMapConditionalFormattingOption { + /** + *

The conditional formatting that determines the shape of the filled map.

+ * @public + */ + Shape: FilledMapShapeConditionalFormatting | undefined; +} /** + *

The conditional formatting of a FilledMapVisual.

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

Conditional formatting options of a FilledMapVisual.

+ * @public + */ + ConditionalFormattingOptions: FilledMapConditionalFormattingOption[] | undefined; +} /** - *

The options that determine the presentation of the GaugeChartVisual.

+ *

A filled map.

+ *

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

* @public */ -export interface GaugeChartOptions { +export interface FilledMapVisual { /** - *

The options that determine the primary value display type.

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

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

The comparison configuration of a GaugeChartVisual.

+ *

The title that is displayed on the visual.

* @public */ - Comparison?: ComparisonConfiguration | undefined; + Title?: VisualTitleLabelOptions | undefined; /** - *

The arc axis configuration of a GaugeChartVisual.

+ *

The subtitle that is displayed on the visual.

* @public */ - ArcAxis?: ArcAxisConfiguration | undefined; + Subtitle?: VisualSubtitleLabelOptions | undefined; /** - *

The arc configuration of a GaugeChartVisual.

+ *

The configuration settings of the visual.

* @public */ - Arc?: ArcConfiguration | undefined; + ChartConfiguration?: FilledMapConfiguration | undefined; /** - *

The options that determine the primary value font configuration.

+ *

The conditional formatting of a FilledMapVisual.

* @public */ - PrimaryValueFontConfiguration?: FontConfiguration | undefined; + ConditionalFormatting?: FilledMapConditionalFormatting | undefined; + + /** + *

The column hierarchy that is used during drill-downs and drill-ups.

+ * @public + */ + ColumnHierarchies?: ColumnHierarchy[] | undefined; + + /** + *

The list of custom actions that are configured for a visual.

+ * @public + */ + Actions?: VisualCustomAction[] | undefined; + + /** + *

The alt text for the visual.

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

The configuration of a GaugeChartVisual.

* @public + * @enum */ -export interface GaugeChartConfiguration { +export const FunnelChartMeasureDataLabelStyle = { + PERCENTAGE_BY_FIRST_STAGE: "PERCENTAGE_BY_FIRST_STAGE", + PERCENTAGE_BY_PREVIOUS_STAGE: "PERCENTAGE_BY_PREVIOUS_STAGE", + VALUE_AND_PERCENTAGE_BY_FIRST_STAGE: "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE", + VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE: "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE", + VALUE_ONLY: "VALUE_ONLY", +} as const; + +/** + * @public + */ +export type FunnelChartMeasureDataLabelStyle = + (typeof FunnelChartMeasureDataLabelStyle)[keyof typeof FunnelChartMeasureDataLabelStyle]; + +/** + *

The options that determine the presentation of the data labels.

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

The field well configuration of a GaugeChartVisual.

+ *

The visibility option that determines if data labels are displayed.

* @public */ - FieldWells?: GaugeChartFieldWells | undefined; + Visibility?: Visibility | undefined; /** - *

The options that determine the presentation of the GaugeChartVisual.

+ *

The visibility of the category labels within the data labels.

* @public */ - GaugeChartOptions?: GaugeChartOptions | undefined; + CategoryLabelVisibility?: Visibility | undefined; /** - *

The data label configuration of a GaugeChartVisual.

+ *

The visibility of the measure labels within the data labels.

* @public */ - DataLabels?: DataLabelOptions | undefined; + MeasureLabelVisibility?: Visibility | undefined; /** - *

The tooltip configuration of a GaugeChartVisual.

+ *

Determines the positioning of the data label relative to a section of the funnel.

* @public */ - TooltipOptions?: TooltipOptions | undefined; + Position?: DataLabelPosition | undefined; /** - *

The visual palette configuration of a GaugeChartVisual.

+ *

The font configuration for the data labels.

+ *

Only the FontSize attribute of the font configuration is used for data labels.

* @public */ - VisualPalette?: VisualPalette | undefined; + LabelFontConfiguration?: FontConfiguration | undefined; /** - *

The color configuration of a GaugeChartVisual.

+ *

The color of the data label text.

* @public */ - ColorConfiguration?: GaugeChartColorConfiguration | undefined; + LabelColor?: string | undefined; /** - *

The general visual interactions setup for a visual.

+ *

Determines the style of the metric labels.

* @public */ - Interactions?: VisualInteractionOptions | undefined; + MeasureDataLabelStyle?: FunnelChartMeasureDataLabelStyle | undefined; } /** - *

The options that determine the presentation of the arc of a GaugeChartVisual.

+ *

The field well configuration of a FunnelChartVisual.

* @public */ -export interface GaugeChartArcConditionalFormatting { +export interface FunnelChartAggregatedFieldWells { /** - *

The conditional formatting of the arc foreground color.

+ *

The category field wells of a funnel chart. Values are grouped by category fields.

* @public */ - ForegroundColor?: ConditionalFormattingColor | undefined; -} - -/** - * @public - * @enum - */ -export const ConditionalFormattingIconDisplayOption = { - ICON_ONLY: "ICON_ONLY", -} as const; - -/** - * @public - */ -export type ConditionalFormattingIconDisplayOption = - (typeof ConditionalFormattingIconDisplayOption)[keyof typeof ConditionalFormattingIconDisplayOption]; + Category?: DimensionField[] | undefined; -/** - *

Determines the icon display configuration.

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

Determines the icon display configuration.

+ *

The value field wells of a funnel chart. Values are aggregated based on categories.

* @public */ - IconDisplayOption?: ConditionalFormattingIconDisplayOption | undefined; + Values?: MeasureField[] | undefined; } /** - * @public - * @enum - */ -export const Icon = { - ARROW_DOWN: "ARROW_DOWN", - ARROW_DOWN_LEFT: "ARROW_DOWN_LEFT", - ARROW_DOWN_RIGHT: "ARROW_DOWN_RIGHT", - ARROW_LEFT: "ARROW_LEFT", - ARROW_RIGHT: "ARROW_RIGHT", - ARROW_UP: "ARROW_UP", - ARROW_UP_LEFT: "ARROW_UP_LEFT", - ARROW_UP_RIGHT: "ARROW_UP_RIGHT", - CARET_DOWN: "CARET_DOWN", - CARET_UP: "CARET_UP", - CHECKMARK: "CHECKMARK", - CIRCLE: "CIRCLE", - FACE_DOWN: "FACE_DOWN", - FACE_FLAT: "FACE_FLAT", - FACE_UP: "FACE_UP", - FLAG: "FLAG", - MINUS: "MINUS", - ONE_BAR: "ONE_BAR", - PLUS: "PLUS", - SQUARE: "SQUARE", - THREE_BAR: "THREE_BAR", - THUMBS_DOWN: "THUMBS_DOWN", - THUMBS_UP: "THUMBS_UP", - TRIANGLE: "TRIANGLE", - TWO_BAR: "TWO_BAR", - X: "X", -} as const; - -/** + *

The field well configuration of a FunnelChartVisual.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The field well configuration of a FunnelChartVisual.

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

Custom icon options for an icon set.

+ *

The sort configuration of a FunnelChartVisual.

* @public */ -export interface ConditionalFormattingCustomIconOptions { +export interface FunnelChartSortConfiguration { /** - *

Determines the type of icon.

+ *

The sort configuration of the category fields.

* @public */ - Icon?: Icon | undefined; + CategorySort?: FieldSortOptions[] | undefined; /** - *

Determines the Unicode icon type.

+ *

The limit on the number of categories displayed.

* @public */ - UnicodeIcon?: string | undefined; + CategoryItemsLimit?: ItemsLimitConfiguration | undefined; } /** - *

Determines the custom condition for an icon set.

+ *

The configuration of a FunnelChartVisual.

* @public */ -export interface ConditionalFormattingCustomIconCondition { +export interface FunnelChartConfiguration { /** - *

The expression that determines the condition of the icon set.

+ *

The field well configuration of a FunnelChartVisual.

* @public */ - Expression: string | undefined; + FieldWells?: FunnelChartFieldWells | undefined; /** - *

Custom icon options for an icon set.

+ *

The sort configuration of a FunnelChartVisual.

* @public */ - IconOptions: ConditionalFormattingCustomIconOptions | undefined; + SortConfiguration?: FunnelChartSortConfiguration | undefined; /** - *

Determines the color of the icon.

+ *

The label options of the categories that are displayed in a FunnelChartVisual.

* @public */ - Color?: string | undefined; + CategoryLabelOptions?: ChartAxisLabelOptions | undefined; /** - *

Determines the icon display configuration.

+ *

The label options for the values that are displayed in a FunnelChartVisual.

* @public */ - DisplayConfiguration?: ConditionalFormattingIconDisplayConfiguration | undefined; -} - -/** - * @public - * @enum - */ -export const ConditionalFormattingIconSetType = { - BARS: "BARS", - CARET_UP_MINUS_DOWN: "CARET_UP_MINUS_DOWN", - CHECK_X: "CHECK_X", - FLAGS: "FLAGS", - FOUR_COLOR_ARROW: "FOUR_COLOR_ARROW", - FOUR_GRAY_ARROW: "FOUR_GRAY_ARROW", - PLUS_MINUS: "PLUS_MINUS", - THREE_CIRCLE: "THREE_CIRCLE", - THREE_COLOR_ARROW: "THREE_COLOR_ARROW", - THREE_GRAY_ARROW: "THREE_GRAY_ARROW", - THREE_SHAPE: "THREE_SHAPE", -} as const; - -/** - * @public - */ -export type ConditionalFormattingIconSetType = - (typeof ConditionalFormattingIconSetType)[keyof typeof ConditionalFormattingIconSetType]; + ValueLabelOptions?: ChartAxisLabelOptions | undefined; -/** - *

Formatting configuration for icon set.

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

The expression that determines the formatting configuration for the icon set.

+ *

The tooltip configuration of a FunnelChartVisual.

* @public */ - Expression: string | undefined; + Tooltip?: TooltipOptions | undefined; /** - *

Determines the icon set type.

+ *

The options that determine the presentation of the data labels.

* @public */ - IconSetType?: ConditionalFormattingIconSetType | undefined; -} + DataLabelOptions?: FunnelChartDataLabelOptions | undefined; -/** - *

The formatting configuration for the icon.

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

Formatting configuration for icon set.

+ *

The visual palette configuration of a FunnelChartVisual.

* @public */ - IconSet?: ConditionalFormattingIconSet | undefined; + VisualPalette?: VisualPalette | undefined; /** - *

Determines the custom condition for an icon set.

+ *

The general visual interactions setup for a visual.

* @public */ - CustomCondition?: ConditionalFormattingCustomIconCondition | undefined; + Interactions?: VisualInteractionOptions | undefined; } /** - *

The conditional formatting for the primary value of a GaugeChartVisual.

+ *

A funnel chart.

+ *

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

* @public */ -export interface GaugeChartPrimaryValueConditionalFormatting { +export interface FunnelChartVisual { /** - *

The conditional formatting of the primary value text color.

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

* @public */ - TextColor?: ConditionalFormattingColor | undefined; + VisualId: string | undefined; /** - *

The conditional formatting of the primary value icon.

+ *

The title that is displayed on the visual.

* @public */ - Icon?: ConditionalFormattingIcon | undefined; -} + Title?: VisualTitleLabelOptions | undefined; -/** - *

Conditional formatting options of a GaugeChartVisual.

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

The conditional formatting for the primary value of a GaugeChartVisual.

+ *

The subtitle that is displayed on the visual.

* @public */ - PrimaryValue?: GaugeChartPrimaryValueConditionalFormatting | undefined; + Subtitle?: VisualSubtitleLabelOptions | undefined; /** - *

The options that determine the presentation of the arc of a GaugeChartVisual.

+ *

The configuration of a FunnelChartVisual.

* @public */ - Arc?: GaugeChartArcConditionalFormatting | undefined; -} + ChartConfiguration?: FunnelChartConfiguration | undefined; -/** - *

The conditional formatting of a GaugeChartVisual.

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

Conditional formatting options of a GaugeChartVisual.

+ *

The list of custom actions that are configured for a visual.

* @public */ - ConditionalFormattingOptions?: GaugeChartConditionalFormattingOption[] | undefined; -} + Actions?: VisualCustomAction[] | undefined; -/** - *

A gauge chart.

- *

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

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

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

+ *

The column hierarchy that is used during drill-downs and drill-ups.

* @public */ - VisualId: string | undefined; + ColumnHierarchies?: ColumnHierarchy[] | undefined; /** - *

The title that is displayed on the visual.

+ *

The alt text for the visual.

* @public */ - Title?: VisualTitleLabelOptions | undefined; + VisualContentAltText?: string | undefined; +} +/** + *

The color configuration of a GaugeChartVisual.

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

The subtitle that is displayed on the visual.

+ *

The foreground color configuration of a GaugeChartVisual.

* @public */ - Subtitle?: VisualSubtitleLabelOptions | undefined; + ForegroundColor?: string | undefined; /** - *

The configuration of a GaugeChartVisual.

+ *

The background color configuration of a GaugeChartVisual.

* @public */ - ChartConfiguration?: GaugeChartConfiguration | undefined; + BackgroundColor?: string | undefined; +} +/** + *

The field well configuration of a GaugeChartVisual.

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

The conditional formatting of a GaugeChartVisual.

+ *

The value field wells of a GaugeChartVisual.

* @public */ - ConditionalFormatting?: GaugeChartConditionalFormatting | undefined; + Values?: MeasureField[] | undefined; /** - *

The list of custom actions that are configured for a visual.

+ *

The target value field wells of a GaugeChartVisual.

* @public */ - Actions?: VisualCustomAction[] | undefined; + TargetValues?: MeasureField[] | undefined; } /** - *

The aggregated field wells for a geospatial map.

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

The geospatial field wells of a geospatial map. Values are grouped by geospatial fields.

- * @public - */ - Geospatial?: DimensionField[] | undefined; +export const ArcThicknessOptions = { + LARGE: "LARGE", + MEDIUM: "MEDIUM", + SMALL: "SMALL", +} as const; - /** - *

The size field wells of a geospatial map. Values are aggregated based on geospatial fields.

- * @public - */ - Values?: MeasureField[] | undefined; +/** + * @public + */ +export type ArcThicknessOptions = (typeof ArcThicknessOptions)[keyof typeof ArcThicknessOptions]; +/** + *

The arc configuration of a GaugeChartVisual.

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

The color field wells of a geospatial map.

+ *

The option that determines the arc angle of a GaugeChartVisual.

* @public */ - Colors?: DimensionField[] | undefined; -} + ArcAngle?: number | undefined; -/** - *

The field wells of a GeospatialMapVisual.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The aggregated field well for a geospatial map.

+ *

The options that determine the arc thickness of a GaugeChartVisual.

* @public */ - GeospatialMapAggregatedFieldWells?: GeospatialMapAggregatedFieldWells | undefined; + ArcThickness?: ArcThicknessOptions | undefined; } /** - *

The simple cluster marker of the cluster marker.

+ *

The arc axis range of a GaugeChartVisual.

* @public */ -export interface SimpleClusterMarker { +export interface ArcAxisDisplayRange { /** - *

The color of the simple cluster marker.

+ *

The minimum value of the arc axis range.

* @public */ - Color?: string | undefined; -} + Min?: number | undefined; -/** - *

The cluster marker that is a part of the cluster marker - * configuration.

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

The simple cluster marker of the cluster marker.

+ *

The maximum value of the arc axis range.

* @public */ - SimpleClusterMarker?: SimpleClusterMarker | undefined; + Max?: number | undefined; } /** - *

The cluster marker configuration of the geospatial map selected point style.

+ *

The arc axis configuration of a GaugeChartVisual.

* @public */ -export interface ClusterMarkerConfiguration { +export interface ArcAxisConfiguration { /** - *

The cluster marker that is a part of the cluster marker configuration.

+ *

The arc axis range of a GaugeChartVisual.

* @public */ - ClusterMarker?: ClusterMarker | undefined; -} + Range?: ArcAxisDisplayRange | undefined; -/** - *

The color to be used in the heatmap point style.

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

The hex color to be used in the heatmap point style.

+ *

The reserved range of the arc axis.

* @public */ - Color: string | undefined; + ReserveRange?: number | undefined; } /** - *

The color scale specification for the heatmap point style.

+ *

The format of the comparison.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

* @public */ -export interface GeospatialHeatmapColorScale { +export interface ComparisonFormatConfiguration { /** - *

The list of colors to be used in heatmap point style.

+ *

The number display format.

* @public */ - Colors?: GeospatialHeatmapDataColor[] | undefined; -} + NumberDisplayFormatConfiguration?: NumberDisplayFormatConfiguration | undefined; -/** - *

The heatmap configuration of the geospatial point style.

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

The color scale specification for the heatmap point style.

+ *

The percentage display format.

* @public */ - HeatmapColor?: GeospatialHeatmapColorScale | undefined; + PercentageDisplayFormatConfiguration?: PercentageDisplayFormatConfiguration | undefined; } /** * @public * @enum */ -export const GeospatialSelectedPointStyle = { - CLUSTER: "CLUSTER", - HEATMAP: "HEATMAP", - POINT: "POINT", +export const ComparisonMethod = { + DIFFERENCE: "DIFFERENCE", + PERCENT: "PERCENT", + PERCENT_DIFFERENCE: "PERCENT_DIFFERENCE", } as const; /** * @public */ -export type GeospatialSelectedPointStyle = - (typeof GeospatialSelectedPointStyle)[keyof typeof GeospatialSelectedPointStyle]; +export type ComparisonMethod = (typeof ComparisonMethod)[keyof typeof ComparisonMethod]; /** - *

The point style of the geospatial map.

+ *

The comparison display configuration of a KPI or gauge chart.

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

The selected point styles (point, cluster) of the geospatial map.

- * @public - */ - SelectedPointStyle?: GeospatialSelectedPointStyle | undefined; - +export interface ComparisonConfiguration { /** - *

The cluster marker configuration of the geospatial point style.

- * @public - */ - ClusterMarkerConfiguration?: ClusterMarkerConfiguration | undefined; - + *

The method of the comparison. Choose from the following options:

+ *
    + *
  • + *

    + * DIFFERENCE + *

    + *
  • + *
  • + *

    + * PERCENT_DIFFERENCE + *

    + *
  • + *
  • + *

    + * PERCENT + *

    + *
  • + *
+ * @public + */ + ComparisonMethod?: ComparisonMethod | undefined; + /** - *

The heatmap configuration of the geospatial point style.

+ *

The format of the comparison.

* @public */ - HeatmapConfiguration?: GeospatialHeatmapConfiguration | undefined; + ComparisonFormat?: ComparisonFormatConfiguration | undefined; } /** - *

The configuration of a GeospatialMapVisual.

* @public + * @enum */ -export interface GeospatialMapConfiguration { +export const PrimaryValueDisplayType = { + ACTUAL: "ACTUAL", + COMPARISON: "COMPARISON", + HIDDEN: "HIDDEN", +} as const; + +/** + * @public + */ +export type PrimaryValueDisplayType = (typeof PrimaryValueDisplayType)[keyof typeof PrimaryValueDisplayType]; + +/** + *

The options that determine the presentation of the GaugeChartVisual.

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

The field wells of the visual.

+ *

The options that determine the primary value display type.

* @public */ - FieldWells?: GeospatialMapFieldWells | undefined; + PrimaryValueDisplayType?: PrimaryValueDisplayType | undefined; /** - *

The legend display setup of the visual.

+ *

The comparison configuration of a GaugeChartVisual.

* @public */ - Legend?: LegendOptions | undefined; + Comparison?: ComparisonConfiguration | undefined; /** - *

The tooltip display setup of the visual.

+ *

The arc axis configuration of a GaugeChartVisual.

* @public */ - Tooltip?: TooltipOptions | undefined; + ArcAxis?: ArcAxisConfiguration | undefined; /** - *

The window options of the geospatial map.

+ *

The arc configuration of a GaugeChartVisual.

* @public */ - WindowOptions?: GeospatialWindowOptions | undefined; + Arc?: ArcConfiguration | undefined; /** - *

The map style options of the geospatial map.

+ *

The options that determine the primary value font configuration.

* @public */ - MapStyleOptions?: GeospatialMapStyleOptions | undefined; + PrimaryValueFontConfiguration?: FontConfiguration | undefined; +} +/** + *

The configuration of a GaugeChartVisual.

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

The point style options of the geospatial map.

+ *

The field well configuration of a GaugeChartVisual.

* @public */ - PointStyleOptions?: GeospatialPointStyleOptions | undefined; + FieldWells?: GaugeChartFieldWells | undefined; /** - *

The visual display options for the visual palette.

+ *

The options that determine the presentation of the GaugeChartVisual.

* @public */ - VisualPalette?: VisualPalette | undefined; + GaugeChartOptions?: GaugeChartOptions | undefined; /** - *

The general visual interactions setup for a visual.

+ *

The data label configuration of a GaugeChartVisual.

* @public */ - Interactions?: VisualInteractionOptions | undefined; -} + DataLabels?: DataLabelOptions | undefined; -/** - *

A geospatial map or a points on map visual.

- *

For more information, see Creating point maps in the Amazon QuickSight User Guide.

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

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

+ *

The tooltip configuration of a GaugeChartVisual.

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

The title that is displayed on the visual.

+ *

The visual palette configuration of a GaugeChartVisual.

* @public */ - Title?: VisualTitleLabelOptions | undefined; + VisualPalette?: VisualPalette | undefined; /** - *

The subtitle that is displayed on the visual.

+ *

The color configuration of a GaugeChartVisual.

* @public */ - Subtitle?: VisualSubtitleLabelOptions | undefined; + ColorConfiguration?: GaugeChartColorConfiguration | undefined; /** - *

The configuration settings of the visual.

+ *

The general visual interactions setup for a visual.

* @public */ - ChartConfiguration?: GeospatialMapConfiguration | undefined; + Interactions?: VisualInteractionOptions | undefined; +} +/** + *

The options that determine the presentation of the arc of a GaugeChartVisual.

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

The column hierarchy that is used during drill-downs and drill-ups.

+ *

The conditional formatting of the arc foreground color.

* @public */ - ColumnHierarchies?: ColumnHierarchy[] | undefined; + ForegroundColor?: ConditionalFormattingColor | undefined; +} + +/** + * @public + * @enum + */ +export const ConditionalFormattingIconDisplayOption = { + ICON_ONLY: "ICON_ONLY", +} as const; + +/** + * @public + */ +export type ConditionalFormattingIconDisplayOption = + (typeof ConditionalFormattingIconDisplayOption)[keyof typeof ConditionalFormattingIconDisplayOption]; +/** + *

Determines the icon display configuration.

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

The list of custom actions that are configured for a visual.

+ *

Determines the icon display configuration.

* @public */ - Actions?: VisualCustomAction[] | undefined; + IconDisplayOption?: ConditionalFormattingIconDisplayOption | undefined; } /** * @public * @enum */ -export const ColorFillType = { - DISCRETE: "DISCRETE", - GRADIENT: "GRADIENT", +export const Icon = { + ARROW_DOWN: "ARROW_DOWN", + ARROW_DOWN_LEFT: "ARROW_DOWN_LEFT", + ARROW_DOWN_RIGHT: "ARROW_DOWN_RIGHT", + ARROW_LEFT: "ARROW_LEFT", + ARROW_RIGHT: "ARROW_RIGHT", + ARROW_UP: "ARROW_UP", + ARROW_UP_LEFT: "ARROW_UP_LEFT", + ARROW_UP_RIGHT: "ARROW_UP_RIGHT", + CARET_DOWN: "CARET_DOWN", + CARET_UP: "CARET_UP", + CHECKMARK: "CHECKMARK", + CIRCLE: "CIRCLE", + FACE_DOWN: "FACE_DOWN", + FACE_FLAT: "FACE_FLAT", + FACE_UP: "FACE_UP", + FLAG: "FLAG", + MINUS: "MINUS", + ONE_BAR: "ONE_BAR", + PLUS: "PLUS", + SQUARE: "SQUARE", + THREE_BAR: "THREE_BAR", + THUMBS_DOWN: "THUMBS_DOWN", + THUMBS_UP: "THUMBS_UP", + TRIANGLE: "TRIANGLE", + TWO_BAR: "TWO_BAR", + X: "X", } as const; /** * @public */ -export type ColorFillType = (typeof ColorFillType)[keyof typeof ColorFillType]; +export type Icon = (typeof Icon)[keyof typeof Icon]; /** - *

Determines the color that is applied to a particular data value.

+ *

Custom icon options for an icon set.

* @public */ -export interface DataColor { +export interface ConditionalFormattingCustomIconOptions { /** - *

The color that is applied to the data value.

+ *

Determines the type of icon.

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

The data value that the color is applied to.

+ *

Determines the Unicode icon type.

* @public */ - DataValue?: number | undefined; + UnicodeIcon?: string | undefined; } /** - *

Determines the color scale that is applied to the visual.

+ *

Determines the custom condition for an icon set.

* @public */ -export interface ColorScale { +export interface ConditionalFormattingCustomIconCondition { /** - *

Determines the list of colors that are applied to the visual.

+ *

The expression that determines the condition of the icon set.

* @public */ - Colors: DataColor[] | undefined; + Expression: string | undefined; /** - *

Determines the color fill type.

+ *

Custom icon options for an icon set.

* @public */ - ColorFillType: ColorFillType | undefined; + IconOptions: ConditionalFormattingCustomIconOptions | undefined; /** - *

Determines the color that is applied to null values.

+ *

Determines the color of the icon.

* @public */ - NullValueColor?: DataColor | undefined; + Color?: string | undefined; + + /** + *

Determines the icon display configuration.

+ * @public + */ + DisplayConfiguration?: ConditionalFormattingIconDisplayConfiguration | undefined; } /** - *

The aggregated field wells of a heat map.

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

The rows field well of a heat map.

- * @public - */ - Rows?: DimensionField[] | undefined; +export const ConditionalFormattingIconSetType = { + BARS: "BARS", + CARET_UP_MINUS_DOWN: "CARET_UP_MINUS_DOWN", + CHECK_X: "CHECK_X", + FLAGS: "FLAGS", + FOUR_COLOR_ARROW: "FOUR_COLOR_ARROW", + FOUR_GRAY_ARROW: "FOUR_GRAY_ARROW", + PLUS_MINUS: "PLUS_MINUS", + THREE_CIRCLE: "THREE_CIRCLE", + THREE_COLOR_ARROW: "THREE_COLOR_ARROW", + THREE_GRAY_ARROW: "THREE_GRAY_ARROW", + THREE_SHAPE: "THREE_SHAPE", +} as const; + +/** + * @public + */ +export type ConditionalFormattingIconSetType = + (typeof ConditionalFormattingIconSetType)[keyof typeof ConditionalFormattingIconSetType]; +/** + *

Formatting configuration for icon set.

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

The columns field well of a heat map.

+ *

The expression that determines the formatting configuration for the icon set.

* @public */ - Columns?: DimensionField[] | undefined; + Expression: string | undefined; /** - *

The values field well of a heat map.

+ *

Determines the icon set type.

* @public */ - Values?: MeasureField[] | undefined; + IconSetType?: ConditionalFormattingIconSetType | undefined; } /** - *

The field well configuration of a heat map.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

+ *

The formatting configuration for the icon.

* @public */ -export interface HeatMapFieldWells { +export interface ConditionalFormattingIcon { /** - *

The aggregated field wells of a heat map.

+ *

Formatting configuration for icon set.

* @public */ - HeatMapAggregatedFieldWells?: HeatMapAggregatedFieldWells | undefined; -} + IconSet?: ConditionalFormattingIconSet | undefined; + + /** + *

Determines the custom condition for an icon set.

+ * @public + */ + CustomCondition?: ConditionalFormattingCustomIconCondition | undefined; +} /** - *

The sort configuration of a heat map.

+ *

The conditional formatting for the primary value of a GaugeChartVisual.

* @public */ -export interface HeatMapSortConfiguration { +export interface GaugeChartPrimaryValueConditionalFormatting { /** - *

The field sort configuration of the rows fields.

+ *

The conditional formatting of the primary value text color.

* @public */ - HeatMapRowSort?: FieldSortOptions[] | undefined; + TextColor?: ConditionalFormattingColor | undefined; /** - *

The column sort configuration for heat map for columns that aren't a part of a field well.

+ *

The conditional formatting of the primary value icon.

* @public */ - HeatMapColumnSort?: FieldSortOptions[] | undefined; + Icon?: ConditionalFormattingIcon | undefined; +} +/** + *

Conditional formatting options of a GaugeChartVisual.

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

The limit on the number of rows that are displayed in a heat map.

+ *

The conditional formatting for the primary value of a GaugeChartVisual.

* @public */ - HeatMapRowItemsLimitConfiguration?: ItemsLimitConfiguration | undefined; + PrimaryValue?: GaugeChartPrimaryValueConditionalFormatting | undefined; /** - *

The limit on the number of columns that are displayed in a heat map.

+ *

The options that determine the presentation of the arc of a GaugeChartVisual.

* @public */ - HeatMapColumnItemsLimitConfiguration?: ItemsLimitConfiguration | undefined; + Arc?: GaugeChartArcConditionalFormatting | undefined; } /** - *

The configuration of a heat map.

+ *

The conditional formatting of a GaugeChartVisual.

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

The field wells of the visual.

- * @public - */ - FieldWells?: HeatMapFieldWells | undefined; - +export interface GaugeChartConditionalFormatting { /** - *

The sort configuration of a heat map.

+ *

Conditional formatting options of a GaugeChartVisual.

* @public */ - SortConfiguration?: HeatMapSortConfiguration | undefined; + ConditionalFormattingOptions?: GaugeChartConditionalFormattingOption[] | undefined; +} +/** + *

A gauge chart.

+ *

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

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

The label options of the row that is displayed in a heat map.

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

* @public */ - RowLabelOptions?: ChartAxisLabelOptions | undefined; + VisualId: string | undefined; /** - *

The label options of the column that is displayed in a heat map.

+ *

The title that is displayed on the visual.

* @public */ - ColumnLabelOptions?: ChartAxisLabelOptions | undefined; + Title?: VisualTitleLabelOptions | undefined; /** - *

The color options (gradient color, point of divergence) in a heat map.

+ *

The subtitle that is displayed on the visual.

* @public */ - ColorScale?: ColorScale | undefined; + Subtitle?: VisualSubtitleLabelOptions | undefined; /** - *

The legend display setup of the visual.

+ *

The configuration of a GaugeChartVisual.

* @public */ - Legend?: LegendOptions | undefined; + ChartConfiguration?: GaugeChartConfiguration | undefined; /** - *

The options that determine if visual data labels are displayed.

+ *

The conditional formatting of a GaugeChartVisual.

* @public */ - DataLabels?: DataLabelOptions | undefined; + ConditionalFormatting?: GaugeChartConditionalFormatting | undefined; /** - *

The tooltip display setup of the visual.

+ *

The list of custom actions that are configured for a visual.

* @public */ - Tooltip?: TooltipOptions | undefined; + Actions?: VisualCustomAction[] | undefined; /** - *

The general visual interactions setup for a visual.

+ *

The alt text for the visual.

* @public */ - Interactions?: VisualInteractionOptions | undefined; + VisualContentAltText?: string | undefined; } /** - *

A heat map.

- *

For more information, see Using heat maps in the Amazon QuickSight User Guide.

+ *

The aggregated field wells for a geospatial map.

* @public */ -export interface HeatMapVisual { +export interface GeospatialMapAggregatedFieldWells { /** - *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

+ *

The geospatial field wells of a geospatial map. Values are grouped by geospatial fields.

* @public */ - VisualId: string | undefined; + Geospatial?: DimensionField[] | undefined; /** - *

The title that is displayed on the visual.

+ *

The size field wells of a geospatial map. Values are aggregated based on geospatial fields.

* @public */ - Title?: VisualTitleLabelOptions | undefined; + Values?: MeasureField[] | undefined; /** - *

The subtitle that is displayed on the visual.

+ *

The color field wells of a geospatial map.

* @public */ - Subtitle?: VisualSubtitleLabelOptions | undefined; + Colors?: DimensionField[] | undefined; +} +/** + *

The field wells of a GeospatialMapVisual.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The configuration of a heat map.

+ *

The aggregated field well for a geospatial map.

* @public */ - ChartConfiguration?: HeatMapConfiguration | undefined; + GeospatialMapAggregatedFieldWells?: GeospatialMapAggregatedFieldWells | undefined; +} +/** + *

The simple cluster marker of the cluster marker.

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

The column hierarchy that is used during drill-downs and drill-ups.

+ *

The color of the simple cluster marker.

* @public */ - ColumnHierarchies?: ColumnHierarchy[] | undefined; + Color?: string | undefined; +} +/** + *

The cluster marker that is a part of the cluster marker + * configuration.

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

The list of custom actions that are configured for a visual.

+ *

The simple cluster marker of the cluster marker.

* @public */ - Actions?: VisualCustomAction[] | undefined; + SimpleClusterMarker?: SimpleClusterMarker | undefined; } /** - *

The options that determine the bin count of a histogram.

+ *

The cluster marker configuration of the geospatial map selected point style.

* @public */ -export interface BinCountOptions { +export interface ClusterMarkerConfiguration { /** - *

The options that determine the bin count value.

+ *

The cluster marker that is a part of the cluster marker configuration.

* @public */ - Value?: number | undefined; + ClusterMarker?: ClusterMarker | undefined; } /** - *

The options that determine the bin width of a histogram.

+ *

The color to be used in the heatmap point style.

* @public */ -export interface BinWidthOptions { +export interface GeospatialHeatmapDataColor { /** - *

The options that determine the bin width value.

+ *

The hex color to be used in the heatmap point style.

* @public */ - Value?: number | undefined; + Color: string | undefined; +} +/** + *

The color scale specification for the heatmap point style.

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

The options that determine the bin count limit.

+ *

The list of colors to be used in heatmap point style.

* @public */ - BinCountLimit?: number | undefined; + Colors?: GeospatialHeatmapDataColor[] | undefined; +} + +/** + *

The heatmap configuration of the geospatial point style.

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

The color scale specification for the heatmap point style.

+ * @public + */ + HeatmapColor?: GeospatialHeatmapColorScale | undefined; } /** * @public * @enum */ -export const HistogramBinType = { - BIN_COUNT: "BIN_COUNT", - BIN_WIDTH: "BIN_WIDTH", +export const GeospatialSelectedPointStyle = { + CLUSTER: "CLUSTER", + HEATMAP: "HEATMAP", + POINT: "POINT", } as const; /** * @public */ -export type HistogramBinType = (typeof HistogramBinType)[keyof typeof HistogramBinType]; +export type GeospatialSelectedPointStyle = + (typeof GeospatialSelectedPointStyle)[keyof typeof GeospatialSelectedPointStyle]; /** - *

The options that determine the presentation of histogram bins.

+ *

The point style of the geospatial map.

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

The options that determine the selected bin type.

- * @public - */ - SelectedBinType?: HistogramBinType | undefined; - +export interface GeospatialPointStyleOptions { /** - *

The options that determine the bin count of a histogram.

+ *

The selected point styles (point, cluster) of the geospatial map.

* @public */ - BinCount?: BinCountOptions | undefined; + SelectedPointStyle?: GeospatialSelectedPointStyle | undefined; /** - *

The options that determine the bin width of a histogram.

+ *

The cluster marker configuration of the geospatial point style.

* @public */ - BinWidth?: BinWidthOptions | undefined; + ClusterMarkerConfiguration?: ClusterMarkerConfiguration | undefined; /** - *

The options that determine the bin start value.

+ *

The heatmap configuration of the geospatial point style.

* @public */ - StartValue?: number | undefined; + HeatmapConfiguration?: GeospatialHeatmapConfiguration | undefined; } /** - *

The field well configuration of a histogram.

+ *

The configuration of a GeospatialMapVisual.

* @public */ -export interface HistogramAggregatedFieldWells { +export interface GeospatialMapConfiguration { /** - *

The value field wells of a histogram. Values are aggregated by COUNT or DISTINCT_COUNT.

+ *

The field wells of the visual.

* @public */ - Values?: MeasureField[] | undefined; -} + FieldWells?: GeospatialMapFieldWells | undefined; -/** - *

The field well configuration of a histogram.

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

The field well configuration of a histogram.

+ *

The legend display setup of the visual.

* @public */ - HistogramAggregatedFieldWells?: HistogramAggregatedFieldWells | undefined; -} + Legend?: LegendOptions | undefined; -/** - *

The configuration for a HistogramVisual.

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

The field well configuration of a histogram.

+ *

The tooltip display setup of the visual.

* @public */ - FieldWells?: HistogramFieldWells | undefined; + Tooltip?: TooltipOptions | undefined; /** - *

The options that determine the presentation of the x-axis.

+ *

The window options of the geospatial map.

* @public */ - XAxisDisplayOptions?: AxisDisplayOptions | undefined; + WindowOptions?: GeospatialWindowOptions | undefined; /** - *

The options that determine the presentation of the x-axis label.

+ *

The map style options of the geospatial map.

* @public */ - XAxisLabelOptions?: ChartAxisLabelOptions | undefined; + MapStyleOptions?: GeospatialMapStyleOptions | undefined; /** - *

The options that determine the presentation of the y-axis.

+ *

The point style options of the geospatial map.

* @public */ - YAxisDisplayOptions?: AxisDisplayOptions | undefined; + PointStyleOptions?: GeospatialPointStyleOptions | undefined; /** - *

The options that determine the presentation of histogram bins.

+ *

The visual display options for the visual palette.

* @public */ - BinOptions?: HistogramBinOptions | undefined; + VisualPalette?: VisualPalette | undefined; /** - *

The data label configuration of a histogram.

+ *

The general visual interactions setup for a visual.

* @public */ - DataLabels?: DataLabelOptions | undefined; + Interactions?: VisualInteractionOptions | undefined; +} +/** + *

A geospatial map or a points on map visual.

+ *

For more information, see Creating point maps in the Amazon QuickSight User Guide.

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

The tooltip configuration of a histogram.

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

* @public */ - Tooltip?: TooltipOptions | undefined; - - /** - *

The visual palette configuration of a histogram.

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

The general visual interactions setup for a visual.

+ *

The title that is displayed on the visual.

* @public */ - Interactions?: VisualInteractionOptions | undefined; -} + Title?: VisualTitleLabelOptions | undefined; -/** - *

A histogram.

- *

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

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

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

+ *

The subtitle that is displayed on the visual.

* @public */ - VisualId: string | undefined; + Subtitle?: VisualSubtitleLabelOptions | undefined; /** - *

The title that is displayed on the visual.

+ *

The configuration settings of the visual.

* @public */ - Title?: VisualTitleLabelOptions | undefined; + ChartConfiguration?: GeospatialMapConfiguration | undefined; /** - *

The subtitle that is displayed on the visual.

+ *

The column hierarchy that is used during drill-downs and drill-ups.

* @public */ - Subtitle?: VisualSubtitleLabelOptions | undefined; + ColumnHierarchies?: ColumnHierarchy[] | undefined; /** - *

The configuration for a HistogramVisual.

+ *

The list of custom actions that are configured for a visual.

* @public */ - ChartConfiguration?: HistogramConfiguration | undefined; + Actions?: VisualCustomAction[] | undefined; /** - *

The list of custom actions that are configured for a visual.

+ *

The alt text for the visual.

* @public */ - Actions?: VisualCustomAction[] | undefined; + VisualContentAltText?: string | undefined; } /** * @public * @enum */ -export const ForecastComputationSeasonality = { - AUTOMATIC: "AUTOMATIC", - CUSTOM: "CUSTOM", +export const ColorFillType = { + DISCRETE: "DISCRETE", + GRADIENT: "GRADIENT", } as const; /** * @public */ -export type ForecastComputationSeasonality = - (typeof ForecastComputationSeasonality)[keyof typeof ForecastComputationSeasonality]; +export type ColorFillType = (typeof ColorFillType)[keyof typeof ColorFillType]; /** - *

The forecast computation configuration.

+ *

Determines the color that is applied to a particular data value.

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

The ID for a computation.

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

The name of a computation.

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

The time field that is used in a computation.

- * @public - */ - Time?: DimensionField | undefined; - +export interface DataColor { /** - *

The value field that is used in a computation.

+ *

The color that is applied to the data value.

* @public */ - Value?: MeasureField | undefined; + Color?: string | undefined; /** - *

The periods forward setup of a forecast computation.

+ *

The data value that the color is applied to.

* @public */ - PeriodsForward?: number | undefined; + DataValue?: number | undefined; +} +/** + *

Determines the color scale that is applied to the visual.

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

The periods backward setup of a forecast computation.

+ *

Determines the list of colors that are applied to the visual.

* @public */ - PeriodsBackward?: number | undefined; + Colors: DataColor[] | undefined; /** - *

The upper boundary setup of a forecast computation.

+ *

Determines the color fill type.

* @public */ - UpperBoundary?: number | undefined; + ColorFillType: ColorFillType | undefined; /** - *

The lower boundary setup of a forecast computation.

+ *

Determines the color that is applied to null values.

* @public */ - LowerBoundary?: number | undefined; + NullValueColor?: DataColor | undefined; +} +/** + *

The aggregated field wells of a heat map.

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

The prediction interval setup of a forecast computation.

+ *

The rows field well of a heat map.

* @public */ - PredictionInterval?: number | undefined; + Rows?: DimensionField[] | undefined; /** - *

The seasonality setup of a forecast computation. Choose one of the following options:

- *
    - *
  • - *

    - * AUTOMATIC - *

    - *
  • - *
  • - *

    - * CUSTOM: Checks the custom seasonality value.

    - *
  • - *
+ *

The columns field well of a heat map.

* @public */ - Seasonality?: ForecastComputationSeasonality | undefined; + Columns?: DimensionField[] | undefined; /** - *

The custom seasonality value setup of a forecast computation.

+ *

The values field well of a heat map.

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

The growth rate computation configuration.

+ *

The field well configuration of a heat map.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

* @public */ -export interface GrowthRateComputation { +export interface HeatMapFieldWells { /** - *

The ID for a computation.

+ *

The aggregated field wells of a heat map.

* @public */ - ComputationId: string | undefined; + HeatMapAggregatedFieldWells?: HeatMapAggregatedFieldWells | undefined; +} +/** + *

The sort configuration of a heat map.

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

The name of a computation.

+ *

The field sort configuration of the rows fields.

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

The time field that is used in a computation.

+ *

The column sort configuration for heat map for columns that aren't a part of a field well.

* @public */ - Time?: DimensionField | undefined; + HeatMapColumnSort?: FieldSortOptions[] | undefined; /** - *

The value field that is used in a computation.

+ *

The limit on the number of rows that are displayed in a heat map.

* @public */ - Value?: MeasureField | undefined; + HeatMapRowItemsLimitConfiguration?: ItemsLimitConfiguration | undefined; /** - *

The period size setup of a growth rate computation.

+ *

The limit on the number of columns that are displayed in a heat map.

* @public */ - PeriodSize?: number | undefined; + HeatMapColumnItemsLimitConfiguration?: ItemsLimitConfiguration | undefined; } /** - * @public - * @enum - */ -export const MaximumMinimumComputationType = { - MAXIMUM: "MAXIMUM", - MINIMUM: "MINIMUM", -} as const; - -/** - * @public - */ -export type MaximumMinimumComputationType = - (typeof MaximumMinimumComputationType)[keyof typeof MaximumMinimumComputationType]; - -/** - *

The maximum and minimum computation configuration.

+ *

The configuration of a heat map.

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

The ID for a computation.

- * @public - */ - ComputationId: string | undefined; - +export interface HeatMapConfiguration { /** - *

The name of a computation.

+ *

The field wells of the visual.

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

The time field that is used in a computation.

+ *

The sort configuration of a heat map.

* @public */ - Time?: DimensionField | undefined; + SortConfiguration?: HeatMapSortConfiguration | undefined; /** - *

The value field that is used in a computation.

+ *

The label options of the row that is displayed in a heat map.

* @public */ - Value?: MeasureField | undefined; + RowLabelOptions?: ChartAxisLabelOptions | undefined; /** - *

The type of computation. Choose one of the following options:

- *
    - *
  • - *

    MAXIMUM: A maximum computation.

    - *
  • - *
  • - *

    MINIMUM: A minimum computation.

    - *
  • - *
+ *

The label options of the column that is displayed in a heat map.

* @public */ - Type: MaximumMinimumComputationType | undefined; -} + ColumnLabelOptions?: ChartAxisLabelOptions | undefined; -/** - *

The metric comparison computation configuration.

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

The ID for a computation.

+ *

The color options (gradient color, point of divergence) in a heat map.

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

The name of a computation.

+ *

The legend display setup of the visual.

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

The time field that is used in a computation.

+ *

The options that determine if visual data labels are displayed.

* @public */ - Time?: DimensionField | undefined; + DataLabels?: DataLabelOptions | undefined; /** - *

The field that is used in a metric comparison from value setup.

+ *

The tooltip display setup of the visual.

* @public */ - FromValue?: MeasureField | undefined; + Tooltip?: TooltipOptions | undefined; /** - *

The field that is used in a metric comparison to value setup.

+ *

The general visual interactions setup for a visual.

* @public */ - TargetValue?: MeasureField | undefined; + Interactions?: VisualInteractionOptions | undefined; } /** - *

The period over period computation configuration.

+ *

A heat map.

+ *

For more information, see Using heat maps in the Amazon QuickSight User Guide.

* @public */ -export interface PeriodOverPeriodComputation { +export interface HeatMapVisual { /** - *

The ID for a computation.

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

* @public */ - ComputationId: string | undefined; + VisualId: string | undefined; /** - *

The name of a computation.

+ *

The title that is displayed on the visual.

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

The time field that is used in a computation.

+ *

The subtitle that is displayed on the visual.

* @public */ - Time?: DimensionField | undefined; + Subtitle?: VisualSubtitleLabelOptions | undefined; /** - *

The value field that is used in a computation.

+ *

The configuration of a heat map.

* @public */ - Value?: MeasureField | undefined; -} + ChartConfiguration?: HeatMapConfiguration | undefined; -/** - *

The period to date computation configuration.

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

The ID for a computation.

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

The name of a computation.

+ *

The column hierarchy that is used during drill-downs and drill-ups.

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

The time field that is used in a computation.

+ *

The list of custom actions that are configured for a visual.

* @public */ - Time?: DimensionField | undefined; + Actions?: VisualCustomAction[] | undefined; /** - *

The value field that is used in a computation.

+ *

The alt text for the visual.

* @public */ - Value?: MeasureField | undefined; + VisualContentAltText?: string | undefined; +} +/** + *

The options that determine the bin count of a histogram.

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

The time granularity setup of period to date computation. Choose from the following options:

- *
    - *
  • - *

    YEAR: Year to date.

    - *
  • - *
  • - *

    MONTH: Month to date.

    - *
  • - *
+ *

The options that determine the bin count value.

* @public */ - PeriodTimeGranularity?: TimeGranularity | undefined; + Value?: number | undefined; } /** + *

The options that determine the bin width of a histogram.

* @public - * @enum */ -export const TopBottomSortOrder = { - ABSOLUTE_DIFFERENCE: "ABSOLUTE_DIFFERENCE", - PERCENT_DIFFERENCE: "PERCENT_DIFFERENCE", -} as const; +export interface BinWidthOptions { + /** + *

The options that determine the bin width value.

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

The options that determine the bin count limit.

+ * @public + */ + BinCountLimit?: number | undefined; +} /** * @public * @enum */ -export const TopBottomComputationType = { - BOTTOM: "BOTTOM", - TOP: "TOP", +export const HistogramBinType = { + BIN_COUNT: "BIN_COUNT", + BIN_WIDTH: "BIN_WIDTH", } as const; /** * @public */ -export type TopBottomComputationType = (typeof TopBottomComputationType)[keyof typeof TopBottomComputationType]; +export type HistogramBinType = (typeof HistogramBinType)[keyof typeof HistogramBinType]; /** - *

The top movers and bottom movers computation setup.

+ *

The options that determine the presentation of histogram bins.

* @public */ -export interface TopBottomMoversComputation { +export interface HistogramBinOptions { /** - *

The ID for a computation.

+ *

The options that determine the selected bin type.

* @public */ - ComputationId: string | undefined; + SelectedBinType?: HistogramBinType | undefined; /** - *

The name of a computation.

+ *

The options that determine the bin count of a histogram.

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

The time field that is used in a computation.

+ *

The options that determine the bin width of a histogram.

* @public */ - Time?: DimensionField | undefined; + BinWidth?: BinWidthOptions | undefined; /** - *

The category field that is used in a computation.

+ *

The options that determine the bin start value.

* @public */ - Category?: DimensionField | undefined; + StartValue?: number | undefined; +} +/** + *

The field well configuration of a histogram.

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

The value field that is used in a computation.

+ *

The value field wells of a histogram. Values are aggregated by COUNT or DISTINCT_COUNT.

* @public */ - Value?: MeasureField | undefined; + Values?: MeasureField[] | undefined; +} +/** + *

The field well configuration of a histogram.

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

The mover size setup of the top and bottom movers computation.

+ *

The field well configuration of a histogram.

* @public */ - MoverSize?: number | undefined; + HistogramAggregatedFieldWells?: HistogramAggregatedFieldWells | undefined; +} +/** + *

The configuration for a HistogramVisual.

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

The sort order setup of the top and bottom movers computation.

+ *

The field well configuration of a histogram.

* @public */ - SortOrder?: TopBottomSortOrder | undefined; + FieldWells?: HistogramFieldWells | undefined; /** - *

The computation type. Choose from the following options:

- *
    - *
  • - *

    TOP: Top movers computation.

    - *
  • - *
  • - *

    BOTTOM: Bottom movers computation.

    - *
  • - *
+ *

The options that determine the presentation of the x-axis.

* @public */ - Type: TopBottomComputationType | undefined; -} + XAxisDisplayOptions?: AxisDisplayOptions | undefined; -/** - *

The top ranked and bottom ranked computation configuration.

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

The ID for a computation.

+ *

The options that determine the presentation of the x-axis label.

* @public */ - ComputationId: string | undefined; + XAxisLabelOptions?: ChartAxisLabelOptions | undefined; /** - *

The name of a computation.

+ *

The options that determine the presentation of the y-axis.

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

The category field that is used in a computation.

+ *

The options that determine the presentation of histogram bins.

* @public */ - Category?: DimensionField | undefined; + BinOptions?: HistogramBinOptions | undefined; /** - *

The value field that is used in a computation.

+ *

The data label configuration of a histogram.

* @public */ - Value?: MeasureField | undefined; + DataLabels?: DataLabelOptions | undefined; /** - *

The result size of a top and bottom ranked computation.

+ *

The tooltip configuration of a histogram.

* @public */ - ResultSize?: number | undefined; + Tooltip?: TooltipOptions | undefined; /** - *

The computation type. Choose one of the following options:

- *
    - *
  • - *

    TOP: A top ranked computation.

    - *
  • - *
  • - *

    BOTTOM: A bottom ranked computation.

    - *
  • - *
+ *

The visual palette configuration of a histogram.

* @public */ - Type: TopBottomComputationType | undefined; + VisualPalette?: VisualPalette | undefined; + + /** + *

The general visual interactions setup for a visual.

+ * @public + */ + Interactions?: VisualInteractionOptions | undefined; } /** - *

The total aggregation computation configuration.

+ *

A histogram.

+ *

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

* @public */ -export interface TotalAggregationComputation { +export interface HistogramVisual { /** - *

The ID for a computation.

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

* @public */ - ComputationId: string | undefined; + VisualId: string | undefined; /** - *

The name of a computation.

+ *

The title that is displayed on the visual.

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

The value field that is used in a computation.

+ *

The subtitle that is displayed on the visual.

* @public */ - Value?: MeasureField | undefined; -} + Subtitle?: VisualSubtitleLabelOptions | undefined; -/** - *

The unique values computation configuration.

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

The ID for a computation.

+ *

The configuration for a HistogramVisual.

* @public */ - ComputationId: string | undefined; + ChartConfiguration?: HistogramConfiguration | undefined; /** - *

The name of a computation.

+ *

The list of custom actions that are configured for a visual.

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

The category field that is used in a computation.

+ *

The alt text for the visual.

* @public */ - Category?: DimensionField | undefined; + VisualContentAltText?: string | undefined; } /** - *

The computation union that is used in an insight visual.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

* @public + * @enum */ -export interface Computation { +export const ForecastComputationSeasonality = { + AUTOMATIC: "AUTOMATIC", + CUSTOM: "CUSTOM", +} as const; + +/** + * @public + */ +export type ForecastComputationSeasonality = + (typeof ForecastComputationSeasonality)[keyof typeof ForecastComputationSeasonality]; + +/** + *

The forecast computation configuration.

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

The top ranked and bottom ranked computation configuration.

+ *

The ID for a computation.

* @public */ - TopBottomRanked?: TopBottomRankedComputation | undefined; + ComputationId: string | undefined; /** - *

The top movers and bottom movers computation configuration.

+ *

The name of a computation.

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

The total aggregation computation configuration.

+ *

The time field that is used in a computation.

* @public */ - TotalAggregation?: TotalAggregationComputation | undefined; + Time?: DimensionField | undefined; /** - *

The maximum and minimum computation configuration.

+ *

The value field that is used in a computation.

* @public */ - MaximumMinimum?: MaximumMinimumComputation | undefined; + Value?: MeasureField | undefined; /** - *

The metric comparison computation configuration.

+ *

The periods forward setup of a forecast computation.

* @public */ - MetricComparison?: MetricComparisonComputation | undefined; + PeriodsForward?: number | undefined; /** - *

The period over period computation configuration.

+ *

The periods backward setup of a forecast computation.

* @public */ - PeriodOverPeriod?: PeriodOverPeriodComputation | undefined; + PeriodsBackward?: number | undefined; /** - *

The period to DataSetIdentifier computation configuration.

+ *

The upper boundary setup of a forecast computation.

* @public */ - PeriodToDate?: PeriodToDateComputation | undefined; + UpperBoundary?: number | undefined; /** - *

The growth rate computation configuration.

+ *

The lower boundary setup of a forecast computation.

* @public */ - GrowthRate?: GrowthRateComputation | undefined; + LowerBoundary?: number | undefined; /** - *

The unique values computation configuration.

+ *

The prediction interval setup of a forecast computation.

* @public */ - UniqueValues?: UniqueValuesComputation | undefined; + PredictionInterval?: number | undefined; /** - *

The forecast computation configuration.

+ *

The seasonality setup of a forecast computation. Choose one of the following options:

+ *
    + *
  • + *

    + * AUTOMATIC + *

    + *
  • + *
  • + *

    + * CUSTOM: Checks the custom seasonality value.

    + *
  • + *
* @public */ - Forecast?: ForecastComputation | undefined; -} + Seasonality?: ForecastComputationSeasonality | undefined; -/** - *

The custom narrative options.

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

The string input of custom narrative.

+ *

The custom seasonality value setup of a forecast computation.

* @public */ - Narrative: string | undefined; + CustomSeasonalityValue?: number | undefined; } /** - *

The configuration of an insight visual.

+ *

The growth rate computation configuration.

* @public */ -export interface InsightConfiguration { +export interface GrowthRateComputation { /** - *

The computations configurations of the insight visual

+ *

The ID for a computation.

* @public */ - Computations?: Computation[] | undefined; + ComputationId: string | undefined; /** - *

The custom narrative of the insight visual.

+ *

The name of a computation.

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

The general visual interactions setup for a visual.

+ *

The time field that is used in a computation.

* @public */ - Interactions?: VisualInteractionOptions | undefined; + Time?: DimensionField | undefined; + + /** + *

The value field that is used in a computation.

+ * @public + */ + Value?: MeasureField | undefined; + + /** + *

The period size setup of a growth rate computation.

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

An insight visual.

- *

For more information, see Working with insights in the Amazon QuickSight User Guide.

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

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

- * @public - */ - VisualId: string | undefined; +export const MaximumMinimumComputationType = { + MAXIMUM: "MAXIMUM", + MINIMUM: "MINIMUM", +} as const; + +/** + * @public + */ +export type MaximumMinimumComputationType = + (typeof MaximumMinimumComputationType)[keyof typeof MaximumMinimumComputationType]; +/** + *

The maximum and minimum computation configuration.

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

The title that is displayed on the visual.

+ *

The ID for a computation.

* @public */ - Title?: VisualTitleLabelOptions | undefined; + ComputationId: string | undefined; /** - *

The subtitle that is displayed on the visual.

+ *

The name of a computation.

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

The configuration of an insight visual.

+ *

The time field that is used in a computation.

* @public */ - InsightConfiguration?: InsightConfiguration | undefined; + Time?: DimensionField | undefined; /** - *

The list of custom actions that are configured for a visual.

+ *

The value field that is used in a computation.

* @public */ - Actions?: VisualCustomAction[] | undefined; + Value?: MeasureField | undefined; /** - *

The dataset that is used in the insight visual.

+ *

The type of computation. Choose one of the following options:

+ *
    + *
  • + *

    MAXIMUM: A maximum computation.

    + *
  • + *
  • + *

    MINIMUM: A minimum computation.

    + *
  • + *
* @public */ - DataSetIdentifier: string | undefined; + Type: MaximumMinimumComputationType | undefined; } /** - *

The field well configuration of a KPI visual.

+ *

The metric comparison computation configuration.

* @public */ -export interface KPIFieldWells { +export interface MetricComparisonComputation { /** - *

The value field wells of a KPI visual.

+ *

The ID for a computation.

* @public */ - Values?: MeasureField[] | undefined; + ComputationId: string | undefined; /** - *

The target value field wells of a KPI visual.

+ *

The name of a computation.

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

The trend group field wells of a KPI visual.

+ *

The time field that is used in a computation.

* @public */ - TrendGroups?: DimensionField[] | undefined; -} + Time?: DimensionField | undefined; -/** - *

The options that determine the presentation of the progress bar of a KPI visual.

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

The visibility of the progress bar.

+ *

The field that is used in a metric comparison from value setup.

* @public */ - Visibility?: Visibility | undefined; -} + FromValue?: MeasureField | undefined; -/** - *

The options that determine the presentation of the secondary value of a KPI visual.

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

Determines the visibility of the secondary value.

+ *

The field that is used in a metric comparison to value setup.

* @public */ - Visibility?: Visibility | undefined; + TargetValue?: MeasureField | undefined; } /** + *

The period over period computation configuration.

* @public - * @enum */ -export const KPISparklineType = { - AREA: "AREA", - LINE: "LINE", -} as const; +export interface PeriodOverPeriodComputation { + /** + *

The ID for a computation.

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

The name of a computation.

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

The time field that is used in a computation.

+ * @public + */ + Time?: DimensionField | undefined; + + /** + *

The value field that is used in a computation.

+ * @public + */ + Value?: MeasureField | undefined; +} /** - *

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

+ *

The period to date computation configuration.

* @public */ -export interface KPISparklineOptions { +export interface PeriodToDateComputation { /** - *

The visibility of the sparkline.

+ *

The ID for a computation.

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

The type of the sparkline.

+ *

The name of a computation.

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

The color of the sparkline.

+ *

The time field that is used in a computation.

* @public */ - Color?: string | undefined; + Time?: DimensionField | undefined; /** - *

The tooltip visibility of the sparkline.

+ *

The value field that is used in a computation.

* @public */ - TooltipVisibility?: Visibility | undefined; -} + Value?: MeasureField | undefined; -/** - *

The options that determine the presentation of trend arrows in a KPI visual.

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

The visibility of the trend arrows.

+ *

The time granularity setup of period to date computation. Choose from the following options:

+ *
    + *
  • + *

    YEAR: Year to date.

    + *
  • + *
  • + *

    MONTH: Month to date.

    + *
  • + *
* @public */ - Visibility?: Visibility | undefined; + PeriodTimeGranularity?: TimeGranularity | undefined; } /** * @public * @enum */ -export const KPIVisualStandardLayoutType = { - CLASSIC: "CLASSIC", - VERTICAL: "VERTICAL", +export const TopBottomSortOrder = { + ABSOLUTE_DIFFERENCE: "ABSOLUTE_DIFFERENCE", + PERCENT_DIFFERENCE: "PERCENT_DIFFERENCE", } as const; /** * @public */ -export type KPIVisualStandardLayoutType = - (typeof KPIVisualStandardLayoutType)[keyof typeof KPIVisualStandardLayoutType]; +export type TopBottomSortOrder = (typeof TopBottomSortOrder)[keyof typeof TopBottomSortOrder]; /** - *

The standard layout of the KPI visual.

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

The standard layout type.

- * @public - */ - Type: KPIVisualStandardLayoutType | undefined; -} +export const TopBottomComputationType = { + BOTTOM: "BOTTOM", + TOP: "TOP", +} as const; /** - *

The options that determine the layout a KPI visual.

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

The standard layout of the KPI visual.

- * @public - */ - StandardLayout?: KPIVisualStandardLayout | undefined; -} +export type TopBottomComputationType = (typeof TopBottomComputationType)[keyof typeof TopBottomComputationType]; /** - *

The options that determine the presentation of a KPI visual.

+ *

The top movers and bottom movers computation setup.

* @public */ -export interface KPIOptions { +export interface TopBottomMoversComputation { /** - *

The options that determine the presentation of the progress bar of a KPI visual.

+ *

The ID for a computation.

* @public */ - ProgressBar?: ProgressBarOptions | undefined; + ComputationId: string | undefined; /** - *

The options that determine the presentation of trend arrows in a KPI visual.

- * @public - */ - TrendArrows?: TrendArrowOptions | undefined; - - /** - *

The options that determine the presentation of the secondary value of a KPI visual.

- * @public - */ - SecondaryValue?: SecondaryValueOptions | undefined; - - /** - *

The comparison configuration of a KPI visual.

- * @public - */ - Comparison?: ComparisonConfiguration | undefined; - - /** - *

The options that determine the primary value display type.

- * @public - */ - PrimaryValueDisplayType?: PrimaryValueDisplayType | undefined; - - /** - *

The options that determine the primary value font configuration.

- * @public - */ - PrimaryValueFontConfiguration?: FontConfiguration | undefined; - - /** - *

The options that determine the secondary value font configuration.

- * @public - */ - SecondaryValueFontConfiguration?: FontConfiguration | undefined; - - /** - *

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

- * @public - */ - Sparkline?: KPISparklineOptions | undefined; - - /** - *

The options that determine the layout a KPI visual.

- * @public - */ - VisualLayoutOptions?: KPIVisualLayoutOptions | undefined; -} - -/** - *

The sort configuration of a KPI visual.

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

The sort configuration of the trend group fields.

- * @public - */ - TrendGroupSort?: FieldSortOptions[] | undefined; -} - -/** - *

The configuration of a KPI visual.

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

The field well configuration of a KPI visual.

- * @public - */ - FieldWells?: KPIFieldWells | undefined; - - /** - *

The sort configuration of a KPI visual.

- * @public - */ - SortConfiguration?: KPISortConfiguration | undefined; - - /** - *

The options that determine the presentation of a KPI visual.

+ *

The name of a computation.

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

The general visual interactions setup for a visual.

- * @public - */ - Interactions?: VisualInteractionOptions | undefined; -} - -/** - *

The conditional formatting for the actual value of a KPI visual.

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

The conditional formatting of the actual value's text color.

+ *

The time field that is used in a computation.

* @public */ - TextColor?: ConditionalFormattingColor | undefined; + Time?: DimensionField | undefined; /** - *

The conditional formatting of the actual value's icon.

+ *

The category field that is used in a computation.

* @public */ - Icon?: ConditionalFormattingIcon | undefined; -} + Category?: DimensionField | undefined; -/** - *

The conditional formatting for the comparison value of a KPI visual.

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

The conditional formatting of the comparison value's text color.

+ *

The value field that is used in a computation.

* @public */ - TextColor?: ConditionalFormattingColor | undefined; + Value?: MeasureField | undefined; /** - *

The conditional formatting of the comparison value's icon.

+ *

The mover size setup of the top and bottom movers computation.

* @public */ - Icon?: ConditionalFormattingIcon | undefined; -} + MoverSize?: number | undefined; -/** - *

The conditional formatting for the primary value of a KPI visual.

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

The conditional formatting of the primary value's text color.

+ *

The sort order setup of the top and bottom movers computation.

* @public */ - TextColor?: ConditionalFormattingColor | undefined; + SortOrder?: TopBottomSortOrder | undefined; /** - *

The conditional formatting of the primary value's icon.

+ *

The computation type. Choose from the following options:

+ *
    + *
  • + *

    TOP: Top movers computation.

    + *
  • + *
  • + *

    BOTTOM: Bottom movers computation.

    + *
  • + *
* @public */ - Icon?: ConditionalFormattingIcon | undefined; + Type: TopBottomComputationType | undefined; } /** - *

The conditional formatting for the progress bar of a KPI visual.

+ *

The top ranked and bottom ranked computation configuration.

* @public */ -export interface KPIProgressBarConditionalFormatting { +export interface TopBottomRankedComputation { /** - *

The conditional formatting of the progress bar's foreground color.

+ *

The ID for a computation.

* @public */ - ForegroundColor?: ConditionalFormattingColor | undefined; -} + ComputationId: string | undefined; -/** - *

The conditional formatting options of a KPI visual.

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

The conditional formatting for the primary value of a KPI visual.

+ *

The name of a computation.

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

The conditional formatting for the progress bar of a KPI visual.

+ *

The category field that is used in a computation.

* @public */ - ProgressBar?: KPIProgressBarConditionalFormatting | undefined; + Category?: DimensionField | undefined; /** - *

The conditional formatting for the actual value of a KPI visual.

+ *

The value field that is used in a computation.

* @public */ - ActualValue?: KPIActualValueConditionalFormatting | undefined; + Value?: MeasureField | undefined; /** - *

The conditional formatting for the comparison value of a KPI visual.

+ *

The result size of a top and bottom ranked computation.

* @public */ - ComparisonValue?: KPIComparisonValueConditionalFormatting | undefined; -} + ResultSize?: number | undefined; -/** - *

The conditional formatting of a KPI visual.

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

The conditional formatting options of a KPI visual.

+ *

The computation type. Choose one of the following options:

+ *
    + *
  • + *

    TOP: A top ranked computation.

    + *
  • + *
  • + *

    BOTTOM: A bottom ranked computation.

    + *
  • + *
* @public */ - ConditionalFormattingOptions?: KPIConditionalFormattingOption[] | undefined; + Type: TopBottomComputationType | undefined; } /** - *

A key performance indicator (KPI).

- *

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

+ *

The total aggregation computation configuration.

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

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

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

The title that is displayed on the visual.

- * @public - */ - Title?: VisualTitleLabelOptions | undefined; - - /** - *

The subtitle that is displayed on the visual.

- * @public - */ - Subtitle?: VisualSubtitleLabelOptions | undefined; - - /** - *

The configuration of a KPI visual.

- * @public - */ - ChartConfiguration?: KPIConfiguration | undefined; - +export interface TotalAggregationComputation { /** - *

The conditional formatting of a KPI visual.

+ *

The ID for a computation.

* @public */ - ConditionalFormatting?: KPIConditionalFormatting | undefined; + ComputationId: string | undefined; /** - *

The list of custom actions that are configured for a visual.

+ *

The name of a computation.

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

The column hierarchy that is used during drill-downs and drill-ups.

+ *

The value field that is used in a computation.

* @public */ - ColumnHierarchies?: ColumnHierarchy[] | undefined; + Value?: MeasureField | undefined; } /** - * @public - * @enum - */ -export const LineInterpolation = { - LINEAR: "LINEAR", - SMOOTH: "SMOOTH", - STEPPED: "STEPPED", -} as const; - -/** - * @public - */ -export type LineInterpolation = (typeof LineInterpolation)[keyof typeof LineInterpolation]; - -/** - * @public - * @enum - */ -export const LineChartLineStyle = { - DASHED: "DASHED", - DOTTED: "DOTTED", - SOLID: "SOLID", -} as const; - -/** - * @public - */ -export type LineChartLineStyle = (typeof LineChartLineStyle)[keyof typeof LineChartLineStyle]; - -/** - *

Line styles options for a line series in LineChartVisual.

+ *

The unique values computation configuration.

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

Configuration option that determines whether to show the line for the series.

- * @public - */ - LineVisibility?: Visibility | undefined; - +export interface UniqueValuesComputation { /** - *

Interpolation style for line series.

- *
    - *
  • - *

    - * LINEAR: Show as default, linear style.

    - *
  • - *
  • - *

    - * SMOOTH: Show as a smooth curve.

    - *
  • - *
  • - *

    - * STEPPED: Show steps in line.

    - *
  • - *
+ *

The ID for a computation.

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

Line style for line series.

- *
    - *
  • - *

    - * SOLID: Show as a solid line.

    - *
  • - *
  • - *

    - * DOTTED: Show as a dotted line.

    - *
  • - *
  • - *

    - * DASHED: Show as a dashed line.

    - *
  • - *
+ *

The name of a computation.

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

Width that determines the line thickness.

+ *

The category field that is used in a computation.

* @public */ - LineWidth?: string | undefined; + Category?: DimensionField | undefined; } /** - * @public - * @enum - */ -export const LineChartMarkerShape = { - CIRCLE: "CIRCLE", - DIAMOND: "DIAMOND", - ROUNDED_SQUARE: "ROUNDED_SQUARE", - SQUARE: "SQUARE", - TRIANGLE: "TRIANGLE", -} as const; - -/** - * @public - */ -export type LineChartMarkerShape = (typeof LineChartMarkerShape)[keyof typeof LineChartMarkerShape]; - -/** - *

Marker styles options for a line series in LineChartVisual.

+ *

The computation union that is used in an insight visual.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

Configuration option that determines whether to show the markers in the series.

- * @public - */ - MarkerVisibility?: Visibility | undefined; - - /** - *

Shape option for markers in the series.

- *
    - *
  • - *

    - * CIRCLE: Show marker as a circle.

    - *
  • - *
  • - *

    - * TRIANGLE: Show marker as a triangle.

    - *
  • - *
  • - *

    - * SQUARE: Show marker as a square.

    - *
  • - *
  • - *

    - * DIAMOND: Show marker as a diamond.

    - *
  • - *
  • - *

    - * ROUNDED_SQUARE: Show marker as a rounded square.

    - *
  • - *
+export interface Computation { + /** + *

The top ranked and bottom ranked computation configuration.

* @public */ - MarkerShape?: LineChartMarkerShape | undefined; + TopBottomRanked?: TopBottomRankedComputation | undefined; /** - *

Size of marker in the series.

+ *

The top movers and bottom movers computation configuration.

* @public */ - MarkerSize?: string | undefined; + TopBottomMovers?: TopBottomMoversComputation | undefined; /** - *

Color of marker in the series.

+ *

The total aggregation computation configuration.

* @public */ - MarkerColor?: string | undefined; -} + TotalAggregation?: TotalAggregationComputation | undefined; -/** - *

The options that determine the default presentation of all line series in LineChartVisual.

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

The axis to which you are binding all line series to.

+ *

The maximum and minimum computation configuration.

* @public */ - AxisBinding?: AxisBinding | undefined; + MaximumMinimum?: MaximumMinimumComputation | undefined; /** - *

Line styles options for all line series in the visual.

+ *

The metric comparison computation configuration.

* @public */ - LineStyleSettings?: LineChartLineStyleSettings | undefined; + MetricComparison?: MetricComparisonComputation | undefined; /** - *

Marker styles options for all line series in the visual.

+ *

The period over period computation configuration.

* @public */ - MarkerStyleSettings?: LineChartMarkerStyleSettings | undefined; -} + PeriodOverPeriod?: PeriodOverPeriodComputation | undefined; -/** - *

The field well configuration of a line chart.

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

The category field wells of a line chart. Values are grouped by category fields.

+ *

The period to DataSetIdentifier computation configuration.

* @public */ - Category?: DimensionField[] | undefined; + PeriodToDate?: PeriodToDateComputation | undefined; /** - *

The value field wells of a line chart. Values are aggregated based on categories.

+ *

The growth rate computation configuration.

* @public */ - Values?: MeasureField[] | undefined; + GrowthRate?: GrowthRateComputation | undefined; /** - *

The color field wells of a line chart. Values are grouped by category fields.

+ *

The unique values computation configuration.

* @public */ - Colors?: DimensionField[] | undefined; + UniqueValues?: UniqueValuesComputation | undefined; /** - *

The small multiples field well of a line chart.

+ *

The forecast computation configuration.

* @public */ - SmallMultiples?: DimensionField[] | undefined; + Forecast?: ForecastComputation | undefined; } /** - *

The field well configuration of a line chart.

+ *

The custom narrative options.

* @public */ -export interface LineChartFieldWells { +export interface CustomNarrativeOptions { /** - *

The field well configuration of a line chart.

+ *

The string input of custom narrative.

* @public */ - LineChartAggregatedFieldWells?: LineChartAggregatedFieldWells | undefined; + Narrative: string | undefined; } /** - *

The forecast properties setup of a forecast in the line chart.

+ *

The configuration of an insight visual.

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

The periods forward setup of a forecast computation.

- * @public - */ - PeriodsForward?: number | undefined; - +export interface InsightConfiguration { /** - *

The periods backward setup of a forecast computation.

+ *

The computations configurations of the insight visual

* @public */ - PeriodsBackward?: number | undefined; + Computations?: Computation[] | undefined; /** - *

The upper boundary setup of a forecast computation.

+ *

The custom narrative of the insight visual.

* @public */ - UpperBoundary?: number | undefined; + CustomNarrative?: CustomNarrativeOptions | undefined; /** - *

The lower boundary setup of a forecast computation.

+ *

The general visual interactions setup for a visual.

* @public */ - LowerBoundary?: number | undefined; + Interactions?: VisualInteractionOptions | undefined; +} +/** + *

An insight visual.

+ *

For more information, see Working with insights in the Amazon QuickSight User Guide.

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

The prediction interval setup of a forecast computation.

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

* @public */ - PredictionInterval?: number | undefined; + VisualId: string | undefined; /** - *

The seasonality setup of a forecast computation. Choose one of the following options:

- *
    - *
  • - *

    - * NULL: The input is set to NULL.

    - *
  • - *
  • - *

    - * NON_NULL: The input is set to a custom value.

    - *
  • - *
+ *

The title that is displayed on the visual.

* @public */ - Seasonality?: number | undefined; -} + Title?: VisualTitleLabelOptions | undefined; -/** - *

Provides the forecast to meet the target for a particular date.

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

The date that you need the forecast results for.

+ *

The subtitle that is displayed on the visual.

* @public */ - Date: Date | undefined; + Subtitle?: VisualSubtitleLabelOptions | undefined; /** - *

The target value that you want to meet for the provided date.

+ *

The configuration of an insight visual.

* @public */ - Value: number | undefined; -} + InsightConfiguration?: InsightConfiguration | undefined; -/** - *

Provides the forecast to meet the target for a particular date range.

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

The start date in the date range that you need the forecast results for.

+ *

The list of custom actions that are configured for a visual.

* @public */ - StartDate: Date | undefined; + Actions?: VisualCustomAction[] | undefined; /** - *

The end date in the date range that you need the forecast results for.

+ *

The dataset that is used in the insight visual.

* @public */ - EndDate: Date | undefined; + DataSetIdentifier: string | undefined; /** - *

The target value that you want to meet for the provided date range.

+ *

The alt text for the visual.

* @public */ - Value: number | undefined; + VisualContentAltText?: string | undefined; } /** - *

The forecast scenario of a forecast in the line chart.

+ *

The field well configuration of a KPI visual.

* @public */ -export interface ForecastScenario { +export interface KPIFieldWells { /** - *

The what-if analysis forecast setup with the target date.

+ *

The value field wells of a KPI visual.

* @public */ - WhatIfPointScenario?: WhatIfPointScenario | undefined; + Values?: MeasureField[] | undefined; /** - *

The what-if analysis forecast setup with the date range.

+ *

The target value field wells of a KPI visual.

* @public */ - WhatIfRangeScenario?: WhatIfRangeScenario | undefined; + TargetValues?: MeasureField[] | undefined; + + /** + *

The trend group field wells of a KPI visual.

+ * @public + */ + TrendGroups?: DimensionField[] | undefined; } /** - *

The forecast configuration that is used in a line chart's display properties.

+ *

The options that determine the presentation of the progress bar of a KPI visual.

* @public */ -export interface ForecastConfiguration { +export interface ProgressBarOptions { /** - *

The forecast properties setup of a forecast in the line - * chart.

+ *

The visibility of the progress bar.

* @public */ - ForecastProperties?: TimeBasedForecastProperties | undefined; + Visibility?: Visibility | undefined; +} +/** + *

The options that determine the presentation of the secondary value of a KPI visual.

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

The forecast scenario of a forecast in the line chart.

+ *

Determines the visibility of the secondary value.

* @public */ - Scenario?: ForecastScenario | undefined; + Visibility?: Visibility | undefined; } /** * @public * @enum */ -export const MissingDataTreatmentOption = { - INTERPOLATE: "INTERPOLATE", - SHOW_AS_BLANK: "SHOW_AS_BLANK", - SHOW_AS_ZERO: "SHOW_AS_ZERO", +export const KPISparklineType = { + AREA: "AREA", + LINE: "LINE", } as const; /** * @public */ -export type MissingDataTreatmentOption = (typeof MissingDataTreatmentOption)[keyof typeof MissingDataTreatmentOption]; +export type KPISparklineType = (typeof KPISparklineType)[keyof typeof KPISparklineType]; /** - *

The configuration options that determine how missing data is treated during the rendering of a line chart.

+ *

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

* @public */ -export interface MissingDataConfiguration { +export interface KPISparklineOptions { /** - *

The treatment option that determines how missing data should be rendered. Choose - * from the following options:

- *
    - *
  • - *

    - * INTERPOLATE: Interpolate missing values between the prior and the next known value.

    - *
  • - *
  • - *

    - * SHOW_AS_ZERO: Show missing values as the value 0.

    - *
  • - *
  • - *

    - * SHOW_AS_BLANK: Display a blank space when rendering missing data.

    - *
  • - *
+ *

The visibility of the sparkline.

* @public */ - TreatmentOption?: MissingDataTreatmentOption | undefined; + Visibility?: Visibility | undefined; + + /** + *

The type of the sparkline.

+ * @public + */ + Type: KPISparklineType | undefined; + + /** + *

The color of the sparkline.

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

The tooltip visibility of the sparkline.

+ * @public + */ + TooltipVisibility?: Visibility | undefined; } /** - *

The series axis configuration of a line chart.

+ *

The options that determine the presentation of trend arrows in a KPI visual.

* @public */ -export interface LineSeriesAxisDisplayOptions { +export interface TrendArrowOptions { /** - *

The options that determine the presentation of the line series axis.

+ *

The visibility of the trend arrows.

* @public */ - AxisOptions?: AxisDisplayOptions | undefined; + Visibility?: Visibility | undefined; +} + +/** + * @public + * @enum + */ +export const KPIVisualStandardLayoutType = { + CLASSIC: "CLASSIC", + VERTICAL: "VERTICAL", +} as const; + +/** + * @public + */ +export type KPIVisualStandardLayoutType = + (typeof KPIVisualStandardLayoutType)[keyof typeof KPIVisualStandardLayoutType]; +/** + *

The standard layout of the KPI visual.

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

The configuration options that determine how missing data is treated during the rendering of a line chart.

+ *

The standard layout type.

* @public */ - MissingDataConfigurations?: MissingDataConfiguration[] | undefined; + Type: KPIVisualStandardLayoutType | undefined; } /** - *

The options that determine the presentation of a line series in the visual

+ *

The options that determine the layout a KPI visual.

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

Line styles options for a line series in LineChartVisual.

- * @public - */ - LineStyleSettings?: LineChartLineStyleSettings | undefined; - +export interface KPIVisualLayoutOptions { /** - *

Marker styles options for a line series in LineChartVisual.

+ *

The standard layout of the KPI visual.

* @public */ - MarkerStyleSettings?: LineChartMarkerStyleSettings | undefined; + StandardLayout?: KPIVisualStandardLayout | undefined; } /** - *

The data field series item configuration of a line chart.

+ *

The options that determine the presentation of a KPI visual.

* @public */ -export interface DataFieldSeriesItem { +export interface KPIOptions { /** - *

The field ID of the field that you are setting the axis binding to.

+ *

The options that determine the presentation of the progress bar of a KPI visual.

* @public */ - FieldId: string | undefined; + ProgressBar?: ProgressBarOptions | undefined; /** - *

The field value of the field that you are setting the axis binding to.

+ *

The options that determine the presentation of trend arrows in a KPI visual.

* @public */ - FieldValue?: string | undefined; + TrendArrows?: TrendArrowOptions | undefined; /** - *

The axis that you are binding the field to.

+ *

The options that determine the presentation of the secondary value of a KPI visual.

* @public */ - AxisBinding: AxisBinding | undefined; + SecondaryValue?: SecondaryValueOptions | undefined; /** - *

The options that determine the presentation of line series associated to the field.

+ *

The comparison configuration of a KPI visual.

* @public */ - Settings?: LineChartSeriesSettings | undefined; -} + Comparison?: ComparisonConfiguration | undefined; -/** - *

The field series item configuration of a line chart.

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

The field ID of the field for which you are setting the axis binding.

+ *

The options that determine the primary value display type.

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

The axis that you are binding the field to.

+ *

The options that determine the primary value font configuration.

* @public */ - AxisBinding: AxisBinding | undefined; + PrimaryValueFontConfiguration?: FontConfiguration | undefined; /** - *

The options that determine the presentation of line series associated to the field.

+ *

The options that determine the secondary value font configuration.

* @public */ - Settings?: LineChartSeriesSettings | undefined; -} + SecondaryValueFontConfiguration?: FontConfiguration | undefined; -/** - *

The series item configuration of a line chart.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The field series item configuration of a line chart.

+ *

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

* @public */ - FieldSeriesItem?: FieldSeriesItem | undefined; + Sparkline?: KPISparklineOptions | undefined; /** - *

The data field series item configuration of a line chart.

+ *

The options that determine the layout a KPI visual.

* @public */ - DataFieldSeriesItem?: DataFieldSeriesItem | undefined; + VisualLayoutOptions?: KPIVisualLayoutOptions | undefined; } /** - *

The sort configuration of a line chart.

+ *

The sort configuration of a KPI visual.

* @public */ -export interface LineChartSortConfiguration { +export interface KPISortConfiguration { /** - *

The sort configuration of the category fields.

+ *

The sort configuration of the trend group fields.

* @public */ - CategorySort?: FieldSortOptions[] | undefined; + TrendGroupSort?: FieldSortOptions[] | undefined; +} +/** + *

The configuration of a KPI visual.

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

The limit on the number of categories that are displayed in a line chart.

+ *

The field well configuration of a KPI visual.

* @public */ - CategoryItemsLimitConfiguration?: ItemsLimitConfiguration | undefined; + FieldWells?: KPIFieldWells | undefined; /** - *

The limit on the number of lines that are displayed in a line chart.

+ *

The sort configuration of a KPI visual.

* @public */ - ColorItemsLimitConfiguration?: ItemsLimitConfiguration | undefined; + SortConfiguration?: KPISortConfiguration | undefined; /** - *

The sort configuration of the small multiples field.

+ *

The options that determine the presentation of a KPI visual.

* @public */ - SmallMultiplesSort?: FieldSortOptions[] | undefined; + KPIOptions?: KPIOptions | undefined; /** - *

The limit on the number of small multiples panels that are displayed.

+ *

The general visual interactions setup for a visual.

* @public */ - SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration | undefined; + Interactions?: VisualInteractionOptions | undefined; } /** - * @public - * @enum - */ -export const LineChartType = { - AREA: "AREA", - LINE: "LINE", - STACKED_AREA: "STACKED_AREA", -} as const; - -/** - * @public - */ -export type LineChartType = (typeof LineChartType)[keyof typeof LineChartType]; - -/** - *

The configuration of a line chart.

+ *

The conditional formatting for the actual value of a KPI visual.

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

The field well configuration of a line chart.

- * @public - */ - FieldWells?: LineChartFieldWells | undefined; - +export interface KPIActualValueConditionalFormatting { /** - *

The sort configuration of a line chart.

+ *

The conditional formatting of the actual value's text color.

* @public */ - SortConfiguration?: LineChartSortConfiguration | undefined; + TextColor?: ConditionalFormattingColor | undefined; /** - *

The forecast configuration of a line chart.

+ *

The conditional formatting of the actual value's icon.

* @public */ - ForecastConfigurations?: ForecastConfiguration[] | undefined; + Icon?: ConditionalFormattingIcon | undefined; +} +/** + *

The conditional formatting for the comparison value of a KPI visual.

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

Determines the type of the line chart.

+ *

The conditional formatting of the comparison value's text color.

* @public */ - Type?: LineChartType | undefined; + TextColor?: ConditionalFormattingColor | undefined; /** - *

The small multiples setup for the visual.

+ *

The conditional formatting of the comparison value's icon.

* @public */ - SmallMultiplesOptions?: SmallMultiplesOptions | undefined; + Icon?: ConditionalFormattingIcon | undefined; +} +/** + *

The conditional formatting for the primary value of a KPI visual.

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

The options that determine the presentation of the x-axis.

+ *

The conditional formatting of the primary value's text color.

* @public */ - XAxisDisplayOptions?: AxisDisplayOptions | undefined; + TextColor?: ConditionalFormattingColor | undefined; /** - *

The options that determine the presentation of the x-axis label.

+ *

The conditional formatting of the primary value's icon.

* @public */ - XAxisLabelOptions?: ChartAxisLabelOptions | undefined; + Icon?: ConditionalFormattingIcon | undefined; +} +/** + *

The conditional formatting for the progress bar of a KPI visual.

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

The series axis configuration of a line chart.

+ *

The conditional formatting of the progress bar's foreground color.

* @public */ - PrimaryYAxisDisplayOptions?: LineSeriesAxisDisplayOptions | undefined; + ForegroundColor?: ConditionalFormattingColor | undefined; +} +/** + *

The conditional formatting options of a KPI visual.

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

The options that determine the presentation of the y-axis label.

+ *

The conditional formatting for the primary value of a KPI visual.

* @public */ - PrimaryYAxisLabelOptions?: ChartAxisLabelOptions | undefined; + PrimaryValue?: KPIPrimaryValueConditionalFormatting | undefined; /** - *

The series axis configuration of a line chart.

+ *

The conditional formatting for the progress bar of a KPI visual.

* @public */ - SecondaryYAxisDisplayOptions?: LineSeriesAxisDisplayOptions | undefined; + ProgressBar?: KPIProgressBarConditionalFormatting | undefined; /** - *

The options that determine the presentation of the secondary y-axis label.

+ *

The conditional formatting for the actual value of a KPI visual.

* @public */ - SecondaryYAxisLabelOptions?: ChartAxisLabelOptions | undefined; + ActualValue?: KPIActualValueConditionalFormatting | undefined; /** - *

The settings of a chart's single axis configuration.

+ *

The conditional formatting for the comparison value of a KPI visual.

* @public */ - SingleAxisOptions?: SingleAxisOptions | undefined; + ComparisonValue?: KPIComparisonValueConditionalFormatting | undefined; +} +/** + *

The conditional formatting of a KPI visual.

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

The options that determine the default presentation of all line series in LineChartVisual.

+ *

The conditional formatting options of a KPI visual.

* @public */ - DefaultSeriesSettings?: LineChartDefaultSeriesSettings | undefined; + ConditionalFormattingOptions?: KPIConditionalFormattingOption[] | undefined; +} +/** + *

A key performance indicator (KPI).

+ *

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

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

The series item configuration of a line chart.

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

* @public */ - Series?: SeriesItem[] | undefined; + VisualId: string | undefined; /** - *

The legend configuration of a line chart.

+ *

The title that is displayed on the visual.

* @public */ - Legend?: LegendOptions | undefined; + Title?: VisualTitleLabelOptions | undefined; /** - *

The data label configuration of a line chart.

+ *

The subtitle that is displayed on the visual.

* @public */ - DataLabels?: DataLabelOptions | undefined; + Subtitle?: VisualSubtitleLabelOptions | undefined; /** - *

The reference lines configuration of a line chart.

+ *

The configuration of a KPI visual.

* @public */ - ReferenceLines?: ReferenceLine[] | undefined; + ChartConfiguration?: KPIConfiguration | undefined; /** - *

The tooltip configuration of a line chart.

+ *

The conditional formatting of a KPI visual.

* @public */ - Tooltip?: TooltipOptions | undefined; + ConditionalFormatting?: KPIConditionalFormatting | undefined; /** - *

The default configuration of a line chart's contribution analysis.

+ *

The list of custom actions that are configured for a visual.

* @public */ - ContributionAnalysisDefaults?: ContributionAnalysisDefault[] | undefined; + Actions?: VisualCustomAction[] | undefined; /** - *

The visual palette configuration of a line chart.

+ *

The column hierarchy that is used during drill-downs and drill-ups.

* @public */ - VisualPalette?: VisualPalette | undefined; + ColumnHierarchies?: ColumnHierarchy[] | undefined; /** - *

The general visual interactions setup for a visual.

+ *

The alt text for the visual.

* @public */ - Interactions?: VisualInteractionOptions | undefined; + VisualContentAltText?: string | undefined; } /** - *

A line chart.

- *

For more information, see Using line charts in the Amazon QuickSight User Guide.

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

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

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

The title that is displayed on the visual.

- * @public - */ - Title?: VisualTitleLabelOptions | undefined; - + *

The operation that is defined by the custom action.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The subtitle that is displayed on the visual.

+ *

The filter operation that filters data included in a visual or in an entire sheet.

* @public */ - Subtitle?: VisualSubtitleLabelOptions | undefined; + FilterOperation?: CustomActionFilterOperation | undefined; /** - *

The configuration of a line chart.

+ *

The navigation operation that navigates between different sheets in the same analysis.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

* @public */ - ChartConfiguration?: LineChartConfiguration | undefined; + NavigationOperation?: CustomActionNavigationOperation | undefined; /** - *

The list of custom actions that are configured for a visual.

+ *

The URL operation that opens a link to another webpage.

* @public */ - Actions?: VisualCustomAction[] | undefined; + URLOperation?: CustomActionURLOperation | undefined; /** - *

The column hierarchy that is used during drill-downs and drill-ups.

+ *

The set parameter operation that sets parameters in custom action.

* @public */ - ColumnHierarchies?: ColumnHierarchy[] | undefined; + SetParametersOperation?: CustomActionSetParametersOperation | undefined; } /** * @public * @enum */ -export const ArcThickness = { - LARGE: "LARGE", - MEDIUM: "MEDIUM", - SMALL: "SMALL", - WHOLE: "WHOLE", +export const LayerCustomActionTrigger = { + DATA_POINT_CLICK: "DATA_POINT_CLICK", + DATA_POINT_MENU: "DATA_POINT_MENU", } as const; /** * @public */ -export type ArcThickness = (typeof ArcThickness)[keyof typeof ArcThickness]; +export type LayerCustomActionTrigger = (typeof LayerCustomActionTrigger)[keyof typeof LayerCustomActionTrigger]; /** - *

The options that determine the arc thickness of a GaugeChartVisual.

+ *

A layer custom action.

* @public */ -export interface ArcOptions { +export interface LayerCustomAction { /** - *

The arc thickness of a GaugeChartVisual.

+ *

The ID of the custom action.

* @public */ - ArcThickness?: ArcThickness | undefined; -} + CustomActionId: string | undefined; -/** - *

The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.

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

Determines the visibility of the label in a donut chart. In the Amazon QuickSight console, this option is called 'Show total'.

+ *

The name of the custom action.

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

The options for configuring a donut chart or pie chart.

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

The option for define the arc of the chart shape. Valid values are as follows:

+ *

The status of the LayerCustomAction.

+ * @public + */ + Status?: WidgetStatus | undefined; + + /** + *

The trigger of the LayerCustomAction.

+ *

Valid values are defined as follows:

*
    *
  • *

    - * WHOLE - A pie chart

    - *
  • - *
  • - *

    - * SMALL- A small-sized donut chart

    - *
  • - *
  • - *

    - * MEDIUM- A medium-sized donut chart

    + * DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.

    *
  • *
  • *

    - * LARGE- A large-sized donut chart

    + * DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.

    *
  • *
* @public */ - ArcOptions?: ArcOptions | undefined; + Trigger: LayerCustomActionTrigger | undefined; /** - *

The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.

+ *

A list of LayerCustomActionOperations.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

* @public */ - DonutCenterOptions?: DonutCenterOptions | undefined; + ActionOperations: LayerCustomActionOperation[] | undefined; } /** - *

The field well configuration of a pie chart.

+ *

The source properties for a geospatial static file.

* @public */ -export interface PieChartAggregatedFieldWells { +export interface GeospatialStaticFileSource { /** - *

The category (group/color) field wells of a pie chart.

+ *

The ID of the static file.

* @public */ - Category?: DimensionField[] | undefined; + StaticFileId: string | undefined; +} +/** + *

The data source properties for the geospatial data.

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

The value field wells of a pie chart. Values are aggregated based on categories.

+ *

The static file data source properties for the geospatial data.

* @public */ - Values?: MeasureField[] | undefined; + StaticFileDataSource?: GeospatialStaticFileSource | undefined; +} +/** + *

The color field that defines a gradient or categorical style.

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

The small multiples field well of a pie chart.

+ *

A list of color dimension fields.

* @public */ - SmallMultiples?: DimensionField[] | undefined; + ColorDimensionsFields?: DimensionField[] | undefined; + + /** + *

A list of color measure fields.

+ * @public + */ + ColorValuesFields?: MeasureField[] | undefined; } /** - *

The field well configuration of a pie chart.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

+ *

The unaggregated field for a table.

* @public */ -export interface PieChartFieldWells { +export interface UnaggregatedField { /** - *

The field well configuration of a pie chart.

+ *

The custom field ID.

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

The column that is used in the UnaggregatedField.

+ * @public + */ + Column: ColumnIdentifier | undefined; + + /** + *

The format configuration of the field.

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

The sort configuration of a pie chart.

+ *

The custom actions for a layer.

* @public */ -export interface PieChartSortConfiguration { +export interface GeospatialLayerJoinDefinition { /** - *

The sort configuration of the category fields.

+ *

The name of the field or property in the geospatial data source.

* @public */ - CategorySort?: FieldSortOptions[] | undefined; + ShapeKeyField?: string | undefined; /** - *

The limit on the number of categories that are displayed in a pie chart.

+ *

The unaggregated field for a table.

* @public */ - CategoryItemsLimit?: ItemsLimitConfiguration | undefined; + DatasetKeyField?: UnaggregatedField | undefined; /** - *

The sort configuration of the small multiples field.

+ *

The geospatial color field for the join definition.

* @public */ - SmallMultiplesSort?: FieldSortOptions[] | undefined; + ColorField?: GeospatialLayerColorField | undefined; +} +/** + *

The categorical data color for a single category.

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

The limit on the number of small multiples panels that are displayed.

+ *

The color and opacity values for the category data color.

* @public */ - SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration | undefined; + Color: string | undefined; + + /** + *

The data value for the category data color.

+ * @public + */ + DataValue: string | undefined; } /** - *

The configuration of a pie chart.

+ *

The symbol style for null data.

* @public */ -export interface PieChartConfiguration { +export interface GeospatialNullSymbolStyle { /** - *

The field wells of the visual.

+ *

The color and opacity values for the fill color.

* @public */ - FieldWells?: PieChartFieldWells | undefined; + FillColor?: string | undefined; /** - *

The sort configuration of a pie chart.

+ *

The color and opacity values for the stroke color.

* @public */ - SortConfiguration?: PieChartSortConfiguration | undefined; + StrokeColor?: string | undefined; /** - *

The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.

+ *

The width of the border stroke.

* @public */ - DonutOptions?: DonutOptions | undefined; + StrokeWidth?: number | undefined; +} +/** + *

The properties for the visualization of null data.

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

The small multiples setup for the visual.

+ *

The symbol style for null data.

* @public */ - SmallMultiplesOptions?: SmallMultiplesOptions | undefined; + SymbolStyle: GeospatialNullSymbolStyle | undefined; +} +/** + *

The definition for a categorical color.

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

The label options of the group/color that is displayed in a pie chart.

+ *

A list of categorical data colors for each category.

* @public */ - CategoryLabelOptions?: ChartAxisLabelOptions | undefined; + CategoryDataColors: GeospatialCategoricalDataColor[] | undefined; /** - *

The label options for the value that is displayed in a pie chart.

+ *

The state of visibility for null data.

* @public */ - ValueLabelOptions?: ChartAxisLabelOptions | undefined; + NullDataVisibility?: Visibility | undefined; /** - *

The legend display setup of the visual.

+ *

The null data visualization settings.

* @public */ - Legend?: LegendOptions | undefined; + NullDataSettings?: GeospatialNullDataSettings | undefined; /** - *

The options that determine if visual data labels are displayed.

+ *

The default opacity of a categorical color.

* @public */ - DataLabels?: DataLabelOptions | undefined; + DefaultOpacity?: number | undefined; +} +/** + *

The gradient step color for a single step.

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

The tooltip display setup of the visual.

+ *

The color and opacity values for the gradient step color.

* @public */ - Tooltip?: TooltipOptions | undefined; + Color: string | undefined; /** - *

The palette (chart color) display setup of the visual.

+ *

The data value for the gradient step color.

* @public */ - VisualPalette?: VisualPalette | undefined; + DataValue: number | undefined; +} +/** + *

The definition for a gradient color.

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

The contribution analysis (anomaly configuration) setup of the visual.

+ *

A list of gradient step colors for the gradient.

* @public */ - ContributionAnalysisDefaults?: ContributionAnalysisDefault[] | undefined; + StepColors: GeospatialGradientStepColor[] | undefined; /** - *

The general visual interactions setup for a visual.

+ *

The state of visibility for null data.

* @public */ - Interactions?: VisualInteractionOptions | undefined; + NullDataVisibility?: Visibility | undefined; + + /** + *

The null data visualization settings.

+ * @public + */ + NullDataSettings?: GeospatialNullDataSettings | undefined; + + /** + *

The default opacity for the gradient color.

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

A pie or donut chart.

- *

The PieChartVisual structure describes a visual that is a member of the pie chart family.

- *

The following charts can be described by using this structure:

- *
    - *
  • - *

    Pie charts

    - *
  • - *
  • - *

    Donut charts

    - *
  • - *
- *

For more information, see Using pie charts in the Amazon QuickSight User Guide.

- *

For more information, see Using donut charts in the Amazon QuickSight User Guide.

* @public + * @enum */ -export interface PieChartVisual { +export const GeospatialColorState = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", +} as const; + +/** + * @public + */ +export type GeospatialColorState = (typeof GeospatialColorState)[keyof typeof GeospatialColorState]; + +/** + *

The definition for a solid color.

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

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

+ *

The color and opacity values for the color.

* @public */ - VisualId: string | undefined; + Color: string | undefined; /** - *

The title that is displayed on the visual.

+ *

Enables and disables the view state of the color.

* @public */ - Title?: VisualTitleLabelOptions | undefined; + State?: GeospatialColorState | undefined; +} +/** + *

The visualization properties for solid, gradient, and categorical colors.

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

The subtitle that is displayed on the visual.

+ *

The visualization properties for the solid color.

* @public */ - Subtitle?: VisualSubtitleLabelOptions | undefined; + Solid?: GeospatialSolidColor | undefined; /** - *

The configuration of a pie chart.

+ *

The visualization properties for the gradient color.

* @public */ - ChartConfiguration?: PieChartConfiguration | undefined; + Gradient?: GeospatialGradientColor | undefined; /** - *

The list of custom actions that are configured for a visual.

+ *

The visualization properties for the categorical color.

* @public */ - Actions?: VisualCustomAction[] | undefined; + Categorical?: GeospatialCategoricalColor | undefined; +} +/** + *

The width properties for a line.

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

The column hierarchy that is used during drill-downs and drill-ups.

+ *

The positive value for the width of a line.

* @public */ - ColumnHierarchies?: ColumnHierarchy[] | undefined; + LineWidth?: number | undefined; } /** + *

The symbol style for a line layer.

* @public - * @enum */ -export const PivotTableFieldCollapseState = { - COLLAPSED: "COLLAPSED", - EXPANDED: "EXPANDED", -} as const; +export interface GeospatialLineSymbolStyle { + /** + *

The color and opacity values for the fill color.

+ * @public + */ + FillColor?: GeospatialColor | undefined; + + /** + *

The width value for a line.

+ * @public + */ + LineWidth?: GeospatialLineWidth | undefined; +} /** + *

The visualization style for a line layer.

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

The symbol style for a line style.

+ * @public + */ + LineSymbolStyle?: GeospatialLineSymbolStyle | undefined; +} /** - *

The target of a pivot table field collapse state.

+ *

The geospatial Line layer.

* @public */ -export interface PivotTableFieldCollapseStateTarget { +export interface GeospatialLineLayer { /** - *

The field ID of the pivot table that the collapse state needs to be set to.

+ *

The visualization style for a line layer.

* @public */ - FieldId?: string | undefined; + Style: GeospatialLineStyle | undefined; +} +/** + *

The geospatial radius for a circle.

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

The data path of the pivot table's header. Used to set the collapse state.

+ *

The positive value for the radius of a circle.

* @public */ - FieldDataPathValues?: DataPathValue[] | undefined; + Radius?: number | undefined; } /** - *

The collapse state options for the pivot table field options.

+ *

The properties for a circle symbol style.

* @public */ -export interface PivotTableFieldCollapseStateOption { +export interface GeospatialCircleSymbolStyle { /** - *

A tagged-union object that sets the collapse state.

+ *

The color and opacity values for the fill color.

* @public */ - Target: PivotTableFieldCollapseStateTarget | undefined; + FillColor?: GeospatialColor | undefined; /** - *

The state of the field target of a pivot table. Choose one of the following options:

- *
    - *
  • - *

    - * COLLAPSED - *

    - *
  • - *
  • - *

    - * EXPANDED - *

    - *
  • - *
+ *

The color and opacity values for the stroke color.

* @public */ - State?: PivotTableFieldCollapseState | undefined; + StrokeColor?: GeospatialColor | undefined; + + /** + *

The width of the stroke (border).

+ * @public + */ + StrokeWidth?: GeospatialLineWidth | undefined; + + /** + *

The radius of the circle.

+ * @public + */ + CircleRadius?: GeospatialCircleRadius | undefined; } /** - *

The data path options for the pivot table field options.

+ *

The point style for a point layer.

* @public */ -export interface PivotTableDataPathOption { +export interface GeospatialPointStyle { /** - *

The list of data path values for the data path options.

+ *

The circle symbol style for a point layer.

* @public */ - DataPathList: DataPathValue[] | undefined; + CircleSymbolStyle?: GeospatialCircleSymbolStyle | undefined; +} +/** + *

The geospatial Point layer.

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

The width of the data path option.

+ *

The visualization style for a point layer.

* @public */ - Width?: string | undefined; + Style: GeospatialPointStyle | undefined; } /** - *

The selected field options for the pivot table field options.

+ *

The polygon symbol style for a polygon layer.

* @public */ -export interface PivotTableFieldOption { +export interface GeospatialPolygonSymbolStyle { /** - *

The field ID of the pivot table field.

+ *

The color and opacity values for the fill color.

* @public */ - FieldId: string | undefined; + FillColor?: GeospatialColor | undefined; /** - *

The custom label of the pivot table field.

+ *

The color and opacity values for the stroke color.

* @public */ - CustomLabel?: string | undefined; + StrokeColor?: GeospatialColor | undefined; /** - *

The visibility of the pivot table field.

+ *

The width of the border stroke.

* @public */ - Visibility?: Visibility | undefined; + StrokeWidth?: GeospatialLineWidth | undefined; } /** - *

The field options for a pivot table visual.

+ *

The polygon style for a polygon layer.

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

The selected field options for the pivot table field options.

- * @public - */ - SelectedFieldOptions?: PivotTableFieldOption[] | undefined; - +export interface GeospatialPolygonStyle { /** - *

The data path options for the pivot table field options.

+ *

The polygon symbol style for a polygon layer.

* @public */ - DataPathOptions?: PivotTableDataPathOption[] | undefined; + PolygonSymbolStyle?: GeospatialPolygonSymbolStyle | undefined; +} +/** + *

The geospatial polygon layer.

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

The collapse state options for the pivot table field options.

+ *

The visualization style for a polygon layer.

* @public */ - CollapseStateOptions?: PivotTableFieldCollapseStateOption[] | undefined; + Style: GeospatialPolygonStyle | undefined; } /** - *

The aggregated field well for the pivot table.

+ *

The definition properties for a geospatial layer.

* @public */ -export interface PivotTableAggregatedFieldWells { +export interface GeospatialLayerDefinition { /** - *

The rows field well for a pivot table. Values are grouped by rows fields.

+ *

The definition for a point layer.

* @public */ - Rows?: DimensionField[] | undefined; + PointLayer?: GeospatialPointLayer | undefined; /** - *

The columns field well for a pivot table. Values are grouped by columns fields.

+ *

The definition for a line layer.

* @public */ - Columns?: DimensionField[] | undefined; + LineLayer?: GeospatialLineLayer | undefined; /** - *

The values field well for a pivot table. Values are aggregated based on rows and columns fields.

+ *

The definition for a polygon layer.

* @public */ - Values?: MeasureField[] | undefined; + PolygonLayer?: GeospatialPolygonLayer | undefined; } /** - *

The field wells for a pivot table visual.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The aggregated field well for the pivot table.

- * @public - */ - PivotTableAggregatedFieldWells?: PivotTableAggregatedFieldWells | undefined; -} +export const GeospatialLayerType = { + LINE: "LINE", + POINT: "POINT", + POLYGON: "POLYGON", +} as const; /** - *

The paginated report options for a pivot table visual.

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

The properties for a single geospatial layer.

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

The visibility of the printing table overflow across pages.

+ *

The ID of the layer.

* @public */ - VerticalOverflowVisibility?: Visibility | undefined; + LayerId: string | undefined; /** - *

The visibility of the repeating header rows on each page.

+ *

The layer type.

* @public */ - OverflowColumnHeaderVisibility?: Visibility | undefined; -} + LayerType?: GeospatialLayerType | undefined; -/** - *

Allows data paths to be sorted by a specific data value.

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

Determines the sort direction.

+ *

The data source for the layer.

* @public */ - Direction: SortDirection | undefined; + DataSource?: GeospatialDataSourceItem | undefined; /** - *

The list of data paths that need to be sorted.

+ *

The label that is displayed for the layer.

* @public */ - SortPaths: DataPathValue[] | undefined; -} + Label?: string | undefined; -/** - *

The sort by field for the field sort options.

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

The field sort (field id, direction) for the pivot table sort by options.

+ *

The state of visibility for the layer.

* @public */ - Field?: FieldSort | undefined; + Visibility?: Visibility | undefined; /** - *

The column sort (field id, direction) for the pivot table sort by options.

+ *

The definition properties for a layer.

* @public */ - Column?: ColumnSort | undefined; + LayerDefinition?: GeospatialLayerDefinition | undefined; /** - *

The data path sort (data path value, direction) for the pivot table sort by options.

+ *

The display options for the visual tooltip.

* @public */ - DataPath?: DataPathSort | undefined; + Tooltip?: TooltipOptions | undefined; + + /** + *

The join definition properties for a layer.

+ * @public + */ + JoinDefinition?: GeospatialLayerJoinDefinition | undefined; + + /** + *

A list of custom actions for a layer.

+ * @public + */ + Actions?: LayerCustomAction[] | undefined; } /** - *

The field sort options for a pivot table sort configuration.

* @public + * @enum */ -export interface PivotFieldSortOptions { +export const GeospatialMapNavigation = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", +} as const; + +/** + * @public + */ +export type GeospatialMapNavigation = (typeof GeospatialMapNavigation)[keyof typeof GeospatialMapNavigation]; + +/** + *

The map state properties for a map.

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

The field ID for the field sort options.

+ *

The bound + * options (north, south, west, east) of the geospatial window options.

* @public */ - FieldId: string | undefined; + Bounds?: GeospatialCoordinateBounds | undefined; /** - *

The sort by field for the field sort options.

+ *

Enables or disables map navigation for a map.

* @public */ - SortBy: PivotTableSortBy | undefined; + MapNavigation?: GeospatialMapNavigation | undefined; } /** - *

The sort configuration for a PivotTableVisual.

+ *

The map style properties for a map.

* @public */ -export interface PivotTableSortConfiguration { +export interface GeospatialMapStyle { /** - *

The field sort options for a pivot table sort configuration.

+ *

The selected base map style.

* @public */ - FieldSortOptions?: PivotFieldSortOptions[] | undefined; + BaseMapStyle?: BaseMapStyleType | undefined; + + /** + *

The background color and opacity values for a map.

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

The state of visibility for the base map.

+ * @public + */ + BaseMapVisibility?: Visibility | undefined; } /** + *

The map definition that defines map state, map style, and geospatial layers.

* @public - * @enum */ -export const TableBorderStyle = { - NONE: "NONE", - SOLID: "SOLID", -} as const; +export interface GeospatialLayerMapConfiguration { + /** + *

The options for the legend setup of a visual.

+ * @public + */ + Legend?: LegendOptions | undefined; -/** - * @public - */ -export type TableBorderStyle = (typeof TableBorderStyle)[keyof typeof TableBorderStyle]; + /** + *

The geospatial layers to visualize on the map.

+ * @public + */ + MapLayers?: GeospatialLayerItem[] | undefined; -/** - *

The border options for a table border.

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

The color of a table border.

+ *

The map state properties for the map.

* @public */ - Color?: string | undefined; + MapState?: GeospatialMapState | undefined; /** - *

The thickness of a table border.

+ *

The map style properties for the map.

* @public */ - Thickness?: number | undefined; + MapStyle?: GeospatialMapStyle | undefined; /** - *

The style (none, solid) of a table border.

+ *

The general visual interactions setup for visual publish options

* @public */ - Style?: TableBorderStyle | undefined; + Interactions?: VisualInteractionOptions | undefined; } /** - *

The side border options for a table.

+ *

A layer map visual.

* @public */ -export interface TableSideBorderOptions { +export interface LayerMapVisual { /** - *

The table border options of the inner vertical border.

+ *

The ID of the visual.

* @public */ - InnerVertical?: TableBorderOptions | undefined; + VisualId: string | undefined; /** - *

The table border options of the inner horizontal border.

+ *

The title label options for a visual.

* @public */ - InnerHorizontal?: TableBorderOptions | undefined; + Title?: VisualTitleLabelOptions | undefined; /** - *

The table border options of the left border.

+ *

The subtitle label options for a visual.

* @public */ - Left?: TableBorderOptions | undefined; + Subtitle?: VisualSubtitleLabelOptions | undefined; /** - *

The table border options of the right border.

+ *

The configuration settings of the visual.

* @public */ - Right?: TableBorderOptions | undefined; + ChartConfiguration?: GeospatialLayerMapConfiguration | undefined; /** - *

The table border options of the top border.

+ *

The dataset that is used to create the layer map visual. You can't create a visual without a dataset.

* @public */ - Top?: TableBorderOptions | undefined; + DataSetIdentifier: string | undefined; /** - *

The table border options of the bottom border.

+ *

The alt text for the visual.

* @public */ - Bottom?: TableBorderOptions | undefined; + VisualContentAltText?: string | undefined; } /** - *

Determines the border options for a table visual.

* @public + * @enum */ -export interface GlobalTableBorderOptions { +export const LineInterpolation = { + LINEAR: "LINEAR", + SMOOTH: "SMOOTH", + STEPPED: "STEPPED", +} as const; + +/** + * @public + */ +export type LineInterpolation = (typeof LineInterpolation)[keyof typeof LineInterpolation]; + +/** + * @public + * @enum + */ +export const LineChartLineStyle = { + DASHED: "DASHED", + DOTTED: "DOTTED", + SOLID: "SOLID", +} as const; + +/** + * @public + */ +export type LineChartLineStyle = (typeof LineChartLineStyle)[keyof typeof LineChartLineStyle]; + +/** + *

Line styles options for a line series in LineChartVisual.

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

Determines the options for uniform border.

+ *

Configuration option that determines whether to show the line for the series.

+ * @public + */ + LineVisibility?: Visibility | undefined; + + /** + *

Interpolation style for line series.

+ *
    + *
  • + *

    + * LINEAR: Show as default, linear style.

    + *
  • + *
  • + *

    + * SMOOTH: Show as a smooth curve.

    + *
  • + *
  • + *

    + * STEPPED: Show steps in line.

    + *
  • + *
+ * @public + */ + LineInterpolation?: LineInterpolation | undefined; + + /** + *

Line style for line series.

+ *
    + *
  • + *

    + * SOLID: Show as a solid line.

    + *
  • + *
  • + *

    + * DOTTED: Show as a dotted line.

    + *
  • + *
  • + *

    + * DASHED: Show as a dashed line.

    + *
  • + *
* @public */ - UniformBorder?: TableBorderOptions | undefined; + LineStyle?: LineChartLineStyle | undefined; /** - *

Determines the options for side specific border.

+ *

Width that determines the line thickness.

* @public */ - SideSpecificBorder?: TableSideBorderOptions | undefined; + LineWidth?: string | undefined; } /** * @public * @enum */ -export const TextWrap = { - NONE: "NONE", - WRAP: "WRAP", -} as const; - -/** - * @public - */ -export type TextWrap = (typeof TextWrap)[keyof typeof TextWrap]; - -/** - * @public - * @enum - */ -export const VerticalTextAlignment = { - AUTO: "AUTO", - BOTTOM: "BOTTOM", - MIDDLE: "MIDDLE", - TOP: "TOP", +export const LineChartMarkerShape = { + CIRCLE: "CIRCLE", + DIAMOND: "DIAMOND", + ROUNDED_SQUARE: "ROUNDED_SQUARE", + SQUARE: "SQUARE", + TRIANGLE: "TRIANGLE", } as const; /** * @public */ -export type VerticalTextAlignment = (typeof VerticalTextAlignment)[keyof typeof VerticalTextAlignment]; +export type LineChartMarkerShape = (typeof LineChartMarkerShape)[keyof typeof LineChartMarkerShape]; /** - *

The table cell style for a cell in pivot table or table visual.

+ *

Marker styles options for a line series in LineChartVisual.

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

The visibility of the table cells.

- * @public - */ - Visibility?: Visibility | undefined; - +export interface LineChartMarkerStyleSettings { /** - *

The font configuration of the table cells.

+ *

Configuration option that determines whether to show the markers in the series.

* @public */ - FontConfiguration?: FontConfiguration | undefined; + MarkerVisibility?: Visibility | undefined; /** - *

The text wrap (none, wrap) for the table cells.

+ *

Shape option for markers in the series.

+ *
    + *
  • + *

    + * CIRCLE: Show marker as a circle.

    + *
  • + *
  • + *

    + * TRIANGLE: Show marker as a triangle.

    + *
  • + *
  • + *

    + * SQUARE: Show marker as a square.

    + *
  • + *
  • + *

    + * DIAMOND: Show marker as a diamond.

    + *
  • + *
  • + *

    + * ROUNDED_SQUARE: Show marker as a rounded square.

    + *
  • + *
* @public */ - TextWrap?: TextWrap | undefined; + MarkerShape?: LineChartMarkerShape | undefined; /** - *

The horizontal text alignment (left, center, right, auto) for the table cells.

+ *

Size of marker in the series.

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

The vertical text alignment (top, middle, bottom) for the table cells.

+ *

Color of marker in the series.

* @public */ - VerticalTextAlignment?: VerticalTextAlignment | undefined; + MarkerColor?: string | undefined; +} +/** + *

The options that determine the default presentation of all line series in LineChartVisual.

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

The background color for the table cells.

+ *

The axis to which you are binding all line series to.

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

The height color for the table cells.

+ *

Line styles options for all line series in the visual.

* @public */ - Height?: number | undefined; + LineStyleSettings?: LineChartLineStyleSettings | undefined; /** - *

The borders for the table cells.

+ *

Marker styles options for all line series in the visual.

* @public */ - Border?: GlobalTableBorderOptions | undefined; + MarkerStyleSettings?: LineChartMarkerStyleSettings | undefined; } /** - * @public - * @enum - */ -export const PivotTableMetricPlacement = { - COLUMN: "COLUMN", - ROW: "ROW", -} as const; - -/** + *

The field well configuration of a line chart.

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

The category field wells of a line chart. Values are grouped by category fields.

+ * @public + */ + Category?: DimensionField[] | undefined; -/** - *

Determines the row alternate color options.

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

Determines the widget status.

+ *

The value field wells of a line chart. Values are aggregated based on categories.

* @public */ - Status?: WidgetStatus | undefined; + Values?: MeasureField[] | undefined; /** - *

Determines the list of row alternate colors.

+ *

The color field wells of a line chart. Values are grouped by category fields.

* @public */ - RowAlternateColors?: string[] | undefined; + Colors?: DimensionField[] | undefined; /** - *

The primary background color options for alternate rows.

+ *

The small multiples field well of a line chart.

* @public */ - UsePrimaryBackgroundColor?: WidgetStatus | undefined; + SmallMultiples?: DimensionField[] | undefined; } /** - *

The options for the label thta is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

+ *

The field well configuration of a line chart.

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

The visibility of the rows label.

- * @public - */ - Visibility?: Visibility | undefined; - +export interface LineChartFieldWells { /** - *

The custom label string for the rows label.

+ *

The field well configuration of a line chart.

* @public */ - CustomLabel?: string | undefined; + LineChartAggregatedFieldWells?: LineChartAggregatedFieldWells | undefined; } /** - * @public - * @enum - */ -export const PivotTableRowsLayout = { - HIERARCHY: "HIERARCHY", - TABULAR: "TABULAR", -} as const; - -/** - * @public - */ -export type PivotTableRowsLayout = (typeof PivotTableRowsLayout)[keyof typeof PivotTableRowsLayout]; - -/** - *

The table options for a pivot table visual.

+ *

The forecast properties setup of a forecast in the line chart.

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

The metric placement (row, column) options.

- * @public - */ - MetricPlacement?: PivotTableMetricPlacement | undefined; - - /** - *

The visibility of the single metric options.

- * @public - */ - SingleMetricVisibility?: Visibility | undefined; - +export interface TimeBasedForecastProperties { /** - *

The visibility of the column names.

+ *

The periods forward setup of a forecast computation.

* @public */ - ColumnNamesVisibility?: Visibility | undefined; + PeriodsForward?: number | undefined; /** - *

Determines the visibility of the pivot table.

+ *

The periods backward setup of a forecast computation.

* @public */ - ToggleButtonsVisibility?: Visibility | undefined; + PeriodsBackward?: number | undefined; /** - *

The table cell style of the column header.

+ *

The upper boundary setup of a forecast computation.

* @public */ - ColumnHeaderStyle?: TableCellStyle | undefined; + UpperBoundary?: number | undefined; /** - *

The table cell style of the row headers.

+ *

The lower boundary setup of a forecast computation.

* @public */ - RowHeaderStyle?: TableCellStyle | undefined; + LowerBoundary?: number | undefined; /** - *

The table cell style of cells.

+ *

The prediction interval setup of a forecast computation.

* @public */ - CellStyle?: TableCellStyle | undefined; + PredictionInterval?: number | undefined; /** - *

The table cell style of row field names.

+ *

The seasonality setup of a forecast computation. Choose one of the following options:

+ *
    + *
  • + *

    + * NULL: The input is set to NULL.

    + *
  • + *
  • + *

    + * NON_NULL: The input is set to a custom value.

    + *
  • + *
* @public */ - RowFieldNamesStyle?: TableCellStyle | undefined; + Seasonality?: number | undefined; +} +/** + *

Provides the forecast to meet the target for a particular date.

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

The row alternate color options (widget status, row alternate colors).

+ *

The date that you need the forecast results for.

* @public */ - RowAlternateColorOptions?: RowAlternateColorOptions | undefined; + Date: Date | undefined; /** - *

The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is HIDDEN, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE.

+ *

The target value that you want to meet for the provided date.

* @public */ - CollapsedRowDimensionsVisibility?: Visibility | undefined; + Value: number | undefined; +} +/** + *

Provides the forecast to meet the target for a particular date range.

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

The layout for the row dimension headers of a pivot table. Choose one of the following options.

- *
    - *
  • - *

    - * TABULAR: (Default) Each row field is displayed in a separate column.

    - *
  • - *
  • - *

    - * HIERARCHY: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.

    - *
  • - *
+ *

The start date in the date range that you need the forecast results for.

* @public */ - RowsLayout?: PivotTableRowsLayout | undefined; + StartDate: Date | undefined; /** - *

The options for the label that is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

+ *

The end date in the date range that you need the forecast results for.

* @public */ - RowsLabelOptions?: PivotTableRowsLabelOptions | undefined; + EndDate: Date | undefined; /** - *

The default cell width of the pivot table.

+ *

The target value that you want to meet for the provided date range.

* @public */ - DefaultCellWidth?: string | undefined; + Value: number | undefined; } /** + *

The forecast scenario of a forecast in the line chart.

* @public - * @enum */ -export const PivotTableSubtotalLevel = { - ALL: "ALL", - CUSTOM: "CUSTOM", - LAST: "LAST", -} as const; +export interface ForecastScenario { + /** + *

The what-if analysis forecast setup with the target date.

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

The what-if analysis forecast setup with the date range.

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

The optional configuration of subtotals cells.

+ *

The forecast configuration that is used in a line chart's display properties.

* @public */ -export interface PivotTableFieldSubtotalOptions { +export interface ForecastConfiguration { /** - *

The field ID of the subtotal options.

+ *

The forecast properties setup of a forecast in the line + * chart.

* @public */ - FieldId?: string | undefined; + ForecastProperties?: TimeBasedForecastProperties | undefined; + + /** + *

The forecast scenario of a forecast in the line chart.

+ * @public + */ + Scenario?: ForecastScenario | undefined; } /** * @public * @enum */ -export const StyledCellType = { - METRIC_HEADER: "METRIC_HEADER", - TOTAL: "TOTAL", - VALUE: "VALUE", +export const MissingDataTreatmentOption = { + INTERPOLATE: "INTERPOLATE", + SHOW_AS_BLANK: "SHOW_AS_BLANK", + SHOW_AS_ZERO: "SHOW_AS_ZERO", } as const; /** * @public */ -export type StyledCellType = (typeof StyledCellType)[keyof typeof StyledCellType]; +export type MissingDataTreatmentOption = (typeof MissingDataTreatmentOption)[keyof typeof MissingDataTreatmentOption]; /** - *

The table style target.

+ *

The configuration options that determine how missing data is treated during the rendering of a line chart.

* @public */ -export interface TableStyleTarget { +export interface MissingDataConfiguration { /** - *

The cell type of the table style target.

+ *

The treatment option that determines how missing data should be rendered. Choose + * from the following options:

+ *
    + *
  • + *

    + * INTERPOLATE: Interpolate missing values between the prior and the next known value.

    + *
  • + *
  • + *

    + * SHOW_AS_ZERO: Show missing values as the value 0.

    + *
  • + *
  • + *

    + * SHOW_AS_BLANK: Display a blank space when rendering missing data.

    + *
  • + *
* @public */ - CellType: StyledCellType | undefined; + TreatmentOption?: MissingDataTreatmentOption | undefined; } /** - *

The subtotal options.

+ *

The series axis configuration of a line chart.

* @public */ -export interface SubtotalOptions { +export interface LineSeriesAxisDisplayOptions { /** - *

The visibility configuration for the subtotal cells.

+ *

The options that determine the presentation of the line series axis.

* @public */ - TotalsVisibility?: Visibility | undefined; + AxisOptions?: AxisDisplayOptions | undefined; /** - *

The custom label string for the subtotal cells.

+ *

The configuration options that determine how missing data is treated during the rendering of a line chart.

* @public */ - CustomLabel?: string | undefined; + MissingDataConfigurations?: MissingDataConfiguration[] | undefined; +} +/** + *

The options that determine the presentation of a line series in the visual

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

The field level (all, custom, last) for the subtotal cells.

+ *

Line styles options for a line series in LineChartVisual.

* @public */ - FieldLevel?: PivotTableSubtotalLevel | undefined; + LineStyleSettings?: LineChartLineStyleSettings | undefined; /** - *

The optional configuration of subtotal cells.

+ *

Marker styles options for a line series in LineChartVisual.

* @public */ - FieldLevelOptions?: PivotTableFieldSubtotalOptions[] | undefined; + MarkerStyleSettings?: LineChartMarkerStyleSettings | undefined; +} +/** + *

The data field series item configuration of a line chart.

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

The cell styling options for the subtotal cells.

+ *

The field ID of the field that you are setting the axis binding to.

* @public */ - TotalCellStyle?: TableCellStyle | undefined; + FieldId: string | undefined; /** - *

The cell styling options for the subtotals of value cells.

+ *

The field value of the field that you are setting the axis binding to.

* @public */ - ValueCellStyle?: TableCellStyle | undefined; + FieldValue?: string | undefined; /** - *

The cell styling options for the subtotals of header cells.

+ *

The axis that you are binding the field to.

* @public */ - MetricHeaderCellStyle?: TableCellStyle | undefined; + AxisBinding: AxisBinding | undefined; /** - *

The style targets options for subtotals.

+ *

The options that determine the presentation of line series associated to the field.

* @public */ - StyleTargets?: TableStyleTarget[] | undefined; + Settings?: LineChartSeriesSettings | undefined; } /** - * @public - * @enum - */ -export const TableTotalsPlacement = { - AUTO: "AUTO", - END: "END", - START: "START", -} as const; - -/** - * @public - */ -export type TableTotalsPlacement = (typeof TableTotalsPlacement)[keyof typeof TableTotalsPlacement]; - -/** - * @public - * @enum - */ -export const TableTotalsScrollStatus = { - PINNED: "PINNED", - SCROLLED: "SCROLLED", -} as const; - -/** - * @public - */ -export type TableTotalsScrollStatus = (typeof TableTotalsScrollStatus)[keyof typeof TableTotalsScrollStatus]; - -/** - * @public - * @enum - */ -export const SimpleTotalAggregationFunction = { - AVERAGE: "AVERAGE", - DEFAULT: "DEFAULT", - MAX: "MAX", - MIN: "MIN", - NONE: "NONE", - SUM: "SUM", -} as const; - -/** - * @public - */ -export type SimpleTotalAggregationFunction = - (typeof SimpleTotalAggregationFunction)[keyof typeof SimpleTotalAggregationFunction]; - -/** - *

An aggregation function that aggregates the total values of a measure.

+ *

The field series item configuration of a line chart.

* @public */ -export interface TotalAggregationFunction { +export interface FieldSeriesItem { /** - *

A built in aggregation function for total values.

+ *

The field ID of the field for which you are setting the axis binding.

* @public */ - SimpleTotalAggregationFunction?: SimpleTotalAggregationFunction | undefined; -} + FieldId: string | undefined; -/** - *

The total aggregation settings map of a field id.

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

The field id that's associated with the total aggregation option.

+ *

The axis that you are binding the field to.

* @public */ - FieldId: string | undefined; + AxisBinding: AxisBinding | undefined; /** - *

The total aggregation function that you want to set for a specified field id.

+ *

The options that determine the presentation of line series associated to the field.

* @public */ - TotalAggregationFunction: TotalAggregationFunction | undefined; + Settings?: LineChartSeriesSettings | undefined; } /** - *

The optional configuration of totals cells in a PivotTableVisual.

+ *

The series item configuration of a line chart.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The visibility configuration for the total cells.

- * @public - */ - TotalsVisibility?: Visibility | undefined; - +export interface SeriesItem { /** - *

The placement (start, end) for the total cells.

+ *

The field series item configuration of a line chart.

* @public */ - Placement?: TableTotalsPlacement | undefined; + FieldSeriesItem?: FieldSeriesItem | undefined; /** - *

The scroll status (pinned, scrolled) for the total cells.

+ *

The data field series item configuration of a line chart.

* @public */ - ScrollStatus?: TableTotalsScrollStatus | undefined; + DataFieldSeriesItem?: DataFieldSeriesItem | undefined; +} +/** + *

The sort configuration of a line chart.

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

The custom label string for the total cells.

+ *

The sort configuration of the category fields.

* @public */ - CustomLabel?: string | undefined; + CategorySort?: FieldSortOptions[] | undefined; /** - *

The cell styling options for the total cells.

+ *

The limit on the number of categories that are displayed in a line chart.

* @public */ - TotalCellStyle?: TableCellStyle | undefined; + CategoryItemsLimitConfiguration?: ItemsLimitConfiguration | undefined; /** - *

The cell styling options for the totals of value cells.

+ *

The limit on the number of lines that are displayed in a line chart.

* @public */ - ValueCellStyle?: TableCellStyle | undefined; + ColorItemsLimitConfiguration?: ItemsLimitConfiguration | undefined; /** - *

The cell styling options for the total of header cells.

+ *

The sort configuration of the small multiples field.

* @public */ - MetricHeaderCellStyle?: TableCellStyle | undefined; + SmallMultiplesSort?: FieldSortOptions[] | undefined; /** - *

The total aggregation options for each value field.

+ *

The limit on the number of small multiples panels that are displayed.

* @public */ - TotalAggregationOptions?: TotalAggregationOption[] | undefined; + SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration | undefined; } /** - *

The total options for a pivot table visual.

+ * @public + * @enum + */ +export const LineChartType = { + AREA: "AREA", + LINE: "LINE", + STACKED_AREA: "STACKED_AREA", +} as const; + +/** * @public */ -export interface PivotTableTotalOptions { +export type LineChartType = (typeof LineChartType)[keyof typeof LineChartType]; + +/** + *

The configuration of a line chart.

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

The row subtotal options.

+ *

The field well configuration of a line chart.

* @public */ - RowSubtotalOptions?: SubtotalOptions | undefined; + FieldWells?: LineChartFieldWells | undefined; /** - *

The column subtotal options.

+ *

The sort configuration of a line chart.

* @public */ - ColumnSubtotalOptions?: SubtotalOptions | undefined; + SortConfiguration?: LineChartSortConfiguration | undefined; /** - *

The row total options.

+ *

The forecast configuration of a line chart.

* @public */ - RowTotalOptions?: PivotTotalOptions | undefined; + ForecastConfigurations?: ForecastConfiguration[] | undefined; /** - *

The column total options.

+ *

Determines the type of the line chart.

* @public */ - ColumnTotalOptions?: PivotTotalOptions | undefined; -} + Type?: LineChartType | undefined; -/** - *

The configuration for a PivotTableVisual.

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

The field wells of the visual.

+ *

The small multiples setup for the visual.

* @public */ - FieldWells?: PivotTableFieldWells | undefined; + SmallMultiplesOptions?: SmallMultiplesOptions | undefined; /** - *

The sort configuration for a PivotTableVisual.

+ *

The options that determine the presentation of the x-axis.

* @public */ - SortConfiguration?: PivotTableSortConfiguration | undefined; + XAxisDisplayOptions?: AxisDisplayOptions | undefined; /** - *

The table options for a pivot table visual.

+ *

The options that determine the presentation of the x-axis label.

* @public */ - TableOptions?: PivotTableOptions | undefined; + XAxisLabelOptions?: ChartAxisLabelOptions | undefined; /** - *

The total options for a pivot table visual.

+ *

The series axis configuration of a line chart.

* @public */ - TotalOptions?: PivotTableTotalOptions | undefined; + PrimaryYAxisDisplayOptions?: LineSeriesAxisDisplayOptions | undefined; /** - *

The field options for a pivot table visual.

+ *

The options that determine the presentation of the y-axis label.

* @public */ - FieldOptions?: PivotTableFieldOptions | undefined; + PrimaryYAxisLabelOptions?: ChartAxisLabelOptions | undefined; /** - *

The paginated report options for a pivot table visual.

+ *

The series axis configuration of a line chart.

* @public */ - PaginatedReportOptions?: PivotTablePaginatedReportOptions | undefined; + SecondaryYAxisDisplayOptions?: LineSeriesAxisDisplayOptions | undefined; /** - *

The general visual interactions setup for a visual.

+ *

The options that determine the presentation of the secondary y-axis label.

* @public */ - Interactions?: VisualInteractionOptions | undefined; -} - -/** - * @public - * @enum - */ -export const PivotTableConditionalFormattingScopeRole = { - FIELD: "FIELD", - FIELD_TOTAL: "FIELD_TOTAL", - GRAND_TOTAL: "GRAND_TOTAL", -} as const; - -/** - * @public - */ -export type PivotTableConditionalFormattingScopeRole = - (typeof PivotTableConditionalFormattingScopeRole)[keyof typeof PivotTableConditionalFormattingScopeRole]; + SecondaryYAxisLabelOptions?: ChartAxisLabelOptions | undefined; -/** - *

The scope of the cell for conditional formatting.

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

The role (field, field total, grand total) of the cell for conditional formatting.

+ *

The settings of a chart's single axis configuration.

* @public */ - Role?: PivotTableConditionalFormattingScopeRole | undefined; -} + SingleAxisOptions?: SingleAxisOptions | undefined; -/** - *

The conditional formatting for the text.

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

The conditional formatting for the text background color.

+ *

The options that determine the default presentation of all line series in LineChartVisual.

* @public */ - BackgroundColor?: ConditionalFormattingColor | undefined; + DefaultSeriesSettings?: LineChartDefaultSeriesSettings | undefined; /** - *

The conditional formatting for the text color.

+ *

The series item configuration of a line chart.

* @public */ - TextColor?: ConditionalFormattingColor | undefined; + Series?: SeriesItem[] | undefined; /** - *

The conditional formatting for the icon.

+ *

The legend configuration of a line chart.

* @public */ - Icon?: ConditionalFormattingIcon | undefined; -} + Legend?: LegendOptions | undefined; -/** - *

The cell conditional formatting option for a pivot table.

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

The field ID of the cell for conditional formatting.

+ *

The data label configuration of a line chart.

* @public */ - FieldId: string | undefined; + DataLabels?: DataLabelOptions | undefined; /** - *

The text format of the cell for conditional formatting.

+ *

The reference lines configuration of a line chart.

* @public */ - TextFormat?: TextConditionalFormat | undefined; + ReferenceLines?: ReferenceLine[] | undefined; /** - *

The scope of the cell for conditional formatting.

+ *

The tooltip configuration of a line chart.

* @public */ - Scope?: PivotTableConditionalFormattingScope | undefined; + Tooltip?: TooltipOptions | undefined; /** - *

A list of cell scopes for conditional formatting.

+ *

The default configuration of a line chart's contribution analysis.

* @public */ - Scopes?: PivotTableConditionalFormattingScope[] | undefined; -} + ContributionAnalysisDefaults?: ContributionAnalysisDefault[] | undefined; -/** - *

Conditional formatting options for a PivotTableVisual.

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

The cell conditional formatting option for a pivot table.

+ *

The visual palette configuration of a line chart.

* @public */ - Cell?: PivotTableCellConditionalFormatting | undefined; -} + VisualPalette?: VisualPalette | undefined; -/** - *

The conditional formatting for a PivotTableVisual.

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

Conditional formatting options for a PivotTableVisual.

+ *

The general visual interactions setup for a visual.

* @public */ - ConditionalFormattingOptions?: PivotTableConditionalFormattingOption[] | undefined; + Interactions?: VisualInteractionOptions | undefined; } /** - *

A pivot table.

- *

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

+ *

A line chart.

+ *

For more information, see Using line charts in the Amazon QuickSight User Guide.

* @public */ -export interface PivotTableVisual { +export interface LineChartVisual { /** - *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

* @public */ VisualId: string | undefined; @@ -6474,237 +6351,243 @@ export interface PivotTableVisual { Subtitle?: VisualSubtitleLabelOptions | undefined; /** - *

The configuration settings of the visual.

+ *

The configuration of a line chart.

* @public */ - ChartConfiguration?: PivotTableConfiguration | undefined; + ChartConfiguration?: LineChartConfiguration | undefined; /** - *

The conditional formatting for a PivotTableVisual.

+ *

The list of custom actions that are configured for a visual.

* @public */ - ConditionalFormatting?: PivotTableConditionalFormatting | undefined; + Actions?: VisualCustomAction[] | undefined; /** - *

The list of custom actions that are configured for a visual.

+ *

The column hierarchy that is used during drill-downs and drill-ups.

* @public */ - Actions?: VisualCustomAction[] | undefined; + ColumnHierarchies?: ColumnHierarchy[] | undefined; + + /** + *

The alt text for the visual.

+ * @public + */ + VisualContentAltText?: string | undefined; } /** * @public * @enum */ -export const RadarChartAxesRangeScale = { - AUTO: "AUTO", - INDEPENDENT: "INDEPENDENT", - SHARED: "SHARED", +export const ArcThickness = { + LARGE: "LARGE", + MEDIUM: "MEDIUM", + SMALL: "SMALL", + WHOLE: "WHOLE", } as const; /** * @public */ -export type RadarChartAxesRangeScale = (typeof RadarChartAxesRangeScale)[keyof typeof RadarChartAxesRangeScale]; +export type ArcThickness = (typeof ArcThickness)[keyof typeof ArcThickness]; /** - *

The configured style settings of a radar chart.

+ *

The options that determine the arc thickness of a GaugeChartVisual.

* @public */ -export interface RadarChartAreaStyleSettings { +export interface ArcOptions { /** - *

The visibility settings of a radar chart.

+ *

The arc thickness of a GaugeChartVisual.

* @public */ - Visibility?: Visibility | undefined; + ArcThickness?: ArcThickness | undefined; } /** - *

The series settings of a radar chart.

+ *

The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.

* @public */ -export interface RadarChartSeriesSettings { +export interface DonutCenterOptions { /** - *

The area style settings of a radar chart.

+ *

Determines the visibility of the label in a donut chart. In the Amazon QuickSight console, this option is called 'Show total'.

* @public */ - AreaStyleSettings?: RadarChartAreaStyleSettings | undefined; + LabelVisibility?: Visibility | undefined; } /** - *

The aggregated field well configuration of a RadarChartVisual.

+ *

The options for configuring a donut chart or pie chart.

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

The aggregated field well categories of a radar chart.

- * @public - */ - Category?: DimensionField[] | undefined; - - /** - *

The color that are assigned to the aggregated field wells of a radar chart.

- * @public - */ - Color?: DimensionField[] | undefined; - +export interface DonutOptions { /** - *

The values that are assigned to the aggregated field wells of a radar chart.

+ *

The option for define the arc of the chart shape. Valid values are as follows:

+ *
    + *
  • + *

    + * WHOLE - A pie chart

    + *
  • + *
  • + *

    + * SMALL- A small-sized donut chart

    + *
  • + *
  • + *

    + * MEDIUM- A medium-sized donut chart

    + *
  • + *
  • + *

    + * LARGE- A large-sized donut chart

    + *
  • + *
* @public */ - Values?: MeasureField[] | undefined; -} + ArcOptions?: ArcOptions | undefined; -/** - *

The field wells of a radar chart visual.

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

The aggregated field wells of a radar chart visual.

+ *

The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.

* @public */ - RadarChartAggregatedFieldWells?: RadarChartAggregatedFieldWells | undefined; + DonutCenterOptions?: DonutCenterOptions | undefined; } /** - * @public - * @enum - */ -export const RadarChartShape = { - CIRCLE: "CIRCLE", - POLYGON: "POLYGON", -} as const; - -/** - * @public - */ -export type RadarChartShape = (typeof RadarChartShape)[keyof typeof RadarChartShape]; - -/** - *

The sort configuration of a RadarChartVisual.

+ *

The field well configuration of a pie chart.

* @public */ -export interface RadarChartSortConfiguration { +export interface PieChartAggregatedFieldWells { /** - *

The category sort options of a radar chart.

+ *

The category (group/color) field wells of a pie chart.

* @public */ - CategorySort?: FieldSortOptions[] | undefined; + Category?: DimensionField[] | undefined; /** - *

The category items limit for a radar chart.

+ *

The value field wells of a pie chart. Values are aggregated based on categories.

* @public */ - CategoryItemsLimit?: ItemsLimitConfiguration | undefined; + Values?: MeasureField[] | undefined; /** - *

The color sort configuration of a radar chart.

+ *

The small multiples field well of a pie chart.

* @public */ - ColorSort?: FieldSortOptions[] | undefined; + SmallMultiples?: DimensionField[] | undefined; +} +/** + *

The field well configuration of a pie chart.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The color items limit of a radar chart.

+ *

The field well configuration of a pie chart.

* @public */ - ColorItemsLimit?: ItemsLimitConfiguration | undefined; + PieChartAggregatedFieldWells?: PieChartAggregatedFieldWells | undefined; } /** - *

The configuration of a RadarChartVisual.

+ *

The sort configuration of a pie chart.

* @public */ -export interface RadarChartConfiguration { +export interface PieChartSortConfiguration { /** - *

The field well configuration of a RadarChartVisual.

+ *

The sort configuration of the category fields.

* @public */ - FieldWells?: RadarChartFieldWells | undefined; + CategorySort?: FieldSortOptions[] | undefined; /** - *

The sort configuration of a RadarChartVisual.

+ *

The limit on the number of categories that are displayed in a pie chart.

* @public */ - SortConfiguration?: RadarChartSortConfiguration | undefined; + CategoryItemsLimit?: ItemsLimitConfiguration | undefined; /** - *

The shape of the radar chart.

+ *

The sort configuration of the small multiples field.

* @public */ - Shape?: RadarChartShape | undefined; + SmallMultiplesSort?: FieldSortOptions[] | undefined; /** - *

The base sreies settings of a radar chart.

+ *

The limit on the number of small multiples panels that are displayed.

* @public */ - BaseSeriesSettings?: RadarChartSeriesSettings | undefined; + SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration | undefined; +} +/** + *

The configuration of a pie chart.

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

The start angle of a radar chart's axis.

+ *

The field wells of the visual.

* @public */ - StartAngle?: number | undefined; + FieldWells?: PieChartFieldWells | undefined; /** - *

The palette (chart color) display setup of the visual.

+ *

The sort configuration of a pie chart.

* @public */ - VisualPalette?: VisualPalette | undefined; + SortConfiguration?: PieChartSortConfiguration | undefined; /** - *

Determines the visibility of the colors of alternatign bands in a radar chart.

+ *

The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.

* @public */ - AlternateBandColorsVisibility?: Visibility | undefined; + DonutOptions?: DonutOptions | undefined; /** - *

The color of the even-numbered alternate bands of a radar chart.

+ *

The small multiples setup for the visual.

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

The color of the odd-numbered alternate bands of a radar chart.

+ *

The label options of the group/color that is displayed in a pie chart.

* @public */ - AlternateBandOddColor?: string | undefined; + CategoryLabelOptions?: ChartAxisLabelOptions | undefined; /** - *

The category axis of a radar chart.

+ *

The label options for the value that is displayed in a pie chart.

* @public */ - CategoryAxis?: AxisDisplayOptions | undefined; + ValueLabelOptions?: ChartAxisLabelOptions | undefined; /** - *

The category label options of a radar chart.

+ *

The legend display setup of the visual.

* @public */ - CategoryLabelOptions?: ChartAxisLabelOptions | undefined; + Legend?: LegendOptions | undefined; /** - *

The color axis of a radar chart.

+ *

The options that determine if visual data labels are displayed.

* @public */ - ColorAxis?: AxisDisplayOptions | undefined; + DataLabels?: DataLabelOptions | undefined; /** - *

The color label options of a radar chart.

+ *

The tooltip display setup of the visual.

* @public */ - ColorLabelOptions?: ChartAxisLabelOptions | undefined; + Tooltip?: TooltipOptions | undefined; /** - *

The legend display setup of the visual.

+ *

The palette (chart color) display setup of the visual.

* @public */ - Legend?: LegendOptions | undefined; + VisualPalette?: VisualPalette | undefined; /** - *

The axis behavior options of a radar chart.

+ *

The contribution analysis (anomaly configuration) setup of the visual.

* @public */ - AxesRangeScale?: RadarChartAxesRangeScale | undefined; + ContributionAnalysisDefaults?: ContributionAnalysisDefault[] | undefined; /** *

The general visual interactions setup for a visual.

@@ -6714,10 +6597,22 @@ export interface RadarChartConfiguration { } /** - *

A radar chart visual.

+ *

A pie or donut chart.

+ *

The PieChartVisual structure describes a visual that is a member of the pie chart family.

+ *

The following charts can be described by using this structure:

+ *
    + *
  • + *

    Pie charts

    + *
  • + *
  • + *

    Donut charts

    + *
  • + *
+ *

For more information, see Using pie charts in the Amazon QuickSight User Guide.

+ *

For more information, see Using donut charts in the Amazon QuickSight User Guide.

* @public */ -export interface RadarChartVisual { +export interface PieChartVisual { /** *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

* @public @@ -6737,10 +6632,10 @@ export interface RadarChartVisual { Subtitle?: VisualSubtitleLabelOptions | undefined; /** - *

The configuration settings of the visual.

+ *

The configuration of a pie chart.

* @public */ - ChartConfiguration?: RadarChartConfiguration | undefined; + ChartConfiguration?: PieChartConfiguration | undefined; /** *

The list of custom actions that are configured for a visual.

@@ -6753,761 +6648,807 @@ export interface RadarChartVisual { * @public */ ColumnHierarchies?: ColumnHierarchy[] | undefined; -} - -/** - *

The field well configuration of a sankey diagram.

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

The source field wells of a sankey diagram.

- * @public - */ - Source?: DimensionField[] | undefined; /** - *

The destination field wells of a sankey diagram.

+ *

The alt text for the visual.

* @public */ - Destination?: DimensionField[] | undefined; - - /** - *

The weight field wells of a sankey diagram.

- * @public - */ - Weight?: MeasureField[] | undefined; + VisualContentAltText?: string | undefined; } /** - *

The field well configuration of a sankey diagram.

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

The field well configuration of a sankey diagram.

- * @public - */ - SankeyDiagramAggregatedFieldWells?: SankeyDiagramAggregatedFieldWells | undefined; -} +export const PivotTableFieldCollapseState = { + COLLAPSED: "COLLAPSED", + EXPANDED: "EXPANDED", +} as const; /** - *

The sort configuration of a sankey diagram.

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

The sort configuration of the weight fields.

- * @public - */ - WeightSort?: FieldSortOptions[] | undefined; +export type PivotTableFieldCollapseState = + (typeof PivotTableFieldCollapseState)[keyof typeof PivotTableFieldCollapseState]; +/** + *

The target of a pivot table field collapse state.

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

The limit on the number of source nodes that are displayed in a sankey diagram.

+ *

The field ID of the pivot table that the collapse state needs to be set to.

* @public */ - SourceItemsLimit?: ItemsLimitConfiguration | undefined; + FieldId?: string | undefined; /** - *

The limit on the number of destination nodes that are displayed in a sankey diagram.

+ *

The data path of the pivot table's header. Used to set the collapse state.

* @public */ - DestinationItemsLimit?: ItemsLimitConfiguration | undefined; + FieldDataPathValues?: DataPathValue[] | undefined; } /** - *

The configuration of a sankey diagram.

+ *

The collapse state options for the pivot table field options.

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

The field well configuration of a sankey diagram.

- * @public - */ - FieldWells?: SankeyDiagramFieldWells | undefined; - - /** - *

The sort configuration of a sankey diagram.

- * @public - */ - SortConfiguration?: SankeyDiagramSortConfiguration | undefined; - +export interface PivotTableFieldCollapseStateOption { /** - *

The data label configuration of a sankey diagram.

+ *

A tagged-union object that sets the collapse state.

* @public */ - DataLabels?: DataLabelOptions | undefined; + Target: PivotTableFieldCollapseStateTarget | undefined; /** - *

The general visual interactions setup for a visual.

+ *

The state of the field target of a pivot table. Choose one of the following options:

+ *
    + *
  • + *

    + * COLLAPSED + *

    + *
  • + *
  • + *

    + * EXPANDED + *

    + *
  • + *
* @public */ - Interactions?: VisualInteractionOptions | undefined; + State?: PivotTableFieldCollapseState | undefined; } /** - *

A sankey diagram.

- *

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

+ *

The data path options for the pivot table field options.

* @public */ -export interface SankeyDiagramVisual { +export interface PivotTableDataPathOption { /** - *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

+ *

The list of data path values for the data path options.

* @public */ - VisualId: string | undefined; + DataPathList: DataPathValue[] | undefined; /** - *

The title that is displayed on the visual.

+ *

The width of the data path option.

* @public */ - Title?: VisualTitleLabelOptions | undefined; + Width?: string | undefined; +} +/** + *

The selected field options for the pivot table field options.

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

The subtitle that is displayed on the visual.

+ *

The field ID of the pivot table field.

* @public */ - Subtitle?: VisualSubtitleLabelOptions | undefined; + FieldId: string | undefined; /** - *

The configuration of a sankey diagram.

+ *

The custom label of the pivot table field.

* @public */ - ChartConfiguration?: SankeyDiagramChartConfiguration | undefined; + CustomLabel?: string | undefined; /** - *

The list of custom actions that are configured for a visual.

+ *

The visibility of the pivot table field.

* @public */ - Actions?: VisualCustomAction[] | undefined; + Visibility?: Visibility | undefined; } /** - *

The aggregated field well of a scatter plot.

+ *

The field options for a pivot table visual.

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

The x-axis field well of a scatter plot.

- *

The x-axis is aggregated by category.

- * @public - */ - XAxis?: MeasureField[] | undefined; - - /** - *

The y-axis field well of a scatter plot.

- *

The y-axis is aggregated by category.

- * @public - */ - YAxis?: MeasureField[] | undefined; - +export interface PivotTableFieldOptions { /** - *

The category field well of a scatter plot.

+ *

The selected field options for the pivot table field options.

* @public */ - Category?: DimensionField[] | undefined; + SelectedFieldOptions?: PivotTableFieldOption[] | undefined; /** - *

The size field well of a scatter plot.

+ *

The data path options for the pivot table field options.

* @public */ - Size?: MeasureField[] | undefined; + DataPathOptions?: PivotTableDataPathOption[] | undefined; /** - *

The label field well of a scatter plot.

+ *

The collapse state options for the pivot table field options.

* @public */ - Label?: DimensionField[] | undefined; + CollapseStateOptions?: PivotTableFieldCollapseStateOption[] | undefined; } /** - *

The unaggregated field wells of a scatter plot.

+ *

The aggregated field well for the pivot table.

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

The x-axis field well of a scatter plot.

- *

The x-axis is a dimension field and cannot be aggregated.

- * @public - */ - XAxis?: DimensionField[] | undefined; - +export interface PivotTableAggregatedFieldWells { /** - *

The y-axis field well of a scatter plot.

- *

The y-axis is a dimension field and cannot be aggregated.

+ *

The rows field well for a pivot table. Values are grouped by rows fields.

* @public */ - YAxis?: DimensionField[] | undefined; + Rows?: DimensionField[] | undefined; /** - *

The size field well of a scatter plot.

+ *

The columns field well for a pivot table. Values are grouped by columns fields.

* @public */ - Size?: MeasureField[] | undefined; + Columns?: DimensionField[] | undefined; /** - *

The category field well of a scatter plot.

+ *

The values field well for a pivot table. Values are aggregated based on rows and columns fields.

* @public */ - Category?: DimensionField[] | undefined; + Values?: MeasureField[] | undefined; +} +/** + *

The field wells for a pivot table visual.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

The label field well of a scatter plot.

+ *

The aggregated field well for the pivot table.

* @public */ - Label?: DimensionField[] | undefined; + PivotTableAggregatedFieldWells?: PivotTableAggregatedFieldWells | undefined; } /** - *

The field well configuration of a scatter plot.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

+ *

The paginated report options for a pivot table visual.

* @public */ -export interface ScatterPlotFieldWells { +export interface PivotTablePaginatedReportOptions { /** - *

The aggregated field wells of a scatter plot. The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both.

+ *

The visibility of the printing table overflow across pages.

* @public */ - ScatterPlotCategoricallyAggregatedFieldWells?: ScatterPlotCategoricallyAggregatedFieldWells | undefined; + VerticalOverflowVisibility?: Visibility | undefined; /** - *

The unaggregated field wells of a scatter plot. The x and y-axes of these scatter plots are - * unaggregated.

+ *

The visibility of the repeating header rows on each page.

* @public */ - ScatterPlotUnaggregatedFieldWells?: ScatterPlotUnaggregatedFieldWells | undefined; + OverflowColumnHeaderVisibility?: Visibility | undefined; } /** - *

The sort configuration of a scatter plot.

+ *

Allows data paths to be sorted by a specific data value.

* @public */ -export interface ScatterPlotSortConfiguration { +export interface DataPathSort { + /** + *

Determines the sort direction.

+ * @public + */ + Direction: SortDirection | undefined; + /** - *

The limit configuration of the visual display for an axis.

+ *

The list of data paths that need to be sorted.

* @public */ - ScatterPlotLimitConfiguration?: ItemsLimitConfiguration | undefined; + SortPaths: DataPathValue[] | undefined; } /** - *

The configuration of a scatter plot.

+ *

The sort by field for the field sort options.

* @public */ -export interface ScatterPlotConfiguration { +export interface PivotTableSortBy { /** - *

The field wells of the visual.

+ *

The field sort (field id, direction) for the pivot table sort by options.

* @public */ - FieldWells?: ScatterPlotFieldWells | undefined; + Field?: FieldSort | undefined; /** - *

The sort configuration of a scatter plot.

+ *

The column sort (field id, direction) for the pivot table sort by options.

* @public */ - SortConfiguration?: ScatterPlotSortConfiguration | undefined; + Column?: ColumnSort | undefined; /** - *

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.

+ *

The data path sort (data path value, direction) for the pivot table sort by options.

* @public */ - XAxisLabelOptions?: ChartAxisLabelOptions | undefined; + DataPath?: DataPathSort | undefined; +} +/** + *

The field sort options for a pivot table sort configuration.

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

The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.

+ *

The field ID for the field sort options.

* @public */ - XAxisDisplayOptions?: AxisDisplayOptions | undefined; + FieldId: string | undefined; /** - *

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.

+ *

The sort by field for the field sort options.

* @public */ - YAxisLabelOptions?: ChartAxisLabelOptions | undefined; + SortBy: PivotTableSortBy | undefined; +} +/** + *

The sort configuration for a PivotTableVisual.

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

The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.

+ *

The field sort options for a pivot table sort configuration.

* @public */ - YAxisDisplayOptions?: AxisDisplayOptions | undefined; + FieldSortOptions?: PivotFieldSortOptions[] | undefined; +} - /** - *

The legend display setup of the visual.

- * @public - */ - Legend?: LegendOptions | undefined; +/** + * @public + * @enum + */ +export const TableBorderStyle = { + NONE: "NONE", + SOLID: "SOLID", +} as const; - /** - *

The options that determine if visual data labels are displayed.

- * @public - */ - DataLabels?: DataLabelOptions | undefined; +/** + * @public + */ +export type TableBorderStyle = (typeof TableBorderStyle)[keyof typeof TableBorderStyle]; +/** + *

The border options for a table border.

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

The legend display setup of the visual.

+ *

The color of a table border.

* @public */ - Tooltip?: TooltipOptions | undefined; + Color?: string | undefined; /** - *

The palette (chart color) display setup of the visual.

+ *

The thickness of a table border.

* @public */ - VisualPalette?: VisualPalette | undefined; + Thickness?: number | undefined; /** - *

The general visual interactions setup for a visual.

+ *

The style (none, solid) of a table border.

* @public */ - Interactions?: VisualInteractionOptions | undefined; + Style?: TableBorderStyle | undefined; } /** - *

A scatter plot.

- *

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

+ *

The side border options for a table.

* @public */ -export interface ScatterPlotVisual { +export interface TableSideBorderOptions { /** - *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

+ *

The table border options of the inner vertical border.

* @public */ - VisualId: string | undefined; + InnerVertical?: TableBorderOptions | undefined; /** - *

The title that is displayed on the visual.

+ *

The table border options of the inner horizontal border.

* @public */ - Title?: VisualTitleLabelOptions | undefined; + InnerHorizontal?: TableBorderOptions | undefined; /** - *

The subtitle that is displayed on the visual.

+ *

The table border options of the left border.

* @public */ - Subtitle?: VisualSubtitleLabelOptions | undefined; + Left?: TableBorderOptions | undefined; /** - *

The configuration settings of the visual.

+ *

The table border options of the right border.

* @public */ - ChartConfiguration?: ScatterPlotConfiguration | undefined; + Right?: TableBorderOptions | undefined; /** - *

The list of custom actions that are configured for a visual.

+ *

The table border options of the top border.

* @public */ - Actions?: VisualCustomAction[] | undefined; + Top?: TableBorderOptions | undefined; /** - *

The column hierarchy that is used during drill-downs and drill-ups.

+ *

The table border options of the bottom border.

* @public */ - ColumnHierarchies?: ColumnHierarchy[] | undefined; + Bottom?: TableBorderOptions | undefined; } /** - *

The settings for the pinned columns of a table visual.

+ *

Determines the border options for a table visual.

* @public */ -export interface TablePinnedFieldOptions { +export interface GlobalTableBorderOptions { + /** + *

Determines the options for uniform border.

+ * @public + */ + UniformBorder?: TableBorderOptions | undefined; + /** - *

A list of columns to be pinned to the left of a table visual.

+ *

Determines the options for side specific border.

* @public */ - PinnedLeftFields?: string[] | undefined; + SideSpecificBorder?: TableSideBorderOptions | undefined; } /** * @public * @enum */ -export const TableCellImageScalingConfiguration = { - DO_NOT_SCALE: "DO_NOT_SCALE", - FIT_TO_CELL_HEIGHT: "FIT_TO_CELL_HEIGHT", - FIT_TO_CELL_WIDTH: "FIT_TO_CELL_WIDTH", +export const TextWrap = { + NONE: "NONE", + WRAP: "WRAP", } as const; /** * @public */ -export type TableCellImageScalingConfiguration = - (typeof TableCellImageScalingConfiguration)[keyof typeof TableCellImageScalingConfiguration]; +export type TextWrap = (typeof TextWrap)[keyof typeof TextWrap]; /** - *

The sizing options for the table image configuration.

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

The cell scaling configuration of the sizing options for the table image configuration.

- * @public - */ - TableCellImageScalingConfiguration?: TableCellImageScalingConfiguration | undefined; -} +export const VerticalTextAlignment = { + AUTO: "AUTO", + BOTTOM: "BOTTOM", + MIDDLE: "MIDDLE", + TOP: "TOP", +} as const; + +/** + * @public + */ +export type VerticalTextAlignment = (typeof VerticalTextAlignment)[keyof typeof VerticalTextAlignment]; /** - *

The image configuration of a table field URL.

+ *

The table cell style for a cell in pivot table or table visual.

* @public */ -export interface TableFieldImageConfiguration { +export interface TableCellStyle { + /** + *

The visibility of the table cells.

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

The font configuration of the table cells.

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

The text wrap (none, wrap) for the table cells.

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

The horizontal text alignment (left, center, right, auto) for the table cells.

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

The vertical text alignment (top, middle, bottom) for the table cells.

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

The background color for the table cells.

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

The height color for the table cells.

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

The sizing options for the table image configuration.

+ *

The borders for the table cells.

* @public */ - SizingOptions?: TableCellImageSizingConfiguration | undefined; + Border?: GlobalTableBorderOptions | undefined; } /** * @public * @enum */ -export const TableFieldIconSetType = { - LINK: "LINK", +export const PivotTableMetricPlacement = { + COLUMN: "COLUMN", + ROW: "ROW", } as const; /** * @public */ -export type TableFieldIconSetType = (typeof TableFieldIconSetType)[keyof typeof TableFieldIconSetType]; +export type PivotTableMetricPlacement = (typeof PivotTableMetricPlacement)[keyof typeof PivotTableMetricPlacement]; /** - *

The custom icon content for the table link content configuration.

+ *

Determines the row alternate color options.

* @public */ -export interface TableFieldCustomIconContent { +export interface RowAlternateColorOptions { /** - *

The icon set type (link) of the custom icon content for table URL link content.

+ *

Determines the widget status.

* @public */ - Icon?: TableFieldIconSetType | undefined; -} + Status?: WidgetStatus | undefined; -/** - *

The custom text content (value, font configuration) for the table link content configuration.

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

The string value of the custom text content for the table URL link content.

+ *

Determines the list of row alternate colors.

* @public */ - Value?: string | undefined; + RowAlternateColors?: string[] | undefined; /** - *

The font configuration of the custom text content for the table URL link content.

+ *

The primary background color options for alternate rows.

* @public */ - FontConfiguration: FontConfiguration | undefined; + UsePrimaryBackgroundColor?: WidgetStatus | undefined; } /** - *

The URL content (text, icon) for the table link configuration.

+ *

The options for the label thta is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

* @public */ -export interface TableFieldLinkContentConfiguration { +export interface PivotTableRowsLabelOptions { /** - *

The custom text content (value, font configuration) for the table link content configuration.

+ *

The visibility of the rows label.

* @public */ - CustomTextContent?: TableFieldCustomTextContent | undefined; + Visibility?: Visibility | undefined; /** - *

The custom icon content for the table link content configuration.

+ *

The custom label string for the rows label.

* @public */ - CustomIconContent?: TableFieldCustomIconContent | undefined; + CustomLabel?: string | undefined; } /** - *

The link configuration of a table field URL.

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

The URL target (new tab, new window, same tab) for the table link configuration.

- * @public - */ - Target: URLTargetConfiguration | undefined; +export const PivotTableRowsLayout = { + HIERARCHY: "HIERARCHY", + TABULAR: "TABULAR", +} as const; - /** - *

The URL content (text, icon) for the table link configuration.

- * @public - */ - Content: TableFieldLinkContentConfiguration | undefined; -} +/** + * @public + */ +export type PivotTableRowsLayout = (typeof PivotTableRowsLayout)[keyof typeof PivotTableRowsLayout]; /** - *

The URL configuration for a table field.

+ *

The table options for a pivot table visual.

* @public */ -export interface TableFieldURLConfiguration { +export interface PivotTableOptions { /** - *

The link configuration of a table field URL.

+ *

The metric placement (row, column) options.

* @public */ - LinkConfiguration?: TableFieldLinkConfiguration | undefined; + MetricPlacement?: PivotTableMetricPlacement | undefined; /** - *

The image configuration of a table field URL.

+ *

The visibility of the single metric options.

* @public */ - ImageConfiguration?: TableFieldImageConfiguration | undefined; -} + SingleMetricVisibility?: Visibility | undefined; -/** - *

The options for a table field.

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

The field ID for a table field.

+ *

The visibility of the column names.

* @public */ - FieldId: string | undefined; + ColumnNamesVisibility?: Visibility | undefined; /** - *

The width for a table field.

+ *

Determines the visibility of the pivot table.

* @public */ - Width?: string | undefined; + ToggleButtonsVisibility?: Visibility | undefined; /** - *

The custom label for a table field.

+ *

The table cell style of the column header.

* @public */ - CustomLabel?: string | undefined; + ColumnHeaderStyle?: TableCellStyle | undefined; /** - *

The visibility of a table field.

+ *

The table cell style of the row headers.

* @public */ - Visibility?: Visibility | undefined; + RowHeaderStyle?: TableCellStyle | undefined; /** - *

The URL configuration for a table field.

+ *

The table cell style of cells.

* @public */ - URLStyling?: TableFieldURLConfiguration | undefined; -} + CellStyle?: TableCellStyle | undefined; -/** - *

The field options of a table visual.

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

The field options to be configured to a table.

+ *

The table cell style of row field names.

* @public */ - SelectedFieldOptions?: TableFieldOption[] | undefined; + RowFieldNamesStyle?: TableCellStyle | undefined; /** - *

The order of the field IDs that are configured as field options for a table visual.

+ *

The row alternate color options (widget status, row alternate colors).

* @public */ - Order?: string[] | undefined; + RowAlternateColorOptions?: RowAlternateColorOptions | undefined; /** - *

The settings for the pinned columns of a table visual.

+ *

The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is HIDDEN, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE.

* @public */ - PinnedFieldOptions?: TablePinnedFieldOptions | undefined; -} + CollapsedRowDimensionsVisibility?: Visibility | undefined; -/** - *

The aggregated field well for the table.

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

The group by field well for a pivot table. Values are grouped by group by fields.

+ *

The layout for the row dimension headers of a pivot table. Choose one of the following options.

+ *
    + *
  • + *

    + * TABULAR: (Default) Each row field is displayed in a separate column.

    + *
  • + *
  • + *

    + * HIERARCHY: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.

    + *
  • + *
* @public */ - GroupBy?: DimensionField[] | undefined; + RowsLayout?: PivotTableRowsLayout | undefined; + + /** + *

The options for the label that is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

+ * @public + */ + RowsLabelOptions?: PivotTableRowsLabelOptions | undefined; /** - *

The values field well for a pivot table. Values are aggregated based on group by fields.

+ *

The default cell width of the pivot table.

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

The unaggregated field for a table.

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

The custom field ID.

- * @public - */ - FieldId: string | undefined; +export const PivotTableSubtotalLevel = { + ALL: "ALL", + CUSTOM: "CUSTOM", + LAST: "LAST", +} as const; - /** - *

The column that is used in the UnaggregatedField.

- * @public - */ - Column: ColumnIdentifier | undefined; +/** + * @public + */ +export type PivotTableSubtotalLevel = (typeof PivotTableSubtotalLevel)[keyof typeof PivotTableSubtotalLevel]; +/** + *

The optional configuration of subtotals cells.

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

The format configuration of the field.

+ *

The field ID of the subtotal options.

* @public */ - FormatConfiguration?: FormatConfiguration | undefined; + FieldId?: string | undefined; } /** - *

The unaggregated field well for the table.

+ * @public + * @enum + */ +export const StyledCellType = { + METRIC_HEADER: "METRIC_HEADER", + TOTAL: "TOTAL", + VALUE: "VALUE", +} as const; + +/** * @public */ -export interface TableUnaggregatedFieldWells { - /** - *

The values field well for a pivot table. Values are unaggregated for an unaggregated table.

- * @public - */ - Values?: UnaggregatedField[] | undefined; -} +export type StyledCellType = (typeof StyledCellType)[keyof typeof StyledCellType]; /** - *

The field wells for a table visual.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

+ *

The table style target.

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

The aggregated field well for the table.

- * @public - */ - TableAggregatedFieldWells?: TableAggregatedFieldWells | undefined; - +export interface TableStyleTarget { /** - *

The unaggregated field well for the table.

+ *

The cell type of the table style target.

* @public */ - TableUnaggregatedFieldWells?: TableUnaggregatedFieldWells | undefined; + CellType: StyledCellType | undefined; } /** - *

The paginated report options for a table visual.

+ *

The subtotal options.

* @public */ -export interface TablePaginatedReportOptions { +export interface SubtotalOptions { /** - *

The visibility of printing table overflow across pages.

+ *

The visibility configuration for the subtotal cells.

* @public */ - VerticalOverflowVisibility?: Visibility | undefined; + TotalsVisibility?: Visibility | undefined; /** - *

The visibility of repeating header rows on each page.

+ *

The custom label string for the subtotal cells.

* @public */ - OverflowColumnHeaderVisibility?: Visibility | undefined; -} + CustomLabel?: string | undefined; -/** - *

The sort configuration for a TableVisual.

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

The field sort options for rows in the table.

+ *

The field level (all, custom, last) for the subtotal cells.

* @public */ - RowSort?: FieldSortOptions[] | undefined; + FieldLevel?: PivotTableSubtotalLevel | undefined; /** - *

The pagination configuration (page size, page number) for the table.

+ *

The optional configuration of subtotal cells.

* @public */ - PaginationConfiguration?: PaginationConfiguration | undefined; -} + FieldLevelOptions?: PivotTableFieldSubtotalOptions[] | undefined; -/** - *

The options for data bars.

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

The field ID for the data bars options.

+ *

The cell styling options for the subtotal cells.

* @public */ - FieldId: string | undefined; + TotalCellStyle?: TableCellStyle | undefined; /** - *

The color of the positive data bar.

+ *

The cell styling options for the subtotals of value cells.

* @public */ - PositiveColor?: string | undefined; + ValueCellStyle?: TableCellStyle | undefined; /** - *

The color of the negative data bar.

+ *

The cell styling options for the subtotals of header cells.

* @public */ - NegativeColor?: string | undefined; -} + MetricHeaderCellStyle?: TableCellStyle | undefined; -/** - *

The inline visualization of a specific type to display within a chart.

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

The configuration of the inline visualization of the data bars within a chart.

+ *

The style targets options for subtotals.

* @public */ - DataBars?: DataBarsOptions | undefined; + StyleTargets?: TableStyleTarget[] | undefined; } /** * @public * @enum */ -export const TableOrientation = { - HORIZONTAL: "HORIZONTAL", - VERTICAL: "VERTICAL", +export const TableTotalsPlacement = { + AUTO: "AUTO", + END: "END", + START: "START", } as const; /** * @public */ -export type TableOrientation = (typeof TableOrientation)[keyof typeof TableOrientation]; +export type TableTotalsPlacement = (typeof TableTotalsPlacement)[keyof typeof TableTotalsPlacement]; /** - *

The table options for a table visual.

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

The orientation (vertical, horizontal) for a table.

- * @public - */ - Orientation?: TableOrientation | undefined; +export const TableTotalsScrollStatus = { + PINNED: "PINNED", + SCROLLED: "SCROLLED", +} as const; +/** + * @public + */ +export type TableTotalsScrollStatus = (typeof TableTotalsScrollStatus)[keyof typeof TableTotalsScrollStatus]; + +/** + * @public + * @enum + */ +export const SimpleTotalAggregationFunction = { + AVERAGE: "AVERAGE", + DEFAULT: "DEFAULT", + MAX: "MAX", + MIN: "MIN", + NONE: "NONE", + SUM: "SUM", +} as const; + +/** + * @public + */ +export type SimpleTotalAggregationFunction = + (typeof SimpleTotalAggregationFunction)[keyof typeof SimpleTotalAggregationFunction]; + +/** + *

An aggregation function that aggregates the total values of a measure.

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

The table cell style of a table header.

+ *

A built in aggregation function for total values.

* @public */ - HeaderStyle?: TableCellStyle | undefined; + SimpleTotalAggregationFunction?: SimpleTotalAggregationFunction | undefined; +} +/** + *

The total aggregation settings map of a field id.

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

The table cell style of table cells.

+ *

The field id that's associated with the total aggregation option.

* @public */ - CellStyle?: TableCellStyle | undefined; + FieldId: string | undefined; /** - *

The row alternate color options (widget status, row alternate colors) for a table.

+ *

The total aggregation function that you want to set for a specified field id.

* @public */ - RowAlternateColorOptions?: RowAlternateColorOptions | undefined; + TotalAggregationFunction: TotalAggregationFunction | undefined; } /** - *

The total options for a table visual.

+ *

The optional configuration of totals cells in a PivotTableVisual.

* @public */ -export interface TotalOptions { +export interface PivotTotalOptions { /** *

The visibility configuration for the total cells.

* @public @@ -7533,64 +7474,100 @@ export interface TotalOptions { CustomLabel?: string | undefined; /** - *

Cell styling options for the total cells.

+ *

The cell styling options for the total cells.

* @public */ TotalCellStyle?: TableCellStyle | undefined; /** - *

The total aggregation settings for each value field.

+ *

The cell styling options for the totals of value cells.

+ * @public + */ + ValueCellStyle?: TableCellStyle | undefined; + + /** + *

The cell styling options for the total of header cells.

+ * @public + */ + MetricHeaderCellStyle?: TableCellStyle | undefined; + + /** + *

The total aggregation options for each value field.

* @public */ TotalAggregationOptions?: TotalAggregationOption[] | undefined; } /** - *

The configuration for a TableVisual.

+ *

The total options for a pivot table visual.

* @public */ -export interface TableConfiguration { +export interface PivotTableTotalOptions { /** - *

The field wells of the visual.

+ *

The row subtotal options.

+ * @public + */ + RowSubtotalOptions?: SubtotalOptions | undefined; + + /** + *

The column subtotal options.

+ * @public + */ + ColumnSubtotalOptions?: SubtotalOptions | undefined; + + /** + *

The row total options.

+ * @public + */ + RowTotalOptions?: PivotTotalOptions | undefined; + + /** + *

The column total options.

* @public */ - FieldWells?: TableFieldWells | undefined; + ColumnTotalOptions?: PivotTotalOptions | undefined; +} +/** + *

The configuration for a PivotTableVisual.

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

The sort configuration for a TableVisual.

+ *

The field wells of the visual.

* @public */ - SortConfiguration?: TableSortConfiguration | undefined; + FieldWells?: PivotTableFieldWells | undefined; /** - *

The table options for a table visual.

+ *

The sort configuration for a PivotTableVisual.

* @public */ - TableOptions?: TableOptions | undefined; + SortConfiguration?: PivotTableSortConfiguration | undefined; /** - *

The total options for a table visual.

+ *

The table options for a pivot table visual.

* @public */ - TotalOptions?: TotalOptions | undefined; + TableOptions?: PivotTableOptions | undefined; /** - *

The field options for a table visual.

+ *

The total options for a pivot table visual.

* @public */ - FieldOptions?: TableFieldOptions | undefined; + TotalOptions?: PivotTableTotalOptions | undefined; /** - *

The paginated report options for a table visual.

+ *

The field options for a pivot table visual.

* @public */ - PaginatedReportOptions?: TablePaginatedReportOptions | undefined; + FieldOptions?: PivotTableFieldOptions | undefined; /** - *

A collection of inline visualizations to display within a chart.

+ *

The paginated report options for a pivot table visual.

* @public */ - TableInlineVisualizations?: TableInlineVisualization[] | undefined; + PaginatedReportOptions?: PivotTablePaginatedReportOptions | undefined; /** *

The general visual interactions setup for a visual.

@@ -7600,77 +7577,117 @@ export interface TableConfiguration { } /** - *

The cell conditional formatting option for a table.

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

The field ID of the cell for conditional formatting.

- * @public - */ - FieldId: string | undefined; +export const PivotTableConditionalFormattingScopeRole = { + FIELD: "FIELD", + FIELD_TOTAL: "FIELD_TOTAL", + GRAND_TOTAL: "GRAND_TOTAL", +} as const; + +/** + * @public + */ +export type PivotTableConditionalFormattingScopeRole = + (typeof PivotTableConditionalFormattingScopeRole)[keyof typeof PivotTableConditionalFormattingScopeRole]; +/** + *

The scope of the cell for conditional formatting.

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

The text format of the cell for conditional formatting.

+ *

The role (field, field total, grand total) of the cell for conditional formatting.

* @public */ - TextFormat?: TextConditionalFormat | undefined; + Role?: PivotTableConditionalFormattingScopeRole | undefined; } /** - *

The conditional formatting of a table row.

+ *

The conditional formatting for the text.

* @public */ -export interface TableRowConditionalFormatting { +export interface TextConditionalFormat { /** - *

The conditional formatting color (solid, gradient) of the background for a table row.

+ *

The conditional formatting for the text background color.

* @public */ BackgroundColor?: ConditionalFormattingColor | undefined; /** - *

The conditional formatting color (solid, gradient) of the text for a table row.

+ *

The conditional formatting for the text color.

* @public */ TextColor?: ConditionalFormattingColor | undefined; + + /** + *

The conditional formatting for the icon.

+ * @public + */ + Icon?: ConditionalFormattingIcon | undefined; } /** - *

Conditional formatting options for a PivotTableVisual.

+ *

The cell conditional formatting option for a pivot table.

* @public */ -export interface TableConditionalFormattingOption { +export interface PivotTableCellConditionalFormatting { + /** + *

The field ID of the cell for conditional formatting.

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

The text format of the cell for conditional formatting.

+ * @public + */ + TextFormat?: TextConditionalFormat | undefined; + + /** + *

The scope of the cell for conditional formatting.

+ * @public + */ + Scope?: PivotTableConditionalFormattingScope | undefined; + /** - *

The cell conditional formatting option for a table.

+ *

A list of cell scopes for conditional formatting.

* @public */ - Cell?: TableCellConditionalFormatting | undefined; + Scopes?: PivotTableConditionalFormattingScope[] | undefined; +} +/** + *

Conditional formatting options for a PivotTableVisual.

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

The row conditional formatting option for a table.

+ *

The cell conditional formatting option for a pivot table.

* @public */ - Row?: TableRowConditionalFormatting | undefined; + Cell?: PivotTableCellConditionalFormatting | undefined; } /** *

The conditional formatting for a PivotTableVisual.

* @public */ -export interface TableConditionalFormatting { +export interface PivotTableConditionalFormatting { /** *

Conditional formatting options for a PivotTableVisual.

* @public */ - ConditionalFormattingOptions?: TableConditionalFormattingOption[] | undefined; + ConditionalFormattingOptions?: PivotTableConditionalFormattingOption[] | undefined; } /** - *

A table visual.

- *

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

+ *

A pivot table.

+ *

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

* @public */ -export interface TableVisual { +export interface PivotTableVisual { /** *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

* @public @@ -7693,76 +7710,124 @@ export interface TableVisual { *

The configuration settings of the visual.

* @public */ - ChartConfiguration?: TableConfiguration | undefined; + ChartConfiguration?: PivotTableConfiguration | undefined; /** *

The conditional formatting for a PivotTableVisual.

* @public */ - ConditionalFormatting?: TableConditionalFormatting | undefined; + ConditionalFormatting?: PivotTableConditionalFormatting | undefined; + + /** + *

The list of custom actions that are configured for a visual.

+ * @public + */ + Actions?: VisualCustomAction[] | undefined; + + /** + *

The alt text for the visual.

+ * @public + */ + VisualContentAltText?: string | undefined; +} + +/** + * @public + * @enum + */ +export const PluginVisualAxisName = { + GROUP_BY: "GROUP_BY", + VALUE: "VALUE", +} as const; - /** - *

The list of custom actions that are configured for a visual.

- * @public - */ - Actions?: VisualCustomAction[] | undefined; -} +/** + * @public + */ +export type PluginVisualAxisName = (typeof PluginVisualAxisName)[keyof typeof PluginVisualAxisName]; /** - *

Aggregated field wells of a tree map.

+ *

A collection of field wells for a plugin visual.

* @public */ -export interface TreeMapAggregatedFieldWells { +export interface PluginVisualFieldWell { + /** + *

The semantic axis name for the field well.

+ * @public + */ + AxisName?: PluginVisualAxisName | undefined; + /** - *

The group by field well of a tree map. Values are grouped based on group by fields.

+ *

A list of dimensions for the field well.

* @public */ - Groups?: DimensionField[] | undefined; + Dimensions?: DimensionField[] | undefined; /** - *

The size field well of a tree map. Values are aggregated based on group by fields.

+ *

A list of measures that exist in the field well.

* @public */ - Sizes?: MeasureField[] | undefined; + Measures?: MeasureField[] | undefined; /** - *

The color field well of a tree map. Values are grouped by aggregations based on group by fields.

+ *

A list of unaggregated fields that exist in the field well.

* @public */ - Colors?: MeasureField[] | undefined; + Unaggregated?: UnaggregatedField[] | undefined; } /** - *

The field wells of a tree map.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

+ *

A query limits configuration.

* @public */ -export interface TreeMapFieldWells { +export interface PluginVisualItemsLimitConfiguration { /** - *

The aggregated field wells of a tree map.

+ *

Determines how many values are be fetched at once.

* @public */ - TreeMapAggregatedFieldWells?: TreeMapAggregatedFieldWells | undefined; + ItemsLimit?: number | undefined; } /** - *

The sort configuration of a tree map.

+ *

The table query sorting options for the plugin visual.

* @public */ -export interface TreeMapSortConfiguration { +export interface PluginVisualTableQuerySort { /** - *

The sort configuration of group by fields.

+ *

Determines how data is sorted in the response.

* @public */ - TreeMapSort?: FieldSortOptions[] | undefined; + RowSort?: FieldSortOptions[] | undefined; /** - *

The limit on the number of groups that are displayed.

+ *

The maximum amount of data to be returned by a query.

* @public */ - TreeMapGroupItemsLimitConfiguration?: ItemsLimitConfiguration | undefined; + ItemsLimitConfiguration?: PluginVisualItemsLimitConfiguration | undefined; } +/** + * @internal + */ +export const ReferenceLineLabelConfigurationFilterSensitiveLog = (obj: ReferenceLineLabelConfiguration): any => ({ + ...obj, + ...(obj.ValueLabelConfiguration && { + ValueLabelConfiguration: ReferenceLineValueLabelConfigurationFilterSensitiveLog(obj.ValueLabelConfiguration), + }), +}); + +/** + * @internal + */ +export const ReferenceLineFilterSensitiveLog = (obj: ReferenceLine): any => ({ + ...obj, + ...(obj.DataConfiguration && { + DataConfiguration: ReferenceLineDataConfigurationFilterSensitiveLog(obj.DataConfiguration), + }), + ...(obj.LabelConfiguration && { + LabelConfiguration: ReferenceLineLabelConfigurationFilterSensitiveLog(obj.LabelConfiguration), + }), +}); + /** * @internal */ @@ -8480,6 +8545,77 @@ export const KPIVisualFilterSensitiveLog = (obj: KPIVisual): any => ({ }), }); +/** + * @internal + */ +export const LayerCustomActionOperationFilterSensitiveLog = (obj: LayerCustomActionOperation): any => ({ + ...obj, + ...(obj.SetParametersOperation && { + SetParametersOperation: CustomActionSetParametersOperationFilterSensitiveLog(obj.SetParametersOperation), + }), +}); + +/** + * @internal + */ +export const LayerCustomActionFilterSensitiveLog = (obj: LayerCustomAction): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const GeospatialLayerColorFieldFilterSensitiveLog = (obj: GeospatialLayerColorField): any => ({ + ...obj, + ...(obj.ColorValuesFields && { + ColorValuesFields: obj.ColorValuesFields.map((item) => MeasureFieldFilterSensitiveLog(item)), + }), +}); + +/** + * @internal + */ +export const UnaggregatedFieldFilterSensitiveLog = (obj: UnaggregatedField): any => ({ + ...obj, + ...(obj.FormatConfiguration && { + FormatConfiguration: FormatConfigurationFilterSensitiveLog(obj.FormatConfiguration), + }), +}); + +/** + * @internal + */ +export const GeospatialLayerJoinDefinitionFilterSensitiveLog = (obj: GeospatialLayerJoinDefinition): any => ({ + ...obj, + ...(obj.DatasetKeyField && { DatasetKeyField: UnaggregatedFieldFilterSensitiveLog(obj.DatasetKeyField) }), +}); + +/** + * @internal + */ +export const GeospatialLayerItemFilterSensitiveLog = (obj: GeospatialLayerItem): any => ({ + ...obj, + ...(obj.JoinDefinition && { JoinDefinition: GeospatialLayerJoinDefinitionFilterSensitiveLog(obj.JoinDefinition) }), +}); + +/** + * @internal + */ +export const GeospatialLayerMapConfigurationFilterSensitiveLog = (obj: GeospatialLayerMapConfiguration): any => ({ + ...obj, + ...(obj.MapLayers && { MapLayers: obj.MapLayers.map((item) => GeospatialLayerItemFilterSensitiveLog(item)) }), +}); + +/** + * @internal + */ +export const LayerMapVisualFilterSensitiveLog = (obj: LayerMapVisual): any => ({ + ...obj, + ...(obj.ChartConfiguration && { + ChartConfiguration: GeospatialLayerMapConfigurationFilterSensitiveLog(obj.ChartConfiguration), + }), +}); + /** * @internal */ @@ -8705,218 +8841,8 @@ export const PivotTableVisualFilterSensitiveLog = (obj: PivotTableVisual): any = /** * @internal */ -export const RadarChartAggregatedFieldWellsFilterSensitiveLog = (obj: RadarChartAggregatedFieldWells): any => ({ - ...obj, - ...(obj.Values && { Values: obj.Values.map((item) => MeasureFieldFilterSensitiveLog(item)) }), -}); - -/** - * @internal - */ -export const RadarChartFieldWellsFilterSensitiveLog = (obj: RadarChartFieldWells): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const RadarChartConfigurationFilterSensitiveLog = (obj: RadarChartConfiguration): any => ({ - ...obj, - ...(obj.VisualPalette && { VisualPalette: VisualPaletteFilterSensitiveLog(obj.VisualPalette) }), -}); - -/** - * @internal - */ -export const RadarChartVisualFilterSensitiveLog = (obj: RadarChartVisual): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const SankeyDiagramAggregatedFieldWellsFilterSensitiveLog = (obj: SankeyDiagramAggregatedFieldWells): any => ({ - ...obj, - ...(obj.Weight && { Weight: obj.Weight.map((item) => MeasureFieldFilterSensitiveLog(item)) }), -}); - -/** - * @internal - */ -export const SankeyDiagramFieldWellsFilterSensitiveLog = (obj: SankeyDiagramFieldWells): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const SankeyDiagramChartConfigurationFilterSensitiveLog = (obj: SankeyDiagramChartConfiguration): any => ({ - ...obj, - ...(obj.DataLabels && { DataLabels: DataLabelOptionsFilterSensitiveLog(obj.DataLabels) }), -}); - -/** - * @internal - */ -export const SankeyDiagramVisualFilterSensitiveLog = (obj: SankeyDiagramVisual): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const ScatterPlotCategoricallyAggregatedFieldWellsFilterSensitiveLog = ( - obj: ScatterPlotCategoricallyAggregatedFieldWells -): any => ({ - ...obj, - ...(obj.XAxis && { XAxis: obj.XAxis.map((item) => MeasureFieldFilterSensitiveLog(item)) }), - ...(obj.YAxis && { YAxis: obj.YAxis.map((item) => MeasureFieldFilterSensitiveLog(item)) }), - ...(obj.Size && { Size: obj.Size.map((item) => MeasureFieldFilterSensitiveLog(item)) }), -}); - -/** - * @internal - */ -export const ScatterPlotUnaggregatedFieldWellsFilterSensitiveLog = (obj: ScatterPlotUnaggregatedFieldWells): any => ({ - ...obj, - ...(obj.Size && { Size: obj.Size.map((item) => MeasureFieldFilterSensitiveLog(item)) }), -}); - -/** - * @internal - */ -export const ScatterPlotFieldWellsFilterSensitiveLog = (obj: ScatterPlotFieldWells): any => ({ - ...obj, - ...(obj.ScatterPlotCategoricallyAggregatedFieldWells && { - ScatterPlotCategoricallyAggregatedFieldWells: ScatterPlotCategoricallyAggregatedFieldWellsFilterSensitiveLog( - obj.ScatterPlotCategoricallyAggregatedFieldWells - ), - }), -}); - -/** - * @internal - */ -export const ScatterPlotConfigurationFilterSensitiveLog = (obj: ScatterPlotConfiguration): any => ({ - ...obj, - ...(obj.FieldWells && { FieldWells: ScatterPlotFieldWellsFilterSensitiveLog(obj.FieldWells) }), - ...(obj.DataLabels && { DataLabels: DataLabelOptionsFilterSensitiveLog(obj.DataLabels) }), - ...(obj.VisualPalette && { VisualPalette: VisualPaletteFilterSensitiveLog(obj.VisualPalette) }), -}); - -/** - * @internal - */ -export const ScatterPlotVisualFilterSensitiveLog = (obj: ScatterPlotVisual): any => ({ - ...obj, - ...(obj.ChartConfiguration && { - ChartConfiguration: ScatterPlotConfigurationFilterSensitiveLog(obj.ChartConfiguration), - }), -}); - -/** - * @internal - */ -export const TableAggregatedFieldWellsFilterSensitiveLog = (obj: TableAggregatedFieldWells): any => ({ - ...obj, - ...(obj.Values && { Values: obj.Values.map((item) => MeasureFieldFilterSensitiveLog(item)) }), -}); - -/** - * @internal - */ -export const UnaggregatedFieldFilterSensitiveLog = (obj: UnaggregatedField): any => ({ - ...obj, - ...(obj.FormatConfiguration && { - FormatConfiguration: FormatConfigurationFilterSensitiveLog(obj.FormatConfiguration), - }), -}); - -/** - * @internal - */ -export const TableUnaggregatedFieldWellsFilterSensitiveLog = (obj: TableUnaggregatedFieldWells): any => ({ - ...obj, - ...(obj.Values && { Values: obj.Values.map((item) => UnaggregatedFieldFilterSensitiveLog(item)) }), -}); - -/** - * @internal - */ -export const TableFieldWellsFilterSensitiveLog = (obj: TableFieldWells): any => ({ - ...obj, - ...(obj.TableUnaggregatedFieldWells && { - TableUnaggregatedFieldWells: TableUnaggregatedFieldWellsFilterSensitiveLog(obj.TableUnaggregatedFieldWells), - }), -}); - -/** - * @internal - */ -export const TableConfigurationFilterSensitiveLog = (obj: TableConfiguration): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const TableCellConditionalFormattingFilterSensitiveLog = (obj: TableCellConditionalFormatting): any => ({ - ...obj, - ...(obj.TextFormat && { TextFormat: TextConditionalFormatFilterSensitiveLog(obj.TextFormat) }), -}); - -/** - * @internal - */ -export const TableRowConditionalFormattingFilterSensitiveLog = (obj: TableRowConditionalFormatting): any => ({ - ...obj, - ...(obj.BackgroundColor && { BackgroundColor: ConditionalFormattingColorFilterSensitiveLog(obj.BackgroundColor) }), - ...(obj.TextColor && { TextColor: ConditionalFormattingColorFilterSensitiveLog(obj.TextColor) }), -}); - -/** - * @internal - */ -export const TableConditionalFormattingOptionFilterSensitiveLog = (obj: TableConditionalFormattingOption): any => ({ - ...obj, - ...(obj.Cell && { Cell: TableCellConditionalFormattingFilterSensitiveLog(obj.Cell) }), - ...(obj.Row && { Row: TableRowConditionalFormattingFilterSensitiveLog(obj.Row) }), -}); - -/** - * @internal - */ -export const TableConditionalFormattingFilterSensitiveLog = (obj: TableConditionalFormatting): any => ({ - ...obj, - ...(obj.ConditionalFormattingOptions && { - ConditionalFormattingOptions: obj.ConditionalFormattingOptions.map((item) => - TableConditionalFormattingOptionFilterSensitiveLog(item) - ), - }), -}); - -/** - * @internal - */ -export const TableVisualFilterSensitiveLog = (obj: TableVisual): any => ({ - ...obj, - ...(obj.ConditionalFormatting && { - ConditionalFormatting: TableConditionalFormattingFilterSensitiveLog(obj.ConditionalFormatting), - }), -}); - -/** - * @internal - */ -export const TreeMapAggregatedFieldWellsFilterSensitiveLog = (obj: TreeMapAggregatedFieldWells): any => ({ - ...obj, - ...(obj.Sizes && { Sizes: obj.Sizes.map((item) => MeasureFieldFilterSensitiveLog(item)) }), - ...(obj.Colors && { Colors: obj.Colors.map((item) => MeasureFieldFilterSensitiveLog(item)) }), -}); - -/** - * @internal - */ -export const TreeMapFieldWellsFilterSensitiveLog = (obj: TreeMapFieldWells): any => ({ +export const PluginVisualFieldWellFilterSensitiveLog = (obj: PluginVisualFieldWell): any => ({ ...obj, + ...(obj.Measures && { Measures: obj.Measures.map((item) => MeasureFieldFilterSensitiveLog(item)) }), + ...(obj.Unaggregated && { Unaggregated: obj.Unaggregated.map((item) => UnaggregatedFieldFilterSensitiveLog(item)) }), }); diff --git a/clients/client-quicksight/src/models/models_2.ts b/clients/client-quicksight/src/models/models_2.ts index 7a38b90aea9f..f07e261bb432 100644 --- a/clients/client-quicksight/src/models/models_2.ts +++ b/clients/client-quicksight/src/models/models_2.ts @@ -2,8 +2,6 @@ import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client"; import { - AccountCustomization, - AdHocFilteringOption, AggFunction, AggregationPartitionBy, AggType, @@ -17,14 +15,13 @@ import { ChartAxisLabelOptions, ColumnConfiguration, ColumnConfigurationFilterSensitiveLog, - DashboardBehavior, DataLabelOptions, DataLabelOptionsFilterSensitiveLog, DataSetIdentifierDeclaration, DimensionField, - Edition, FilterControl, FilterGroup, + FontConfiguration, Layout, LegendOptions, MeasureField, @@ -37,12 +34,14 @@ import { ResourceStatus, SheetContentType, SheetControlLayout, + SheetImage, SheetTextBox, TimeGranularity, TopicTimeGranularity, + URLTargetConfiguration, + Visibility, VisualCustomAction, VisualInteractionOptions, - VisualMenuOption, } from "./models_0"; import { @@ -51,6 +50,8 @@ import { ColorScale, ColumnHierarchy, ComboChartVisual, + ConditionalFormattingColor, + ConditionalFormattingColorFilterSensitiveLog, CustomContentVisual, EmptyVisual, FieldSortOptions, @@ -67,17 +68,24 @@ import { ItemsLimitConfiguration, KPIVisual, KPIVisualFilterSensitiveLog, + LayerMapVisual, + LayerMapVisualFilterSensitiveLog, LineChartVisual, + PaginationConfiguration, PieChartVisual, PivotTableVisual, - RadarChartVisual, - SankeyDiagramVisual, - ScatterPlotVisual, - ScatterPlotVisualFilterSensitiveLog, - TableVisual, + PluginVisualFieldWell, + PluginVisualTableQuerySort, + RowAlternateColorOptions, + TableCellStyle, + TableTotalsPlacement, + TableTotalsScrollStatus, + TextConditionalFormat, + TextConditionalFormatFilterSensitiveLog, TooltipOptions, - TreeMapFieldWells, - TreeMapSortConfiguration, + TotalAggregationOption, + UnaggregatedField, + UnaggregatedFieldFilterSensitiveLog, VisualPalette, VisualPaletteFilterSensitiveLog, VisualSubtitleLabelOptions, @@ -87,286 +95,329 @@ import { import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException"; /** - *

The configuration of a tree map.

+ *

Determines how the plugin visual sorts the data during query.

* @public */ -export interface TreeMapConfiguration { +export interface PluginVisualSortConfiguration { /** - *

The field wells of the visual.

+ *

The table query sorting options for the plugin visual.

* @public */ - FieldWells?: TreeMapFieldWells | undefined; + PluginVisualTableQuerySort?: PluginVisualTableQuerySort | undefined; +} +/** + *

The key value pair of the persisted property.

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

The sort configuration of a tree map.

+ *

The name of the plugin visual property.

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

The label options (label text, label visibility) of the groups that are displayed in a tree map.

+ *

The value of the plugin visual property.

* @public */ - GroupLabelOptions?: ChartAxisLabelOptions | undefined; + Value?: string | undefined; +} +/** + *

The options and persisted properties for the plugin visual.

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

The label options (label text, label visibility) of the sizes that are displayed in a tree map.

+ *

The persisted properties and their values.

* @public */ - SizeLabelOptions?: ChartAxisLabelOptions | undefined; + VisualProperties?: PluginVisualProperty[] | undefined; +} +/** + *

The plugin visual configuration. This includes the field wells, sorting options, and persisted options of the plugin visual.

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

The label options (label text, label visibility) for the colors displayed in a tree map.

+ *

The field wells configuration of the plugin visual.

* @public */ - ColorLabelOptions?: ChartAxisLabelOptions | undefined; + FieldWells?: PluginVisualFieldWell[] | undefined; /** - *

The color options (gradient color, point of divergence) of a tree map.

+ *

The persisted properties of the plugin visual.

* @public */ - ColorScale?: ColorScale | undefined; + VisualOptions?: PluginVisualOptions | undefined; /** - *

The legend display setup of the visual.

+ *

The sort configuration of the plugin visual.

* @public */ - Legend?: LegendOptions | undefined; + SortConfiguration?: PluginVisualSortConfiguration | undefined; +} +/** + *

A flexible visualization type that allows engineers + * to create new custom charts in Amazon QuickSight.

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

The options that determine if visual data labels are displayed.

+ *

The ID of the visual that you want to use.

* @public */ - DataLabels?: DataLabelOptions | undefined; + VisualId: string | undefined; /** - *

The tooltip display setup of the visual.

+ *

The Amazon Resource Name (ARN) that reflects the plugin and version.

* @public */ - Tooltip?: TooltipOptions | undefined; + PluginArn: string | undefined; /** - *

The general visual interactions setup for a visual.

+ *

The title label options for a visual.

* @public */ - Interactions?: VisualInteractionOptions | undefined; -} + Title?: VisualTitleLabelOptions | undefined; -/** - *

A tree map.

- *

For more information, see Using tree maps in the Amazon QuickSight User Guide.

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

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

+ *

The subtitle label options for a visual.

* @public */ - VisualId: string | undefined; + Subtitle?: VisualSubtitleLabelOptions | undefined; /** - *

The title that is displayed on the visual.

+ *

+ * A description of the plugin field wells and their persisted properties. + *

* @public */ - Title?: VisualTitleLabelOptions | undefined; + ChartConfiguration?: PluginVisualConfiguration | undefined; /** - *

The subtitle that is displayed on the visual.

+ *

The alt text for the visual.

* @public */ - Subtitle?: VisualSubtitleLabelOptions | undefined; + VisualContentAltText?: string | undefined; +} - /** - *

The configuration settings of the visual.

- * @public - */ - ChartConfiguration?: TreeMapConfiguration | undefined; +/** + * @public + * @enum + */ +export const RadarChartAxesRangeScale = { + AUTO: "AUTO", + INDEPENDENT: "INDEPENDENT", + SHARED: "SHARED", +} as const; + +/** + * @public + */ +export type RadarChartAxesRangeScale = (typeof RadarChartAxesRangeScale)[keyof typeof RadarChartAxesRangeScale]; +/** + *

The configured style settings of a radar chart.

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

The list of custom actions that are configured for a visual.

+ *

The visibility settings of a radar chart.

* @public */ - Actions?: VisualCustomAction[] | undefined; + Visibility?: Visibility | undefined; +} +/** + *

The series settings of a radar chart.

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

The column hierarchy that is used during drill-downs and drill-ups.

+ *

The area style settings of a radar chart.

* @public */ - ColumnHierarchies?: ColumnHierarchy[] | undefined; + AreaStyleSettings?: RadarChartAreaStyleSettings | undefined; } /** - *

The color configuration for individual groups within a waterfall visual.

+ *

The aggregated field well configuration of a RadarChartVisual.

* @public */ -export interface WaterfallChartGroupColorConfiguration { +export interface RadarChartAggregatedFieldWells { /** - *

Defines the color for the positive bars of a waterfall chart.

+ *

The aggregated field well categories of a radar chart.

* @public */ - PositiveBarColor?: string | undefined; + Category?: DimensionField[] | undefined; /** - *

Defines the color for the negative bars of a waterfall chart.

+ *

The color that are assigned to the aggregated field wells of a radar chart.

* @public */ - NegativeBarColor?: string | undefined; + Color?: DimensionField[] | undefined; /** - *

Defines the color for the total bars of a waterfall chart.

+ *

The values that are assigned to the aggregated field wells of a radar chart.

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

The color configuration of a waterfall visual.

+ *

The field wells of a radar chart visual.

* @public */ -export interface WaterfallChartColorConfiguration { +export interface RadarChartFieldWells { /** - *

The color configuration for individual groups within a waterfall visual.

+ *

The aggregated field wells of a radar chart visual.

* @public */ - GroupColorConfiguration?: WaterfallChartGroupColorConfiguration | undefined; + RadarChartAggregatedFieldWells?: RadarChartAggregatedFieldWells | undefined; } /** - *

The field well configuration of a waterfall visual.

* @public + * @enum */ -export interface WaterfallChartAggregatedFieldWells { +export const RadarChartShape = { + CIRCLE: "CIRCLE", + POLYGON: "POLYGON", +} as const; + +/** + * @public + */ +export type RadarChartShape = (typeof RadarChartShape)[keyof typeof RadarChartShape]; + +/** + *

The sort configuration of a RadarChartVisual.

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

The category field wells of a waterfall visual.

+ *

The category sort options of a radar chart.

* @public */ - Categories?: DimensionField[] | undefined; + CategorySort?: FieldSortOptions[] | undefined; /** - *

The value field wells of a waterfall visual.

+ *

The category items limit for a radar chart.

* @public */ - Values?: MeasureField[] | undefined; + CategoryItemsLimit?: ItemsLimitConfiguration | undefined; /** - *

The breakdown field wells of a waterfall visual.

+ *

The color sort configuration of a radar chart.

* @public */ - Breakdowns?: DimensionField[] | undefined; -} + ColorSort?: FieldSortOptions[] | undefined; -/** - *

The field well configuration of a waterfall visual.

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

The field well configuration of a waterfall visual.

+ *

The color items limit of a radar chart.

* @public */ - WaterfallChartAggregatedFieldWells?: WaterfallChartAggregatedFieldWells | undefined; + ColorItemsLimit?: ItemsLimitConfiguration | undefined; } /** - *

The sort configuration of a waterfall visual.

+ *

The configuration of a RadarChartVisual.

* @public */ -export interface WaterfallChartSortConfiguration { +export interface RadarChartConfiguration { /** - *

The sort configuration of the category fields.

+ *

The field well configuration of a RadarChartVisual.

* @public */ - CategorySort?: FieldSortOptions[] | undefined; + FieldWells?: RadarChartFieldWells | undefined; /** - *

The limit on the number of bar groups that are displayed.

+ *

The sort configuration of a RadarChartVisual.

* @public */ - BreakdownItemsLimit?: ItemsLimitConfiguration | undefined; -} + SortConfiguration?: RadarChartSortConfiguration | undefined; -/** - *

The options that determine the presentation of a waterfall visual.

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

This option determines the total bar label of a waterfall visual.

+ *

The shape of the radar chart.

* @public */ - TotalBarLabel?: string | undefined; -} + Shape?: RadarChartShape | undefined; -/** - *

The configuration for a waterfall visual.

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

The field well configuration of a waterfall visual.

+ *

The base sreies settings of a radar chart.

* @public */ - FieldWells?: WaterfallChartFieldWells | undefined; + BaseSeriesSettings?: RadarChartSeriesSettings | undefined; /** - *

The sort configuration of a waterfall visual.

+ *

The start angle of a radar chart's axis.

* @public */ - SortConfiguration?: WaterfallChartSortConfiguration | undefined; + StartAngle?: number | undefined; /** - *

The options that determine the presentation of a waterfall visual.

+ *

The palette (chart color) display setup of the visual.

* @public */ - WaterfallChartOptions?: WaterfallChartOptions | undefined; + VisualPalette?: VisualPalette | undefined; /** - *

The options that determine the presentation of the category axis label.

+ *

Determines the visibility of the colors of alternatign bands in a radar chart.

* @public */ - CategoryAxisLabelOptions?: ChartAxisLabelOptions | undefined; + AlternateBandColorsVisibility?: Visibility | undefined; /** - *

The options that determine the presentation of the category axis.

+ *

The color of the even-numbered alternate bands of a radar chart.

* @public */ - CategoryAxisDisplayOptions?: AxisDisplayOptions | undefined; + AlternateBandEvenColor?: string | undefined; /** - *

The options that determine the presentation of the y-axis label.

+ *

The color of the odd-numbered alternate bands of a radar chart.

* @public */ - PrimaryYAxisLabelOptions?: ChartAxisLabelOptions | undefined; + AlternateBandOddColor?: string | undefined; /** - *

The options that determine the presentation of the y-axis.

+ *

The category axis of a radar chart.

* @public */ - PrimaryYAxisDisplayOptions?: AxisDisplayOptions | undefined; + CategoryAxis?: AxisDisplayOptions | undefined; /** - *

The legend configuration of a waterfall visual.

+ *

The category label options of a radar chart.

* @public */ - Legend?: LegendOptions | undefined; + CategoryLabelOptions?: ChartAxisLabelOptions | undefined; /** - *

The data label configuration of a waterfall visual.

+ *

The color axis of a radar chart.

* @public */ - DataLabels?: DataLabelOptions | undefined; + ColorAxis?: AxisDisplayOptions | undefined; /** - *

The visual palette configuration of a waterfall visual.

+ *

The color label options of a radar chart.

* @public */ - VisualPalette?: VisualPalette | undefined; + ColorLabelOptions?: ChartAxisLabelOptions | undefined; /** - *

The color configuration of a waterfall visual.

+ *

The legend display setup of the visual.

* @public */ - ColorConfiguration?: WaterfallChartColorConfiguration | undefined; + Legend?: LegendOptions | undefined; + + /** + *

The axis behavior options of a radar chart.

+ * @public + */ + AxesRangeScale?: RadarChartAxesRangeScale | undefined; /** *

The general visual interactions setup for a visual.

@@ -376,11 +427,10 @@ export interface WaterfallChartConfiguration { } /** - *

A waterfall chart.

- *

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

+ *

A radar chart visual.

* @public */ -export interface WaterfallVisual { +export interface RadarChartVisual { /** *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

* @public @@ -400,10 +450,10 @@ export interface WaterfallVisual { Subtitle?: VisualSubtitleLabelOptions | undefined; /** - *

The configuration for a waterfall visual.

+ *

The configuration settings of the visual.

* @public */ - ChartConfiguration?: WaterfallChartConfiguration | undefined; + ChartConfiguration?: RadarChartConfiguration | undefined; /** *

The list of custom actions that are configured for a visual.

@@ -416,6719 +466,6862 @@ export interface WaterfallVisual { * @public */ ColumnHierarchies?: ColumnHierarchy[] | undefined; + + /** + *

The alt text for the visual.

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

The aggregated field wells of a word cloud.

+ *

The field well configuration of a sankey diagram.

* @public */ -export interface WordCloudAggregatedFieldWells { +export interface SankeyDiagramAggregatedFieldWells { /** - *

The group by field well of a word cloud. Values are grouped by group by fields.

+ *

The source field wells of a sankey diagram.

* @public */ - GroupBy?: DimensionField[] | undefined; + Source?: DimensionField[] | undefined; /** - *

The size field well of a word cloud. Values are aggregated based on group by fields.

+ *

The destination field wells of a sankey diagram.

* @public */ - Size?: MeasureField[] | undefined; + Destination?: DimensionField[] | undefined; + + /** + *

The weight field wells of a sankey diagram.

+ * @public + */ + Weight?: MeasureField[] | undefined; } /** - *

The field wells of a word cloud visual.

- *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

+ *

The field well configuration of a sankey diagram.

* @public */ -export interface WordCloudFieldWells { +export interface SankeyDiagramFieldWells { /** - *

The aggregated field wells of a word cloud.

+ *

The field well configuration of a sankey diagram.

* @public */ - WordCloudAggregatedFieldWells?: WordCloudAggregatedFieldWells | undefined; + SankeyDiagramAggregatedFieldWells?: SankeyDiagramAggregatedFieldWells | undefined; } /** - *

The sort configuration of a word cloud visual.

+ *

The sort configuration of a sankey diagram.

* @public */ -export interface WordCloudSortConfiguration { +export interface SankeyDiagramSortConfiguration { /** - *

The limit on the number of groups that are displayed in a word cloud.

+ *

The sort configuration of the weight fields.

* @public */ - CategoryItemsLimit?: ItemsLimitConfiguration | undefined; + WeightSort?: FieldSortOptions[] | undefined; /** - *

The sort configuration of group by fields.

+ *

The limit on the number of source nodes that are displayed in a sankey diagram.

* @public */ - CategorySort?: FieldSortOptions[] | undefined; + SourceItemsLimit?: ItemsLimitConfiguration | undefined; + + /** + *

The limit on the number of destination nodes that are displayed in a sankey diagram.

+ * @public + */ + DestinationItemsLimit?: ItemsLimitConfiguration | undefined; } /** + *

The configuration of a sankey diagram.

* @public - * @enum */ -export const WordCloudCloudLayout = { - FLUID: "FLUID", - NORMAL: "NORMAL", -} as const; +export interface SankeyDiagramChartConfiguration { + /** + *

The field well configuration of a sankey diagram.

+ * @public + */ + FieldWells?: SankeyDiagramFieldWells | undefined; -/** - * @public - */ -export type WordCloudCloudLayout = (typeof WordCloudCloudLayout)[keyof typeof WordCloudCloudLayout]; + /** + *

The sort configuration of a sankey diagram.

+ * @public + */ + SortConfiguration?: SankeyDiagramSortConfiguration | undefined; -/** - * @public - * @enum - */ -export const WordCloudWordCasing = { - EXISTING_CASE: "EXISTING_CASE", - LOWER_CASE: "LOWER_CASE", -} as const; + /** + *

The data label configuration of a sankey diagram.

+ * @public + */ + DataLabels?: DataLabelOptions | undefined; -/** - * @public - */ -export type WordCloudWordCasing = (typeof WordCloudWordCasing)[keyof typeof WordCloudWordCasing]; + /** + *

The general visual interactions setup for a visual.

+ * @public + */ + Interactions?: VisualInteractionOptions | undefined; +} /** + *

A sankey diagram.

+ *

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

* @public - * @enum */ -export const WordCloudWordOrientation = { - HORIZONTAL: "HORIZONTAL", - HORIZONTAL_AND_VERTICAL: "HORIZONTAL_AND_VERTICAL", -} as const; - -/** - * @public - */ -export type WordCloudWordOrientation = (typeof WordCloudWordOrientation)[keyof typeof WordCloudWordOrientation]; - -/** - * @public - * @enum - */ -export const WordCloudWordPadding = { - LARGE: "LARGE", - MEDIUM: "MEDIUM", - NONE: "NONE", - SMALL: "SMALL", -} as const; - -/** - * @public - */ -export type WordCloudWordPadding = (typeof WordCloudWordPadding)[keyof typeof WordCloudWordPadding]; - -/** - * @public - * @enum - */ -export const WordCloudWordScaling = { - EMPHASIZE: "EMPHASIZE", - NORMAL: "NORMAL", -} as const; - -/** - * @public - */ -export type WordCloudWordScaling = (typeof WordCloudWordScaling)[keyof typeof WordCloudWordScaling]; - -/** - *

The word cloud options for a word cloud visual.

- * @public - */ -export interface WordCloudOptions { +export interface SankeyDiagramVisual { /** - *

The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

* @public */ - WordOrientation?: WordCloudWordOrientation | undefined; + VisualId: string | undefined; /** - *

The word scaling options (emphasize, normal) for the words in a word cloud.

+ *

The title that is displayed on the visual.

* @public */ - WordScaling?: WordCloudWordScaling | undefined; + Title?: VisualTitleLabelOptions | undefined; /** - *

The cloud layout options (fluid, normal) of a word cloud.

+ *

The subtitle that is displayed on the visual.

* @public */ - CloudLayout?: WordCloudCloudLayout | undefined; + Subtitle?: VisualSubtitleLabelOptions | undefined; /** - *

The word casing options (lower_case, existing_case) for the words in a word cloud.

+ *

The configuration of a sankey diagram.

* @public */ - WordCasing?: WordCloudWordCasing | undefined; + ChartConfiguration?: SankeyDiagramChartConfiguration | undefined; /** - *

The word padding options (none, small, medium, large) for the words in a word cloud.

+ *

The list of custom actions that are configured for a visual.

* @public */ - WordPadding?: WordCloudWordPadding | undefined; + Actions?: VisualCustomAction[] | undefined; /** - *

The length limit of each word from 1-100.

+ *

The alt text for the visual.

* @public */ - MaximumStringLength?: number | undefined; + VisualContentAltText?: string | undefined; } /** - *

The configuration of a word cloud visual.

+ *

The aggregated field well of a scatter plot.

* @public */ -export interface WordCloudChartConfiguration { +export interface ScatterPlotCategoricallyAggregatedFieldWells { /** - *

The field wells of the visual.

+ *

The x-axis field well of a scatter plot.

+ *

The x-axis is aggregated by category.

* @public */ - FieldWells?: WordCloudFieldWells | undefined; + XAxis?: MeasureField[] | undefined; /** - *

The sort configuration of a word cloud visual.

+ *

The y-axis field well of a scatter plot.

+ *

The y-axis is aggregated by category.

* @public */ - SortConfiguration?: WordCloudSortConfiguration | undefined; + YAxis?: MeasureField[] | undefined; /** - *

The label options (label text, label visibility, and sort icon visibility) for the word cloud category.

+ *

The category field well of a scatter plot.

* @public */ - CategoryLabelOptions?: ChartAxisLabelOptions | undefined; + Category?: DimensionField[] | undefined; /** - *

The options for a word cloud visual.

+ *

The size field well of a scatter plot.

* @public */ - WordCloudOptions?: WordCloudOptions | undefined; + Size?: MeasureField[] | undefined; /** - *

The general visual interactions setup for a visual.

+ *

The label field well of a scatter plot.

* @public */ - Interactions?: VisualInteractionOptions | undefined; + Label?: DimensionField[] | undefined; } /** - *

A word cloud.

- *

For more information, see Using word clouds in the Amazon QuickSight User Guide.

+ *

The unaggregated field wells of a scatter plot.

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

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

- * @public - */ - VisualId: string | undefined; - +export interface ScatterPlotUnaggregatedFieldWells { /** - *

The title that is displayed on the visual.

+ *

The x-axis field well of a scatter plot.

+ *

The x-axis is a dimension field and cannot be aggregated.

* @public */ - Title?: VisualTitleLabelOptions | undefined; + XAxis?: DimensionField[] | undefined; /** - *

The subtitle that is displayed on the visual.

+ *

The y-axis field well of a scatter plot.

+ *

The y-axis is a dimension field and cannot be aggregated.

* @public */ - Subtitle?: VisualSubtitleLabelOptions | undefined; + YAxis?: DimensionField[] | undefined; /** - *

The configuration settings of the visual.

+ *

The size field well of a scatter plot.

* @public */ - ChartConfiguration?: WordCloudChartConfiguration | undefined; + Size?: MeasureField[] | undefined; /** - *

The list of custom actions that are configured for a visual.

+ *

The category field well of a scatter plot.

* @public */ - Actions?: VisualCustomAction[] | undefined; + Category?: DimensionField[] | undefined; /** - *

The column hierarchy that is used during drill-downs and drill-ups.

+ *

The label field well of a scatter plot.

* @public */ - ColumnHierarchies?: ColumnHierarchy[] | undefined; + Label?: DimensionField[] | undefined; } /** - *

A visual displayed on a sheet in an analysis, dashboard, or template.

+ *

The field well configuration of a scatter plot.

*

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

* @public */ -export interface Visual { +export interface ScatterPlotFieldWells { /** - *

A table visual.

- *

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

+ *

The aggregated field wells of a scatter plot. The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both.

* @public */ - TableVisual?: TableVisual | undefined; + ScatterPlotCategoricallyAggregatedFieldWells?: ScatterPlotCategoricallyAggregatedFieldWells | undefined; /** - *

A pivot table.

- *

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

+ *

The unaggregated field wells of a scatter plot. The x and y-axes of these scatter plots are + * unaggregated.

* @public */ - PivotTableVisual?: PivotTableVisual | undefined; + ScatterPlotUnaggregatedFieldWells?: ScatterPlotUnaggregatedFieldWells | undefined; +} +/** + *

The sort configuration of a scatter plot.

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

A bar chart.

- *

For more information, see Using bar charts in the Amazon QuickSight User Guide.

+ *

The limit configuration of the visual display for an axis.

* @public */ - BarChartVisual?: BarChartVisual | undefined; + ScatterPlotLimitConfiguration?: ItemsLimitConfiguration | undefined; +} +/** + *

The configuration of a scatter plot.

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

A key performance indicator (KPI).

- *

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

+ *

The field wells of the visual.

* @public */ - KPIVisual?: KPIVisual | undefined; + FieldWells?: ScatterPlotFieldWells | undefined; /** - *

A pie or donut chart.

- *

For more information, see Using pie charts in the Amazon QuickSight User Guide.

+ *

The sort configuration of a scatter plot.

* @public */ - PieChartVisual?: PieChartVisual | undefined; + SortConfiguration?: ScatterPlotSortConfiguration | undefined; /** - *

A gauge chart.

- *

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

+ *

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.

* @public */ - GaugeChartVisual?: GaugeChartVisual | undefined; + XAxisLabelOptions?: ChartAxisLabelOptions | undefined; /** - *

A line chart.

- *

For more information, see Using line charts in the Amazon QuickSight User Guide.

+ *

The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.

* @public */ - LineChartVisual?: LineChartVisual | undefined; + XAxisDisplayOptions?: AxisDisplayOptions | undefined; /** - *

A heat map.

- *

For more information, see Using heat maps in the Amazon QuickSight User Guide.

+ *

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.

* @public */ - HeatMapVisual?: HeatMapVisual | undefined; + YAxisLabelOptions?: ChartAxisLabelOptions | undefined; /** - *

A tree map.

- *

For more information, see Using tree maps in the Amazon QuickSight User Guide.

+ *

The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.

* @public */ - TreeMapVisual?: TreeMapVisual | undefined; + YAxisDisplayOptions?: AxisDisplayOptions | undefined; /** - *

A geospatial map or a points on map visual.

- *

For more information, see Creating point maps in the Amazon QuickSight User Guide.

+ *

The legend display setup of the visual.

* @public */ - GeospatialMapVisual?: GeospatialMapVisual | undefined; + Legend?: LegendOptions | undefined; /** - *

A filled map.

- *

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

+ *

The options that determine if visual data labels are displayed.

* @public */ - FilledMapVisual?: FilledMapVisual | undefined; + DataLabels?: DataLabelOptions | undefined; /** - *

A funnel chart.

- *

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

+ *

The legend display setup of the visual.

* @public */ - FunnelChartVisual?: FunnelChartVisual | undefined; + Tooltip?: TooltipOptions | undefined; /** - *

A scatter plot.

- *

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

+ *

The palette (chart color) display setup of the visual.

* @public */ - ScatterPlotVisual?: ScatterPlotVisual | undefined; + VisualPalette?: VisualPalette | undefined; /** - *

A combo chart.

- *

For more information, see Using combo charts in the Amazon QuickSight User Guide.

+ *

The general visual interactions setup for a visual.

* @public */ - ComboChartVisual?: ComboChartVisual | undefined; + Interactions?: VisualInteractionOptions | undefined; +} +/** + *

A scatter plot.

+ *

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

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

A box plot.

- *

For more information, see Using box plots in the Amazon QuickSight User Guide.

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

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

A waterfall chart.

- *

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

+ *

The title that is displayed on the visual.

* @public */ - WaterfallVisual?: WaterfallVisual | undefined; + Title?: VisualTitleLabelOptions | undefined; /** - *

A histogram.

- *

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

+ *

The subtitle that is displayed on the visual.

* @public */ - HistogramVisual?: HistogramVisual | undefined; + Subtitle?: VisualSubtitleLabelOptions | undefined; /** - *

A word cloud.

- *

For more information, see Using word clouds in the Amazon QuickSight User Guide.

+ *

The configuration settings of the visual.

* @public */ - WordCloudVisual?: WordCloudVisual | undefined; + ChartConfiguration?: ScatterPlotConfiguration | undefined; /** - *

An insight visual.

- *

For more information, see Working with insights in the Amazon QuickSight User Guide.

+ *

The list of custom actions that are configured for a visual.

* @public */ - InsightVisual?: InsightVisual | undefined; + Actions?: VisualCustomAction[] | undefined; /** - *

A sankey diagram.

- *

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

+ *

The column hierarchy that is used during drill-downs and drill-ups.

* @public */ - SankeyDiagramVisual?: SankeyDiagramVisual | undefined; + ColumnHierarchies?: ColumnHierarchy[] | undefined; /** - *

A visual that contains custom content.

- *

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

+ *

The alt text for the visual.

* @public */ - CustomContentVisual?: CustomContentVisual | undefined; + VisualContentAltText?: string | undefined; +} +/** + *

The settings for the pinned columns of a table visual.

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

An empty visual.

+ *

A list of columns to be pinned to the left of a table visual.

* @public */ - EmptyVisual?: EmptyVisual | undefined; + PinnedLeftFields?: string[] | undefined; +} + +/** + * @public + * @enum + */ +export const TableCellImageScalingConfiguration = { + DO_NOT_SCALE: "DO_NOT_SCALE", + FIT_TO_CELL_HEIGHT: "FIT_TO_CELL_HEIGHT", + FIT_TO_CELL_WIDTH: "FIT_TO_CELL_WIDTH", +} as const; + +/** + * @public + */ +export type TableCellImageScalingConfiguration = + (typeof TableCellImageScalingConfiguration)[keyof typeof TableCellImageScalingConfiguration]; +/** + *

The sizing options for the table image configuration.

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

A radar chart visual.

- *

For more information, see Using radar charts in the Amazon QuickSight User Guide.

+ *

The cell scaling configuration of the sizing options for the table image configuration.

* @public */ - RadarChartVisual?: RadarChartVisual | undefined; + TableCellImageScalingConfiguration?: TableCellImageScalingConfiguration | undefined; } /** - *

A sheet is an object that contains a set of visuals that - * are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.

+ *

The image configuration of a table field URL.

* @public */ -export interface SheetDefinition { +export interface TableFieldImageConfiguration { /** - *

The unique identifier of a sheet.

+ *

The sizing options for the table image configuration.

* @public */ - SheetId: string | undefined; + SizingOptions?: TableCellImageSizingConfiguration | undefined; +} - /** - *

The title of the sheet.

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

The custom icon content for the table link content configuration.

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

A description of the sheet.

+ *

The icon set type (link) of the custom icon content for table URL link content.

* @public */ - Description?: string | undefined; + Icon?: TableFieldIconSetType | undefined; +} +/** + *

The custom text content (value, font configuration) for the table link content configuration.

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

The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight - * console.

+ *

The string value of the custom text content for the table URL link content.

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

The list of parameter controls that are on a sheet.

- *

For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.

+ *

The font configuration of the custom text content for the table URL link content.

* @public */ - ParameterControls?: ParameterControl[] | undefined; + FontConfiguration: FontConfiguration | undefined; +} +/** + *

The URL content (text, icon) for the table link configuration.

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

The list of filter controls that are on a sheet.

- *

For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.

+ *

The custom text content (value, font configuration) for the table link content configuration.

* @public */ - FilterControls?: FilterControl[] | undefined; + CustomTextContent?: TableFieldCustomTextContent | undefined; /** - *

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

+ *

The custom icon content for the table link content configuration.

* @public */ - Visuals?: Visual[] | undefined; + CustomIconContent?: TableFieldCustomIconContent | undefined; +} +/** + *

The link configuration of a table field URL.

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

The text boxes that are on a sheet.

+ *

The URL target (new tab, new window, same tab) for the table link configuration.

* @public */ - TextBoxes?: SheetTextBox[] | undefined; + Target: URLTargetConfiguration | undefined; /** - *

Layouts define how the components of a sheet are arranged.

- *

For more information, see Types of layout in the Amazon QuickSight User Guide.

+ *

The URL content (text, icon) for the table link configuration.

* @public */ - Layouts?: Layout[] | undefined; + Content: TableFieldLinkContentConfiguration | undefined; +} +/** + *

The URL configuration for a table field.

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

The control layouts of the sheet.

+ *

The link configuration of a table field URL.

* @public */ - SheetControlLayouts?: SheetControlLayout[] | undefined; + LinkConfiguration?: TableFieldLinkConfiguration | undefined; /** - *

The layout content type of the sheet. Choose one of the following options:

- *
    - *
  • - *

    - * PAGINATED: Creates a sheet for a paginated report.

    - *
  • - *
  • - *

    - * INTERACTIVE: Creates a sheet for an interactive dashboard.

    - *
  • - *
+ *

The image configuration of a table field URL.

* @public */ - ContentType?: SheetContentType | undefined; + ImageConfiguration?: TableFieldImageConfiguration | undefined; } /** - *

The definition of an analysis.

+ *

The options for a table field.

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

An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead - * of dataset ARNs throughout analysis sub-structures.

- * @public - */ - DataSetIdentifierDeclarations: DataSetIdentifierDeclaration[] | undefined; - +export interface TableFieldOption { /** - *

An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about - * a sheet within this analysis.

+ *

The field ID for a table field.

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

An array of calculated field definitions for the analysis.

+ *

The width for a table field.

* @public */ - CalculatedFields?: CalculatedField[] | undefined; + Width?: string | undefined; /** - *

An array of parameter declarations for an analysis.

- *

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 custom label for a table field.

* @public */ - ParameterDeclarations?: ParameterDeclaration[] | undefined; + CustomLabel?: string | undefined; /** - *

Filter definitions for an analysis.

- *

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

+ *

The visibility of a table field.

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

- * An array of analysis-level column configurations. Column configurations can be used to set default - * formatting for a column to be used throughout an analysis. - *

+ *

The URL configuration for a table field.

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

The field options of a table visual.

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

The configuration for default analysis settings.

+ *

The field options to be configured to a table.

* @public */ - AnalysisDefaults?: AnalysisDefaults | undefined; + SelectedFieldOptions?: TableFieldOption[] | undefined; /** - *

An array of option definitions for an analysis.

+ *

The order of the field IDs that are configured as field options for a table visual.

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

A structure that describes the query execution options.

+ *

The settings for the pinned columns of a table visual.

* @public */ - QueryExecutionOptions?: QueryExecutionOptions | undefined; + PinnedFieldOptions?: TablePinnedFieldOptions | undefined; } /** - * @public - * @enum - */ -export const AnalysisFilterAttribute = { - ANALYSIS_NAME: "ANALYSIS_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; - -/** - * @public - */ -export type AnalysisFilterAttribute = (typeof AnalysisFilterAttribute)[keyof typeof AnalysisFilterAttribute]; - -/** - * @public - * @enum - */ -export const FilterOperator = { - StringEquals: "StringEquals", - StringLike: "StringLike", -} as const; - -/** - * @public - */ -export type FilterOperator = (typeof FilterOperator)[keyof typeof FilterOperator]; - -/** - *

A filter that you apply when searching for one or more analyses.

+ *

The aggregated field well for the table.

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

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":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value ANALYSIS_NAME.

- * @public - */ - Operator?: FilterOperator | undefined; - +export interface TableAggregatedFieldWells { /** - *

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 analyses with that ARN listed as one of the analysis' 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 analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are considered.

    - *
  • - *
  • - *

    - * DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.

    - *
  • - *
  • - *

    - * DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses 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 analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered.

    - *
  • - *
  • - *

    - * ANALYSIS_NAME: Any analyses whose names have a substring match to this value will be returned.

    - *
  • - *
+ *

The group by field well for a pivot table. Values are grouped by group by fields.

* @public */ - Name?: AnalysisFilterAttribute | undefined; + GroupBy?: DimensionField[] | undefined; /** - *

The value of the named item, in this case QUICKSIGHT_USER, that you want - * to use as a filter, for example "Value". An example is - * "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

+ *

The values field well for a pivot table. Values are aggregated based on group by fields.

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

Dataset reference.

+ *

The unaggregated field well for the table.

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

Dataset placeholder.

- * @public - */ - DataSetPlaceholder: string | undefined; - +export interface TableUnaggregatedFieldWells { /** - *

Dataset Amazon Resource Name (ARN).

+ *

The values field well for a pivot table. Values are unaggregated for an unaggregated table.

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

The source template of an analysis.

+ *

The field wells for a table visual.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

* @public */ -export interface AnalysisSourceTemplate { +export interface TableFieldWells { /** - *

The dataset references of the source template of an analysis.

+ *

The aggregated field well for the table.

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

The Amazon Resource Name (ARN) of the source template of an analysis.

+ *

The unaggregated field well for the table.

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

The source entity of an analysis.

+ *

The paginated report options for a table visual.

* @public */ -export interface AnalysisSourceEntity { +export interface TablePaginatedReportOptions { /** - *

The source template for the source entity of the analysis.

+ *

The visibility of printing table overflow across pages.

* @public */ - SourceTemplate?: AnalysisSourceTemplate | undefined; + VerticalOverflowVisibility?: Visibility | undefined; + + /** + *

The visibility of repeating header rows on each page.

+ * @public + */ + OverflowColumnHeaderVisibility?: Visibility | undefined; } /** - *

The summary metadata that describes an analysis.

+ *

The sort configuration for a TableVisual.

* @public */ -export interface AnalysisSummary { +export interface TableSortConfiguration { /** - *

The Amazon Resource Name (ARN) for the analysis.

+ *

The field sort options for rows in the table.

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

The ID of the analysis. This ID displays in the URL.

+ *

The pagination configuration (page size, page number) for the table.

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

The options for data bars.

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

The name of the analysis. This name is displayed in the Amazon QuickSight console. - *

+ *

The field ID for the data bars options.

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

The last known status for the analysis.

+ *

The color of the positive data bar.

* @public */ - Status?: ResourceStatus | undefined; + PositiveColor?: string | undefined; /** - *

The time that the analysis was created.

+ *

The color of the negative data bar.

* @public */ - CreatedTime?: Date | undefined; + NegativeColor?: string | undefined; +} +/** + *

The inline visualization of a specific type to display within a chart.

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

The time that the analysis was last updated.

+ *

The configuration of the inline visualization of the data bars within a chart.

* @public */ - LastUpdatedTime?: Date | undefined; + DataBars?: DataBarsOptions | undefined; } /** * @public * @enum */ -export const AnchorType = { - TODAY: "TODAY", +export const TableOrientation = { + HORIZONTAL: "HORIZONTAL", + VERTICAL: "VERTICAL", } as const; /** * @public */ -export type AnchorType = (typeof AnchorType)[keyof typeof AnchorType]; +export type TableOrientation = (typeof TableOrientation)[keyof typeof TableOrientation]; /** - *

The definition of the Anchor.

+ *

The table options for a table visual.

* @public */ -export interface Anchor { +export interface TableOptions { /** - *

The AnchorType for the Anchor.

+ *

The orientation (vertical, horizontal) for a table.

* @public */ - AnchorType?: AnchorType | undefined; + Orientation?: TableOrientation | undefined; /** - *

The TimeGranularity of the Anchor.

+ *

The table cell style of a table header.

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

The offset of the Anchor.

+ *

The table cell style of table cells.

* @public */ - Offset?: number | undefined; -} - -/** - * @public - * @enum - */ -export const AnonymousUserDashboardEmbeddingConfigurationDisabledFeature = { - SHARED_VIEW: "SHARED_VIEW", -} as const; - -/** - * @public - */ -export type AnonymousUserDashboardEmbeddingConfigurationDisabledFeature = - (typeof AnonymousUserDashboardEmbeddingConfigurationDisabledFeature)[keyof typeof AnonymousUserDashboardEmbeddingConfigurationDisabledFeature]; - -/** - * @public - * @enum - */ -export const AnonymousUserDashboardEmbeddingConfigurationEnabledFeature = { - SHARED_VIEW: "SHARED_VIEW", -} as const; - -/** - * @public - */ -export type AnonymousUserDashboardEmbeddingConfigurationEnabledFeature = - (typeof AnonymousUserDashboardEmbeddingConfigurationEnabledFeature)[keyof typeof AnonymousUserDashboardEmbeddingConfigurationEnabledFeature]; + CellStyle?: TableCellStyle | undefined; -/** - *

The shared view settings of an embedded dashboard.

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

The shared view settings of an embedded dashboard.

+ *

The row alternate color options (widget status, row alternate colors) for a table.

* @public */ - Enabled: boolean | undefined; + RowAlternateColorOptions?: RowAlternateColorOptions | undefined; } /** - *

The feature configuration for an embedded dashboard.

+ *

The total options for a table visual.

* @public */ -export interface AnonymousUserDashboardFeatureConfigurations { +export interface TotalOptions { /** - *

The shared view settings of an embedded dashboard.

+ *

The visibility configuration for the total cells.

* @public */ - SharedView?: SharedViewConfigurations | undefined; -} + TotalsVisibility?: Visibility | undefined; -/** - *

Information about the dashboard that you want to embed.

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

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard.

- *

The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

+ *

The placement (start, end) for the total cells.

* @public */ - InitialDashboardId: string | undefined; + Placement?: TableTotalsPlacement | undefined; /** - *

A list of all enabled features of a specified anonymous dashboard.

+ *

The scroll status (pinned, scrolled) for the total cells.

* @public */ - EnabledFeatures?: AnonymousUserDashboardEmbeddingConfigurationEnabledFeature[] | undefined; + ScrollStatus?: TableTotalsScrollStatus | undefined; /** - *

A list of all disabled features of a specified anonymous dashboard.

+ *

The custom label string for the total cells.

* @public */ - DisabledFeatures?: AnonymousUserDashboardEmbeddingConfigurationDisabledFeature[] | undefined; + CustomLabel?: string | undefined; /** - *

The feature configuration for an embedded dashboard.

+ *

Cell styling options for the total cells.

* @public */ - FeatureConfigurations?: AnonymousUserDashboardFeatureConfigurations | undefined; + TotalCellStyle?: TableCellStyle | undefined; + + /** + *

The total aggregation settings for each value field.

+ * @public + */ + TotalAggregationOptions?: TotalAggregationOption[] | undefined; } /** - *

A structure that contains the following elements:

- *
    - *
  • - *

    The DashboardId of the dashboard that has the visual that you want to embed.

    - *
  • - *
  • - *

    The SheetId of the sheet that has the visual that you want to embed.

    - *
  • - *
  • - *

    The VisualId of the visual that you want to embed.

    - *
  • - *
- *

The DashboardId, SheetId, and VisualId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

+ *

The configuration for a TableVisual.

* @public */ -export interface DashboardVisualId { +export interface TableConfiguration { /** - *

The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

+ *

The field wells of the visual.

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

The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

+ *

The sort configuration for a TableVisual.

* @public */ - SheetId: string | undefined; + SortConfiguration?: TableSortConfiguration | undefined; /** - *

The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

+ *

The table options for a table visual.

* @public */ - VisualId: string | undefined; -} + TableOptions?: TableOptions | undefined; -/** - *

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

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

The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

- *

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

+ *

The total options for a table visual.

* @public */ - InitialDashboardVisualId: DashboardVisualId | undefined; -} + TotalOptions?: TotalOptions | undefined; -/** - *

The settings that you want to use for the Generative Q&A experience.

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

The Amazon QuickSight Q topic ID of the new reader experience topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Generative Q&A experience with this new reader experience topic pre selected.

- *

The Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

+ *

The field options for a table visual.

* @public */ - InitialTopicId: string | undefined; -} + FieldOptions?: TableFieldOptions | undefined; -/** - *

The settings that you want to use with the Q search bar.

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

The Amazon QuickSight Q topic ID of the legacy topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this legacy topic pre-selected.

- *

The Amazon Resource Name (ARN) of this Q legacy topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

+ *

The paginated report options for a table visual.

* @public */ - InitialTopicId: string | undefined; -} + PaginatedReportOptions?: TablePaginatedReportOptions | undefined; -/** - *

The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.

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

The type of embedding experience. In this case, Amazon QuickSight dashboards.

+ *

A collection of inline visualizations to display within a chart.

* @public */ - Dashboard?: AnonymousUserDashboardEmbeddingConfiguration | undefined; + TableInlineVisualizations?: TableInlineVisualization[] | undefined; /** - *

The type of embedding experience. In this case, Amazon QuickSight visuals.

+ *

The general visual interactions setup for a visual.

* @public */ - DashboardVisual?: AnonymousUserDashboardVisualEmbeddingConfiguration | undefined; + Interactions?: VisualInteractionOptions | undefined; +} +/** + *

The cell conditional formatting option for a table.

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

The Q search bar that you want to use for anonymous user embedding.

+ *

The field ID of the cell for conditional formatting.

* @public */ - QSearchBar?: AnonymousUserQSearchBarEmbeddingConfiguration | undefined; + FieldId: string | undefined; /** - *

The Generative Q&A experience that you want to use for anonymous user embedding.

+ *

The text format of the cell for conditional formatting.

* @public */ - GenerativeQnA?: AnonymousUserGenerativeQnAEmbeddingConfiguration | undefined; + TextFormat?: TextConditionalFormat | undefined; } /** - * @public - * @enum - */ -export const SnapshotFileFormatType = { - CSV: "CSV", - EXCEL: "EXCEL", - PDF: "PDF", -} as const; - -/** - * @public - */ -export type SnapshotFileFormatType = (typeof SnapshotFileFormatType)[keyof typeof SnapshotFileFormatType]; - -/** - * @public - * @enum - */ -export const SnapshotFileSheetSelectionScope = { - ALL_VISUALS: "ALL_VISUALS", - SELECTED_VISUALS: "SELECTED_VISUALS", -} as const; - -/** - * @public - */ -export type SnapshotFileSheetSelectionScope = - (typeof SnapshotFileSheetSelectionScope)[keyof typeof SnapshotFileSheetSelectionScope]; - -/** - *

A structure that contains information that identifies the snapshot that needs to be generated.

+ *

The conditional formatting of a table row.

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

The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.

- * @public - */ - SheetId: string | undefined; - +export interface TableRowConditionalFormatting { /** - *

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

- *
    - *
  • - *

    - * ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.

    - *
  • - *
  • - *

    - * SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.

    - *
  • - *
+ *

The conditional formatting color (solid, gradient) of the background for a table row.

* @public */ - SelectionScope: SnapshotFileSheetSelectionScope | undefined; + BackgroundColor?: ConditionalFormattingColor | undefined; /** - *

- * A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file. - *

+ *

The conditional formatting color (solid, gradient) of the text for a table row.

* @public */ - VisualIds?: string[] | undefined; + TextColor?: ConditionalFormattingColor | undefined; } /** - *

A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.

+ *

Conditional formatting options for a PivotTableVisual.

* @public */ -export interface SnapshotFile { +export interface TableConditionalFormattingOption { /** - *

A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.

+ *

The cell conditional formatting option for a table.

* @public */ - SheetSelections: SnapshotFileSheetSelection[] | undefined; + Cell?: TableCellConditionalFormatting | undefined; /** - *

The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.

+ *

The row conditional formatting option for a table.

* @public */ - FormatType: SnapshotFileFormatType | undefined; + Row?: TableRowConditionalFormatting | undefined; } /** - *

Information on the error that caused the snapshot job to fail.

+ *

The conditional formatting for a PivotTableVisual.

* @public */ -export interface SnapshotJobResultErrorInfo { +export interface TableConditionalFormatting { /** - *

The error message.

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

The error type.

+ *

Conditional formatting options for a PivotTableVisual.

* @public */ - ErrorType?: string | undefined; + ConditionalFormattingOptions?: TableConditionalFormattingOption[] | undefined; } /** - *

An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default Amazon QuickSight bucket.

+ *

A table visual.

+ *

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

* @public */ -export interface S3BucketConfiguration { +export interface TableVisual { /** - *

The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

* @public */ - BucketName: string | undefined; + VisualId: string | undefined; /** - *

The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

+ *

The title that is displayed on the visual.

* @public */ - BucketPrefix: string | undefined; + Title?: VisualTitleLabelOptions | undefined; /** - *

The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

+ *

The subtitle that is displayed on the visual.

* @public */ - BucketRegion: string | undefined; -} + Subtitle?: VisualSubtitleLabelOptions | undefined; -/** - *

A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot.

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

A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.

+ *

The configuration settings of the visual.

* @public */ - BucketConfiguration: S3BucketConfiguration | undefined; -} + ChartConfiguration?: TableConfiguration | undefined; -/** - *

The Amazon S3 result from the snapshot job. The result includes the DestinationConfiguration and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error.

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

A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call. - *

+ *

The conditional formatting for a PivotTableVisual.

* @public */ - S3DestinationConfiguration?: SnapshotS3DestinationConfiguration | undefined; + ConditionalFormatting?: TableConditionalFormatting | undefined; /** - *

The Amazon S3 Uri.

+ *

The list of custom actions that are configured for a visual.

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

An array of error records that describe any failures that occur while the dashboard snapshot job runs.

+ *

The alt text for the visual.

* @public */ - ErrorInfo?: SnapshotJobResultErrorInfo[] | undefined; + VisualContentAltText?: string | undefined; } /** - *

A structure that contains information on the generated snapshot file groups.

+ *

Aggregated field wells of a tree map.

* @public */ -export interface SnapshotJobResultFileGroup { +export interface TreeMapAggregatedFieldWells { /** - *

A list of SnapshotFile objects.

+ *

The group by field well of a tree map. Values are grouped based on group by fields.

* @public */ - Files?: SnapshotFile[] | undefined; + Groups?: DimensionField[] | undefined; /** - *

A list of SnapshotJobS3Result objects.

+ *

The size field well of a tree map. Values are aggregated based on group by fields.

* @public */ - S3Results?: SnapshotJobS3Result[] | undefined; + Sizes?: MeasureField[] | undefined; + + /** + *

The color field well of a tree map. Values are grouped by aggregations based on group by fields.

+ * @public + */ + Colors?: MeasureField[] | undefined; } /** - *

A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call. - *

+ *

The field wells of a tree map.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

* @public */ -export interface AnonymousUserSnapshotJobResult { +export interface TreeMapFieldWells { /** - *

A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.

+ *

The aggregated field wells of a tree map.

* @public */ - FileGroups?: SnapshotJobResultFileGroup[] | undefined; + TreeMapAggregatedFieldWells?: TreeMapAggregatedFieldWells | undefined; } /** - *

The color palette.

+ *

The sort configuration of a tree map.

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

The foreground color.

+ *

The sort configuration of group by fields.

* @public */ - Foreground?: string | undefined; + TreeMapSort?: FieldSortOptions[] | undefined; /** - *

The background color.

+ *

The limit on the number of groups that are displayed.

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

The color palette.

+ *

The configuration of a tree map.

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

The primary color.

+ *

The field wells of the visual.

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

The secondary color.

+ *

The sort configuration of a tree map.

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

The color that is used for accent elements.

+ *

The label options (label text, label visibility) of the groups that are displayed in a tree map.

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

The color that is used for measure elements.

+ *

The label options (label text, label visibility) of the sizes that are displayed in a tree map.

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

The color that is used for dimension elements.

+ *

The label options (label text, label visibility) for the colors displayed in a tree map.

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

The color that is used for success elements.

+ *

The color options (gradient color, point of divergence) of a tree map.

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

The color that is used for info elements.

+ *

The legend display setup of the visual.

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

The color that is used for warning elements.

+ *

The options that determine if visual data labels are displayed.

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

The color that is used for danger elements.

+ *

The tooltip display setup of the visual.

* @public */ - Danger?: Palette | undefined; + Tooltip?: TooltipOptions | undefined; + + /** + *

The general visual interactions setup for a visual.

+ * @public + */ + Interactions?: VisualInteractionOptions | undefined; } /** - *

The navigation bar style.

+ *

A tree map.

+ *

For more information, see Using tree maps in the Amazon QuickSight User Guide.

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

The global navigation bar style.

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

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

The contextual navigation bar style.

+ *

The title that is displayed on the visual.

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

The element style.

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

The navigation bar style.

+ *

The subtitle that is displayed on the visual.

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

The application theme.

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

The color palette.

+ *

The configuration settings of the visual.

* @public */ - BrandColorPalette?: BrandColorPalette | undefined; + ChartConfiguration?: TreeMapConfiguration | undefined; /** - *

The element style.

+ *

The list of custom actions that are configured for a visual.

* @public */ - BrandElementStyle?: BrandElementStyle | undefined; -} - -/** - * @public - * @enum - */ -export const AssetBundleExportJobAnalysisPropertyToOverride = { - NAME: "Name", -} as const; - -/** - * @public - */ -export type AssetBundleExportJobAnalysisPropertyToOverride = - (typeof AssetBundleExportJobAnalysisPropertyToOverride)[keyof typeof AssetBundleExportJobAnalysisPropertyToOverride]; + Actions?: VisualCustomAction[] | undefined; -/** - *

Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.

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

The ARN of the specific Analysis resource whose override properties are configured in this structure.

+ *

The column hierarchy that is used during drill-downs and drill-ups.

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

A list of Analysis resource properties to generate variables for in the returned CloudFormation template.

+ *

The alt text for the visual.

* @public */ - Properties: AssetBundleExportJobAnalysisPropertyToOverride[] | undefined; + VisualContentAltText?: string | undefined; } /** - * @public - * @enum - */ -export const AssetBundleExportJobDashboardPropertyToOverride = { - NAME: "Name", -} as const; - -/** + *

The color configuration for individual groups within a waterfall visual.

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

Defines the color for the positive bars of a waterfall chart.

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

Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.

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

The ARN of the specific Dashboard resource whose override properties are configured in this structure.

+ *

Defines the color for the negative bars of a waterfall chart.

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

A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.

+ *

Defines the color for the total bars of a waterfall chart.

* @public */ - Properties: AssetBundleExportJobDashboardPropertyToOverride[] | undefined; + TotalBarColor?: string | undefined; } /** + *

The color configuration of a waterfall visual.

* @public - * @enum */ -export const AssetBundleExportJobDataSetPropertyToOverride = { - NAME: "Name", -} as const; +export interface WaterfallChartColorConfiguration { + /** + *

The color configuration for individual groups within a waterfall visual.

+ * @public + */ + GroupColorConfiguration?: WaterfallChartGroupColorConfiguration | undefined; +} /** + *

The field well configuration of a waterfall visual.

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

The category field wells of a waterfall visual.

+ * @public + */ + Categories?: DimensionField[] | undefined; -/** - *

Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.

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

The ARN of the specific DataSet resource whose override properties are configured in this structure.

+ *

The value field wells of a waterfall visual.

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

A list of DataSet resource properties to generate variables for in the returned CloudFormation template.

+ *

The breakdown field wells of a waterfall visual.

* @public */ - Properties: AssetBundleExportJobDataSetPropertyToOverride[] | undefined; + Breakdowns?: DimensionField[] | undefined; } /** - * @public - * @enum - */ -export const AssetBundleExportJobDataSourcePropertyToOverride = { - CATALOG: "Catalog", - CLUSTER_ID: "ClusterId", - DATABASE: "Database", - DATA_SET_NAME: "DataSetName", - DISABLE_SSL: "DisableSsl", - DOMAIN: "Domain", - HOST: "Host", - INSTANCE_ID: "InstanceId", - MANIFEST_FILE_LOCATION: "ManifestFileLocation", - NAME: "Name", - PASSWORD: "Password", - PORT: "Port", - PRODUCT_TYPE: "ProductType", - ROLE_ARN: "RoleArn", - SECRET_ARN: "SecretArn", - USERNAME: "Username", - WAREHOUSE: "Warehouse", - WORK_GROUP: "WorkGroup", -} as const; - -/** + *

The field well configuration of a waterfall visual.

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

The field well configuration of a waterfall visual.

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

Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.

+ *

The sort configuration of a waterfall visual.

* @public */ -export interface AssetBundleExportJobDataSourceOverrideProperties { +export interface WaterfallChartSortConfiguration { /** - *

The ARN of the specific DataSource resource whose override properties are configured in this structure.

+ *

The sort configuration of the category fields.

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

A list of DataSource resource properties to generate variables for in the returned CloudFormation template.

+ *

The limit on the number of bar groups that are displayed.

* @public */ - Properties: AssetBundleExportJobDataSourcePropertyToOverride[] | undefined; + BreakdownItemsLimit?: ItemsLimitConfiguration | undefined; } /** + *

The options that determine the presentation of a waterfall visual.

* @public - * @enum */ -export const AssetBundleExportJobFolderPropertyToOverride = { - NAME: "Name", - PARENT_FOLDER_ARN: "ParentFolderArn", -} as const; +export interface WaterfallChartOptions { + /** + *

This option determines the total bar label of a waterfall visual.

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

The configuration for a waterfall visual.

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

The field well configuration of a waterfall visual.

+ * @public + */ + FieldWells?: WaterfallChartFieldWells | undefined; -/** - *

Controls how a specific Folder resource is parameterized in the returned CloudFormation template.

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

The ARN of the specific Folder resource whose override properties are configured in this structure.

+ *

The sort configuration of a waterfall visual.

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

A list of Folder resource properties to generate variables for in the returned CloudFormation template.

+ *

The options that determine the presentation of a waterfall visual.

* @public */ - Properties: AssetBundleExportJobFolderPropertyToOverride[] | undefined; -} + WaterfallChartOptions?: WaterfallChartOptions | undefined; -/** - * @public - * @enum - */ -export const AssetBundleExportJobRefreshSchedulePropertyToOverride = { - START_AFTER_DATE_TIME: "StartAfterDateTime", -} as const; + /** + *

The options that determine the presentation of the category axis label.

+ * @public + */ + CategoryAxisLabelOptions?: ChartAxisLabelOptions | undefined; -/** - * @public - */ -export type AssetBundleExportJobRefreshSchedulePropertyToOverride = - (typeof AssetBundleExportJobRefreshSchedulePropertyToOverride)[keyof typeof AssetBundleExportJobRefreshSchedulePropertyToOverride]; + /** + *

The options that determine the presentation of the category axis.

+ * @public + */ + CategoryAxisDisplayOptions?: AxisDisplayOptions | undefined; -/** - *

Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.

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

The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.

+ *

The options that determine the presentation of the y-axis label.

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

A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation template.

+ *

The options that determine the presentation of the y-axis.

* @public */ - Properties: AssetBundleExportJobRefreshSchedulePropertyToOverride[] | undefined; -} + PrimaryYAxisDisplayOptions?: AxisDisplayOptions | undefined; -/** - *

An optional structure that configures resource ID overrides for the export job.

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

An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

+ *

The legend configuration of a waterfall visual.

* @public */ - PrefixForAllResources?: boolean | undefined; -} + Legend?: LegendOptions | undefined; -/** - * @public - * @enum - */ -export const AssetBundleExportJobThemePropertyToOverride = { - NAME: "Name", -} as const; + /** + *

The data label configuration of a waterfall visual.

+ * @public + */ + DataLabels?: DataLabelOptions | undefined; -/** - * @public - */ -export type AssetBundleExportJobThemePropertyToOverride = - (typeof AssetBundleExportJobThemePropertyToOverride)[keyof typeof AssetBundleExportJobThemePropertyToOverride]; + /** + *

The visual palette configuration of a waterfall visual.

+ * @public + */ + VisualPalette?: VisualPalette | undefined; -/** - *

Controls how a specific Theme resource is parameterized in the returned CloudFormation template.

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

The ARN of the specific Theme resource whose override properties are configured in this structure.

+ *

The color configuration of a waterfall visual.

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

A list of Theme resource properties to generate variables for in the returned CloudFormation template.

+ *

The general visual interactions setup for a visual.

* @public */ - Properties: AssetBundleExportJobThemePropertyToOverride[] | undefined; + Interactions?: VisualInteractionOptions | undefined; } /** - * @public - * @enum - */ -export const AssetBundleExportJobVPCConnectionPropertyToOverride = { - DNS_RESOLVERS: "DnsResolvers", - NAME: "Name", - ROLE_ARN: "RoleArn", -} as const; - -/** + *

A waterfall chart.

+ *

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

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

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

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

Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.

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

The ARN of the specific VPCConnection resource whose override properties are configured in this structure.

+ *

The title that is displayed on the visual.

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

A list of VPCConnection resource properties to generate variables for in the returned CloudFormation template.

+ *

The subtitle that is displayed on the visual.

* @public */ - Properties: AssetBundleExportJobVPCConnectionPropertyToOverride[] | undefined; -} + Subtitle?: VisualSubtitleLabelOptions | undefined; -/** - *

An optional collection of CloudFormation property configurations that control how the export job is generated.

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

An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.

+ *

The configuration for a waterfall visual.

* @public */ - ResourceIdOverrideConfiguration?: AssetBundleExportJobResourceIdOverrideConfiguration | undefined; + ChartConfiguration?: WaterfallChartConfiguration | undefined; /** - *

An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.

+ *

The list of custom actions that are configured for a visual.

* @public */ - VPCConnections?: AssetBundleExportJobVPCConnectionOverrideProperties[] | undefined; + Actions?: VisualCustomAction[] | undefined; /** - *

An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.

+ *

The column hierarchy that is used during drill-downs and drill-ups.

* @public */ - RefreshSchedules?: AssetBundleExportJobRefreshScheduleOverrideProperties[] | undefined; + ColumnHierarchies?: ColumnHierarchy[] | undefined; /** - *

An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.

+ *

The alt text for the visual.

* @public */ - DataSources?: AssetBundleExportJobDataSourceOverrideProperties[] | undefined; + VisualContentAltText?: string | undefined; +} +/** + *

The aggregated field wells of a word cloud.

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

An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.

+ *

The group by field well of a word cloud. Values are grouped by group by fields.

* @public */ - DataSets?: AssetBundleExportJobDataSetOverrideProperties[] | undefined; + GroupBy?: DimensionField[] | undefined; /** - *

An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.

+ *

The size field well of a word cloud. Values are aggregated based on group by fields.

* @public */ - Themes?: AssetBundleExportJobThemeOverrideProperties[] | undefined; + Size?: MeasureField[] | undefined; +} +/** + *

The field wells of a word cloud visual.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.

+ *

The aggregated field wells of a word cloud.

* @public */ - Analyses?: AssetBundleExportJobAnalysisOverrideProperties[] | undefined; + WordCloudAggregatedFieldWells?: WordCloudAggregatedFieldWells | undefined; +} +/** + *

The sort configuration of a word cloud visual.

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

An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.

+ *

The limit on the number of groups that are displayed in a word cloud.

* @public */ - Dashboards?: AssetBundleExportJobDashboardOverrideProperties[] | undefined; + CategoryItemsLimit?: ItemsLimitConfiguration | undefined; /** - *

An optional list of structures that controls how Folder resources are parameterized in the returned CloudFormation template.

+ *

The sort configuration of group by fields.

* @public */ - Folders?: AssetBundleExportJobFolderOverrideProperties[] | undefined; + CategorySort?: FieldSortOptions[] | undefined; } /** * @public * @enum */ -export const AssetBundleExportFormat = { - CLOUDFORMATION_JSON: "CLOUDFORMATION_JSON", - QUICKSIGHT_JSON: "QUICKSIGHT_JSON", +export const WordCloudCloudLayout = { + FLUID: "FLUID", + NORMAL: "NORMAL", } as const; /** * @public */ -export type AssetBundleExportFormat = (typeof AssetBundleExportFormat)[keyof typeof AssetBundleExportFormat]; +export type WordCloudCloudLayout = (typeof WordCloudCloudLayout)[keyof typeof WordCloudCloudLayout]; /** - *

Describes an error that occurred during an Asset Bundle export job.

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

The ARN of the resource whose processing caused an error.

- * @public - */ - Arn?: string | undefined; +export const WordCloudWordCasing = { + EXISTING_CASE: "EXISTING_CASE", + LOWER_CASE: "LOWER_CASE", +} as const; - /** - *

The specific error type of the error that occurred.

- * @public - */ - Type?: string | undefined; +/** + * @public + */ +export type WordCloudWordCasing = (typeof WordCloudWordCasing)[keyof typeof WordCloudWordCasing]; - /** - *

A description of the error.

- * @public - */ - Message?: string | undefined; -} +/** + * @public + * @enum + */ +export const WordCloudWordOrientation = { + HORIZONTAL: "HORIZONTAL", + HORIZONTAL_AND_VERTICAL: "HORIZONTAL_AND_VERTICAL", +} as const; + +/** + * @public + */ +export type WordCloudWordOrientation = (typeof WordCloudWordOrientation)[keyof typeof WordCloudWordOrientation]; /** * @public * @enum */ -export const AssetBundleExportJobStatus = { - FAILED: "FAILED", - IN_PROGRESS: "IN_PROGRESS", - QUEUED_FOR_IMMEDIATE_EXECUTION: "QUEUED_FOR_IMMEDIATE_EXECUTION", - SUCCESSFUL: "SUCCESSFUL", +export const WordCloudWordPadding = { + LARGE: "LARGE", + MEDIUM: "MEDIUM", + NONE: "NONE", + SMALL: "SMALL", } as const; /** * @public */ -export type AssetBundleExportJobStatus = (typeof AssetBundleExportJobStatus)[keyof typeof AssetBundleExportJobStatus]; +export type WordCloudWordPadding = (typeof WordCloudWordPadding)[keyof typeof WordCloudWordPadding]; /** - *

A summary of the export job that includes details of the job's configuration and its current status.

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

The current status of the export job.

- * @public - */ - JobStatus?: AssetBundleExportJobStatus | undefined; +export const WordCloudWordScaling = { + EMPHASIZE: "EMPHASIZE", + NORMAL: "NORMAL", +} as const; - /** - *

The ARN of the export job.

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

The word cloud options for a word cloud visual.

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

The time that the export job was created.

+ *

The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

* @public */ - CreatedTime?: Date | undefined; + WordOrientation?: WordCloudWordOrientation | undefined; /** - *

The ID of the export job.

+ *

The word scaling options (emphasize, normal) for the words in a word cloud.

* @public */ - AssetBundleExportJobId?: string | undefined; + WordScaling?: WordCloudWordScaling | undefined; /** - *

The flag that determines the inclusion of resource dependencies in the returned asset bundle.

+ *

The cloud layout options (fluid, normal) of a word cloud.

* @public */ - IncludeAllDependencies?: boolean | undefined; + CloudLayout?: WordCloudCloudLayout | undefined; /** - *

The format for the export job.

+ *

The word casing options (lower_case, existing_case) for the words in a word cloud.

* @public */ - ExportFormat?: AssetBundleExportFormat | undefined; + WordCasing?: WordCloudWordCasing | undefined; /** - *

The flag that determines the inclusion of permissions associated with each resource ARN.

+ *

The word padding options (none, small, medium, large) for the words in a word cloud.

* @public */ - IncludePermissions?: boolean | undefined; + WordPadding?: WordCloudWordPadding | undefined; /** - *

The flag that determines the inclusion of tags associated with each resource ARN.

+ *

The length limit of each word from 1-100.

* @public */ - IncludeTags?: boolean | undefined; + MaximumStringLength?: number | undefined; } /** - *

The option to relax the validation that is required to export each asset. When StrictModeForAllResource is set to false, validation is skipped for specific UI errors.

+ *

The configuration of a word cloud visual.

* @public */ -export interface AssetBundleExportJobValidationStrategy { +export interface WordCloudChartConfiguration { /** - *

A Boolean value that indicates whether to export resources under strict or lenient mode.

+ *

The field wells of the visual.

* @public */ - StrictModeForAllResources?: boolean | undefined; -} + FieldWells?: WordCloudFieldWells | undefined; -/** - *

Describes a warning that occurred during an Asset Bundle export job.

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

The ARN of the resource whose processing caused a warning.

+ *

The sort configuration of a word cloud visual.

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

A description of the warning.

+ *

The label options (label text, label visibility, and sort icon visibility) for the word cloud category.

* @public */ - Message?: string | undefined; -} + CategoryLabelOptions?: ChartAxisLabelOptions | undefined; -/** - * @public - * @enum - */ -export const AssetBundleImportFailureAction = { - DO_NOTHING: "DO_NOTHING", - ROLLBACK: "ROLLBACK", -} as const; - -/** - * @public - */ -export type AssetBundleImportFailureAction = - (typeof AssetBundleImportFailureAction)[keyof typeof AssetBundleImportFailureAction]; - -/** - *

The override parameters for a single analysis that is being imported.

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

The ID of the analysis that you ant to apply overrides to.

+ *

The options for a word cloud visual.

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

A new name for the analysis.

+ *

The general visual interactions setup for a visual.

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

A structure that contains the permissions for the resource that you want to override in an asset bundle import job.

+ *

A word cloud.

+ *

For more information, see Using word clouds in the Amazon QuickSight User Guide.

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

A list of principals to grant permissions on.

- * @public - */ - Principals: string[] | undefined; - +export interface WordCloudVisual { /** - *

A list of IAM actions to grant permissions on.

+ *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

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

An object that contains a list of permissions to be applied to a list of analysis IDs.

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

A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.

+ *

The title that is displayed on the visual.

* @public */ - AnalysisIds: string[] | undefined; + Title?: VisualTitleLabelOptions | undefined; /** - *

A list of permissions for the analyses that you want to apply overrides to.

+ *

The subtitle that is displayed on the visual.

* @public */ - Permissions: AssetBundleResourcePermissions | undefined; -} + Subtitle?: VisualSubtitleLabelOptions | undefined; -/** - *

The key or keys of the key-value pairs for the resource tag or tags assigned to the - * resource.

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

Tag key.

+ *

The configuration settings of the visual.

* @public */ - Key: string | undefined; + ChartConfiguration?: WordCloudChartConfiguration | undefined; /** - *

Tag value.

+ *

The list of custom actions that are configured for a visual.

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

An object that contains a list of tags to be assigned to a list of analysis IDs.

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

A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.

+ *

The column hierarchy that is used during drill-downs and drill-ups.

* @public */ - AnalysisIds: string[] | undefined; + ColumnHierarchies?: ColumnHierarchy[] | undefined; /** - *

A list of tags for the analyses that you want to apply overrides to.

+ *

The alt text for the visual.

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

The override parameters for a single dashboard that is being imported.

+ *

A visual displayed on a sheet in an analysis, dashboard, or template.

+ *

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

* @public */ -export interface AssetBundleImportJobDashboardOverrideParameters { +export interface Visual { /** - *

The ID of the dashboard that you want to apply overrides to.

+ *

A table visual.

+ *

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

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

A new name for the dashboard.

+ *

A pivot table.

+ *

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

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

A structure that contains the configuration of a shared link to an Amazon QuickSight dashboard.

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

A list of link sharing permissions for the dashboards that you want to apply overrides to.

+ *

A bar chart.

+ *

For more information, see Using bar charts in the Amazon QuickSight User Guide.

* @public */ - Permissions?: AssetBundleResourcePermissions | undefined; -} + BarChartVisual?: BarChartVisual | undefined; -/** - *

An object that contains a list of permissions to be applied to a list of dashboard IDs.

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

A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.

+ *

A key performance indicator (KPI).

+ *

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

* @public */ - DashboardIds: string[] | undefined; + KPIVisual?: KPIVisual | undefined; /** - *

A list of permissions for the dashboards that you want to apply overrides to.

+ *

A pie or donut chart.

+ *

For more information, see Using pie charts in the Amazon QuickSight User Guide.

* @public */ - Permissions?: AssetBundleResourcePermissions | undefined; + PieChartVisual?: PieChartVisual | undefined; /** - *

A structure that contains the link sharing configurations that you want to apply overrides to.

+ *

A gauge chart.

+ *

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

* @public */ - LinkSharingConfiguration?: AssetBundleResourceLinkSharingConfiguration | undefined; -} + GaugeChartVisual?: GaugeChartVisual | undefined; -/** - *

An object that contains a list of tags to be assigned to a list of dashboard IDs.

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

A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.

+ *

A line chart.

+ *

For more information, see Using line charts in the Amazon QuickSight User Guide.

* @public */ - DashboardIds: string[] | undefined; + LineChartVisual?: LineChartVisual | undefined; /** - *

A list of tags for the dashboards that you want to apply overrides to.

+ *

A heat map.

+ *

For more information, see Using heat maps in the Amazon QuickSight User Guide.

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

The override parameters for a single dataset that is being imported.

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

The ID of the dataset to apply overrides to.

+ *

A tree map.

+ *

For more information, see Using tree maps in the Amazon QuickSight User Guide.

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

A new name for the dataset.

+ *

A geospatial map or a points on map visual.

+ *

For more information, see Creating point maps in the Amazon QuickSight User Guide.

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

An object that contains a list of permissions to be applied to a list of dataset IDs.

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

A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.

+ *

A filled map.

+ *

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

* @public */ - DataSetIds: string[] | undefined; + FilledMapVisual?: FilledMapVisual | undefined; /** - *

A list of permissions for the datasets that you want to apply overrides to.

+ *

The properties for a layer map visual

* @public */ - Permissions: AssetBundleResourcePermissions | undefined; -} + LayerMapVisual?: LayerMapVisual | undefined; -/** - *

An object that contains a list of tags to be assigned to a list of dataset IDs.

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

A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.

+ *

A funnel chart.

+ *

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

* @public */ - DataSetIds: string[] | undefined; + FunnelChartVisual?: FunnelChartVisual | undefined; /** - *

A list of tags for the datasets that you want to apply overrides to.

+ *

A scatter plot.

+ *

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

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

A username and password credential pair to use to import a data source resource.

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

The username for the data source connection.

+ *

A combo chart.

+ *

For more information, see Using combo charts in the Amazon QuickSight User Guide.

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

The password for the data source connection.

+ *

A box plot.

+ *

For more information, see Using box plots in the Amazon QuickSight User Guide.

* @public */ - Password: string | undefined; -} + BoxPlotVisual?: BoxPlotVisual | undefined; -/** - *

The login credentials to use to import a data source resource.

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

A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.

+ *

A waterfall chart.

+ *

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

* @public */ - CredentialPair?: AssetBundleImportJobDataSourceCredentialPair | undefined; + WaterfallVisual?: WaterfallVisual | undefined; /** - *

The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.

+ *

A histogram.

+ *

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

* @public */ - SecretArn?: string | undefined; -} + HistogramVisual?: HistogramVisual | undefined; -/** - *

Parameters for Amazon Athena.

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

The workgroup that Amazon Athena uses.

+ *

A word cloud.

+ *

For more information, see Using word clouds in the Amazon QuickSight User Guide.

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

Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

+ *

An insight visual.

+ *

For more information, see Working with insights in the Amazon QuickSight User Guide.

* @public */ - RoleArn?: string | undefined; -} + InsightVisual?: InsightVisual | undefined; -/** - *

Parameters for Amazon Aurora.

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

Host.

+ *

A sankey diagram.

+ *

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

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

Port.

+ *

A visual that contains custom content.

+ *

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

* @public */ - Port: number | undefined; + CustomContentVisual?: CustomContentVisual | undefined; /** - *

Database.

- * @public - */ - Database: string | undefined; -} - -/** - *

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

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

The Amazon Aurora PostgreSQL-Compatible host to connect to.

+ *

An empty visual.

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

The port that Amazon Aurora PostgreSQL is listening on.

+ *

A radar chart visual.

+ *

For more information, see Using radar charts in the Amazon QuickSight User Guide.

* @public */ - Port: number | undefined; + RadarChartVisual?: RadarChartVisual | undefined; /** - *

The Amazon Aurora PostgreSQL database to connect to.

+ *

The custom plugin visual type.

* @public */ - Database: string | undefined; + PluginVisual?: PluginVisual | undefined; } /** - *

The parameters for IoT Analytics.

+ *

A sheet is an object that contains a set of visuals that + * are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.

* @public */ -export interface AwsIotAnalyticsParameters { +export interface SheetDefinition { /** - *

Dataset name.

+ *

The unique identifier of a sheet.

* @public */ - DataSetName: string | undefined; -} + SheetId: string | undefined; -/** - *

The parameters that are required to connect to a Google BigQuery data source.

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

The Google Cloud Platform project ID where your datasource was created.

+ *

The title of the sheet.

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

The storage location where you create a Google BigQuery data source.

+ *

A description of the sheet.

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

The parameters that are required to connect to a Databricks data source.

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

The host name of the Databricks data source.

+ *

The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight + * console.

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

The port for the Databricks data source.

+ *

The list of parameter controls that are on a sheet.

+ *

For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.

* @public */ - Port: number | undefined; + ParameterControls?: ParameterControl[] | undefined; /** - *

The HTTP path of the Databricks data source.

+ *

The list of filter controls that are on a sheet.

+ *

For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.

* @public */ - SqlEndpointPath: string | undefined; -} + FilterControls?: FilterControl[] | undefined; -/** - *

The required parameters for connecting to an Exasol data source.

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

The hostname or IP address of the Exasol data source.

+ *

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

* @public */ - Host: string | undefined; + Visuals?: Visual[] | undefined; /** - *

The port for the Exasol data source.

+ *

The text boxes that are on a sheet.

* @public */ - Port: number | undefined; -} + TextBoxes?: SheetTextBox[] | undefined; -/** - *

The parameters for Jira.

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

The base URL of the Jira site.

+ *

A list of images on a sheet.

* @public */ - SiteBaseUrl: string | undefined; -} + Images?: SheetImage[] | undefined; -/** - *

The parameters for MariaDB.

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

Host.

+ *

Layouts define how the components of a sheet are arranged.

+ *

For more information, see Types of layout in the Amazon QuickSight User Guide.

* @public */ - Host: string | undefined; + Layouts?: Layout[] | undefined; /** - *

Port.

+ *

The control layouts of the sheet.

* @public */ - Port: number | undefined; + SheetControlLayouts?: SheetControlLayout[] | undefined; /** - *

Database.

+ *

The layout content type of the sheet. Choose one of the following options:

+ *
    + *
  • + *

    + * PAGINATED: Creates a sheet for a paginated report.

    + *
  • + *
  • + *

    + * INTERACTIVE: Creates a sheet for an interactive dashboard.

    + *
  • + *
* @public */ - Database: string | undefined; + ContentType?: SheetContentType | undefined; } /** - *

The parameters for MySQL.

+ *

The structure that contains the Amazon S3 location to download the static file from.

* @public */ -export interface MySqlParameters { +export interface StaticFileS3SourceOptions { /** - *

Host.

+ *

The name of the Amazon S3 bucket.

* @public */ - Host: string | undefined; + BucketName: string | undefined; /** - *

Port.

+ *

The identifier of the static file in the Amazon S3 bucket.

* @public */ - Port: number | undefined; + ObjectKey: string | undefined; /** - *

Database.

+ *

The Region of the Amazon S3 account that contains the bucket.

* @public */ - Database: string | undefined; + Region: string | undefined; } /** - *

The parameters for Oracle.

+ *

The structure that contains the URL to download the static file from.

* @public */ -export interface OracleParameters { +export interface StaticFileUrlSourceOptions { /** - *

An Oracle host.

+ *

The URL to download the static file from.

* @public */ - Host: string | undefined; + Url: string | undefined; +} +/** + *

The source of the static file.

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

The port.

+ *

The structure that contains the URL to download the static file from.

* @public */ - Port: number | undefined; + UrlOptions?: StaticFileUrlSourceOptions | undefined; /** - *

The database.

+ *

The structure that contains the Amazon S3 location to download the static file from.

* @public */ - Database: string | undefined; + S3Options?: StaticFileS3SourceOptions | undefined; } /** - *

The parameters for PostgreSQL.

+ *

A static file that contains an image.

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

Host.

- * @public - */ - Host: string | undefined; - +export interface ImageStaticFile { /** - *

Port.

+ *

The ID of the static file that contains an image.

* @public */ - Port: number | undefined; + StaticFileId: string | undefined; /** - *

Database.

+ *

The source of the image static file.

* @public */ - Database: string | undefined; + Source?: StaticFileSource | undefined; } /** - *

The parameters for Presto.

+ *

A static file that contains the geospatial data.

* @public */ -export interface PrestoParameters { +export interface SpatialStaticFile { /** - *

Host.

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

Port.

+ *

The ID of the spatial static file.

* @public */ - Port: number | undefined; + StaticFileId: string | undefined; /** - *

Catalog.

+ *

The source of the spatial static file.

* @public */ - Catalog: string | undefined; + Source?: StaticFileSource | undefined; } /** - *

The parameters for Amazon RDS.

+ *

The static file.

* @public */ -export interface RdsParameters { +export interface StaticFile { /** - *

Instance ID.

+ *

The image static file.

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

Database.

+ *

The spacial static file.

* @public */ - Database: string | undefined; + SpatialStaticFile?: SpatialStaticFile | undefined; } /** - *

A structure that grants Amazon QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see - * GetClusterCredentials - * .

+ *

The definition of an analysis.

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

Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.

- * @public - */ - RoleArn: string | undefined; - +export interface AnalysisDefinition { /** - *

The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

+ *

An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead + * of dataset ARNs throughout analysis sub-structures.

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

A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.

+ *

An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about + * a sheet within this analysis.

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

Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.

+ *

An array of calculated field definitions for the analysis.

* @public */ - AutoCreateDatabaseUser?: boolean | undefined; -} + CalculatedFields?: CalculatedField[] | undefined; -/** - *

The parameters for an IAM Identity Center configuration.

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

A Boolean option that controls whether Trusted Identity Propagation should be used.

+ *

An array of parameter declarations for an analysis.

+ *

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 */ - EnableIdentityPropagation?: boolean | undefined; -} + ParameterDeclarations?: ParameterDeclaration[] | undefined; -/** - *

The parameters for Amazon Redshift. The ClusterId field can be blank if - * Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.

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

Host. This field can be blank if ClusterId is provided.

+ *

Filter definitions for an analysis.

+ *

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

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

Port. This field can be blank if the ClusterId is provided.

+ *

+ * An array of analysis-level column configurations. Column configurations can be used to set default + * formatting for a column to be used throughout an analysis. + *

* @public */ - Port?: number | undefined; + ColumnConfigurations?: ColumnConfiguration[] | undefined; /** - *

Database.

+ *

The configuration for default analysis settings.

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

Cluster ID. This field can be blank if the Host and Port are - * provided.

+ *

An array of option definitions for an analysis.

* @public */ - ClusterId?: string | undefined; + Options?: AssetOptions | undefined; /** - *

An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.

+ *

A structure that describes the query execution options.

* @public */ - IAMParameters?: RedshiftIAMParameters | undefined; + QueryExecutionOptions?: QueryExecutionOptions | undefined; /** - *

An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.

- *

This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.

+ *

The static files for the definition.

* @public */ - IdentityCenterConfiguration?: IdentityCenterConfiguration | undefined; + StaticFiles?: StaticFile[] | undefined; } /** - *

Amazon S3 manifest file location.

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

Amazon S3 bucket.

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

Amazon S3 key that identifies an object.

- * @public - */ - Key: string | undefined; -} - -/** - *

The parameters for S3.

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

Location of the Amazon S3 manifest file. This is NULL if the manifest file was - * uploaded into Amazon QuickSight.

- * @public - */ - ManifestFileLocation: ManifestFileLocation | undefined; - - /** - *

Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

- * @public - */ - RoleArn?: string | undefined; -} +export const AnalysisFilterAttribute = { + ANALYSIS_NAME: "ANALYSIS_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 parameters for ServiceNow.

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

URL of the base site.

- * @public - */ - SiteBaseUrl: string | undefined; -} +export type AnalysisFilterAttribute = (typeof AnalysisFilterAttribute)[keyof typeof AnalysisFilterAttribute]; /** * @public * @enum */ -export const AuthenticationType = { - PASSWORD: "PASSWORD", - TOKEN: "TOKEN", - X509: "X509", +export const FilterOperator = { + StringEquals: "StringEquals", + StringLike: "StringLike", } as const; /** * @public */ -export type AuthenticationType = (typeof AuthenticationType)[keyof typeof AuthenticationType]; +export type FilterOperator = (typeof FilterOperator)[keyof typeof FilterOperator]; /** - *

VPC connection properties.

+ *

A filter that you apply when searching for one or more analyses.

* @public */ -export interface VpcConnectionProperties { +export interface AnalysisSearchFilter { /** - *

The Amazon Resource Name (ARN) for the VPC connection.

+ *

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":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value ANALYSIS_NAME.

* @public */ - VpcConnectionArn: string | undefined; + 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 analyses with that ARN listed as one of the analysis' 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 analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are considered.

    + *
  • + *
  • + *

    + * DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.

    + *
  • + *
  • + *

    + * DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses 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 analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered.

    + *
  • + *
  • + *

    + * ANALYSIS_NAME: Any analyses whose names have a substring match to this value will be returned.

    + *
  • + *
+ * @public + */ + Name?: AnalysisFilterAttribute | undefined; + + /** + *

The value of the named item, in this case QUICKSIGHT_USER, that you want + * to use as a filter, for example "Value". An example is + * "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

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

An object that contains information needed to create a data source connection that uses OAuth client credentials. This option is available for data source connections that are made with Snowflake and Starburst.

+ *

Dataset reference.

* @public */ -export interface OAuthParameters { +export interface DataSetReference { /** - *

The token endpoint URL of the identity provider.

+ *

Dataset placeholder.

* @public */ - TokenProviderUrl: string | undefined; + DataSetPlaceholder: string | undefined; /** - *

The OAuth scope.

+ *

Dataset Amazon Resource Name (ARN).

* @public */ - OAuthScope?: string | undefined; + DataSetArn: string | undefined; +} +/** + *

The source template of an analysis.

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

VPC connection properties.

+ *

The dataset references of the source template of an analysis.

* @public */ - IdentityProviderVpcConnectionProperties?: VpcConnectionProperties | undefined; + DataSetReferences: DataSetReference[] | undefined; /** - *

The resource uri of the identity provider.

+ *

The Amazon Resource Name (ARN) of the source template of an analysis.

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

The parameters for Snowflake.

+ *

The source entity of an analysis.

* @public */ -export interface SnowflakeParameters { +export interface AnalysisSourceEntity { /** - *

Host.

+ *

The source template for the source entity of the analysis.

* @public */ - Host: string | undefined; + SourceTemplate?: AnalysisSourceTemplate | undefined; +} +/** + *

The summary metadata that describes an analysis.

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

Database.

+ *

The Amazon Resource Name (ARN) for the analysis.

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

Warehouse.

+ *

The ID of the analysis. This ID displays in the URL.

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

The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.

+ *

The name of the analysis. This name is displayed in the Amazon QuickSight console. + *

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

The database access control role.

+ *

The last known status for the analysis.

* @public */ - DatabaseAccessControlRole?: string | undefined; + Status?: ResourceStatus | undefined; /** - *

An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake.

+ *

The time that the analysis was created.

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

The time that the analysis was last updated.

+ * @public + */ + LastUpdatedTime?: Date | undefined; } /** - *

The parameters for Spark.

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

Host.

- * @public - */ - Host: string | undefined; +export const AnchorType = { + TODAY: "TODAY", +} as const; - /** - *

Port.

- * @public - */ - Port: number | undefined; -} +/** + * @public + */ +export type AnchorType = (typeof AnchorType)[keyof typeof AnchorType]; /** - *

The parameters for SQL Server.

+ *

The definition of the Anchor.

* @public */ -export interface SqlServerParameters { +export interface Anchor { /** - *

Host.

+ *

The AnchorType for the Anchor.

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

Port.

+ *

The TimeGranularity of the Anchor.

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

Database.

+ *

The offset of the Anchor.

* @public */ - Database: string | undefined; + Offset?: number | undefined; } /** * @public * @enum */ -export const StarburstProductType = { - ENTERPRISE: "ENTERPRISE", - GALAXY: "GALAXY", +export const AnonymousUserDashboardEmbeddingConfigurationDisabledFeature = { + SHARED_VIEW: "SHARED_VIEW", } as const; /** * @public */ -export type StarburstProductType = (typeof StarburstProductType)[keyof typeof StarburstProductType]; +export type AnonymousUserDashboardEmbeddingConfigurationDisabledFeature = + (typeof AnonymousUserDashboardEmbeddingConfigurationDisabledFeature)[keyof typeof AnonymousUserDashboardEmbeddingConfigurationDisabledFeature]; /** - *

The parameters that are required to connect to a Starburst data source.

* @public + * @enum */ -export interface StarburstParameters { +export const AnonymousUserDashboardEmbeddingConfigurationEnabledFeature = { + SHARED_VIEW: "SHARED_VIEW", +} as const; + +/** + * @public + */ +export type AnonymousUserDashboardEmbeddingConfigurationEnabledFeature = + (typeof AnonymousUserDashboardEmbeddingConfigurationEnabledFeature)[keyof typeof AnonymousUserDashboardEmbeddingConfigurationEnabledFeature]; + +/** + *

The shared view settings of an embedded dashboard.

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

The host name of the Starburst data source.

+ *

The shared view settings of an embedded dashboard.

* @public */ - Host: string | undefined; + Enabled: boolean | undefined; +} +/** + *

The feature configuration for an embedded dashboard.

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

The port for the Starburst data source.

+ *

The shared view settings of an embedded dashboard.

* @public */ - Port: number | undefined; + SharedView?: SharedViewConfigurations | undefined; +} +/** + *

Information about the dashboard that you want to embed.

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

The catalog name for the Starburst data source.

+ *

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard.

+ *

The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

* @public */ - Catalog: string | undefined; + InitialDashboardId: string | undefined; /** - *

The product type for the Starburst data source.

+ *

A list of all enabled features of a specified anonymous dashboard.

* @public */ - ProductType?: StarburstProductType | undefined; - - /** - *

The database access control role.

- * @public - */ - DatabaseAccessControlRole?: string | undefined; + EnabledFeatures?: AnonymousUserDashboardEmbeddingConfigurationEnabledFeature[] | undefined; /** - *

The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.

+ *

A list of all disabled features of a specified anonymous dashboard.

* @public */ - AuthenticationType?: AuthenticationType | undefined; + DisabledFeatures?: AnonymousUserDashboardEmbeddingConfigurationDisabledFeature[] | undefined; /** - *

An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.

+ *

The feature configuration for an embedded dashboard.

* @public */ - OAuthParameters?: OAuthParameters | undefined; + FeatureConfigurations?: AnonymousUserDashboardFeatureConfigurations | undefined; } /** - *

The parameters for Teradata.

+ *

A structure that contains the following elements:

+ *
    + *
  • + *

    The DashboardId of the dashboard that has the visual that you want to embed.

    + *
  • + *
  • + *

    The SheetId of the sheet that has the visual that you want to embed.

    + *
  • + *
  • + *

    The VisualId of the visual that you want to embed.

    + *
  • + *
+ *

The DashboardId, SheetId, and VisualId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

* @public */ -export interface TeradataParameters { +export interface DashboardVisualId { /** - *

Host.

+ *

The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

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

Port.

+ *

The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

* @public */ - Port: number | undefined; + SheetId: string | undefined; /** - *

Database.

+ *

The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

* @public */ - Database: string | undefined; + VisualId: string | undefined; } /** - *

The parameters that are required to connect to a Trino data source.

+ *

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

* @public */ -export interface TrinoParameters { +export interface AnonymousUserDashboardVisualEmbeddingConfiguration { /** - *

The host name of the Trino data source.

+ *

The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

+ *

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

* @public */ - Host: string | undefined; + InitialDashboardVisualId: DashboardVisualId | undefined; +} +/** + *

The settings that you want to use for the Generative Q&A experience.

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

The port for the Trino data source.

+ *

The Amazon QuickSight Q topic ID of the new reader experience topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Generative Q&A experience with this new reader experience topic pre selected.

+ *

The Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

* @public */ - Port: number | undefined; + InitialTopicId: string | undefined; +} +/** + *

The settings that you want to use with the Q search bar.

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

The catalog name for the Trino data source.

+ *

The Amazon QuickSight Q topic ID of the legacy topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this legacy topic pre-selected.

+ *

The Amazon Resource Name (ARN) of this Q legacy topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

* @public */ - Catalog: string | undefined; + InitialTopicId: string | undefined; } /** - *

The parameters for Twitter.

+ *

The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.

* @public */ -export interface TwitterParameters { +export interface AnonymousUserEmbeddingExperienceConfiguration { /** - *

Twitter query string.

+ *

The type of embedding experience. In this case, Amazon QuickSight dashboards.

* @public */ - Query: string | undefined; + Dashboard?: AnonymousUserDashboardEmbeddingConfiguration | undefined; /** - *

Maximum number of rows to query Twitter.

+ *

The type of embedding experience. In this case, Amazon QuickSight visuals.

* @public */ - MaxRows: number | undefined; + DashboardVisual?: AnonymousUserDashboardVisualEmbeddingConfiguration | undefined; + + /** + *

The Q search bar that you want to use for anonymous user embedding.

+ * @public + */ + QSearchBar?: AnonymousUserQSearchBarEmbeddingConfiguration | undefined; + + /** + *

The Generative Q&A experience that you want to use for anonymous user embedding.

+ * @public + */ + GenerativeQnA?: AnonymousUserGenerativeQnAEmbeddingConfiguration | undefined; } /** - *

The parameters that Amazon QuickSight uses to connect to your underlying data source. - * This is a variant type structure. For this structure to be valid, only one of the - * attributes can be non-null.

* @public + * @enum */ -export type DataSourceParameters = - | DataSourceParameters.AmazonElasticsearchParametersMember - | DataSourceParameters.AmazonOpenSearchParametersMember - | DataSourceParameters.AthenaParametersMember - | DataSourceParameters.AuroraParametersMember - | DataSourceParameters.AuroraPostgreSqlParametersMember - | DataSourceParameters.AwsIotAnalyticsParametersMember - | DataSourceParameters.BigQueryParametersMember - | DataSourceParameters.DatabricksParametersMember - | DataSourceParameters.ExasolParametersMember - | DataSourceParameters.JiraParametersMember - | DataSourceParameters.MariaDbParametersMember - | DataSourceParameters.MySqlParametersMember - | DataSourceParameters.OracleParametersMember - | DataSourceParameters.PostgreSqlParametersMember - | DataSourceParameters.PrestoParametersMember - | DataSourceParameters.RdsParametersMember - | DataSourceParameters.RedshiftParametersMember - | DataSourceParameters.S3ParametersMember - | DataSourceParameters.ServiceNowParametersMember - | DataSourceParameters.SnowflakeParametersMember - | DataSourceParameters.SparkParametersMember - | DataSourceParameters.SqlServerParametersMember - | DataSourceParameters.StarburstParametersMember - | DataSourceParameters.TeradataParametersMember - | DataSourceParameters.TrinoParametersMember - | DataSourceParameters.TwitterParametersMember - | DataSourceParameters.$UnknownMember; +export const SnapshotFileFormatType = { + CSV: "CSV", + EXCEL: "EXCEL", + PDF: "PDF", +} as const; /** * @public */ -export namespace DataSourceParameters { +export type SnapshotFileFormatType = (typeof SnapshotFileFormatType)[keyof typeof SnapshotFileFormatType]; + +/** + * @public + * @enum + */ +export const SnapshotFileSheetSelectionScope = { + ALL_VISUALS: "ALL_VISUALS", + SELECTED_VISUALS: "SELECTED_VISUALS", +} as const; + +/** + * @public + */ +export type SnapshotFileSheetSelectionScope = + (typeof SnapshotFileSheetSelectionScope)[keyof typeof SnapshotFileSheetSelectionScope]; + +/** + *

A structure that contains information that identifies the snapshot that needs to be generated.

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

The parameters for OpenSearch.

+ *

The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.

* @public */ - export interface AmazonElasticsearchParametersMember { - AmazonElasticsearchParameters: AmazonElasticsearchParameters; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + SheetId: string | undefined; /** - *

The parameters for Amazon Athena.

+ *

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

+ *
    + *
  • + *

    + * ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.

    + *
  • + *
  • + *

    + * SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.

    + *
  • + *
* @public */ - export interface AthenaParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters: AthenaParameters; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + SelectionScope: SnapshotFileSheetSelectionScope | undefined; /** - *

The parameters for Amazon Aurora MySQL.

+ *

+ * A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file. + *

* @public */ - export interface AuroraParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters: AuroraParameters; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + VisualIds?: string[] | undefined; +} +/** + *

A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.

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

The parameters for Amazon Aurora.

+ *

A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.

* @public */ - export interface AuroraPostgreSqlParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters: AuroraPostgreSqlParameters; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + SheetSelections: SnapshotFileSheetSelection[] | undefined; /** - *

The parameters for IoT Analytics.

+ *

The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.

* @public */ - export interface AwsIotAnalyticsParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters: AwsIotAnalyticsParameters; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + FormatType: SnapshotFileFormatType | undefined; +} +/** + *

Information on the error that caused the snapshot job to fail.

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

The parameters for Jira.

+ *

The error message.

* @public */ - export interface JiraParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters: JiraParameters; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + ErrorMessage?: string | undefined; /** - *

The parameters for MariaDB.

+ *

The error type.

* @public */ - export interface MariaDbParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters: MariaDbParameters; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + ErrorType?: string | undefined; +} +/** + *

An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default Amazon QuickSight bucket.

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

The parameters for MySQL.

+ *

The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

* @public */ - export interface MySqlParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters: MySqlParameters; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + BucketName: string | undefined; /** - *

The parameters for Oracle.

+ *

The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

* @public */ - export interface OracleParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters: OracleParameters; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + BucketPrefix: string | undefined; /** - *

The parameters for PostgreSQL.

+ *

The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

* @public */ - export interface PostgreSqlParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters: PostgreSqlParameters; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } - - /** - *

The parameters for Presto.

- * @public - */ - export interface PrestoParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters: PrestoParameters; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + BucketRegion: string | undefined; +} +/** + *

A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot.

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

The parameters for Amazon RDS.

+ *

A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.

* @public */ - export interface RdsParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters: RdsParameters; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + BucketConfiguration: S3BucketConfiguration | undefined; +} +/** + *

The Amazon S3 result from the snapshot job. The result includes the DestinationConfiguration and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error.

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

The parameters for Amazon Redshift.

+ *

A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call. + *

* @public */ - export interface RedshiftParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters: RedshiftParameters; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + S3DestinationConfiguration?: SnapshotS3DestinationConfiguration | undefined; /** - *

The parameters for S3.

+ *

The Amazon S3 Uri.

* @public */ - export interface S3ParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters: S3Parameters; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + S3Uri?: string | undefined; /** - *

The parameters for ServiceNow.

+ *

An array of error records that describe any failures that occur while the dashboard snapshot job runs.

* @public */ - export interface ServiceNowParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters: ServiceNowParameters; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + ErrorInfo?: SnapshotJobResultErrorInfo[] | undefined; +} +/** + *

A structure that contains information on the generated snapshot file groups.

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

The parameters for Snowflake.

+ *

A list of SnapshotFile objects.

* @public */ - export interface SnowflakeParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters: SnowflakeParameters; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + Files?: SnapshotFile[] | undefined; /** - *

The parameters for Spark.

+ *

A list of SnapshotJobS3Result objects.

* @public */ - export interface SparkParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters: SparkParameters; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + S3Results?: SnapshotJobS3Result[] | undefined; +} +/** + *

A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call. + *

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

The parameters for SQL Server.

+ *

A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.

* @public */ - export interface SqlServerParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters: SqlServerParameters; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + FileGroups?: SnapshotJobResultFileGroup[] | undefined; +} +/** + *

The color palette.

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

The parameters for Teradata.

+ *

The foreground color.

* @public */ - export interface TeradataParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters: TeradataParameters; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + Foreground?: string | undefined; /** - *

The parameters for Twitter.

+ *

The background color.

* @public */ - export interface TwitterParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters: TwitterParameters; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + Background?: string | undefined; +} +/** + *

The color palette.

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

The parameters for OpenSearch.

+ *

The primary color.

* @public */ - export interface AmazonOpenSearchParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters: AmazonOpenSearchParameters; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + Primary?: Palette | undefined; /** - *

The parameters for Exasol.

+ *

The secondary color.

* @public */ - export interface ExasolParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters: ExasolParameters; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + Secondary?: Palette | undefined; /** - *

The parameters that are required to connect to a Databricks data source.

+ *

The color that is used for accent elements.

* @public */ - export interface DatabricksParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters: DatabricksParameters; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + Accent?: Palette | undefined; /** - *

The parameters that are required to connect to a Starburst data source.

+ *

The color that is used for measure elements.

* @public */ - export interface StarburstParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters: StarburstParameters; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown?: never; - } + Measure?: Palette | undefined; /** - *

The parameters that are required to connect to a Trino data source.

+ *

The color that is used for dimension elements.

* @public */ - export interface TrinoParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters: TrinoParameters; - BigQueryParameters?: never; - $unknown?: never; - } + Dimension?: Palette | undefined; /** - *

The parameters that are required to connect to a Google BigQuery data source.

+ *

The color that is used for success elements.

* @public */ - export interface BigQueryParametersMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters: BigQueryParameters; - $unknown?: never; - } + Success?: Palette | undefined; /** + *

The color that is used for info elements.

* @public */ - export interface $UnknownMember { - AmazonElasticsearchParameters?: never; - AthenaParameters?: never; - AuroraParameters?: never; - AuroraPostgreSqlParameters?: never; - AwsIotAnalyticsParameters?: never; - JiraParameters?: never; - MariaDbParameters?: never; - MySqlParameters?: never; - OracleParameters?: never; - PostgreSqlParameters?: never; - PrestoParameters?: never; - RdsParameters?: never; - RedshiftParameters?: never; - S3Parameters?: never; - ServiceNowParameters?: never; - SnowflakeParameters?: never; - SparkParameters?: never; - SqlServerParameters?: never; - TeradataParameters?: never; - TwitterParameters?: never; - AmazonOpenSearchParameters?: never; - ExasolParameters?: never; - DatabricksParameters?: never; - StarburstParameters?: never; - TrinoParameters?: never; - BigQueryParameters?: never; - $unknown: [string, any]; - } - - export interface Visitor { - AmazonElasticsearchParameters: (value: AmazonElasticsearchParameters) => T; - AthenaParameters: (value: AthenaParameters) => T; - AuroraParameters: (value: AuroraParameters) => T; - AuroraPostgreSqlParameters: (value: AuroraPostgreSqlParameters) => T; - AwsIotAnalyticsParameters: (value: AwsIotAnalyticsParameters) => T; - JiraParameters: (value: JiraParameters) => T; - MariaDbParameters: (value: MariaDbParameters) => T; - MySqlParameters: (value: MySqlParameters) => T; - OracleParameters: (value: OracleParameters) => T; - PostgreSqlParameters: (value: PostgreSqlParameters) => T; - PrestoParameters: (value: PrestoParameters) => T; - RdsParameters: (value: RdsParameters) => T; - RedshiftParameters: (value: RedshiftParameters) => T; - S3Parameters: (value: S3Parameters) => T; - ServiceNowParameters: (value: ServiceNowParameters) => T; - SnowflakeParameters: (value: SnowflakeParameters) => T; - SparkParameters: (value: SparkParameters) => T; - SqlServerParameters: (value: SqlServerParameters) => T; - TeradataParameters: (value: TeradataParameters) => T; - TwitterParameters: (value: TwitterParameters) => T; - AmazonOpenSearchParameters: (value: AmazonOpenSearchParameters) => T; - ExasolParameters: (value: ExasolParameters) => T; - DatabricksParameters: (value: DatabricksParameters) => T; - StarburstParameters: (value: StarburstParameters) => T; - TrinoParameters: (value: TrinoParameters) => T; - BigQueryParameters: (value: BigQueryParameters) => T; - _: (name: string, value: any) => T; - } + Info?: Palette | undefined; - export const visit = (value: DataSourceParameters, visitor: Visitor): T => { - if (value.AmazonElasticsearchParameters !== undefined) - return visitor.AmazonElasticsearchParameters(value.AmazonElasticsearchParameters); - if (value.AthenaParameters !== undefined) return visitor.AthenaParameters(value.AthenaParameters); - if (value.AuroraParameters !== undefined) return visitor.AuroraParameters(value.AuroraParameters); - if (value.AuroraPostgreSqlParameters !== undefined) - return visitor.AuroraPostgreSqlParameters(value.AuroraPostgreSqlParameters); - if (value.AwsIotAnalyticsParameters !== undefined) - return visitor.AwsIotAnalyticsParameters(value.AwsIotAnalyticsParameters); - if (value.JiraParameters !== undefined) return visitor.JiraParameters(value.JiraParameters); - if (value.MariaDbParameters !== undefined) return visitor.MariaDbParameters(value.MariaDbParameters); - if (value.MySqlParameters !== undefined) return visitor.MySqlParameters(value.MySqlParameters); - if (value.OracleParameters !== undefined) return visitor.OracleParameters(value.OracleParameters); - if (value.PostgreSqlParameters !== undefined) return visitor.PostgreSqlParameters(value.PostgreSqlParameters); - if (value.PrestoParameters !== undefined) return visitor.PrestoParameters(value.PrestoParameters); - if (value.RdsParameters !== undefined) return visitor.RdsParameters(value.RdsParameters); - if (value.RedshiftParameters !== undefined) return visitor.RedshiftParameters(value.RedshiftParameters); - if (value.S3Parameters !== undefined) return visitor.S3Parameters(value.S3Parameters); - if (value.ServiceNowParameters !== undefined) return visitor.ServiceNowParameters(value.ServiceNowParameters); - if (value.SnowflakeParameters !== undefined) return visitor.SnowflakeParameters(value.SnowflakeParameters); - if (value.SparkParameters !== undefined) return visitor.SparkParameters(value.SparkParameters); - if (value.SqlServerParameters !== undefined) return visitor.SqlServerParameters(value.SqlServerParameters); - if (value.TeradataParameters !== undefined) return visitor.TeradataParameters(value.TeradataParameters); - if (value.TwitterParameters !== undefined) return visitor.TwitterParameters(value.TwitterParameters); - if (value.AmazonOpenSearchParameters !== undefined) - return visitor.AmazonOpenSearchParameters(value.AmazonOpenSearchParameters); - if (value.ExasolParameters !== undefined) return visitor.ExasolParameters(value.ExasolParameters); - if (value.DatabricksParameters !== undefined) return visitor.DatabricksParameters(value.DatabricksParameters); - if (value.StarburstParameters !== undefined) return visitor.StarburstParameters(value.StarburstParameters); - if (value.TrinoParameters !== undefined) return visitor.TrinoParameters(value.TrinoParameters); - if (value.BigQueryParameters !== undefined) return visitor.BigQueryParameters(value.BigQueryParameters); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; -} + /** + *

The color that is used for warning elements.

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

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your - * underlying data source.

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

A Boolean option to control whether SSL should be disabled.

+ *

The color that is used for danger elements.

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

The override parameters for a single data source that is being imported.

+ *

The navigation bar style.

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

The ID of the data source to apply overrides to.

- * @public - */ - DataSourceId: string | undefined; - +export interface NavbarStyle { /** - *

A new name for the data source.

+ *

The global navigation bar style.

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

The parameters that Amazon QuickSight uses to connect to your underlying data source. - * This is a variant type structure. For this structure to be valid, only one of the - * attributes can be non-null.

+ *

The contextual navigation bar style.

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

The element style.

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

VPC connection properties.

+ *

The navigation bar style.

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

The application theme.

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

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your - * underlying data source.

+ *

The color palette.

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

An optional structure that provides the credentials to be used to create the imported data source.

+ *

The element style.

* @public */ - Credentials?: AssetBundleImportJobDataSourceCredentials | undefined; + BrandElementStyle?: BrandElementStyle | undefined; } /** - *

An object that contains a list of permissions to be applied to a list of data source IDs.

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

A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.

- * @public - */ - DataSourceIds: string[] | undefined; +export const AssetBundleExportJobAnalysisPropertyToOverride = { + NAME: "Name", +} as const; - /** - *

A list of permissions for the data source that you want to apply overrides to.

- * @public - */ - Permissions: AssetBundleResourcePermissions | undefined; -} +/** + * @public + */ +export type AssetBundleExportJobAnalysisPropertyToOverride = + (typeof AssetBundleExportJobAnalysisPropertyToOverride)[keyof typeof AssetBundleExportJobAnalysisPropertyToOverride]; /** - *

An object that contains a list of tags to be assigned to a list of data source IDs.

+ *

Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.

* @public */ -export interface AssetBundleImportJobDataSourceOverrideTags { +export interface AssetBundleExportJobAnalysisOverrideProperties { /** - *

A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.

+ *

The ARN of the specific Analysis resource whose override properties are configured in this structure.

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

A list of tags for the data source that you want to apply overrides to.

+ *

A list of Analysis resource properties to generate variables for in the returned CloudFormation template.

* @public */ - Tags: Tag[] | undefined; + Properties: AssetBundleExportJobAnalysisPropertyToOverride[] | undefined; } /** - *

Describes an error that occurred within an Asset Bundle import execution.

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

The ARN of the resource whose processing caused an error.

- * @public - */ - Arn?: string | undefined; +export const AssetBundleExportJobDashboardPropertyToOverride = { + NAME: "Name", +} as const; + +/** + * @public + */ +export type AssetBundleExportJobDashboardPropertyToOverride = + (typeof AssetBundleExportJobDashboardPropertyToOverride)[keyof typeof AssetBundleExportJobDashboardPropertyToOverride]; +/** + *

Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.

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

The specific error type or the error that occurred.

+ *

The ARN of the specific Dashboard resource whose override properties are configured in this structure.

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

A description of the error.

+ *

A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.

* @public */ - Message?: string | undefined; + Properties: AssetBundleExportJobDashboardPropertyToOverride[] | undefined; } /** - *

The override parameters for a single folder that is being imported.

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

The ID of the folder that you want to apply overrides to.

- * @public - */ - FolderId: string | undefined; +export const AssetBundleExportJobDataSetPropertyToOverride = { + NAME: "Name", +} as const; + +/** + * @public + */ +export type AssetBundleExportJobDataSetPropertyToOverride = + (typeof AssetBundleExportJobDataSetPropertyToOverride)[keyof typeof AssetBundleExportJobDataSetPropertyToOverride]; +/** + *

Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.

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

A new name for the folder.

+ *

The ARN of the specific DataSet resource whose override properties are configured in this structure.

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

A new parent folder arn. This change can only be applied if the import creates a brand new folder. Existing folders cannot be moved.

+ *

A list of DataSet resource properties to generate variables for in the returned CloudFormation template.

* @public */ - ParentFolderArn?: string | undefined; + Properties: AssetBundleExportJobDataSetPropertyToOverride[] | undefined; } /** - *

An object that contains a list of permissions to be applied to a list of folder IDs.

* @public + * @enum */ -export interface AssetBundleImportJobFolderOverridePermissions { +export const AssetBundleExportJobDataSourcePropertyToOverride = { + CATALOG: "Catalog", + CLUSTER_ID: "ClusterId", + DATABASE: "Database", + DATA_SET_NAME: "DataSetName", + DISABLE_SSL: "DisableSsl", + DOMAIN: "Domain", + HOST: "Host", + INSTANCE_ID: "InstanceId", + MANIFEST_FILE_LOCATION: "ManifestFileLocation", + NAME: "Name", + PASSWORD: "Password", + PORT: "Port", + PRODUCT_TYPE: "ProductType", + ROLE_ARN: "RoleArn", + SECRET_ARN: "SecretArn", + USERNAME: "Username", + WAREHOUSE: "Warehouse", + WORK_GROUP: "WorkGroup", +} as const; + +/** + * @public + */ +export type AssetBundleExportJobDataSourcePropertyToOverride = + (typeof AssetBundleExportJobDataSourcePropertyToOverride)[keyof typeof AssetBundleExportJobDataSourcePropertyToOverride]; + +/** + *

Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.

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

A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.

+ *

The ARN of the specific DataSource resource whose override properties are configured in this structure.

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

A structure that contains the permissions for the resource that you want to override in an asset bundle import job.

+ *

A list of DataSource resource properties to generate variables for in the returned CloudFormation template.

* @public */ - Permissions?: AssetBundleResourcePermissions | undefined; + Properties: AssetBundleExportJobDataSourcePropertyToOverride[] | undefined; } /** - *

An object that contains a list of tags to be assigned to a list of folder IDs.

* @public + * @enum */ -export interface AssetBundleImportJobFolderOverrideTags { +export const AssetBundleExportJobFolderPropertyToOverride = { + NAME: "Name", + PARENT_FOLDER_ARN: "ParentFolderArn", +} as const; + +/** + * @public + */ +export type AssetBundleExportJobFolderPropertyToOverride = + (typeof AssetBundleExportJobFolderPropertyToOverride)[keyof typeof AssetBundleExportJobFolderPropertyToOverride]; + +/** + *

Controls how a specific Folder resource is parameterized in the returned CloudFormation template.

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

A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.

+ *

The ARN of the specific Folder resource whose override properties are configured in this structure.

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

A list of tags for the folders that you want to apply overrides to.

+ *

A list of Folder resource properties to generate variables for in the returned CloudFormation template.

* @public */ - Tags: Tag[] | undefined; + Properties: AssetBundleExportJobFolderPropertyToOverride[] | undefined; } /** - *

A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.

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

A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.

- * @public - */ - DataSetId: string | undefined; +export const AssetBundleExportJobRefreshSchedulePropertyToOverride = { + START_AFTER_DATE_TIME: "StartAfterDateTime", +} as const; + +/** + * @public + */ +export type AssetBundleExportJobRefreshSchedulePropertyToOverride = + (typeof AssetBundleExportJobRefreshSchedulePropertyToOverride)[keyof typeof AssetBundleExportJobRefreshSchedulePropertyToOverride]; +/** + *

Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.

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

A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.

+ *

The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.

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

An override for the StartAfterDateTime of a RefreshSchedule. Make - * sure that the StartAfterDateTime is set to a time that takes - * place in the future.

+ *

A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation template.

* @public */ - StartAfterDateTime?: Date | undefined; + Properties: AssetBundleExportJobRefreshSchedulePropertyToOverride[] | undefined; } /** - *

An optional structure that configures resource ID overrides for the import job.

+ *

An optional structure that configures resource ID overrides for the export job.

* @public */ -export interface AssetBundleImportJobResourceIdOverrideConfiguration { +export interface AssetBundleExportJobResourceIdOverrideConfiguration { /** *

An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

* @public */ - PrefixForAllResources?: string | undefined; + PrefixForAllResources?: boolean | undefined; } /** - *

The override parameters for a single theme that is imported.

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

The ID of the theme to apply overrides to.

- * @public - */ - ThemeId: string | undefined; +export const AssetBundleExportJobThemePropertyToOverride = { + NAME: "Name", +} as const; - /** - *

A new name for the theme.

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

The override parameters for a single VPC connection that is imported.

+ *

Controls how a specific Theme resource is parameterized in the returned CloudFormation template.

* @public */ -export interface AssetBundleImportJobVPCConnectionOverrideParameters { +export interface AssetBundleExportJobThemeOverrideProperties { /** - *

The ID of the VPC Connection to apply overrides to.

+ *

The ARN of the specific Theme resource whose override properties are configured in this structure.

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

A new name for the VPC connection.

+ *

A list of Theme resource properties to generate variables for in the returned CloudFormation template.

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

A list of new subnet IDs for the VPC connection you are importing. This field is - * required if you are importing the VPC connection from another Amazon Web Services account or Region.

- * @public - */ - SubnetIds?: string[] | undefined; +/** + * @public + * @enum + */ +export const AssetBundleExportJobVPCConnectionPropertyToOverride = { + DNS_RESOLVERS: "DnsResolvers", + NAME: "Name", + ROLE_ARN: "RoleArn", +} as const; - /** - *

A new security group ID for the VPC connection you are importing. This field is required - * if you are importing the VPC connection from another Amazon Web Services account or Region.

- * @public - */ - SecurityGroupIds?: string[] | undefined; +/** + * @public + */ +export type AssetBundleExportJobVPCConnectionPropertyToOverride = + (typeof AssetBundleExportJobVPCConnectionPropertyToOverride)[keyof typeof AssetBundleExportJobVPCConnectionPropertyToOverride]; +/** + *

Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.

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

An optional override of DNS resolvers to be used by the VPC connection.

+ *

The ARN of the specific VPCConnection resource whose override properties are configured in this structure.

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

An optional override of the role ARN to be used by the VPC connection.

+ *

A list of VPCConnection resource properties to generate variables for in the returned CloudFormation template.

* @public */ - RoleArn?: string | undefined; + Properties: AssetBundleExportJobVPCConnectionPropertyToOverride[] | undefined; } /** - *

A list of overrides that modify the asset bundle resource configuration before the resource is imported.

+ *

An optional collection of CloudFormation property configurations that control how the export job is generated.

* @public */ -export interface AssetBundleImportJobOverrideParameters { +export interface AssetBundleCloudFormationOverridePropertyConfiguration { /** - *

An optional structure that configures resource ID overrides to be applied within the import job.

+ *

An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.

* @public */ - ResourceIdOverrideConfiguration?: AssetBundleImportJobResourceIdOverrideConfiguration | undefined; + ResourceIdOverrideConfiguration?: AssetBundleExportJobResourceIdOverrideConfiguration | undefined; /** - *

A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.

+ *

An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.

* @public */ - VPCConnections?: AssetBundleImportJobVPCConnectionOverrideParameters[] | undefined; + VPCConnections?: AssetBundleExportJobVPCConnectionOverrideProperties[] | undefined; /** - *

A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.

+ *

An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.

* @public */ - RefreshSchedules?: AssetBundleImportJobRefreshScheduleOverrideParameters[] | undefined; + RefreshSchedules?: AssetBundleExportJobRefreshScheduleOverrideProperties[] | undefined; /** - *

A list of overrides for any DataSource resources that are present in the asset bundle that is imported.

+ *

An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.

* @public */ - DataSources?: AssetBundleImportJobDataSourceOverrideParameters[] | undefined; + DataSources?: AssetBundleExportJobDataSourceOverrideProperties[] | undefined; /** - *

A list of overrides for any DataSet resources that are present in the asset bundle that is imported.

+ *

An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.

* @public */ - DataSets?: AssetBundleImportJobDataSetOverrideParameters[] | undefined; + DataSets?: AssetBundleExportJobDataSetOverrideProperties[] | undefined; /** - *

A list of overrides for any Theme resources that are present in the asset bundle that is imported.

+ *

An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.

* @public */ - Themes?: AssetBundleImportJobThemeOverrideParameters[] | undefined; + Themes?: AssetBundleExportJobThemeOverrideProperties[] | undefined; /** - *

A list of overrides for any Analysis resources that are present in the asset bundle that is imported.

+ *

An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.

* @public */ - Analyses?: AssetBundleImportJobAnalysisOverrideParameters[] | undefined; + Analyses?: AssetBundleExportJobAnalysisOverrideProperties[] | undefined; /** - *

A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.

+ *

An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.

* @public */ - Dashboards?: AssetBundleImportJobDashboardOverrideParameters[] | undefined; + Dashboards?: AssetBundleExportJobDashboardOverrideProperties[] | undefined; /** - *

A list of overrides for any Folder resources that are present in the asset bundle that is imported.

+ *

An optional list of structures that controls how Folder resources are parameterized in the returned CloudFormation template.

* @public */ - Folders?: AssetBundleImportJobFolderOverrideParameters[] | undefined; + Folders?: AssetBundleExportJobFolderOverrideProperties[] | undefined; } /** - *

An object that contains a list of permissions to be applied to a list of theme IDs.

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

A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.

- * @public - */ - ThemeIds: string[] | undefined; - - /** - *

A list of permissions for the themes that you want to apply overrides to.

- * @public - */ - Permissions: AssetBundleResourcePermissions | undefined; -} +export const AssetBundleExportFormat = { + CLOUDFORMATION_JSON: "CLOUDFORMATION_JSON", + QUICKSIGHT_JSON: "QUICKSIGHT_JSON", +} as const; /** - *

A structure that contains the override permission configurations that modify the permissions for specified resources before the resource is imported.

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

A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.

- * @public - */ - DataSources?: AssetBundleImportJobDataSourceOverridePermissions[] | undefined; - - /** - *

A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.

- * @public - */ - DataSets?: AssetBundleImportJobDataSetOverridePermissions[] | undefined; - - /** - *

A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.

- * @public - */ - Themes?: AssetBundleImportJobThemeOverridePermissions[] | undefined; +export type AssetBundleExportFormat = (typeof AssetBundleExportFormat)[keyof typeof AssetBundleExportFormat]; +/** + *

Describes an error that occurred during an Asset Bundle export job.

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

A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.

+ *

The ARN of the resource whose processing caused an error.

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

A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.

+ *

The specific error type of the error that occurred.

* @public */ - Dashboards?: AssetBundleImportJobDashboardOverridePermissions[] | undefined; + Type?: string | undefined; /** - *

A list of permissions for the folders that you want to apply overrides to.

+ *

A description of the error.

* @public */ - Folders?: AssetBundleImportJobFolderOverridePermissions[] | undefined; + Message?: string | undefined; } /** - *

An object that contains a list of tags to be assigned to a list of theme IDs.

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

A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.

- * @public - */ - ThemeIds: string[] | undefined; +export const AssetBundleExportJobStatus = { + FAILED: "FAILED", + IN_PROGRESS: "IN_PROGRESS", + QUEUED_FOR_IMMEDIATE_EXECUTION: "QUEUED_FOR_IMMEDIATE_EXECUTION", + SUCCESSFUL: "SUCCESSFUL", +} as const; - /** - *

A list of tags for the themes that you want to apply overrides to.

- * @public - */ - Tags: Tag[] | undefined; -} +/** + * @public + */ +export type AssetBundleExportJobStatus = (typeof AssetBundleExportJobStatus)[keyof typeof AssetBundleExportJobStatus]; /** - *

An object that contains a list of tags to be assigned to a list of VPC connection IDs.

+ *

A summary of the export job that includes details of the job's configuration and its current status.

* @public */ -export interface AssetBundleImportJobVPCConnectionOverrideTags { +export interface AssetBundleExportJobSummary { /** - *

A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.

+ *

The current status of the export job.

* @public */ - VPCConnectionIds: string[] | undefined; + JobStatus?: AssetBundleExportJobStatus | undefined; /** - *

A list of tags for the VPC connections that you want to apply overrides to.

+ *

The ARN of the export job.

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

A structure that contains the override tag configuration that modify the tags that are assigned to specified resources before the resource is imported.

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

A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.

+ *

The time that the export job was created.

* @public */ - VPCConnections?: AssetBundleImportJobVPCConnectionOverrideTags[] | undefined; + CreatedTime?: Date | undefined; /** - *

A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.

+ *

The ID of the export job.

* @public */ - DataSources?: AssetBundleImportJobDataSourceOverrideTags[] | undefined; + AssetBundleExportJobId?: string | undefined; /** - *

A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.

+ *

The flag that determines the inclusion of resource dependencies in the returned asset bundle.

* @public */ - DataSets?: AssetBundleImportJobDataSetOverrideTags[] | undefined; + IncludeAllDependencies?: boolean | undefined; /** - *

A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.

+ *

The format for the export job.

* @public */ - Themes?: AssetBundleImportJobThemeOverrideTags[] | undefined; + ExportFormat?: AssetBundleExportFormat | undefined; /** - *

A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.

+ *

The flag that determines the inclusion of permissions associated with each resource ARN.

* @public */ - Analyses?: AssetBundleImportJobAnalysisOverrideTags[] | undefined; + IncludePermissions?: boolean | undefined; /** - *

A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.

+ *

The flag that determines the inclusion of tags associated with each resource ARN.

* @public */ - Dashboards?: AssetBundleImportJobDashboardOverrideTags[] | undefined; + IncludeTags?: boolean | undefined; +} +/** + *

The option to relax the validation that is required to export each asset. When StrictModeForAllResource is set to false, validation is skipped for specific UI errors.

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

A list of tag overrides for any Folder resources that are present in the asset bundle that is imported.

+ *

A Boolean value that indicates whether to export resources under strict or lenient mode.

* @public */ - Folders?: AssetBundleImportJobFolderOverrideTags[] | undefined; + StrictModeForAllResources?: boolean | undefined; } /** - *

An optional parameter that overrides the validation strategy for all analyses and dashboards before the resource is imported.

+ *

Describes a warning that occurred during an Asset Bundle export job.

* @public */ -export interface AssetBundleImportJobOverrideValidationStrategy { +export interface AssetBundleExportJobWarning { /** - *

A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.

+ *

The ARN of the resource whose processing caused a warning.

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

A description of the warning.

+ * @public + */ + Message?: string | undefined; } /** * @public * @enum */ -export const AssetBundleImportJobStatus = { - FAILED: "FAILED", - FAILED_ROLLBACK_COMPLETED: "FAILED_ROLLBACK_COMPLETED", - FAILED_ROLLBACK_ERROR: "FAILED_ROLLBACK_ERROR", - FAILED_ROLLBACK_IN_PROGRESS: "FAILED_ROLLBACK_IN_PROGRESS", - IN_PROGRESS: "IN_PROGRESS", - QUEUED_FOR_IMMEDIATE_EXECUTION: "QUEUED_FOR_IMMEDIATE_EXECUTION", - SUCCESSFUL: "SUCCESSFUL", +export const AssetBundleImportFailureAction = { + DO_NOTHING: "DO_NOTHING", + ROLLBACK: "ROLLBACK", } as const; /** * @public */ -export type AssetBundleImportJobStatus = (typeof AssetBundleImportJobStatus)[keyof typeof AssetBundleImportJobStatus]; +export type AssetBundleImportFailureAction = + (typeof AssetBundleImportFailureAction)[keyof typeof AssetBundleImportFailureAction]; /** - *

A summary of the import job that includes details of the requested job's configuration and its current status.

+ *

The override parameters for a single analysis that is being imported.

* @public */ -export interface AssetBundleImportJobSummary { +export interface AssetBundleImportJobAnalysisOverrideParameters { /** - *

The current status of the import job.

+ *

The ID of the analysis that you ant to apply overrides to.

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

The ARN of the import job.

+ *

A new name for the analysis.

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

A structure that contains the permissions for the resource that you want to override in an asset bundle import job.

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

The time that the import job was created.

+ *

A list of principals to grant permissions on.

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

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

+ *

A list of IAM actions to grant permissions on.

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

An object that contains a list of permissions to be applied to a list of analysis IDs.

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

The failure action for the import job.

+ *

A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.

* @public */ - FailureAction?: AssetBundleImportFailureAction | undefined; + AnalysisIds: string[] | undefined; + + /** + *

A list of permissions for the analyses that you want to apply overrides to.

+ * @public + */ + Permissions: AssetBundleResourcePermissions | undefined; } /** - *

Describes a warning that occurred during an Asset Bundle import job.

+ *

The key or keys of the key-value pairs for the resource tag or tags assigned to the + * resource.

* @public */ -export interface AssetBundleImportJobWarning { +export interface Tag { /** - *

The ARN of the resource that the warning occurred for.

+ *

Tag key.

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

A description of the warning that occurred during an Asset Bundle import job.

+ *

Tag value.

* @public */ - Message?: string | undefined; + Value: string | undefined; } /** - *

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.

+ *

An object that contains a list of tags to be assigned to a list of analysis IDs.

* @public */ -export interface AssetBundleImportSource { +export interface AssetBundleImportJobAnalysisOverrideTags { /** - *

The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.

- *

If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or - * PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using - * an SDK for a different language or receiving related errors, try to base64 encode your data.

+ *

A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.

* @public */ - Body?: Uint8Array | undefined; + AnalysisIds: string[] | undefined; /** - *

The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller - * has read access to. The file must be a zip format file and can't exceed 20 MB.

+ *

A list of tags for the analyses that you want to apply overrides to.

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

A description of the import source that you provide at the start of an import job. This value is set to either Body or S3Uri, depending on how the StartAssetBundleImportJobRequest is configured.

+ *

The override parameters for a single dashboard that is being imported.

* @public */ -export interface AssetBundleImportSourceDescription { +export interface AssetBundleImportJobDashboardOverrideParameters { /** - *

An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.

+ *

The ID of the dashboard that you want to apply overrides to.

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

The Amazon S3 URI that you provided at the start of the import job.

+ *

A new name for the dashboard.

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

A structure that contains the configuration of a shared link to an Amazon QuickSight dashboard.

* @public - * @enum */ -export const AssignmentStatus = { - DISABLED: "DISABLED", - DRAFT: "DRAFT", - ENABLED: "ENABLED", -} as const; +export interface AssetBundleResourceLinkSharingConfiguration { + /** + *

A list of link sharing permissions for the dashboards that you want to apply overrides to.

+ * @public + */ + Permissions?: AssetBundleResourcePermissions | undefined; +} /** + *

An object that contains a list of permissions to be applied to a list of dashboard IDs.

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

A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.

+ * @public + */ + DashboardIds: string[] | undefined; -/** - * @public - * @enum - */ -export const AuthenticationMethodOption = { - ACTIVE_DIRECTORY: "ACTIVE_DIRECTORY", - IAM_AND_QUICKSIGHT: "IAM_AND_QUICKSIGHT", - IAM_IDENTITY_CENTER: "IAM_IDENTITY_CENTER", - IAM_ONLY: "IAM_ONLY", -} as const; + /** + *

A list of permissions for the dashboards that you want to apply overrides to.

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

A structure that contains the link sharing configurations that you want to apply overrides to.

+ * @public + */ + LinkSharingConfiguration?: AssetBundleResourceLinkSharingConfiguration | undefined; +} /** + *

An object that contains a list of tags to be assigned to a list of dashboard IDs.

* @public - * @enum */ -export const ServiceType = { - REDSHIFT: "REDSHIFT", -} as const; +export interface AssetBundleImportJobDashboardOverrideTags { + /** + *

A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.

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

A list of tags for the dashboards that you want to apply overrides to.

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

The authorized targets that are associated with a service.

+ *

The override parameters for a single dataset that is being imported.

* @public */ -export interface AuthorizedTargetsByService { +export interface AssetBundleImportJobDataSetOverrideParameters { /** - *

The name of the Amazon Web Services service.

+ *

The ID of the dataset to apply overrides to.

* @public */ - Service?: ServiceType | undefined; + DataSetId: string | undefined; /** - *

Aist of authorized targets that are represented by IAM Identity Center application ARNs.

+ *

A new name for the dataset.

* @public */ - AuthorizedTargets?: string[] | undefined; + Name?: string | undefined; } /** - * @public - * @enum - */ -export const AuthorSpecifiedAggregation = { - AVERAGE: "AVERAGE", - COUNT: "COUNT", - DISTINCT_COUNT: "DISTINCT_COUNT", - MAX: "MAX", - MEDIAN: "MEDIAN", - MIN: "MIN", - PERCENTILE: "PERCENTILE", - STDEV: "STDEV", - STDEVP: "STDEVP", - SUM: "SUM", - VAR: "VAR", - VARP: "VARP", -} as const; - -/** + *

An object that contains a list of permissions to be applied to a list of dataset IDs.

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

A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.

+ * @public + */ + DataSetIds: string[] | undefined; -/** - * @public - * @enum - */ -export const ContributionAnalysisDirection = { - DECREASE: "DECREASE", - INCREASE: "INCREASE", - NEUTRAL: "NEUTRAL", -} as const; + /** + *

A list of permissions for the datasets that you want to apply overrides to.

+ * @public + */ + Permissions: AssetBundleResourcePermissions | undefined; +} /** + *

An object that contains a list of tags to be assigned to a list of dataset IDs.

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

A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.

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

The definition for the ContributionAnalysisFactor.

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

The field name of the ContributionAnalysisFactor.

+ *

A list of tags for the datasets that you want to apply overrides to.

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

A username and password credential pair to use to import a data source resource.

* @public - * @enum */ -export const ContributionAnalysisSortType = { - ABSOLUTE_DIFFERENCE: "ABSOLUTE_DIFFERENCE", - CONTRIBUTION_PERCENTAGE: "CONTRIBUTION_PERCENTAGE", - DEVIATION_FROM_EXPECTED: "DEVIATION_FROM_EXPECTED", - PERCENTAGE_DIFFERENCE: "PERCENTAGE_DIFFERENCE", -} as const; +export interface AssetBundleImportJobDataSourceCredentialPair { + /** + *

The username for the data source connection.

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

The password for the data source connection.

+ * @public + */ + Password: string | undefined; +} /** - *

The definition for the identifier.

+ *

The login credentials to use to import a data source resource.

* @public */ -export interface Identifier { +export interface AssetBundleImportJobDataSourceCredentials { /** - *

The identity of the identifier.

+ *

A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.

* @public */ - Identity: string | undefined; + CredentialPair?: AssetBundleImportJobDataSourceCredentialPair | undefined; + + /** + *

The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.

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

Parameters for Amazon Athena.

* @public - * @enum */ -export const TopicSortDirection = { - ASCENDING: "ASCENDING", - DESCENDING: "DESCENDING", -} as const; +export interface AthenaParameters { + /** + *

The workgroup that Amazon Athena uses.

+ * @public + */ + WorkGroup?: string | undefined; -/** - * @public - */ -export type TopicSortDirection = (typeof TopicSortDirection)[keyof typeof TopicSortDirection]; + /** + *

Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

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

The definition for the FilterAggMetrics.

+ *

Parameters for Amazon Aurora.

* @public */ -export interface FilterAggMetrics { +export interface AuroraParameters { /** - *

The metric operand of the FilterAggMetrics.

+ *

Host.

* @public */ - MetricOperand?: Identifier | undefined; + Host: string | undefined; /** - *

The function for the FilterAggMetrics.

+ *

Port.

* @public */ - Function?: AggType | undefined; + Port: number | undefined; /** - *

The sort direction for FilterAggMetrics.

+ *

Database.

* @public */ - SortDirection?: TopicSortDirection | undefined; + Database: string | undefined; } /** + *

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

* @public - * @enum */ -export const ConstantType = { - COLLECTIVE: "COLLECTIVE", - RANGE: "RANGE", - SINGULAR: "SINGULAR", -} as const; +export interface AuroraPostgreSqlParameters { + /** + *

The Amazon Aurora PostgreSQL-Compatible host to connect to.

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

The port that Amazon Aurora PostgreSQL is listening on.

+ * @public + */ + Port: number | undefined; + + /** + *

The Amazon Aurora PostgreSQL database to connect to.

+ * @public + */ + Database: string | undefined; +} /** + *

The parameters for IoT Analytics.

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

Dataset name.

+ * @public + */ + DataSetName: string | undefined; +} /** - *

The definition for a CollectiveConstantEntry.

+ *

The parameters that are required to connect to a Google BigQuery data source.

* @public */ -export interface CollectiveConstantEntry { +export interface BigQueryParameters { /** - *

The ConstantType of a CollectiveConstantEntry.

+ *

The Google Cloud Platform project ID where your datasource was created.

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

The value of a CollectiveConstantEntry.

+ *

The storage location where you create a Google BigQuery data source.

* @public */ - Value?: string | undefined; + DataSetRegion?: string | undefined; } /** - *

The definition for a TopicConstantValue.

+ *

The parameters that are required to connect to a Databricks data source.

* @public */ -export interface TopicConstantValue { +export interface DatabricksParameters { /** - *

The constant type of a TopicConstantValue.

+ *

The host name of the Databricks data source.

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

The value of the TopicConstantValue.

+ *

The port for the Databricks data source.

* @public */ - Value?: string | undefined; + Port: number | undefined; /** - *

The minimum for the TopicConstantValue.

+ *

The HTTP path of the Databricks data source.

* @public */ - Minimum?: string | undefined; - + SqlEndpointPath: string | undefined; +} + +/** + *

The required parameters for connecting to an Exasol data source.

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

The maximum for the TopicConstantValue.

+ *

The hostname or IP address of the Exasol data source.

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

The value list of the TopicConstantValue.

+ *

The port for the Exasol data source.

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

The parameters for Jira.

* @public - * @enum - */ -export const FilterClass = { - CONDITIONAL_VALUE_FILTER: "CONDITIONAL_VALUE_FILTER", - ENFORCED_VALUE_FILTER: "ENFORCED_VALUE_FILTER", - NAMED_VALUE_FILTER: "NAMED_VALUE_FILTER", -} as const; - -/** - * @public - */ -export type FilterClass = (typeof FilterClass)[keyof typeof FilterClass]; - -/** - * @public - * @enum - */ -export const TopicIRFilterType = { - ACCEPT_ALL_FILTER: "ACCEPT_ALL_FILTER", - CATEGORY_FILTER: "CATEGORY_FILTER", - DATE_RANGE_FILTER: "DATE_RANGE_FILTER", - EQUALS: "EQUALS", - NUMERIC_EQUALITY_FILTER: "NUMERIC_EQUALITY_FILTER", - NUMERIC_RANGE_FILTER: "NUMERIC_RANGE_FILTER", - RANK_LIMIT_FILTER: "RANK_LIMIT_FILTER", - RELATIVE_DATE_FILTER: "RELATIVE_DATE_FILTER", - TOP_BOTTOM_FILTER: "TOP_BOTTOM_FILTER", -} as const; - -/** - * @public - */ -export type TopicIRFilterType = (typeof TopicIRFilterType)[keyof typeof TopicIRFilterType]; - -/** - * @public - * @enum */ -export const TopicIRFilterFunction = { - CONTAINS: "CONTAINS", - CONTAINS_STRING: "CONTAINS_STRING", - ENDS_WITH: "ENDS_WITH", - EXACT: "EXACT", - LAST: "LAST", - NEXT: "NEXT", - NOW: "NOW", - PREVIOUS: "PREVIOUS", - STARTS_WITH: "STARTS_WITH", - THIS: "THIS", -} as const; +export interface JiraParameters { + /** + *

The base URL of the Jira site.

+ * @public + */ + SiteBaseUrl: string | undefined; +} /** + *

The parameters for MariaDB.

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

Host.

+ * @public + */ + Host: string | undefined; -/** - * @public - * @enum - */ -export const NullFilterOption = { - ALL_VALUES: "ALL_VALUES", - NON_NULLS_ONLY: "NON_NULLS_ONLY", - NULLS_ONLY: "NULLS_ONLY", -} as const; + /** + *

Port.

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

Database.

+ * @public + */ + Database: string | undefined; +} /** - *

The definition for a TopicIRFilterOption.

+ *

The parameters for MySQL.

* @public */ -export interface TopicIRFilterOption { +export interface MySqlParameters { /** - *

The filter type for the TopicIRFilterOption.

+ *

Host.

* @public */ - FilterType?: TopicIRFilterType | undefined; + Host: string | undefined; /** - *

The filter class for the TopicIRFilterOption.

+ *

Port.

* @public */ - FilterClass?: FilterClass | undefined; + Port: number | undefined; /** - *

The operand field for the TopicIRFilterOption.

+ *

Database.

* @public */ - OperandField?: Identifier | undefined; + Database: string | undefined; +} +/** + *

The parameters for Oracle.

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

The function for the TopicIRFilterOption.

+ *

An Oracle host.

* @public */ - Function?: TopicIRFilterFunction | undefined; + Host: string | undefined; /** - *

The constant for the TopicIRFilterOption.

+ *

The port.

* @public */ - Constant?: TopicConstantValue | undefined; + Port: number | undefined; /** - *

The inverse for the TopicIRFilterOption.

+ *

The database.

* @public */ - Inverse?: boolean | undefined; + Database: string | undefined; +} +/** + *

The parameters for PostgreSQL.

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

The null filter for the TopicIRFilterOption.

+ *

Host.

* @public */ - NullFilter?: NullFilterOption | undefined; + Host: string | undefined; /** - *

The aggregation for the TopicIRFilterOption.

+ *

Port.

* @public */ - Aggregation?: AggType | undefined; + Port: number | undefined; /** - *

The aggregation function parameters for the TopicIRFilterOption.

+ *

Database.

* @public */ - AggregationFunctionParameters?: Record | undefined; + Database: string | undefined; +} +/** + *

The parameters for Presto.

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

The AggregationPartitionBy for the TopicIRFilterOption.

+ *

Host.

* @public */ - AggregationPartitionBy?: AggregationPartitionBy[] | undefined; + Host: string | undefined; /** - *

The range for the TopicIRFilterOption.

+ *

Port.

* @public */ - Range?: TopicConstantValue | undefined; + Port: number | undefined; /** - *

The inclusive for the TopicIRFilterOption.

+ *

Catalog.

* @public */ - Inclusive?: boolean | undefined; + Catalog: string | undefined; +} +/** + *

The parameters for Amazon RDS.

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

The time granularity for the TopicIRFilterOption.

+ *

Instance ID.

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

The last next offset for the TopicIRFilterOption.

+ *

Database.

* @public */ - LastNextOffset?: TopicConstantValue | undefined; + Database: string | undefined; +} +/** + *

A structure that grants Amazon QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see + * GetClusterCredentials + * .

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

The agg metrics for the TopicIRFilterOption.

+ *

Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.

* @public */ - AggMetrics?: FilterAggMetrics[] | undefined; + RoleArn: string | undefined; /** - *

The TopBottomLimit for the TopicIRFilterOption.

+ *

The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

* @public */ - TopBottomLimit?: TopicConstantValue | undefined; + DatabaseUser?: string | undefined; /** - *

The sort direction for the TopicIRFilterOption.

+ *

A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.

* @public */ - SortDirection?: TopicSortDirection | undefined; + DatabaseGroups?: string[] | undefined; /** - *

The anchor for the TopicIRFilterOption.

+ *

Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.

* @public */ - Anchor?: Anchor | undefined; + AutoCreateDatabaseUser?: boolean | undefined; } /** - *

The definition for the ContributionAnalysisTimeRanges.

+ *

The parameters for an IAM Identity Center configuration.

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

The start range for the ContributionAnalysisTimeRanges.

- * @public - */ - StartRange?: TopicIRFilterOption | undefined; - +export interface IdentityCenterConfiguration { /** - *

The end range for the ContributionAnalysisTimeRanges.

+ *

A Boolean option that controls whether Trusted Identity Propagation should be used.

* @public */ - EndRange?: TopicIRFilterOption | undefined; + EnableIdentityPropagation?: boolean | undefined; } /** - *

The definition for a TopicIRContributionAnalysis.

+ *

The parameters for Amazon Redshift. The ClusterId field can be blank if + * Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.

* @public */ -export interface TopicIRContributionAnalysis { +export interface RedshiftParameters { /** - *

The factors for a TopicIRContributionAnalysis.

+ *

Host. This field can be blank if ClusterId is provided.

* @public */ - Factors?: ContributionAnalysisFactor[] | undefined; + Host?: string | undefined; /** - *

The time ranges for the TopicIRContributionAnalysis.

+ *

Port. This field can be blank if the ClusterId is provided.

* @public */ - TimeRanges?: ContributionAnalysisTimeRanges | undefined; + Port?: number | undefined; /** - *

The direction for the TopicIRContributionAnalysis.

+ *

Database.

* @public */ - Direction?: ContributionAnalysisDirection | undefined; + Database: string | undefined; /** - *

The sort type for the TopicIRContributionAnalysis.

+ *

Cluster ID. This field can be blank if the Host and Port are + * provided.

* @public */ - SortType?: ContributionAnalysisSortType | undefined; -} + ClusterId?: string | undefined; -/** - * @public - * @enum - */ -export const DisplayFormat = { - AUTO: "AUTO", - CURRENCY: "CURRENCY", - DATE: "DATE", - NUMBER: "NUMBER", - PERCENT: "PERCENT", - STRING: "STRING", -} as const; + /** + *

An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.

+ * @public + */ + IAMParameters?: RedshiftIAMParameters | undefined; + + /** + *

An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.

+ *

This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.

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

Amazon S3 manifest file location.

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

Amazon S3 bucket.

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

Amazon S3 key that identifies an object.

+ * @public + */ + Key: string | undefined; +} + +/** + *

The parameters for S3.

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

Location of the Amazon S3 manifest file. This is NULL if the manifest file was + * uploaded into Amazon QuickSight.

+ * @public + */ + ManifestFileLocation: ManifestFileLocation | undefined; + + /** + *

Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

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

The parameters for ServiceNow.

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

URL of the base site.

+ * @public + */ + SiteBaseUrl: string | undefined; +} /** * @public * @enum */ -export const TopicNumericSeparatorSymbol = { - COMMA: "COMMA", - DOT: "DOT", +export const AuthenticationType = { + PASSWORD: "PASSWORD", + TOKEN: "TOKEN", + X509: "X509", } as const; /** * @public */ -export type TopicNumericSeparatorSymbol = - (typeof TopicNumericSeparatorSymbol)[keyof typeof TopicNumericSeparatorSymbol]; +export type AuthenticationType = (typeof AuthenticationType)[keyof typeof AuthenticationType]; /** - *

A structure that represents a negative format.

+ *

VPC connection properties.

* @public */ -export interface NegativeFormat { +export interface VpcConnectionProperties { /** - *

The prefix for a negative format.

+ *

The Amazon Resource Name (ARN) for the VPC connection.

* @public */ - Prefix?: string | undefined; + VpcConnectionArn: string | undefined; +} +/** + *

An object that contains information needed to create a data source connection that uses OAuth client credentials. This option is available for data source connections that are made with Snowflake and Starburst.

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

The suffix for a negative format.

+ *

The token endpoint URL of the identity provider.

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

The OAuth scope.

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

VPC connection properties.

+ * @public + */ + IdentityProviderVpcConnectionProperties?: VpcConnectionProperties | undefined; + + /** + *

The resource uri of the identity provider.

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

A structure that represents additional options for display formatting.

+ *

The parameters for Snowflake.

* @public */ -export interface DisplayFormatOptions { +export interface SnowflakeParameters { /** - *

A Boolean value that indicates whether to use blank cell format.

+ *

Host.

* @public */ - UseBlankCellFormat?: boolean | undefined; + Host: string | undefined; /** - *

Determines the blank cell format.

+ *

Database.

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

Determines the DateTime format.

+ *

Warehouse.

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

Determines the decimal separator.

+ *

The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.

* @public */ - DecimalSeparator?: TopicNumericSeparatorSymbol | undefined; + AuthenticationType?: AuthenticationType | undefined; /** - *

Determines the grouping separator.

+ *

The database access control role.

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

A Boolean value that indicates whether to use grouping.

+ *

An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake.

* @public */ - UseGrouping?: boolean | undefined; + OAuthParameters?: OAuthParameters | undefined; +} + +/** + *

The parameters for Spark.

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

Host.

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

Port.

+ * @public + */ + Port: number | undefined; +} + +/** + *

The parameters for SQL Server.

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

Host.

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

Port.

+ * @public + */ + Port: number | undefined; + + /** + *

Database.

+ * @public + */ + Database: string | undefined; +} + +/** + * @public + * @enum + */ +export const StarburstProductType = { + ENTERPRISE: "ENTERPRISE", + GALAXY: "GALAXY", +} as const; + +/** + * @public + */ +export type StarburstProductType = (typeof StarburstProductType)[keyof typeof StarburstProductType]; + +/** + *

The parameters that are required to connect to a Starburst data source.

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

The host name of the Starburst data source.

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

The port for the Starburst data source.

+ * @public + */ + Port: number | undefined; + + /** + *

The catalog name for the Starburst data source.

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

The product type for the Starburst data source.

+ * @public + */ + ProductType?: StarburstProductType | undefined; + + /** + *

The database access control role.

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

The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.

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

An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.

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

The parameters for Teradata.

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

Host.

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

Port.

+ * @public + */ + Port: number | undefined; + + /** + *

Database.

+ * @public + */ + Database: string | undefined; +} + +/** + *

The parameters that are required to connect to a Trino data source.

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

The host name of the Trino data source.

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

The port for the Trino data source.

+ * @public + */ + Port: number | undefined; + + /** + *

The catalog name for the Trino data source.

+ * @public + */ + Catalog: string | undefined; +} + +/** + *

The parameters for Twitter.

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

Twitter query string.

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

Maximum number of rows to query Twitter.

+ * @public + */ + MaxRows: number | undefined; +} + +/** + *

The parameters that Amazon QuickSight uses to connect to your underlying data 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 DataSourceParameters = + | DataSourceParameters.AmazonElasticsearchParametersMember + | DataSourceParameters.AmazonOpenSearchParametersMember + | DataSourceParameters.AthenaParametersMember + | DataSourceParameters.AuroraParametersMember + | DataSourceParameters.AuroraPostgreSqlParametersMember + | DataSourceParameters.AwsIotAnalyticsParametersMember + | DataSourceParameters.BigQueryParametersMember + | DataSourceParameters.DatabricksParametersMember + | DataSourceParameters.ExasolParametersMember + | DataSourceParameters.JiraParametersMember + | DataSourceParameters.MariaDbParametersMember + | DataSourceParameters.MySqlParametersMember + | DataSourceParameters.OracleParametersMember + | DataSourceParameters.PostgreSqlParametersMember + | DataSourceParameters.PrestoParametersMember + | DataSourceParameters.RdsParametersMember + | DataSourceParameters.RedshiftParametersMember + | DataSourceParameters.S3ParametersMember + | DataSourceParameters.ServiceNowParametersMember + | DataSourceParameters.SnowflakeParametersMember + | DataSourceParameters.SparkParametersMember + | DataSourceParameters.SqlServerParametersMember + | DataSourceParameters.StarburstParametersMember + | DataSourceParameters.TeradataParametersMember + | DataSourceParameters.TrinoParametersMember + | DataSourceParameters.TwitterParametersMember + | DataSourceParameters.$UnknownMember; + +/** + * @public + */ +export namespace DataSourceParameters { + /** + *

The parameters for OpenSearch.

+ * @public + */ + export interface AmazonElasticsearchParametersMember { + AmazonElasticsearchParameters: AmazonElasticsearchParameters; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for Amazon Athena.

+ * @public + */ + export interface AthenaParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters: AthenaParameters; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for Amazon Aurora MySQL.

+ * @public + */ + export interface AuroraParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters: AuroraParameters; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for Amazon Aurora.

+ * @public + */ + export interface AuroraPostgreSqlParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters: AuroraPostgreSqlParameters; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for IoT Analytics.

+ * @public + */ + export interface AwsIotAnalyticsParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters: AwsIotAnalyticsParameters; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for Jira.

+ * @public + */ + export interface JiraParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters: JiraParameters; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for MariaDB.

+ * @public + */ + export interface MariaDbParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters: MariaDbParameters; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for MySQL.

+ * @public + */ + export interface MySqlParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters: MySqlParameters; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for Oracle.

+ * @public + */ + export interface OracleParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters: OracleParameters; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for PostgreSQL.

+ * @public + */ + export interface PostgreSqlParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters: PostgreSqlParameters; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for Presto.

+ * @public + */ + export interface PrestoParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters: PrestoParameters; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for Amazon RDS.

+ * @public + */ + export interface RdsParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters: RdsParameters; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for Amazon Redshift.

+ * @public + */ + export interface RedshiftParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters: RedshiftParameters; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for S3.

+ * @public + */ + export interface S3ParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters: S3Parameters; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for ServiceNow.

+ * @public + */ + export interface ServiceNowParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters: ServiceNowParameters; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for Snowflake.

+ * @public + */ + export interface SnowflakeParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters: SnowflakeParameters; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for Spark.

+ * @public + */ + export interface SparkParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters: SparkParameters; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for SQL Server.

+ * @public + */ + export interface SqlServerParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters: SqlServerParameters; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for Teradata.

+ * @public + */ + export interface TeradataParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters: TeradataParameters; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for Twitter.

+ * @public + */ + export interface TwitterParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters: TwitterParameters; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for OpenSearch.

+ * @public + */ + export interface AmazonOpenSearchParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters: AmazonOpenSearchParameters; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters for Exasol.

+ * @public + */ + export interface ExasolParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters: ExasolParameters; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters that are required to connect to a Databricks data source.

+ * @public + */ + export interface DatabricksParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters: DatabricksParameters; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters that are required to connect to a Starburst data source.

+ * @public + */ + export interface StarburstParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters: StarburstParameters; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters that are required to connect to a Trino data source.

+ * @public + */ + export interface TrinoParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters: TrinoParameters; + BigQueryParameters?: never; + $unknown?: never; + } + + /** + *

The parameters that are required to connect to a Google BigQuery data source.

+ * @public + */ + export interface BigQueryParametersMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters: BigQueryParameters; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + AmazonElasticsearchParameters?: never; + AthenaParameters?: never; + AuroraParameters?: never; + AuroraPostgreSqlParameters?: never; + AwsIotAnalyticsParameters?: never; + JiraParameters?: never; + MariaDbParameters?: never; + MySqlParameters?: never; + OracleParameters?: never; + PostgreSqlParameters?: never; + PrestoParameters?: never; + RdsParameters?: never; + RedshiftParameters?: never; + S3Parameters?: never; + ServiceNowParameters?: never; + SnowflakeParameters?: never; + SparkParameters?: never; + SqlServerParameters?: never; + TeradataParameters?: never; + TwitterParameters?: never; + AmazonOpenSearchParameters?: never; + ExasolParameters?: never; + DatabricksParameters?: never; + StarburstParameters?: never; + TrinoParameters?: never; + BigQueryParameters?: never; + $unknown: [string, any]; + } + + export interface Visitor { + AmazonElasticsearchParameters: (value: AmazonElasticsearchParameters) => T; + AthenaParameters: (value: AthenaParameters) => T; + AuroraParameters: (value: AuroraParameters) => T; + AuroraPostgreSqlParameters: (value: AuroraPostgreSqlParameters) => T; + AwsIotAnalyticsParameters: (value: AwsIotAnalyticsParameters) => T; + JiraParameters: (value: JiraParameters) => T; + MariaDbParameters: (value: MariaDbParameters) => T; + MySqlParameters: (value: MySqlParameters) => T; + OracleParameters: (value: OracleParameters) => T; + PostgreSqlParameters: (value: PostgreSqlParameters) => T; + PrestoParameters: (value: PrestoParameters) => T; + RdsParameters: (value: RdsParameters) => T; + RedshiftParameters: (value: RedshiftParameters) => T; + S3Parameters: (value: S3Parameters) => T; + ServiceNowParameters: (value: ServiceNowParameters) => T; + SnowflakeParameters: (value: SnowflakeParameters) => T; + SparkParameters: (value: SparkParameters) => T; + SqlServerParameters: (value: SqlServerParameters) => T; + TeradataParameters: (value: TeradataParameters) => T; + TwitterParameters: (value: TwitterParameters) => T; + AmazonOpenSearchParameters: (value: AmazonOpenSearchParameters) => T; + ExasolParameters: (value: ExasolParameters) => T; + DatabricksParameters: (value: DatabricksParameters) => T; + StarburstParameters: (value: StarburstParameters) => T; + TrinoParameters: (value: TrinoParameters) => T; + BigQueryParameters: (value: BigQueryParameters) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: DataSourceParameters, visitor: Visitor): T => { + if (value.AmazonElasticsearchParameters !== undefined) + return visitor.AmazonElasticsearchParameters(value.AmazonElasticsearchParameters); + if (value.AthenaParameters !== undefined) return visitor.AthenaParameters(value.AthenaParameters); + if (value.AuroraParameters !== undefined) return visitor.AuroraParameters(value.AuroraParameters); + if (value.AuroraPostgreSqlParameters !== undefined) + return visitor.AuroraPostgreSqlParameters(value.AuroraPostgreSqlParameters); + if (value.AwsIotAnalyticsParameters !== undefined) + return visitor.AwsIotAnalyticsParameters(value.AwsIotAnalyticsParameters); + if (value.JiraParameters !== undefined) return visitor.JiraParameters(value.JiraParameters); + if (value.MariaDbParameters !== undefined) return visitor.MariaDbParameters(value.MariaDbParameters); + if (value.MySqlParameters !== undefined) return visitor.MySqlParameters(value.MySqlParameters); + if (value.OracleParameters !== undefined) return visitor.OracleParameters(value.OracleParameters); + if (value.PostgreSqlParameters !== undefined) return visitor.PostgreSqlParameters(value.PostgreSqlParameters); + if (value.PrestoParameters !== undefined) return visitor.PrestoParameters(value.PrestoParameters); + if (value.RdsParameters !== undefined) return visitor.RdsParameters(value.RdsParameters); + if (value.RedshiftParameters !== undefined) return visitor.RedshiftParameters(value.RedshiftParameters); + if (value.S3Parameters !== undefined) return visitor.S3Parameters(value.S3Parameters); + if (value.ServiceNowParameters !== undefined) return visitor.ServiceNowParameters(value.ServiceNowParameters); + if (value.SnowflakeParameters !== undefined) return visitor.SnowflakeParameters(value.SnowflakeParameters); + if (value.SparkParameters !== undefined) return visitor.SparkParameters(value.SparkParameters); + if (value.SqlServerParameters !== undefined) return visitor.SqlServerParameters(value.SqlServerParameters); + if (value.TeradataParameters !== undefined) return visitor.TeradataParameters(value.TeradataParameters); + if (value.TwitterParameters !== undefined) return visitor.TwitterParameters(value.TwitterParameters); + if (value.AmazonOpenSearchParameters !== undefined) + return visitor.AmazonOpenSearchParameters(value.AmazonOpenSearchParameters); + if (value.ExasolParameters !== undefined) return visitor.ExasolParameters(value.ExasolParameters); + if (value.DatabricksParameters !== undefined) return visitor.DatabricksParameters(value.DatabricksParameters); + if (value.StarburstParameters !== undefined) return visitor.StarburstParameters(value.StarburstParameters); + if (value.TrinoParameters !== undefined) return visitor.TrinoParameters(value.TrinoParameters); + if (value.BigQueryParameters !== undefined) return visitor.BigQueryParameters(value.BigQueryParameters); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} +/** + *

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your + * underlying data source.

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

Determines the number of fraction digits.

+ *

A Boolean option to control whether SSL should be disabled.

* @public */ - FractionDigits?: number | undefined; + DisableSsl?: boolean | undefined; +} +/** + *

The override parameters for a single data source that is being imported.

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

The prefix value for a display format.

+ *

The ID of the data source to apply overrides to.

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

The suffix value for a display format.

+ *

A new name for the data source.

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

The unit scaler. Valid values for this structure are: NONE, - * AUTO, THOUSANDS, MILLIONS, - * BILLIONS, - * and TRILLIONS.

+ *

The parameters that Amazon QuickSight uses to connect to your underlying data source. + * This is a variant type structure. For this structure to be valid, only one of the + * attributes can be non-null.

* @public */ - UnitScaler?: NumberScale | undefined; + DataSourceParameters?: DataSourceParameters | undefined; /** - *

The negative format.

+ *

VPC connection properties.

* @public */ - NegativeFormat?: NegativeFormat | undefined; + VpcConnectionProperties?: VpcConnectionProperties | undefined; /** - *

The currency symbol, such as USD.

+ *

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your + * underlying data source.

* @public */ - CurrencySymbol?: string | undefined; -} + SslProperties?: SslProperties | undefined; -/** - *

The definition for a NamedEntityRef.

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

The NamedEntityName for the NamedEntityRef.

+ *

An optional structure that provides the credentials to be used to create the imported data source.

* @public */ - NamedEntityName?: string | undefined; + Credentials?: AssetBundleImportJobDataSourceCredentials | undefined; } /** - *

The definition for a TopicSortClause.

+ *

An object that contains a list of permissions to be applied to a list of data source IDs.

* @public */ -export interface TopicSortClause { +export interface AssetBundleImportJobDataSourceOverridePermissions { /** - *

The operand for a TopicSortClause.

+ *

A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.

* @public */ - Operand?: Identifier | undefined; + DataSourceIds: string[] | undefined; /** - *

The sort direction for the TopicSortClause.

+ *

A list of permissions for the data source that you want to apply overrides to.

* @public */ - SortDirection?: TopicSortDirection | undefined; + Permissions: AssetBundleResourcePermissions | undefined; } /** - *

The definition for a TopicIRGroupBy.

+ *

An object that contains a list of tags to be assigned to a list of data source IDs.

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

The field name for the TopicIRGroupBy.

- * @public - */ - FieldName?: Identifier | undefined; - +export interface AssetBundleImportJobDataSourceOverrideTags { /** - *

The time granularity for the TopicIRGroupBy.

+ *

A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.

* @public */ - TimeGranularity?: TopicTimeGranularity | undefined; + DataSourceIds: string[] | undefined; /** - *

The sort for the TopicIRGroupBy.

+ *

A list of tags for the data source that you want to apply overrides to.

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

Describes an error that occurred within an Asset Bundle import execution.

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

The display format for the TopicIRGroupBy.

+ *

The ARN of the resource whose processing caused an error.

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

A structure that represents additional options for display formatting.

+ *

The specific error type or the error that occurred.

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

The named entity for the TopicIRGroupBy.

+ *

A description of the error.

* @public */ - NamedEntity?: NamedEntityRef | undefined; + Message?: string | undefined; } /** - * @public - * @enum - */ -export const ComparisonMethodType = { - DIFF: "DIFF", - DIFF_AS_PERC: "DIFF_AS_PERC", - MOVING_AVERAGE: "MOVING_AVERAGE", - PERCENT_OF_TOTAL: "PERCENT_OF_TOTAL", - PERC_DIFF: "PERC_DIFF", - POP_CURRENT_DIFF: "POP_CURRENT_DIFF", - POP_CURRENT_DIFF_AS_PERC: "POP_CURRENT_DIFF_AS_PERC", - POP_OVERTIME_DIFF: "POP_OVERTIME_DIFF", - POP_OVERTIME_DIFF_AS_PERC: "POP_OVERTIME_DIFF_AS_PERC", - RUNNING_SUM: "RUNNING_SUM", -} as const; - -/** - * @public - */ -export type ComparisonMethodType = (typeof ComparisonMethodType)[keyof typeof ComparisonMethodType]; - -/** - *

The definition of a TopicIRComparisonMethod.

+ *

The override parameters for a single folder that is being imported.

* @public */ -export interface TopicIRComparisonMethod { +export interface AssetBundleImportJobFolderOverrideParameters { /** - *

The type for the TopicIRComparisonMethod.

+ *

The ID of the folder that you want to apply overrides to.

* @public */ - Type?: ComparisonMethodType | undefined; + FolderId: string | undefined; /** - *

The period for the TopicIRComparisonMethod.

+ *

A new name for the folder.

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

The window size for the TopicIRComparisonMethod.

+ *

A new parent folder arn. This change can only be applied if the import creates a brand new folder. Existing folders cannot be moved.

* @public */ - WindowSize?: number | undefined; + ParentFolderArn?: string | undefined; } /** - *

The definition for a TopicIRMetric.

+ *

An object that contains a list of permissions to be applied to a list of folder IDs.

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

The metric ID for the TopicIRMetric.

- * @public - */ - MetricId?: Identifier | undefined; - +export interface AssetBundleImportJobFolderOverridePermissions { /** - *

The function for the TopicIRMetric.

+ *

A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.

* @public */ - Function?: AggFunction | undefined; + FolderIds: string[] | undefined; /** - *

The operands for the TopicIRMetric.

+ *

A structure that contains the permissions for the resource that you want to override in an asset bundle import job.

* @public */ - Operands?: Identifier[] | undefined; + Permissions?: AssetBundleResourcePermissions | undefined; +} +/** + *

An object that contains a list of tags to be assigned to a list of folder IDs.

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

The comparison method for the TopicIRMetric.

+ *

A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.

* @public */ - ComparisonMethod?: TopicIRComparisonMethod | undefined; + FolderIds: string[] | undefined; /** - *

The expression for the TopicIRMetric.

+ *

A list of tags for the folders that you want to apply overrides to.

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

A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.

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

The calculated field references for the TopicIRMetric.

+ *

A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.

* @public */ - CalculatedFieldReferences?: Identifier[] | undefined; + DataSetId: string | undefined; /** - *

The display format for the TopicIRMetric.

+ *

A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.

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

A structure that represents additional options for display formatting.

+ *

An override for the StartAfterDateTime of a RefreshSchedule. Make + * sure that the StartAfterDateTime is set to a time that takes + * place in the future.

* @public */ - DisplayFormatOptions?: DisplayFormatOptions | undefined; + StartAfterDateTime?: Date | undefined; +} +/** + *

An optional structure that configures resource ID overrides for the import job.

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

The named entity for the TopicIRMetric.

+ *

An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

* @public */ - NamedEntity?: NamedEntityRef | undefined; + PrefixForAllResources?: string | undefined; } /** - *

The definition for a VisualOptions.

+ *

The override parameters for a single theme that is imported.

* @public */ -export interface VisualOptions { +export interface AssetBundleImportJobThemeOverrideParameters { /** - *

The type for a VisualOptions.

+ *

The ID of the theme to apply overrides to.

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

A new name for the theme.

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

The definition for a TopicIR.

+ *

The override parameters for a single VPC connection that is imported.

* @public */ -export interface TopicIR { +export interface AssetBundleImportJobVPCConnectionOverrideParameters { /** - *

The metrics for the TopicIR.

+ *

The ID of the VPC Connection to apply overrides to.

* @public */ - Metrics?: TopicIRMetric[] | undefined; + VPCConnectionId: string | undefined; /** - *

The GroupBy list for the TopicIR.

+ *

A new name for the VPC connection.

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

The filters for the TopicIR.

+ *

A list of new subnet IDs for the VPC connection you are importing. This field is + * required if you are importing the VPC connection from another Amazon Web Services account or Region.

* @public */ - Filters?: TopicIRFilterOption[][] | undefined; + SubnetIds?: string[] | undefined; /** - *

The sort for the TopicIR.

+ *

A new security group ID for the VPC connection you are importing. This field is required + * if you are importing the VPC connection from another Amazon Web Services account or Region.

* @public */ - Sort?: TopicSortClause | undefined; + SecurityGroupIds?: string[] | undefined; /** - *

The contribution analysis for the TopicIR.

+ *

An optional override of DNS resolvers to be used by the VPC connection.

* @public */ - ContributionAnalysis?: TopicIRContributionAnalysis | undefined; + DnsResolvers?: string[] | undefined; /** - *

The visual for the TopicIR.

+ *

An optional override of the role ARN to be used by the VPC connection.

* @public */ - Visual?: VisualOptions | undefined; -} - -/** - * @public - * @enum - */ -export const VisualRole = { - COMPLIMENTARY: "COMPLIMENTARY", - FALLBACK: "FALLBACK", - FRAGMENT: "FRAGMENT", - MULTI_INTENT: "MULTI_INTENT", - PRIMARY: "PRIMARY", -} as const; + RoleArn?: string | undefined; +} /** + *

A list of overrides that modify the asset bundle resource configuration before the resource is imported.

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

An optional structure that configures resource ID overrides to be applied within the import job.

+ * @public + */ + ResourceIdOverrideConfiguration?: AssetBundleImportJobResourceIdOverrideConfiguration | undefined; -/** - *

The definition for the slot.

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

The slot ID of the slot.

+ *

A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.

* @public */ - SlotId?: string | undefined; + VPCConnections?: AssetBundleImportJobVPCConnectionOverrideParameters[] | undefined; /** - *

The visual ID for the slot.

+ *

A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.

* @public */ - VisualId?: string | undefined; -} + RefreshSchedules?: AssetBundleImportJobRefreshScheduleOverrideParameters[] | undefined; -/** - *

The definition for a TopicTemplate.

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

The template type for the TopicTemplate.

+ *

A list of overrides for any DataSource resources that are present in the asset bundle that is imported.

* @public */ - TemplateType?: string | undefined; + DataSources?: AssetBundleImportJobDataSourceOverrideParameters[] | undefined; /** - *

The slots for the TopicTemplate.

+ *

A list of overrides for any DataSet resources that are present in the asset bundle that is imported.

* @public */ - Slots?: Slot[] | undefined; -} + DataSets?: AssetBundleImportJobDataSetOverrideParameters[] | undefined; -/** - * @public - * @enum - */ -export const ReviewedAnswerErrorCode = { - DATASET_DOES_NOT_EXIST: "DATASET_DOES_NOT_EXIST", - DUPLICATED_ANSWER: "DUPLICATED_ANSWER", - INTERNAL_ERROR: "INTERNAL_ERROR", - INVALID_DATA: "INVALID_DATA", - INVALID_DATASET_ARN: "INVALID_DATASET_ARN", - MISSING_ANSWER: "MISSING_ANSWER", - MISSING_REQUIRED_FIELDS: "MISSING_REQUIRED_FIELDS", -} as const; + /** + *

A list of overrides for any Theme resources that are present in the asset bundle that is imported.

+ * @public + */ + Themes?: AssetBundleImportJobThemeOverrideParameters[] | undefined; -/** - * @public - */ -export type ReviewedAnswerErrorCode = (typeof ReviewedAnswerErrorCode)[keyof typeof ReviewedAnswerErrorCode]; + /** + *

A list of overrides for any Analysis resources that are present in the asset bundle that is imported.

+ * @public + */ + Analyses?: AssetBundleImportJobAnalysisOverrideParameters[] | undefined; -/** - *

The definition for a InvalidTopicReviewedAnswer.

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

The answer ID for the InvalidTopicReviewedAnswer.

+ *

A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.

* @public */ - AnswerId?: string | undefined; + Dashboards?: AssetBundleImportJobDashboardOverrideParameters[] | undefined; /** - *

The error that is returned for the InvalidTopicReviewedAnswer.

+ *

A list of overrides for any Folder resources that are present in the asset bundle that is imported.

* @public */ - Error?: ReviewedAnswerErrorCode | undefined; + Folders?: AssetBundleImportJobFolderOverrideParameters[] | undefined; } /** - *

The definition for a SucceededTopicReviewedAnswer.

+ *

An object that contains a list of permissions to be applied to a list of theme IDs.

* @public */ -export interface SucceededTopicReviewedAnswer { +export interface AssetBundleImportJobThemeOverridePermissions { /** - *

The answer ID for the SucceededTopicReviewedAnswer.

+ *

A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.

* @public */ - AnswerId?: string | undefined; + ThemeIds: string[] | undefined; + + /** + *

A list of permissions for the themes that you want to apply overrides to.

+ * @public + */ + Permissions: AssetBundleResourcePermissions | undefined; } /** + *

A structure that contains the override permission configurations that modify the permissions for specified resources before the resource is imported.

* @public */ -export interface BatchCreateTopicReviewedAnswerResponse { +export interface AssetBundleImportJobOverridePermissions { /** - *

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region - * for each Amazon Web Services account.

+ *

A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.

* @public */ - TopicId?: string | undefined; + DataSources?: AssetBundleImportJobDataSourceOverridePermissions[] | undefined; /** - *

The Amazon Resource Name (ARN) of the topic.

+ *

A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.

* @public */ - TopicArn?: string | undefined; + DataSets?: AssetBundleImportJobDataSetOverridePermissions[] | undefined; /** - *

The definition of Answers that are successfully created.

+ *

A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.

* @public */ - SucceededAnswers?: SucceededTopicReviewedAnswer[] | undefined; + Themes?: AssetBundleImportJobThemeOverridePermissions[] | undefined; /** - *

The definition of Answers that are invalid and not created.

+ *

A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.

* @public */ - InvalidAnswers?: InvalidTopicReviewedAnswer[] | undefined; + Analyses?: AssetBundleImportJobAnalysisOverridePermissions[] | undefined; /** - *

The HTTP status of the request.

+ *

A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.

* @public */ - Status?: number | undefined; + Dashboards?: AssetBundleImportJobDashboardOverridePermissions[] | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

A list of permissions for the folders that you want to apply overrides to.

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

An internal failure occurred.

+ *

An object that contains a list of tags to be assigned to a list of theme IDs.

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

The Amazon Web Services request ID for this request.

+ *

A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.

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

A list of tags for the themes that you want to apply overrides to.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "InternalFailureException", - $fault: "server", - ...opts, - }); - Object.setPrototypeOf(this, InternalFailureException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } + Tags: Tag[] | undefined; } /** - *

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

+ *

An object that contains a list of tags to be assigned to a list of VPC connection IDs.

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

The Amazon Web Services request ID for this request.

+ *

A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.

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

A list of tags for the VPC connections that you want to apply overrides to.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "InvalidParameterValueException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, InvalidParameterValueException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } + Tags: Tag[] | undefined; } /** - * @public - * @enum - */ -export const ExceptionResourceType = { - ACCOUNT_SETTINGS: "ACCOUNT_SETTINGS", - DATA_SET: "DATA_SET", - DATA_SOURCE: "DATA_SOURCE", - GROUP: "GROUP", - IAMPOLICY_ASSIGNMENT: "IAMPOLICY_ASSIGNMENT", - INGESTION: "INGESTION", - NAMESPACE: "NAMESPACE", - USER: "USER", - VPC_CONNECTION: "VPC_CONNECTION", -} as const; - -/** - * @public - */ -export type ExceptionResourceType = (typeof ExceptionResourceType)[keyof typeof ExceptionResourceType]; - -/** - *

One or more resources can't be found.

+ *

A structure that contains the override tag configuration that modify the tags that are assigned to specified resources before the resource is imported.

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

The resource type for this request.

+ *

A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.

* @public */ - ResourceType?: ExceptionResourceType | undefined; + VPCConnections?: AssetBundleImportJobVPCConnectionOverrideTags[] | undefined; /** - *

The Amazon Web Services request ID for this request.

+ *

A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.

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

Access is throttled.

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

The Amazon Web Services request ID for this request.

+ *

A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.

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

A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.

+ * @public + */ + Themes?: AssetBundleImportJobThemeOverrideTags[] | undefined; -/** - * @public - */ -export interface BatchDeleteTopicReviewedAnswerRequest { /** - *

The ID of the Amazon Web Services account that you want to delete a reviewed answers in.

+ *

A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.

* @public */ - AwsAccountId: string | undefined; + Analyses?: AssetBundleImportJobAnalysisOverrideTags[] | undefined; /** - *

The ID for the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.

* @public */ - TopicId: string | undefined; + Dashboards?: AssetBundleImportJobDashboardOverrideTags[] | undefined; /** - *

The Answer IDs of the Answers to be deleted.

+ *

A list of tag overrides for any Folder resources that are present in the asset bundle that is imported.

* @public */ - AnswerIds?: string[] | undefined; + Folders?: AssetBundleImportJobFolderOverrideTags[] | undefined; } /** + *

An optional parameter that overrides the validation strategy for all analyses and dashboards before the resource is imported.

* @public */ -export interface BatchDeleteTopicReviewedAnswerResponse { +export interface AssetBundleImportJobOverrideValidationStrategy { /** - *

The ID of the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.

* @public */ - TopicId?: string | undefined; + StrictModeForAllResources?: boolean | undefined; +} + +/** + * @public + * @enum + */ +export const AssetBundleImportJobStatus = { + FAILED: "FAILED", + FAILED_ROLLBACK_COMPLETED: "FAILED_ROLLBACK_COMPLETED", + FAILED_ROLLBACK_ERROR: "FAILED_ROLLBACK_ERROR", + FAILED_ROLLBACK_IN_PROGRESS: "FAILED_ROLLBACK_IN_PROGRESS", + IN_PROGRESS: "IN_PROGRESS", + QUEUED_FOR_IMMEDIATE_EXECUTION: "QUEUED_FOR_IMMEDIATE_EXECUTION", + SUCCESSFUL: "SUCCESSFUL", +} as const; + +/** + * @public + */ +export type AssetBundleImportJobStatus = (typeof AssetBundleImportJobStatus)[keyof typeof AssetBundleImportJobStatus]; +/** + *

A summary of the import job that includes details of the requested job's configuration and its current status.

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

The Amazon Resource Name (ARN) of the topic.

+ *

The current status of the import job.

* @public */ - TopicArn?: string | undefined; + JobStatus?: AssetBundleImportJobStatus | undefined; /** - *

The definition of Answers that are successfully deleted.

+ *

The ARN of the import job.

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

The definition of Answers that are invalid and not deleted.

+ *

The time that the import job was created.

* @public */ - InvalidAnswers?: InvalidTopicReviewedAnswer[] | undefined; + CreatedTime?: Date | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

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

The HTTP status of the request.

+ *

The failure action for the import job.

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

Updating or deleting a resource can cause an inconsistent state.

+ *

Describes a warning that occurred during an Asset Bundle import job.

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

The Amazon Web Services request ID for this request.

+ *

The ARN of the resource that the warning occurred for.

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

A description of the warning that occurred during an Asset Bundle import job.

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

The bookmarks configuration of an embedded dashboard.

+ *

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.

* @public */ -export interface BookmarksConfigurations { +export interface AssetBundleImportSource { /** - *

A Boolean value that determines whether a user - * can bookmark an embedded dashboard.

+ *

The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB. If the size of the file that you want to upload is more than 20 MB, add the file to your Amazon S3 bucket and use S3Uri of the file for this operation.

+ *

If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using an SDK for a different language or receiving related errors, try to base64 encode your data.

* @public */ - Enabled: boolean | undefined; + Body?: Uint8Array | undefined; + + /** + *

The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read access to. The file must be a zip format file and can't exceed 1 GB.

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

The display options for tile borders for visuals.

+ *

A description of the import source that you provide at the start of an import job. This value is set to either Body or S3Uri, depending on how the StartAssetBundleImportJobRequest is configured.

* @public */ -export interface BorderStyle { +export interface AssetBundleImportSourceDescription { /** - *

The option to enable display of borders for visuals.

+ *

An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.

* @public */ - Show?: boolean | undefined; + Body?: string | undefined; + + /** + *

The Amazon S3 URI that you provided at the start of the import job.

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

The source of the image.

* @public + * @enum */ -export type ImageSource = ImageSource.PublicUrlMember | ImageSource.S3UriMember | ImageSource.$UnknownMember; +export const AssignmentStatus = { + DISABLED: "DISABLED", + DRAFT: "DRAFT", + ENABLED: "ENABLED", +} as const; /** * @public */ -export namespace ImageSource { +export type AssignmentStatus = (typeof AssignmentStatus)[keyof typeof AssignmentStatus]; + +/** + * @public + * @enum + */ +export const AuthenticationMethodOption = { + ACTIVE_DIRECTORY: "ACTIVE_DIRECTORY", + IAM_AND_QUICKSIGHT: "IAM_AND_QUICKSIGHT", + IAM_IDENTITY_CENTER: "IAM_IDENTITY_CENTER", + IAM_ONLY: "IAM_ONLY", +} as const; + +/** + * @public + */ +export type AuthenticationMethodOption = (typeof AuthenticationMethodOption)[keyof typeof AuthenticationMethodOption]; + +/** + * @public + * @enum + */ +export const ServiceType = { + REDSHIFT: "REDSHIFT", +} as const; + +/** + * @public + */ +export type ServiceType = (typeof ServiceType)[keyof typeof ServiceType]; + +/** + *

The authorized targets that are associated with a service.

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

The public URL that points to the source image.

+ *

The name of the Amazon Web Services service.

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

The Amazon S3 URI that points to the source image.

+ *

Aist of authorized targets that are represented by IAM Identity Center application ARNs.

* @public */ - export interface S3UriMember { - PublicUrl?: never; - S3Uri: string; - $unknown?: never; - } + AuthorizedTargets?: string[] | undefined; +} + +/** + * @public + * @enum + */ +export const AuthorSpecifiedAggregation = { + AVERAGE: "AVERAGE", + COUNT: "COUNT", + 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 AuthorSpecifiedAggregation = (typeof AuthorSpecifiedAggregation)[keyof typeof AuthorSpecifiedAggregation]; + +/** + * @public + * @enum + */ +export const ContributionAnalysisDirection = { + DECREASE: "DECREASE", + INCREASE: "INCREASE", + NEUTRAL: "NEUTRAL", +} as const; +/** + * @public + */ +export type ContributionAnalysisDirection = + (typeof ContributionAnalysisDirection)[keyof typeof ContributionAnalysisDirection]; + +/** + *

The definition for the ContributionAnalysisFactor.

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

The field name of the ContributionAnalysisFactor.

* @public */ - 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]); - }; + FieldName?: string | undefined; } /** - *

The logo image configuration.

+ * @public + * @enum + */ +export const ContributionAnalysisSortType = { + ABSOLUTE_DIFFERENCE: "ABSOLUTE_DIFFERENCE", + CONTRIBUTION_PERCENTAGE: "CONTRIBUTION_PERCENTAGE", + DEVIATION_FROM_EXPECTED: "DEVIATION_FROM_EXPECTED", + PERCENTAGE_DIFFERENCE: "PERCENTAGE_DIFFERENCE", +} as const; + +/** * @public */ -export interface ImageConfiguration { - /** - *

The source of the image.

- * @public - */ - Source?: ImageSource | undefined; -} +export type ContributionAnalysisSortType = + (typeof ContributionAnalysisSortType)[keyof typeof ContributionAnalysisSortType]; /** - *

The image set configuration.

+ *

The definition for the identifier.

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

The original image.

+ *

The identity of the identifier.

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

The logo set configuration.

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

The primary logo.

- * @public - */ - Primary: ImageSetConfiguration | undefined; - - /** - *

The favicon logo.

- * @public - */ - Favicon?: ImageSetConfiguration | undefined; -} +export const TopicSortDirection = { + ASCENDING: "ASCENDING", + DESCENDING: "DESCENDING", +} as const; /** - *

The logo configuration.

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

The alt text for the logo.

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

A set of configured logos.

- * @public - */ - LogoSet: LogoSetConfiguration | undefined; -} +export type TopicSortDirection = (typeof TopicSortDirection)[keyof typeof TopicSortDirection]; /** - *

The definition of the brand.

+ *

The definition for the FilterAggMetrics.

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

The name of the brand.

- * @public - */ - BrandName: string | undefined; - +export interface FilterAggMetrics { /** - *

The description of the brand.

+ *

The metric operand of the FilterAggMetrics.

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

The application theme of the brand.

+ *

The function for the FilterAggMetrics.

* @public */ - ApplicationTheme?: ApplicationTheme | undefined; + Function?: AggType | undefined; /** - *

The logo configuration of the brand.

+ *

The sort direction for FilterAggMetrics.

* @public */ - LogoConfiguration?: LogoConfiguration | undefined; + SortDirection?: TopicSortDirection | undefined; } /** * @public * @enum */ -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", +export const ConstantType = { + COLLECTIVE: "COLLECTIVE", + RANGE: "RANGE", + SINGULAR: "SINGULAR", } as const; /** * @public */ -export type BrandStatus = (typeof BrandStatus)[keyof typeof BrandStatus]; +export type ConstantType = (typeof ConstantType)[keyof typeof ConstantType]; /** - *

The logo image.

+ *

The definition for a CollectiveConstantEntry.

* @public */ -export interface Image { +export interface CollectiveConstantEntry { /** - *

The source of the logo image.

+ *

The ConstantType of a CollectiveConstantEntry.

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

The URL that points to the generated logo image.

+ *

The value of a CollectiveConstantEntry.

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

The image set.

+ *

The definition for a TopicConstantValue.

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

The original image.

+ *

The constant type of a TopicConstantValue.

* @public */ - Original: Image | undefined; + ConstantType?: ConstantType | undefined; /** - *

The image with the height set to 64 pixels.

+ *

The value of the TopicConstantValue.

* @public */ - Height64?: Image | undefined; + Value?: string | undefined; /** - *

The image with the height set to 32 pixels.

+ *

The minimum for the TopicConstantValue.

* @public */ - Height32?: Image | undefined; -} + Minimum?: string | undefined; -/** - *

A set of logos.

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

The primary logo.

+ *

The maximum for the TopicConstantValue.

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

The favicon logo.

+ *

The value list of the TopicConstantValue.

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

The logo configuration.

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

The alt text for the logo.

- * @public - */ - AltText: string | undefined; +export const FilterClass = { + CONDITIONAL_VALUE_FILTER: "CONDITIONAL_VALUE_FILTER", + ENFORCED_VALUE_FILTER: "ENFORCED_VALUE_FILTER", + NAMED_VALUE_FILTER: "NAMED_VALUE_FILTER", +} as const; - /** - *

A set of configured logos.

- * @public - */ - LogoSet: LogoSet | undefined; -} +/** + * @public + */ +export type FilterClass = (typeof FilterClass)[keyof typeof FilterClass]; /** * @public * @enum */ -export const BrandVersionStatus = { - CREATE_FAILED: "CREATE_FAILED", - CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS", - CREATE_SUCCEEDED: "CREATE_SUCCEEDED", +export const TopicIRFilterType = { + ACCEPT_ALL_FILTER: "ACCEPT_ALL_FILTER", + CATEGORY_FILTER: "CATEGORY_FILTER", + DATE_RANGE_FILTER: "DATE_RANGE_FILTER", + EQUALS: "EQUALS", + NUMERIC_EQUALITY_FILTER: "NUMERIC_EQUALITY_FILTER", + NUMERIC_RANGE_FILTER: "NUMERIC_RANGE_FILTER", + RANK_LIMIT_FILTER: "RANK_LIMIT_FILTER", + RELATIVE_DATE_FILTER: "RELATIVE_DATE_FILTER", + TOP_BOTTOM_FILTER: "TOP_BOTTOM_FILTER", } as const; /** * @public */ -export type BrandVersionStatus = (typeof BrandVersionStatus)[keyof typeof BrandVersionStatus]; +export type TopicIRFilterType = (typeof TopicIRFilterType)[keyof typeof TopicIRFilterType]; /** - *

The details of the brand.

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

The ID of the Amazon QuickSight brand.

- * @public - */ - BrandId: string | undefined; +export const TopicIRFilterFunction = { + CONTAINS: "CONTAINS", + CONTAINS_STRING: "CONTAINS_STRING", + ENDS_WITH: "ENDS_WITH", + EXACT: "EXACT", + LAST: "LAST", + NEXT: "NEXT", + NOW: "NOW", + PREVIOUS: "PREVIOUS", + STARTS_WITH: "STARTS_WITH", + THIS: "THIS", +} as const; + +/** + * @public + */ +export type TopicIRFilterFunction = (typeof TopicIRFilterFunction)[keyof typeof TopicIRFilterFunction]; + +/** + * @public + * @enum + */ +export const NullFilterOption = { + ALL_VALUES: "ALL_VALUES", + NON_NULLS_ONLY: "NON_NULLS_ONLY", + NULLS_ONLY: "NULLS_ONLY", +} as const; + +/** + * @public + */ +export type NullFilterOption = (typeof NullFilterOption)[keyof typeof NullFilterOption]; +/** + *

The definition for a TopicIRFilterOption.

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

The Amazon Resource Name (ARN) of the brand.

+ *

The filter type for the TopicIRFilterOption.

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

The status of the brand.

+ *

The filter class for the TopicIRFilterOption.

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

The time that the brand was created.

+ *

The operand field for the TopicIRFilterOption.

* @public */ - CreatedTime?: Date | undefined; + OperandField?: Identifier | undefined; /** - *

The last time the brand was updated.

+ *

The function for the TopicIRFilterOption.

* @public */ - LastUpdatedTime?: Date | undefined; + Function?: TopicIRFilterFunction | undefined; /** - *

The ID of the version.

+ *

The constant for the TopicIRFilterOption.

* @public */ - VersionId?: string | undefined; + Constant?: TopicConstantValue | undefined; /** - *

The status of the version.

+ *

The inverse for the TopicIRFilterOption.

* @public */ - VersionStatus?: BrandVersionStatus | undefined; + Inverse?: boolean | undefined; /** - *

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

+ *

The null filter for the TopicIRFilterOption.

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

The logo details.

+ *

The aggregation for the TopicIRFilterOption.

* @public */ - Logo?: Logo | undefined; -} + Aggregation?: AggType | undefined; -/** - *

A summary of the brand.

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

The Amazon Resource Name (ARN) of the brand.

+ *

The aggregation function parameters for the TopicIRFilterOption.

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

The ID of the Amazon QuickSight brand.

+ *

The AggregationPartitionBy for the TopicIRFilterOption.

* @public */ - BrandId?: string | undefined; + AggregationPartitionBy?: AggregationPartitionBy[] | undefined; /** - *

The name of the brand.

+ *

The range for the TopicIRFilterOption.

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

The description of the brand.

+ *

The inclusive for the TopicIRFilterOption.

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

The status of the brand.

+ *

The time granularity for the TopicIRFilterOption.

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

The time that the brand was created.

+ *

The last next offset for the TopicIRFilterOption.

* @public */ - CreatedTime?: Date | undefined; + LastNextOffset?: TopicConstantValue | undefined; /** - *

The time when the brand was last updated.

+ *

The agg metrics for the TopicIRFilterOption.

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

A calculated column for a dataset.

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

Column name.

+ *

The TopBottomLimit for the TopicIRFilterOption.

* @public */ - ColumnName: string | undefined; + TopBottomLimit?: TopicConstantValue | undefined; /** - *

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 sort direction for the TopicIRFilterOption.

* @public */ - ColumnId: string | undefined; + SortDirection?: TopicSortDirection | undefined; /** - *

An expression that defines the calculated column.

+ *

The anchor for the TopicIRFilterOption.

* @public */ - Expression: string | undefined; + Anchor?: Anchor | undefined; } /** + *

The definition for the ContributionAnalysisTimeRanges.

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

The Amazon Web Services account ID.

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

The ID of the dataset used in the ingestion.

+ *

The start range for the ContributionAnalysisTimeRanges.

* @public */ - DataSetId: string | undefined; + StartRange?: TopicIRFilterOption | undefined; /** - *

An ID for the ingestion.

+ *

The end range for the ContributionAnalysisTimeRanges.

* @public */ - IngestionId: string | undefined; + EndRange?: TopicIRFilterOption | undefined; } /** + *

The definition for a TopicIRContributionAnalysis.

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

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

+ *

The factors for a TopicIRContributionAnalysis.

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

An ID for the ingestion.

+ *

The time ranges for the TopicIRContributionAnalysis.

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

The Amazon Web Services request ID for this operation.

+ *

The direction for the TopicIRContributionAnalysis.

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

The HTTP status of the request.

+ *

The sort type for the TopicIRContributionAnalysis.

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

The resource specified already exists.

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

The resource type for this request.

- * @public - */ - ResourceType?: ExceptionResourceType | undefined; +export const DisplayFormat = { + AUTO: "AUTO", + CURRENCY: "CURRENCY", + DATE: "DATE", + NUMBER: "NUMBER", + PERCENT: "PERCENT", + STRING: "STRING", +} as const; - /** - *

The Amazon Web Services request ID for this request.

- * @public - */ - RequestId?: string | undefined; - /** - * @internal - */ - 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; - } -} +/** + * @public + */ +export type DisplayFormat = (typeof DisplayFormat)[keyof typeof DisplayFormat]; /** * @public * @enum */ -export const CapabilityState = { - DENY: "DENY", +export const TopicNumericSeparatorSymbol = { + COMMA: "COMMA", + DOT: "DOT", } as const; /** * @public */ -export type CapabilityState = (typeof CapabilityState)[keyof typeof CapabilityState]; +export type TopicNumericSeparatorSymbol = + (typeof TopicNumericSeparatorSymbol)[keyof typeof TopicNumericSeparatorSymbol]; /** - *

A set of actions that correspond to Amazon QuickSight permissions.

+ *

A structure that represents a negative format.

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

The ability to export to CSV files.

+ *

The prefix for a negative format.

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

The ability to export to Excel files.

+ *

The suffix for a negative format.

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

A structure that represents additional options for display formatting.

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

The ability to export to Create and Update themes.

+ *

A Boolean value that indicates whether to use blank cell format.

* @public */ - CreateAndUpdateThemes?: CapabilityState | undefined; + UseBlankCellFormat?: boolean | undefined; /** - *

The ability to add or run anomaly detection.

+ *

Determines the blank cell format.

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

The ability to share analyses.

+ *

Determines the DateTime format.

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

The ability to create and update datasets.

+ *

Determines the decimal separator.

* @public */ - CreateAndUpdateDatasets?: CapabilityState | undefined; + DecimalSeparator?: TopicNumericSeparatorSymbol | undefined; /** - *

The ability to share datasets.

+ *

Determines the grouping separator.

* @public */ - ShareDatasets?: CapabilityState | undefined; + GroupingSeparator?: string | undefined; /** - *

The ability to subscribe to email reports.

+ *

A Boolean value that indicates whether to use grouping.

* @public */ - SubscribeDashboardEmailReports?: CapabilityState | undefined; + UseGrouping?: boolean | undefined; /** - *

The ability to create and update email reports.

+ *

Determines the number of fraction digits.

* @public */ - CreateAndUpdateDashboardEmailReports?: CapabilityState | undefined; + FractionDigits?: number | undefined; /** - *

The ability to share dashboards.

+ *

The prefix value for a display format.

* @public */ - ShareDashboards?: CapabilityState | undefined; + Prefix?: string | undefined; /** - *

The ability to create and update threshold alerts.

+ *

The suffix value for a display format.

* @public */ - CreateAndUpdateThresholdAlerts?: CapabilityState | undefined; + Suffix?: string | undefined; /** - *

The ability to rename shared folders.

+ *

The unit scaler. Valid values for this structure are: NONE, + * AUTO, THOUSANDS, MILLIONS, + * BILLIONS, + * and TRILLIONS.

* @public */ - RenameSharedFolders?: CapabilityState | undefined; + UnitScaler?: NumberScale | undefined; /** - *

The ability to create shared folders.

+ *

The negative format.

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

The ability to create and update data sources.

+ *

The currency symbol, such as USD.

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

The definition for a NamedEntityRef.

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

The ability to share data sources.

+ *

The NamedEntityName for the NamedEntityRef.

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

The definition for a TopicSortClause.

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

The ability to view account SPICE capacity.

+ *

The operand for a TopicSortClause.

* @public */ - ViewAccountSPICECapacity?: CapabilityState | undefined; + Operand?: Identifier | undefined; /** - *

The ability to create a SPICE dataset.

+ *

The sort direction for the TopicSortClause.

* @public */ - CreateSPICEDataset?: CapabilityState | undefined; + SortDirection?: TopicSortDirection | undefined; } /** - * @public - * @enum - */ -export const ColumnDataType = { - DATETIME: "DATETIME", - DECIMAL: "DECIMAL", - INTEGER: "INTEGER", - STRING: "STRING", -} as const; - -/** - * @public - */ -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.

+ *

The definition for a TopicIRGroupBy.

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

Column name.

+ *

The field name for the TopicIRGroupBy.

* @public */ - ColumnName: string | undefined; + FieldName?: Identifier | undefined; /** - *

New column data type.

+ *

The time granularity for the TopicIRGroupBy.

* @public */ - NewColumnType: ColumnDataType | undefined; + TimeGranularity?: TopicTimeGranularity | 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 sort for the TopicIRGroupBy.

* @public */ - SubType?: ColumnDataSubType | undefined; + Sort?: TopicSortClause | 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 display format for the TopicIRGroupBy.

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

A structure that represents additional options for display formatting.

+ * @public + */ + DisplayFormatOptions?: DisplayFormatOptions | undefined; -/** - * @public - */ -export type CategoryFilterFunction = (typeof CategoryFilterFunction)[keyof typeof CategoryFilterFunction]; + /** + *

The named entity for the TopicIRGroupBy.

+ * @public + */ + NamedEntity?: NamedEntityRef | undefined; +} /** * @public * @enum */ -export const CategoryFilterType = { - CUSTOM_FILTER: "CUSTOM_FILTER", - CUSTOM_FILTER_LIST: "CUSTOM_FILTER_LIST", - FILTER_LIST: "FILTER_LIST", +export const ComparisonMethodType = { + DIFF: "DIFF", + DIFF_AS_PERC: "DIFF_AS_PERC", + MOVING_AVERAGE: "MOVING_AVERAGE", + PERCENT_OF_TOTAL: "PERCENT_OF_TOTAL", + PERC_DIFF: "PERC_DIFF", + POP_CURRENT_DIFF: "POP_CURRENT_DIFF", + POP_CURRENT_DIFF_AS_PERC: "POP_CURRENT_DIFF_AS_PERC", + POP_OVERTIME_DIFF: "POP_OVERTIME_DIFF", + POP_OVERTIME_DIFF_AS_PERC: "POP_OVERTIME_DIFF_AS_PERC", + RUNNING_SUM: "RUNNING_SUM", } as const; /** * @public */ -export type CategoryFilterType = (typeof CategoryFilterType)[keyof typeof CategoryFilterType]; +export type ComparisonMethodType = (typeof ComparisonMethodType)[keyof typeof ComparisonMethodType]; /** - *

A structure that represents the cell value synonym.

+ *

The definition of a TopicIRComparisonMethod.

* @public */ -export interface CellValueSynonym { +export interface TopicIRComparisonMethod { /** - *

The cell value.

+ *

The type for the TopicIRComparisonMethod.

* @public */ - CellValue?: string | undefined; + Type?: ComparisonMethodType | undefined; /** - *

Other names or aliases for the cell value.

+ *

The period for the TopicIRComparisonMethod.

* @public */ - Synonyms?: string[] | undefined; -} + Period?: TopicTimeGranularity | undefined; -/** - *

A structure that represents a collective constant.

- * @public - */ -export interface CollectiveConstant { /** - *

A list of values for the collective constant.

+ *

The window size for the TopicIRComparisonMethod.

* @public */ - ValueList?: string[] | undefined; + WindowSize?: number | undefined; } /** - * @public - * @enum - */ -export const ColumnDataRole = { - DIMENSION: "DIMENSION", - MEASURE: "MEASURE", -} as const; - -/** + *

The definition for a TopicIRMetric.

* @public */ -export type ColumnDataRole = (typeof ColumnDataRole)[keyof typeof ColumnDataRole]; +export interface TopicIRMetric { + /** + *

The metric ID for the TopicIRMetric.

+ * @public + */ + MetricId?: Identifier | undefined; -/** - *

Metadata that contains a description for a column.

- * @public - */ -export interface ColumnDescription { /** - *

The text of a description for a column.

+ *

The function for the TopicIRMetric.

* @public */ - Text?: string | undefined; -} + Function?: AggFunction | undefined; -/** - * @public - * @enum - */ -export const GeoSpatialCountryCode = { - US: "US", -} as const; + /** + *

The operands for the TopicIRMetric.

+ * @public + */ + Operands?: Identifier[] | undefined; -/** - * @public - */ -export type GeoSpatialCountryCode = (typeof GeoSpatialCountryCode)[keyof typeof GeoSpatialCountryCode]; + /** + *

The comparison method for the TopicIRMetric.

+ * @public + */ + ComparisonMethod?: TopicIRComparisonMethod | undefined; -/** - *

Geospatial column group that denotes a hierarchy.

- * @public - */ -export interface GeoSpatialColumnGroup { /** - *

A display name for the hierarchy.

+ *

The expression for the TopicIRMetric.

* @public */ - Name: string | undefined; + Expression?: string | undefined; /** - *

Country code.

+ *

The calculated field references for the TopicIRMetric.

* @public */ - CountryCode?: GeoSpatialCountryCode | undefined; + CalculatedFieldReferences?: Identifier[] | undefined; /** - *

Columns in this hierarchy.

+ *

The display format for the TopicIRMetric.

* @public */ - Columns: string[] | undefined; -} + DisplayFormat?: DisplayFormat | 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.

+ *

A structure that represents additional options for display formatting.

* @public */ - GeoSpatialColumnGroup?: GeoSpatialColumnGroup | undefined; -} + DisplayFormatOptions?: DisplayFormatOptions | 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 named entity for the TopicIRMetric.

* @public */ - Name?: string | undefined; + NamedEntity?: NamedEntityRef | undefined; } /** - *

The column group schema.

+ *

The definition for a VisualOptions.

* @public */ -export interface ColumnGroupSchema { - /** - *

The name of the column group schema.

- * @public - */ - Name?: string | undefined; - +export interface VisualOptions { /** - *

A structure containing the list of schemas for column group columns.

+ *

The type for a VisualOptions.

* @public */ - ColumnGroupColumnSchemaList?: ColumnGroupColumnSchema[] | undefined; + type?: string | 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.

+ *

The definition for a TopicIR.

* @public */ -export interface ColumnLevelPermissionRule { +export interface TopicIR { /** - *

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

+ *

The metrics for the TopicIR.

* @public */ - Principals?: string[] | undefined; + Metrics?: TopicIRMetric[] | undefined; /** - *

An array of column names.

+ *

The GroupBy list for the TopicIR.

* @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; + GroupByList?: TopicIRGroupBy[] | undefined; -/** - * @public - */ -export type ColumnOrderingType = (typeof ColumnOrderingType)[keyof typeof ColumnOrderingType]; + /** + *

The filters for the TopicIR.

+ * @public + */ + Filters?: TopicIRFilterOption[][] | undefined; -/** - *

The column schema.

- * @public - */ -export interface ColumnSchema { /** - *

The name of the column schema.

+ *

The sort for the TopicIR.

* @public */ - Name?: string | undefined; + Sort?: TopicSortClause | undefined; /** - *

The data type of the column schema.

+ *

The contribution analysis for the TopicIR.

* @public */ - DataType?: string | undefined; + ContributionAnalysis?: TopicIRContributionAnalysis | undefined; /** - *

The geographic role of the column schema.

+ *

The visual for the TopicIR.

* @public */ - GeographicRole?: string | undefined; + Visual?: VisualOptions | undefined; } /** * @public * @enum */ -export const GeoSpatialDataRole = { - CITY: "CITY", - COUNTRY: "COUNTRY", - COUNTY: "COUNTY", - LATITUDE: "LATITUDE", - LONGITUDE: "LONGITUDE", - POSTCODE: "POSTCODE", - STATE: "STATE", +export const VisualRole = { + COMPLIMENTARY: "COMPLIMENTARY", + FALLBACK: "FALLBACK", + FRAGMENT: "FRAGMENT", + MULTI_INTENT: "MULTI_INTENT", + PRIMARY: "PRIMARY", } as const; /** * @public */ -export type GeoSpatialDataRole = (typeof GeoSpatialDataRole)[keyof typeof GeoSpatialDataRole]; +export type VisualRole = (typeof VisualRole)[keyof typeof VisualRole]; /** - *

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.

+ *

The definition for the slot.

* @public */ -export interface ColumnTag { +export interface Slot { /** - *

A geospatial role for a column.

+ *

The slot ID of the slot.

* @public */ - ColumnGeographicRole?: GeoSpatialDataRole | undefined; + SlotId?: string | undefined; /** - *

A description for a column.

+ *

The visual ID for the slot.

* @public */ - ColumnDescription?: ColumnDescription | undefined; + VisualId?: string | undefined; } /** + *

The definition for a TopicTemplate.

* @public - * @enum */ -export const ColumnTagName = { - COLUMN_DESCRIPTION: "COLUMN_DESCRIPTION", - COLUMN_GEOGRAPHIC_ROLE: "COLUMN_GEOGRAPHIC_ROLE", -} as const; +export interface TopicTemplate { + /** + *

The template type for the TopicTemplate.

+ * @public + */ + TemplateType?: string | undefined; -/** - * @public - */ -export type ColumnTagName = (typeof ColumnTagName)[keyof typeof ColumnTagName]; + /** + *

The slots for the TopicTemplate.

+ * @public + */ + Slots?: Slot[] | undefined; +} /** * @public * @enum */ -export const UndefinedSpecifiedValueType = { - LEAST: "LEAST", - MOST: "MOST", +export const ReviewedAnswerErrorCode = { + DATASET_DOES_NOT_EXIST: "DATASET_DOES_NOT_EXIST", + DUPLICATED_ANSWER: "DUPLICATED_ANSWER", + INTERNAL_ERROR: "INTERNAL_ERROR", + INVALID_DATA: "INVALID_DATA", + INVALID_DATASET_ARN: "INVALID_DATASET_ARN", + MISSING_ANSWER: "MISSING_ANSWER", + MISSING_REQUIRED_FIELDS: "MISSING_REQUIRED_FIELDS", } as const; /** * @public */ -export type UndefinedSpecifiedValueType = - (typeof UndefinedSpecifiedValueType)[keyof typeof UndefinedSpecifiedValueType]; +export type ReviewedAnswerErrorCode = (typeof ReviewedAnswerErrorCode)[keyof typeof ReviewedAnswerErrorCode]; /** - *

A structure that represents a comparative order.

+ *

The definition for a InvalidTopicReviewedAnswer.

* @public */ -export interface ComparativeOrder { - /** - *

The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.

- * @public - */ - UseOrdering?: ColumnOrderingType | undefined; - +export interface InvalidTopicReviewedAnswer { /** - *

The list of columns to be used in the ordering.

+ *

The answer ID for the InvalidTopicReviewedAnswer.

* @public */ - SpecifedOrder?: string[] | undefined; + AnswerId?: string | undefined; /** - *

The treat of undefined specified values. Valid values for this structure are LEAST and MOST.

+ *

The error that is returned for the InvalidTopicReviewedAnswer.

* @public */ - TreatUndefinedSpecifiedValues?: UndefinedSpecifiedValueType | undefined; + Error?: ReviewedAnswerErrorCode | undefined; } /** - *

A resource is already in a state that indicates an operation is happening that must complete - * before a new update can be applied.

+ *

The definition for a SucceededTopicReviewedAnswer.

* @public */ -export class ConcurrentUpdatingException extends __BaseException { - readonly name: "ConcurrentUpdatingException" = "ConcurrentUpdatingException"; - readonly $fault: "server" = "server"; - Message?: string | undefined; - RequestId?: string | undefined; +export interface SucceededTopicReviewedAnswer { /** - * @internal + *

The answer ID for the SucceededTopicReviewedAnswer.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "ConcurrentUpdatingException", - $fault: "server", - ...opts, - }); - Object.setPrototypeOf(this, ConcurrentUpdatingException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } + AnswerId?: string | undefined; } /** * @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 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" - * \}.

- * @public - */ - AccountCustomization: AccountCustomization | undefined; - +export interface BatchCreateTopicReviewedAnswerResponse { /** - *

A list of the tags that you want to attach to this resource.

+ *

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region + * for each Amazon Web Services account.

* @public */ - Tags?: Tag[] | undefined; -} + TopicId?: string | undefined; -/** - * @public - */ -export interface CreateAccountCustomizationResponse { /** - *

The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.

+ *

The Amazon Resource Name (ARN) of the topic.

* @public */ - Arn?: string | undefined; + TopicArn?: string | undefined; /** - *

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

+ *

The definition of Answers that are successfully created.

* @public */ - AwsAccountId?: string | undefined; + SucceededAnswers?: SucceededTopicReviewedAnswer[] | undefined; /** - *

The namespace associated with the customization you're creating.

+ *

The definition of Answers that are invalid and not created.

* @public */ - Namespace?: string | undefined; + InvalidAnswers?: InvalidTopicReviewedAnswer[] | undefined; /** - *

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.

+ *

The HTTP status of the request.

* @public */ - AccountCustomization?: AccountCustomization | 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; } /** - *

This resource is currently unavailable.

+ *

An internal failure occurred.

* @public */ -export class ResourceUnavailableException extends __BaseException { - readonly name: "ResourceUnavailableException" = "ResourceUnavailableException"; +export class InternalFailureException extends __BaseException { + readonly name: "InternalFailureException" = "InternalFailureException"; readonly $fault: "server" = "server"; Message?: string | undefined; - /** - *

The resource type for this request.

- * @public - */ - ResourceType?: ExceptionResourceType | undefined; - /** *

The Amazon Web Services request ID for this request.

* @public @@ -7137,245 +7330,200 @@ export class ResourceUnavailableException extends __BaseException { /** * @internal */ - constructor(opts: __ExceptionOptionType) { + constructor(opts: __ExceptionOptionType) { super({ - name: "ResourceUnavailableException", + name: "InternalFailureException", $fault: "server", ...opts, }); - Object.setPrototypeOf(this, ResourceUnavailableException.prototype); + Object.setPrototypeOf(this, InternalFailureException.prototype); this.Message = opts.Message; - this.ResourceType = opts.ResourceType; this.RequestId = opts.RequestId; } } /** + *

One or more parameters has a value that isn't valid.

* @public */ -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; - - /** - *

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; - - /** - *

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 email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

- * @public - */ - NotificationEmail: string | 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.

- * @public - */ - ActiveDirectoryName?: string | 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.

- * @public - */ - Realm?: string | undefined; - +export class InvalidParameterValueException extends __BaseException { + readonly name: "InvalidParameterValueException" = "InvalidParameterValueException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; /** - *

The ID of the Active Directory that is associated with your Amazon QuickSight account.

+ *

The Amazon Web Services request ID for this request.

* @public */ - DirectoryId?: string | undefined; - + RequestId?: string | 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.

- * @public + * @internal */ - AdminGroup?: string[] | undefined; + constructor(opts: __ExceptionOptionType) { + super({ + name: "InvalidParameterValueException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, InvalidParameterValueException.prototype); + this.Message = opts.Message; + this.RequestId = opts.RequestId; + } +} - /** - *

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 - */ - AuthorGroup?: string[] | undefined; +/** + * @public + * @enum + */ +export const ExceptionResourceType = { + ACCOUNT_SETTINGS: "ACCOUNT_SETTINGS", + DATA_SET: "DATA_SET", + DATA_SOURCE: "DATA_SOURCE", + GROUP: "GROUP", + IAMPOLICY_ASSIGNMENT: "IAMPOLICY_ASSIGNMENT", + INGESTION: "INGESTION", + NAMESPACE: "NAMESPACE", + USER: "USER", + VPC_CONNECTION: "VPC_CONNECTION", +} as const; - /** - *

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 - */ - ReaderGroup?: string[] | undefined; +/** + * @public + */ +export type ExceptionResourceType = (typeof ExceptionResourceType)[keyof typeof ExceptionResourceType]; +/** + *

One or more resources can't be found.

+ * @public + */ +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + Message?: string | 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 resource type for this request.

* @public */ - AdminProGroup?: string[] | undefined; + ResourceType?: ExceptionResourceType | 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 Amazon Web Services request ID for this request.

* @public */ - AuthorProGroup?: string[] | undefined; - + RequestId?: string | 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.

- * @public + * @internal */ - ReaderProGroup?: string[] | undefined; + constructor(opts: __ExceptionOptionType) { + super({ + name: "ResourceNotFoundException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, ResourceNotFoundException.prototype); + this.Message = opts.Message; + this.ResourceType = opts.ResourceType; + this.RequestId = opts.RequestId; + } +} +/** + *

Access is throttled.

+ * @public + */ +export class ThrottlingException extends __BaseException { + readonly name: "ThrottlingException" = "ThrottlingException"; + readonly $fault: "client" = "client"; + Message?: string | 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 Amazon Web Services request ID for this request.

* @public */ - FirstName?: string | undefined; - + RequestId?: string | 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.

- * @public + * @internal */ - LastName?: string | undefined; + constructor(opts: __ExceptionOptionType) { + super({ + name: "ThrottlingException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, ThrottlingException.prototype); + this.Message = opts.Message; + this.RequestId = opts.RequestId; + } +} +/** + * @public + */ +export interface BatchDeleteTopicReviewedAnswerRequest { /** - *

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 ID of the Amazon Web Services account that you want to delete a reviewed answers in.

* @public */ - EmailAddress?: string | undefined; + AwsAccountId: string | 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 ID for the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - ContactNumber?: string | undefined; + TopicId: string | undefined; /** - *

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

+ *

The Answer IDs of the Answers to be deleted.

* @public */ - IAMIdentityCenterInstanceArn?: string | undefined; + AnswerIds?: string[] | undefined; } /** - *

A SignupResponse object that contains a summary of a newly created account.

* @public */ -export interface SignupResponse { +export interface BatchDeleteTopicReviewedAnswerResponse { /** - *

A Boolean that is TRUE if the Amazon QuickSight uses IAM as an - * authentication method.

+ *

The ID of the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - IAMUser?: boolean | undefined; + TopicId?: string | undefined; /** - *

The user login name for your Amazon QuickSight account.

+ *

The Amazon Resource Name (ARN) of the topic.

* @public */ - userLoginName?: string | undefined; + TopicArn?: string | undefined; /** - *

The name of your Amazon QuickSight account.

+ *

The definition of Answers that are successfully deleted.

* @public */ - accountName?: string | undefined; + SucceededAnswers?: SucceededTopicReviewedAnswer[] | 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.

+ *

The definition of Answers that are invalid and not deleted.

* @public */ - directoryType?: string | undefined; -} + InvalidAnswers?: InvalidTopicReviewedAnswer[] | undefined; -/** - * @public - */ -export interface CreateAccountSubscriptionResponse { /** - *

A SignupResponse object that returns information about a newly created Amazon QuickSight account.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - SignupResponse?: SignupResponse | 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; + Status?: number | undefined; } /** - *

One or more preconditions aren't met.

+ *

Updating or deleting a resource can cause an inconsistent state.

* @public */ -export class PreconditionNotMetException extends __BaseException { - readonly name: "PreconditionNotMetException" = "PreconditionNotMetException"; +export class ConflictException extends __BaseException { + readonly name: "ConflictException" = "ConflictException"; readonly $fault: "client" = "client"; Message?: string | undefined; /** @@ -7386,1245 +7534,1109 @@ export class PreconditionNotMetException extends __BaseException { /** * @internal */ - constructor(opts: __ExceptionOptionType) { + constructor(opts: __ExceptionOptionType) { super({ - name: "PreconditionNotMetException", + name: "ConflictException", $fault: "client", ...opts, }); - Object.setPrototypeOf(this, PreconditionNotMetException.prototype); + Object.setPrototypeOf(this, ConflictException.prototype); this.Message = opts.Message; this.RequestId = opts.RequestId; } } /** - *

A date-time parameter.

+ *

The bookmarks configuration of an embedded dashboard.

* @public */ -export interface DateTimeParameter { - /** - *

A display name for the date-time parameter.

- * @public - */ - Name: string | undefined; - +export interface BookmarksConfigurations { /** - *

The values for the date-time parameter.

+ *

A Boolean value that determines whether a user + * can bookmark an embedded dashboard.

* @public */ - Values: Date[] | undefined; + Enabled: boolean | undefined; } /** - *

A decimal parameter.

+ *

The display options for tile borders for visuals.

* @public */ -export interface DecimalParameter { - /** - *

A display name for the decimal parameter.

- * @public - */ - Name: string | undefined; - +export interface BorderStyle { /** - *

The values for the decimal parameter.

+ *

The option to enable display of borders for visuals.

* @public */ - Values: number[] | undefined; + Show?: boolean | undefined; } /** - *

An integer parameter.

+ *

The source of the image.

* @public */ -export interface IntegerParameter { - /** - *

The name of the integer parameter.

- * @public - */ - Name: string | undefined; - - /** - *

The values for the integer parameter.

- * @public - */ - Values: number[] | undefined; -} +export type ImageSource = ImageSource.PublicUrlMember | ImageSource.S3UriMember | ImageSource.$UnknownMember; /** - *

A string parameter.

* @public */ -export interface StringParameter { - /** - *

A display name for a string parameter.

- * @public - */ - Name: string | undefined; - +export namespace ImageSource { /** - *

The values of a string parameter.

+ *

The public URL that points to the source image.

* @public */ - Values: string[] | undefined; -} + export interface PublicUrlMember { + PublicUrl: string; + S3Uri?: never; + $unknown?: never; + } -/** - *

A list of Amazon QuickSight parameters and the list's override values.

- * @public - */ -export interface _Parameters { /** - *

The parameters that have a data type of string.

+ *

The Amazon S3 URI that points to the source image.

* @public */ - StringParameters?: StringParameter[] | undefined; + export interface S3UriMember { + PublicUrl?: never; + S3Uri: string; + $unknown?: never; + } /** - *

The parameters that have a data type of integer.

* @public */ - IntegerParameters?: IntegerParameter[] | undefined; + export interface $UnknownMember { + PublicUrl?: never; + S3Uri?: never; + $unknown: [string, any]; + } - /** - *

The parameters that have a data type of decimal.

- * @public - */ - DecimalParameters?: DecimalParameter[] | undefined; + export interface Visitor { + PublicUrl: (value: string) => T; + S3Uri: (value: string) => T; + _: (name: string, value: any) => T; + } - /** - *

The parameters that have a data type of date-time.

- * @public - */ - DateTimeParameters?: DateTimeParameter[] | undefined; + 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]); + }; } /** - *

Permission for the resource.

+ *

The logo image configuration.

* @public */ -export interface ResourcePermission { - /** - *

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 - */ - Principal: string | undefined; - +export interface ImageConfiguration { /** - *

The IAM action to grant or revoke permissions on.

+ *

The source of the image.

* @public */ - Actions: string[] | undefined; + Source?: ImageSource | undefined; } /** - * @public - * @enum - */ -export const ValidationStrategyMode = { - LENIENT: "LENIENT", - STRICT: "STRICT", -} as const; - -/** - * @public - */ -export type ValidationStrategyMode = (typeof ValidationStrategyMode)[keyof typeof ValidationStrategyMode]; - -/** - *

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.

+ *

The image set configuration.

* @public */ -export interface ValidationStrategy { +export interface ImageSetConfiguration { /** - *

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.

+ *

The original image.

* @public */ - Mode: ValidationStrategyMode | undefined; + Original: ImageConfiguration | undefined; } /** + *

The logo set configuration.

* @public */ -export interface CreateAnalysisRequest { +export interface LogoSetConfiguration { /** - *

The ID of the Amazon Web Services account where you are creating an analysis.

+ *

The primary logo.

* @public */ - AwsAccountId: string | undefined; + Primary: ImageSetConfiguration | undefined; /** - *

The ID for the analysis that you're creating. This ID displays in the URL of the - * analysis.

+ *

The favicon logo.

* @public */ - AnalysisId: string | undefined; + Favicon?: ImageSetConfiguration | undefined; +} +/** + *

The logo configuration.

+ * @public + */ +export interface LogoConfiguration { /** - *

A descriptive name for the analysis that you're creating. This name displays for the - * analysis in the Amazon QuickSight console.

+ *

The alt text for the logo.

* @public */ - Name: string | undefined; + AltText: string | 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 set of configured logos.

* @public */ - Parameters?: _Parameters | undefined; + LogoSet: LogoSetConfiguration | undefined; +} +/** + *

The definition of the brand.

+ * @public + */ +export interface BrandDefinition { /** - *

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 name of the brand.

* @public */ - Permissions?: ResourcePermission[] | undefined; + BrandName: 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 description of the brand.

* @public */ - SourceEntity?: AnalysisSourceEntity | undefined; + Description?: 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 application theme of the brand.

* @public */ - ThemeArn?: string | undefined; + ApplicationTheme?: ApplicationTheme | undefined; /** - *

Contains a map of the key-value pairs for the resource tag or tags assigned to the - * analysis.

+ *

The logo configuration of the brand.

* @public */ - Tags?: Tag[] | undefined; + LogoConfiguration?: LogoConfiguration | 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.

- * @public - */ - Definition?: AnalysisDefinition | undefined; +/** + * @public + * @enum + */ +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 BrandStatus = (typeof BrandStatus)[keyof typeof BrandStatus]; +/** + *

The logo image.

+ * @public + */ +export interface Image { /** - *

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

+ *

The source of the logo image.

* @public */ - ValidationStrategy?: ValidationStrategy | undefined; + Source?: ImageSource | undefined; /** - *

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

+ *

The URL that points to the generated logo image.

* @public */ - FolderArns?: string[] | undefined; + GeneratedImageUrl?: string | undefined; } /** + *

The image set.

* @public */ -export interface CreateAnalysisResponse { +export interface ImageSet { /** - *

The ARN for the analysis.

+ *

The original image.

* @public */ - Arn?: string | undefined; + Original: Image | undefined; /** - *

The ID of the analysis.

+ *

The image with the height set to 64 pixels.

* @public */ - AnalysisId?: string | undefined; + Height64?: Image | undefined; /** - *

The status of the creation of the analysis.

+ *

The image with the height set to 32 pixels.

* @public */ - CreationStatus?: ResourceStatus | undefined; + Height32?: Image | undefined; +} +/** + *

A set of logos.

+ * @public + */ +export interface LogoSet { /** - *

The HTTP status of the request.

+ *

The primary logo.

* @public */ - Status?: number | undefined; + Primary: ImageSet | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The favicon logo.

* @public */ - RequestId?: string | undefined; + Favicon?: ImageSet | undefined; } /** - *

A limit is exceeded.

+ *

The logo configuration.

* @public */ -export class LimitExceededException extends __BaseException { - readonly name: "LimitExceededException" = "LimitExceededException"; - readonly $fault: "client" = "client"; - Message?: string | undefined; +export interface Logo { /** - *

Limit exceeded.

+ *

The alt text for the logo.

* @public */ - ResourceType?: ExceptionResourceType | undefined; + AltText: string | undefined; /** - *

The Amazon Web Services request ID for this request.

+ *

A set of configured logos.

* @public */ - 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; - } + LogoSet: LogoSet | 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 + * @enum */ -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.

- * @public - */ - RequestId?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "UnsupportedUserEditionException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, UnsupportedUserEditionException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } -} +export const BrandVersionStatus = { + CREATE_FAILED: "CREATE_FAILED", + CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS", + CREATE_SUCCEEDED: "CREATE_SUCCEEDED", +} as const; + +/** + * @public + */ +export type BrandVersionStatus = (typeof BrandVersionStatus)[keyof typeof BrandVersionStatus]; /** + *

The details of the brand.

* @public */ -export interface CreateBrandRequest { +export interface BrandDetail { + /** + *

The ID of the Amazon QuickSight brand.

+ * @public + */ + BrandId: string | undefined; + /** - *

The ID of the Amazon Web Services account that owns the brand.

+ *

The Amazon Resource Name (ARN) of the brand.

* @public */ - AwsAccountId: string | undefined; + Arn?: string | undefined; /** - *

The ID of the Amazon QuickSight brand.

+ *

The status of the brand.

* @public */ - BrandId: string | undefined; + BrandStatus?: BrandStatus | undefined; /** - *

The definition of the brand.

+ *

The time that the brand was created.

* @public */ - BrandDefinition?: BrandDefinition | undefined; + CreatedTime?: Date | undefined; /** - *

A map of the key-value pairs that are assigned to the brand.

+ *

The last time the brand was updated.

* @public */ - Tags?: Tag[] | undefined; -} + LastUpdatedTime?: Date | undefined; -/** - * @public - */ -export interface CreateBrandResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

The ID of the version.

* @public */ - RequestId?: string | undefined; + VersionId?: string | undefined; /** - *

The details of the brand.

+ *

The status of the version.

* @public */ - BrandDetail?: BrandDetail | undefined; + VersionStatus?: BrandVersionStatus | undefined; /** - *

The definition of the brand.

+ *

A list of errors that occurred during the most recent brand operation.

* @public */ - BrandDefinition?: BrandDefinition | undefined; -} + Errors?: string[] | undefined; -/** - *

An internal service exception.

- * @public - */ -export class InternalServerException extends __BaseException { - readonly name: "InternalServerException" = "InternalServerException"; - readonly $fault: "server" = "server"; - Message: string | undefined; /** - * @internal + *

The logo details.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "InternalServerException", - $fault: "server", - ...opts, - }); - Object.setPrototypeOf(this, InternalServerException.prototype); - this.Message = opts.Message; - } + Logo?: Logo | undefined; } /** - *

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

+ *

A summary of the brand.

* @public */ -export class InvalidRequestException extends __BaseException { - readonly name: "InvalidRequestException" = "InvalidRequestException"; - readonly $fault: "client" = "client"; - Message?: string | undefined; +export interface BrandSummary { /** - *

The Amazon Web Services request ID for this request.

+ *

The Amazon Resource Name (ARN) of the brand.

* @public */ - RequestId?: string | undefined; + Arn?: string | undefined; + /** - * @internal + *

The ID of the Amazon QuickSight brand.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "InvalidRequestException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, InvalidRequestException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } -} + BrandId?: 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 name of the brand.

* @public */ - Columns: CalculatedColumn[] | undefined; -} + BrandName?: string | undefined; -/** - * @public - */ -export interface CreateCustomPermissionsRequest { /** - *

The ID of the Amazon Web Services account that you want to create the custom permissions profile in.

+ *

The description of the brand.

* @public */ - AwsAccountId: string | undefined; + Description?: string | undefined; /** - *

The name of the custom permissions profile that you want to create.

+ *

The status of the brand.

* @public */ - CustomPermissionsName: string | undefined; + BrandStatus?: BrandStatus | undefined; /** - *

A set of actions to include in the custom permissions profile.

+ *

The time that the brand was created.

* @public */ - Capabilities?: Capabilities | undefined; + CreatedTime?: Date | undefined; /** - *

The tags to associate with the custom permissions profile.

+ *

The time when the brand was last updated.

* @public */ - Tags?: Tag[] | undefined; + LastUpdatedTime?: Date | undefined; } /** + *

A calculated column for a dataset.

* @public */ -export interface CreateCustomPermissionsResponse { +export interface CalculatedColumn { /** - *

The HTTP status of the request.

+ *

Column name.

* @public */ - Status?: number | undefined; + ColumnName: string | undefined; /** - *

The Amazon Resource Name (ARN) of the custom permissions profile.

+ *

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 */ - Arn?: string | undefined; + ColumnId: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

An expression that defines the calculated column.

* @public */ - RequestId?: string | undefined; + Expression: string | undefined; } /** - *

The drill down options for data points in a dashbaord.

* @public */ -export interface DataPointDrillUpDownOption { +export interface CancelIngestionRequest { /** - *

The status of the drill down options of data points.

+ *

The Amazon Web Services account ID.

* @public */ - AvailabilityStatus?: DashboardBehavior | undefined; -} + AwsAccountId: string | undefined; -/** - *

The data point menu options of a dashboard.

- * @public - */ -export interface DataPointMenuLabelOption { /** - *

The status of the data point menu options.

+ *

The ID of the dataset used in the ingestion.

* @public */ - AvailabilityStatus?: DashboardBehavior | undefined; -} + DataSetId: string | undefined; -/** - *

The data point tooltip options.

- * @public - */ -export interface DataPointTooltipOption { /** - *

The status of the data point tool tip options.

+ *

An ID for the ingestion.

* @public */ - AvailabilityStatus?: DashboardBehavior | undefined; + IngestionId: string | undefined; } /** - *

Export to .csv option.

* @public */ -export interface ExportToCSVOption { +export interface CancelIngestionResponse { + /** + *

The Amazon Resource Name (ARN) for the data ingestion.

+ * @public + */ + Arn?: string | undefined; + + /** + *

An ID for the ingestion.

+ * @public + */ + IngestionId?: string | undefined; + /** - *

Availability status.

+ *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

* @public */ - AvailabilityStatus?: DashboardBehavior | undefined; + Status?: number | undefined; } /** - *

Determines whether or not hidden fields are visible on exported dashbaords.

+ *

The resource specified already exists.

* @public */ -export interface ExportWithHiddenFieldsOption { +export class ResourceExistsException extends __BaseException { + readonly name: "ResourceExistsException" = "ResourceExistsException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; + /** + *

The resource type for this request.

+ * @public + */ + ResourceType?: ExceptionResourceType | undefined; + /** - *

The status of the export with hidden fields options.

+ *

The Amazon Web Services request ID for this request.

* @public */ - AvailabilityStatus?: DashboardBehavior | undefined; + RequestId?: string | undefined; + /** + * @internal + */ + 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; + } } /** * @public * @enum */ -export const DashboardUIState = { - COLLAPSED: "COLLAPSED", - EXPANDED: "EXPANDED", +export const CapabilityState = { + DENY: "DENY", } as const; /** * @public */ -export type DashboardUIState = (typeof DashboardUIState)[keyof typeof DashboardUIState]; +export type CapabilityState = (typeof CapabilityState)[keyof typeof CapabilityState]; /** - *

Sheet controls option.

+ *

A set of actions that correspond to Amazon QuickSight permissions.

* @public */ -export interface SheetControlsOption { +export interface Capabilities { /** - *

Visibility state.

+ *

The ability to export to CSV files.

* @public */ - VisibilityState?: DashboardUIState | undefined; -} + ExportToCsv?: CapabilityState | undefined; -/** - *

The sheet layout maximization options of a dashbaord.

- * @public - */ -export interface SheetLayoutElementMaximizationOption { /** - *

The status of the sheet layout maximization options of a dashbaord.

+ *

The ability to export to Excel files.

* @public */ - AvailabilityStatus?: DashboardBehavior | undefined; -} + ExportToExcel?: CapabilityState | undefined; -/** - *

The axis sort options for a visual.

- * @public - */ -export interface VisualAxisSortOption { /** - *

The availaiblity status of a visual's axis sort options.

+ *

The ability to export to Create and Update themes.

* @public */ - AvailabilityStatus?: DashboardBehavior | undefined; -} + CreateAndUpdateThemes?: CapabilityState | 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 ability to add or run anomaly detection.

* @public */ - AvailabilityStatus?: DashboardBehavior | undefined; -} + AddOrRunAnomalyDetectionForAnalyses?: CapabilityState | 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 ability to share analyses.

* @public */ - ExportHiddenFieldsOption?: ExportHiddenFieldsOption | undefined; -} + ShareAnalyses?: CapabilityState | undefined; + + /** + *

The ability to create and update datasets.

+ * @public + */ + CreateAndUpdateDatasets?: CapabilityState | undefined; -/** - *

Dashboard publish options.

- * @public - */ -export interface DashboardPublishOptions { /** - *

Ad hoc (one-time) filtering option.

+ *

The ability to share datasets.

* @public */ - AdHocFilteringOption?: AdHocFilteringOption | undefined; + ShareDatasets?: CapabilityState | undefined; /** - *

Export to .csv option.

+ *

The ability to subscribe to email reports.

* @public */ - ExportToCSVOption?: ExportToCSVOption | undefined; + SubscribeDashboardEmailReports?: CapabilityState | undefined; /** - *

Sheet controls option.

+ *

The ability to create and update email reports.

* @public */ - SheetControlsOption?: SheetControlsOption | undefined; + CreateAndUpdateDashboardEmailReports?: CapabilityState | undefined; /** - * @deprecated - * - *

The visual publish options of a visual in a dashboard.

+ *

The ability to share dashboards.

* @public */ - VisualPublishOptions?: DashboardVisualPublishOptions | undefined; + ShareDashboards?: CapabilityState | undefined; /** - *

The sheet layout maximization options of a dashbaord.

+ *

The ability to create and update threshold alerts.

* @public */ - SheetLayoutElementMaximizationOption?: SheetLayoutElementMaximizationOption | undefined; + CreateAndUpdateThresholdAlerts?: CapabilityState | undefined; /** - *

The menu options of a visual in a dashboard.

+ *

The ability to rename shared folders.

* @public */ - VisualMenuOption?: VisualMenuOption | undefined; + RenameSharedFolders?: CapabilityState | undefined; /** - *

The axis sort options of a dashboard.

+ *

The ability to create shared folders.

* @public */ - VisualAxisSortOption?: VisualAxisSortOption | undefined; + CreateSharedFolders?: CapabilityState | undefined; /** - *

Determines if hidden fields are exported with a dashboard.

+ *

The ability to create and update data sources.

* @public */ - ExportWithHiddenFieldsOption?: ExportWithHiddenFieldsOption | undefined; + CreateAndUpdateDataSources?: CapabilityState | undefined; /** - *

The drill-down options of data points in a dashboard.

+ *

The ability to share data sources.

* @public */ - DataPointDrillUpDownOption?: DataPointDrillUpDownOption | undefined; + ShareDataSources?: CapabilityState | undefined; /** - *

The data point menu label options of a dashboard.

+ *

The ability to view account SPICE capacity.

* @public */ - DataPointMenuLabelOption?: DataPointMenuLabelOption | undefined; + ViewAccountSPICECapacity?: CapabilityState | undefined; /** - *

The data point tool tip options of a dashboard.

+ *

The ability to create a SPICE dataset.

* @public */ - DataPointTooltipOption?: DataPointTooltipOption | undefined; + CreateSPICEDataset?: CapabilityState | undefined; } /** - *

The contents of a dashboard.

* @public + * @enum */ -export interface DashboardVersionDefinition { - /** - *

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 - */ - DataSetIdentifierDeclarations: DataSetIdentifierDeclaration[] | undefined; +export const ColumnDataType = { + DATETIME: "DATETIME", + DECIMAL: "DECIMAL", + INTEGER: "INTEGER", + STRING: "STRING", +} as const; - /** - *

An array of sheet definitions for a dashboard.

- * @public - */ - Sheets?: SheetDefinition[] | undefined; +/** + * @public + */ +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 { /** - *

An array of calculated field definitions for the dashboard.

+ *

Column name.

* @public */ - CalculatedFields?: CalculatedField[] | undefined; + ColumnName: string | 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.

+ *

New column data type.

* @public */ - ParameterDeclarations?: ParameterDeclaration[] | undefined; + NewColumnType: ColumnDataType | undefined; /** - *

The filter definitions for a dashboard.

- *

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

+ *

The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.

* @public */ - FilterGroups?: FilterGroup[] | undefined; + SubType?: ColumnDataSubType | 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.

+ *

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 */ - ColumnConfigurations?: ColumnConfiguration[] | undefined; + Format?: string | 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.

+ * @public + */ +export interface CellValueSynonym { /** - *

The configuration for default analysis settings.

+ *

The cell value.

* @public */ - AnalysisDefaults?: AnalysisDefaults | undefined; + CellValue?: string | undefined; /** - *

An array of option definitions for a dashboard.

+ *

Other names or aliases for the cell value.

* @public */ - Options?: AssetOptions | undefined; + Synonyms?: string[] | undefined; } /** - *

A structure that contains the configuration of a shareable link to the dashboard.

+ *

A structure that represents a collective constant.

* @public */ -export interface LinkSharingConfiguration { +export interface CollectiveConstant { /** - *

A structure that contains the permissions of a shareable link.

+ *

A list of values for the collective constant.

* @public */ - Permissions?: ResourcePermission[] | undefined; + ValueList?: string[] | undefined; } /** - *

Dashboard source template.

* @public + * @enum */ -export interface DashboardSourceTemplate { - /** - *

Dataset references.

- * @public - */ - DataSetReferences: DataSetReference[] | undefined; +export const ColumnDataRole = { + DIMENSION: "DIMENSION", + MEASURE: "MEASURE", +} as const; - /** - *

The Amazon Resource Name (ARN) of the resource.

- * @public - */ - Arn: string | undefined; -} +/** + * @public + */ +export type ColumnDataRole = (typeof ColumnDataRole)[keyof typeof ColumnDataRole]; /** - *

Dashboard source entity.

+ *

Metadata that contains a description for a column.

* @public */ -export interface DashboardSourceEntity { +export interface ColumnDescription { /** - *

Source template.

+ *

The text of a description for a column.

* @public */ - SourceTemplate?: DashboardSourceTemplate | undefined; + Text?: string | undefined; } /** * @public + * @enum */ -export interface CreateDashboardRequest { - /** - *

The ID of the Amazon Web Services account where you want to create the dashboard.

- * @public - */ - AwsAccountId: string | undefined; +export const GeoSpatialCountryCode = { + US: "US", +} as const; - /** - *

The ID for the dashboard, also added to the IAM policy.

- * @public - */ - DashboardId: string | undefined; +/** + * @public + */ +export type GeoSpatialCountryCode = (typeof GeoSpatialCountryCode)[keyof typeof GeoSpatialCountryCode]; +/** + *

Geospatial column group that denotes a hierarchy.

+ * @public + */ +export interface GeoSpatialColumnGroup { /** - *

The display name of the dashboard.

+ *

A display name for the hierarchy.

* @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.

+ *

Country code.

* @public */ - Parameters?: _Parameters | undefined; + CountryCode?: GeoSpatialCountryCode | 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.

+ *

Columns in this hierarchy.

* @public */ - Permissions?: ResourcePermission[] | undefined; + Columns: string[] | 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 { /** - *

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.

+ *

Geospatial column group that denotes a hierarchy.

* @public */ - SourceEntity?: DashboardSourceEntity | undefined; + GeoSpatialColumnGroup?: GeoSpatialColumnGroup | undefined; +} +/** + *

A structure describing the name, data type, and geographic role of the columns.

+ * @public + */ +export interface ColumnGroupColumnSchema { /** - *

Contains a map of the key-value pairs for the resource tag or tags assigned to the - * dashboard.

+ *

The name of the column group's column schema.

* @public */ - Tags?: Tag[] | undefined; + Name?: string | undefined; +} +/** + *

The column group schema.

+ * @public + */ +export interface ColumnGroupSchema { /** - *

A description for the first version of the dashboard being created.

+ *

The name of the column group schema.

* @public */ - VersionDescription?: string | undefined; + Name?: string | 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.

    - *
  • - *
+ *

A structure containing the list of schemas for column group columns.

* @public */ - DashboardPublishOptions?: DashboardPublishOptions | 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 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.

+ *

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

* @public */ - ThemeArn?: string | undefined; + Principals?: 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.

+ *

An array of column names.

* @public */ - Definition?: DashboardVersionDefinition | undefined; + ColumnNames?: string[] | undefined; +} - /** - *

The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.

- * @public - */ - ValidationStrategy?: ValidationStrategy | undefined; +/** + * @internal + */ +export const PluginVisualConfigurationFilterSensitiveLog = (obj: PluginVisualConfiguration): any => ({ + ...obj, +}); - /** - *

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

- * @public - */ - FolderArns?: string[] | undefined; +/** + * @internal + */ +export const PluginVisualFilterSensitiveLog = (obj: PluginVisual): any => ({ + ...obj, +}); - /** - *

A structure that contains the permissions of a shareable link to the dashboard.

- * @public - */ - LinkSharingConfiguration?: LinkSharingConfiguration | undefined; +/** + * @internal + */ +export const RadarChartAggregatedFieldWellsFilterSensitiveLog = (obj: RadarChartAggregatedFieldWells): any => ({ + ...obj, + ...(obj.Values && { Values: obj.Values.map((item) => MeasureFieldFilterSensitiveLog(item)) }), +}); - /** - *

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

- * @public - */ - LinkEntities?: string[] | undefined; -} +/** + * @internal + */ +export const RadarChartFieldWellsFilterSensitiveLog = (obj: RadarChartFieldWells): any => ({ + ...obj, +}); /** - * @public + * @internal */ -export interface CreateDashboardResponse { - /** - *

The ARN of the dashboard.

- * @public - */ - Arn?: string | undefined; +export const RadarChartConfigurationFilterSensitiveLog = (obj: RadarChartConfiguration): any => ({ + ...obj, + ...(obj.VisualPalette && { VisualPalette: VisualPaletteFilterSensitiveLog(obj.VisualPalette) }), +}); - /** - *

The ARN of the dashboard, including the version number of the first version that is - * created.

- * @public - */ - VersionArn?: string | undefined; +/** + * @internal + */ +export const RadarChartVisualFilterSensitiveLog = (obj: RadarChartVisual): any => ({ + ...obj, +}); - /** - *

The ID for the dashboard.

- * @public - */ - DashboardId?: string | undefined; +/** + * @internal + */ +export const SankeyDiagramAggregatedFieldWellsFilterSensitiveLog = (obj: SankeyDiagramAggregatedFieldWells): any => ({ + ...obj, + ...(obj.Weight && { Weight: obj.Weight.map((item) => MeasureFieldFilterSensitiveLog(item)) }), +}); - /** - *

The status of the dashboard creation request.

- * @public - */ - CreationStatus?: ResourceStatus | undefined; +/** + * @internal + */ +export const SankeyDiagramFieldWellsFilterSensitiveLog = (obj: SankeyDiagramFieldWells): any => ({ + ...obj, +}); - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; +/** + * @internal + */ +export const SankeyDiagramChartConfigurationFilterSensitiveLog = (obj: SankeyDiagramChartConfiguration): any => ({ + ...obj, + ...(obj.DataLabels && { DataLabels: DataLabelOptionsFilterSensitiveLog(obj.DataLabels) }), +}); - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; -} +/** + * @internal + */ +export const SankeyDiagramVisualFilterSensitiveLog = (obj: SankeyDiagramVisual): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ScatterPlotCategoricallyAggregatedFieldWellsFilterSensitiveLog = ( + obj: ScatterPlotCategoricallyAggregatedFieldWells +): any => ({ + ...obj, + ...(obj.XAxis && { XAxis: obj.XAxis.map((item) => MeasureFieldFilterSensitiveLog(item)) }), + ...(obj.YAxis && { YAxis: obj.YAxis.map((item) => MeasureFieldFilterSensitiveLog(item)) }), + ...(obj.Size && { Size: obj.Size.map((item) => MeasureFieldFilterSensitiveLog(item)) }), +}); /** - *

The default values of a date time parameter.

- * @public + * @internal */ -export interface DateTimeDatasetParameterDefaultValues { - /** - *

A list of static default values for a given date time parameter.

- * @public - */ - StaticValues?: Date[] | undefined; -} +export const ScatterPlotUnaggregatedFieldWellsFilterSensitiveLog = (obj: ScatterPlotUnaggregatedFieldWells): any => ({ + ...obj, + ...(obj.Size && { Size: obj.Size.map((item) => MeasureFieldFilterSensitiveLog(item)) }), +}); /** - * @public - * @enum + * @internal */ -export const DatasetParameterValueType = { - MULTI_VALUED: "MULTI_VALUED", - SINGLE_VALUED: "SINGLE_VALUED", -} as const; +export const ScatterPlotFieldWellsFilterSensitiveLog = (obj: ScatterPlotFieldWells): any => ({ + ...obj, + ...(obj.ScatterPlotCategoricallyAggregatedFieldWells && { + ScatterPlotCategoricallyAggregatedFieldWells: ScatterPlotCategoricallyAggregatedFieldWellsFilterSensitiveLog( + obj.ScatterPlotCategoricallyAggregatedFieldWells + ), + }), +}); /** - * @public + * @internal */ -export type DatasetParameterValueType = (typeof DatasetParameterValueType)[keyof typeof DatasetParameterValueType]; +export const ScatterPlotConfigurationFilterSensitiveLog = (obj: ScatterPlotConfiguration): any => ({ + ...obj, + ...(obj.FieldWells && { FieldWells: ScatterPlotFieldWellsFilterSensitiveLog(obj.FieldWells) }), + ...(obj.DataLabels && { DataLabels: DataLabelOptionsFilterSensitiveLog(obj.DataLabels) }), + ...(obj.VisualPalette && { VisualPalette: VisualPaletteFilterSensitiveLog(obj.VisualPalette) }), +}); /** - *

A date time parameter for a dataset.

- * @public + * @internal */ -export interface DateTimeDatasetParameter { - /** - *

An identifier for the parameter that is created in the dataset.

- * @public - */ - Id: string | undefined; - - /** - *

The name of the date time parameter that is created in the dataset.

- * @public - */ - Name: string | undefined; - - /** - *

The value type of the dataset parameter. Valid values are single value or multi value.

- * @public - */ - ValueType: DatasetParameterValueType | undefined; - - /** - *

The time granularity of the date time parameter.

- * @public - */ - TimeGranularity?: TimeGranularity | undefined; - - /** - *

A list of default values for a given date time parameter. This structure only accepts static values.

- * @public - */ - DefaultValues?: DateTimeDatasetParameterDefaultValues | undefined; -} +export const ScatterPlotVisualFilterSensitiveLog = (obj: ScatterPlotVisual): any => ({ + ...obj, + ...(obj.ChartConfiguration && { + ChartConfiguration: ScatterPlotConfigurationFilterSensitiveLog(obj.ChartConfiguration), + }), +}); /** - *

The default values of a decimal parameter.

- * @public + * @internal */ -export interface DecimalDatasetParameterDefaultValues { - /** - *

A list of static default values for a given decimal parameter.

- * @public - */ - StaticValues?: number[] | undefined; -} +export const TableAggregatedFieldWellsFilterSensitiveLog = (obj: TableAggregatedFieldWells): any => ({ + ...obj, + ...(obj.Values && { Values: obj.Values.map((item) => MeasureFieldFilterSensitiveLog(item)) }), +}); /** - *

A decimal parameter for a dataset.

- * @public + * @internal */ -export interface DecimalDatasetParameter { - /** - *

An identifier for the decimal parameter created in the dataset.

- * @public - */ - Id: string | undefined; - - /** - *

The name of the decimal parameter that is created in the dataset.

- * @public - */ - Name: string | undefined; - - /** - *

The value type of the dataset parameter. Valid values are single value or multi value.

- * @public - */ - ValueType: DatasetParameterValueType | undefined; - - /** - *

A list of default values for a given decimal parameter. This structure only accepts static values.

- * @public - */ - DefaultValues?: DecimalDatasetParameterDefaultValues | undefined; -} +export const TableUnaggregatedFieldWellsFilterSensitiveLog = (obj: TableUnaggregatedFieldWells): any => ({ + ...obj, + ...(obj.Values && { Values: obj.Values.map((item) => UnaggregatedFieldFilterSensitiveLog(item)) }), +}); /** - *

The default values of an integer parameter.

- * @public + * @internal */ -export interface IntegerDatasetParameterDefaultValues { - /** - *

A list of static default values for a given integer parameter.

- * @public - */ - StaticValues?: number[] | undefined; -} +export const TableFieldWellsFilterSensitiveLog = (obj: TableFieldWells): any => ({ + ...obj, + ...(obj.TableUnaggregatedFieldWells && { + TableUnaggregatedFieldWells: TableUnaggregatedFieldWellsFilterSensitiveLog(obj.TableUnaggregatedFieldWells), + }), +}); /** - *

An integer parameter for a dataset.

- * @public + * @internal */ -export interface IntegerDatasetParameter { - /** - *

An identifier for the integer parameter created in the dataset.

- * @public - */ - Id: string | undefined; - - /** - *

The name of the integer parameter that is created in the dataset.

- * @public - */ - Name: string | undefined; - - /** - *

The value type of the dataset parameter. Valid values are single value or multi value.

- * @public - */ - ValueType: DatasetParameterValueType | undefined; - - /** - *

A list of default values for a given integer parameter. This structure only accepts static values.

- * @public - */ - DefaultValues?: IntegerDatasetParameterDefaultValues | undefined; -} +export const TableConfigurationFilterSensitiveLog = (obj: TableConfiguration): any => ({ + ...obj, +}); /** - *

The default values of a string parameter.

- * @public + * @internal */ -export interface StringDatasetParameterDefaultValues { - /** - *

A list of static default values for a given string parameter.

- * @public - */ - StaticValues?: string[] | undefined; -} +export const TableCellConditionalFormattingFilterSensitiveLog = (obj: TableCellConditionalFormatting): any => ({ + ...obj, + ...(obj.TextFormat && { TextFormat: TextConditionalFormatFilterSensitiveLog(obj.TextFormat) }), +}); /** - *

A string parameter for a dataset.

- * @public + * @internal */ -export interface StringDatasetParameter { - /** - *

An identifier for the string parameter that is created in the dataset.

- * @public - */ - Id: string | undefined; - - /** - *

The name of the string parameter that is created in the dataset.

- * @public - */ - Name: string | undefined; - - /** - *

The value type of the dataset parameter. Valid values are single value or multi value.

- * @public - */ - ValueType: DatasetParameterValueType | undefined; +export const TableRowConditionalFormattingFilterSensitiveLog = (obj: TableRowConditionalFormatting): any => ({ + ...obj, + ...(obj.BackgroundColor && { BackgroundColor: ConditionalFormattingColorFilterSensitiveLog(obj.BackgroundColor) }), + ...(obj.TextColor && { TextColor: ConditionalFormattingColorFilterSensitiveLog(obj.TextColor) }), +}); - /** - *

A list of default values for a given string dataset parameter type. This structure only accepts static values.

- * @public - */ - DefaultValues?: StringDatasetParameterDefaultValues | undefined; -} +/** + * @internal + */ +export const TableConditionalFormattingOptionFilterSensitiveLog = (obj: TableConditionalFormattingOption): any => ({ + ...obj, + ...(obj.Cell && { Cell: TableCellConditionalFormattingFilterSensitiveLog(obj.Cell) }), + ...(obj.Row && { Row: TableRowConditionalFormattingFilterSensitiveLog(obj.Row) }), +}); /** - *

A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.

- * @public + * @internal */ -export interface DatasetParameter { - /** - *

A string parameter that is created in the dataset.

- * @public - */ - StringDatasetParameter?: StringDatasetParameter | undefined; +export const TableConditionalFormattingFilterSensitiveLog = (obj: TableConditionalFormatting): any => ({ + ...obj, + ...(obj.ConditionalFormattingOptions && { + ConditionalFormattingOptions: obj.ConditionalFormattingOptions.map((item) => + TableConditionalFormattingOptionFilterSensitiveLog(item) + ), + }), +}); - /** - *

A decimal parameter that is created in the dataset.

- * @public - */ - DecimalDatasetParameter?: DecimalDatasetParameter | undefined; +/** + * @internal + */ +export const TableVisualFilterSensitiveLog = (obj: TableVisual): any => ({ + ...obj, + ...(obj.ConditionalFormatting && { + ConditionalFormatting: TableConditionalFormattingFilterSensitiveLog(obj.ConditionalFormatting), + }), +}); - /** - *

An integer parameter that is created in the dataset.

- * @public - */ - IntegerDatasetParameter?: IntegerDatasetParameter | undefined; +/** + * @internal + */ +export const TreeMapAggregatedFieldWellsFilterSensitiveLog = (obj: TreeMapAggregatedFieldWells): any => ({ + ...obj, + ...(obj.Sizes && { Sizes: obj.Sizes.map((item) => MeasureFieldFilterSensitiveLog(item)) }), + ...(obj.Colors && { Colors: obj.Colors.map((item) => MeasureFieldFilterSensitiveLog(item)) }), +}); - /** - *

A date time parameter that is created in the dataset.

- * @public - */ - DateTimeDatasetParameter?: DateTimeDatasetParameter | undefined; -} +/** + * @internal + */ +export const TreeMapFieldWellsFilterSensitiveLog = (obj: TreeMapFieldWells): any => ({ + ...obj, +}); /** * @internal @@ -8708,6 +8720,7 @@ export const VisualFilterSensitiveLog = (obj: Visual): any => ({ ...obj, ...(obj.KPIVisual && { KPIVisual: KPIVisualFilterSensitiveLog(obj.KPIVisual) }), ...(obj.GaugeChartVisual && { GaugeChartVisual: GaugeChartVisualFilterSensitiveLog(obj.GaugeChartVisual) }), + ...(obj.LayerMapVisual && { LayerMapVisual: LayerMapVisualFilterSensitiveLog(obj.LayerMapVisual) }), ...(obj.ScatterPlotVisual && { ScatterPlotVisual: ScatterPlotVisualFilterSensitiveLog(obj.ScatterPlotVisual) }), ...(obj.HistogramVisual && { HistogramVisual: HistogramVisualFilterSensitiveLog(obj.HistogramVisual) }), ...(obj.InsightVisual && { InsightVisual: InsightVisualFilterSensitiveLog(obj.InsightVisual) }), @@ -8850,102 +8863,3 @@ export const ColumnDescriptionFilterSensitiveLog = (obj: ColumnDescription): any ...obj, ...(obj.Text && { Text: SENSITIVE_STRING }), }); - -/** - * @internal - */ -export const ColumnTagFilterSensitiveLog = (obj: ColumnTag): any => ({ - ...obj, - ...(obj.ColumnDescription && { ColumnDescription: ColumnDescriptionFilterSensitiveLog(obj.ColumnDescription) }), -}); - -/** - * @internal - */ -export const DateTimeParameterFilterSensitiveLog = (obj: DateTimeParameter): any => ({ - ...obj, - ...(obj.Values && { Values: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const DecimalParameterFilterSensitiveLog = (obj: DecimalParameter): any => ({ - ...obj, - ...(obj.Values && { Values: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const IntegerParameterFilterSensitiveLog = (obj: IntegerParameter): any => ({ - ...obj, - ...(obj.Values && { Values: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const StringParameterFilterSensitiveLog = (obj: StringParameter): any => ({ - ...obj, - ...(obj.Values && { Values: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const _ParametersFilterSensitiveLog = (obj: _Parameters): any => ({ - ...obj, - ...(obj.StringParameters && { - StringParameters: obj.StringParameters.map((item) => StringParameterFilterSensitiveLog(item)), - }), - ...(obj.IntegerParameters && { - IntegerParameters: obj.IntegerParameters.map((item) => IntegerParameterFilterSensitiveLog(item)), - }), - ...(obj.DecimalParameters && { - DecimalParameters: obj.DecimalParameters.map((item) => DecimalParameterFilterSensitiveLog(item)), - }), - ...(obj.DateTimeParameters && { - DateTimeParameters: obj.DateTimeParameters.map((item) => DateTimeParameterFilterSensitiveLog(item)), - }), -}); - -/** - * @internal - */ -export const CreateAnalysisRequestFilterSensitiveLog = (obj: CreateAnalysisRequest): any => ({ - ...obj, - ...(obj.Parameters && { Parameters: _ParametersFilterSensitiveLog(obj.Parameters) }), -}); - -/** - * @internal - */ -export const CreateColumnsOperationFilterSensitiveLog = (obj: CreateColumnsOperation): any => ({ - ...obj, - ...(obj.Columns && { Columns: obj.Columns.map((item) => CalculatedColumnFilterSensitiveLog(item)) }), -}); - -/** - * @internal - */ -export const DashboardVersionDefinitionFilterSensitiveLog = (obj: DashboardVersionDefinition): any => ({ - ...obj, - ...(obj.CalculatedFields && { - CalculatedFields: obj.CalculatedFields.map((item) => CalculatedFieldFilterSensitiveLog(item)), - }), - ...(obj.ParameterDeclarations && { - ParameterDeclarations: obj.ParameterDeclarations.map((item) => ParameterDeclarationFilterSensitiveLog(item)), - }), - ...(obj.ColumnConfigurations && { - ColumnConfigurations: obj.ColumnConfigurations.map((item) => ColumnConfigurationFilterSensitiveLog(item)), - }), -}); - -/** - * @internal - */ -export const CreateDashboardRequestFilterSensitiveLog = (obj: CreateDashboardRequest): any => ({ - ...obj, - ...(obj.Parameters && { Parameters: _ParametersFilterSensitiveLog(obj.Parameters) }), -}); diff --git a/clients/client-quicksight/src/models/models_3.ts b/clients/client-quicksight/src/models/models_3.ts index a2014452b5a6..fc2dfe65ccd6 100644 --- a/clients/client-quicksight/src/models/models_3.ts +++ b/clients/client-quicksight/src/models/models_3.ts @@ -5,6 +5,7 @@ import { AccountCustomization, AccountInfo, AccountSettings, + AdHocFilteringOption, Analysis, AnalysisDefaults, AnalysisError, @@ -13,6 +14,9 @@ import { CalculatedFieldFilterSensitiveLog, ColumnConfiguration, ColumnConfigurationFilterSensitiveLog, + DashboardBehavior, + DataSetIdentifierDeclaration, + Edition, Entity, FilterGroup, ParameterDeclaration, @@ -20,35 +24,22 @@ import { QueryExecutionOptions, ResourceStatus, Sheet, + TimeGranularity, TopicTimeGranularity, + VisualMenuOption, } from "./models_0"; import { - _Parameters, - _ParametersFilterSensitiveLog, AnalysisDefinition, - AnonymousUserSnapshotJobResult, - AssetBundleCloudFormationOverridePropertyConfiguration, - AssetBundleExportFormat, - AssetBundleExportJobError, - AssetBundleExportJobStatus, - AssetBundleExportJobValidationStrategy, - AssetBundleExportJobWarning, - AssetBundleImportFailureAction, - AssetBundleImportJobError, - AssetBundleImportJobOverrideParameters, - AssetBundleImportJobOverridePermissions, - AssetBundleImportJobOverrideTags, - AssetBundleImportJobOverrideValidationStrategy, - AssetBundleImportJobStatus, - AssetBundleImportJobWarning, - AssetBundleImportSourceDescription, - AssetBundleImportSourceDescriptionFilterSensitiveLog, + AnalysisSourceEntity, AssignmentStatus, + AuthenticationMethodOption, AuthorSpecifiedAggregation, BorderStyle, BrandDefinition, BrandDetail, + CalculatedColumn, + CalculatedColumnFilterSensitiveLog, Capabilities, CastColumnTypeOperation, CategoryFilterFunction, @@ -58,5972 +49,5923 @@ import { ColumnDataRole, ColumnDataSubType, ColumnDataType, + ColumnDescription, + ColumnDescriptionFilterSensitiveLog, ColumnGroup, ColumnGroupSchema, ColumnLevelPermissionRule, - ColumnSchema, - ColumnTag, - ColumnTagFilterSensitiveLog, - ColumnTagName, - ComparativeOrder, ConstantType, - CreateColumnsOperation, - CreateColumnsOperationFilterSensitiveLog, - DashboardPublishOptions, - DashboardVersionDefinition, - DatasetParameter, DataSetReference, DataSourceParameters, DisplayFormat, DisplayFormatOptions, + ExceptionResourceType, FilterClass, FilterOperator, - LinkSharingConfiguration, - ResourcePermission, ServiceType, SheetDefinition, - SnapshotFile, - SnapshotS3DestinationConfiguration, SslProperties, + StaticFile, Tag, - ValidationStrategy, VpcConnectionProperties, } from "./models_2"; import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException"; /** - *

The usage configuration to apply to child datasets that reference this dataset as a source.

* @public + * @enum */ -export interface DataSetUsageConfiguration { +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 { /** - *

An option that controls whether a child dataset of a direct query can use this dataset as a source.

+ *

The name of the column schema.

* @public */ - DisableUseAsDirectQuerySource?: boolean | undefined; + Name?: string | undefined; /** - *

An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

+ *

The data type of the column schema.

* @public */ - DisableUseAsImportedSource?: boolean | undefined; + DataType?: string | undefined; + + /** + *

The geographic role of the column schema.

+ * @public + */ + GeographicRole?: string | undefined; } /** - *

A FieldFolder element is a folder that contains fields and nested subfolders.

* @public + * @enum */ -export interface FieldFolder { +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]; + +/** + *

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 { /** - *

The description for a field folder.

+ *

A geospatial role for a column.

* @public */ - description?: string | undefined; + ColumnGeographicRole?: GeoSpatialDataRole | undefined; /** - *

A folder has a list of columns. A column can only be in one folder.

+ *

A description for a column.

* @public */ - columns?: string[] | undefined; + ColumnDescription?: ColumnDescription | undefined; } /** * @public * @enum */ -export const DataSetImportMode = { - DIRECT_QUERY: "DIRECT_QUERY", - SPICE: "SPICE", +export const ColumnTagName = { + COLUMN_DESCRIPTION: "COLUMN_DESCRIPTION", + COLUMN_GEOGRAPHIC_ROLE: "COLUMN_GEOGRAPHIC_ROLE", } as const; /** * @public */ -export type DataSetImportMode = (typeof DataSetImportMode)[keyof typeof DataSetImportMode]; +export type ColumnTagName = (typeof ColumnTagName)[keyof typeof ColumnTagName]; /** - *

A transform operation that filters rows based on a condition.

* @public + * @enum */ -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.

- * @public - */ - ConditionExpression: string | undefined; -} +export const UndefinedSpecifiedValueType = { + LEAST: "LEAST", + MOST: "MOST", +} as const; /** - *

The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.

* @public */ -export interface NewDefaultValues { +export type UndefinedSpecifiedValueType = + (typeof UndefinedSpecifiedValueType)[keyof typeof UndefinedSpecifiedValueType]; + +/** + *

A structure that represents a comparative order.

+ * @public + */ +export interface ComparativeOrder { /** - *

A list of static default values for a given string parameter.

+ *

The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.

* @public */ - StringStaticValues?: string[] | undefined; + UseOrdering?: ColumnOrderingType | undefined; /** - *

A list of static default values for a given decimal parameter.

+ *

The list of columns to be used in the ordering.

* @public */ - DecimalStaticValues?: number[] | undefined; + SpecifedOrder?: string[] | undefined; /** - *

A list of static default values for a given date time parameter.

+ *

The treat of undefined specified values. Valid values for this structure are LEAST and MOST.

* @public */ - DateTimeStaticValues?: Date[] | undefined; + 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; /** - *

A list of static default values for a given integer parameter.

- * @public + * @internal */ - IntegerStaticValues?: number[] | undefined; + constructor(opts: __ExceptionOptionType) { + super({ + name: "ConcurrentUpdatingException", + $fault: "server", + ...opts, + }); + Object.setPrototypeOf(this, ConcurrentUpdatingException.prototype); + this.Message = opts.Message; + this.RequestId = opts.RequestId; + } } /** - *

A transform operation that overrides the dataset parameter values that are defined in another dataset.

* @public */ -export interface OverrideDatasetParameterOperation { +export interface CreateAccountCustomizationRequest { /** - *

The name of the parameter to be overridden with different values.

+ *

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

* @public */ - ParameterName: string | undefined; + AwsAccountId: string | undefined; /** - *

The new name for the parameter.

+ *

The Amazon QuickSight namespace that you want to add customizations to.

* @public */ - NewParameterName?: string | undefined; + Namespace?: string | undefined; /** - *

The new default values for the parameter.

+ *

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 */ - NewDefaultValues?: NewDefaultValues | undefined; -} + AccountCustomization: AccountCustomization | 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.

+ *

A list of the tags that you want to attach to this resource.

* @public */ - ProjectedColumns: string[] | undefined; + Tags?: Tag[] | undefined; } /** - *

A transform operation that renames a column.

* @public */ -export interface RenameColumnOperation { +export interface CreateAccountCustomizationResponse { /** - *

The name of the column to be renamed.

+ *

The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.

* @public */ - ColumnName: string | undefined; + Arn?: string | undefined; /** - *

The new name for the column.

+ *

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

* @public */ - NewColumnName: string | undefined; -} + AwsAccountId?: string | undefined; -/** - *

A transform operation that tags a column with additional information.

- * @public - */ -export interface TagColumnOperation { /** - *

The column that this operation acts on.

+ *

The namespace associated with the customization you're creating.

* @public */ - ColumnName: string | undefined; + Namespace?: string | 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 QuickSight customizations you're adding in the current Amazon Web Services Region.

* @public */ - Tags: ColumnTag[] | undefined; + AccountCustomization?: AccountCustomization | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; } /** - *

A transform operation that removes tags associated with a column.

+ *

This resource is currently unavailable.

* @public */ -export interface UntagColumnOperation { +export class ResourceUnavailableException extends __BaseException { + readonly name: "ResourceUnavailableException" = "ResourceUnavailableException"; + readonly $fault: "server" = "server"; + Message?: string | undefined; /** - *

The column that this operation acts on.

+ *

The resource type for this request.

* @public */ - ColumnName: string | undefined; + ResourceType?: ExceptionResourceType | undefined; /** - *

The column tags to remove from this column.

+ *

The Amazon Web Services request ID for this request.

* @public */ - TagNames: ColumnTagName[] | 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; + } } /** - *

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; +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; -/** - * @public - */ -export namespace TransformOperation { /** - *

An operation that projects columns. Operations that come after a projection can only - * refer to projected columns.

+ *

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 */ - export interface ProjectOperationMember { - ProjectOperation: ProjectOperation; - FilterOperation?: never; - CreateColumnsOperation?: never; - RenameColumnOperation?: never; - CastColumnTypeOperation?: never; - TagColumnOperation?: never; - UntagColumnOperation?: never; - OverrideDatasetParameterOperation?: never; - $unknown?: never; - } + AuthenticationMethod: AuthenticationMethodOption | undefined; /** - *

An operation that filters rows based on some condition.

+ *

The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.

* @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 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 */ - export interface CreateColumnsOperationMember { - ProjectOperation?: never; - FilterOperation?: never; - CreateColumnsOperation: CreateColumnsOperation; - RenameColumnOperation?: never; - CastColumnTypeOperation?: never; - TagColumnOperation?: never; - UntagColumnOperation?: never; - OverrideDatasetParameterOperation?: never; - $unknown?: never; - } + AccountName: string | undefined; /** - *

An operation that renames a column.

+ *

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

* @public */ - export interface RenameColumnOperationMember { - ProjectOperation?: never; - FilterOperation?: never; - CreateColumnsOperation?: never; - RenameColumnOperation: RenameColumnOperation; - CastColumnTypeOperation?: never; - TagColumnOperation?: never; - UntagColumnOperation?: never; - OverrideDatasetParameterOperation?: never; - $unknown?: never; - } + NotificationEmail: string | undefined; /** - *

A transform operation that casts a column to a different type.

+ *

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 */ - export interface CastColumnTypeOperationMember { - ProjectOperation?: never; - FilterOperation?: never; - CreateColumnsOperation?: never; - RenameColumnOperation?: never; - CastColumnTypeOperation: CastColumnTypeOperation; - TagColumnOperation?: never; - UntagColumnOperation?: never; - OverrideDatasetParameterOperation?: never; - $unknown?: never; - } + ActiveDirectoryName?: string | undefined; /** - *

An operation that tags a column with additional information.

+ *

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 */ - export interface TagColumnOperationMember { - ProjectOperation?: never; - FilterOperation?: never; - CreateColumnsOperation?: never; - RenameColumnOperation?: never; - CastColumnTypeOperation?: never; - TagColumnOperation: TagColumnOperation; - UntagColumnOperation?: never; - OverrideDatasetParameterOperation?: never; - $unknown?: never; - } + Realm?: string | undefined; /** - *

A transform operation that removes tags associated with a column.

+ *

The ID of the Active Directory that is associated with your Amazon QuickSight account.

* @public */ - export interface UntagColumnOperationMember { - ProjectOperation?: never; - FilterOperation?: never; - CreateColumnsOperation?: never; - RenameColumnOperation?: never; - CastColumnTypeOperation?: never; - TagColumnOperation?: never; - UntagColumnOperation: UntagColumnOperation; - OverrideDatasetParameterOperation?: never; - $unknown?: never; - } + DirectoryId?: string | undefined; /** - *

A transform operation that overrides the dataset parameter values that are defined in another dataset.

+ *

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 */ - export interface OverrideDatasetParameterOperationMember { - ProjectOperation?: never; - FilterOperation?: never; - CreateColumnsOperation?: never; - RenameColumnOperation?: never; - CastColumnTypeOperation?: never; - TagColumnOperation?: never; - UntagColumnOperation?: never; - OverrideDatasetParameterOperation: OverrideDatasetParameterOperation; - $unknown?: never; - } + AdminGroup?: string[] | 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.

* @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]); - }; -} + AuthorGroup?: 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.

+ *

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 */ - UniqueKey?: boolean | undefined; -} + ReaderGroup?: string[] | undefined; -/** - * @public - * @enum - */ -export const JoinType = { - INNER: "INNER", - LEFT: "LEFT", - OUTER: "OUTER", - RIGHT: "RIGHT", -} as const; + /** + *

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 + */ + AdminProGroup?: string[] | undefined; -/** - * @public - */ -export type JoinType = (typeof JoinType)[keyof typeof JoinType]; + /** + *

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 + */ + AuthorProGroup?: string[] | undefined; -/** - *

The instructions associated with a join.

- * @public - */ -export interface JoinInstruction { /** - *

The operand on the left side of a join.

+ *

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 */ - LeftOperand: string | undefined; + ReaderProGroup?: string[] | undefined; /** - *

The operand on the right side of a join.

+ *

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 */ - RightOperand: string | undefined; + FirstName?: string | undefined; /** - *

Join key properties of the left operand.

+ *

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 */ - LeftJoinKeyProperties?: JoinKeyProperties | undefined; + LastName?: string | undefined; /** - *

Join key properties of the right operand.

+ *

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 */ - RightJoinKeyProperties?: JoinKeyProperties | undefined; + EmailAddress?: string | undefined; /** - *

The type of join that it is.

+ *

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 */ - Type: JoinType | undefined; + ContactNumber?: string | undefined; /** - *

The join instructions provided in the ON clause of a join.

+ *

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

* @public */ - OnClause: string | undefined; + IAMIdentityCenterInstanceArn?: 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.

+ *

A SignupResponse object that contains a summary of a newly created account.

* @public */ -export interface LogicalTableSource { +export interface SignupResponse { /** - *

Specifies the result of a join of two logical tables.

+ *

A Boolean that is TRUE if the Amazon QuickSight uses IAM as an + * authentication method.

* @public */ - JoinInstruction?: JoinInstruction | undefined; + IAMUser?: boolean | undefined; /** - *

Physical table ID.

+ *

The user login name for your Amazon QuickSight account.

* @public */ - PhysicalTableId?: string | undefined; + userLoginName?: string | undefined; /** - *

The Amazon Resource Number (ARN) of the parent dataset.

+ *

The name of your Amazon QuickSight account.

* @public */ - DataSetArn?: string | undefined; + accountName?: string | 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.

+ * @public + */ + directoryType?: string | 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 { +export interface CreateAccountSubscriptionResponse { /** - *

A display name for the logical table.

+ *

A SignupResponse object that returns information about a newly created Amazon QuickSight account.

* @public */ - Alias: string | undefined; + SignupResponse?: SignupResponse | 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 HTTP status of the request.

* @public */ - DataTransforms?: TransformOperation[] | undefined; + Status?: number | undefined; /** - *

Source of this logical table.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Source: LogicalTableSource | undefined; + RequestId?: string | undefined; } /** - * @public - * @enum - */ -export const InputColumnDataType = { - BIT: "BIT", - BOOLEAN: "BOOLEAN", - DATETIME: "DATETIME", - DECIMAL: "DECIMAL", - INTEGER: "INTEGER", - JSON: "JSON", - STRING: "STRING", -} as const; - -/** + *

One or more preconditions aren't met.

* @public */ -export type InputColumnDataType = (typeof InputColumnDataType)[keyof typeof InputColumnDataType]; +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; + } +} /** - *

Metadata for a column that is used as the input of a transform operation.

+ *

A date-time parameter.

* @public */ -export interface InputColumn { +export interface DateTimeParameter { /** - *

The name of this column in the underlying data source.

+ *

A display name for the date-time parameter.

* @public */ Name: string | undefined; /** - *

The data type of the column.

+ *

The values for the date-time parameter.

* @public */ - Type: InputColumnDataType | undefined; + Values: Date[] | undefined; +} +/** + *

A decimal parameter.

+ * @public + */ +export interface DecimalParameter { /** - *

The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.

+ *

A display name for the decimal parameter.

* @public */ - SubType?: ColumnDataSubType | undefined; + Name: string | undefined; + + /** + *

The values for the decimal parameter.

+ * @public + */ + Values: number[] | undefined; } /** - *

A physical table type built from the results of the custom SQL query.

+ *

An integer parameter.

* @public */ -export interface CustomSql { +export interface IntegerParameter { /** - *

The Amazon Resource Name (ARN) of the data source.

+ *

The name of the integer parameter.

* @public */ - DataSourceArn: string | undefined; + Name: string | undefined; /** - *

A display name for the SQL query result.

+ *

The values for the integer parameter.

* @public */ - Name: string | undefined; + Values: number[] | undefined; +} +/** + *

A string parameter.

+ * @public + */ +export interface StringParameter { /** - *

The SQL query.

+ *

A display name for a string parameter.

* @public */ - SqlQuery: string | undefined; + Name: string | undefined; /** - *

The column schema from the SQL query result set.

+ *

The values of a string parameter.

* @public */ - Columns?: InputColumn[] | undefined; + Values: string[] | undefined; } /** - *

A physical table type for relational data sources.

+ *

A list of Amazon QuickSight parameters and the list's override values.

* @public */ -export interface RelationalTable { +export interface _Parameters { /** - *

The Amazon Resource Name (ARN) for the data source.

+ *

The parameters that have a data type of string.

* @public */ - DataSourceArn: string | undefined; + StringParameters?: StringParameter[] | undefined; /** - *

The catalog associated with a table.

+ *

The parameters that have a data type of integer.

* @public */ - Catalog?: string | undefined; + IntegerParameters?: IntegerParameter[] | undefined; /** - *

The schema name. This name applies to certain relational database engines.

+ *

The parameters that have a data type of decimal.

* @public */ - Schema?: string | undefined; + DecimalParameters?: DecimalParameter[] | undefined; /** - *

The name of the relational table.

+ *

The parameters that have a data type of date-time.

* @public */ - Name: string | undefined; + DateTimeParameters?: DateTimeParameter[] | undefined; +} + +/** + *

Permission for the resource.

+ * @public + */ +export interface ResourcePermission { + /** + *

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 + */ + Principal: string | undefined; /** - *

The column schema of the table.

+ *

The IAM action to grant or revoke permissions on.

* @public */ - InputColumns: InputColumn[] | undefined; + Actions: string[] | undefined; } /** * @public * @enum */ -export const FileFormat = { - CLF: "CLF", - CSV: "CSV", - ELF: "ELF", - JSON: "JSON", - TSV: "TSV", - XLSX: "XLSX", +export const ValidationStrategyMode = { + LENIENT: "LENIENT", + STRICT: "STRICT", } as const; /** * @public */ -export type FileFormat = (typeof FileFormat)[keyof typeof FileFormat]; +export type ValidationStrategyMode = (typeof ValidationStrategyMode)[keyof typeof ValidationStrategyMode]; /** + *

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 - * @enum */ -export const TextQualifier = { - DOUBLE_QUOTE: "DOUBLE_QUOTE", - SINGLE_QUOTE: "SINGLE_QUOTE", -} as const; +export interface ValidationStrategy { + /** + *

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 + */ + Mode: ValidationStrategyMode | undefined; +} /** * @public */ -export type TextQualifier = (typeof TextQualifier)[keyof typeof TextQualifier]; - -/** - *

Information about the format for a source file or files.

- * @public - */ -export interface UploadSettings { - /** - *

File format.

- * @public - */ - Format?: FileFormat | undefined; - +export interface CreateAnalysisRequest { /** - *

A row number to start reading data from.

+ *

The ID of the Amazon Web Services account where you are creating an analysis.

* @public */ - StartFromRow?: number | undefined; + AwsAccountId: string | undefined; /** - *

Whether the file has a header row, or the files each have a header row.

+ *

The ID for the analysis that you're creating. This ID displays in the URL of the + * analysis.

* @public */ - ContainsHeader?: boolean | undefined; + AnalysisId: string | undefined; /** - *

Text qualifier.

+ *

A descriptive name for the analysis that you're creating. This name displays for the + * analysis in the Amazon QuickSight console.

* @public */ - TextQualifier?: TextQualifier | undefined; + Name: string | undefined; /** - *

The delimiter between values in the file.

+ *

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 */ - Delimiter?: string | undefined; -} + Parameters?: _Parameters | undefined; -/** - *

A physical table type for an S3 data source.

- * @public - */ -export interface S3Source { /** - *

The Amazon Resource Name (ARN) for the data source.

+ *

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 */ - DataSourceArn: string | undefined; + Permissions?: ResourcePermission[] | undefined; /** - *

Information about the format for the S3 source file or files.

+ *

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 */ - UploadSettings?: UploadSettings | undefined; + SourceEntity?: AnalysisSourceEntity | 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.

- *
+ *

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 */ - 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 type PhysicalTable = - | PhysicalTable.CustomSqlMember - | PhysicalTable.RelationalTableMember - | PhysicalTable.S3SourceMember - | PhysicalTable.$UnknownMember; + ThemeArn?: string | undefined; -/** - * @public - */ -export namespace PhysicalTable { /** - *

A physical table type for relational data sources.

+ *

Contains a map of the key-value pairs for the resource tag or tags assigned to the + * analysis.

* @public */ - export interface RelationalTableMember { - RelationalTable: RelationalTable; - CustomSql?: never; - S3Source?: never; - $unknown?: never; - } + Tags?: Tag[] | undefined; /** - *

A physical table type built from the results of the custom SQL query.

+ *

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 */ - export interface CustomSqlMember { - RelationalTable?: never; - CustomSql: CustomSql; - S3Source?: never; - $unknown?: never; - } + Definition?: AnalysisDefinition | undefined; /** - *

A physical table type for as S3 data source.

+ *

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

* @public */ - export interface S3SourceMember { - RelationalTable?: never; - CustomSql?: never; - S3Source: S3Source; - $unknown?: never; - } + ValidationStrategy?: ValidationStrategy | undefined; /** + *

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

* @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]); - }; + FolderArns?: string[] | 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]; - -/** - * @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.

* @public */ -export interface RowLevelPermissionDataSet { +export interface CreateAnalysisResponse { /** - *

The namespace associated with the dataset that contains permissions for RLS.

+ *

The ARN for the analysis.

* @public */ - Namespace?: string | undefined; + Arn?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

+ *

The ID of the analysis.

* @public */ - Arn: string | undefined; + AnalysisId?: string | undefined; /** - *

The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS - * is included for backward compatibility only.

+ *

The status of the creation of the analysis.

* @public */ - PermissionPolicy: RowLevelPermissionPolicy | undefined; + CreationStatus?: ResourceStatus | 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.

+ *

The HTTP status of the request.

* @public */ - FormatVersion?: RowLevelPermissionFormatVersion | undefined; + Status?: number | undefined; /** - *

The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Status?: Status | undefined; + RequestId?: string | undefined; } /** - *

A set of rules associated with a tag.

+ *

A limit is exceeded.

* @public */ -export interface RowLevelPermissionTagRule { +export class LimitExceededException extends __BaseException { + readonly name: "LimitExceededException" = "LimitExceededException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; /** - *

The unique key for a tag.

+ *

Limit exceeded.

* @public */ - TagKey: string | undefined; + ResourceType?: ExceptionResourceType | undefined; /** - *

The column name that a tag key is assigned to.

+ *

The Amazon Web Services request ID for this request.

* @public */ - ColumnName: string | undefined; - + RequestId?: string | 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.

- * @public + * @internal */ - TagMultiValueDelimiter?: string | undefined; + 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 class UnsupportedUserEditionException extends __BaseException { + readonly name: "UnsupportedUserEditionException" = "UnsupportedUserEditionException"; + readonly $fault: "client" = "client"; + Message?: string | 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.

+ *

The Amazon Web Services request ID for this request.

* @public */ - MatchAllValue?: string | undefined; + RequestId?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType) { + super({ + name: "UnsupportedUserEditionException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, UnsupportedUserEditionException.prototype); + this.Message = opts.Message; + this.RequestId = opts.RequestId; + } } /** - *

The configuration of tags on a dataset to set row-level security.

* @public */ -export interface RowLevelPermissionTagConfiguration { +export interface CreateBrandRequest { /** - *

The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

+ *

The ID of the Amazon Web Services account that owns the brand.

* @public */ - Status?: Status | undefined; + AwsAccountId: string | undefined; /** - *

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

+ *

The ID of the Amazon QuickSight brand.

* @public */ - TagRules: RowLevelPermissionTagRule[] | undefined; + BrandId: 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 definition of the brand.

* @public */ - TagRuleConfigurations?: string[][] | undefined; + BrandDefinition?: BrandDefinition | undefined; + + /** + *

A map of the key-value pairs that are assigned to the brand.

+ * @public + */ + Tags?: Tag[] | undefined; } /** * @public */ -export interface CreateDataSetRequest { +export interface CreateBrandResponse { /** - *

The Amazon Web Services account ID.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AwsAccountId: string | undefined; + RequestId?: string | undefined; /** - *

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 details of the brand.

* @public */ - DataSetId: string | undefined; + BrandDetail?: BrandDetail | undefined; /** - *

The display name for the dataset.

+ *

The definition of the brand.

* @public */ - Name: string | undefined; - - /** - *

Declares the physical tables that are available in the underlying data sources.

- * @public - */ - PhysicalTableMap: Record | undefined; - - /** - *

Configures the combination and transformation of the data from the physical tables.

- * @public - */ - LogicalTableMap?: Record | undefined; + BrandDefinition?: BrandDefinition | undefined; +} +/** + *

An internal service exception.

+ * @public + */ +export class InternalServerException extends __BaseException { + readonly name: "InternalServerException" = "InternalServerException"; + readonly $fault: "server" = "server"; + Message: string | undefined; /** - *

Indicates whether you want to import the data into SPICE.

- * @public + * @internal */ - ImportMode: DataSetImportMode | undefined; + 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 class InvalidRequestException extends __BaseException { + readonly name: "InvalidRequestException" = "InvalidRequestException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; /** - *

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

+ *

The Amazon Web Services request ID for this request.

* @public */ - ColumnGroups?: ColumnGroup[] | undefined; - + RequestId?: string | undefined; /** - *

The folder that contains fields and nested subfolders for your dataset.

- * @public + * @internal */ - FieldFolders?: Record | undefined; + constructor(opts: __ExceptionOptionType) { + super({ + name: "InvalidRequestException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, InvalidRequestException.prototype); + this.Message = opts.Message; + this.RequestId = opts.RequestId; + } +} +/** + *

A transform operation that creates calculated columns. Columns created in one such + * operation form a lexical closure.

+ * @public + */ +export interface CreateColumnsOperation { /** - *

A list of resource permissions on the dataset.

+ *

Calculated columns to create.

* @public */ - Permissions?: ResourcePermission[] | undefined; + Columns: CalculatedColumn[] | undefined; +} +/** + * @public + */ +export interface CreateCustomPermissionsRequest { /** - *

The row-level security configuration for the data that you want to create.

+ *

The ID of the Amazon Web Services account that you want to create the custom permissions profile in.

* @public */ - RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; + AwsAccountId: string | undefined; /** - *

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

+ *

The name of the custom permissions profile that you want to create.

* @public */ - RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration | undefined; + CustomPermissionsName: string | undefined; /** - *

A set of one or more definitions of a - * ColumnLevelPermissionRule - * .

+ *

A set of actions to include in the custom permissions profile.

* @public */ - ColumnLevelPermissionRules?: ColumnLevelPermissionRule[] | undefined; + Capabilities?: Capabilities | undefined; /** - *

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

+ *

The tags to associate with the custom permissions profile.

* @public */ Tags?: Tag[] | undefined; +} +/** + * @public + */ +export interface CreateCustomPermissionsResponse { /** - *

The usage configuration to apply to child datasets that reference this dataset as a source.

+ *

The HTTP status of the request.

* @public */ - DataSetUsageConfiguration?: DataSetUsageConfiguration | undefined; + Status?: number | undefined; /** - *

The parameter declarations of the dataset.

+ *

The Amazon Resource Name (ARN) of the custom permissions profile.

* @public */ - DatasetParameters?: DatasetParameter[] | undefined; + Arn?: string | undefined; /** - *

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - FolderArns?: string[] | undefined; + RequestId?: string | undefined; } /** + *

The drill down options for data points in a dashbaord.

* @public */ -export interface CreateDataSetResponse { - /** - *

The Amazon Resource Name (ARN) of the dataset.

- * @public - */ - Arn?: string | undefined; - +export interface DataPointDrillUpDownOption { /** - *

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 status of the drill down options of data points.

* @public */ - DataSetId?: string | undefined; + AvailabilityStatus?: DashboardBehavior | undefined; +} +/** + *

The data point menu options of a dashboard.

+ * @public + */ +export interface DataPointMenuLabelOption { /** - *

The ARN for the ingestion, which is triggered as a result of dataset creation if the import - * mode is SPICE.

+ *

The status of the data point menu options.

* @public */ - IngestionArn?: string | undefined; + AvailabilityStatus?: DashboardBehavior | undefined; +} +/** + *

The data point tooltip options.

+ * @public + */ +export interface DataPointTooltipOption { /** - *

The ID of the ingestion, which is triggered as a result of dataset creation if the import - * mode is SPICE.

+ *

The status of the data point tool tip options.

* @public */ - IngestionId?: string | undefined; + AvailabilityStatus?: DashboardBehavior | undefined; +} +/** + *

Export to .csv option.

+ * @public + */ +export interface ExportToCSVOption { /** - *

The Amazon Web Services request ID for this operation.

+ *

Availability status.

* @public */ - RequestId?: string | undefined; + AvailabilityStatus?: DashboardBehavior | undefined; +} +/** + *

Determines whether or not hidden fields are visible on exported dashbaords.

+ * @public + */ +export interface ExportWithHiddenFieldsOption { /** - *

The HTTP status of the request.

+ *

The status of the export with hidden fields options.

* @public */ - Status?: number | undefined; + AvailabilityStatus?: DashboardBehavior | undefined; } /** - *

The combination of user name and password that are used as credentials.

* @public + * @enum */ -export interface CredentialPair { - /** - *

User name.

- * @public - */ - Username: string | undefined; +export const DashboardUIState = { + COLLAPSED: "COLLAPSED", + EXPANDED: "EXPANDED", +} as const; - /** - *

Password.

- * @public - */ - Password: string | undefined; +/** + * @public + */ +export type DashboardUIState = (typeof DashboardUIState)[keyof typeof DashboardUIState]; +/** + *

Sheet controls option.

+ * @public + */ +export interface SheetControlsOption { /** - *

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.

+ *

Visibility state.

* @public */ - AlternateDataSourceParameters?: DataSourceParameters[] | undefined; + VisibilityState?: DashboardUIState | 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.

+ *

The sheet layout maximization options of a dashbaord.

* @public */ -export interface DataSourceCredentials { - /** - *

Credential pair. For more information, see - * - * CredentialPair - * .

- * @public - */ - CredentialPair?: CredentialPair | undefined; - +export interface SheetLayoutElementMaximizationOption { /** - *

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.

+ *

The status of the sheet layout maximization options of a dashbaord.

* @public */ - CopySourceArn?: string | undefined; + AvailabilityStatus?: DashboardBehavior | undefined; +} +/** + *

The axis sort options for a visual.

+ * @public + */ +export interface VisualAxisSortOption { /** - *

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

+ *

The availaiblity status of a visual's axis sort options.

* @public */ - SecretArn?: string | undefined; + AvailabilityStatus?: DashboardBehavior | undefined; } /** + *

Determines if hidden fields are included in an exported dashboard.

* @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", -} as const; +export interface ExportHiddenFieldsOption { + /** + *

The status of the export hidden fields options of a dashbaord.

+ * @public + */ + AvailabilityStatus?: DashboardBehavior | undefined; +} /** + *

The visual publish options of a visual in a dashboard

* @public */ -export type DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType]; +export interface DashboardVisualPublishOptions { + /** + *

Determines if hidden fields are included in an exported dashboard.

+ * @public + */ + ExportHiddenFieldsOption?: ExportHiddenFieldsOption | undefined; +} /** + *

Dashboard publish options.

* @public */ -export interface CreateDataSourceRequest { +export interface DashboardPublishOptions { /** - *

The Amazon Web Services account ID.

+ *

Ad hoc (one-time) filtering option.

* @public */ - AwsAccountId: string | undefined; + AdHocFilteringOption?: AdHocFilteringOption | undefined; /** - *

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

Export to .csv option.

* @public */ - DataSourceId: string | undefined; + ExportToCSVOption?: ExportToCSVOption | undefined; /** - *

A display name for the data source.

+ *

Sheet controls option.

* @public */ - Name: string | undefined; + SheetControlsOption?: SheetControlsOption | undefined; /** - *

The type of the data source. To return a - * list of all data sources, use ListDataSources.

- *

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

+ * @deprecated + * + *

The visual publish options of a visual in a dashboard.

* @public */ - Type: DataSourceType | undefined; + VisualPublishOptions?: DashboardVisualPublishOptions | undefined; /** - *

The parameters that Amazon QuickSight uses to connect to your underlying source.

+ *

The sheet layout maximization options of a dashbaord.

* @public */ - DataSourceParameters?: DataSourceParameters | undefined; + SheetLayoutElementMaximizationOption?: SheetLayoutElementMaximizationOption | undefined; /** - *

The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only - * credentials based on user name and password are supported.

+ *

The menu options of a visual in a dashboard.

* @public */ - Credentials?: DataSourceCredentials | undefined; + VisualMenuOption?: VisualMenuOption | undefined; /** - *

A list of resource permissions on the data source.

+ *

The axis sort options of a dashboard.

* @public */ - Permissions?: ResourcePermission[] | undefined; + VisualAxisSortOption?: VisualAxisSortOption | undefined; /** - *

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to - * your underlying source.

+ *

Determines if hidden fields are exported with a dashboard.

* @public */ - VpcConnectionProperties?: VpcConnectionProperties | undefined; + ExportWithHiddenFieldsOption?: ExportWithHiddenFieldsOption | undefined; /** - *

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

+ *

The drill-down options of data points in a dashboard.

* @public */ - SslProperties?: SslProperties | undefined; + DataPointDrillUpDownOption?: DataPointDrillUpDownOption | undefined; /** - *

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

+ *

The data point menu label options of a dashboard.

* @public */ - Tags?: Tag[] | undefined; + DataPointMenuLabelOption?: DataPointMenuLabelOption | undefined; /** - *

When you create the data source, Amazon QuickSight adds the data source to these folders.

+ *

The data point tool tip options of a dashboard.

* @public */ - FolderArns?: string[] | undefined; + DataPointTooltipOption?: DataPointTooltipOption | undefined; } /** + *

The contents of a dashboard.

* @public */ -export interface CreateDataSourceResponse { +export interface DashboardVersionDefinition { /** - *

The Amazon Resource Name (ARN) of the data source.

+ *

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 */ - Arn?: string | undefined; + DataSetIdentifierDeclarations: DataSetIdentifierDeclaration[] | undefined; /** - *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

An array of sheet definitions for a dashboard.

* @public */ - DataSourceId?: string | undefined; + Sheets?: SheetDefinition[] | undefined; /** - *

The status of creating the data source.

+ *

An array of calculated field definitions for the dashboard.

* @public */ - CreationStatus?: ResourceStatus | undefined; + CalculatedFields?: CalculatedField[] | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

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 */ - RequestId?: string | undefined; + ParameterDeclarations?: ParameterDeclaration[] | undefined; /** - *

The HTTP status of the request.

+ *

The filter definitions for a dashboard.

+ *

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

* @public */ - Status?: number | undefined; -} + FilterGroups?: FilterGroup[] | 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.

+ *

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 */ - RequestId?: string | undefined; + ColumnConfigurations?: ColumnConfiguration[] | undefined; + /** - * @internal + *

The configuration for default analysis settings.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "CustomerManagedKeyUnavailableException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, CustomerManagedKeyUnavailableException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } + AnalysisDefaults?: AnalysisDefaults | undefined; + + /** + *

An array of option definitions for a dashboard.

+ * @public + */ + Options?: AssetOptions | undefined; + + /** + *

The static files for the definition.

+ * @public + */ + StaticFiles?: StaticFile[] | undefined; } /** + *

A structure that contains the configuration of a shareable link to the dashboard.

* @public - * @enum */ -export const FolderType = { - RESTRICTED: "RESTRICTED", - SHARED: "SHARED", -} as const; +export interface LinkSharingConfiguration { + /** + *

A structure that contains the permissions of a shareable link.

+ * @public + */ + Permissions?: ResourcePermission[] | undefined; +} /** + *

Dashboard source template.

* @public */ -export type FolderType = (typeof FolderType)[keyof typeof FolderType]; +export interface DashboardSourceTemplate { + /** + *

Dataset references.

+ * @public + */ + DataSetReferences: DataSetReference[] | undefined; -/** - * @public - * @enum - */ -export const SharingModel = { - ACCOUNT: "ACCOUNT", - NAMESPACE: "NAMESPACE", -} as const; + /** + *

The Amazon Resource Name (ARN) of the resource.

+ * @public + */ + Arn: string | undefined; +} /** + *

Dashboard source entity.

* @public */ -export type SharingModel = (typeof SharingModel)[keyof typeof SharingModel]; +export interface DashboardSourceEntity { + /** + *

Source template.

+ * @public + */ + SourceTemplate?: DashboardSourceTemplate | undefined; +} /** * @public */ -export interface CreateFolderRequest { +export interface CreateDashboardRequest { /** - *

The ID for the Amazon Web Services account where you want to create the folder.

+ *

The ID of the Amazon Web Services account where you want to create the dashboard.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the folder.

+ *

The ID for the dashboard, also added to the IAM policy.

* @public */ - FolderId: string | undefined; + DashboardId: string | undefined; /** - *

The name of the folder.

+ *

The display name of the dashboard.

* @public */ - Name?: string | undefined; + Name: string | undefined; /** - *

The type of folder. By default, folderType is SHARED.

+ *

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 */ - FolderType?: FolderType | undefined; + Parameters?: _Parameters | undefined; /** - *

The Amazon Resource Name (ARN) for the parent folder.

- *

- * ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

+ *

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 */ - ParentFolderArn?: string | undefined; + Permissions?: ResourcePermission[] | undefined; /** - *

A structure that describes the principals and the resource-level permissions of a folder.

- *

To specify no permissions, omit Permissions.

+ *

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 */ - Permissions?: ResourcePermission[] | undefined; + SourceEntity?: DashboardSourceEntity | undefined; /** - *

Tags for the folder.

+ *

Contains a map of the key-value pairs for the resource tag or tags assigned to the + * dashboard.

* @public */ Tags?: Tag[] | undefined; /** - *

An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

+ *

A description for the first version of the dashboard being created.

* @public */ - SharingModel?: SharingModel | undefined; -} + VersionDescription?: string | undefined; -/** - * @public - */ -export interface CreateFolderResponse { /** - *

The HTTP status of the request.

+ *

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 */ - Status?: number | undefined; + DashboardPublishOptions?: DashboardPublishOptions | undefined; /** - *

The Amazon Resource Name (ARN) for the newly created folder.

+ *

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 */ - Arn?: string | undefined; + ThemeArn?: string | undefined; /** - *

The folder ID for the newly created folder.

+ *

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 */ - FolderId?: string | undefined; + Definition?: DashboardVersionDefinition | undefined; /** - *

The request ID for the newly created folder.

+ *

The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.

* @public */ - RequestId?: string | undefined; -} + ValidationStrategy?: ValidationStrategy | undefined; -/** - * @public - * @enum - */ -export const MemberType = { - ANALYSIS: "ANALYSIS", - DASHBOARD: "DASHBOARD", - DATASET: "DATASET", - DATASOURCE: "DATASOURCE", - TOPIC: "TOPIC", -} as const; + /** + *

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

+ * @public + */ + FolderArns?: string[] | undefined; -/** - * @public - */ -export type MemberType = (typeof MemberType)[keyof typeof MemberType]; + /** + *

A structure that contains the permissions of a shareable link to the dashboard.

+ * @public + */ + LinkSharingConfiguration?: LinkSharingConfiguration | undefined; + + /** + *

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

+ * @public + */ + LinkEntities?: string[] | undefined; +} /** * @public */ -export interface CreateFolderMembershipRequest { +export interface CreateDashboardResponse { /** - *

The ID for the Amazon Web Services account that contains the folder.

+ *

The ARN of the dashboard.

* @public */ - AwsAccountId: string | undefined; + Arn?: string | undefined; /** - *

The ID of the folder.

+ *

The ARN of the dashboard, including the version number of the first version that is + * created.

* @public */ - FolderId: string | undefined; + VersionArn?: string | undefined; /** - *

The ID of the asset that you want to add to the folder.

+ *

The ID for the dashboard.

* @public */ - MemberId: string | undefined; + DashboardId?: string | undefined; /** - *

The member type of the asset that you want to add to a folder.

+ *

The status of the dashboard creation request.

* @public */ - MemberType: MemberType | undefined; -} + CreationStatus?: ResourceStatus | undefined; -/** - *

An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.

- * @public - */ -export interface FolderMember { /** - *

The ID of an asset in the folder.

+ *

The HTTP status of the request.

* @public */ - MemberId?: string | undefined; + Status?: number | undefined; /** - *

The type of asset that it is.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - MemberType?: MemberType | undefined; + RequestId?: string | undefined; } /** + *

The default values of a date time parameter.

* @public */ -export interface CreateFolderMembershipResponse { +export interface DateTimeDatasetParameterDefaultValues { /** - *

The HTTP status of the request.

+ *

A list of static default values for a given date time parameter.

* @public */ - Status?: number | undefined; + StaticValues?: Date[] | undefined; +} + +/** + * @public + * @enum + */ +export const DatasetParameterValueType = { + MULTI_VALUED: "MULTI_VALUED", + SINGLE_VALUED: "SINGLE_VALUED", +} as const; +/** + * @public + */ +export type DatasetParameterValueType = (typeof DatasetParameterValueType)[keyof typeof DatasetParameterValueType]; + +/** + *

A date time parameter for a dataset.

+ * @public + */ +export interface DateTimeDatasetParameter { /** - *

Information about the member in the folder.

+ *

An identifier for the parameter that is created in the dataset.

* @public */ - FolderMember?: FolderMember | undefined; + Id: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The name of the date time parameter that is created in the dataset.

* @public */ - RequestId?: string | undefined; -} + Name: string | undefined; -/** - *

The request object for this operation.

- * @public - */ -export interface CreateGroupRequest { /** - *

A name for the group that you want to create.

+ *

The value type of the dataset parameter. Valid values are single value or multi value.

* @public */ - GroupName: string | undefined; + ValueType: DatasetParameterValueType | undefined; /** - *

A description for the group that you want to create.

+ *

The time granularity of the date time parameter.

* @public */ - Description?: string | undefined; + TimeGranularity?: TimeGranularity | 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 list of default values for a given date time parameter. This structure only accepts static values.

* @public */ - AwsAccountId: string | undefined; + DefaultValues?: DateTimeDatasetParameterDefaultValues | undefined; +} +/** + *

The default values of a decimal parameter.

+ * @public + */ +export interface DecimalDatasetParameterDefaultValues { /** - *

The namespace that you want the group to be a part of.

+ *

A list of static default values for a given decimal parameter.

* @public */ - Namespace: string | undefined; + StaticValues?: number[] | 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.

+ *

A decimal parameter for a dataset.

* @public */ -export interface Group { +export interface DecimalDatasetParameter { /** - *

The Amazon Resource Name (ARN) for the group.

+ *

An identifier for the decimal parameter created in the dataset.

* @public */ - Arn?: string | undefined; + Id: string | undefined; /** - *

The name of the group.

+ *

The name of the decimal parameter that is created in the dataset.

* @public */ - GroupName?: string | undefined; + Name: string | undefined; /** - *

The group description.

+ *

The value type of the dataset parameter. Valid values are single value or multi value.

* @public */ - Description?: string | undefined; + ValueType: DatasetParameterValueType | undefined; /** - *

The principal ID of the group.

+ *

A list of default values for a given decimal parameter. This structure only accepts static values.

* @public */ - PrincipalId?: string | undefined; + DefaultValues?: DecimalDatasetParameterDefaultValues | undefined; } /** - *

The response object for this operation.

+ *

The default values of an integer parameter.

* @public */ -export interface CreateGroupResponse { +export interface IntegerDatasetParameterDefaultValues { /** - *

The name of the group.

+ *

A list of static default values for a given integer parameter.

* @public */ - Group?: Group | undefined; - - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; - - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; + StaticValues?: number[] | undefined; } /** + *

An integer parameter for a dataset.

* @public */ -export interface CreateGroupMembershipRequest { +export interface IntegerDatasetParameter { /** - *

The name of the user that you want to add to the group membership.

+ *

An identifier for the integer parameter created in the dataset.

* @public */ - MemberName: string | undefined; + Id: string | undefined; /** - *

The name of the group that you want to add the user to.

+ *

The name of the integer parameter that is created in 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.

+ *

The value type of the dataset parameter. Valid values are single value or multi value.

* @public */ - AwsAccountId: string | undefined; + ValueType: DatasetParameterValueType | undefined; /** - *

The namespace that you want the user to be a part of.

+ *

A list of default values for a given integer parameter. This structure only accepts static values.

* @public */ - Namespace: string | undefined; + DefaultValues?: IntegerDatasetParameterDefaultValues | undefined; } /** - *

A member of an Amazon QuickSight group. Currently, group members must be users. Groups - * can't be members of another group. .

+ *

The default values of a string parameter.

* @public */ -export interface GroupMember { - /** - *

The Amazon Resource Name (ARN) for the group member (user).

- * @public - */ - Arn?: string | undefined; - +export interface StringDatasetParameterDefaultValues { /** - *

The name of the group member (user).

+ *

A list of static default values for a given string parameter.

* @public */ - MemberName?: string | undefined; + StaticValues?: string[] | undefined; } /** + *

A string parameter for a dataset.

* @public */ -export interface CreateGroupMembershipResponse { - /** - *

The group member.

- * @public - */ - GroupMember?: GroupMember | undefined; - +export interface StringDatasetParameter { /** - *

The Amazon Web Services request ID for this operation.

+ *

An identifier for the string parameter that is created in the dataset.

* @public */ - RequestId?: string | undefined; + Id: string | undefined; /** - *

The HTTP status of the request.

+ *

The name of the string parameter that is created in the dataset.

* @public */ - Status?: number | undefined; -} + Name: string | 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 value type of the dataset parameter. Valid values are single value or multi value.

* @public */ - AwsAccountId: string | undefined; + ValueType: DatasetParameterValueType | undefined; /** - *

The name of the assignment, also called a rule. - * The - * name - * must be unique within the - * Amazon Web Services account.

+ *

A list of default values for a given string dataset parameter type. This structure only accepts static values.

* @public */ - AssignmentName: string | undefined; + DefaultValues?: StringDatasetParameterDefaultValues | 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 { /** - *

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.

    - *
  • - *
+ *

A string parameter that is created in the dataset.

* @public */ - AssignmentStatus: AssignmentStatus | undefined; + StringDatasetParameter?: StringDatasetParameter | undefined; /** - *

The ARN for the IAM policy to apply to the Amazon QuickSight users and - * groups specified in this assignment.

+ *

A decimal parameter that is created in the dataset.

* @public */ - PolicyArn?: string | undefined; + DecimalDatasetParameter?: DecimalDatasetParameter | undefined; /** - *

The Amazon QuickSight users, groups, or both that you want to assign the policy - * to.

+ *

An integer parameter that is created in the dataset.

* @public */ - Identities?: Record | undefined; + IntegerDatasetParameter?: IntegerDatasetParameter | undefined; /** - *

The namespace that contains the assignment.

+ *

A date time parameter that is created in the dataset.

* @public */ - Namespace: string | undefined; + DateTimeDatasetParameter?: DateTimeDatasetParameter | undefined; } /** + *

The usage configuration to apply to child datasets that reference this dataset as a source.

* @public */ -export interface CreateIAMPolicyAssignmentResponse { - /** - *

The name of the assignment. - * The - * name must be unique within the Amazon Web Services account.

- * @public - */ - AssignmentName?: string | undefined; - - /** - *

The ID for the assignment.

- * @public - */ - AssignmentId?: 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.

    - *
  • - *
- * @public - */ - AssignmentStatus?: AssignmentStatus | undefined; - +export interface DataSetUsageConfiguration { /** - *

The ARN for the IAM policy that is applied to the Amazon QuickSight - * users and groups specified in this assignment.

+ *

An option that controls whether a child dataset of a direct query can use this dataset as a source.

* @public */ - PolicyArn?: string | undefined; + DisableUseAsDirectQuerySource?: boolean | undefined; /** - *

The Amazon QuickSight users, groups, or both that the IAM policy is - * assigned to.

+ *

An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

* @public */ - Identities?: Record | undefined; + DisableUseAsImportedSource?: boolean | undefined; +} +/** + *

A FieldFolder element is a folder that contains fields and nested subfolders.

+ * @public + */ +export interface FieldFolder { /** - *

The Amazon Web Services request ID for this operation.

+ *

The description for a field folder.

* @public */ - RequestId?: string | undefined; + description?: string | undefined; /** - *

The HTTP status of the request.

+ *

A folder has a list of columns. A column can only be in one folder.

* @public */ - Status?: number | undefined; + columns?: string[] | undefined; } /** * @public * @enum */ -export const IngestionType = { - FULL_REFRESH: "FULL_REFRESH", - INCREMENTAL_REFRESH: "INCREMENTAL_REFRESH", +export const DataSetImportMode = { + DIRECT_QUERY: "DIRECT_QUERY", + SPICE: "SPICE", } as const; /** * @public */ -export type IngestionType = (typeof IngestionType)[keyof typeof IngestionType]; +export type DataSetImportMode = (typeof DataSetImportMode)[keyof typeof DataSetImportMode]; /** + *

A transform operation that filters rows based on a condition.

* @public */ -export interface CreateIngestionRequest { +export interface FilterOperation { /** - *

The ID of the dataset used in the ingestion.

+ *

An expression that must evaluate to a Boolean value. Rows for which the expression + * evaluates to true are kept in the dataset.

* @public */ - DataSetId: string | undefined; + ConditionExpression: string | undefined; +} +/** + *

The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.

+ * @public + */ +export interface NewDefaultValues { /** - *

An ID for the ingestion.

+ *

A list of static default values for a given string parameter.

* @public */ - IngestionId: string | undefined; + StringStaticValues?: string[] | undefined; /** - *

The Amazon Web Services account ID.

+ *

A list of static default values for a given decimal parameter.

* @public */ - AwsAccountId: string | undefined; + DecimalStaticValues?: number[] | undefined; /** - *

The type of ingestion that you want to create.

+ *

A list of static default values for a given date time parameter.

* @public */ - IngestionType?: IngestionType | undefined; -} + DateTimeStaticValues?: Date[] | undefined; -/** - * @public - * @enum - */ -export const IngestionStatus = { - CANCELLED: "CANCELLED", - COMPLETED: "COMPLETED", - FAILED: "FAILED", - INITIALIZED: "INITIALIZED", - QUEUED: "QUEUED", - RUNNING: "RUNNING", -} as const; + /** + *

A list of static default values for a given integer parameter.

+ * @public + */ + IntegerStaticValues?: number[] | undefined; +} /** + *

A transform operation that overrides the dataset parameter values that are defined in another dataset.

* @public */ -export type IngestionStatus = (typeof IngestionStatus)[keyof typeof IngestionStatus]; +export interface OverrideDatasetParameterOperation { + /** + *

The name of the parameter to be overridden with different values.

+ * @public + */ + ParameterName: string | undefined; -/** - * @public - */ -export interface CreateIngestionResponse { /** - *

The Amazon Resource Name (ARN) for the data ingestion.

+ *

The new name for the parameter.

* @public */ - Arn?: string | undefined; + NewParameterName?: string | undefined; /** - *

An ID for the ingestion.

+ *

The new default values for the parameter.

* @public */ - IngestionId?: 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 ProjectOperation { /** - *

The ingestion status.

+ *

Projected columns.

* @public */ - IngestionStatus?: IngestionStatus | undefined; + ProjectedColumns: string[] | undefined; +} +/** + *

A transform operation that renames a column.

+ * @public + */ +export interface RenameColumnOperation { /** - *

The Amazon Web Services request ID for this operation.

+ *

The name of the column to be renamed.

* @public */ - RequestId?: string | undefined; + ColumnName: string | undefined; /** - *

The HTTP status of the request.

+ *

The new name for the column.

* @public */ - Status?: number | undefined; + NewColumnName: string | undefined; } /** + *

A transform operation that tags a column with additional information.

* @public - * @enum */ -export const IdentityStore = { - QUICKSIGHT: "QUICKSIGHT", -} as const; - -/** - * @public - */ -export type IdentityStore = (typeof IdentityStore)[keyof typeof IdentityStore]; - -/** - * @public - */ -export interface CreateNamespaceRequest { - /** - *

The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.

- * @public - */ - AwsAccountId: string | undefined; - - /** - *

The name that you want to use to describe the new namespace.

- * @public - */ - Namespace: string | undefined; - - /** - *

Specifies the type of your user identity directory. Currently, this supports users - * with an identity type of QUICKSIGHT.

- * @public - */ - IdentityStore: IdentityStore | undefined; - - /** - *

The tags that you want to associate with the namespace that you're creating.

- * @public - */ - Tags?: Tag[] | undefined; -} - -/** - * @public - * @enum - */ -export const NamespaceStatus = { - CREATED: "CREATED", - CREATING: "CREATING", - DELETING: "DELETING", - NON_RETRYABLE_FAILURE: "NON_RETRYABLE_FAILURE", - RETRYABLE_FAILURE: "RETRYABLE_FAILURE", -} as const; - -/** - * @public - */ -export type NamespaceStatus = (typeof NamespaceStatus)[keyof typeof NamespaceStatus]; - -/** - * @public - */ -export interface CreateNamespaceResponse { - /** - *

The ARN of the Amazon QuickSight namespace you created.

- * @public - */ - Arn?: string | undefined; - - /** - *

The name of the new namespace that you created.

- * @public - */ - Name?: string | 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.

- * @public - */ - CapacityRegion?: string | 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.

- * @public - */ - CreationStatus?: NamespaceStatus | undefined; - - /** - *

Specifies the type of your user identity directory. Currently, this supports users - * with an identity type of QUICKSIGHT.

- * @public - */ - IdentityStore?: IdentityStore | 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 - * @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 day of the week that you want to schedule a refresh on.

- * @public - */ - DayOfWeek?: DayOfWeek | undefined; - - /** - *

The day of the month that you want to schedule refresh on.

- * @public - */ - DayOfMonth?: 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.

    - *
  • - *
- * @public - */ - Interval: RefreshInterval | undefined; - - /** - *

The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

- * @public - */ - RefreshOnDay?: ScheduleRefreshOnEntity | 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().

- * @public - */ - Timezone?: 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.

- * @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; - +export interface TagColumnOperation { /** - *

The Amazon Web Services account ID.

+ *

The column that this operation acts on.

* @public */ - AwsAccountId: string | undefined; + ColumnName: string | undefined; /** - *

The refresh schedule.

+ *

The dataset column tag, currently only used for geospatial type tagging.

+ * + *

This is not tags for the Amazon Web Services tagging feature.

+ *
* @public */ - Schedule: RefreshSchedule | undefined; + Tags: ColumnTag[] | undefined; } /** + *

A transform operation that removes tags associated with a column.

* @public */ -export interface CreateRefreshScheduleResponse { - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; - - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; - +export interface UntagColumnOperation { /** - *

The ID of the refresh schedule.

+ *

The column that this operation acts on.

* @public */ - ScheduleId?: string | undefined; + ColumnName: string | undefined; /** - *

The Amazon Resource Name (ARN) for the refresh schedule.

+ *

The column tags to remove from this column.

* @public */ - Arn?: string | undefined; + TagNames: ColumnTagName[] | 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; - -/** + *

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 Role = (typeof Role)[keyof typeof Role]; +export type TransformOperation = + | TransformOperation.CastColumnTypeOperationMember + | TransformOperation.CreateColumnsOperationMember + | TransformOperation.FilterOperationMember + | TransformOperation.OverrideDatasetParameterOperationMember + | TransformOperation.ProjectOperationMember + | TransformOperation.RenameColumnOperationMember + | TransformOperation.TagColumnOperationMember + | TransformOperation.UntagColumnOperationMember + | TransformOperation.$UnknownMember; /** * @public */ -export interface CreateRoleMembershipRequest { - /** - *

The name of the group that you want to add to the role.

- * @public - */ - MemberName: string | undefined; - +export namespace TransformOperation { /** - *

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.

+ *

An operation that projects columns. Operations that come after a projection can only + * refer to projected columns.

* @public */ - AwsAccountId: string | undefined; + export interface ProjectOperationMember { + ProjectOperation: ProjectOperation; + FilterOperation?: never; + CreateColumnsOperation?: never; + RenameColumnOperation?: never; + CastColumnTypeOperation?: never; + TagColumnOperation?: never; + UntagColumnOperation?: never; + OverrideDatasetParameterOperation?: never; + $unknown?: never; + } /** - *

The namespace that the role belongs to.

+ *

An operation that filters rows based on some condition.

* @public */ - Namespace: string | undefined; + export interface FilterOperationMember { + ProjectOperation?: never; + FilterOperation: FilterOperation; + CreateColumnsOperation?: never; + RenameColumnOperation?: never; + CastColumnTypeOperation?: never; + TagColumnOperation?: never; + UntagColumnOperation?: never; + OverrideDatasetParameterOperation?: never; + $unknown?: never; + } /** - *

The role that you want to add a group to.

+ *

An operation that creates calculated columns. Columns created in one such operation + * form a lexical closure.

* @public */ - Role: Role | undefined; -} + export interface CreateColumnsOperationMember { + ProjectOperation?: never; + FilterOperation?: never; + CreateColumnsOperation: CreateColumnsOperation; + RenameColumnOperation?: never; + CastColumnTypeOperation?: never; + TagColumnOperation?: never; + UntagColumnOperation?: never; + OverrideDatasetParameterOperation?: never; + $unknown?: never; + } -/** - * @public - */ -export interface CreateRoleMembershipResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

An operation that renames a column.

* @public */ - RequestId?: string | undefined; + export interface RenameColumnOperationMember { + ProjectOperation?: never; + FilterOperation?: never; + CreateColumnsOperation?: never; + RenameColumnOperation: RenameColumnOperation; + CastColumnTypeOperation?: never; + TagColumnOperation?: never; + UntagColumnOperation?: never; + OverrideDatasetParameterOperation?: never; + $unknown?: never; + } /** - *

The HTTP status of the request.

+ *

A transform operation that casts a column to a different type.

* @public */ - Status?: number | undefined; -} + export interface CastColumnTypeOperationMember { + ProjectOperation?: never; + FilterOperation?: never; + CreateColumnsOperation?: never; + RenameColumnOperation?: never; + CastColumnTypeOperation: CastColumnTypeOperation; + TagColumnOperation?: never; + UntagColumnOperation?: never; + OverrideDatasetParameterOperation?: never; + $unknown?: never; + } -/** - *

Dataset schema.

- * @public - */ -export interface DataSetSchema { /** - *

A structure containing the list of column schemas.

+ *

An operation that tags a column with additional information.

* @public */ - ColumnSchemaList?: ColumnSchema[] | undefined; -} + export interface TagColumnOperationMember { + ProjectOperation?: never; + FilterOperation?: never; + CreateColumnsOperation?: never; + RenameColumnOperation?: never; + CastColumnTypeOperation?: never; + TagColumnOperation: TagColumnOperation; + UntagColumnOperation?: never; + OverrideDatasetParameterOperation?: never; + $unknown?: never; + } -/** - *

Dataset configuration.

- * @public - */ -export interface DataSetConfiguration { /** - *

Placeholder.

+ *

A transform operation that removes tags associated with a column.

* @public */ - Placeholder?: string | undefined; + export interface UntagColumnOperationMember { + ProjectOperation?: never; + FilterOperation?: never; + CreateColumnsOperation?: never; + RenameColumnOperation?: never; + CastColumnTypeOperation?: never; + TagColumnOperation?: never; + UntagColumnOperation: UntagColumnOperation; + OverrideDatasetParameterOperation?: never; + $unknown?: never; + } /** - *

Dataset schema.

+ *

A transform operation that overrides the dataset parameter values that are defined in another dataset.

* @public */ - DataSetSchema?: DataSetSchema | undefined; + export interface OverrideDatasetParameterOperationMember { + ProjectOperation?: never; + FilterOperation?: never; + CreateColumnsOperation?: never; + RenameColumnOperation?: never; + CastColumnTypeOperation?: never; + TagColumnOperation?: never; + UntagColumnOperation?: never; + OverrideDatasetParameterOperation: OverrideDatasetParameterOperation; + $unknown?: never; + } /** - *

A structure containing the list of column group schemas.

* @public */ - ColumnGroupSchemaList?: ColumnGroupSchema[] | 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]); + }; } /** - *

The detailed definition of a template.

+ *

Properties associated with the columns participating in a join.

* @public */ -export interface TemplateVersionDefinition { +export interface JoinKeyProperties { /** - *

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

+ *

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 */ - DataSetConfigurations: DataSetConfiguration[] | undefined; + UniqueKey?: boolean | undefined; +} - /** - *

An array of sheet definitions for a template.

- * @public - */ - Sheets?: SheetDefinition[] | undefined; +/** + * @public + * @enum + */ +export const JoinType = { + INNER: "INNER", + LEFT: "LEFT", + OUTER: "OUTER", + RIGHT: "RIGHT", +} as const; - /** - *

An array of calculated field definitions for the template.

- * @public - */ - CalculatedFields?: CalculatedField[] | undefined; +/** + * @public + */ +export type JoinType = (typeof JoinType)[keyof typeof JoinType]; +/** + *

The instructions associated with a join.

+ * @public + */ +export interface JoinInstruction { /** - *

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 operand on the left side of a join.

* @public */ - ParameterDeclarations?: ParameterDeclaration[] | undefined; + LeftOperand: string | undefined; /** - *

Filter definitions for a template.

- *

For more information, see Filtering Data in the Amazon QuickSight User Guide. - *

+ *

The operand on the right side of a join.

* @public */ - FilterGroups?: FilterGroup[] | undefined; + RightOperand: string | undefined; /** - *

An array of template-level column - * configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

+ *

Join key properties of the left operand.

* @public */ - ColumnConfigurations?: ColumnConfiguration[] | undefined; + LeftJoinKeyProperties?: JoinKeyProperties | undefined; /** - *

The configuration for default analysis settings.

+ *

Join key properties of the right operand.

* @public */ - AnalysisDefaults?: AnalysisDefaults | undefined; + RightJoinKeyProperties?: JoinKeyProperties | undefined; /** - *

An array of option definitions for a template.

+ *

The type of join that it is.

* @public */ - Options?: AssetOptions | undefined; + Type: JoinType | undefined; /** - *

A structure that describes the query execution options.

+ *

The join instructions provided in the ON clause of a join.

* @public */ - QueryExecutionOptions?: QueryExecutionOptions | undefined; + OnClause: string | undefined; } /** - *

The source analysis of the template.

+ *

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 TemplateSourceAnalysis { +export interface LogicalTableSource { /** - *

The Amazon Resource Name (ARN) of the resource.

+ *

Specifies the result of a join of two logical tables.

* @public */ - Arn: string | undefined; + JoinInstruction?: JoinInstruction | undefined; + + /** + *

Physical table ID.

+ * @public + */ + PhysicalTableId?: string | undefined; /** - *

A structure containing information about the dataset references used as placeholders - * in the template.

+ *

The Amazon Resource Number (ARN) of the parent dataset.

* @public */ - DataSetReferences: DataSetReference[] | undefined; + DataSetArn?: string | undefined; } /** - *

The source template of the template.

+ *

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 TemplateSourceTemplate { +export interface LogicalTable { /** - *

The Amazon Resource Name (ARN) of the resource.

+ *

A display name for the logical table.

* @public */ - Arn: string | undefined; -} + Alias: string | undefined; -/** - *

The source entity of the template.

- * @public - */ -export interface TemplateSourceEntity { /** - *

The source analysis, if it is based on an analysis.

+ *

Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.

* @public */ - SourceAnalysis?: TemplateSourceAnalysis | undefined; + DataTransforms?: TransformOperation[] | undefined; /** - *

The source template, if it is based on an template.

+ *

Source of this logical table.

* @public */ - SourceTemplate?: TemplateSourceTemplate | undefined; + Source: LogicalTableSource | undefined; } /** * @public + * @enum */ -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.

- * @public - */ - AwsAccountId: string | undefined; +export const InputColumnDataType = { + BIT: "BIT", + BOOLEAN: "BOOLEAN", + DATETIME: "DATETIME", + DECIMAL: "DECIMAL", + INTEGER: "INTEGER", + JSON: "JSON", + STRING: "STRING", +} as const; - /** - *

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 - */ - TemplateId: string | undefined; +/** + * @public + */ +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 InputColumn { /** - *

A display name for the template.

+ *

The name of this column in the underlying data source.

* @public */ - Name?: string | undefined; + Name: string | undefined; /** - *

A list of resource permissions to be set on the template.

+ *

The data type of the column.

* @public */ - Permissions?: ResourcePermission[] | undefined; + Type: InputColumnDataType | undefined; /** - *

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 sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.

* @public */ - SourceEntity?: TemplateSourceEntity | undefined; + SubType?: ColumnDataSubType | undefined; +} +/** + *

A physical table type built from the results of the custom SQL query.

+ * @public + */ +export interface CustomSql { /** - *

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

+ *

The Amazon Resource Name (ARN) of the data source.

* @public */ - Tags?: Tag[] | undefined; + DataSourceArn: string | undefined; /** - *

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.

+ *

A display name for the SQL query result.

* @public */ - VersionDescription?: string | undefined; + Name: string | 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 SQL query.

* @public */ - Definition?: TemplateVersionDefinition | undefined; + SqlQuery: 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 column schema from the SQL query result set.

* @public */ - ValidationStrategy?: ValidationStrategy | undefined; + Columns?: InputColumn[] | undefined; } /** + *

A physical table type for relational data sources.

* @public */ -export interface CreateTemplateResponse { - /** - *

The ARN for the template.

- * @public - */ - Arn?: string | undefined; - +export interface RelationalTable { /** - *

The ARN for the template, including the version information of - * the first version.

+ *

The Amazon Resource Name (ARN) for the data source.

* @public */ - VersionArn?: string | undefined; + DataSourceArn: string | undefined; /** - *

The ID of the template.

+ *

The catalog associated with a table.

* @public */ - TemplateId?: string | undefined; + Catalog?: string | undefined; /** - *

The template creation status.

+ *

The schema name. This name applies to certain relational database engines.

* @public */ - CreationStatus?: ResourceStatus | undefined; + Schema?: string | undefined; /** - *

The HTTP status of the request.

+ *

The name of the relational table.

* @public */ - Status?: number | undefined; + Name: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The column schema of the table.

* @public */ - RequestId?: string | undefined; + InputColumns: InputColumn[] | undefined; } /** * @public + * @enum */ -export interface CreateTemplateAliasRequest { - /** - *

The ID of the Amazon Web Services account that contains the template that you creating an alias for.

- * @public - */ - AwsAccountId: string | undefined; +export const FileFormat = { + CLF: "CLF", + CSV: "CSV", + ELF: "ELF", + JSON: "JSON", + TSV: "TSV", + XLSX: "XLSX", +} as const; - /** - *

An ID for the template.

- * @public - */ - TemplateId: string | undefined; +/** + * @public + */ +export type FileFormat = (typeof FileFormat)[keyof typeof FileFormat]; + +/** + * @public + * @enum + */ +export const TextQualifier = { + DOUBLE_QUOTE: "DOUBLE_QUOTE", + SINGLE_QUOTE: "SINGLE_QUOTE", +} as const; +/** + * @public + */ +export type TextQualifier = (typeof TextQualifier)[keyof typeof TextQualifier]; + +/** + *

Information about the format for a source file or files.

+ * @public + */ +export interface UploadSettings { /** - *

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.

+ *

File format.

* @public */ - AliasName: string | undefined; + Format?: FileFormat | undefined; /** - *

The version number of the template.

+ *

A row number to start reading data from.

* @public */ - TemplateVersionNumber: number | undefined; -} + StartFromRow?: number | undefined; -/** - *

The template alias.

- * @public - */ -export interface TemplateAlias { /** - *

The display name of the template alias.

+ *

Whether the file has a header row, or the files each have a header row.

* @public */ - AliasName?: string | undefined; + ContainsHeader?: boolean | undefined; /** - *

The Amazon Resource Name (ARN) of the template alias.

+ *

Text qualifier.

* @public */ - Arn?: string | undefined; + TextQualifier?: TextQualifier | undefined; /** - *

The version number of the template alias.

+ *

The delimiter between values in the file.

* @public */ - TemplateVersionNumber?: number | undefined; + Delimiter?: string | undefined; } /** + *

A physical table type for an S3 data source.

* @public */ -export interface CreateTemplateAliasResponse { +export interface S3Source { /** - *

Information about the template alias.

+ *

The Amazon Resource Name (ARN) for the data source.

* @public */ - TemplateAlias?: TemplateAlias | undefined; + DataSourceArn: string | undefined; /** - *

The HTTP status of the request.

+ *

Information about the format for the S3 source file or files.

* @public */ - Status?: number | undefined; + UploadSettings?: UploadSettings | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

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 */ - RequestId?: string | undefined; + InputColumns: InputColumn[] | 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.

+ *

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 DataColorPalette { +export type PhysicalTable = + | PhysicalTable.CustomSqlMember + | PhysicalTable.RelationalTableMember + | PhysicalTable.S3SourceMember + | PhysicalTable.$UnknownMember; + +/** + * @public + */ +export namespace PhysicalTable { /** - *

The hexadecimal codes for the colors.

+ *

A physical table type for relational data sources.

* @public */ - Colors?: string[] | undefined; + export interface RelationalTableMember { + RelationalTable: RelationalTable; + CustomSql?: never; + S3Source?: never; + $unknown?: never; + } /** - *

The minimum and maximum hexadecimal codes that describe a color gradient.

+ *

A physical table type built from the results of the custom SQL query.

* @public */ - MinMaxGradient?: string[] | undefined; + export interface CustomSqlMember { + RelationalTable?: never; + CustomSql: CustomSql; + S3Source?: never; + $unknown?: never; + } /** - *

The hexadecimal code of a color that applies to charts where a lack of data is - * highlighted.

+ *

A physical table type for as S3 data source.

* @public */ - EmptyFillColor?: string | undefined; -} + export interface S3SourceMember { + RelationalTable?: never; + CustomSql?: never; + S3Source: S3Source; + $unknown?: never; + } -/** - *

Display options related to tiles on a sheet.

- * @public - */ -export interface TileStyle { /** - *

The border around a tile.

* @public */ - Border?: BorderStyle | 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]); + }; } /** - *

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 RowLevelPermissionFormatVersion = { + VERSION_1: "VERSION_1", + VERSION_2: "VERSION_2", +} 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 RowLevelPermissionFormatVersion = + (typeof RowLevelPermissionFormatVersion)[keyof typeof RowLevelPermissionFormatVersion]; /** - *

The display options for the layout of tiles on a sheet.

* @public + * @enum */ -export interface TileLayoutStyle { - /** - *

The gutter settings that apply between tiles.

- * @public - */ - Gutter?: GutterStyle | undefined; - - /** - *

The margin settings that apply around the outside edge of sheets.

- * @public - */ - Margin?: MarginStyle | undefined; -} +export const RowLevelPermissionPolicy = { + DENY_ACCESS: "DENY_ACCESS", + GRANT_ACCESS: "GRANT_ACCESS", +} as const; /** - *

The theme display options for sheets.

* @public */ -export interface SheetStyle { - /** - *

The display options for tiles.

- * @public - */ - Tile?: TileStyle | undefined; - - /** - *

The layout options for tiles.

- * @public - */ - TileLayout?: TileLayoutStyle | undefined; -} +export type RowLevelPermissionPolicy = (typeof RowLevelPermissionPolicy)[keyof typeof RowLevelPermissionPolicy]; /** - *

Determines the font settings.

* @public + * @enum */ -export interface Font { - /** - *

Determines the font family settings.

- * @public - */ - FontFamily?: string | undefined; -} +export const Status = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", +} as const; /** - *

Determines the typography options.

* @public */ -export interface Typography { - /** - *

Determines the list of font families.

- * @public - */ - FontFamilies?: Font[] | undefined; -} +export type Status = (typeof Status)[keyof typeof Status]; /** - *

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. - *

+ *

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 UIColorPalette { +export interface RowLevelPermissionDataSet { /** - *

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.

+ *

The namespace associated with the dataset that contains permissions for RLS.

* @public */ - PrimaryForeground?: string | undefined; + Namespace?: string | undefined; /** - *

The background color that applies to visuals and other high emphasis UI.

+ *

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

* @public */ - PrimaryBackground?: string | undefined; + Arn: string | undefined; /** - *

The foreground color that applies to any sheet title, sheet control text, or UI that - * appears over the secondary background.

+ *

The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS + * is included for backward compatibility only.

* @public */ - SecondaryForeground?: string | undefined; + PermissionPolicy: RowLevelPermissionPolicy | undefined; /** - *

The background color that applies to the sheet background and sheet controls.

+ *

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 */ - SecondaryBackground?: string | undefined; + FormatVersion?: RowLevelPermissionFormatVersion | undefined; /** - *

This color is that applies to selected states and buttons.

+ *

The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

* @public */ - Accent?: string | undefined; + Status?: Status | undefined; +} +/** + *

A set of rules associated with a tag.

+ * @public + */ +export interface RowLevelPermissionTagRule { /** - *

The foreground color that applies to any text or other elements that appear over the - * accent color.

+ *

The unique key for a tag.

* @public */ - AccentForeground?: string | undefined; + TagKey: string | undefined; /** - *

The color that applies to error messages.

+ *

The column name that a tag key is assigned to.

* @public */ - Danger?: string | undefined; + ColumnName: string | undefined; /** - *

The foreground color that applies to any text or other elements that appear over the - * error color.

+ *

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 */ - DangerForeground?: string | undefined; + TagMultiValueDelimiter?: string | undefined; /** - *

This color that applies to warning and informational messages.

+ *

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 */ - Warning?: string | undefined; + MatchAllValue?: string | undefined; +} +/** + *

The configuration of tags on a dataset to set row-level security.

+ * @public + */ +export interface RowLevelPermissionTagConfiguration { /** - *

The foreground color that applies to any text or other elements that appear over the - * warning color.

+ *

The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

* @public */ - WarningForeground?: string | undefined; + Status?: Status | undefined; /** - *

The color that applies to success messages, for example the check mark for a - * successful download.

+ *

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

* @public */ - Success?: string | undefined; + TagRules: RowLevelPermissionTagRule[] | undefined; /** - *

The foreground color that applies to any text or other elements that appear over the - * success color.

+ *

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 */ - SuccessForeground?: string | undefined; + TagRuleConfigurations?: string[][] | undefined; +} +/** + * @public + */ +export interface CreateDataSetRequest { /** - *

The color that applies to the names of fields that are identified as - * dimensions.

+ *

The Amazon Web Services account ID.

* @public */ - Dimension?: string | undefined; + AwsAccountId: string | undefined; /** - *

The foreground color that applies to any text or other elements that appear over the - * dimension color.

+ *

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 */ - DimensionForeground?: string | undefined; + DataSetId: string | undefined; /** - *

The color that applies to the names of fields that are identified as measures.

+ *

The display name for the dataset.

* @public */ - Measure?: string | undefined; + Name: string | undefined; /** - *

The foreground color that applies to any text or other elements that appear over the - * measure color.

+ *

Declares the physical tables that are available in the underlying data sources.

* @public */ - MeasureForeground?: string | undefined; -} + PhysicalTableMap: Record | undefined; -/** - *

The theme configuration. This configuration contains all of the display properties for - * a theme.

- * @public - */ -export interface ThemeConfiguration { /** - *

Color properties that apply to chart data colors.

+ *

Configures the combination and transformation of the data from the physical tables.

* @public */ - DataColorPalette?: DataColorPalette | undefined; + LogicalTableMap?: Record | undefined; /** - *

Color properties that apply to the UI and to charts, excluding the colors that apply - * to data.

+ *

Indicates whether you want to import the data into SPICE.

* @public */ - UIColorPalette?: UIColorPalette | undefined; + ImportMode: DataSetImportMode | undefined; /** - *

Display options related to sheets.

+ *

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

* @public */ - Sheet?: SheetStyle | undefined; + ColumnGroups?: ColumnGroup[] | undefined; /** - *

Determines the typography options.

+ *

The folder that contains fields and nested subfolders for your dataset.

* @public */ - Typography?: Typography | undefined; -} + FieldFolders?: Record | undefined; -/** - * @public - */ -export interface CreateThemeRequest { /** - *

The ID of the Amazon Web Services account where you want to store the new theme.

+ *

A list of resource permissions on the dataset.

* @public */ - AwsAccountId: string | undefined; + Permissions?: ResourcePermission[] | 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 row-level security configuration for the data that you want to create.

* @public */ - ThemeId: string | undefined; + RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; /** - *

A display name for the theme.

+ *

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

* @public */ - Name: string | undefined; + RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration | 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.

+ *

A set of one or more definitions of a + * ColumnLevelPermissionRule + * .

* @public */ - BaseThemeId: string | undefined; + ColumnLevelPermissionRules?: ColumnLevelPermissionRule[] | 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.

+ *

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

* @public */ - VersionDescription?: string | undefined; + Tags?: Tag[] | undefined; /** - *

The theme configuration, which contains the theme display properties.

+ *

The usage configuration to apply to child datasets that reference this dataset as a source.

* @public */ - Configuration: ThemeConfiguration | undefined; + DataSetUsageConfiguration?: DataSetUsageConfiguration | undefined; /** - *

A valid grouping of resource permissions to apply to the new theme. - *

+ *

The parameter declarations of the dataset.

* @public */ - Permissions?: ResourcePermission[] | undefined; + DatasetParameters?: DatasetParameter[] | undefined; /** - *

A map of the key-value pairs for the resource tag or tags that you want to add to the - * resource.

+ *

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

* @public */ - Tags?: Tag[] | undefined; + FolderArns?: string[] | undefined; } /** * @public */ -export interface CreateThemeResponse { +export interface CreateDataSetResponse { /** - *

The Amazon Resource Name (ARN) for the theme.

+ *

The Amazon Resource Name (ARN) of the dataset.

* @public */ Arn?: string | undefined; /** - *

The Amazon Resource Name (ARN) for the new theme.

+ *

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 */ - VersionArn?: string | undefined; + DataSetId?: string | undefined; /** - *

The ID of the theme.

+ *

The ARN for the ingestion, which is triggered as a result of dataset creation if the import + * mode is SPICE.

* @public */ - ThemeId?: string | undefined; + IngestionArn?: string | undefined; /** - *

The theme creation status.

+ *

The ID of the ingestion, which is triggered as a result of dataset creation if the import + * mode is SPICE.

* @public */ - CreationStatus?: ResourceStatus | undefined; + IngestionId?: 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 request.

* @public */ - RequestId?: string | undefined; + Status?: number | undefined; } /** + *

The combination of user name and password that are used as credentials.

* @public */ -export interface CreateThemeAliasRequest { - /** - *

The ID of the Amazon Web Services account that contains the theme for the new theme alias.

- * @public - */ - AwsAccountId: string | undefined; - +export interface CredentialPair { /** - *

An ID for the theme alias.

+ *

User name.

* @public */ - ThemeId: string | undefined; + Username: 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.

+ *

Password.

* @public */ - AliasName: string | undefined; + Password: string | undefined; /** - *

The version number of the theme.

+ *

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 */ - ThemeVersionNumber: number | undefined; + AlternateDataSourceParameters?: DataSourceParameters[] | undefined; } /** - *

An alias for a theme.

+ *

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 ThemeAlias { +export interface DataSourceCredentials { /** - *

The Amazon Resource Name (ARN) of the theme alias.

+ *

Credential pair. For more information, see + * + * CredentialPair + * .

* @public */ - Arn?: string | undefined; + CredentialPair?: CredentialPair | undefined; /** - *

The display name of the theme alias.

+ *

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 */ - AliasName?: string | undefined; + CopySourceArn?: string | undefined; /** - *

The version number of the theme alias.

+ *

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

* @public */ - ThemeVersionNumber?: number | undefined; + SecretArn?: string | undefined; } /** * @public + * @enum */ -export interface CreateThemeAliasResponse { +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 DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType]; + +/** + * @public + */ +export interface CreateDataSourceRequest { /** - *

Information about the theme alias.

+ *

The Amazon Web Services account ID.

* @public */ - ThemeAlias?: ThemeAlias | undefined; + AwsAccountId: string | undefined; /** - *

The HTTP status of the request.

+ *

An ID for 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.

+ *

A display name for the data source.

* @public */ - RequestId?: string | undefined; -} + Name: string | undefined; -/** - *

Configuration options for a Topic.

- * @public - */ -export interface TopicConfigOptions { /** - *

Enables Amazon Q Business Insights for a Topic.

+ *

The type of the data source. To return a + * list of all data sources, use ListDataSources.

+ *

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

* @public */ - QBusinessInsightsEnabled?: boolean | undefined; -} + Type: DataSourceType | 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; + /** + *

The parameters that Amazon QuickSight uses to connect to your underlying source.

+ * @public + */ + DataSourceParameters?: DataSourceParameters | undefined; -/** - * @public - */ -export type DefaultAggregation = (typeof DefaultAggregation)[keyof typeof DefaultAggregation]; + /** + *

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 structure that represents a default formatting definition.

- * @public - */ -export interface DefaultFormatting { /** - *

The display format. Valid values for this structure are AUTO, - * PERCENT, CURRENCY, NUMBER, DATE, and - * STRING.

+ *

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; + + /** + *

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

* @public */ - DisplayFormat?: DisplayFormat | undefined; + Tags?: Tag[] | undefined; /** - *

The additional options for display formatting.

+ *

When you create the data source, Amazon QuickSight adds the data source to these folders.

* @public */ - DisplayFormatOptions?: DisplayFormatOptions | undefined; + FolderArns?: string[] | undefined; } /** - *

A structure that represents a semantic type.

* @public */ -export interface SemanticType { +export interface CreateDataSourceResponse { /** - *

The semantic type name.

+ *

The Amazon Resource Name (ARN) of the data source.

* @public */ - TypeName?: string | undefined; + Arn?: string | undefined; /** - *

The semantic type sub type name.

+ *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - SubTypeName?: string | undefined; + DataSourceId?: string | undefined; /** - *

The semantic type parameters.

+ *

The status of creating the data source.

* @public */ - TypeParameters?: Record | undefined; + CreationStatus?: ResourceStatus | undefined; /** - *

The semantic type truthy cell value.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - TruthyCellValue?: string | undefined; + RequestId?: string | undefined; /** - *

The other names or aliases for the true cell value.

+ *

The HTTP status of the request.

* @public */ - TruthyCellValueSynonyms?: string[] | undefined; + 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 semantic type falsey cell value.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - FalseyCellValue?: string | undefined; - + RequestId?: string | undefined; /** - *

The other names or aliases for the false cell value.

- * @public + * @internal */ - FalseyCellValueSynonyms?: string[] | undefined; + constructor(opts: __ExceptionOptionType) { + super({ + name: "CustomerManagedKeyUnavailableException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, CustomerManagedKeyUnavailableException.prototype); + this.Message = opts.Message; + this.RequestId = opts.RequestId; + } } /** - *

A structure that represents a calculated field.

* @public + * @enum */ -export interface TopicCalculatedField { +export const FolderType = { + RESTRICTED: "RESTRICTED", + SHARED: "SHARED", +} as const; + +/** + * @public + */ +export type FolderType = (typeof FolderType)[keyof typeof FolderType]; + +/** + * @public + * @enum + */ +export const SharingModel = { + ACCOUNT: "ACCOUNT", + NAMESPACE: "NAMESPACE", +} as const; + +/** + * @public + */ +export type SharingModel = (typeof SharingModel)[keyof typeof SharingModel]; + +/** + * @public + */ +export interface CreateFolderRequest { /** - *

The calculated field name.

+ *

The ID for the Amazon Web Services account where you want to create the folder.

* @public */ - CalculatedFieldName: string | undefined; + AwsAccountId: string | undefined; /** - *

The calculated field description.

+ *

The ID of the folder.

* @public */ - CalculatedFieldDescription?: string | undefined; + FolderId: string | undefined; /** - *

The calculated field expression.

+ *

The name of the folder.

* @public */ - Expression: string | undefined; + Name?: string | undefined; /** - *

The other names or aliases for the calculated field.

+ *

The type of folder. By default, folderType is SHARED.

* @public */ - CalculatedFieldSynonyms?: string[] | undefined; + FolderType?: FolderType | undefined; /** - *

A boolean value that indicates if a calculated field is included in the topic.

+ *

The Amazon Resource Name (ARN) for the parent folder.

+ *

+ * ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

* @public */ - IsIncludedInTopic?: boolean | undefined; + ParentFolderArn?: string | undefined; /** - *

A Boolean value that indicates if a calculated field is visible in the autocomplete.

+ *

A structure that describes the principals and the resource-level permissions of a folder.

+ *

To specify no permissions, omit Permissions.

* @public */ - DisableIndexing?: boolean | undefined; + Permissions?: ResourcePermission[] | undefined; /** - *

The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.

+ *

Tags for the folder.

* @public */ - ColumnDataRole?: ColumnDataRole | undefined; + Tags?: Tag[] | undefined; /** - *

The level of time precision that is used to aggregate DateTime values.

+ *

An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

* @public */ - TimeGranularity?: TopicTimeGranularity | undefined; + SharingModel?: SharingModel | undefined; +} + +/** + * @public + */ +export interface CreateFolderResponse { + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; /** - *

The default formatting definition.

+ *

The Amazon Resource Name (ARN) for the newly created folder.

* @public */ - DefaultFormatting?: DefaultFormatting | undefined; + Arn?: string | undefined; /** - *

The default aggregation. Valid values for this structure are SUM, - * MAX, MIN, COUNT, - * DISTINCT_COUNT, - * and AVERAGE.

+ *

The folder ID for the newly created folder.

* @public */ - Aggregation?: DefaultAggregation | undefined; + FolderId?: string | undefined; /** - *

The order in which data is displayed for the calculated field when - * it's used in a comparative context.

+ *

The request ID for the newly created folder.

* @public */ - ComparativeOrder?: ComparativeOrder | undefined; + RequestId?: string | undefined; +} + +/** + * @public + * @enum + */ +export const MemberType = { + ANALYSIS: "ANALYSIS", + DASHBOARD: "DASHBOARD", + DATASET: "DATASET", + DATASOURCE: "DATASOURCE", + TOPIC: "TOPIC", +} as const; + +/** + * @public + */ +export type MemberType = (typeof MemberType)[keyof typeof MemberType]; +/** + * @public + */ +export interface CreateFolderMembershipRequest { /** - *

The semantic type.

+ *

The ID for the Amazon Web Services account that contains the folder.

* @public */ - SemanticType?: SemanticType | undefined; + AwsAccountId: string | 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.

+ *

The ID of the folder.

* @public */ - AllowedAggregations?: AuthorSpecifiedAggregation[] | undefined; + FolderId: 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 ID of the asset that you want to add to the folder.

* @public */ - NotAllowedAggregations?: AuthorSpecifiedAggregation[] | undefined; + MemberId: string | undefined; /** - *

A Boolean value that indicates whether to never aggregate calculated field in filters.

+ *

The member type of the asset that you want to add to a folder.

* @public */ - NeverAggregateInFilter?: boolean | undefined; + MemberType: MemberType | undefined; +} +/** + *

An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.

+ * @public + */ +export interface FolderMember { /** - *

The other - * names or aliases for the calculated field cell value.

+ *

The ID of an asset in the folder.

* @public */ - CellValueSynonyms?: CellValueSynonym[] | undefined; + MemberId?: string | undefined; /** - *

The non additive for the table style target.

+ *

The type of asset that it is.

* @public */ - NonAdditive?: boolean | undefined; + MemberType?: MemberType | undefined; } /** - *

Represents a column in a dataset.

* @public */ -export interface TopicColumn { +export interface CreateFolderMembershipResponse { /** - *

The name of the column.

+ *

The HTTP status of the request.

* @public */ - ColumnName: string | undefined; + Status?: number | undefined; /** - *

A user-friendly name for the column.

+ *

Information about the member in the folder.

* @public */ - ColumnFriendlyName?: string | undefined; + FolderMember?: FolderMember | undefined; /** - *

A description of the column and its contents.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - ColumnDescription?: string | undefined; + RequestId?: string | undefined; +} +/** + *

The request object for this operation.

+ * @public + */ +export interface CreateGroupRequest { /** - *

The other names or aliases for the column.

+ *

A name for the group that you want to create.

* @public */ - ColumnSynonyms?: string[] | undefined; + GroupName: string | undefined; /** - *

The role of the column in the data. Valid values are DIMENSION and MEASURE.

+ *

A description for the group that you want to create.

* @public */ - ColumnDataRole?: ColumnDataRole | undefined; + Description?: string | undefined; /** - *

The type of aggregation that is performed on the column data when - * it's queried.

+ *

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 */ - Aggregation?: DefaultAggregation | undefined; + AwsAccountId: string | undefined; + + /** + *

The namespace that you want the group to be a part of.

+ * @public + */ + 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 { /** - *

A Boolean value that indicates whether the column is included in the query results.

+ *

The Amazon Resource Name (ARN) for the group.

* @public */ - IsIncludedInTopic?: boolean | undefined; + Arn?: string | undefined; /** - *

A Boolean value that indicates whether the column shows in the autocomplete functionality.

+ *

The name of the group.

* @public */ - DisableIndexing?: boolean | undefined; + GroupName?: string | undefined; /** - *

The order in which data is displayed for the column when - * it's used in a comparative context.

+ *

The group description.

* @public */ - ComparativeOrder?: ComparativeOrder | undefined; + Description?: string | undefined; /** - *

The semantic type of data contained in the column.

+ *

The principal ID of the group.

* @public */ - SemanticType?: SemanticType | undefined; + PrincipalId?: string | undefined; +} +/** + *

The response object for this operation.

+ * @public + */ +export interface CreateGroupResponse { /** - *

The level of time precision that is used to aggregate DateTime values.

+ *

The name of the group.

* @public */ - TimeGranularity?: TopicTimeGranularity | undefined; + Group?: Group | undefined; /** - *

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.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AllowedAggregations?: AuthorSpecifiedAggregation[] | undefined; + RequestId?: string | 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; +} +/** + * @public + */ +export interface CreateGroupMembershipRequest { /** - *

The default formatting used for values in the column.

+ *

The name of the user that you want to add to the group membership.

* @public */ - DefaultFormatting?: DefaultFormatting | undefined; + MemberName: string | undefined; /** - *

A Boolean - * value that indicates whether to aggregate the column data when - * it's used in a filter context.

+ *

The name of the group that you want to add the user to.

* @public */ - NeverAggregateInFilter?: boolean | undefined; + GroupName: string | undefined; /** - *

The other names or aliases for the column cell value.

+ *

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 */ - CellValueSynonyms?: CellValueSynonym[] | undefined; + AwsAccountId: string | undefined; /** - *

The non additive value for the column.

+ *

The namespace that you want the user to be a part of.

* @public */ - NonAdditive?: boolean | undefined; + Namespace: string | undefined; } /** - *

A structure that represents a data aggregation.

+ *

A member of an Amazon QuickSight group. Currently, group members must be users. Groups + * can't be members of another group. .

* @public */ -export interface DataAggregation { +export interface GroupMember { /** - *

The level of time precision that is used to aggregate DateTime values.

+ *

The Amazon Resource Name (ARN) for the group member (user).

* @public */ - DatasetRowDateGranularity?: TopicTimeGranularity | undefined; + Arn?: string | undefined; /** - *

The column name for the default date.

+ *

The name of the group member (user).

* @public */ - DefaultDateColumnName?: string | undefined; + MemberName?: string | undefined; } /** - *

A constant used in a category filter.

* @public */ -export interface TopicCategoryFilterConstant { +export interface CreateGroupMembershipResponse { /** - *

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.

+ *

The group member.

* @public */ - ConstantType?: ConstantType | undefined; + GroupMember?: GroupMember | undefined; /** - *

A singular constant used in a category filter. This element is used to specify a single value for the constant.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - SingularConstant?: string | undefined; + RequestId?: string | undefined; /** - *

A collective constant used in a category filter. This element is used to specify a list of values for the constant.

+ *

The HTTP status of the request.

* @public */ - CollectiveConstant?: CollectiveConstant | undefined; + Status?: number | undefined; } /** - *

A structure that represents a category filter.

* @public */ -export interface TopicCategoryFilter { +export interface CreateIAMPolicyAssignmentRequest { /** - *

The category filter function. Valid values for this structure are EXACT and CONTAINS.

+ *

The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.

* @public */ - CategoryFilterFunction?: CategoryFilterFunction | undefined; + AwsAccountId: string | 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 name of the assignment, also called a rule. + * The + * name + * must be unique within the + * Amazon Web Services account.

* @public */ - CategoryFilterType?: CategoryFilterType | undefined; + AssignmentName: string | undefined; /** - *

The constant used in a category filter.

+ *

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 */ - Constant?: TopicCategoryFilterConstant | undefined; + AssignmentStatus: AssignmentStatus | undefined; /** - *

A Boolean value that indicates if the filter is inverse.

+ *

The ARN for the IAM policy to apply to the Amazon QuickSight users and + * groups specified in this assignment.

* @public */ - Inverse?: boolean | undefined; -} + PolicyArn?: string | undefined; -/** - *

A structure that represents a range constant.

- * @public - */ -export interface RangeConstant { /** - *

The minimum value for a range constant.

+ *

The Amazon QuickSight users, groups, or both that you want to assign the policy + * to.

* @public */ - Minimum?: string | undefined; + Identities?: Record | undefined; /** - *

The maximum value for a range constant.

+ *

The namespace that contains the assignment.

* @public */ - Maximum?: string | undefined; + Namespace: 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.

- * @public - */ - ConstantType?: ConstantType | undefined; - +export interface CreateIAMPolicyAssignmentResponse { /** - *

The value of the constant that is used to specify the endpoints of a range filter.

+ *

The name of the assignment. + * The + * name must be unique within the Amazon Web Services account.

* @public */ - RangeConstant?: RangeConstant | undefined; -} + AssignmentName?: 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.

+ *

The ID for the assignment.

* @public */ - Inclusive?: boolean | undefined; + AssignmentId?: string | undefined; /** - *

The constant used in a date range filter.

- * @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]; - -/** - *

A structure that represents a singular filter constant, used in filters to specify a single value to match against.

- * @public - */ -export interface TopicSingularFilterConstant { + *

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 + */ + AssignmentStatus?: AssignmentStatus | undefined; + /** - *

The type of the singular filter constant. Valid values for this structure are SINGULAR.

+ *

The ARN for the IAM policy that is applied to the Amazon QuickSight + * users and groups specified in this assignment.

* @public */ - ConstantType?: ConstantType | undefined; + PolicyArn?: string | undefined; /** - *

The value of the singular filter constant.

+ *

The Amazon QuickSight users, groups, or both that the IAM policy is + * assigned to.

* @public */ - SingularConstant?: string | undefined; -} + Identities?: Record | 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.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Constant?: TopicSingularFilterConstant | undefined; + RequestId?: 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 HTTP status of the request.

* @public */ - Aggregation?: NamedFilterAggType | undefined; + Status?: number | 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 + * @enum */ -export interface TopicNumericRangeFilter { +export const IngestionType = { + FULL_REFRESH: "FULL_REFRESH", + INCREMENTAL_REFRESH: "INCREMENTAL_REFRESH", +} as const; + +/** + * @public + */ +export type IngestionType = (typeof IngestionType)[keyof typeof IngestionType]; + +/** + * @public + */ +export interface CreateIngestionRequest { /** - *

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 ID of the dataset used in the ingestion.

* @public */ - Inclusive?: boolean | undefined; + DataSetId: string | undefined; /** - *

The constant used in a - * numeric range filter.

+ *

An ID for the ingestion.

* @public */ - Constant?: TopicRangeFilterConstant | undefined; + IngestionId: 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 Amazon Web Services account ID.

* @public */ - Aggregation?: NamedFilterAggType | undefined; + AwsAccountId: string | undefined; + + /** + *

The type of ingestion that you want to create.

+ * @public + */ + IngestionType?: IngestionType | undefined; } /** * @public * @enum */ -export const TopicRelativeDateFilterFunction = { - LAST: "LAST", - NEXT: "NEXT", - NOW: "NOW", - PREVIOUS: "PREVIOUS", - THIS: "THIS", +export const IngestionStatus = { + CANCELLED: "CANCELLED", + COMPLETED: "COMPLETED", + FAILED: "FAILED", + INITIALIZED: "INITIALIZED", + QUEUED: "QUEUED", + RUNNING: "RUNNING", } as const; /** * @public */ -export type TopicRelativeDateFilterFunction = - (typeof TopicRelativeDateFilterFunction)[keyof typeof TopicRelativeDateFilterFunction]; +export type IngestionStatus = (typeof IngestionStatus)[keyof typeof IngestionStatus]; /** - *

A structure that represents a relative date filter.

* @public */ -export interface TopicRelativeDateFilter { +export interface CreateIngestionResponse { /** - *

The level of time precision that is used to aggregate DateTime values.

+ *

The Amazon Resource Name (ARN) for the data ingestion.

* @public */ - TimeGranularity?: TopicTimeGranularity | undefined; + Arn?: 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.

+ *

An ID for the ingestion.

* @public */ - RelativeDateFilterFunction?: TopicRelativeDateFilterFunction | undefined; + IngestionId?: string | undefined; /** - *

The constant used in a - * relative date filter.

+ *

The ingestion status.

* @public */ - Constant?: TopicSingularFilterConstant | undefined; -} + IngestionStatus?: IngestionStatus | undefined; -/** - *

A structure that represents a filter used to select items for a topic.

- * @public - */ -export interface TopicFilter { /** - *

A description of the filter used to select items for a topic.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - FilterDescription?: string | undefined; + RequestId?: string | undefined; /** - *

The class of the filter. Valid values for this structure are - * ENFORCED_VALUE_FILTER, - * CONDITIONAL_VALUE_FILTER, - * and NAMED_VALUE_FILTER.

+ *

The HTTP status of the request.

* @public */ - FilterClass?: FilterClass | undefined; + Status?: number | undefined; +} + +/** + * @public + * @enum + */ +export const IdentityStore = { + QUICKSIGHT: "QUICKSIGHT", +} as const; + +/** + * @public + */ +export type IdentityStore = (typeof IdentityStore)[keyof typeof IdentityStore]; +/** + * @public + */ +export interface CreateNamespaceRequest { /** - *

The name of the filter.

+ *

The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.

* @public */ - FilterName: string | undefined; + AwsAccountId: string | undefined; /** - *

The other names or aliases for the filter.

+ *

The name that you want to use to describe the new namespace.

* @public */ - FilterSynonyms?: string[] | undefined; + Namespace: string | undefined; /** - *

The name of the field that the filter operates on.

+ *

Specifies the type of your user identity directory. Currently, this supports users + * with an identity type of QUICKSIGHT.

* @public */ - OperandFieldName: string | undefined; + IdentityStore: IdentityStore | undefined; /** - *

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 tags that you want to associate with the namespace that you're creating.

* @public */ - FilterType?: NamedFilterType | undefined; + Tags?: Tag[] | undefined; +} + +/** + * @public + * @enum + */ +export const NamespaceStatus = { + CREATED: "CREATED", + CREATING: "CREATING", + DELETING: "DELETING", + NON_RETRYABLE_FAILURE: "NON_RETRYABLE_FAILURE", + RETRYABLE_FAILURE: "RETRYABLE_FAILURE", +} as const; + +/** + * @public + */ +export type NamespaceStatus = (typeof NamespaceStatus)[keyof typeof NamespaceStatus]; +/** + * @public + */ +export interface CreateNamespaceResponse { /** - *

The category filter that is associated with this filter.

+ *

The ARN of the Amazon QuickSight namespace you created.

* @public */ - CategoryFilter?: TopicCategoryFilter | undefined; + Arn?: string | undefined; /** - *

The numeric equality filter.

+ *

The name of the new namespace that you created.

* @public */ - NumericEqualityFilter?: TopicNumericEqualityFilter | undefined; + Name?: string | undefined; /** - *

The numeric range filter.

+ *

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 */ - NumericRangeFilter?: TopicNumericRangeFilter | undefined; + CapacityRegion?: string | undefined; /** - *

The date range filter.

+ *

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 */ - DateRangeFilter?: TopicDateRangeFilter | undefined; + CreationStatus?: NamespaceStatus | undefined; /** - *

The relative date filter.

+ *

Specifies the type of your user identity directory. Currently, this supports users + * with an identity type of QUICKSIGHT.

* @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]; + IdentityStore?: IdentityStore | 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.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Aggregation?: NamedEntityAggType | undefined; + RequestId?: string | undefined; /** - *

The additional parameters for an aggregation function.

+ *

The HTTP status of the request.

* @public */ - AggregationFunctionParameters?: Record | undefined; + Status?: number | undefined; } /** * @public * @enum */ -export const PropertyRole = { - ID: "ID", - PRIMARY: "PRIMARY", +export const RefreshInterval = { + DAILY: "DAILY", + HOURLY: "HOURLY", + MINUTE15: "MINUTE15", + MINUTE30: "MINUTE30", + MONTHLY: "MONTHLY", + WEEKLY: "WEEKLY", } as const; /** * @public */ -export type PropertyRole = (typeof PropertyRole)[keyof typeof PropertyRole]; +export type RefreshInterval = (typeof RefreshInterval)[keyof typeof RefreshInterval]; /** * @public * @enum */ -export const PropertyUsage = { - DIMENSION: "DIMENSION", - INHERIT: "INHERIT", - MEASURE: "MEASURE", +export const DayOfWeek = { + FRIDAY: "FRIDAY", + MONDAY: "MONDAY", + SATURDAY: "SATURDAY", + SUNDAY: "SUNDAY", + THURSDAY: "THURSDAY", + TUESDAY: "TUESDAY", + WEDNESDAY: "WEDNESDAY", } as const; /** * @public */ -export type PropertyUsage = (typeof PropertyUsage)[keyof typeof PropertyUsage]; +export type DayOfWeek = (typeof DayOfWeek)[keyof typeof DayOfWeek]; /** - *

A structure that represents a named entity.

+ *

The refresh on entity for weekly or monthly schedules.

* @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; - - /** - *

The property role. Valid values for this structure are PRIMARY and ID.

- * @public - */ - PropertyRole?: PropertyRole | undefined; - +export interface ScheduleRefreshOnEntity { /** - *

The property usage. Valid values for this structure are INHERIT, - * DIMENSION, - * and MEASURE.

+ *

The day of the week that you want to schedule a refresh on.

* @public */ - PropertyUsage?: PropertyUsage | undefined; + DayOfWeek?: DayOfWeek | undefined; /** - *

The definition of a metric.

+ *

The day of the month that you want to schedule refresh on.

* @public */ - Metric?: NamedEntityDefinitionMetric | undefined; + DayOfMonth?: string | undefined; } /** - *

A structure that represents a semantic entity type.

+ *

Specifies the interval between each scheduled refresh of a dataset.

* @public */ -export interface SemanticEntityType { +export interface RefreshFrequency { /** - *

The semantic entity type name.

+ *

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 */ - TypeName?: string | undefined; + Interval: RefreshInterval | undefined; /** - *

The semantic entity sub type name.

+ *

The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

* @public */ - SubTypeName?: string | undefined; + RefreshOnDay?: ScheduleRefreshOnEntity | undefined; /** - *

The semantic entity type parameters.

+ *

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 */ - TypeParameters?: Record | undefined; + Timezone?: 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.

+ * @public + */ + TimeOfTheDay?: string | undefined; } /** - *

A structure that represents a named entity.

+ *

The refresh schedule of a dataset.

* @public */ -export interface TopicNamedEntity { +export interface RefreshSchedule { /** - *

The name of the named entity.

+ *

An identifier for the refresh schedule.

* @public */ - EntityName: string | undefined; + ScheduleId: string | undefined; /** - *

The description of the named entity.

+ *

The frequency for the refresh schedule.

* @public */ - EntityDescription?: string | undefined; + ScheduleFrequency: RefreshFrequency | undefined; /** - *

The other - * names or aliases for the named entity.

+ *

Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

* @public */ - EntitySynonyms?: string[] | undefined; + StartAfterDateTime?: Date | undefined; /** - *

The type of named entity that a topic represents.

+ *

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 */ - SemanticEntityType?: SemanticEntityType | undefined; + RefreshType: IngestionType | undefined; /** - *

The definition of a named entity.

+ *

The Amazon Resource Name (ARN) for the refresh schedule.

* @public */ - Definition?: NamedEntityDefinition[] | undefined; + Arn?: string | undefined; } /** - *

A structure that represents a dataset.

* @public */ -export interface DatasetMetadata { - /** - *

The Amazon Resource Name (ARN) of the dataset.

- * @public - */ - DatasetArn: string | undefined; - +export interface CreateRefreshScheduleRequest { /** - *

The name of the dataset.

+ *

The ID of the dataset.

* @public */ - DatasetName?: string | undefined; + DataSetId: string | undefined; /** - *

The description of the dataset.

+ *

The Amazon Web Services account ID.

* @public */ - DatasetDescription?: string | undefined; + AwsAccountId: string | undefined; /** - *

The definition of a data aggregation.

+ *

The refresh schedule.

* @public */ - DataAggregation?: DataAggregation | undefined; + Schedule: RefreshSchedule | undefined; +} +/** + * @public + */ +export interface CreateRefreshScheduleResponse { /** - *

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; /** - *

The list of calculated field definitions.

+ *

The ID of the refresh schedule.

* @public */ - CalculatedFields?: TopicCalculatedField[] | undefined; + ScheduleId?: string | undefined; /** - *

The list of named entities definitions.

+ *

The Amazon Resource Name (ARN) for the refresh schedule.

* @public */ - NamedEntities?: TopicNamedEntity[] | undefined; + Arn?: string | undefined; } /** * @public * @enum */ -export const TopicUserExperienceVersion = { - LEGACY: "LEGACY", - NEW_READER_EXPERIENCE: "NEW_READER_EXPERIENCE", +export const Role = { + ADMIN: "ADMIN", + ADMIN_PRO: "ADMIN_PRO", + AUTHOR: "AUTHOR", + AUTHOR_PRO: "AUTHOR_PRO", + READER: "READER", + READER_PRO: "READER_PRO", } as const; /** * @public */ -export type TopicUserExperienceVersion = (typeof TopicUserExperienceVersion)[keyof typeof TopicUserExperienceVersion]; +export type Role = (typeof Role)[keyof typeof Role]; /** - *

A structure that describes the details of a topic, such as its name, description, and associated data sets.

* @public */ -export interface TopicDetails { +export interface CreateRoleMembershipRequest { /** - *

The name of the topic.

+ *

The name of the group that you want to add to the role.

* @public */ - Name?: string | undefined; + MemberName: string | undefined; /** - *

The description of the topic.

+ *

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 */ - Description?: string | undefined; + AwsAccountId: string | undefined; /** - *

The user experience version of a topic.

+ *

The namespace that the role belongs to.

* @public */ - UserExperienceVersion?: TopicUserExperienceVersion | undefined; + Namespace: string | undefined; /** - *

The data sets that the topic is associated with.

+ *

The role that you want to add a group to.

* @public */ - DataSets?: DatasetMetadata[] | undefined; + Role: Role | undefined; +} +/** + * @public + */ +export interface CreateRoleMembershipResponse { /** - *

Configuration options for a Topic.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - ConfigOptions?: TopicConfigOptions | undefined; + RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; } /** + *

Dataset schema.

* @public */ -export interface CreateTopicRequest { +export interface DataSetSchema { /** - *

The ID of the Amazon Web Services account that you want to create a topic in.

+ *

A structure containing the list of column schemas.

* @public */ - AwsAccountId: string | undefined; + ColumnSchemaList?: ColumnSchema[] | undefined; +} +/** + *

Dataset configuration.

+ * @public + */ +export interface DataSetConfiguration { /** - *

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.

+ *

Placeholder.

* @public */ - TopicId: string | undefined; + Placeholder?: string | undefined; /** - *

The definition of a topic to create.

+ *

Dataset schema.

* @public */ - Topic: TopicDetails | undefined; + DataSetSchema?: DataSetSchema | undefined; /** - *

Contains a map of the key-value pairs for the resource tag or tags that are assigned to - * the dataset.

+ *

A structure containing the list of column group schemas.

* @public */ - Tags?: Tag[] | undefined; + ColumnGroupSchemaList?: ColumnGroupSchema[] | undefined; } /** + *

The detailed definition of a template.

* @public */ -export interface CreateTopicResponse { - /** - *

The Amazon Resource Name (ARN) of the topic.

- * @public - */ - Arn?: string | undefined; - +export interface TemplateVersionDefinition { /** - *

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.

+ *

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

* @public */ - TopicId?: string | undefined; + DataSetConfigurations: DataSetConfiguration[] | undefined; /** - *

The Amazon Resource Name (ARN) of the topic refresh.

+ *

An array of sheet definitions for a template.

* @public */ - RefreshArn?: string | undefined; + Sheets?: SheetDefinition[] | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

An array of calculated field definitions for the template.

* @public */ - RequestId?: string | undefined; + CalculatedFields?: CalculatedField[] | undefined; /** - *

The HTTP status of the request.

+ *

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 */ - Status?: number | undefined; -} - -/** - * @public - * @enum - */ -export const TopicScheduleType = { - DAILY: "DAILY", - HOURLY: "HOURLY", - MONTHLY: "MONTHLY", - WEEKLY: "WEEKLY", -} as const; - -/** - * @public - */ -export type TopicScheduleType = (typeof TopicScheduleType)[keyof typeof TopicScheduleType]; + ParameterDeclarations?: ParameterDeclaration[] | undefined; -/** - *

A structure that represents a topic refresh schedule.

- * @public - */ -export interface TopicRefreshSchedule { /** - *

A Boolean value that controls whether to schedule is enabled.

+ *

Filter definitions for a template.

+ *

For more information, see Filtering Data in the Amazon QuickSight User Guide. + *

* @public */ - IsEnabled: boolean | undefined; + FilterGroups?: FilterGroup[] | undefined; /** - *

A Boolean value that controls whether to schedule runs at the same schedule that is specified in - * SPICE dataset.

+ *

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 */ - BasedOnSpiceSchedule: boolean | undefined; + ColumnConfigurations?: ColumnConfiguration[] | undefined; /** - *

The starting date and time for the refresh schedule.

+ *

The configuration for default analysis settings.

* @public */ - StartingAt?: Date | undefined; + AnalysisDefaults?: AnalysisDefaults | undefined; /** - *

The timezone that you want the refresh schedule to use.

+ *

An array of option definitions for a template.

* @public */ - Timezone?: string | undefined; + Options?: AssetOptions | undefined; /** - *

The time of day when the refresh should run, for - * example, Monday-Sunday.

+ *

A structure that describes the query execution options.

* @public */ - RepeatAt?: string | undefined; + QueryExecutionOptions?: QueryExecutionOptions | undefined; /** - *

The type of refresh schedule. Valid values for this structure are HOURLY, - * DAILY, - * WEEKLY, - * and MONTHLY.

+ *

The static files for the definition.

* @public */ - TopicScheduleType?: TopicScheduleType | undefined; + StaticFiles?: StaticFile[] | undefined; } /** + *

The source analysis of the template.

* @public */ -export interface CreateTopicRefreshScheduleRequest { +export interface TemplateSourceAnalysis { /** - *

The ID of the Amazon Web Services account that contains the topic - * you're creating a refresh schedule for.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ - AwsAccountId: string | undefined; + Arn: string | 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.

+ *

A structure containing information about the dataset references used as placeholders + * in the template.

* @public */ - TopicId: string | undefined; + DataSetReferences: DataSetReference[] | undefined; +} +/** + *

The source template of the template.

+ * @public + */ +export interface TemplateSourceTemplate { /** - *

The Amazon Resource Name (ARN) of the dataset.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ - DatasetArn: string | undefined; + Arn: string | undefined; +} +/** + *

The source entity of the template.

+ * @public + */ +export interface TemplateSourceEntity { /** - *

The name of the dataset.

+ *

The source analysis, if it is based on an analysis.

* @public */ - DatasetName?: string | undefined; + SourceAnalysis?: TemplateSourceAnalysis | undefined; /** - *

The definition of a refresh schedule.

+ *

The source template, if it is based on an template.

* @public */ - RefreshSchedule: TopicRefreshSchedule | undefined; + SourceTemplate?: TemplateSourceTemplate | undefined; } /** * @public */ -export interface CreateTopicRefreshScheduleResponse { +export interface CreateTemplateRequest { /** - *

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 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 */ - TopicId?: string | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Resource Name (ARN) of the topic.

+ *

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 */ - TopicArn?: string | undefined; + TemplateId: string | undefined; /** - *

The Amazon Resource Name (ARN) of the dataset.

+ *

A display name for the template.

* @public */ - DatasetArn?: string | undefined; + Name?: string | undefined; /** - *

The HTTP status of the request.

+ *

A list of resource permissions to be set on the template.

* @public */ - Status?: number | undefined; + Permissions?: ResourcePermission[] | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

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 */ - RequestId?: string | undefined; -} + SourceEntity?: TemplateSourceEntity | undefined; -/** - * @public - */ -export interface CreateVPCConnectionRequest { /** - *

The Amazon Web Services account ID of the account where you want to create a new VPC - * connection.

+ *

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

* @public */ - AwsAccountId: string | undefined; + Tags?: Tag[] | 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 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 */ - VPCConnectionId: string | undefined; + VersionDescription?: string | undefined; /** - *

The display name for the VPC connection.

+ *

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 */ - Name: string | undefined; + Definition?: TemplateVersionDefinition | undefined; /** - *

A list of subnet IDs for the VPC connection.

+ *

TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.

* @public */ - SubnetIds: string[] | undefined; + ValidationStrategy?: ValidationStrategy | undefined; +} +/** + * @public + */ +export interface CreateTemplateResponse { /** - *

A list of security group IDs for the VPC connection.

+ *

The ARN for the template.

* @public */ - SecurityGroupIds: string[] | undefined; + Arn?: string | undefined; /** - *

A list of IP addresses of DNS resolver endpoints for the VPC connection.

+ *

The ARN for the template, including the version information of + * the first version.

* @public */ - DnsResolvers?: string[] | undefined; + VersionArn?: string | undefined; /** - *

The IAM role to associate with the VPC connection.

+ *

The ID of the template.

* @public */ - RoleArn: string | undefined; + TemplateId?: string | undefined; /** - *

A map of the key-value pairs for the resource tag or tags assigned to the VPC - * connection.

+ *

The template creation status.

* @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]; + CreationStatus?: ResourceStatus | 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; + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; -/** - * @public - */ -export type VPCConnectionResourceStatus = - (typeof VPCConnectionResourceStatus)[keyof typeof VPCConnectionResourceStatus]; + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; +} /** * @public */ -export interface CreateVPCConnectionResponse { +export interface CreateTemplateAliasRequest { /** - *

The Amazon Resource Name (ARN) of the VPC connection.

+ *

The ID of the Amazon Web Services account that contains the template that you creating an alias for.

* @public */ - Arn?: string | undefined; + AwsAccountId: string | 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.

+ *

An ID for the template.

* @public */ - VPCConnectionId?: string | undefined; + TemplateId: string | undefined; /** - *

The status of the creation of the VPC connection.

+ *

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 */ - CreationStatus?: VPCConnectionResourceStatus | undefined; + AliasName: string | undefined; /** - *

The availability status of the VPC connection.

+ *

The version number of the template.

* @public */ - AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; + TemplateVersionNumber: number | undefined; +} +/** + *

The template alias.

+ * @public + */ +export interface TemplateAlias { /** - *

The Amazon Web Services request ID for this operation.

+ *

The display name of the template alias.

* @public */ - RequestId?: string | undefined; + AliasName?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the template alias.

+ * @public + */ + Arn?: string | undefined; + + /** + *

The version number of the template alias.

+ * @public + */ + TemplateVersionNumber?: number | undefined; +} + +/** + * @public + */ +export interface CreateTemplateAliasResponse { + /** + *

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; } /** - *

The custom permissions profile.

+ *

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 CustomPermissions { +export interface DataColorPalette { /** - *

The Amazon Resource Name (ARN) of the custom permissions profile.

+ *

The hexadecimal codes for the colors.

* @public */ - Arn?: string | undefined; + Colors?: string[] | undefined; /** - *

The name of the custom permissions profile.

+ *

The minimum and maximum hexadecimal codes that describe a color gradient.

* @public */ - CustomPermissionsName?: string | undefined; + MinMaxGradient?: string[] | undefined; /** - *

A set of actions in the custom permissions profile.

+ *

The hexadecimal code of a color that applies to charts where a lack of data is + * highlighted.

* @public */ - Capabilities?: Capabilities | undefined; + EmptyFillColor?: string | undefined; } /** + *

Display options related to tiles on a sheet.

* @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; +export interface TileStyle { + /** + *

The border around a tile.

+ * @public + */ + Border?: BorderStyle | undefined; +} /** + *

The display options for gutter spacing between tiles on a sheet.

* @public */ -export type DashboardErrorType = (typeof DashboardErrorType)[keyof typeof DashboardErrorType]; +export interface GutterStyle { + /** + *

This Boolean value controls whether to display a gutter space between sheet tiles. + *

+ * @public + */ + Show?: boolean | undefined; +} /** - *

Dashboard error.

+ *

The display options for margins around the outside edge of sheets.

* @public */ -export interface DashboardError { +export interface MarginStyle { /** - *

Type.

+ *

This Boolean value controls whether to display sheet margins.

* @public */ - Type?: DashboardErrorType | undefined; + Show?: boolean | undefined; +} +/** + *

The display options for the layout of tiles on a sheet.

+ * @public + */ +export interface TileLayoutStyle { /** - *

Message.

+ *

The gutter settings that apply between tiles.

* @public */ - Message?: string | undefined; + Gutter?: GutterStyle | undefined; /** - *

Lists the violated entities that caused the dashboard error.

+ *

The margin settings that apply around the outside edge of sheets.

* @public */ - ViolatedEntities?: Entity[] | undefined; + Margin?: MarginStyle | undefined; } /** - *

Dashboard version.

+ *

The theme display options for sheets.

* @public */ -export interface DashboardVersion { +export interface SheetStyle { /** - *

The time that this dashboard version was created.

+ *

The display options for tiles.

* @public */ - CreatedTime?: Date | undefined; + Tile?: TileStyle | undefined; /** - *

Errors associated with this dashboard version.

+ *

The layout options for tiles.

* @public */ - Errors?: DashboardError[] | undefined; + TileLayout?: TileLayoutStyle | undefined; +} +/** + *

Determines the font settings.

+ * @public + */ +export interface Font { /** - *

Version number for this version of the dashboard.

+ *

Determines the font family settings.

* @public */ - VersionNumber?: number | undefined; + FontFamily?: string | undefined; +} +/** + *

Determines the typography options.

+ * @public + */ +export interface Typography { /** - *

The HTTP status of the request.

+ *

Determines the list of font families.

* @public */ - Status?: ResourceStatus | undefined; + FontFamilies?: Font[] | undefined; +} +/** + *

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 Amazon Resource Name (ARN) of the resource.

+ *

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 */ - Arn?: string | undefined; + PrimaryForeground?: string | undefined; /** - *

Source entity ARN.

+ *

The background color that applies to visuals and other high emphasis UI.

* @public */ - SourceEntityArn?: string | undefined; + PrimaryBackground?: string | undefined; /** - *

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this - * version of the dashboard.

+ *

The foreground color that applies to any sheet title, sheet control text, or UI that + * appears over the secondary background.

* @public */ - DataSetArns?: string[] | undefined; + SecondaryForeground?: string | undefined; /** - *

Description.

+ *

The background color that applies to the sheet background and sheet controls.

* @public */ - Description?: string | undefined; + SecondaryBackground?: string | undefined; /** - *

The ARN of the theme associated with a version of the dashboard.

+ *

This color is that applies to selected states and buttons.

* @public */ - ThemeArn?: string | undefined; + Accent?: string | undefined; /** - *

A list of the associated sheets with the unique identifier and name of each sheet.

+ *

The foreground color that applies to any text or other elements that appear over the + * accent color.

* @public */ - Sheets?: Sheet[] | undefined; -} + AccentForeground?: string | undefined; -/** - *

Dashboard.

- * @public - */ -export interface Dashboard { /** - *

Dashboard ID.

+ *

The color that applies to error messages.

* @public */ - DashboardId?: string | undefined; + Danger?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the resource.

+ *

The foreground color that applies to any text or other elements that appear over the + * error color.

* @public */ - Arn?: string | undefined; + DangerForeground?: string | undefined; /** - *

A display name for the dashboard.

+ *

This color that applies to warning and informational messages.

* @public */ - Name?: string | undefined; + Warning?: string | undefined; /** - *

Version.

+ *

The foreground color that applies to any text or other elements that appear over the + * warning color.

* @public */ - Version?: DashboardVersion | undefined; + WarningForeground?: string | undefined; /** - *

The time that this dashboard was created.

+ *

The color that applies to success messages, for example the check mark for a + * successful download.

* @public */ - CreatedTime?: Date | undefined; + Success?: string | undefined; /** - *

The last time that this dashboard was published.

+ *

The foreground color that applies to any text or other elements that appear over the + * success color.

* @public */ - LastPublishedTime?: Date | undefined; + SuccessForeground?: string | undefined; /** - *

The last time that this dashboard was updated.

+ *

The color that applies to the names of fields that are identified as + * dimensions.

* @public */ - LastUpdatedTime?: Date | undefined; + Dimension?: string | undefined; /** - *

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

+ *

The foreground color that applies to any text or other elements that appear over the + * dimension color.

+ * @public + */ + DimensionForeground?: string | undefined; + + /** + *

The color that applies to the names of fields that are identified as measures.

+ * @public + */ + Measure?: string | undefined; + + /** + *

The foreground color that applies to any text or other elements that appear over the + * measure color.

* @public */ - LinkEntities?: string[] | undefined; + MeasureForeground?: string | 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", -} as const; - -/** + *

The theme configuration. This configuration contains all of the display properties for + * a theme.

* @public */ -export type DashboardFilterAttribute = (typeof DashboardFilterAttribute)[keyof typeof DashboardFilterAttribute]; +export interface ThemeConfiguration { + /** + *

Color properties that apply to chart data colors.

+ * @public + */ + DataColorPalette?: DataColorPalette | undefined; -/** - *

A filter that you apply when searching for dashboards.

- * @public - */ -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.

+ *

Color properties that apply to the UI and to charts, excluding the colors that apply + * to data.

* @public */ - Operator: FilterOperator | undefined; + UIColorPalette?: UIColorPalette | 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.

    - *
  • - *
+ *

Display options related to sheets.

* @public */ - Name?: DashboardFilterAttribute | undefined; + Sheet?: SheetStyle | 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".

+ *

Determines the typography options.

* @public */ - Value?: string | undefined; + Typography?: Typography | undefined; } /** - *

Dashboard summary.

* @public */ -export interface DashboardSummary { +export interface CreateThemeRequest { /** - *

The Amazon Resource Name (ARN) of the resource.

+ *

The ID of the Amazon Web Services account where you want to store the new theme.

* @public */ - Arn?: string | undefined; + AwsAccountId: string | undefined; /** - *

Dashboard ID.

+ *

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 */ - DashboardId?: string | undefined; + ThemeId: string | undefined; /** - *

A display name for the dashboard.

+ *

A display name for the theme.

* @public */ - Name?: string | undefined; + Name: string | undefined; /** - *

The time that this dashboard was created.

+ *

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 */ - CreatedTime?: Date | undefined; + BaseThemeId: string | undefined; /** - *

The last time that this dashboard was updated.

+ *

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 */ - LastUpdatedTime?: Date | undefined; + VersionDescription?: string | undefined; /** - *

Published version number.

+ *

The theme configuration, which contains the theme display properties.

* @public */ - PublishedVersionNumber?: number | undefined; + Configuration: ThemeConfiguration | undefined; /** - *

The last time that this dashboard was published.

+ *

A valid grouping of resource permissions to apply to the new theme. + *

* @public */ - LastPublishedTime?: Date | undefined; + Permissions?: ResourcePermission[] | undefined; + + /** + *

A map of the key-value pairs for the resource tag or tags that you want to add to the + * resource.

+ * @public + */ + Tags?: Tag[] | undefined; } /** - *

Dashboard version summary.

* @public */ -export interface DashboardVersionSummary { +export interface CreateThemeResponse { /** - *

The Amazon Resource Name (ARN) of the resource.

+ *

The Amazon Resource Name (ARN) for the theme.

* @public */ Arn?: string | undefined; /** - *

The time that this dashboard version was created.

+ *

The Amazon Resource Name (ARN) for the new theme.

* @public */ - CreatedTime?: Date | undefined; + VersionArn?: string | undefined; /** - *

Version number.

+ *

The ID of the theme.

* @public */ - VersionNumber?: number | undefined; + ThemeId?: string | undefined; /** - *

The HTTP status of the request.

+ *

The theme creation status.

* @public */ - Status?: ResourceStatus | undefined; + CreationStatus?: ResourceStatus | undefined; /** - *

Source entity ARN.

+ *

The HTTP status of the request.

* @public */ - SourceEntityArn?: string | undefined; + Status?: number | undefined; /** - *

Description.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Description?: string | undefined; + RequestId?: string | undefined; } /** - *

Output column.

* @public */ -export interface OutputColumn { +export interface CreateThemeAliasRequest { /** - *

The display name of the column..

+ *

The ID of the Amazon Web Services account that contains the theme for the new theme alias.

* @public */ - Name?: string | undefined; + AwsAccountId: string | undefined; /** - *

A description for a column.

+ *

An ID for the theme alias.

* @public */ - Description?: string | undefined; + ThemeId: string | undefined; /** - *

The data type of the column.

+ *

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 */ - Type?: ColumnDataType | undefined; + AliasName: string | undefined; /** - *

The sub data type of the column.

+ *

The version number of the theme.

* @public */ - SubType?: ColumnDataSubType | undefined; + ThemeVersionNumber: number | undefined; } /** - *

Dataset.

+ *

An alias for a theme.

* @public */ -export interface DataSet { +export interface ThemeAlias { /** - *

The Amazon Resource Name (ARN) of the resource.

+ *

The Amazon Resource Name (ARN) of the theme alias.

* @public */ Arn?: string | undefined; /** - *

The ID of the dataset.

+ *

The display name of the theme alias.

* @public */ - DataSetId?: string | undefined; + AliasName?: string | undefined; /** - *

A display name for the dataset.

+ *

The version number of the theme alias.

* @public */ - Name?: string | undefined; + ThemeVersionNumber?: number | undefined; +} +/** + * @public + */ +export interface CreateThemeAliasResponse { /** - *

The time that this dataset was created.

+ *

Information about the theme alias.

* @public */ - CreatedTime?: Date | undefined; + ThemeAlias?: ThemeAlias | undefined; /** - *

The last time that this dataset was updated.

+ *

The HTTP status of the request.

* @public */ - LastUpdatedTime?: Date | undefined; + Status?: number | undefined; /** - *

Declares the physical tables that are available in the underlying data sources.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - PhysicalTableMap?: Record | undefined; + RequestId?: string | undefined; +} +/** + *

Configuration options for a Topic.

+ * @public + */ +export interface TopicConfigOptions { /** - *

Configures the combination and transformation of the data from the physical - * tables.

+ *

Enables Amazon Q Business Insights for a Topic.

* @public */ - LogicalTableMap?: Record | undefined; + QBusinessInsightsEnabled?: boolean | undefined; +} - /** - *

The list of columns after all transforms. These columns are available in templates, - * analyses, and dashboards.

- * @public - */ - OutputColumns?: OutputColumn[] | 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.

+ * @public + */ +export interface DefaultFormatting { /** - *

A value that indicates whether you want to import the data into SPICE.

+ *

The display format. Valid values for this structure are AUTO, + * PERCENT, CURRENCY, NUMBER, DATE, and + * STRING.

* @public */ - ImportMode?: DataSetImportMode | undefined; + DisplayFormat?: DisplayFormat | undefined; /** - *

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't - * imported into SPICE.

+ *

The additional options for display formatting.

* @public */ - ConsumedSpiceCapacityInBytes?: number | undefined; + DisplayFormatOptions?: DisplayFormatOptions | undefined; +} +/** + *

A structure that represents a semantic type.

+ * @public + */ +export interface SemanticType { /** - *

Groupings of columns that work together in certain Amazon QuickSight features. - * Currently, only geospatial hierarchy is supported.

+ *

The semantic type name.

* @public */ - ColumnGroups?: ColumnGroup[] | undefined; + TypeName?: string | undefined; /** - *

The folder that contains fields and nested subfolders for your dataset.

+ *

The semantic type sub type name.

* @public */ - FieldFolders?: Record | undefined; + SubTypeName?: string | undefined; /** - *

The row-level security configuration for the dataset.

+ *

The semantic type parameters.

* @public */ - RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; + TypeParameters?: Record | undefined; /** - *

The element you can use to define tags for row-level security.

+ *

The semantic type truthy cell value.

* @public */ - RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration | undefined; + TruthyCellValue?: string | undefined; /** - *

A set of one or more definitions of a - * ColumnLevelPermissionRule - * .

+ *

The other names or aliases for the true cell value.

* @public */ - ColumnLevelPermissionRules?: ColumnLevelPermissionRule[] | undefined; + TruthyCellValueSynonyms?: string[] | undefined; /** - *

The usage configuration to apply to child datasets that reference this dataset as a source.

+ *

The semantic type falsey cell value.

* @public */ - DataSetUsageConfiguration?: DataSetUsageConfiguration | undefined; + FalseyCellValue?: string | undefined; /** - *

The parameters that are declared in a dataset.

+ *

The other names or aliases for the false cell value.

* @public */ - DatasetParameters?: DatasetParameter[] | undefined; + FalseyCellValueSynonyms?: 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; - -/** - * @public - */ -export type DataSetFilterAttribute = (typeof DataSetFilterAttribute)[keyof typeof DataSetFilterAttribute]; - -/** - * @public - * @enum - */ -export const LookbackWindowSizeUnit = { - DAY: "DAY", - HOUR: "HOUR", - WEEK: "WEEK", -} as const; - -/** - * @public - */ -export type LookbackWindowSizeUnit = (typeof LookbackWindowSizeUnit)[keyof typeof LookbackWindowSizeUnit]; - -/** - *

The lookback window setup of an incremental refresh configuration.

+ *

A structure that represents a calculated field.

* @public */ -export interface LookbackWindow { - /** - *

The name of the lookback window column.

- * @public - */ - ColumnName: string | undefined; - +export interface TopicCalculatedField { /** - *

The lookback window column size.

+ *

The calculated field name.

* @public */ - Size: number | undefined; + CalculatedFieldName: string | undefined; /** - *

The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.

+ *

The calculated field description.

* @public */ - SizeUnit: LookbackWindowSizeUnit | undefined; -} + CalculatedFieldDescription?: string | undefined; -/** - *

The incremental refresh configuration for a dataset.

- * @public - */ -export interface IncrementalRefresh { /** - *

The lookback window setup for an incremental refresh configuration.

+ *

The calculated field expression.

* @public */ - LookbackWindow: LookbackWindow | undefined; -} + Expression: string | undefined; -/** - *

The refresh configuration of a dataset.

- * @public - */ -export interface RefreshConfiguration { /** - *

The incremental refresh for the dataset.

+ *

The other names or aliases for the calculated field.

* @public */ - IncrementalRefresh: IncrementalRefresh | undefined; -} + CalculatedFieldSynonyms?: string[] | undefined; -/** - *

The refresh properties of a dataset.

- * @public - */ -export interface DataSetRefreshProperties { /** - *

The refresh configuration for a dataset.

+ *

A boolean value that indicates if a calculated field is included in the topic.

* @public */ - RefreshConfiguration: RefreshConfiguration | undefined; -} + IsIncludedInTopic?: boolean | undefined; -/** - *

A filter that you apply when searching for datasets.

- * @public - */ -export interface DataSetSearchFilter { /** - *

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.

+ *

A Boolean value that indicates if a calculated field is visible in the autocomplete.

* @public */ - Operator: FilterOperator | undefined; + DisableIndexing?: boolean | 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 column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.

* @public */ - Name: DataSetFilterAttribute | undefined; + ColumnDataRole?: ColumnDataRole | 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 level of time precision that is used to aggregate DateTime values.

* @public */ - Value: string | undefined; -} + TimeGranularity?: TopicTimeGranularity | undefined; -/** - *

Dataset summary.

- * @public - */ -export interface DataSetSummary { /** - *

The Amazon Resource Name (ARN) of the dataset.

+ *

The default formatting definition.

* @public */ - Arn?: string | undefined; + DefaultFormatting?: DefaultFormatting | undefined; /** - *

The ID of the dataset.

+ *

The default aggregation. Valid values for this structure are SUM, + * MAX, MIN, COUNT, + * DISTINCT_COUNT, + * and AVERAGE.

* @public */ - DataSetId?: string | undefined; + Aggregation?: DefaultAggregation | undefined; /** - *

A display name for the dataset.

+ *

The order in which data is displayed for the calculated field when + * it's used in a comparative context.

* @public */ - Name?: string | undefined; + ComparativeOrder?: ComparativeOrder | undefined; /** - *

The time that this dataset was created.

+ *

The semantic type.

* @public */ - CreatedTime?: Date | undefined; + SemanticType?: SemanticType | undefined; /** - *

The last time that this dataset was updated.

+ *

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 */ - LastUpdatedTime?: Date | undefined; + AllowedAggregations?: AuthorSpecifiedAggregation[] | undefined; /** - *

A value that indicates whether you want to import the data into SPICE.

+ *

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 */ - ImportMode?: DataSetImportMode | undefined; + NotAllowedAggregations?: AuthorSpecifiedAggregation[] | undefined; /** - *

The row-level security configuration for the dataset.

+ *

A Boolean value that indicates whether to never aggregate calculated field in filters.

* @public */ - RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; + NeverAggregateInFilter?: boolean | undefined; /** - *

Whether or not the row level permission tags are applied.

+ *

The other + * names or aliases for the calculated field cell value.

* @public */ - RowLevelPermissionTagConfigurationApplied?: boolean | undefined; + CellValueSynonyms?: CellValueSynonym[] | undefined; /** - *

A value that indicates if the dataset has column level permission configured.

+ *

The non additive for the table style target.

* @public */ - ColumnLevelPermissionRulesApplied?: boolean | undefined; + NonAdditive?: boolean | 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", -} as const; - -/** + *

Represents a column in a dataset.

* @public */ -export type DataSourceErrorInfoType = (typeof DataSourceErrorInfoType)[keyof typeof DataSourceErrorInfoType]; +export interface TopicColumn { + /** + *

The name of the column.

+ * @public + */ + ColumnName: string | undefined; + + /** + *

A user-friendly name for the column.

+ * @public + */ + ColumnFriendlyName?: string | undefined; -/** - *

Error information for the data source creation or update.

- * @public - */ -export interface DataSourceErrorInfo { /** - *

Error type.

+ *

A description of the column and its contents.

* @public */ - Type?: DataSourceErrorInfoType | undefined; + ColumnDescription?: string | undefined; /** - *

Error message.

+ *

The other names or aliases for the column.

* @public */ - Message?: string | undefined; -} + ColumnSynonyms?: string[] | undefined; -/** - *

The structure of a data source.

- * @public - */ -export interface DataSource { /** - *

The Amazon Resource Name (ARN) of the data source.

+ *

The role of the column in the data. Valid values are DIMENSION and MEASURE.

* @public */ - Arn?: string | undefined; + ColumnDataRole?: ColumnDataRole | undefined; /** - *

The ID of the data source. This ID is unique per Amazon Web Services Region for each - * Amazon Web Services account.

+ *

The type of aggregation that is performed on the column data when + * it's queried.

* @public */ - DataSourceId?: string | undefined; + Aggregation?: DefaultAggregation | undefined; /** - *

A display name for the data source.

+ *

A Boolean value that indicates whether the column is included in the query results.

* @public */ - Name?: string | undefined; + IsIncludedInTopic?: boolean | undefined; /** - *

The type of the data source. This type indicates which database engine the data source - * connects to.

+ *

A Boolean value that indicates whether the column shows in the autocomplete functionality.

* @public */ - Type?: DataSourceType | undefined; + DisableIndexing?: boolean | undefined; /** - *

The HTTP status of the request.

+ *

The order in which data is displayed for the column when + * it's used in a comparative context.

* @public */ - Status?: ResourceStatus | undefined; + ComparativeOrder?: ComparativeOrder | undefined; /** - *

The time that this data source was created.

+ *

The semantic type of data contained in the column.

* @public */ - CreatedTime?: Date | undefined; + SemanticType?: SemanticType | undefined; /** - *

The last time that this data source was updated.

+ *

The level of time precision that is used to aggregate DateTime values.

* @public */ - LastUpdatedTime?: Date | undefined; + TimeGranularity?: TopicTimeGranularity | 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.

+ *

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 */ - DataSourceParameters?: DataSourceParameters | undefined; + AllowedAggregations?: AuthorSpecifiedAggregation[] | undefined; /** - *

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 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 */ - AlternateDataSourceParameters?: DataSourceParameters[] | undefined; + NotAllowedAggregations?: AuthorSpecifiedAggregation[] | 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 default formatting used for values in the column.

* @public */ - VpcConnectionProperties?: VpcConnectionProperties | undefined; + DefaultFormatting?: DefaultFormatting | undefined; /** - *

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your - * underlying source.

+ *

A Boolean + * value that indicates whether to aggregate the column data when + * it's used in a filter context.

* @public */ - SslProperties?: SslProperties | undefined; + NeverAggregateInFilter?: boolean | undefined; /** - *

Error information from the last update or the creation of the data source.

+ *

The other names or aliases for the column cell value.

* @public */ - ErrorInfo?: DataSourceErrorInfo | undefined; + CellValueSynonyms?: CellValueSynonym[] | undefined; /** - *

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

+ *

The non additive value for the column.

* @public */ - SecretArn?: string | undefined; + NonAdditive?: boolean | undefined; } /** + *

A structure that represents a data aggregation.

* @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; +export interface DataAggregation { + /** + *

The level of time precision that is used to aggregate DateTime values.

+ * @public + */ + DatasetRowDateGranularity?: TopicTimeGranularity | undefined; + + /** + *

The column name for the default date.

+ * @public + */ + DefaultDateColumnName?: string | undefined; +} /** + *

A constant used in a category filter.

* @public */ -export type DataSourceFilterAttribute = (typeof DataSourceFilterAttribute)[keyof typeof DataSourceFilterAttribute]; +export interface TopicCategoryFilterConstant { + /** + *

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 + */ + ConstantType?: ConstantType | undefined; + + /** + *

A singular constant used in a category filter. This element is used to specify a single value for the constant.

+ * @public + */ + SingularConstant?: string | undefined; + + /** + *

A collective constant used in a category filter. This element is used to specify a list of values for the constant.

+ * @public + */ + CollectiveConstant?: CollectiveConstant | undefined; +} /** - *

A filter that you apply when searching for data sources.

+ *

A structure that represents a category filter.

* @public */ -export interface DataSourceSearchFilter { +export interface TopicCategoryFilter { /** - *

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.

+ *

The category filter function. Valid values for this structure are EXACT and CONTAINS.

* @public */ - Operator: FilterOperator | undefined; + CategoryFilterFunction?: CategoryFilterFunction | 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.

    - *
  • - *
+ *

The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.

* @public */ - Name: DataSourceFilterAttribute | undefined; + CategoryFilterType?: CategoryFilterType | 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 constant used in a category filter.

* @public */ - Value: string | undefined; + Constant?: TopicCategoryFilterConstant | undefined; + + /** + *

A Boolean value that indicates if the filter is inverse.

+ * @public + */ + Inverse?: boolean | undefined; } /** - *

A DataSourceSummary object that returns a summary of a data source.

+ *

A structure that represents a range constant.

* @public */ -export interface DataSourceSummary { +export interface RangeConstant { /** - *

The arn of the datasource.

+ *

The minimum value for a range constant.

* @public */ - Arn?: string | undefined; + Minimum?: string | undefined; /** - *

The unique ID of the data source.

+ *

The maximum value for a range constant.

* @public */ - DataSourceId?: string | 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 name of the data source.

+ *

The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE.

* @public */ - Name?: string | undefined; + ConstantType?: ConstantType | undefined; /** - *

The type of the data source.

+ *

The value of the constant that is used to specify the endpoints of a range filter.

* @public */ - Type?: DataSourceType | undefined; + RangeConstant?: RangeConstant | undefined; +} +/** + *

A filter used to restrict data based on a range of dates or times.

+ * @public + */ +export interface TopicDateRangeFilter { /** - *

The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.

+ *

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 */ - CreatedTime?: Date | undefined; + Inclusive?: boolean | undefined; + + /** + *

The constant used in a date range filter.

+ * @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; - /** - *

The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.

- * @public - */ - LastUpdatedTime?: Date | undefined; -} +/** + * @public + */ +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 DeleteAccountCustomizationRequest { +export interface TopicSingularFilterConstant { /** - *

The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in - * this Amazon Web Services Region.

+ *

The type of the singular filter constant. Valid values for this structure are SINGULAR.

* @public */ - AwsAccountId: string | undefined; + ConstantType?: ConstantType | undefined; /** - *

The Amazon QuickSight namespace that you're deleting the customizations from.

+ *

The value of the singular filter constant.

* @public */ - Namespace?: string | undefined; + SingularConstant?: 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 DeleteAccountCustomizationResponse { +export interface TopicNumericEqualityFilter { /** - *

The Amazon Web Services request ID for this operation.

+ *

The constant used in a numeric equality filter.

* @public */ - RequestId?: string | undefined; + Constant?: TopicSingularFilterConstant | undefined; /** - *

The HTTP status of the request.

+ *

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 */ - Status?: 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 DeleteAccountSubscriptionRequest { +export interface TopicNumericRangeFilter { /** - *

The Amazon Web Services account ID of the account that you want to delete.

+ *

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 */ - AwsAccountId: string | undefined; -} + Inclusive?: boolean | undefined; -/** - * @public - */ -export interface DeleteAccountSubscriptionResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

The constant used in a + * numeric range filter.

* @public */ - RequestId?: string | undefined; + Constant?: TopicRangeFilterConstant | undefined; /** - *

The HTTP status of the request.

+ *

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 */ - Status?: number | undefined; + Aggregation?: NamedFilterAggType | undefined; } /** * @public + * @enum */ -export interface DeleteAnalysisRequest { - /** - *

The ID of the Amazon Web Services account where you want to delete an analysis.

- * @public - */ - AwsAccountId: 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 { /** - *

The ID of the analysis that you're deleting.

+ *

The level of time precision that is used to aggregate DateTime values.

* @public */ - AnalysisId: string | undefined; + TimeGranularity?: TopicTimeGranularity | 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.

+ *

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 */ - RecoveryWindowInDays?: number | undefined; + RelativeDateFilterFunction?: TopicRelativeDateFilterFunction | 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 constant used in a + * relative date filter.

* @public */ - ForceDeleteWithoutRecovery?: boolean | undefined; + Constant?: TopicSingularFilterConstant | undefined; } /** + *

A structure that represents a filter used to select items for a topic.

* @public */ -export interface DeleteAnalysisResponse { - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; - +export interface TopicFilter { /** - *

The Amazon Resource Name (ARN) of the deleted analysis.

+ *

A description of the filter used to select items for a topic.

* @public */ - Arn?: string | undefined; + FilterDescription?: string | undefined; /** - *

The ID of the deleted analysis.

+ *

The class of the filter. Valid values for this structure are + * ENFORCED_VALUE_FILTER, + * CONDITIONAL_VALUE_FILTER, + * and NAMED_VALUE_FILTER.

* @public */ - AnalysisId?: string | undefined; + FilterClass?: FilterClass | undefined; /** - *

The date and time that the analysis is scheduled to be deleted.

+ *

The name of the filter.

* @public */ - DeletionTime?: Date | undefined; + FilterName: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The other names or aliases for the filter.

* @public */ - RequestId?: string | undefined; -} + FilterSynonyms?: string[] | undefined; -/** - * @public - */ -export interface DeleteBrandRequest { /** - *

The ID of the Amazon Web Services account that owns the brand.

+ *

The name of the field that the filter operates on.

* @public */ - AwsAccountId: string | undefined; + OperandFieldName: string | undefined; /** - *

The ID of the Amazon QuickSight brand.

+ *

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 */ - BrandId: string | undefined; -} + FilterType?: NamedFilterType | undefined; -/** - * @public - */ -export interface DeleteBrandResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

The category filter that is associated with this filter.

* @public */ - RequestId?: string | undefined; -} + CategoryFilter?: TopicCategoryFilter | undefined; -/** - * @public - */ -export interface DeleteBrandAssignmentRequest { /** - *

The ID of the Amazon Web Services account that owns the brand assignment.

+ *

The numeric equality filter.

* @public */ - AwsAccountId: string | undefined; -} + NumericEqualityFilter?: TopicNumericEqualityFilter | undefined; -/** - * @public - */ -export interface DeleteBrandAssignmentResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

The numeric range filter.

* @public */ - RequestId?: string | undefined; -} + NumericRangeFilter?: TopicNumericRangeFilter | undefined; -/** - * @public - */ -export interface DeleteCustomPermissionsRequest { /** - *

The ID of the Amazon Web Services account that contains the custom permissions profile that you want to delete.

+ *

The date range filter.

* @public */ - AwsAccountId: string | undefined; + DateRangeFilter?: TopicDateRangeFilter | undefined; /** - *

The name of the custom permissions profile that you want to delete.

+ *

The relative date filter.

* @public */ - CustomPermissionsName: string | undefined; + RelativeDateFilter?: TopicRelativeDateFilter | undefined; } /** * @public + * @enum */ -export interface DeleteCustomPermissionsResponse { - /** - *

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; -} +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 interface DeleteDashboardRequest { - /** - *

The ID of the Amazon Web Services account that contains the dashboard that you're - * deleting.

- * @public - */ - AwsAccountId: string | undefined; +export type NamedEntityAggType = (typeof NamedEntityAggType)[keyof typeof NamedEntityAggType]; +/** + *

A structure that represents a metric.

+ * @public + */ +export interface NamedEntityDefinitionMetric { /** - *

The ID for the dashboard.

+ *

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 */ - DashboardId: string | undefined; + Aggregation?: NamedEntityAggType | undefined; /** - *

The version number of the dashboard. If the version number property is provided, only - * the specified version of the dashboard is deleted.

+ *

The additional parameters for an aggregation function.

* @public */ - VersionNumber?: number | undefined; + AggregationFunctionParameters?: Record | undefined; } /** * @public + * @enum */ -export interface DeleteDashboardResponse { - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; +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 Secure Socket Layer (SSL) properties that apply for the resource.

+ *

The name of the entity.

* @public */ - Arn?: string | undefined; + FieldName?: string | undefined; /** - *

The ID of the dashboard.

+ *

The property name to be used for the named entity.

* @public */ - DashboardId?: string | undefined; + PropertyName?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The property role. Valid values for this structure are PRIMARY and ID.

* @public */ - RequestId?: string | undefined; -} + PropertyRole?: PropertyRole | undefined; -/** - * @public - */ -export interface DeleteDataSetRequest { /** - *

The Amazon Web Services account ID.

+ *

The property usage. Valid values for this structure are INHERIT, + * DIMENSION, + * and MEASURE.

* @public */ - AwsAccountId: string | undefined; + PropertyUsage?: PropertyUsage | 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 definition of a metric.

* @public */ - DataSetId: string | undefined; + Metric?: NamedEntityDefinitionMetric | undefined; } /** + *

A structure that represents a semantic entity type.

* @public */ -export interface DeleteDataSetResponse { - /** - *

The Amazon Resource Name (ARN) of the dataset.

- * @public - */ - Arn?: string | undefined; - +export interface SemanticEntityType { /** - *

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 semantic entity type name.

* @public */ - DataSetId?: string | undefined; + TypeName?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The semantic entity sub type name.

* @public */ - RequestId?: string | undefined; + SubTypeName?: string | undefined; /** - *

The HTTP status of the request.

+ *

The semantic entity type parameters.

* @public */ - Status?: number | undefined; + TypeParameters?: Record | undefined; } /** + *

A structure that represents a named entity.

* @public */ -export interface DeleteDataSetRefreshPropertiesRequest { - /** - *

The Amazon Web Services account ID.

- * @public - */ - AwsAccountId: string | undefined; - +export interface TopicNamedEntity { /** - *

The ID of the dataset.

+ *

The name of the named entity.

* @public */ - DataSetId: string | undefined; -} + EntityName: string | undefined; -/** - * @public - */ -export interface DeleteDataSetRefreshPropertiesResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

The description of the named entity.

* @public */ - RequestId?: string | undefined; + EntityDescription?: string | undefined; /** - *

The HTTP status of the request.

+ *

The other + * names or aliases for the named entity.

* @public */ - Status?: number | undefined; -} + EntitySynonyms?: string[] | undefined; -/** - * @public - */ -export interface DeleteDataSourceRequest { /** - *

The Amazon Web Services account ID.

+ *

The type of named entity that a topic represents.

* @public */ - AwsAccountId: string | undefined; + SemanticEntityType?: SemanticEntityType | undefined; /** - *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The definition of a named entity.

* @public */ - DataSourceId: string | undefined; + Definition?: NamedEntityDefinition[] | undefined; } /** + *

A structure that represents a dataset.

* @public */ -export interface DeleteDataSourceResponse { - /** - *

The Amazon Resource Name (ARN) of the data source that you deleted.

- * @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; - +export interface DatasetMetadata { /** - *

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 name of the dataset.

* @public */ - Status?: number | undefined; -} + DatasetName?: string | undefined; -/** - * @public - */ -export interface DeleteFolderRequest { /** - *

The ID for the Amazon Web Services account that contains the folder.

+ *

The description of the dataset.

* @public */ - AwsAccountId: string | undefined; + DatasetDescription?: string | undefined; /** - *

The ID of the folder.

+ *

The definition of a data aggregation.

* @public */ - FolderId: string | undefined; -} + DataAggregation?: DataAggregation | undefined; -/** - * @public - */ -export interface DeleteFolderResponse { /** - *

The HTTP status of the request.

+ *

The list of filter definitions.

* @public */ - Status?: number | undefined; + Filters?: TopicFilter[] | undefined; /** - *

The Amazon Resource Name of the deleted folder.

+ *

The list of column definitions.

* @public */ - Arn?: string | undefined; + Columns?: TopicColumn[] | undefined; /** - *

The ID of the folder.

+ *

The list of calculated field definitions.

* @public */ - FolderId?: string | undefined; + CalculatedFields?: TopicCalculatedField[] | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The list of named entities definitions.

* @public */ - RequestId?: string | undefined; + NamedEntities?: TopicNamedEntity[] | undefined; } /** * @public + * @enum */ -export interface DeleteFolderMembershipRequest { - /** - *

The ID for the Amazon Web Services account that contains the folder.

- * @public - */ - AwsAccountId: string | undefined; +export const TopicUserExperienceVersion = { + LEGACY: "LEGACY", + NEW_READER_EXPERIENCE: "NEW_READER_EXPERIENCE", +} as const; +/** + * @public + */ +export type TopicUserExperienceVersion = (typeof TopicUserExperienceVersion)[keyof typeof TopicUserExperienceVersion]; + +/** + *

A structure that describes the details of a topic, such as its name, description, and associated data sets.

+ * @public + */ +export interface TopicDetails { /** - *

The Folder ID.

+ *

The name of the topic.

* @public */ - FolderId: string | undefined; + Name?: string | undefined; /** - *

The ID of the asset that you want to delete.

+ *

The description of the topic.

* @public */ - MemberId: string | undefined; + Description?: string | undefined; /** - *

The member type of the asset that you want to delete from a folder.

+ *

The user experience version of a topic.

* @public */ - MemberType: MemberType | undefined; -} + UserExperienceVersion?: TopicUserExperienceVersion | undefined; -/** - * @public - */ -export interface DeleteFolderMembershipResponse { /** - *

The HTTP status of the request.

+ *

The data sets that the topic is associated with.

* @public */ - Status?: number | undefined; + DataSets?: DatasetMetadata[] | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

Configuration options for a Topic.

* @public */ - RequestId?: string | undefined; + ConfigOptions?: TopicConfigOptions | undefined; } /** * @public */ -export interface DeleteGroupRequest { +export interface CreateTopicRequest { /** - *

The name of the group that you want to delete.

+ *

The ID of the Amazon Web Services account that you want to create a topic in.

* @public */ - GroupName: string | undefined; + AwsAccountId: 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 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 */ - AwsAccountId: string | undefined; + TopicId: string | undefined; /** - *

The namespace of the group that you want to delete.

+ *

The definition of a topic to create.

* @public */ - Namespace: string | undefined; -} + Topic: TopicDetails | undefined; -/** - * @public - */ -export interface DeleteGroupResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

Contains a map of the key-value pairs for the resource tag or tags that are assigned to + * the dataset.

* @public */ - RequestId?: string | undefined; + Tags?: Tag[] | undefined; /** - *

The HTTP status of the request.

+ *

The Folder ARN of the folder that you want the topic to reside in.

* @public */ - Status?: number | undefined; + FolderArns?: string[] | undefined; } /** * @public */ -export interface DeleteGroupMembershipRequest { - /** - *

The name of the user that you want to delete from the group membership.

- * @public - */ - MemberName: string | undefined; - +export interface CreateTopicResponse { /** - *

The name of the group that you want to delete the user from.

+ *

The Amazon Resource Name (ARN) of the topic.

* @public */ - GroupName: string | undefined; + Arn?: 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 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 */ - AwsAccountId: string | undefined; + TopicId?: string | undefined; /** - *

The namespace of the group that you want to remove a user from.

+ *

The Amazon Resource Name (ARN) of the topic refresh.

* @public */ - Namespace: string | undefined; -} + RefreshArn?: string | undefined; -/** - * @public - */ -export interface DeleteGroupMembershipResponse { /** *

The Amazon Web Services request ID for this operation.

* @public @@ -6039,245 +5981,263 @@ export interface DeleteGroupMembershipResponse { /** * @public + * @enum */ -export interface DeleteIAMPolicyAssignmentRequest { +export const TopicScheduleType = { + DAILY: "DAILY", + HOURLY: "HOURLY", + MONTHLY: "MONTHLY", + WEEKLY: "WEEKLY", +} as const; + +/** + * @public + */ +export type TopicScheduleType = (typeof TopicScheduleType)[keyof typeof TopicScheduleType]; + +/** + *

A structure that represents a topic refresh schedule.

+ * @public + */ +export interface TopicRefreshSchedule { /** - *

The Amazon Web Services account ID where you want to delete the IAM - * policy assignment.

+ *

A Boolean value that controls whether to schedule is enabled.

* @public */ - AwsAccountId: string | undefined; + IsEnabled: boolean | undefined; /** - *

The name of the assignment.

+ *

A Boolean value that controls whether to schedule runs at the same schedule that is specified in + * SPICE dataset.

* @public */ - AssignmentName: string | undefined; + BasedOnSpiceSchedule: boolean | undefined; /** - *

The namespace that contains the assignment.

+ *

The starting date and time for the refresh schedule.

* @public */ - Namespace: string | undefined; -} + StartingAt?: Date | undefined; -/** - * @public - */ -export interface DeleteIAMPolicyAssignmentResponse { /** - *

The name of the assignment.

+ *

The timezone that you want the refresh schedule to use.

* @public */ - AssignmentName?: string | undefined; + Timezone?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The time of day when the refresh should run, for + * example, Monday-Sunday.

* @public */ - RequestId?: string | undefined; + RepeatAt?: string | undefined; /** - *

The HTTP status of the request.

+ *

The type of refresh schedule. Valid values for this structure are HOURLY, + * DAILY, + * WEEKLY, + * and MONTHLY.

* @public */ - Status?: number | undefined; + TopicScheduleType?: TopicScheduleType | undefined; } /** * @public */ -export interface DeleteIdentityPropagationConfigRequest { +export interface CreateTopicRefreshScheduleRequest { /** - *

The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from.

+ *

The ID of the Amazon Web Services account that contains the topic + * you're creating a refresh schedule for.

* @public */ AwsAccountId: string | undefined; /** - *

The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.

- * @public - */ - Service: ServiceType | undefined; -} - -/** - * @public - */ -export interface DeleteIdentityPropagationConfigResponse { - /** - *

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 dataset.

* @public */ - Status?: number | undefined; -} + DatasetArn: string | undefined; -/** - * @public - */ -export interface DeleteNamespaceRequest { /** - *

The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.

+ *

The name of the dataset.

* @public */ - AwsAccountId: string | undefined; + DatasetName?: string | undefined; /** - *

The namespace that you want to delete.

+ *

The definition of a refresh schedule.

* @public */ - Namespace: string | undefined; + RefreshSchedule: TopicRefreshSchedule | undefined; } /** * @public */ -export interface DeleteNamespaceResponse { +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 DeleteRefreshScheduleRequest { /** - *

The ID of the dataset.

+ *

The Amazon Resource Name (ARN) of the dataset.

* @public */ - DataSetId: string | undefined; + DatasetArn?: string | undefined; /** - *

The Amazon Web Services account ID.

+ *

The HTTP status of the request.

* @public */ - AwsAccountId: string | undefined; + Status?: number | undefined; /** - *

The ID of the refresh schedule.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - ScheduleId: string | undefined; + RequestId?: string | undefined; } /** * @public */ -export interface DeleteRefreshScheduleResponse { +export interface CreateVPCConnectionRequest { /** - *

The HTTP status of the request.

+ *

The Amazon Web Services account ID of the account where you want to create a new VPC + * connection.

* @public */ - Status?: number | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

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 */ - RequestId?: string | undefined; + VPCConnectionId: string | undefined; /** - *

The ID of the refresh schedule.

+ *

The display name for the VPC connection.

* @public */ - ScheduleId?: string | undefined; + Name: string | undefined; /** - *

The Amazon Resource Name (ARN) for the refresh schedule.

+ *

A list of subnet IDs for the VPC connection.

* @public */ - Arn?: string | undefined; -} + SubnetIds: string[] | undefined; -/** - * @public - */ -export interface DeleteRoleCustomPermissionRequest { /** - *

The role that you want to remove permissions from.

+ *

A list of security group IDs for the VPC connection.

* @public */ - Role: Role | undefined; + SecurityGroupIds: 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 list of IP addresses of DNS resolver endpoints for the VPC connection.

* @public */ - AwsAccountId: string | undefined; + DnsResolvers?: string[] | undefined; /** - *

The namespace that includes the role.

+ *

The IAM role to associate with the VPC connection.

* @public */ - Namespace: string | undefined; + 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 interface DeleteRoleCustomPermissionResponse { - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; +export const VPCConnectionAvailabilityStatus = { + AVAILABLE: "AVAILABLE", + PARTIALLY_AVAILABLE: "PARTIALLY_AVAILABLE", + UNAVAILABLE: "UNAVAILABLE", +} as const; - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; -} +/** + * @public + */ +export type VPCConnectionAvailabilityStatus = + (typeof VPCConnectionAvailabilityStatus)[keyof typeof VPCConnectionAvailabilityStatus]; /** * @public + * @enum */ -export interface DeleteRoleMembershipRequest { +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 name of the group.

+ *

The Amazon Resource Name (ARN) of the VPC connection.

* @public */ - MemberName: string | undefined; + Arn?: string | undefined; /** - *

The role that you want to remove permissions from.

+ *

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 */ - Role: Role | undefined; + VPCConnectionId?: 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 status of the creation of the VPC connection.

* @public */ - AwsAccountId: string | undefined; + CreationStatus?: VPCConnectionResourceStatus | undefined; /** - *

The namespace that contains the role.

+ *

The availability status of the VPC connection.

* @public */ - Namespace: string | undefined; -} + AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; -/** - * @public - */ -export interface DeleteRoleMembershipResponse { /** *

The Amazon Web Services request ID for this operation.

* @public @@ -6292,150 +6252,153 @@ export interface DeleteRoleMembershipResponse { } /** + *

The custom permissions profile.

* @public */ -export interface DeleteTemplateRequest { +export interface CustomPermissions { /** - *

The ID of the Amazon Web Services account that contains the template that you're deleting.

+ *

The Amazon Resource Name (ARN) of the custom permissions profile.

* @public */ - AwsAccountId: string | undefined; + Arn?: string | undefined; /** - *

An ID for the template you want to delete.

+ *

The name of the custom permissions profile.

* @public */ - TemplateId: string | undefined; + CustomPermissionsName?: string | 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. - *

+ *

A set of actions in the custom permissions profile.

* @public */ - VersionNumber?: number | undefined; + Capabilities?: Capabilities | undefined; } /** * @public + * @enum */ -export interface DeleteTemplateResponse { - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; +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 Resource Name (ARN) of the resource.

+ *

Type.

* @public */ - Arn?: string | undefined; + Type?: DashboardErrorType | undefined; /** - *

An ID for the template.

+ *

Message.

* @public */ - TemplateId?: string | undefined; + Message?: string | undefined; /** - *

The HTTP status of the request.

+ *

Lists the violated entities that caused the dashboard error.

* @public */ - Status?: number | undefined; + ViolatedEntities?: Entity[] | undefined; } /** + *

Dashboard version.

* @public */ -export interface DeleteTemplateAliasRequest { +export interface DashboardVersion { /** - *

The ID of the Amazon Web Services account that contains the item to delete.

+ *

The time that this dashboard version was created.

* @public */ - AwsAccountId: string | undefined; + CreatedTime?: Date | undefined; /** - *

The ID for the template that the specified alias is for.

+ *

Errors associated with this dashboard version.

* @public */ - TemplateId: string | undefined; + Errors?: DashboardError[] | 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.

+ *

Version number for this version of the dashboard.

* @public */ - AliasName: string | undefined; -} + VersionNumber?: number | undefined; -/** - * @public - */ -export interface DeleteTemplateAliasResponse { /** *

The HTTP status of the request.

* @public */ - Status?: number | undefined; - - /** - *

An ID for the template associated with the deletion.

- * @public - */ - TemplateId?: string | undefined; + Status?: ResourceStatus | undefined; /** - *

The name for the template alias.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ - AliasName?: string | undefined; + Arn?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the template you want to delete.

+ *

Source entity ARN.

* @public */ - Arn?: 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; -/** - * @public - */ -export interface DeleteThemeRequest { /** - *

The ID of the Amazon Web Services account that contains the theme that you're deleting.

+ *

Description.

* @public */ - AwsAccountId: string | undefined; + Description?: string | undefined; /** - *

An ID for the theme that you want to delete.

+ *

The ARN of the theme associated with a version of the dashboard.

* @public */ - ThemeId: string | undefined; + ThemeArn?: string | 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.

+ *

A list of the associated sheets with the unique identifier and name of each sheet.

* @public */ - VersionNumber?: number | undefined; + Sheets?: Sheet[] | undefined; } /** + *

Dashboard.

* @public */ -export interface DeleteThemeResponse { +export interface Dashboard { + /** + *

Dashboard ID.

+ * @public + */ + DashboardId?: string | undefined; + /** *

The Amazon Resource Name (ARN) of the resource.

* @public @@ -6443,851 +6406,838 @@ export interface DeleteThemeResponse { Arn?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

A display name for the dashboard.

* @public */ - RequestId?: string | undefined; + Name?: string | undefined; /** - *

The HTTP status of the request.

+ *

Version.

* @public */ - Status?: number | undefined; + Version?: DashboardVersion | undefined; /** - *

An ID for the theme.

+ *

The time that this dashboard was created.

* @public */ - ThemeId?: string | undefined; -} + CreatedTime?: Date | undefined; -/** - * @public - */ -export interface DeleteThemeAliasRequest { /** - *

The ID of the Amazon Web Services account that contains the theme alias to delete.

+ *

The last time that this dashboard was published.

* @public */ - AwsAccountId: string | undefined; + LastPublishedTime?: Date | undefined; /** - *

The ID for the theme that the specified alias is for.

+ *

The last time that this dashboard was updated.

* @public */ - ThemeId: string | undefined; + LastUpdatedTime?: Date | undefined; /** - *

The unique name for the theme alias to delete.

+ *

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

* @public */ - AliasName: string | undefined; + LinkEntities?: string[] | undefined; } /** * @public + * @enum */ -export interface DeleteThemeAliasResponse { - /** - *

The name for the theme alias.

- * @public - */ - AliasName?: string | undefined; - - /** - *

The Amazon Resource Name (ARN) of the theme resource using the deleted alias.

- * @public - */ - Arn?: string | undefined; - - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | 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 HTTP status of the request.

- * @public - */ - Status?: number | undefined; +/** + * @public + */ +export type DashboardFilterAttribute = (typeof DashboardFilterAttribute)[keyof typeof DashboardFilterAttribute]; +/** + *

A filter that you apply when searching for dashboards.

+ * @public + */ +export interface DashboardSearchFilter { /** - *

An ID for the theme associated with the deletion.

+ *

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 */ - ThemeId?: string | undefined; -} + Operator: FilterOperator | undefined; -/** - * @public - */ -export interface DeleteTopicRequest { /** - *

The ID of the Amazon Web Services account that contains the topic that you want to - * delete.

+ *

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 ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

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 */ - TopicId: string | undefined; + Value?: string | undefined; } /** * @public + * @enum */ -export interface DeleteTopicResponse { +export const DashboardsQAStatus = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", +} as const; + +/** + * @public + */ +export type DashboardsQAStatus = (typeof DashboardsQAStatus)[keyof typeof DashboardsQAStatus]; + +/** + *

Dashboard summary.

+ * @public + */ +export interface DashboardSummary { /** - *

The Amazon Resource Name (ARN) of the topic.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ Arn?: string | 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.

+ *

Dashboard ID.

* @public */ - TopicId?: string | undefined; + DashboardId?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

A display name for the dashboard.

* @public */ - RequestId?: string | undefined; + Name?: string | undefined; /** - *

The HTTP status of the request.

+ *

The time that this dashboard was created.

* @public */ - Status?: number | undefined; -} + CreatedTime?: Date | undefined; -/** - * @public - */ -export interface DeleteTopicRefreshScheduleRequest { /** - *

The Amazon Web Services account ID.

+ *

The last time that this dashboard was updated.

* @public */ - AwsAccountId: string | undefined; + LastUpdatedTime?: Date | 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.

+ *

Published version number.

* @public */ - TopicId: string | undefined; + PublishedVersionNumber?: number | undefined; /** - *

The ID of the dataset.

+ *

The last time that this dashboard was published.

* @public */ - DatasetId: string | undefined; + LastPublishedTime?: Date | undefined; } /** + *

Dashboard version summary.

* @public */ -export interface DeleteTopicRefreshScheduleResponse { +export interface DashboardVersionSummary { /** - *

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 Amazon Resource Name (ARN) of the resource.

* @public */ - TopicId?: string | undefined; + Arn?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the topic.

+ *

The time that this dashboard version was created.

* @public */ - TopicArn?: string | undefined; + CreatedTime?: Date | undefined; /** - *

The Amazon Resource Name (ARN) of the dataset.

+ *

Version number.

* @public */ - DatasetArn?: string | undefined; + VersionNumber?: number | undefined; /** *

The HTTP status of the request.

* @public */ - Status?: number | undefined; + Status?: ResourceStatus | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

Source entity ARN.

* @public */ - RequestId?: string | undefined; -} + SourceEntityArn?: string | undefined; -/** - * @public - */ -export interface DeleteUserRequest { /** - *

The name of the user that you want to delete.

+ *

Description.

* @public */ - UserName: string | undefined; + Description?: string | undefined; +} +/** + *

Output column.

+ * @public + */ +export interface OutputColumn { /** - *

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 display name of the column..

* @public */ - AwsAccountId: string | undefined; + Name?: string | undefined; /** - *

The namespace. Currently, you should set this to default.

+ *

A description for a column.

* @public */ - Namespace: string | undefined; -} + Description?: string | undefined; -/** - * @public - */ -export interface DeleteUserResponse { /** - *

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 DeleteUserByPrincipalIdRequest { - /** - *

The principal ID of the user.

- * @public - */ - PrincipalId: string | undefined; - +export interface DataSet { /** - *

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 Resource Name (ARN) of the resource.

* @public */ - AwsAccountId: string | undefined; + Arn?: string | undefined; /** - *

The namespace. Currently, you should set this to default.

+ *

The ID of the dataset.

* @public */ - Namespace: string | undefined; -} + DataSetId?: string | undefined; -/** - * @public - */ -export interface DeleteUserByPrincipalIdResponse { /** - *

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 DeleteUserCustomPermissionRequest { /** - *

The username of the user that you want to remove custom permissions from.

+ *

The last time that this dataset was updated.

* @public */ - UserName: string | undefined; + LastUpdatedTime?: Date | undefined; /** - *

The ID of the Amazon Web Services account that contains the custom permission configuration that you want to delete.

+ *

Declares the physical tables that are available in the underlying data sources.

* @public */ - AwsAccountId: string | undefined; + PhysicalTableMap?: Record | undefined; /** - *

The namespace that the user belongs to.

+ *

Configures the combination and transformation of the data from the physical + * tables.

* @public */ - Namespace: string | undefined; -} + LogicalTableMap?: Record | undefined; -/** - * @public - */ -export interface DeleteUserCustomPermissionResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

The list of columns after all transforms. These columns are available in templates, + * analyses, and dashboards.

* @public */ - RequestId?: string | undefined; + OutputColumns?: OutputColumn[] | undefined; /** - *

The HTTP status of the request.

+ *

A value that indicates whether you want to import the data into SPICE.

* @public */ - Status?: number | undefined; -} + ImportMode?: DataSetImportMode | undefined; -/** - * @public - */ -export interface DeleteVPCConnectionRequest { /** - *

The Amazon Web Services account ID of the account where you want to delete a VPC - * connection.

+ *

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't + * imported into SPICE.

* @public */ - AwsAccountId: string | undefined; + ConsumedSpiceCapacityInBytes?: 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.

+ *

Groupings of columns that work together in certain Amazon QuickSight features. + * Currently, only geospatial hierarchy is supported.

* @public */ - VPCConnectionId: string | undefined; -} + ColumnGroups?: ColumnGroup[] | undefined; -/** - * @public - */ -export interface DeleteVPCConnectionResponse { /** - *

The Amazon Resource Name (ARN) of the deleted VPC connection.

+ *

The folder that contains fields and nested subfolders for your dataset.

* @public */ - Arn?: string | undefined; + FieldFolders?: Record | 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 row-level security configuration for the dataset.

* @public */ - VPCConnectionId?: string | undefined; + RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; /** - *

The deletion status of the VPC connection.

+ *

The element you can use to define tags for row-level security.

* @public */ - DeletionStatus?: VPCConnectionResourceStatus | undefined; + RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration | undefined; /** - *

The availability status of the VPC connection.

+ *

A set of one or more definitions of a + * ColumnLevelPermissionRule + * .

* @public */ - AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; + ColumnLevelPermissionRules?: ColumnLevelPermissionRule[] | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The usage configuration to apply to child datasets that reference this dataset as a source.

* @public */ - RequestId?: string | undefined; + DataSetUsageConfiguration?: DataSetUsageConfiguration | undefined; /** - *

The HTTP status of the request.

+ *

The parameters that are declared in a dataset.

* @public */ - Status?: number | undefined; + DatasetParameters?: DatasetParameter[] | 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; + +/** + * @public + */ +export type DataSetFilterAttribute = (typeof DataSetFilterAttribute)[keyof typeof DataSetFilterAttribute]; + +/** + * @public + * @enum + */ +export const LookbackWindowSizeUnit = { + DAY: "DAY", + HOUR: "HOUR", + WEEK: "WEEK", +} as const; + +/** + * @public + */ +export type LookbackWindowSizeUnit = (typeof LookbackWindowSizeUnit)[keyof typeof LookbackWindowSizeUnit]; + +/** + *

The lookback window setup of an incremental refresh configuration.

* @public */ -export interface DescribeAccountCustomizationRequest { +export interface LookbackWindow { /** - *

The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations - * for.

+ *

The name of the lookback window column.

* @public */ - AwsAccountId: string | undefined; + ColumnName: string | undefined; /** - *

The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations - * for.

+ *

The lookback window column size.

* @public */ - Namespace?: string | undefined; + Size: number | 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.

+ *

The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.

* @public */ - Resolved?: boolean | undefined; + SizeUnit: LookbackWindowSizeUnit | undefined; } /** + *

The incremental refresh configuration for a dataset.

* @public */ -export interface DescribeAccountCustomizationResponse { - /** - *

The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.

- * @public - */ - Arn?: string | undefined; - - /** - *

The ID for the Amazon Web Services account that you're describing.

- * @public - */ - AwsAccountId?: string | undefined; - - /** - *

The Amazon QuickSight namespace that you're describing.

- * @public - */ - 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.

- * @public - */ - RequestId?: string | undefined; - +export interface IncrementalRefresh { /** - *

The HTTP status of the request.

+ *

The lookback window setup for an incremental refresh configuration.

* @public */ - Status?: number | undefined; + LookbackWindow: LookbackWindow | undefined; } /** + *

The refresh configuration of a dataset.

* @public */ -export interface DescribeAccountSettingsRequest { +export interface RefreshConfiguration { /** - *

The ID for the Amazon Web Services account that contains the settings that you want to list.

+ *

The incremental refresh for the dataset.

* @public */ - AwsAccountId: string | undefined; + IncrementalRefresh: IncrementalRefresh | undefined; } /** + *

The refresh properties of a dataset.

* @public */ -export interface DescribeAccountSettingsResponse { - /** - *

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 - */ - AccountSettings?: AccountSettings | undefined; - - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; - +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 DescribeAccountSubscriptionRequest { +export interface DataSetSearchFilter { /** - *

The Amazon Web Services account ID associated with your Amazon QuickSight account.

+ *

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; -/** - * @public - */ -export interface DescribeAccountSubscriptionResponse { /** - *

A structure that contains the following elements:

+ *

The name of the value that you want to use as a filter, for example, "Name": + * "QUICKSIGHT_OWNER".

+ *

Valid values are defined as follows:

*
    *
  • - *

    Your Amazon QuickSight account name.

    + *

    + * 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.

    *
  • *
  • - *

    The edition of Amazon QuickSight that your account is using.

    + *

    + * 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.

    *
  • *
  • - *

    The notification email address that is associated with the Amazon QuickSight - * account. - *

    + *

    + * 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.

    *
  • *
  • - *

    The authentication type of the Amazon QuickSight account.

    + *

    + * 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.

    *
  • *
  • - *

    The status of the Amazon QuickSight account's subscription.

    + *

    + * 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 */ - AccountInfo?: AccountInfo | undefined; - - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; + Name: DataSetFilterAttribute | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

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 */ - RequestId?: string | undefined; + Value: string | undefined; } /** + *

Dataset summary.

* @public */ -export interface DescribeAnalysisRequest { - /** - *

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; - +export interface DataSetSummary { /** - *

The ID of the analysis that you're describing. The ID is part of the URL of the - * analysis.

+ *

The Amazon Resource Name (ARN) of the dataset.

* @public */ - AnalysisId: string | undefined; -} + Arn?: string | undefined; -/** - * @public - */ -export interface DescribeAnalysisResponse { /** - *

A metadata structure that contains summary information for the analysis that you're - * describing.

+ *

The ID of the dataset.

* @public */ - Analysis?: Analysis | undefined; + DataSetId?: string | undefined; /** - *

The HTTP status of the request.

+ *

A display name for the dataset.

* @public */ - Status?: number | undefined; + Name?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The time that this dataset was created.

* @public */ - RequestId?: string | undefined; -} + CreatedTime?: Date | undefined; -/** - * @public - */ -export interface DescribeAnalysisDefinitionRequest { /** - *

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 last time that this dataset was updated.

* @public */ - AwsAccountId: string | undefined; + LastUpdatedTime?: Date | undefined; /** - *

The ID of the analysis that you're describing. The ID is part of the URL of the - * analysis.

+ *

A value that indicates whether you want to import the data into SPICE.

* @public */ - AnalysisId: string | undefined; -} + ImportMode?: DataSetImportMode | undefined; -/** - * @public - */ -export interface DescribeAnalysisDefinitionResponse { /** - *

The ID of the analysis described.

+ *

The row-level security configuration for the dataset.

* @public */ - AnalysisId?: string | undefined; + RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; /** - *

The descriptive name of the analysis.

+ *

Whether or not the row level permission tags are applied.

* @public */ - Name?: string | undefined; + RowLevelPermissionTagConfigurationApplied?: boolean | undefined; /** - *

Errors associated with the analysis.

+ *

A value that indicates if the dataset has column level permission configured.

* @public */ - Errors?: AnalysisError[] | undefined; + ColumnLevelPermissionRulesApplied?: boolean | undefined; +} - /** - *

Status associated with the analysis.

- *
    - *
  • - *

    - * CREATION_IN_PROGRESS - *

    - *
  • - *
  • - *

    - * CREATION_SUCCESSFUL - *

    - *
  • - *
  • - *

    - * CREATION_FAILED - *

    - *
  • - *
  • - *

    - * UPDATE_IN_PROGRESS - *

    - *
  • - *
  • - *

    - * UPDATE_SUCCESSFUL - *

    - *
  • - *
  • - *

    - * UPDATE_FAILED - *

    - *
  • - *
  • - *

    - * DELETED - *

    - *
  • - *
+/** + * @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", +} as const; + +/** + * @public + */ +export type DataSourceErrorInfoType = (typeof DataSourceErrorInfoType)[keyof typeof DataSourceErrorInfoType]; + +/** + *

Error information for the data source creation or update.

+ * @public + */ +export interface DataSourceErrorInfo { + /** + *

Error type.

* @public */ - ResourceStatus?: ResourceStatus | undefined; + Type?: DataSourceErrorInfoType | undefined; /** - *

The ARN of the theme of the analysis.

+ *

Error message.

* @public */ - ThemeArn?: string | undefined; + Message?: string | undefined; +} +/** + *

The structure of a data source.

+ * @public + */ +export interface DataSource { /** - *

The definition of an analysis.

- *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

+ *

The Amazon Resource Name (ARN) of the data source.

* @public */ - Definition?: AnalysisDefinition | 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.

+ *

A display name for the data source.

* @public */ - RequestId?: string | undefined; -} + Name?: string | undefined; -/** - * @public - */ -export interface DescribeAnalysisPermissionsRequest { /** - *

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 type of the data source. This type indicates which database engine the data source + * connects to.

* @public */ - AwsAccountId: string | undefined; + Type?: DataSourceType | undefined; /** - *

The ID of the analysis whose permissions you're describing. The ID is part of the - * analysis URL.

+ *

The HTTP status of the request.

* @public */ - AnalysisId: string | undefined; -} + Status?: ResourceStatus | undefined; -/** - * @public - */ -export interface DescribeAnalysisPermissionsResponse { /** - *

The ID of the analysis whose permissions you're describing.

+ *

The time that this data source was created.

* @public */ - AnalysisId?: string | undefined; + CreatedTime?: Date | undefined; /** - *

The Amazon Resource Name (ARN) of the analysis whose permissions you're - * describing.

+ *

The last time that this data source was updated.

* @public */ - AnalysisArn?: string | undefined; + LastUpdatedTime?: Date | undefined; /** - *

A structure that describes the principals and the resource-level permissions on an - * analysis.

+ *

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 */ - Permissions?: ResourcePermission[] | undefined; + DataSourceParameters?: DataSourceParameters | undefined; /** - *

The HTTP status of the request.

+ *

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 */ - Status?: number | undefined; + AlternateDataSourceParameters?: DataSourceParameters[] | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

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 */ - RequestId?: string | undefined; -} + VpcConnectionProperties?: VpcConnectionProperties | undefined; -/** - * @public - */ -export interface DescribeAssetBundleExportJobRequest { /** - *

The ID of the Amazon Web Services account the export job is executed in.

+ *

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your + * underlying source.

* @public */ - AwsAccountId: string | undefined; + SslProperties?: SslProperties | 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.

+ *

Error information from the last update or the creation of the data source.

* @public */ - AssetBundleExportJobId: string | undefined; + ErrorInfo?: DataSourceErrorInfo | undefined; + + /** + *

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

+ * @public + */ + SecretArn?: string | undefined; } /** * @public * @enum */ -export const IncludeFolderMembers = { - NONE: "NONE", - ONE_LEVEL: "ONE_LEVEL", - RECURSE: "RECURSE", +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 type IncludeFolderMembers = (typeof IncludeFolderMembers)[keyof typeof IncludeFolderMembers]; +export type DataSourceFilterAttribute = (typeof DataSourceFilterAttribute)[keyof typeof DataSourceFilterAttribute]; /** + *

A filter that you apply when searching for data sources.

* @public */ -export interface DescribeAssetBundleExportJobResponse { +export interface DataSourceSearchFilter { /** - *

Indicates the status of a job through its queuing and execution.

- *

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

+ *

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 */ - JobStatus?: AssetBundleExportJobStatus | undefined; + Operator: FilterOperator | undefined; /** - *

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 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 */ - DownloadUrl?: string | undefined; + Name: DataSourceFilterAttribute | 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 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 */ - Errors?: AssetBundleExportJobError[] | undefined; + Value: string | undefined; +} +/** + *

A DataSourceSummary object that returns a summary of a data source.

+ * @public + */ +export interface DataSourceSummary { /** - *

The Amazon Resource Name (ARN) for the export job.

+ *

The arn of the datasource.

* @public */ Arn?: string | undefined; /** - *

The time that the export job was created.

+ *

The unique ID of the data source.

* @public */ - CreatedTime?: Date | undefined; + DataSourceId?: string | undefined; /** - *

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

+ *

The name of the data source.

* @public */ - AssetBundleExportJobId?: string | undefined; + Name?: string | undefined; /** - *

The ID of the Amazon Web Services account that the export job was executed in.

+ *

The type of the data source.

* @public */ - AwsAccountId?: string | undefined; + Type?: DataSourceType | undefined; /** - *

A list of resource ARNs that exported with the job.

+ *

The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.

* @public */ - ResourceArns?: string[] | undefined; + CreatedTime?: Date | undefined; /** - *

The include dependencies flag.

+ *

The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.

* @public */ - IncludeAllDependencies?: boolean | undefined; + LastUpdatedTime?: Date | undefined; +} +/** + * @public + */ +export interface DeleteAccountCustomizationRequest { /** - *

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 ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in + * this Amazon Web Services Region.

* @public */ - ExportFormat?: AssetBundleExportFormat | undefined; + AwsAccountId: string | undefined; /** - *

The CloudFormation override property configuration for the export job.

+ *

The Amazon QuickSight namespace that you're deleting the customizations from.

* @public */ - CloudFormationOverridePropertyConfiguration?: AssetBundleCloudFormationOverridePropertyConfiguration | undefined; + Namespace?: string | undefined; +} +/** + * @public + */ +export interface DeleteAccountCustomizationResponse { /** *

The Amazon Web Services request ID for this operation.

* @public @@ -7295,287 +7245,285 @@ 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 DeleteAccountSubscriptionRequest { /** - *

The include permissions flag.

- * @public - */ - IncludePermissions?: boolean | undefined; - - /** - *

The include tags flag.

- * @public - */ - IncludeTags?: boolean | undefined; - - /** - *

The validation strategy that is used to export the analysis or dashboard.

- * @public - */ - ValidationStrategy?: AssetBundleExportJobValidationStrategy | 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 Amazon Web Services account ID of the account that you want to delete.

* @public */ - Warnings?: AssetBundleExportJobWarning[] | undefined; + AwsAccountId: string | undefined; +} +/** + * @public + */ +export interface DeleteAccountSubscriptionResponse { /** - *

The include folder memberships flag.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - IncludeFolderMemberships?: boolean | undefined; + RequestId?: string | undefined; /** - *

A setting that determines whether folder members are included.

+ *

The HTTP status of the request.

* @public */ - IncludeFolderMembers?: IncludeFolderMembers | undefined; + Status?: number | undefined; } /** * @public */ -export interface DescribeAssetBundleImportJobRequest { +export interface DeleteAnalysisRequest { /** - *

The ID of the Amazon Web Services account the import job was executed in.

+ *

The ID of the Amazon Web Services account where you want to delete an analysis.

* @public */ AwsAccountId: 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 analysis that you're deleting.

* @public */ - AssetBundleImportJobId: string | undefined; -} + AnalysisId: string | undefined; -/** - * @public - */ -export interface DescribeAssetBundleImportJobResponse { /** - *

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 - *

    - *
  • - *
+ *

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 */ - JobStatus?: AssetBundleImportJobStatus | undefined; + ForceDeleteWithoutRecovery?: boolean | undefined; +} +/** + * @public + */ +export interface DeleteAnalysisResponse { /** - *

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 HTTP status of the request.

* @public */ - Errors?: AssetBundleImportJobError[] | undefined; + Status?: number | 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 Amazon Resource Name (ARN) of the deleted analysis.

* @public */ - RollbackErrors?: AssetBundleImportJobError[] | undefined; + Arn?: string | undefined; /** - *

The Amazon Resource Name (ARN) for the import job.

+ *

The ID of the deleted analysis.

* @public */ - Arn?: string | undefined; + AnalysisId?: string | undefined; /** - *

The time that the import job was created.

+ *

The date and time that the analysis is scheduled to be deleted.

* @public */ - CreatedTime?: Date | undefined; + DeletionTime?: Date | undefined; /** - *

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AssetBundleImportJobId?: string | undefined; + RequestId?: string | undefined; +} +/** + * @public + */ +export interface DeleteBrandRequest { /** - *

The ID of the Amazon Web Services account the import job was executed in.

+ *

The ID of the Amazon Web Services account that owns the brand.

* @public */ - AwsAccountId?: string | undefined; + AwsAccountId: string | undefined; /** - *

The source of the asset bundle zip file that contains the data that is imported by the job.

+ *

The ID of the Amazon QuickSight brand.

* @public */ - AssetBundleImportSource?: AssetBundleImportSourceDescription | undefined; + BrandId: string | undefined; +} +/** + * @public + */ +export interface DeleteBrandResponse { /** - *

Optional overrides that are applied to the resource configuration before import.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - OverrideParameters?: AssetBundleImportJobOverrideParameters | undefined; + RequestId?: string | undefined; +} +/** + * @public + */ +export interface DeleteBrandAssignmentRequest { /** - *

The failure action for the import job.

+ *

The ID of the Amazon Web Services account that owns the brand assignment.

* @public */ - FailureAction?: AssetBundleImportFailureAction | undefined; + AwsAccountId: string | undefined; +} +/** + * @public + */ +export interface DeleteBrandAssignmentResponse { /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; +} +/** + * @public + */ +export interface DeleteCustomPermissionsRequest { /** - *

The HTTP status of the response.

+ *

The ID of the Amazon Web Services account that contains the custom permissions profile that you want to delete.

* @public */ - Status?: number | undefined; + AwsAccountId: string | undefined; /** - *

Optional permission overrides that are applied to the resource configuration before import.

+ *

The name of the custom permissions profile that you want to delete.

* @public */ - OverridePermissions?: AssetBundleImportJobOverridePermissions | undefined; + CustomPermissionsName: string | undefined; +} +/** + * @public + */ +export interface DeleteCustomPermissionsResponse { /** - *

Optional tag overrides that are applied to the resource configuration before import.

+ *

The HTTP status of the request.

* @public */ - OverrideTags?: AssetBundleImportJobOverrideTags | undefined; + Status?: number | undefined; /** - *

An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.

+ *

The Amazon Resource Name (ARN) of the custom permissions profile.

* @public */ - OverrideValidationStrategy?: AssetBundleImportJobOverrideValidationStrategy | undefined; + Arn?: string | undefined; /** - *

An array of warning records that describe all permitted errors that are encountered during the import job.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Warnings?: AssetBundleImportJobWarning[] | undefined; + RequestId?: string | undefined; } /** * @public */ -export interface DescribeBrandRequest { +export interface DeleteDashboardRequest { /** - *

The ID of the Amazon Web Services account that owns the brand.

+ *

The ID of the Amazon Web Services account that contains the dashboard that you're + * deleting.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the Amazon QuickSight brand.

+ *

The ID for the dashboard.

* @public */ - BrandId: string | undefined; + DashboardId: string | undefined; /** - *

The ID of the specific version. The default value is the latest version.

+ *

The version number of the dashboard. If the version number property is provided, only + * the specified version of the dashboard is deleted.

* @public */ - VersionId?: string | undefined; + VersionNumber?: number | undefined; } /** * @public */ -export interface DescribeBrandResponse { +export interface DeleteDashboardResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

The HTTP status of the request.

* @public */ - RequestId?: string | undefined; + Status?: number | undefined; /** - *

The details of the brand.

+ *

The Secure Socket Layer (SSL) properties that apply for the resource.

* @public */ - BrandDetail?: BrandDetail | undefined; + Arn?: string | undefined; /** - *

The definition of the brand.

+ *

The ID of the dashboard.

* @public */ - BrandDefinition?: BrandDefinition | undefined; -} + DashboardId?: string | undefined; -/** - * @public - */ -export interface DescribeBrandAssignmentRequest { /** - *

The ID of the Amazon Web Services account that owns the brand assignment.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AwsAccountId: string | undefined; + RequestId?: string | undefined; } /** * @public */ -export interface DescribeBrandAssignmentResponse { +export interface DeleteDataSetRequest { /** - *

The Amazon Web Services request ID for this operation.

+ *

The Amazon Web Services account ID.

* @public */ - RequestId?: string | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Resource Name (ARN) of the brand.

+ *

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 */ - BrandArn?: string | undefined; + DataSetId: string | undefined; } /** * @public */ -export interface DescribeBrandPublishedVersionRequest { +export interface DeleteDataSetResponse { /** - *

The ID of the Amazon Web Services account that owns the brand.

+ *

The Amazon Resource Name (ARN) of the dataset.

* @public */ - AwsAccountId: string | undefined; + Arn?: string | undefined; /** - *

The ID of the Amazon QuickSight brand.

+ *

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 */ - BrandId: string | undefined; -} + DataSetId?: string | undefined; -/** - * @public - */ -export interface DescribeBrandPublishedVersionResponse { /** *

The Amazon Web Services request ID for this operation.

* @public @@ -7583,221 +7531,171 @@ export interface DescribeBrandPublishedVersionResponse { RequestId?: string | undefined; /** - *

The details of the brand.

- * @public - */ - BrandDetail?: BrandDetail | undefined; - - /** - *

The definition of the brand.

+ *

The HTTP status of the request.

* @public */ - BrandDefinition?: BrandDefinition | undefined; + Status?: number | undefined; } /** * @public */ -export interface DescribeCustomPermissionsRequest { +export interface DeleteDataSetRefreshPropertiesRequest { /** - *

The ID of the Amazon Web Services account that contains the custom permissions profile that you want described.

+ *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** - *

The name of the custom permissions profile to describe.

+ *

The ID of the dataset.

* @public */ - CustomPermissionsName: string | undefined; + DataSetId: string | undefined; } /** * @public */ -export interface DescribeCustomPermissionsResponse { +export interface DeleteDataSetRefreshPropertiesResponse { + /** + *

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 DeleteDataSourceRequest { /** - *

The custom permissions profile.

+ *

The Amazon Web Services account ID.

* @public */ - CustomPermissions?: CustomPermissions | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - RequestId?: string | undefined; + DataSourceId: string | undefined; } /** * @public */ -export interface DescribeDashboardRequest { +export interface DeleteDataSourceResponse { /** - *

The ID of the Amazon Web Services account that contains the dashboard that you're - * describing.

+ *

The Amazon Resource Name (ARN) of the data source that you deleted.

* @public */ - AwsAccountId: string | undefined; + Arn?: string | undefined; /** - *

The ID for the dashboard.

+ *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - DashboardId: string | undefined; + DataSourceId?: string | undefined; /** - *

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 { - /** - *

Information about the dashboard.

- * @public - */ - Dashboard?: Dashboard | undefined; - +export interface DeleteFolderRequest { /** - *

The HTTP status of this request.

+ *

The ID for the Amazon Web Services account that contains the folder.

* @public */ - Status?: number | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The ID of the folder.

* @public */ - RequestId?: string | undefined; + FolderId: string | undefined; } /** * @public */ -export interface DescribeDashboardDefinitionRequest { +export interface DeleteFolderResponse { /** - *

The ID of the Amazon Web Services account that contains the dashboard that you're - * describing.

+ *

The HTTP status of the request.

* @public */ - AwsAccountId: string | undefined; + Status?: number | undefined; /** - *

The ID for the dashboard.

+ *

The Amazon Resource Name of the deleted folder.

* @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.

+ *

The ID of the folder.

* @public */ - VersionNumber?: number | undefined; + FolderId?: string | undefined; /** - *

The alias name.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AliasName?: string | undefined; + RequestId?: string | undefined; } /** * @public */ -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; - +export interface DeleteFolderMembershipRequest { /** - *

Status associated with the dashboard version.

- *
    - *
  • - *

    - * CREATION_IN_PROGRESS - *

    - *
  • - *
  • - *

    - * CREATION_SUCCESSFUL - *

    - *
  • - *
  • - *

    - * CREATION_FAILED - *

    - *
  • - *
  • - *

    - * UPDATE_IN_PROGRESS - *

    - *
  • - *
  • - *

    - * UPDATE_SUCCESSFUL - *

    - *
  • - *
  • - *

    - * UPDATE_FAILED - *

    - *
  • - *
  • - *

    - * DELETED - *

    - *
  • - *
+ *

The ID for the Amazon Web Services account that contains the folder.

* @public */ - ResourceStatus?: ResourceStatus | undefined; + AwsAccountId: string | undefined; /** - *

The ARN of the theme of the dashboard.

+ *

The Folder ID.

* @public */ - ThemeArn?: string | undefined; + FolderId: string | undefined; /** - *

The definition of a dashboard.

- *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

+ *

The ID of the asset that you want to delete.

* @public */ - Definition?: DashboardVersionDefinition | undefined; + MemberId: string | undefined; + + /** + *

The member type of the asset that you want to delete from a folder.

+ * @public + */ + MemberType: MemberType | undefined; +} +/** + * @public + */ +export interface DeleteFolderMembershipResponse { /** *

The HTTP status of the request.

* @public @@ -7809,83 +7707,83 @@ export interface DescribeDashboardDefinitionResponse { * @public */ RequestId?: string | undefined; +} +/** + * @public + */ +export interface DeleteGroupRequest { /** - *

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 name of the group that you want to delete.

* @public */ - DashboardPublishOptions?: DashboardPublishOptions | undefined; + GroupName: 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.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The namespace of the group that you want to delete.

+ * @public + */ + Namespace: string | undefined; } /** * @public */ -export interface DescribeDashboardPermissionsRequest { +export interface DeleteGroupResponse { /** - *

The ID of the Amazon Web Services account that contains the dashboard that you're describing - * permissions for.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AwsAccountId: string | undefined; + RequestId?: string | undefined; /** - *

The ID for the dashboard, also added to the IAM policy.

+ *

The HTTP status of the request.

* @public */ - DashboardId: string | undefined; + Status?: number | undefined; } /** * @public */ -export interface DescribeDashboardPermissionsResponse { +export interface DeleteGroupMembershipRequest { /** - *

The ID for the dashboard.

+ *

The name of the user that you want to delete from the group membership.

* @public */ - DashboardId?: string | undefined; + MemberName: string | undefined; /** - *

The Amazon Resource Name (ARN) of the dashboard.

+ *

The name of the group that you want to delete the user from.

* @public */ - DashboardArn?: string | undefined; + GroupName: string | undefined; /** - *

A structure that contains the permissions for the dashboard.

+ *

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 */ - Permissions?: ResourcePermission[] | undefined; + AwsAccountId: string | undefined; /** - *

The HTTP status of the request.

+ *

The namespace of the group that you want to remove a user from.

* @public */ - Status?: number | undefined; + Namespace: string | undefined; +} +/** + * @public + */ +export interface DeleteGroupMembershipResponse { /** *

The Amazon Web Services request ID for this operation.

* @public @@ -7893,223 +7791,261 @@ export interface DescribeDashboardPermissionsResponse { 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.

+ *

The HTTP status of the request.

* @public */ - LinkSharingConfiguration?: LinkSharingConfiguration | undefined; + Status?: number | undefined; } /** * @public */ -export interface DescribeDashboardSnapshotJobRequest { +export interface DeleteIAMPolicyAssignmentRequest { /** - *

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

+ *

The Amazon Web Services account ID where you want to delete the IAM + * policy assignment.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the dashboard that you have started a snapshot job for.

+ *

The name of the assignment.

* @public */ - DashboardId: string | undefined; + AssignmentName: 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 that contains the assignment.

* @public */ - SnapshotJobId: string | undefined; + Namespace: string | undefined; } /** * @public - * @enum */ -export const SnapshotJobStatus = { - COMPLETED: "COMPLETED", - FAILED: "FAILED", - QUEUED: "QUEUED", - RUNNING: "RUNNING", -} as const; +export interface DeleteIAMPolicyAssignmentResponse { + /** + *

The name of the assignment.

+ * @public + */ + AssignmentName?: string | undefined; -/** - * @public - */ -export type SnapshotJobStatus = (typeof SnapshotJobStatus)[keyof typeof SnapshotJobStatus]; + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; +} /** - *

A structure that contains information on the Amazon S3 destinations of the generated snapshot.

* @public */ -export interface SnapshotDestinationConfiguration { +export interface DeleteIdentityPropagationConfigRequest { /** - *

- * A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 S3DestinationConfiguration. - *

+ *

The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.

* @public */ - S3Destinations?: SnapshotS3DestinationConfiguration[] | undefined; + Service: ServiceType | undefined; } /** - *

A structure that contains the information on the snapshot files.

* @public */ -export interface SnapshotFileGroup { +export interface DeleteIdentityPropagationConfigResponse { + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + /** - *

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 HTTP status of the request.

* @public */ - Files?: SnapshotFile[] | undefined; + Status?: number | undefined; } /** - *

Describes the configuration of the dashboard snapshot.

* @public */ -export interface SnapshotConfiguration { +export interface DeleteNamespaceRequest { /** - *

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 ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The namespace that you want to delete.

* @public */ - FileGroups: SnapshotFileGroup[] | undefined; + Namespace: string | undefined; +} +/** + * @public + */ +export interface DeleteNamespaceResponse { /** - *

A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - DestinationConfiguration?: SnapshotDestinationConfiguration | undefined; + RequestId?: string | undefined; /** - *

A list of Amazon QuickSight parameters and the list's override values.

+ *

The HTTP status of the request.

* @public */ - Parameters?: _Parameters | undefined; + Status?: number | undefined; } /** - *

Use this structure to redact sensitive information that you provide about an anonymous user from the snapshot.

* @public */ -export interface SnapshotAnonymousUserRedacted { +export interface DeleteRefreshScheduleRequest { + /** + *

The ID of the dataset.

+ * @public + */ + DataSetId: string | undefined; + + /** + *

The Amazon Web Services account ID.

+ * @public + */ + AwsAccountId: string | undefined; + /** - *

The tag keys for the RowLevelPermissionTags.

+ *

The ID of the refresh schedule.

* @public */ - RowLevelPermissionTagKeys?: string[] | undefined; + ScheduleId: 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 { +export interface DeleteRefreshScheduleResponse { /** - *

- * An array of records that describe anonymous users that the dashboard snapshot is generated for. Sensitive user information is excluded. - *

+ *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The ID of the refresh schedule.

* @public */ - AnonymousUsers?: SnapshotAnonymousUserRedacted[] | undefined; + ScheduleId?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) for the refresh schedule.

+ * @public + */ + Arn?: string | undefined; } /** * @public */ -export interface DescribeDashboardSnapshotJobResponse { +export interface DeleteRoleCustomPermissionRequest { /** - *

- * The ID of the Amazon Web Services account that the dashboard snapshot job is executed in. - *

+ *

The role that you want to remove permissions from.

* @public */ - AwsAccountId?: string | undefined; + Role: Role | undefined; /** - *

The ID of the dashboard that you have started a snapshot job for.

+ *

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 */ - 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 that includes the role.

* @public */ - SnapshotJobId?: string | undefined; + Namespace: string | undefined; +} +/** + * @public + */ +export interface DeleteRoleCustomPermissionResponse { /** - *

The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - UserConfiguration?: SnapshotUserConfigurationRedacted | undefined; + RequestId?: string | undefined; /** - *

The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

+ *

The HTTP status of the request.

* @public */ - SnapshotConfiguration?: SnapshotConfiguration | undefined; + Status?: number | undefined; +} +/** + * @public + */ +export interface DeleteRoleMembershipRequest { /** - *

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 name of the group.

* @public */ - Arn?: string | undefined; + MemberName: 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 role that you want to remove permissions from.

* @public */ - JobStatus?: SnapshotJobStatus | undefined; + Role: Role | undefined; /** - *

- * The time that the snapshot job was created. - *

+ *

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 */ - CreatedTime?: Date | undefined; + AwsAccountId: string | undefined; /** - *

- * The time that the snapshot job status was last updated. - *

+ *

The namespace that contains the role.

* @public */ - LastUpdatedTime?: Date | undefined; + Namespace: string | undefined; +} +/** + * @public + */ +export interface DeleteRoleMembershipResponse { /** - *

- * The Amazon Web Services request ID for this operation. - *

+ *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** - *

The HTTP status of the request

+ *

The HTTP status of the request.

* @public */ Status?: number | undefined; @@ -8118,135 +8054,153 @@ export interface DescribeDashboardSnapshotJobResponse { /** * @public */ -export interface DescribeDashboardSnapshotJobResultRequest { +export interface DeleteTemplateRequest { /** - *

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 template that you're deleting.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the dashboard that you have started a snapshot job for.

+ *

An ID for the template you want to delete.

* @public */ - DashboardId: string | undefined; + TemplateId: 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.

+ *

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 */ - SnapshotJobId: string | undefined; + VersionNumber?: number | undefined; } /** - *

An object that contains information on the error that caused the snapshot job to fail.

* @public */ -export interface SnapshotJobErrorInfo { +export interface DeleteTemplateResponse { /** - *

The error message.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - ErrorMessage?: string | undefined; + RequestId?: string | undefined; /** - *

The error type.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ - ErrorType?: string | undefined; -} + Arn?: string | undefined; + + /** + *

An ID for the template.

+ * @public + */ + TemplateId?: string | 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 { /** - *

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 HTTP status of the request.

* @public */ - AnonymousUsers?: AnonymousUserSnapshotJobResult[] | undefined; + Status?: number | undefined; } /** * @public */ -export interface DescribeDashboardSnapshotJobResultResponse { +export interface DeleteTemplateAliasRequest { /** - *

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 Amazon Web Services account that contains the item to delete.

* @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 ID for the template that the specified alias is for.

* @public */ - JobStatus?: SnapshotJobStatus | undefined; + TemplateId: string | undefined; /** - *

The time that a snapshot job was created.

+ *

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 */ - CreatedTime?: Date | undefined; + AliasName: string | undefined; +} +/** + * @public + */ +export interface DeleteTemplateAliasResponse { /** - *

The time that a snapshot job status was last updated.

+ *

The HTTP status of the request.

* @public */ - LastUpdatedTime?: Date | undefined; + Status?: number | 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.

+ *

An ID for the template associated with the deletion.

* @public */ - Result?: SnapshotJobResult | undefined; + TemplateId?: string | undefined; /** - *

Displays information for the error that caused a job to fail.

+ *

The name for the template alias.

* @public */ - ErrorInfo?: SnapshotJobErrorInfo | undefined; + AliasName?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The Amazon Resource Name (ARN) of the template you want to delete.

* @public */ - RequestId?: string | undefined; + Arn?: string | 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 DescribeDataSetRequest { +export interface DeleteThemeRequest { /** - *

The Amazon Web Services account ID.

+ *

The ID of the Amazon Web Services account that contains the theme that you're deleting.

* @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.

+ *

An ID for the theme that you want to delete.

* @public */ - DataSetId: string | undefined; + ThemeId: string | 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.

+ * @public + */ + VersionNumber?: number | undefined; } /** * @public */ -export interface DescribeDataSetResponse { +export interface DeleteThemeResponse { /** - *

Information on the dataset.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ - DataSet?: DataSet | undefined; + Arn?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -8259,81 +8213,53 @@ export interface DescribeDataSetResponse { * @public */ Status?: number | undefined; -} - -/** - * @public - */ -export interface DescribeDataSetPermissionsRequest { - /** - *

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.

+ *

An ID for the theme.

* @public */ - DataSetId: string | undefined; + ThemeId?: string | undefined; } /** * @public */ -export interface DescribeDataSetPermissionsResponse { - /** - *

The Amazon Resource Name (ARN) of the dataset.

- * @public - */ - DataSetArn?: 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; - +export interface DeleteThemeAliasRequest { /** - *

A list of resource permissions on the dataset.

+ *

The ID of the Amazon Web Services account that contains the theme alias to delete.

* @public */ - Permissions?: ResourcePermission[] | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The ID for the theme that the specified alias is for.

* @public */ - RequestId?: string | undefined; + ThemeId: string | undefined; /** - *

The HTTP status of the request.

+ *

The unique name for the theme alias to delete.

* @public */ - Status?: number | undefined; + AliasName: string | undefined; } /** * @public */ -export interface DescribeDataSetRefreshPropertiesRequest { +export interface DeleteThemeAliasResponse { /** - *

The Amazon Web Services account ID.

+ *

The name for the theme alias.

* @public */ - AwsAccountId: string | undefined; + AliasName?: string | undefined; /** - *

The ID of the dataset.

+ *

The Amazon Resource Name (ARN) of the theme resource using the deleted alias.

* @public */ - DataSetId: string | undefined; -} + Arn?: string | undefined; -/** - * @public - */ -export interface DescribeDataSetRefreshPropertiesResponse { /** *

The Amazon Web Services request ID for this operation.

* @public @@ -8347,38 +8273,45 @@ export interface DescribeDataSetRefreshPropertiesResponse { Status?: number | undefined; /** - *

The dataset refresh properties.

+ *

An ID for the theme associated with the deletion.

* @public */ - DataSetRefreshProperties?: DataSetRefreshProperties | undefined; + ThemeId?: string | undefined; } /** * @public */ -export interface DescribeDataSourceRequest { +export interface DeleteTopicRequest { /** - *

The Amazon Web Services account ID.

+ *

The ID of the Amazon Web Services account that contains the topic that you want to + * delete.

* @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 topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - DataSourceId: string | undefined; + TopicId: string | undefined; } /** * @public */ -export interface DescribeDataSourceResponse { +export interface DeleteTopicResponse { + /** + *

The Amazon Resource Name (ARN) of the topic.

+ * @public + */ + Arn?: string | undefined; + /** - *

The information on the data source.

+ *

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 */ - DataSource?: DataSource | undefined; + TopicId?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -8396,7 +8329,7 @@ export interface DescribeDataSourceResponse { /** * @public */ -export interface DescribeDataSourcePermissionsRequest { +export interface DeleteTopicRefreshScheduleRequest { /** *

The Amazon Web Services account ID.

* @public @@ -8404,307 +8337,294 @@ export interface DescribeDataSourcePermissionsRequest { 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 topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - DataSourceId: string | undefined; -} + TopicId: string | undefined; -/** - * @public - */ -export interface DescribeDataSourcePermissionsResponse { /** - *

The Amazon Resource Name (ARN) of the data source.

+ *

The ID of the dataset.

* @public */ - DataSourceArn?: string | undefined; + DatasetId: string | undefined; +} +/** + * @public + */ +export interface DeleteTopicRefreshScheduleResponse { /** - *

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 topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - DataSourceId?: string | undefined; + TopicId?: string | undefined; /** - *

A list of resource permissions on the data source.

+ *

The Amazon Resource Name (ARN) of the topic.

* @public */ - Permissions?: ResourcePermission[] | 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.

* @public */ Status?: number | undefined; -} - -/** - * @public - */ -export interface DescribeFolderRequest { - /** - *

The ID for the Amazon Web Services account that contains the folder.

- * @public - */ - AwsAccountId: string | undefined; /** - *

The ID of the folder.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - FolderId: string | undefined; + RequestId?: string | undefined; } /** - *

A folder in Amazon QuickSight.

* @public */ -export interface Folder { +export interface DeleteUserRequest { /** - *

The ID of the folder.

+ *

The name of the user that you want to delete.

* @public */ - FolderId?: string | undefined; + UserName: string | undefined; /** - *

The Amazon Resource Name (ARN) for the folder.

+ *

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; /** - *

A display name for the folder.

+ *

The namespace. Currently, you should set this to default.

* @public */ - Name?: string | undefined; + Namespace: string | undefined; +} +/** + * @public + */ +export interface DeleteUserResponse { /** - *

The type of folder it is.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - FolderType?: FolderType | undefined; + RequestId?: string | undefined; /** - *

An array of ancestor ARN strings for the folder.

+ *

The HTTP status of the request.

* @public */ - FolderPath?: string[] | undefined; + Status?: number | undefined; +} +/** + *

+ * @public + */ +export interface DeleteUserByPrincipalIdRequest { /** - *

The time that the folder was created.

+ *

The principal ID of the user.

* @public */ - CreatedTime?: Date | undefined; + PrincipalId: string | undefined; /** - *

The time that the folder was last updated.

+ *

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 */ - LastUpdatedTime?: Date | undefined; + AwsAccountId: string | undefined; /** - *

The sharing scope of the folder.

+ *

The namespace. Currently, you should set this to default.

* @public */ - SharingModel?: SharingModel | undefined; + Namespace: string | undefined; } /** * @public */ -export interface DescribeFolderResponse { - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; - +export interface DeleteUserByPrincipalIdResponse { /** - *

Information about the folder.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Folder?: Folder | 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 DescribeFolderPermissionsRequest { +export interface DeleteUserCustomPermissionRequest { /** - *

The ID for the Amazon Web Services account that contains the folder.

+ *

The username of the user that you want to remove custom permissions from.

* @public */ - AwsAccountId: string | undefined; + UserName: string | undefined; /** - *

The ID of the folder.

+ *

The ID of the Amazon Web Services account that contains the custom permission configuration that you want to delete.

* @public */ - FolderId: string | undefined; + AwsAccountId: string | undefined; /** - *

The namespace of the folder whose permissions you want described.

+ *

The namespace that the user belongs to.

* @public */ - Namespace?: string | undefined; + Namespace: string | undefined; +} +/** + * @public + */ +export interface DeleteUserCustomPermissionResponse { /** - *

The maximum number of results to be returned per request.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - MaxResults?: number | undefined; + RequestId?: string | undefined; /** - *

A pagination token for the next set of results.

+ *

The HTTP status of the request.

* @public */ - NextToken?: string | undefined; + Status?: number | undefined; } /** * @public */ -export interface DescribeFolderPermissionsResponse { +export interface DeleteVPCConnectionRequest { /** - *

The HTTP status of the request.

+ *

The Amazon Web Services account ID of the account where you want to delete a VPC + * connection.

* @public */ - Status?: number | undefined; + AwsAccountId: string | undefined; /** - *

The ID of the folder.

+ *

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 */ - FolderId?: string | undefined; + VPCConnectionId: string | undefined; +} +/** + * @public + */ +export interface DeleteVPCConnectionResponse { /** - *

The Amazon Resource Name (ARN) for the folder.

+ *

The Amazon Resource Name (ARN) of the deleted VPC connection.

* @public */ Arn?: string | undefined; /** - *

Information about the permissions on the folder.

+ *

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 */ - Permissions?: ResourcePermission[] | undefined; + VPCConnectionId?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The deletion status of the VPC connection.

* @public */ - RequestId?: string | undefined; + DeletionStatus?: VPCConnectionResourceStatus | undefined; /** - *

The pagination token for the next set of results, or null if there are no more results.

+ *

The availability status of the VPC connection.

* @public */ - NextToken?: string | undefined; -} + AvailabilityStatus?: VPCConnectionAvailabilityStatus | 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 Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; + /** - * @internal + *

The HTTP status of the request.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "InvalidNextTokenException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, InvalidNextTokenException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } + Status?: number | undefined; } /** * @public */ -export interface DescribeFolderResolvedPermissionsRequest { +export interface DescribeAccountCustomizationRequest { /** - *

The ID for the Amazon Web Services account that contains the folder.

+ *

The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations + * for.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the folder.

- * @public - */ - FolderId: string | undefined; - - /** - *

The namespace of the folder whose permissions you want described.

+ *

The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations + * for.

* @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.

+ *

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 */ - NextToken?: string | undefined; + Resolved?: boolean | undefined; } /** * @public */ -export interface DescribeFolderResolvedPermissionsResponse { +export interface DescribeAccountCustomizationResponse { /** - *

The HTTP status of the request.

+ *

The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.

* @public */ - Status?: number | undefined; + Arn?: string | undefined; /** - *

The ID of the folder.

+ *

The ID for the Amazon Web Services account that you're describing.

* @public */ - FolderId?: string | undefined; + AwsAccountId?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the folder.

+ *

The Amazon QuickSight namespace that you're describing.

* @public */ - Arn?: string | undefined; + Namespace?: string | undefined; /** - *

Information about the permissions for the folder.

+ *

The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.

* @public */ - Permissions?: ResourcePermission[] | undefined; + AccountCustomization?: AccountCustomization | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -8713,45 +8633,38 @@ export interface DescribeFolderResolvedPermissionsResponse { RequestId?: string | undefined; /** - *

A pagination token for the next set of results, or null if there are no more results.

+ *

The HTTP status of the request.

* @public */ - NextToken?: string | undefined; + Status?: number | undefined; } /** * @public */ -export interface DescribeGroupRequest { - /** - *

The name of the group that you want to describe.

- * @public - */ - GroupName: string | undefined; - +export interface DescribeAccountSettingsRequest { /** - *

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 for the Amazon Web Services account that contains the settings that you want to list.

* @public */ AwsAccountId: string | undefined; - - /** - *

The namespace of the group that you want described.

- * @public - */ - Namespace: string | undefined; } /** * @public */ -export interface DescribeGroupResponse { +export interface DescribeAccountSettingsResponse { /** - *

The name of the group.

+ *

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 */ - Group?: Group | undefined; + AccountSettings?: AccountSettings | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -8769,388 +8682,380 @@ export interface DescribeGroupResponse { /** * @public */ -export interface DescribeGroupMembershipRequest { +export interface DescribeAccountSubscriptionRequest { /** - *

The user name of the user that you want to search for.

+ *

The Amazon Web Services account ID associated with your Amazon QuickSight account.

* @public */ - MemberName: string | undefined; + AwsAccountId: string | undefined; +} +/** + * @public + */ +export interface DescribeAccountSubscriptionResponse { /** - *

The name of the group that you want to search.

+ *

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 */ - GroupName: string | undefined; + AccountInfo?: AccountInfo | 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 HTTP status of the request.

* @public */ - AwsAccountId: string | undefined; + Status?: number | undefined; /** - *

The namespace that includes the group you are searching within.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Namespace: string | undefined; + RequestId?: string | undefined; } /** * @public */ -export interface DescribeGroupMembershipResponse { +export interface DescribeAnalysisRequest { /** - *

A member of an Amazon QuickSight group. Currently, group members must be users. Groups - * can't be members of another group. .

+ *

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 */ - GroupMember?: GroupMember | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The ID of the analysis that you're describing. The ID is part of the URL of the + * analysis.

* @public */ - RequestId?: string | undefined; + AnalysisId: string | undefined; +} + +/** + * @public + */ +export interface DescribeAnalysisResponse { + /** + *

A metadata structure that contains summary information for the analysis that you're + * describing.

+ * @public + */ + Analysis?: Analysis | 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 DescribeIAMPolicyAssignmentRequest { +export interface DescribeAnalysisDefinitionRequest { /** - *

The ID of the Amazon Web Services account that contains the assignment that you want to - * describe.

+ *

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 name of the assignment, also called a rule.

- * @public - */ - AssignmentName: string | undefined; - - /** - *

The namespace that contains the assignment.

+ *

The ID of the analysis that you're describing. The ID is part of the URL of the + * analysis.

* @public */ - Namespace: string | undefined; + AnalysisId: string | undefined; } /** - *

An Identity and Access Management (IAM) policy assignment.

* @public */ -export interface IAMPolicyAssignment { +export interface DescribeAnalysisDefinitionResponse { /** - *

The Amazon Web Services account ID.

+ *

The ID of the analysis described.

* @public */ - AwsAccountId?: string | undefined; + AnalysisId?: string | undefined; + + /** + *

The descriptive name of the analysis.

+ * @public + */ + Name?: string | undefined; + + /** + *

Errors associated with the analysis.

+ * @public + */ + Errors?: AnalysisError[] | undefined; /** - *

Assignment ID.

+ *

Status associated with the analysis.

+ *
    + *
  • + *

    + * CREATION_IN_PROGRESS + *

    + *
  • + *
  • + *

    + * CREATION_SUCCESSFUL + *

    + *
  • + *
  • + *

    + * CREATION_FAILED + *

    + *
  • + *
  • + *

    + * UPDATE_IN_PROGRESS + *

    + *
  • + *
  • + *

    + * UPDATE_SUCCESSFUL + *

    + *
  • + *
  • + *

    + * UPDATE_FAILED + *

    + *
  • + *
  • + *

    + * DELETED + *

    + *
  • + *
* @public */ - AssignmentId?: string | undefined; + ResourceStatus?: ResourceStatus | undefined; /** - *

Assignment name.

+ *

The ARN of the theme of the analysis.

* @public */ - AssignmentName?: string | undefined; + ThemeArn?: string | undefined; /** - *

The Amazon Resource Name (ARN) for the IAM policy.

+ *

The definition of an analysis.

+ *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

* @public */ - PolicyArn?: string | undefined; + Definition?: AnalysisDefinition | undefined; /** - *

Identities.

+ *

The HTTP status of the request.

* @public */ - Identities?: Record | undefined; + Status?: number | undefined; /** - *

Assignment status.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AssignmentStatus?: AssignmentStatus | undefined; + RequestId?: string | undefined; } /** * @public */ -export interface DescribeIAMPolicyAssignmentResponse { - /** - *

Information describing the IAM policy assignment.

- * @public - */ - IAMPolicyAssignment?: IAMPolicyAssignment | undefined; - +export interface DescribeAnalysisPermissionsRequest { /** - *

The Amazon Web Services request ID for this operation.

+ *

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 */ - RequestId?: string | undefined; + AwsAccountId: string | undefined; /** - *

The HTTP status of the request.

+ *

The ID of the analysis whose permissions you're describing. The ID is part of the + * analysis URL.

* @public */ - Status?: number | undefined; + AnalysisId: string | undefined; } /** * @public */ -export interface DescribeIngestionRequest { +export interface DescribeAnalysisPermissionsResponse { /** - *

The Amazon Web Services account ID.

+ *

The ID of the analysis whose permissions you're describing.

* @public */ - AwsAccountId: string | undefined; + AnalysisId?: string | undefined; /** - *

The ID of the dataset used in the ingestion.

+ *

The Amazon Resource Name (ARN) of the analysis whose permissions you're + * describing.

* @public */ - DataSetId: string | undefined; + AnalysisArn?: string | undefined; /** - *

An ID for the ingestion.

+ *

A structure that describes the principals and the resource-level permissions on an + * analysis.

* @public */ - IngestionId: string | 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; - -/** - * @public - */ -export type IngestionErrorType = (typeof IngestionErrorType)[keyof typeof IngestionErrorType]; + Permissions?: ResourcePermission[] | undefined; -/** - *

Error information for the SPICE ingestion of a dataset.

- * @public - */ -export interface ErrorInfo { /** - *

Error type.

+ *

The HTTP status of the request.

* @public */ - Type?: IngestionErrorType | undefined; + Status?: number | undefined; /** - *

Error message.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Message?: string | undefined; + RequestId?: string | undefined; } /** - *

Information about a queued dataset SPICE ingestion.

* @public */ -export interface QueueInfo { +export interface DescribeAssetBundleExportJobRequest { /** - *

The ID of the queued ingestion.

+ *

The ID of the Amazon Web Services account the export job is executed in.

* @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 of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

* @public */ - QueuedIngestion: string | undefined; + AssetBundleExportJobId: string | undefined; } /** - * @public - * @enum + * @internal */ -export const IngestionRequestSource = { - MANUAL: "MANUAL", - SCHEDULED: "SCHEDULED", -} as const; +export const ColumnTagFilterSensitiveLog = (obj: ColumnTag): any => ({ + ...obj, + ...(obj.ColumnDescription && { ColumnDescription: ColumnDescriptionFilterSensitiveLog(obj.ColumnDescription) }), +}); /** - * @public + * @internal */ -export type IngestionRequestSource = (typeof IngestionRequestSource)[keyof typeof IngestionRequestSource]; +export const DateTimeParameterFilterSensitiveLog = (obj: DateTimeParameter): any => ({ + ...obj, + ...(obj.Values && { Values: SENSITIVE_STRING }), +}); /** - * @public - * @enum + * @internal */ -export const IngestionRequestType = { - EDIT: "EDIT", - FULL_REFRESH: "FULL_REFRESH", - INCREMENTAL_REFRESH: "INCREMENTAL_REFRESH", - INITIAL_INGESTION: "INITIAL_INGESTION", -} as const; +export const DecimalParameterFilterSensitiveLog = (obj: DecimalParameter): any => ({ + ...obj, + ...(obj.Values && { Values: SENSITIVE_STRING }), +}); /** - * @public + * @internal */ -export type IngestionRequestType = (typeof IngestionRequestType)[keyof typeof IngestionRequestType]; +export const IntegerParameterFilterSensitiveLog = (obj: IntegerParameter): any => ({ + ...obj, + ...(obj.Values && { Values: SENSITIVE_STRING }), +}); /** - *

Information about rows for a data set SPICE ingestion.

- * @public + * @internal */ -export interface RowInfo { - /** - *

The number of rows that were ingested.

- * @public - */ - RowsIngested?: number | undefined; - - /** - *

The number of rows that were not ingested.

- * @public - */ - RowsDropped?: number | undefined; - - /** - *

The total number of rows in the dataset.

- * @public - */ - TotalRowsInDataset?: number | undefined; -} +export const StringParameterFilterSensitiveLog = (obj: StringParameter): any => ({ + ...obj, + ...(obj.Values && { Values: SENSITIVE_STRING }), +}); /** - *

Information about the SPICE ingestion for a dataset.

- * @public + * @internal */ -export interface Ingestion { - /** - *

The Amazon Resource Name (ARN) of the resource.

- * @public - */ - Arn: string | undefined; - - /** - *

Ingestion ID.

- * @public - */ - IngestionId?: string | undefined; - - /** - *

Ingestion status.

- * @public - */ - IngestionStatus: IngestionStatus | undefined; - - /** - *

Error information for this ingestion.

- * @public - */ - ErrorInfo?: ErrorInfo | undefined; - - /** - *

Information about rows for a data set SPICE ingestion.

- * @public - */ - RowInfo?: RowInfo | undefined; - - /** - *

Information about a queued dataset SPICE ingestion.

- * @public - */ - QueueInfo?: QueueInfo | undefined; - - /** - *

The time that this ingestion started.

- * @public - */ - CreatedTime: Date | undefined; +export const _ParametersFilterSensitiveLog = (obj: _Parameters): any => ({ + ...obj, + ...(obj.StringParameters && { + StringParameters: obj.StringParameters.map((item) => StringParameterFilterSensitiveLog(item)), + }), + ...(obj.IntegerParameters && { + IntegerParameters: obj.IntegerParameters.map((item) => IntegerParameterFilterSensitiveLog(item)), + }), + ...(obj.DecimalParameters && { + DecimalParameters: obj.DecimalParameters.map((item) => DecimalParameterFilterSensitiveLog(item)), + }), + ...(obj.DateTimeParameters && { + DateTimeParameters: obj.DateTimeParameters.map((item) => DateTimeParameterFilterSensitiveLog(item)), + }), +}); - /** - *

The time that this ingestion took, measured in seconds.

- * @public - */ - IngestionTimeInSeconds?: number | undefined; +/** + * @internal + */ +export const CreateAnalysisRequestFilterSensitiveLog = (obj: CreateAnalysisRequest): any => ({ + ...obj, + ...(obj.Parameters && { Parameters: _ParametersFilterSensitiveLog(obj.Parameters) }), +}); - /** - *

The size of the data ingested, in bytes.

- * @public - */ - IngestionSizeInBytes?: number | undefined; +/** + * @internal + */ +export const CreateColumnsOperationFilterSensitiveLog = (obj: CreateColumnsOperation): any => ({ + ...obj, + ...(obj.Columns && { Columns: obj.Columns.map((item) => CalculatedColumnFilterSensitiveLog(item)) }), +}); - /** - *

Event source for this ingestion.

- * @public - */ - RequestSource?: IngestionRequestSource | undefined; +/** + * @internal + */ +export const DashboardVersionDefinitionFilterSensitiveLog = (obj: DashboardVersionDefinition): any => ({ + ...obj, + ...(obj.CalculatedFields && { + CalculatedFields: obj.CalculatedFields.map((item) => CalculatedFieldFilterSensitiveLog(item)), + }), + ...(obj.ParameterDeclarations && { + ParameterDeclarations: obj.ParameterDeclarations.map((item) => ParameterDeclarationFilterSensitiveLog(item)), + }), + ...(obj.ColumnConfigurations && { + ColumnConfigurations: obj.ColumnConfigurations.map((item) => ColumnConfigurationFilterSensitiveLog(item)), + }), +}); - /** - *

Type of this ingestion.

- * @public - */ - RequestType?: IngestionRequestType | undefined; -} +/** + * @internal + */ +export const CreateDashboardRequestFilterSensitiveLog = (obj: CreateDashboardRequest): any => ({ + ...obj, + ...(obj.Parameters && { Parameters: _ParametersFilterSensitiveLog(obj.Parameters) }), +}); /** * @internal @@ -9410,6 +9315,20 @@ export const CreateTopicRequestFilterSensitiveLog = (obj: CreateTopicRequest): a ...obj, }); +/** + * @internal + */ +export const DashboardVersionFilterSensitiveLog = (obj: DashboardVersion): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DashboardFilterSensitiveLog = (obj: Dashboard): any => ({ + ...obj, +}); + /** * @internal */ @@ -9446,78 +9365,13 @@ export const DataSetFilterSensitiveLog = (obj: DataSet): any => ({ /** * @internal */ -export const DescribeAnalysisDefinitionResponseFilterSensitiveLog = (obj: DescribeAnalysisDefinitionResponse): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const DescribeAssetBundleExportJobResponseFilterSensitiveLog = ( - obj: DescribeAssetBundleExportJobResponse -): any => ({ - ...obj, - ...(obj.DownloadUrl && { DownloadUrl: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const DescribeAssetBundleImportJobResponseFilterSensitiveLog = ( - obj: DescribeAssetBundleImportJobResponse -): any => ({ - ...obj, - ...(obj.AssetBundleImportSource && { - AssetBundleImportSource: AssetBundleImportSourceDescriptionFilterSensitiveLog(obj.AssetBundleImportSource), - }), -}); - -/** - * @internal - */ -export const DescribeDashboardDefinitionResponseFilterSensitiveLog = ( - obj: DescribeDashboardDefinitionResponse -): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const SnapshotConfigurationFilterSensitiveLog = (obj: SnapshotConfiguration): any => ({ - ...obj, - ...(obj.Parameters && { Parameters: _ParametersFilterSensitiveLog(obj.Parameters) }), -}); - -/** - * @internal - */ -export const DescribeDashboardSnapshotJobResponseFilterSensitiveLog = ( - obj: DescribeDashboardSnapshotJobResponse -): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const SnapshotJobResultFilterSensitiveLog = (obj: SnapshotJobResult): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const DescribeDashboardSnapshotJobResultResponseFilterSensitiveLog = ( - obj: DescribeDashboardSnapshotJobResultResponse -): any => ({ +export const DescribeAnalysisResponseFilterSensitiveLog = (obj: DescribeAnalysisResponse): any => ({ ...obj, }); /** * @internal */ -export const DescribeDataSetResponseFilterSensitiveLog = (obj: DescribeDataSetResponse): any => ({ +export const DescribeAnalysisDefinitionResponseFilterSensitiveLog = (obj: DescribeAnalysisDefinitionResponse): any => ({ ...obj, - ...(obj.DataSet && { DataSet: DataSetFilterSensitiveLog(obj.DataSet) }), }); diff --git a/clients/client-quicksight/src/models/models_4.ts b/clients/client-quicksight/src/models/models_4.ts index 6a0eb47e1eb0..d9f0ff25b459 100644 --- a/clients/client-quicksight/src/models/models_4.ts +++ b/clients/client-quicksight/src/models/models_4.ts @@ -4,24 +4,31 @@ import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from " import { AccountCustomization, ActiveIAMPolicyAssignment, Entity, ResourceStatus, Sheet } from "./models_0"; import { - _Parameters, - _ParametersFilterSensitiveLog, AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, + AnonymousUserSnapshotJobResult, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, + AssetBundleExportJobError, + AssetBundleExportJobStatus, AssetBundleExportJobSummary, AssetBundleExportJobValidationStrategy, + AssetBundleExportJobWarning, AssetBundleImportFailureAction, + AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, + AssetBundleImportJobStatus, AssetBundleImportJobSummary, + AssetBundleImportJobWarning, AssetBundleImportSource, + AssetBundleImportSourceDescription, + AssetBundleImportSourceDescriptionFilterSensitiveLog, AssetBundleImportSourceFilterSensitiveLog, AssignmentStatus, AuthorizedTargetsByService, @@ -32,40 +39,37 @@ import { Capabilities, ColumnGroup, ColumnLevelPermissionRule, - DashboardPublishOptions, - DashboardSourceEntity, - DashboardVersionDefinition, DashboardVisualId, - DatasetParameter, - DataSourceParameters, FilterOperator, - LinkSharingConfiguration, - ResourcePermission, - ServiceType, SharedViewConfigurations, - SslProperties, + SnapshotFile, + SnapshotS3DestinationConfiguration, Tag, - TopicIR, - TopicIRFilterSensitiveLog, - TopicTemplate, - ValidationStrategy, - VisualRole, - VpcConnectionProperties, } from "./models_2"; import { + _Parameters, + _ParametersFilterSensitiveLog, CustomPermissions, + Dashboard, + DashboardError, + DashboardPublishOptions, DashboardSearchFilter, + DashboardSourceEntity, + DashboardsQAStatus, DashboardSummary, + DashboardVersionDefinition, DashboardVersionSummary, + DataSet, DataSetConfiguration, + DataSetFilterSensitiveLog, DataSetImportMode, + DatasetParameter, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSetUsageConfiguration, DataSource, - DataSourceCredentials, DataSourceSearchFilter, DataSourceSummary, FieldFolder, @@ -73,27 +77,27 @@ import { Group, GroupMember, IdentityStore, - IncludeFolderMembers, - Ingestion, + IngestionStatus, + LinkSharingConfiguration, LogicalTable, LogicalTableFilterSensitiveLog, NamespaceStatus, PhysicalTable, RefreshSchedule, + ResourcePermission, Role, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, RowLevelPermissionTagConfigurationFilterSensitiveLog, SharingModel, - SnapshotConfiguration, TemplateAlias, - TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, TopicUserExperienceVersion, + ValidationStrategy, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus, } from "./models_3"; @@ -102,263 +106,249 @@ import { QuickSightServiceException as __BaseException } from "./QuickSightServi /** * @public + * @enum */ -export interface DescribeIngestionResponse { +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 { /** - *

Information about the ingestion.

+ *

Indicates the status of a job through its queuing and execution.

+ *

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

* @public */ - Ingestion?: Ingestion | undefined; + JobStatus?: AssetBundleExportJobStatus | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

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 */ - RequestId?: string | undefined; + DownloadUrl?: string | undefined; /** - *

The HTTP status of the request.

+ *

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 */ - Status?: number | undefined; -} + Errors?: AssetBundleExportJobError[] | undefined; -/** - * @public - */ -export interface DescribeIpRestrictionRequest { /** - *

The ID of the Amazon Web Services account that contains the IP rules.

+ *

The Amazon Resource Name (ARN) for the export job.

* @public */ - AwsAccountId: string | undefined; -} + Arn?: string | undefined; -/** - * @public - */ -export interface DescribeIpRestrictionResponse { /** - *

The ID of the Amazon Web Services account that contains the IP rules.

+ *

The time that the export job was created.

* @public */ - AwsAccountId?: string | undefined; + CreatedTime?: Date | undefined; /** - *

A map that describes the IP rules with CIDR range and description.

+ *

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

* @public */ - IpRestrictionRuleMap?: Record | undefined; + AssetBundleExportJobId?: string | undefined; /** - *

A map of allowed VPC IDs and their rule descriptions.

+ *

The ID of the Amazon Web Services account that the export job was executed in.

* @public */ - VpcIdRestrictionRuleMap?: Record | undefined; + AwsAccountId?: string | undefined; /** - *

A map of allowed VPC endpoint IDs and their rule descriptions.

+ *

A list of resource ARNs that exported with the job.

* @public */ - VpcEndpointIdRestrictionRuleMap?: Record | undefined; + ResourceArns?: string[] | undefined; /** - *

A value that specifies whether IP rules are turned on.

+ *

The include dependencies flag.

* @public */ - Enabled?: boolean | undefined; + IncludeAllDependencies?: boolean | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

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 */ - RequestId?: string | undefined; + ExportFormat?: AssetBundleExportFormat | undefined; /** - *

The HTTP status of the request. - *

+ *

The CloudFormation override property configuration for the export job.

* @public */ - Status?: number | undefined; -} + CloudFormationOverridePropertyConfiguration?: AssetBundleCloudFormationOverridePropertyConfiguration | 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 Amazon Web Services request ID for this operation.

* @public */ - AwsAccountId: string | undefined; + RequestId?: string | undefined; /** - *

Determines whether the request returns the default key only.

+ *

The HTTP status of the response.

* @public */ - DefaultKeyOnly?: boolean | undefined; -} + Status?: number | 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 include permissions flag.

* @public */ - KeyArn?: string | undefined; + IncludePermissions?: boolean | undefined; /** - *

Indicates whether a RegisteredCustomerManagedKey is set as the default key for encryption and decryption use.

+ *

The include tags flag.

* @public */ - DefaultKey?: boolean | undefined; -} + IncludeTags?: 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.

+ *

The validation strategy that is used to export the analysis or dashboard.

* @public */ - AwsAccountId?: string | undefined; + ValidationStrategy?: AssetBundleExportJobValidationStrategy | undefined; /** - *

A list of RegisteredCustomerManagedKey objects in a Amazon QuickSight account.

+ *

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 */ - KeyRegistration?: RegisteredCustomerManagedKey[] | undefined; + Warnings?: AssetBundleExportJobWarning[] | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The include folder memberships flag.

* @public */ - RequestId?: string | undefined; + IncludeFolderMemberships?: boolean | undefined; /** - *

The HTTP status of the request.

+ *

A setting that determines whether folder members are included.

* @public */ - Status?: number | undefined; + IncludeFolderMembers?: IncludeFolderMembers | undefined; } /** * @public */ -export interface DescribeNamespaceRequest { +export interface DescribeAssetBundleImportJobRequest { /** - *

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

+ *

The ID of the Amazon Web Services account the import job was executed in.

* @public */ AwsAccountId: string | undefined; /** - *

The namespace that you want to describe.

+ *

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 - * @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 { +export interface DescribeAssetBundleImportJobResponse { /** - *

The error type.

+ *

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 */ - Type?: NamespaceErrorType | undefined; + JobStatus?: AssetBundleImportJobStatus | undefined; /** - *

The message for the error.

+ *

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 */ - Message?: string | undefined; -} + Errors?: AssetBundleImportJobError[] | undefined; -/** - *

The error type.

- * @public - */ -export interface NamespaceInfoV2 { /** - *

The name of the error.

+ *

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 */ - Name?: string | undefined; + RollbackErrors?: AssetBundleImportJobError[] | undefined; /** - *

The namespace ARN.

+ *

The Amazon Resource Name (ARN) for the import job.

* @public */ Arn?: string | undefined; /** - *

The namespace Amazon Web Services Region.

+ *

The time that the import job was created.

* @public */ - CapacityRegion?: string | undefined; + CreatedTime?: Date | undefined; /** - *

The creation status of a namespace that is not yet completely created.

+ *

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

* @public */ - CreationStatus?: NamespaceStatus | undefined; + AssetBundleImportJobId?: string | undefined; /** - *

The identity store used for the namespace.

+ *

The ID of the Amazon Web Services account the import job was executed in.

* @public */ - IdentityStore?: IdentityStore | undefined; + AwsAccountId?: string | undefined; /** - *

An error that occurred when the namespace was created.

+ *

The source of the asset bundle zip file that contains the data that is imported by the job.

* @public */ - NamespaceError?: NamespaceError | undefined; -} + AssetBundleImportSource?: AssetBundleImportSourceDescription | 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.

+ *

Optional overrides that are applied to the resource configuration before import.

* @public */ - Namespace?: NamespaceInfoV2 | undefined; + OverrideParameters?: AssetBundleImportJobOverrideParameters | undefined; + + /** + *

The failure action for the import job.

+ * @public + */ + FailureAction?: AssetBundleImportFailureAction | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -367,99 +357,97 @@ export interface DescribeNamespaceResponse { RequestId?: string | undefined; /** - *

The HTTP status of the request.

+ *

The HTTP status of the response.

* @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.

+ *

Optional permission overrides that are applied to the resource configuration before import.

* @public */ - AwsAccountId: string | undefined; -} - -/** - * @public - * @enum - */ -export const PersonalizationMode = { - DISABLED: "DISABLED", - ENABLED: "ENABLED", -} as const; - -/** - * @public - */ -export type PersonalizationMode = (typeof PersonalizationMode)[keyof typeof PersonalizationMode]; + OverridePermissions?: AssetBundleImportJobOverridePermissions | undefined; -/** - * @public - */ -export interface DescribeQPersonalizationConfigurationResponse { /** - *

A value that indicates whether personalization is enabled or not.

+ *

Optional tag overrides that are applied to the resource configuration before import.

* @public */ - PersonalizationMode?: PersonalizationMode | undefined; + OverrideTags?: AssetBundleImportJobOverrideTags | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.

* @public */ - RequestId?: string | undefined; + OverrideValidationStrategy?: AssetBundleImportJobOverrideValidationStrategy | undefined; /** - *

The HTTP status of the request.

+ *

An array of warning records that describe all permitted errors that are encountered during the import job.

* @public */ - Status?: number | undefined; + Warnings?: AssetBundleImportJobWarning[] | undefined; } /** * @public */ -export interface DescribeRefreshScheduleRequest { +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; /** - *

The ID of the dataset.

+ *

The ID of the Amazon QuickSight brand.

* @public */ - DataSetId: string | undefined; + BrandId: string | undefined; /** - *

The ID of the refresh schedule.

+ *

The ID of the specific version. The default value is the latest version.

* @public */ - ScheduleId: string | undefined; + VersionId?: string | undefined; } /** * @public */ -export interface DescribeRefreshScheduleResponse { +export interface DescribeBrandResponse { /** - *

The refresh schedule.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - RefreshSchedule?: RefreshSchedule | undefined; + RequestId?: string | undefined; /** - *

The HTTP status of the request.

+ *

The details of the brand.

* @public */ - Status?: number | undefined; + BrandDetail?: BrandDetail | undefined; + + /** + *

The definition of the brand.

+ * @public + */ + BrandDefinition?: BrandDefinition | undefined; +} + +/** + * @public + */ +export interface DescribeBrandAssignmentRequest { + /** + *

The ID of the Amazon Web Services account that owns the brand assignment.

+ * @public + */ + AwsAccountId: string | undefined; +} +/** + * @public + */ +export interface DescribeBrandAssignmentResponse { /** *

The Amazon Web Services request ID for this operation.

* @public @@ -467,86 +455,118 @@ export interface DescribeRefreshScheduleResponse { RequestId?: string | undefined; /** - *

The Amazon Resource Name (ARN) for the refresh schedule.

+ *

The Amazon Resource Name (ARN) of the brand.

* @public */ - Arn?: string | undefined; + BrandArn?: string | undefined; } /** * @public */ -export interface DescribeRoleCustomPermissionRequest { +export interface DescribeBrandPublishedVersionRequest { /** - *

The name of the role whose permissions you want described.

+ *

The ID of the Amazon Web Services account that owns the brand.

* @public */ - Role: Role | 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 Amazon QuickSight brand.

* @public */ - AwsAccountId: string | undefined; + BrandId: string | undefined; +} +/** + * @public + */ +export interface DescribeBrandPublishedVersionResponse { /** - *

The namespace that contains the role.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Namespace: string | undefined; + RequestId?: string | undefined; + + /** + *

The details of the brand.

+ * @public + */ + BrandDetail?: BrandDetail | undefined; + + /** + *

The definition of the brand.

+ * @public + */ + BrandDefinition?: BrandDefinition | undefined; } /** * @public */ -export interface DescribeRoleCustomPermissionResponse { +export interface DescribeCustomPermissionsRequest { /** - *

The name of the custom permission that is described.

+ *

The ID of the Amazon Web Services account that contains the custom permissions profile that you want described.

* @public */ - CustomPermissionsName?: string | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The name of the custom permissions profile to describe.

* @public */ - RequestId?: string | undefined; + CustomPermissionsName: string | undefined; +} +/** + * @public + */ +export interface DescribeCustomPermissionsResponse { /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; + + /** + *

The custom permissions profile.

+ * @public + */ + CustomPermissions?: CustomPermissions | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; } /** * @public */ -export interface DescribeTemplateRequest { +export interface DescribeDashboardRequest { /** - *

The ID of the Amazon Web Services account that contains the template that you're describing.

+ *

The ID of the Amazon Web Services account that contains the dashboard that you're + * describing.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the template.

+ *

The ID for the dashboard.

* @public */ - TemplateId: string | undefined; + DashboardId: 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.

+ *

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 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 alias name.

* @public */ AliasName?: string | undefined; @@ -554,69 +574,82 @@ export interface DescribeTemplateRequest { /** * @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; +export interface DescribeDashboardResponse { + /** + *

Information about the dashboard.

+ * @public + */ + Dashboard?: Dashboard | undefined; -/** - * @public - */ -export type TemplateErrorType = (typeof TemplateErrorType)[keyof typeof TemplateErrorType]; + /** + *

The HTTP status of this request.

+ * @public + */ + Status?: number | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; +} /** - *

List of errors that occurred when the template version creation failed.

* @public */ -export interface TemplateError { +export interface DescribeDashboardDefinitionRequest { /** - *

Type of error.

+ *

The ID of the Amazon Web Services account that contains the dashboard that you're + * describing.

* @public */ - Type?: TemplateErrorType | undefined; + AwsAccountId: string | undefined; /** - *

Description of the error type.

+ *

The ID for the dashboard.

* @public */ - Message?: string | undefined; + DashboardId: string | undefined; /** - *

An error path that shows which entities caused the template error.

+ *

The version number for the dashboard. If a version number isn't passed, the + * latest published dashboard version is described.

* @public */ - ViolatedEntities?: Entity[] | undefined; + VersionNumber?: number | undefined; + + /** + *

The alias name.

+ * @public + */ + AliasName?: string | undefined; } /** - *

A version of a template.

* @public */ -export interface TemplateVersion { +export interface DescribeDashboardDefinitionResponse { /** - *

The time that this template version was created.

+ *

The ID of the dashboard described.

* @public */ - CreatedTime?: Date | undefined; + DashboardId?: string | undefined; /** - *

Errors associated with this template version.

+ *

Errors associated with this dashboard version.

* @public */ - Errors?: TemplateError[] | undefined; + Errors?: DashboardError[] | undefined; /** - *

The version number of the template version.

+ *

The display name of the dashboard.

* @public */ - VersionNumber?: number | undefined; + Name?: string | undefined; /** - *

The status that is associated with the template.

+ *

Status associated with the dashboard version.

*
    *
  • *

    @@ -656,100 +689,102 @@ export interface TemplateVersion { *

* @public */ - Status?: ResourceStatus | undefined; + ResourceStatus?: 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.

+ *

The ARN of the theme of the dashboard.

* @public */ - DataSetConfigurations?: DataSetConfiguration[] | undefined; + ThemeArn?: string | undefined; /** - *

The description of the template.

+ *

The definition of a dashboard.

+ *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

* @public */ - Description?: string | undefined; + Definition?: DashboardVersionDefinition | undefined; /** - *

The Amazon Resource Name (ARN) of an analysis or template that was used to create this - * template.

+ *

The HTTP status of the request.

* @public */ - SourceEntityArn?: string | undefined; + Status?: number | 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.

+ *

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 */ - Sheets?: Sheet[] | undefined; + DashboardPublishOptions?: DashboardPublishOptions | 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; - +export interface DescribeDashboardPermissionsRequest { /** - *

The display name of the template.

- * @public - */ - Name?: string | undefined; - - /** - *

A structure describing the versions of the template.

+ *

The ID of the Amazon Web Services account that contains the dashboard that you're describing + * permissions for.

* @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 for the dashboard, also added to the IAM policy.

* @public */ - TemplateId?: string | undefined; + DashboardId: string | undefined; +} +/** + * @public + */ +export interface DescribeDashboardPermissionsResponse { /** - *

Time when this was last updated.

+ *

The ID for the dashboard.

* @public */ - LastUpdatedTime?: Date | undefined; + DashboardId?: string | undefined; /** - *

Time when this was created.

+ *

The Amazon Resource Name (ARN) of the dashboard.

* @public */ - CreatedTime?: Date | undefined; -} + DashboardArn?: string | undefined; -/** - * @public - */ -export interface DescribeTemplateResponse { /** - *

The template structure for the object you want to describe.

+ *

A structure that contains the permissions for the dashboard.

* @public */ - Template?: Template | undefined; + Permissions?: ResourcePermission[] | undefined; /** *

The HTTP status of the request.

@@ -762,426 +797,488 @@ export interface DescribeTemplateResponse { * @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.

+ * @public + */ + LinkSharingConfiguration?: LinkSharingConfiguration | undefined; } /** * @public */ -export interface DescribeTemplateAliasRequest { +export interface DescribeDashboardSnapshotJobRequest { /** - *

The ID of the Amazon Web Services account that contains the template alias that you're - * describing.

+ *

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the template.

+ *

The ID of the dashboard that you have started a snapshot job for.

* @public */ - TemplateId: string | undefined; + DashboardId: 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.

+ *

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 */ - AliasName: string | undefined; + SnapshotJobId: string | undefined; } /** * @public + * @enum */ -export interface DescribeTemplateAliasResponse { - /** - *

Information about the template alias.

- * @public - */ - TemplateAlias?: TemplateAlias | undefined; +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 { /** - *

The HTTP status of the request.

+ *

+ * A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 S3DestinationConfiguration. + *

* @public */ - Status?: number | undefined; + S3Destinations?: SnapshotS3DestinationConfiguration[] | undefined; +} +/** + *

A structure that contains the information on the snapshot files.

+ * @public + */ +export interface SnapshotFileGroup { /** - *

The Amazon Web Services request ID for this operation.

+ *

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 */ - RequestId?: string | undefined; + Files?: SnapshotFile[] | undefined; } /** + *

Describes the configuration of the dashboard snapshot.

* @public */ -export interface DescribeTemplateDefinitionRequest { +export interface SnapshotConfiguration { /** - *

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.

+ *

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 */ - AwsAccountId: string | undefined; + FileGroups: SnapshotFileGroup[] | undefined; /** - *

The ID of the template that you're describing.

+ *

A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.

* @public */ - TemplateId: string | undefined; + DestinationConfiguration?: SnapshotDestinationConfiguration | undefined; /** - *

The version number of the template.

+ *

A list of Amazon QuickSight parameters and the list's override values.

* @public */ - VersionNumber?: 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 SnapshotAnonymousUserRedacted { /** - *

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 tag keys for the RowLevelPermissionTags.

* @public */ - AliasName?: 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 DescribeTemplateDefinitionResponse { +export interface SnapshotUserConfigurationRedacted { /** - *

The descriptive name of the template.

+ *

+ * An array of records that describe anonymous users that the dashboard snapshot is generated for. Sensitive user information is excluded. + *

* @public */ - Name?: string | undefined; + AnonymousUsers?: SnapshotAnonymousUserRedacted[] | undefined; +} +/** + * @public + */ +export interface DescribeDashboardSnapshotJobResponse { /** - *

The ID of the template described.

+ *

+ * The ID of the Amazon Web Services account that the dashboard snapshot job is executed in. + *

* @public */ - TemplateId?: string | undefined; + AwsAccountId?: string | undefined; /** - *

Errors associated with the template version.

+ *

The ID of the dashboard that you have started a snapshot job for.

* @public */ - Errors?: TemplateError[] | undefined; + DashboardId?: string | undefined; /** - *

Status associated with the template.

+ *

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 + */ + SnapshotJobId?: string | undefined; + + /** + *

The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

+ * @public + */ + UserConfiguration?: SnapshotUserConfigurationRedacted | undefined; + + /** + *

The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

+ * @public + */ + SnapshotConfiguration?: SnapshotConfiguration | 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.

+ * @public + */ + Arn?: string | undefined; + + /** + *

Indicates the status of a job. The status updates as the job executes. This shows one of the following values.

*
    *
  • *

    - * CREATION_IN_PROGRESS - *

    - *
  • - *
  • - *

    - * CREATION_SUCCESSFUL - *

    - *
  • - *
  • - *

    - * CREATION_FAILED - *

    - *
  • - *
  • - *

    - * UPDATE_IN_PROGRESS - *

    + * COMPLETED - The job was completed successfully.

    *
  • *
  • *

    - * UPDATE_SUCCESSFUL - *

    + * FAILED - The job failed to execute.

    *
  • *
  • *

    - * UPDATE_FAILED - *

    + * QUEUED - The job is queued and hasn't started yet.

    *
  • *
  • *

    - * DELETED - *

    + * RUNNING - The job is still running.

    *
  • *
* @public */ - ResourceStatus?: ResourceStatus | undefined; + JobStatus?: SnapshotJobStatus | undefined; /** - *

The ARN of the theme of the template.

+ *

+ * The time that the snapshot job was created. + *

* @public */ - ThemeArn?: string | undefined; + CreatedTime?: Date | undefined; /** - *

The definition of the template.

- *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

+ *

+ * The time that the snapshot job status was last updated. + *

* @public */ - Definition?: TemplateVersionDefinition | undefined; + LastUpdatedTime?: Date | 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 DescribeTemplatePermissionsRequest { +export interface DescribeDashboardSnapshotJobResultRequest { /** - *

The ID of the Amazon Web Services account that contains the template that you're describing.

+ *

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the template.

+ *

The ID of the dashboard that you have started a snapshot job for.

* @public */ - TemplateId: string | undefined; + DashboardId: 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.

+ * @public + */ + SnapshotJobId: string | undefined; } /** + *

An object that contains information on the error that caused the snapshot job to fail.

* @public */ -export interface DescribeTemplatePermissionsResponse { +export interface SnapshotJobErrorInfo { /** - *

The ID for the template.

+ *

The error message.

* @public */ - TemplateId?: string | undefined; + ErrorMessage?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the template.

+ *

The error type.

* @public */ - TemplateArn?: string | undefined; + ErrorType?: string | 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 { /** - *

A list of resource permissions to be set on the template.

+ *

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 */ - Permissions?: ResourcePermission[] | undefined; + AnonymousUsers?: AnonymousUserSnapshotJobResult[] | undefined; +} +/** + * @public + */ +export interface DescribeDashboardSnapshotJobResultResponse { /** - *

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 after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

* @public */ - Status?: number | undefined; -} + JobStatus?: SnapshotJobStatus | undefined; -/** - * @public - */ -export interface DescribeThemeRequest { /** - *

The ID of the Amazon Web Services account that contains the theme that you're describing.

+ *

The time that a snapshot job was created.

* @public */ - AwsAccountId: string | undefined; + CreatedTime?: Date | undefined; /** - *

The ID for the theme.

+ *

The time that a snapshot job status was last updated.

* @public */ - ThemeId: string | undefined; + LastUpdatedTime?: Date | 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 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 */ - VersionNumber?: number | undefined; + Result?: SnapshotJobResult | 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.

+ *

Displays information for the error that caused a job to fail.

* @public */ - AliasName?: string | undefined; -} + ErrorInfo?: SnapshotJobErrorInfo | undefined; -/** - * @public - * @enum - */ -export const ThemeType = { - ALL: "ALL", - CUSTOM: "CUSTOM", - QUICKSIGHT: "QUICKSIGHT", -} as const; + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; -/** - * @public - */ -export type ThemeType = (typeof ThemeType)[keyof typeof ThemeType]; + /** + *

The HTTP status of the request

+ * @public + */ + Status?: number | undefined; +} /** * @public - * @enum */ -export const ThemeErrorType = { - INTERNAL_FAILURE: "INTERNAL_FAILURE", -} as const; +export interface DescribeDashboardsQAConfigurationRequest { + /** + *

The ID of the Amazon Web Services account that contains the dashboard QA configuration that you want described.

+ * @public + */ + AwsAccountId: string | undefined; +} /** * @public */ -export type ThemeErrorType = (typeof ThemeErrorType)[keyof typeof ThemeErrorType]; +export interface DescribeDashboardsQAConfigurationResponse { + /** + *

The status of dashboards QA configuration that you want described.

+ * @public + */ + DashboardsQAStatus?: DashboardsQAStatus | undefined; -/** - *

Theme error.

- * @public - */ -export interface ThemeError { /** - *

The type of error.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Type?: ThemeErrorType | undefined; + RequestId?: string | undefined; /** - *

The error message.

+ *

The HTTP status of the request.

* @public */ - Message?: string | undefined; + Status?: number | undefined; } /** - *

A version of a theme.

* @public */ -export interface ThemeVersion { +export interface DescribeDataSetRequest { /** - *

The version number of the theme.

+ *

The Amazon Web Services account ID.

* @public */ - VersionNumber?: number | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Resource Name (ARN) of the resource.

+ *

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 */ - Arn?: string | undefined; + DataSetId: string | undefined; +} +/** + * @public + */ +export interface DescribeDataSetResponse { /** - *

The description of the theme.

+ *

Information on the dataset.

* @public */ - Description?: string | undefined; + DataSet?: DataSet | 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; - - /** - *

The theme configuration, which contains all the theme display properties.

- * @public - */ - Configuration?: ThemeConfiguration | undefined; + Status?: number | undefined; +} +/** + * @public + */ +export interface DescribeDataSetPermissionsRequest { /** - *

Errors associated with the theme.

+ *

The Amazon Web Services account ID.

* @public */ - Errors?: ThemeError[] | undefined; + AwsAccountId: string | undefined; /** - *

The status of the theme version.

+ *

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?: ResourceStatus | undefined; + DataSetId: string | undefined; } /** - *

Summary information about a theme.

* @public */ -export interface Theme { +export interface DescribeDataSetPermissionsResponse { /** - *

The Amazon Resource Name (ARN) of the theme.

+ *

The Amazon Resource Name (ARN) of the dataset.

* @public */ - Arn?: string | undefined; + DataSetArn?: string | undefined; /** - *

The name that the user gives to the theme.

+ *

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 */ - Name?: string | undefined; + DataSetId?: string | undefined; /** - *

The identifier that the user gives to the theme.

+ *

A list of resource permissions on the dataset.

* @public */ - ThemeId?: string | undefined; + Permissions?: ResourcePermission[] | undefined; /** - *

A version of a theme.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Version?: ThemeVersion | undefined; + RequestId?: string | undefined; /** - *

The date and time that the theme was created.

+ *

The HTTP status of the request.

* @public */ - CreatedTime?: Date | undefined; + Status?: number | undefined; +} +/** + * @public + */ +export interface DescribeDataSetRefreshPropertiesRequest { /** - *

The date and time that the theme was last updated.

+ *

The Amazon Web Services account ID.

* @public */ - LastUpdatedTime?: Date | undefined; + AwsAccountId: string | undefined; /** - *

The type of theme, based on how it was created. Valid values include: - * QUICKSIGHT and CUSTOM.

+ *

The ID of the dataset.

* @public */ - Type?: ThemeType | undefined; + DataSetId: string | undefined; } /** * @public */ -export interface DescribeThemeResponse { +export interface DescribeDataSetRefreshPropertiesResponse { /** - *

The information about the theme that you are describing.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Theme?: Theme | undefined; + RequestId?: string | undefined; /** *

The HTTP status of the request.

@@ -1190,94 +1287,87 @@ export interface DescribeThemeResponse { Status?: number | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The dataset refresh properties.

* @public */ - RequestId?: string | undefined; + DataSetRefreshProperties?: DataSetRefreshProperties | undefined; } /** * @public */ -export interface DescribeThemeAliasRequest { +export interface DescribeDataSourceRequest { /** - *

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.

- * @public - */ - ThemeId: string | undefined; - - /** - *

The name of the theme alias that you want to describe.

+ *

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 DescribeThemeAliasResponse { +export interface DescribeDataSourceResponse { /** - *

Information about the theme alias.

+ *

The information on the data source.

* @public */ - ThemeAlias?: ThemeAlias | undefined; + DataSource?: DataSource | 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 DescribeThemePermissionsRequest { +export interface DescribeDataSourcePermissionsRequest { /** - *

The ID of the Amazon Web Services account that contains the theme that you're describing.

+ *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the theme that you want to describe permissions for.

+ *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - ThemeId: string | undefined; + DataSourceId: string | undefined; } /** * @public */ -export interface DescribeThemePermissionsResponse { +export interface DescribeDataSourcePermissionsResponse { /** - *

The ID for the theme.

+ *

The Amazon Resource Name (ARN) of the data source.

* @public */ - ThemeId?: string | undefined; + DataSourceArn?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the theme.

+ *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - ThemeArn?: string | undefined; + DataSourceId?: string | undefined; /** - *

A list of resource permissions set on the theme.

+ *

A list of resource permissions on the data source.

* @public */ Permissions?: ResourcePermission[] | undefined; @@ -1298,100 +1388,89 @@ export interface DescribeThemePermissionsResponse { /** * @public */ -export interface DescribeTopicRequest { +export interface DescribeFolderRequest { /** - *

The Amazon Web Services account ID.

+ *

The ID for the Amazon Web Services account that contains the folder.

* @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.

+ *

The ID of the folder.

* @public */ - TopicId: string | undefined; + FolderId: string | undefined; } /** + *

A folder in Amazon QuickSight.

* @public */ -export interface DescribeTopicResponse { +export interface Folder { /** - *

The Amazon Resource Name (ARN) of the topic.

+ *

The ID of the folder.

+ * @public + */ + FolderId?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) for the folder.

* @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.

+ *

A display name for the folder.

* @public */ - TopicId?: string | undefined; + Name?: string | undefined; /** - *

The definition of a topic.

+ *

The type of folder it is.

* @public */ - Topic?: TopicDetails | 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; /** - *

The HTTP status of the request.

+ *

The time that the folder was created.

* @public */ - Status?: number | undefined; -} + CreatedTime?: Date | undefined; -/** - * @public - */ -export interface DescribeTopicPermissionsRequest { /** - *

The ID of the Amazon Web Services account that contains the topic that you want - * described.

+ *

The time that the folder was last updated.

* @public */ - AwsAccountId: string | undefined; + LastUpdatedTime?: Date | 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.

+ *

The sharing scope of the folder.

* @public */ - TopicId: string | undefined; + SharingModel?: SharingModel | undefined; } /** * @public */ -export interface DescribeTopicPermissionsResponse { - /** - *

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; - +export interface DescribeFolderResponse { /** - *

The Amazon Resource Name (ARN) of the topic.

- * @public - */ - TopicArn?: string | undefined; - - /** - *

A list of resource permissions that are configured to the topic.

+ *

The HTTP status of the request.

* @public */ - Permissions?: ResourcePermission[] | 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.

@@ -1403,77 +1482,65 @@ export interface DescribeTopicPermissionsResponse { /** * @public */ -export interface DescribeTopicRefreshRequest { +export interface DescribeFolderPermissionsRequest { /** - *

The ID of the Amazon Web Services account that contains the topic whose refresh you want - * to describe.

+ *

The ID for the Amazon Web Services account that contains the folder.

* @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.

+ *

The ID of the folder.

* @public */ - TopicId: string | undefined; + FolderId: string | undefined; /** - *

The ID of the refresh, which is performed when the topic is created or updated.

+ *

The namespace of the folder whose permissions you want described.

* @public */ - RefreshId: string | undefined; -} + Namespace?: string | undefined; -/** - * @public - * @enum - */ -export const TopicRefreshStatus = { - CANCELLED: "CANCELLED", - COMPLETED: "COMPLETED", - FAILED: "FAILED", - INITIALIZED: "INITIALIZED", - RUNNING: "RUNNING", -} as const; + /** + *

The maximum number of results to be returned per request.

+ * @public + */ + MaxResults?: number | undefined; -/** - * @public - */ -export type TopicRefreshStatus = (typeof TopicRefreshStatus)[keyof typeof TopicRefreshStatus]; + /** + *

A pagination token for the next set of results.

+ * @public + */ + NextToken?: string | undefined; +} /** - *

The details about the refresh of a topic.

* @public */ -export interface TopicRefreshDetails { +export interface DescribeFolderPermissionsResponse { /** - *

The Amazon Resource Name (ARN) of the topic refresh.

+ *

The HTTP status of the request.

* @public */ - RefreshArn?: string | undefined; + Status?: number | undefined; /** - *

The ID of the refresh, which occurs as a result of topic creation or topic update.

+ *

The ID of the folder.

* @public */ - RefreshId?: string | undefined; + FolderId?: string | undefined; /** - *

The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.

+ *

The Amazon Resource Name (ARN) for the folder.

* @public */ - RefreshStatus?: TopicRefreshStatus | undefined; -} + Arn?: string | undefined; -/** - * @public - */ -export interface DescribeTopicRefreshResponse { /** - *

Details of the refresh, which is performed when the topic is created or updated.

+ *

Information about the permissions on the folder.

* @public */ - RefreshDetails?: TopicRefreshDetails | undefined; + Permissions?: ResourcePermission[] | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -1482,97 +1549,135 @@ export interface DescribeTopicRefreshResponse { RequestId?: string | undefined; /** - *

The HTTP status of the request.

+ *

The pagination token for the next set of results, or null if there are no more results.

* @public */ - Status?: number | undefined; + NextToken?: string | undefined; } /** + *

The NextToken value isn't valid.

* @public */ -export interface DescribeTopicRefreshScheduleRequest { - /** - *

The Amazon Web Services account ID.

- * @public - */ - AwsAccountId: string | undefined; - +export class InvalidNextTokenException extends __BaseException { + readonly name: "InvalidNextTokenException" = "InvalidNextTokenException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; /** - *

The ID of the topic that contains the refresh schedule that you want to describe. This - * ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The Amazon Web Services request ID for this request.

* @public */ - TopicId: string | undefined; - + RequestId?: string | undefined; /** - *

The ID of the dataset.

- * @public + * @internal */ - DatasetId: 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 DescribeTopicRefreshScheduleResponse { +export interface DescribeFolderResolvedPermissionsRequest { /** - *

The ID of the topic that contains the refresh schedule that you want to describe. This - * ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The ID for the Amazon Web Services account that contains the folder.

* @public */ - TopicId?: string | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Resource Name (ARN) of the topic.

+ *

The ID of the folder.

* @public */ - TopicArn?: string | undefined; + FolderId: string | undefined; /** - *

The Amazon Resource Name (ARN) of the dataset.

+ *

The namespace of the folder whose permissions you want described.

* @public */ - DatasetArn?: string | undefined; + Namespace?: string | undefined; /** - *

The definition of a refresh schedule.

+ *

The maximum number of results to be returned per request.

* @public */ - RefreshSchedule?: TopicRefreshSchedule | undefined; + MaxResults?: number | undefined; + + /** + *

A pagination token for the next set of results.

+ * @public + */ + NextToken?: string | undefined; +} +/** + * @public + */ +export interface DescribeFolderResolvedPermissionsResponse { /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; + /** + *

The ID of the folder.

+ * @public + */ + FolderId?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the folder.

+ * @public + */ + Arn?: string | undefined; + + /** + *

Information about the permissions for the folder.

+ * @public + */ + Permissions?: ResourcePermission[] | undefined; + /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; + + /** + *

A pagination token for the next set of results, or null if there are no more results.

+ * @public + */ + NextToken?: string | undefined; } /** * @public */ -export interface DescribeUserRequest { +export interface DescribeGroupRequest { /** - *

The name of the user that you want to describe.

+ *

The name of the group that you want to describe.

* @public */ - UserName: string | undefined; + GroupName: string | undefined; /** - *

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the + *

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; /** - *

The namespace. Currently, you should set this to default.

+ *

The namespace of the group that you want described.

* @public */ Namespace: string | undefined; @@ -1580,173 +1685,156 @@ export interface DescribeUserRequest { /** * @public - * @enum */ -export const IdentityType = { - IAM: "IAM", - IAM_IDENTITY_CENTER: "IAM_IDENTITY_CENTER", - QUICKSIGHT: "QUICKSIGHT", -} as const; +export interface DescribeGroupResponse { + /** + *

The name of the group.

+ * @public + */ + Group?: Group | undefined; -/** - * @public - */ -export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType]; + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; -/** - * @public - * @enum - */ -export const UserRole = { - ADMIN: "ADMIN", - ADMIN_PRO: "ADMIN_PRO", - AUTHOR: "AUTHOR", - AUTHOR_PRO: "AUTHOR_PRO", - READER: "READER", - READER_PRO: "READER_PRO", - RESTRICTED_AUTHOR: "RESTRICTED_AUTHOR", - RESTRICTED_READER: "RESTRICTED_READER", -} as const; + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; +} /** * @public */ -export type UserRole = (typeof UserRole)[keyof typeof UserRole]; +export interface DescribeGroupMembershipRequest { + /** + *

The user name of the user that you want to search for.

+ * @public + */ + MemberName: string | undefined; + + /** + *

The name of the group that you want to search.

+ * @public + */ + GroupName: 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.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The namespace that includes the group you are searching within.

+ * @public + */ + Namespace: string | undefined; +} /** - *

A registered user of Amazon QuickSight.

* @public */ -export interface User { +export interface DescribeGroupMembershipResponse { /** - *

The Amazon Resource Name (ARN) for the user.

+ *

A member of an Amazon QuickSight group. Currently, group members must be users. Groups + * can't be members of another group. .

* @public */ - Arn?: string | undefined; + GroupMember?: GroupMember | undefined; /** - *

The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is - * N/A when the value for IdentityType is IAM - * and the corresponding IAM user is deleted.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - UserName?: string | undefined; + RequestId?: string | undefined; /** - *

The user's email address.

+ *

The HTTP status of the request.

* @public */ - Email?: string | undefined; + Status?: number | undefined; +} + +/** + * @public + */ +export interface DescribeIAMPolicyAssignmentRequest { + /** + *

The ID of the Amazon Web Services account that contains the assignment that you want to + * describe.

+ * @public + */ + AwsAccountId: string | undefined; /** - *

The Amazon QuickSight role for the user. The user role can be one of the - * following:.

- *
    - *
  • - *

    - * READER: A user who has read-only access to dashboards.

    - *
  • - *
  • - *

    - * AUTHOR: A user who can create data sources, datasets, analyses, - * and dashboards.

    - *
  • - *
  • - *

    - * ADMIN: A user who is an author, who can also manage Amazon - * Amazon QuickSight settings.

    - *
  • - *
  • - *

    - * READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

    - *
  • - *
  • - *

    - * AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

    - *
  • - *
  • - *

    - * ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.

    - *
  • - *
  • - *

    - * RESTRICTED_READER: This role isn't currently available for - * use.

    - *
  • - *
  • - *

    - * RESTRICTED_AUTHOR: This role isn't currently available for - * use.

    - *
  • - *
+ *

The name of the assignment, also called a rule.

* @public */ - Role?: UserRole | undefined; + AssignmentName: string | undefined; /** - *

The type of identity authentication used by the user.

+ *

The namespace that contains the assignment.

* @public */ - IdentityType?: IdentityType | undefined; + Namespace: string | undefined; +} +/** + *

An Identity and Access Management (IAM) policy assignment.

+ * @public + */ +export interface IAMPolicyAssignment { /** - *

The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a - * password.

+ *

The Amazon Web Services account ID.

* @public */ - Active?: boolean | undefined; + AwsAccountId?: string | undefined; /** - *

The principal ID of the user.

+ *

Assignment ID.

* @public */ - PrincipalId?: string | undefined; + AssignmentId?: string | undefined; /** - *

The custom permissions profile associated with this user.

+ *

Assignment name.

* @public */ - CustomPermissionsName?: string | undefined; + AssignmentName?: string | undefined; /** - *

The type of supported external login provider that provides identity to let the user - * federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.

- *
    - *
  • - *

    - * COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.

    - *
  • - *
  • - *

    - * CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.

    - *
  • - *
+ *

The Amazon Resource Name (ARN) for the IAM policy.

* @public */ - ExternalLoginFederationProviderType?: string | undefined; + PolicyArn?: string | undefined; /** - *

The URL of the external login provider.

+ *

Identities.

* @public */ - ExternalLoginFederationProviderUrl?: string | undefined; + Identities?: Record | undefined; /** - *

The identity ID for the user in the external login provider.

+ *

Assignment status.

* @public */ - ExternalLoginId?: string | undefined; + AssignmentStatus?: AssignmentStatus | undefined; } /** * @public */ -export interface DescribeUserResponse { +export interface DescribeIAMPolicyAssignmentResponse { /** - *

The user name.

+ *

Information describing the IAM policy assignment.

* @public */ - User?: User | undefined; + IAMPolicyAssignment?: IAMPolicyAssignment | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -1764,170 +1852,255 @@ export interface DescribeUserResponse { /** * @public */ -export interface DescribeVPCConnectionRequest { +export interface DescribeIngestionRequest { /** - *

The Amazon Web Services account ID of the account that contains the VPC connection that - * you want described.

+ *

The Amazon Web Services account ID.

* @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 dataset used in the ingestion.

* @public */ - VPCConnectionId: string | undefined; + DataSetId: string | undefined; + + /** + *

An ID for the ingestion.

+ * @public + */ + IngestionId: string | undefined; } /** * @public * @enum */ -export const NetworkInterfaceStatus = { - ATTACHMENT_FAILED_ROLLBACK_FAILED: "ATTACHMENT_FAILED_ROLLBACK_FAILED", - AVAILABLE: "AVAILABLE", - CREATING: "CREATING", - CREATION_FAILED: "CREATION_FAILED", - DELETED: "DELETED", - DELETING: "DELETING", - DELETION_FAILED: "DELETION_FAILED", - DELETION_SCHEDULED: "DELETION_SCHEDULED", - UPDATE_FAILED: "UPDATE_FAILED", - UPDATING: "UPDATING", +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 NetworkInterfaceStatus = (typeof NetworkInterfaceStatus)[keyof typeof NetworkInterfaceStatus]; +export type IngestionErrorType = (typeof IngestionErrorType)[keyof typeof IngestionErrorType]; /** - *

The structure that contains information about a network interface.

+ *

Error information for the SPICE ingestion of a dataset.

* @public */ -export interface NetworkInterface { +export interface ErrorInfo { /** - *

The subnet ID associated with the network interface.

+ *

Error type.

* @public */ - SubnetId?: string | undefined; + Type?: IngestionErrorType | undefined; /** - *

The availability zone that the network interface resides in.

+ *

Error message.

* @public */ - AvailabilityZone?: string | undefined; - - /** - *

An error message.

- * @public - */ - ErrorMessage?: string | undefined; + Message?: string | undefined; +} +/** + *

Information about a queued dataset SPICE ingestion.

+ * @public + */ +export interface QueueInfo { /** - *

The status of the network interface.

+ *

The ID of the queued ingestion.

* @public */ - Status?: NetworkInterfaceStatus | undefined; + WaitingOnIngestion: string | undefined; /** - *

The network interface ID.

+ *

The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing + * ingestion to complete.

* @public */ - NetworkInterfaceId?: string | undefined; + QueuedIngestion: string | undefined; } /** - *

The structure of a VPC connection.

* @public + * @enum */ -export interface VPCConnection { +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 RowInfo { /** - *

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 number of rows that were ingested.

* @public */ - VPCConnectionId?: string | undefined; + RowsIngested?: number | undefined; /** - *

The Amazon Resource Name (ARN) of the VPC connection.

+ *

The number of rows that were not ingested.

* @public */ - Arn?: string | undefined; + RowsDropped?: number | undefined; /** - *

The display name for the VPC connection.

+ *

The total number of rows in the dataset.

* @public */ - Name?: string | undefined; + TotalRowsInDataset?: number | undefined; +} +/** + *

Information about the SPICE ingestion for a dataset.

+ * @public + */ +export interface Ingestion { /** - *

The Amazon EC2 VPC ID associated with the VPC connection.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ - VPCId?: string | undefined; + Arn: string | undefined; /** - *

The Amazon EC2 security group IDs associated with the VPC connection.

+ *

Ingestion ID.

* @public */ - SecurityGroupIds?: string[] | undefined; + IngestionId?: string | undefined; /** - *

A list of IP addresses of DNS resolver endpoints for the VPC connection.

+ *

Ingestion status.

* @public */ - DnsResolvers?: string[] | undefined; + IngestionStatus: IngestionStatus | undefined; /** - *

The status of the VPC connection.

+ *

Error information for this ingestion.

* @public */ - Status?: VPCConnectionResourceStatus | undefined; + ErrorInfo?: ErrorInfo | undefined; /** - *

The availability status of the VPC connection.

+ *

Information about rows for a data set SPICE ingestion.

* @public */ - AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; + RowInfo?: RowInfo | undefined; /** - *

A list of network interfaces.

+ *

Information about a queued dataset SPICE ingestion.

* @public */ - NetworkInterfaces?: NetworkInterface[] | undefined; + QueueInfo?: QueueInfo | undefined; /** - *

The ARN of the - * IAM role associated with the VPC - * connection.

+ *

The time that this ingestion started.

* @public */ - RoleArn?: string | undefined; + CreatedTime: Date | undefined; /** - *

The time that the VPC connection was created.

+ *

The time that this ingestion took, measured in seconds.

* @public */ - CreatedTime?: Date | undefined; + IngestionTimeInSeconds?: number | undefined; /** - *

The time that the VPC connection was last updated.

+ *

The size of the data ingested, in bytes.

* @public */ - LastUpdatedTime?: Date | undefined; + IngestionSizeInBytes?: number | undefined; + + /** + *

Event source for this ingestion.

+ * @public + */ + RequestSource?: IngestionRequestSource | undefined; + + /** + *

Type of this ingestion.

+ * @public + */ + RequestType?: IngestionRequestType | undefined; } /** * @public */ -export interface DescribeVPCConnectionResponse { +export interface DescribeIngestionResponse { /** - *

A response object that provides information for the specified VPC connection.

+ *

Information about the ingestion.

* @public */ - VPCConnection?: VPCConnection | undefined; + Ingestion?: Ingestion | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -1943,965 +2116,644 @@ export interface DescribeVPCConnectionResponse { } /** - *

The domain specified isn't on the allow list. All domains for embedded dashboards must be - * added to the approved list by an Amazon QuickSight admin.

* @public */ -export class DomainNotWhitelistedException extends __BaseException { - readonly name: "DomainNotWhitelistedException" = "DomainNotWhitelistedException"; - readonly $fault: "client" = "client"; - Message?: string | undefined; +export interface DescribeIpRestrictionRequest { /** - *

The Amazon Web Services request ID for this request.

+ *

The ID of the Amazon Web Services account that contains the IP rules.

* @public */ - RequestId?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "DomainNotWhitelistedException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, DomainNotWhitelistedException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } + AwsAccountId: string | undefined; } -/** - * @public - * @enum - */ -export const EmbeddingIdentityType = { - ANONYMOUS: "ANONYMOUS", - IAM: "IAM", - QUICKSIGHT: "QUICKSIGHT", -} as const; - /** * @public */ -export type EmbeddingIdentityType = (typeof EmbeddingIdentityType)[keyof typeof EmbeddingIdentityType]; +export interface DescribeIpRestrictionResponse { + /** + *

The ID of the Amazon Web Services account that contains the IP rules.

+ * @public + */ + AwsAccountId?: string | undefined; -/** - *

An entry that appears when a KeyRegistration update to Amazon QuickSight fails.

- * @public - */ -export interface FailedKeyRegistrationEntry { /** - *

The ARN of the KMS key that failed to update.

+ *

A map that describes the IP rules with CIDR range and description.

* @public */ - KeyArn?: string | undefined; + IpRestrictionRuleMap?: Record | undefined; /** - *

A message that provides information about why a FailedKeyRegistrationEntry error occurred.

+ *

A map of allowed VPC IDs and their rule descriptions.

* @public */ - Message: string | undefined; + VpcIdRestrictionRuleMap?: Record | undefined; /** - *

The HTTP status of a FailedKeyRegistrationEntry error.

+ *

A map of allowed VPC endpoint IDs and their rule descriptions.

* @public */ - StatusCode: number | undefined; + VpcEndpointIdRestrictionRuleMap?: Record | undefined; /** - *

A boolean that indicates whether a FailedKeyRegistrationEntry resulted from user error. If the value of this property is True, the error was caused by user error. If the value of this property is False, the error occurred on the backend. If your job continues fail and with a False - * SenderFault value, contact Amazon Web Services Support.

+ *

A value that specifies whether IP rules are turned on.

* @public */ - SenderFault: boolean | undefined; -} + Enabled?: boolean | undefined; -/** - * @public - * @enum - */ -export const FolderFilterAttribute = { - DIRECT_QUICKSIGHT_OWNER: "DIRECT_QUICKSIGHT_OWNER", - DIRECT_QUICKSIGHT_SOLE_OWNER: "DIRECT_QUICKSIGHT_SOLE_OWNER", - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER", - FOLDER_NAME: "FOLDER_NAME", - PARENT_FOLDER_ARN: "PARENT_FOLDER_ARN", - QUICKSIGHT_OWNER: "QUICKSIGHT_OWNER", - 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 FolderFilterAttribute = (typeof FolderFilterAttribute)[keyof typeof FolderFilterAttribute]; + /** + *

The HTTP status of the request. + *

+ * @public + */ + Status?: number | undefined; +} /** - *

An object that consists of a member Amazon Resource Name (ARN) and a member ID.

* @public */ -export interface MemberIdArnPair { +export interface DescribeKeyRegistrationRequest { /** - *

The ID of the member.

+ *

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.

* @public */ - MemberId?: string | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Resource Name (ARN) of the member.

+ *

Determines whether the request returns the default key only.

* @public */ - MemberArn?: string | undefined; + DefaultKeyOnly?: boolean | undefined; } /** - *

A filter to use to search an Amazon QuickSight folder.

+ *

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 FolderSearchFilter { - /** - *

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":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value FOLDER_NAME.

- * @public - */ - Operator?: FilterOperator | undefined; - +export interface RegisteredCustomerManagedKey { /** - *

The name of a value that you want to use in the 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 folders with that ARN listed as one of the folder'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 folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered.

    - *
  • - *
  • - *

    - * DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered.

    - *
  • - *
  • - *

    - * DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders 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 folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered.

    - *
  • - *
  • - *

    - * FOLDER_NAME: Any folders whose names have a substring match to this value will be returned.

    - *
  • - *
  • - *

    - * PARENT_FOLDER_ARN: Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned.

    - *
  • - *
+ *

The ARN of the KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.

* @public */ - Name?: FolderFilterAttribute | undefined; + KeyArn?: string | undefined; /** - *

The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId".

+ *

Indicates whether a RegisteredCustomerManagedKey is set as the default key for encryption and decryption use.

* @public */ - Value?: string | undefined; + DefaultKey?: boolean | undefined; } /** - *

A summary of information about an existing Amazon QuickSight folder.

* @public */ -export interface FolderSummary { +export interface DescribeKeyRegistrationResponse { /** - *

The Amazon Resource Name (ARN) of the folder.

+ *

The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request.

* @public */ - Arn?: string | undefined; + AwsAccountId?: string | undefined; /** - *

The ID of the folder.

+ *

A list of RegisteredCustomerManagedKey objects in a Amazon QuickSight account.

* @public */ - FolderId?: string | undefined; - - /** - *

The display name of the folder.

- * @public - */ - Name?: string | undefined; + KeyRegistration?: RegisteredCustomerManagedKey[] | undefined; /** - *

The type of folder.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - FolderType?: FolderType | undefined; + RequestId?: string | undefined; /** - *

The time that the folder was created.

+ *

The HTTP status of the request.

* @public */ - CreatedTime?: Date | undefined; + Status?: number | undefined; +} +/** + * @public + */ +export interface DescribeNamespaceRequest { /** - *

The time that the folder was last updated.

+ *

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

* @public */ - LastUpdatedTime?: Date | undefined; + AwsAccountId: string | undefined; /** - *

The sharing scope of the folder.

+ *

The namespace that you want to describe.

* @public */ - SharingModel?: SharingModel | undefined; + Namespace: string | undefined; } /** - *

The key-value pair used for the row-level security tags feature.

* @public + * @enum */ -export interface SessionTag { +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 key for the tag.

+ *

The error type.

* @public */ - Key: string | undefined; + Type?: NamespaceErrorType | undefined; /** - *

The value that you want to assign the tag.

+ *

The message for the error.

* @public */ - Value: string | undefined; + Message?: string | undefined; } /** + *

The error type.

* @public */ -export interface GenerateEmbedUrlForAnonymousUserRequest { +export interface NamespaceInfoV2 { /** - *

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

+ *

The name of the error.

* @public */ - AwsAccountId: string | undefined; + Name?: string | undefined; /** - *

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

+ *

The namespace ARN.

* @public */ - SessionLifetimeInMinutes?: number | undefined; + Arn?: string | undefined; /** - *

The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

+ *

The namespace Amazon Web Services Region.

* @public */ - Namespace: string | undefined; + CapacityRegion?: string | undefined; /** - *

The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

- *

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

+ *

The creation status of a namespace that is not yet completely created.

* @public */ - SessionTags?: SessionTag[] | undefined; + CreationStatus?: NamespaceStatus | undefined; /** - *

The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user - * is authorized to access during the lifetime of the session.

- *

If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the - * account that you want the user to be able to view.

- *

If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.

- *

Currently, you can pass up to 25 theme ARNs in each API call.

+ *

The identity store used for the namespace.

* @public */ - AuthorizedResourceArns: string[] | undefined; + IdentityStore?: IdentityStore | undefined; /** - *

The configuration of the experience that you are embedding.

+ *

An error that occurred when the namespace was created.

* @public */ - ExperienceConfiguration: AnonymousUserEmbeddingExperienceConfiguration | undefined; + NamespaceError?: NamespaceError | undefined; /** - *

The domains that you want to add to the allow list for access to the generated URL that - * is then embedded. This optional parameter overrides the static domains that are - * configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it - * allows only the domains that you include in this parameter. You can list up to three - * domains or subdomains in each API call.

- *

To include all subdomains under a specific domain to the allow list, use *. - * For example, https://*.sapp.amazon.com includes all subdomains under - * https://sapp.amazon.com.

+ *

The Amazon Resource Name (ARN) for the IAM Identity Center application.

* @public */ - AllowedDomains?: string[] | undefined; -} + IamIdentityCenterApplicationArn?: string | undefined; -/** - * @public - */ -export interface GenerateEmbedUrlForAnonymousUserResponse { /** - *

The embed URL for the dashboard.

+ *

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

* @public */ - EmbedUrl: string | undefined; + IamIdentityCenterInstanceArn?: string | undefined; +} +/** + * @public + */ +export interface DescribeNamespaceResponse { /** - *

The HTTP status of the request.

+ *

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 */ - Status: number | undefined; + Namespace?: NamespaceInfoV2 | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ - RequestId: string | undefined; + RequestId?: string | undefined; /** - *

The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.

+ *

The HTTP status of the request.

* @public */ - AnonymousUserArn: string | undefined; + Status?: number | undefined; } /** - *

The number of minutes specified for the lifetime of a session isn't valid. The session - * lifetime must be 15-600 minutes.

* @public */ -export class SessionLifetimeInMinutesInvalidException extends __BaseException { - readonly name: "SessionLifetimeInMinutesInvalidException" = "SessionLifetimeInMinutesInvalidException"; - readonly $fault: "client" = "client"; - Message?: string | undefined; +export interface DescribeQPersonalizationConfigurationRequest { /** - *

The Amazon Web Services request ID for this request.

+ *

The ID of the Amazon Web Services account that contains the personalization configuration that the user wants described.

* @public */ - RequestId?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "SessionLifetimeInMinutesInvalidException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, SessionLifetimeInMinutesInvalidException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } + AwsAccountId: string | undefined; } /** - *

This error indicates that you are calling an embedding operation in Amazon QuickSight - * without the required pricing plan on your Amazon Web Services account. Before you can use embedding - * for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You - * can do this on the Manage Amazon QuickSight page.

- *

After capacity pricing is added, you can use the - * - * GetDashboardEmbedUrl - * API operation with the - * --identity-type ANONYMOUS option.

* @public + * @enum */ -export class UnsupportedPricingPlanException extends __BaseException { - readonly name: "UnsupportedPricingPlanException" = "UnsupportedPricingPlanException"; - readonly $fault: "client" = "client"; - Message?: string | undefined; +export const PersonalizationMode = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", +} as const; + +/** + * @public + */ +export type PersonalizationMode = (typeof PersonalizationMode)[keyof typeof PersonalizationMode]; + +/** + * @public + */ +export interface DescribeQPersonalizationConfigurationResponse { /** - *

The Amazon Web Services request ID for this request.

+ *

A value that indicates whether personalization is enabled or not.

* @public */ - RequestId?: string | undefined; + PersonalizationMode?: PersonalizationMode | undefined; + /** - * @internal + *

The Amazon Web Services request ID for this operation.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "UnsupportedPricingPlanException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, UnsupportedPricingPlanException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } -} + RequestId?: string | undefined; -/** - *

The state perssitence configuration of an embedded dashboard.

- * @public - */ -export interface StatePersistenceConfigurations { /** - *

Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.

+ *

The HTTP status of the request.

* @public */ - Enabled: boolean | undefined; + Status?: number | undefined; } /** - *

The feature configuration for an embedded dashboard.

* @public */ -export interface RegisteredUserDashboardFeatureConfigurations { +export interface DescribeRefreshScheduleRequest { /** - *

The state persistence settings of an embedded dashboard.

+ *

The Amazon Web Services account ID.

* @public */ - StatePersistence?: StatePersistenceConfigurations | undefined; + AwsAccountId: string | undefined; /** - *

The shared view settings of an embedded dashboard.

+ *

The ID of the dataset.

* @public */ - SharedView?: SharedViewConfigurations | undefined; + DataSetId: string | undefined; /** - *

The bookmarks configuration for an embedded dashboard in Amazon QuickSight.

+ *

The ID of the refresh schedule.

* @public */ - Bookmarks?: BookmarksConfigurations | undefined; + ScheduleId: string | undefined; } /** - *

Information about the dashboard you want to embed.

* @public */ -export interface RegisteredUserDashboardEmbeddingConfiguration { +export interface DescribeRefreshScheduleResponse { /** - *

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.

- *

If the user does not have permission to view this dashboard, they see a permissions error message.

+ *

The refresh schedule.

* @public */ - InitialDashboardId: string | undefined; + RefreshSchedule?: RefreshSchedule | undefined; /** - *

The feature configurations of an embbedded Amazon QuickSight dashboard.

+ *

The HTTP status of the request.

* @public */ - FeatureConfigurations?: RegisteredUserDashboardFeatureConfigurations | undefined; -} + Status?: number | undefined; -/** - *

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

- * @public - */ -export interface RegisteredUserDashboardVisualEmbeddingConfiguration { /** - *

The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

- *

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - InitialDashboardVisualId: DashboardVisualId | undefined; -} + RequestId?: string | undefined; -/** - *

An object that provides information about the configuration of a Generative Q&A experience.

- * @public - */ -export interface RegisteredUserGenerativeQnAEmbeddingConfiguration { /** - *

The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience. - * You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening - * a topic. The ID is in the URL for the topic that you open.

- *

If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.

+ *

The Amazon Resource Name (ARN) for the refresh schedule.

* @public */ - InitialTopicId?: string | undefined; + Arn?: string | undefined; } /** - *

Information about the Q search bar embedding experience.

* @public */ -export interface RegisteredUserQSearchBarEmbeddingConfiguration { - /** - *

The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Amazon QuickSight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers - * are allowed to select other topics from the list of available topics.

- *

If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.

- * @public - */ - InitialTopicId?: string | undefined; -} - -/** - *

The feature configurations of an embedded Amazon QuickSight console.

- * @public - */ -export interface RegisteredUserConsoleFeatureConfigurations { - /** - *

The state persistence configurations of an embedded Amazon QuickSight console.

- * @public - */ - StatePersistence?: StatePersistenceConfigurations | undefined; - +export interface DescribeRoleCustomPermissionRequest { /** - *

The shared view settings of an embedded dashboard.

+ *

The name of the role whose permissions you want described.

* @public */ - SharedView?: SharedViewConfigurations | undefined; -} + Role: Role | undefined; -/** - *

Information about the Amazon QuickSight console that you want to embed.

- * @public - */ -export interface RegisteredUserQuickSightConsoleEmbeddingConfiguration { /** - *

The initial URL path for the Amazon QuickSight console. InitialPath is required.

- *

The entry point URL is constrained to the following paths:

- *
    - *
  • - *

    - * /start - *

    - *
  • - *
  • - *

    - * /start/analyses - *

    - *
  • - *
  • - *

    - * /start/dashboards - *

    - *
  • - *
  • - *

    - * /start/favorites - *

    - *
  • - *
  • - *

    - * /dashboards/DashboardId. DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard.

    - *
  • - *
  • - *

    - * /analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis.

    - *
  • - *
+ *

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 */ - InitialPath?: string | undefined; + AwsAccountId: string | undefined; /** - *

The embedding configuration of an embedded Amazon QuickSight console.

+ *

The namespace that contains the role.

* @public */ - FeatureConfigurations?: RegisteredUserConsoleFeatureConfigurations | undefined; + Namespace: string | undefined; } /** - *

The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.

- * - *

Exactly one of the experience configurations is required. You can choose - * Dashboard or QuickSightConsole. You cannot choose more - * than one experience configuration.

- *
* @public */ -export interface RegisteredUserEmbeddingExperienceConfiguration { - /** - *

The configuration details for providing a dashboard embedding experience.

- * @public - */ - Dashboard?: RegisteredUserDashboardEmbeddingConfiguration | undefined; - - /** - *

The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User - * Guide.

- *

Use - * GenerateEmbedUrlForRegisteredUser - * - * where - * you want to provide an authoring portal that allows users to create data sources, - * datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console - * needs to belong to the author or admin security cohort. If you want to restrict permissions - * to some of these features, add a custom permissions profile to the user with the - * - * UpdateUser - * API operation. Use the - * RegisterUser - * API operation to add a new user with a custom permission profile attached. For more - * information, see the following sections in the Amazon QuickSight User - * Guide:

- * - *

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

- * @public - */ - QuickSightConsole?: RegisteredUserQuickSightConsoleEmbeddingConfiguration | undefined; - +export interface DescribeRoleCustomPermissionResponse { /** - *

The configuration details for embedding the Q search bar.

- *

For more information about embedding the Q search bar, see Embedding Overview in - * the Amazon QuickSight User Guide.

+ *

The name of the custom permission that is described.

* @public */ - QSearchBar?: RegisteredUserQSearchBarEmbeddingConfiguration | undefined; + CustomPermissionsName?: string | undefined; /** - *

The type of embedding experience. In this case, Amazon QuickSight visuals.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - DashboardVisual?: RegisteredUserDashboardVisualEmbeddingConfiguration | undefined; + RequestId?: string | undefined; /** - *

The configuration details for embedding the Generative Q&A experience.

- *

For more information about embedding the Generative Q&A experience, see Embedding Overview in - * the Amazon QuickSight User Guide.

+ *

The HTTP status of the request.

* @public */ - GenerativeQnA?: RegisteredUserGenerativeQnAEmbeddingConfiguration | undefined; + Status?: number | undefined; } /** * @public */ -export interface GenerateEmbedUrlForRegisteredUserRequest { +export interface DescribeTemplateRequest { /** - *

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

+ *

The ID of the Amazon Web Services account that contains the template that you're describing.

* @public */ AwsAccountId: string | undefined; /** - *

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

- * @public - */ - SessionLifetimeInMinutes?: number | undefined; - - /** - *

The Amazon Resource Name for the registered user.

+ *

The ID for the template.

* @public */ - UserArn: string | undefined; + TemplateId: string | undefined; /** - *

The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

+ *

(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 */ - ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfiguration | undefined; + VersionNumber?: number | undefined; /** - *

The domains that you want to add to the allow list for access to the generated URL that - * is then embedded. This optional parameter overrides the static domains that are - * configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it - * allows only the domains that you include in this parameter. You can list up to three - * domains or subdomains in each API call.

- *

To include all subdomains under a specific domain to the allow list, use *. - * For example, https://*.sapp.amazon.com includes all subdomains under - * https://sapp.amazon.com.

+ *

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 */ - AllowedDomains?: string[] | undefined; + AliasName?: string | undefined; } /** * @public + * @enum */ -export interface GenerateEmbedUrlForRegisteredUserResponse { - /** - *

The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.

- * @public - */ - EmbedUrl: 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; -} +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; /** - *

The user with the provided name isn't found. This error can happen in any operation - * that requires finding a user based on a provided user name, such as - * DeleteUser, DescribeUser, and so on.

* @public */ -export class QuickSightUserNotFoundException extends __BaseException { - readonly name: "QuickSightUserNotFoundException" = "QuickSightUserNotFoundException"; - 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: "QuickSightUserNotFoundException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, QuickSightUserNotFoundException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } -} +export type TemplateErrorType = (typeof TemplateErrorType)[keyof typeof TemplateErrorType]; /** + *

List of errors that occurred when the template version creation failed.

* @public */ -export interface GetDashboardEmbedUrlRequest { - /** - *

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

- * @public - */ - AwsAccountId: string | undefined; - +export interface TemplateError { /** - *

The ID for the dashboard, also added to the Identity and Access Management (IAM) - * policy.

+ *

Type of error.

* @public */ - DashboardId: string | undefined; + Type?: TemplateErrorType | undefined; /** - *

The authentication method that the user uses to sign in.

+ *

Description of the error type.

* @public */ - IdentityType: EmbeddingIdentityType | undefined; + Message?: string | undefined; /** - *

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

+ *

An error path that shows which entities caused the template error.

* @public */ - SessionLifetimeInMinutes?: number | undefined; + ViolatedEntities?: Entity[] | undefined; +} +/** + *

A version of a template.

+ * @public + */ +export interface TemplateVersion { /** - *

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables - * the undo/redo button.

+ *

The time that this template version was created.

* @public */ - UndoRedoDisabled?: boolean | undefined; + CreatedTime?: Date | undefined; /** - *

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the - * reset button.

+ *

Errors associated with this template version.

* @public */ - ResetDisabled?: boolean | undefined; + Errors?: TemplateError[] | undefined; /** - *

Adds persistence of state for the user session in an embedded dashboard. Persistence - * applies to the sheet and the parameter settings. These are control settings that the - * dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is - * set to TRUE, the settings are the same when the subscriber reopens the same - * dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is - * set to FALSE, the state of the user session is not persisted. The default is - * FALSE.

+ *

The version number of the template version.

* @public */ - StatePersistenceEnabled?: boolean | undefined; + VersionNumber?: number | undefined; /** - *

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. - * You can use this for any Amazon QuickSight users in your account (readers, authors, or - * admins) authenticated as one of the following:

+ *

The status that is associated with the template.

*
    *
  • - *

    Active Directory (AD) users or group members

    + *

    + * CREATION_IN_PROGRESS + *

    *
  • *
  • - *

    Invited nonfederated users

    + *

    + * CREATION_SUCCESSFUL + *

    *
  • *
  • - *

    IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using - * SAML, OpenID Connect, or IAM federation.

    + *

    + * CREATION_FAILED + *

    + *
  • + *
  • + *

    + * UPDATE_IN_PROGRESS + *

    + *
  • + *
  • + *

    + * UPDATE_SUCCESSFUL + *

    + *
  • + *
  • + *

    + * UPDATE_FAILED + *

    + *
  • + *
  • + *

    + * DELETED + *

    *
  • *
- *

Omit this parameter for users in the third group – IAM users and IAM - * role-based sessions.

* @public */ - UserArn?: string | undefined; + Status?: ResourceStatus | undefined; /** - *

The Amazon QuickSight namespace that contains the dashboard IDs in this request. - * If you're not using a custom namespace, set Namespace = default.

+ *

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 */ - Namespace?: string | undefined; + DataSetConfigurations?: DataSetConfiguration[] | undefined; /** - *

A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

+ *

The description of the template.

* @public */ - AdditionalDashboardIds?: string[] | undefined; -} + Description?: string | undefined; -/** - *

Output returned from the GetDashboardEmbedUrl operation.

- * @public - */ -export interface GetDashboardEmbedUrlResponse { /** - *

A single-use URL that you can put into your server-side webpage to embed your - * dashboard. This URL is valid for 5 minutes. The API operation provides the URL with an - * auth_code value that enables one (and only one) sign-on to a user session - * that is valid for 10 hours.

+ *

The Amazon Resource Name (ARN) of an analysis or template that was used to create this + * template.

* @public */ - EmbedUrl?: string | undefined; + SourceEntityArn?: string | undefined; /** - *

The HTTP status of the request.

+ *

The ARN of the theme associated with this version of the template.

* @public */ - Status?: number | undefined; + ThemeArn?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

A list of the associated sheets with the unique identifier and name of each sheet.

* @public */ - RequestId?: string | undefined; + Sheets?: Sheet[] | undefined; } /** - *

The identity type specified isn't supported. Supported identity types include - * IAM and QUICKSIGHT.

+ *

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 class IdentityTypeNotSupportedException extends __BaseException { - readonly name: "IdentityTypeNotSupportedException" = "IdentityTypeNotSupportedException"; - readonly $fault: "client" = "client"; - Message?: string | undefined; +export interface Template { /** - *

The Amazon Web Services request ID for this request.

+ *

The Amazon Resource Name (ARN) of the template.

* @public */ - RequestId?: string | undefined; + Arn?: string | undefined; + /** - * @internal + *

The display name of the template.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "IdentityTypeNotSupportedException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, IdentityTypeNotSupportedException.prototype); - this.Message = opts.Message; - this.RequestId = opts.RequestId; - } -} + Name?: string | undefined; -/** - * @public - */ -export interface GetSessionEmbedUrlRequest { /** - *

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

+ *

A structure describing the versions of the template.

* @public */ - AwsAccountId: string | undefined; + Version?: TemplateVersion | undefined; /** - *

The URL you use to access the embedded session. The entry point URL is constrained to - * the following paths:

- *
    - *
  • - *

    - * /start - *

    - *
  • - *
  • - *

    - * /start/analyses - *

    - *
  • - *
  • - *

    - * /start/dashboards - *

    - *
  • - *
  • - *

    - * /start/favorites - *

    - *
  • - *
  • - *

    - * /dashboards/DashboardId - * - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard

    - *
  • - *
  • - *

    - * /analyses/AnalysisId - * - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis

    - *
  • - *
+ *

The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - EntryPoint?: string | undefined; + TemplateId?: string | undefined; /** - *

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

+ *

Time when this was last updated.

* @public */ - SessionLifetimeInMinutes?: number | undefined; + LastUpdatedTime?: Date | undefined; /** - *

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. - * You can use this for any type of Amazon QuickSight users in your account (readers, authors, or - * admins). They need to be authenticated as one of the following:

- *
    - *
  1. - *

    Active Directory (AD) users or group members

    - *
  2. - *
  3. - *

    Invited nonfederated users

    - *
  4. - *
  5. - *

    IAM users and IAM role-based sessions authenticated - * through Federated Single Sign-On using SAML, OpenID Connect, or IAM - * federation

    - *
  6. - *
- *

Omit this parameter for users in the third group, IAM users and IAM role-based - * sessions.

+ *

Time when this was created.

* @public */ - UserArn?: string | undefined; + CreatedTime?: Date | undefined; } /** * @public */ -export interface GetSessionEmbedUrlResponse { +export interface DescribeTemplateResponse { /** - *

A single-use URL that you can put into your server-side web page to embed your - * Amazon QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an - * auth_code value that enables one (and only one) sign-on to a user session - * that is valid for 10 hours.

+ *

The template structure for the object you want to describe.

* @public */ - EmbedUrl?: string | undefined; + Template?: Template | undefined; /** *

The HTTP status of the request.

@@ -2916,116 +2768,166 @@ export interface GetSessionEmbedUrlResponse { RequestId?: string | undefined; } -/** - * @public - * @enum - */ -export const GroupFilterAttribute = { - GROUP_NAME: "GROUP_NAME", -} as const; - /** * @public */ -export type GroupFilterAttribute = (typeof GroupFilterAttribute)[keyof typeof GroupFilterAttribute]; +export interface DescribeTemplateAliasRequest { + /** + *

The ID of the Amazon Web Services account that contains the template alias that you're + * describing.

+ * @public + */ + AwsAccountId: string | undefined; -/** - * @public - * @enum - */ -export const GroupFilterOperator = { - StartsWith: "StartsWith", -} as const; + /** + *

The ID for the template.

+ * @public + */ + TemplateId: string | undefined; -/** - * @public - */ -export type GroupFilterOperator = (typeof GroupFilterOperator)[keyof typeof GroupFilterOperator]; + /** + *

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; +} /** - *

A GroupSearchFilter object that you want to apply to your search.

* @public */ -export interface GroupSearchFilter { +export interface DescribeTemplateAliasResponse { /** - *

The comparison operator that you want to use as a filter, for example "Operator": - * "StartsWith". Currently, the only supported operator is - * StartsWith.

+ *

Information about the template alias.

* @public */ - Operator: GroupFilterOperator | undefined; + TemplateAlias?: TemplateAlias | undefined; /** - *

The name of the value that you want to use as a filter, for example "Name": - * "GROUP_NAME". Currently, the only supported name is - * GROUP_NAME.

+ *

The HTTP status of the request.

* @public */ - Name: GroupFilterAttribute | undefined; + Status?: number | undefined; /** - *

The value of the named item, in this case GROUP_NAME, that you want to use as a filter.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Value: string | undefined; + RequestId?: string | undefined; } /** - *

IAM policy assignment summary.

* @public */ -export interface IAMPolicyAssignmentSummary { +export interface DescribeTemplateDefinitionRequest { /** - *

Assignment name.

+ *

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 */ - AssignmentName?: string | undefined; + AwsAccountId: string | undefined; /** - *

Assignment status.

+ *

The ID of the template that you're describing.

* @public */ - AssignmentStatus?: AssignmentStatus | undefined; + 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 ListAnalysesRequest { +export interface DescribeTemplateDefinitionResponse { /** - *

The ID of the Amazon Web Services account that contains the analyses.

+ *

The descriptive name of the template.

* @public */ - AwsAccountId: string | undefined; + Name?: string | undefined; /** - *

A pagination token that can be used in a subsequent request.

+ *

The ID of the template described.

* @public */ - NextToken?: string | undefined; + TemplateId?: string | undefined; /** - *

The maximum number of results to return.

+ *

Errors associated with the template version.

* @public */ - MaxResults?: number | undefined; -} + Errors?: TemplateError[] | undefined; -/** - * @public - */ -export interface ListAnalysesResponse { /** - *

Metadata describing each of the analyses that are listed.

+ *

Status associated with the template.

+ *
    + *
  • + *

    + * CREATION_IN_PROGRESS + *

    + *
  • + *
  • + *

    + * CREATION_SUCCESSFUL + *

    + *
  • + *
  • + *

    + * CREATION_FAILED + *

    + *
  • + *
  • + *

    + * UPDATE_IN_PROGRESS + *

    + *
  • + *
  • + *

    + * UPDATE_SUCCESSFUL + *

    + *
  • + *
  • + *

    + * UPDATE_FAILED + *

    + *
  • + *
  • + *

    + * DELETED + *

    + *
  • + *
* @public */ - AnalysisSummaryList?: AnalysisSummary[] | undefined; + ResourceStatus?: ResourceStatus | undefined; /** - *

A pagination token that can be used in a subsequent request.

+ *

The ARN of the theme of the template.

* @public */ - NextToken?: string | undefined; + 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.

@@ -3043,41 +2945,41 @@ export interface ListAnalysesResponse { /** * @public */ -export interface ListAssetBundleExportJobsRequest { +export interface DescribeTemplatePermissionsRequest { /** - *

The ID of the Amazon Web Services account that the export jobs were executed in.

+ *

The ID of the Amazon Web Services account that contains the template that you're describing.

* @public */ 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.

+ *

The ID for the template.

* @public */ - MaxResults?: number | undefined; + TemplateId: string | undefined; } /** * @public */ -export interface ListAssetBundleExportJobsResponse { +export interface DescribeTemplatePermissionsResponse { /** - *

A list of export job summaries.

+ *

The ID for the template.

* @public */ - AssetBundleExportJobSummaryList?: AssetBundleExportJobSummary[] | undefined; + TemplateId?: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The Amazon Resource Name (ARN) of the template.

* @public */ - NextToken?: string | undefined; + 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.

@@ -3095,188 +2997,195 @@ export interface ListAssetBundleExportJobsResponse { /** * @public */ -export interface ListAssetBundleImportJobsRequest { +export interface DescribeThemeRequest { /** - *

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 theme that you're describing.

* @public */ AwsAccountId: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The ID for the theme.

* @public */ - NextToken?: string | undefined; + ThemeId: string | undefined; /** - *

The maximum number of results to be returned per request.

+ *

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 */ - MaxResults?: number | undefined; + 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 interface ListAssetBundleImportJobsResponse { - /** - *

A list of import job summaries.

- * @public - */ - AssetBundleImportJobSummaryList?: AssetBundleImportJobSummary[] | undefined; +export const ThemeType = { + ALL: "ALL", + CUSTOM: "CUSTOM", + QUICKSIGHT: "QUICKSIGHT", +} as const; - /** - *

The token for the next set of results, or null if there are no more results.

- * @public - */ - NextToken?: string | undefined; +/** + * @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 Amazon Web Services request ID for this operation.

+ *

The type of error.

* @public */ - RequestId?: string | undefined; + Type?: ThemeErrorType | undefined; /** - *

The HTTP status of the response.

+ *

The error message.

* @public */ - Status?: number | undefined; + Message?: string | undefined; } /** + *

A version of a theme.

* @public */ -export interface ListBrandsRequest { +export interface ThemeVersion { /** - *

The ID of the Amazon Web Services account that owns the brands that you want to list.

+ *

The version number of the theme.

* @public */ - AwsAccountId: string | undefined; + VersionNumber?: number | undefined; /** - *

The maximum number of results to be returned in a single request.

+ *

The Amazon Resource Name (ARN) of the resource.

* @public */ - MaxResults?: number | undefined; + Arn?: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The description of the theme.

* @public */ - NextToken?: string | undefined; -} + Description?: string | undefined; -/** - * @public - */ -export interface ListBrandsResponse { /** - *

The token for the next set of results, or null if there are no more results.

+ *

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 */ - NextToken?: string | undefined; + BaseThemeId?: string | undefined; /** - *

A list of all brands in your Amazon Web Services account. This structure provides basic - * information about each brand.

+ *

The date and time that this theme version was created.

* @public */ - Brands?: BrandSummary[] | undefined; -} + CreatedTime?: Date | undefined; -/** - * @public - */ -export interface ListCustomPermissionsRequest { /** - *

The ID of the Amazon Web Services account that contains the custom permissions profiles that you want to list.

+ *

The theme configuration, which contains all the theme display properties.

* @public */ - AwsAccountId: string | undefined; + Configuration?: ThemeConfiguration | undefined; /** - *

The maximum number of results to return.

+ *

Errors associated with the theme.

* @public */ - MaxResults?: number | undefined; + Errors?: ThemeError[] | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The status of the theme version.

* @public */ - NextToken?: string | undefined; + Status?: ResourceStatus | undefined; } /** + *

Summary information about a theme.

* @public */ -export interface ListCustomPermissionsResponse { +export interface Theme { /** - *

The HTTP status of the request.

+ *

The Amazon Resource Name (ARN) of the theme.

* @public */ - Status?: number | undefined; + Arn?: string | undefined; /** - *

A list of custom permissions profiles.

+ *

The name that the user gives to the theme.

* @public */ - CustomPermissionsList?: CustomPermissions[] | undefined; + Name?: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The identifier that the user gives to the theme.

* @public */ - NextToken?: string | undefined; + ThemeId?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

A version of a theme.

* @public */ - RequestId?: string | undefined; -} + Version?: ThemeVersion | undefined; -/** - * @public - */ -export interface ListDashboardsRequest { /** - *

The ID of the Amazon Web Services account that contains the dashboards that you're - * listing.

+ *

The date and time that the theme was created.

* @public */ - AwsAccountId: string | undefined; + CreatedTime?: Date | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The date and time that the theme was last updated.

* @public */ - NextToken?: string | undefined; + LastUpdatedTime?: Date | undefined; /** - *

The maximum number of results to be returned per request.

+ *

The type of theme, based on how it was created. Valid values include: + * QUICKSIGHT and CUSTOM.

* @public */ - MaxResults?: number | undefined; + Type?: ThemeType | undefined; } /** * @public */ -export interface ListDashboardsResponse { - /** - *

A structure that contains all of the dashboards in your Amazon Web Services account. This structure - * provides basic information about the dashboards.

- * @public - */ - DashboardSummaryList?: DashboardSummary[] | undefined; - +export interface DescribeThemeResponse { /** - *

The token for the next set of results, or null if there are no more results.

+ *

The information about the theme that you are describing.

* @public */ - NextToken?: string | undefined; + Theme?: Theme | undefined; /** *

The HTTP status of the request.

@@ -3294,48 +3203,36 @@ export interface ListDashboardsResponse { /** * @public */ -export interface ListDashboardVersionsRequest { +export interface DescribeThemeAliasRequest { /** - *

The ID of the Amazon Web Services account that contains the dashboard that you're listing versions - * for.

+ *

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 dashboard.

- * @public - */ - DashboardId: string | undefined; - - /** - *

The token for the next set of results, or null if there are no more results.

+ *

The ID for the theme.

* @public */ - NextToken?: string | undefined; + ThemeId: string | undefined; /** - *

The maximum number of results to be returned per request.

+ *

The name of the theme alias that you want to describe.

* @public */ - MaxResults?: number | undefined; + AliasName: string | undefined; } /** * @public */ -export interface ListDashboardVersionsResponse { - /** - *

A structure that contains information about each version of the dashboard.

- * @public - */ - DashboardVersionSummaryList?: DashboardVersionSummary[] | undefined; - +export interface DescribeThemeAliasResponse { /** - *

The token for the next set of results, or null if there are no more results.

+ *

Information about the theme alias.

* @public */ - NextToken?: string | undefined; + ThemeAlias?: ThemeAlias | undefined; /** *

The HTTP status of the request.

@@ -3353,41 +3250,41 @@ export interface ListDashboardVersionsResponse { /** * @public */ -export interface ListDataSetsRequest { +export interface DescribeThemePermissionsRequest { /** - *

The Amazon Web Services account ID.

+ *

The ID of the Amazon Web Services account that contains the theme that you're describing.

* @public */ 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.

+ *

The ID for the theme that you want to describe permissions for.

* @public */ - MaxResults?: number | undefined; + ThemeId: string | undefined; } /** * @public */ -export interface ListDataSetsResponse { +export interface DescribeThemePermissionsResponse { /** - *

The list of dataset summaries.

+ *

The ID for the theme.

* @public */ - DataSetSummaries?: DataSetSummary[] | undefined; + ThemeId?: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The Amazon Resource Name (ARN) of the theme.

* @public */ - NextToken?: string | undefined; + 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.

@@ -3405,7 +3302,7 @@ export interface ListDataSetsResponse { /** * @public */ -export interface ListDataSourcesRequest { +export interface DescribeTopicRequest { /** *

The Amazon Web Services account ID.

* @public @@ -3413,33 +3310,33 @@ export interface ListDataSourcesRequest { 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.

+ *

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 */ - MaxResults?: number | undefined; + TopicId: string | undefined; } /** * @public */ -export interface ListDataSourcesResponse { +export interface DescribeTopicResponse { /** - *

A list of data sources.

+ *

The Amazon Resource Name (ARN) of the topic.

* @public */ - DataSources?: DataSource[] | undefined; + Arn?: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

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 */ - NextToken?: string | undefined; + TopicId?: string | undefined; + + /** + *

The definition of a topic.

+ * @public + */ + Topic?: TopicDetails | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -3457,53 +3354,48 @@ export interface ListDataSourcesResponse { /** * @public */ -export interface ListFolderMembersRequest { +export interface DescribeTopicPermissionsRequest { /** - *

The ID for the Amazon Web Services account that contains the folder.

+ *

The ID of the Amazon Web Services account that contains the topic that you want + * described.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the folder.

- * @public - */ - FolderId: 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.

+ *

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 */ - MaxResults?: number | undefined; + TopicId: string | undefined; } /** * @public */ -export interface ListFolderMembersResponse { +export interface DescribeTopicPermissionsResponse { /** - *

The HTTP status of the request.

+ *

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 */ - Status?: number | undefined; + TopicId?: string | undefined; /** - *

A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.

+ *

The Amazon Resource Name (ARN) of the topic.

* @public */ - FolderMemberList?: MemberIdArnPair[] | undefined; + TopicArn?: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

A list of resource permissions that are configured to the topic.

* @public */ - NextToken?: string | undefined; + Permissions?: ResourcePermission[] | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -3515,144 +3407,176 @@ export interface ListFolderMembersResponse { /** * @public */ -export interface ListFoldersRequest { +export interface DescribeTopicRefreshRequest { /** - *

The ID for the Amazon Web Services account that contains the folder.

+ *

The ID of the Amazon Web Services account that contains the topic whose refresh you want + * to describe.

* @public */ AwsAccountId: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

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 */ - NextToken?: string | undefined; + TopicId: string | undefined; /** - *

The maximum number of results to be returned per request.

+ *

The ID of the refresh, which is performed when the topic is created or updated.

* @public */ - MaxResults?: number | undefined; + RefreshId: string | undefined; } /** * @public + * @enum */ -export interface ListFoldersResponse { +export const TopicRefreshStatus = { + CANCELLED: "CANCELLED", + COMPLETED: "COMPLETED", + FAILED: "FAILED", + INITIALIZED: "INITIALIZED", + RUNNING: "RUNNING", +} as const; + +/** + * @public + */ +export type TopicRefreshStatus = (typeof TopicRefreshStatus)[keyof typeof TopicRefreshStatus]; + +/** + *

The details about the refresh of a topic.

+ * @public + */ +export interface TopicRefreshDetails { /** - *

The HTTP status of the request.

+ *

The Amazon Resource Name (ARN) of the topic refresh.

* @public */ - Status?: number | undefined; + RefreshArn?: string | undefined; /** - *

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

+ *

The ID of the refresh, which occurs as a result of topic creation or topic update.

* @public */ - FolderSummaryList?: FolderSummary[] | undefined; + RefreshId?: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.

* @public */ - NextToken?: string | undefined; + RefreshStatus?: TopicRefreshStatus | undefined; +} + +/** + * @public + */ +export interface DescribeTopicRefreshResponse { + /** + *

Details of the refresh, which is performed when the topic is created or updated.

+ * @public + */ + RefreshDetails?: TopicRefreshDetails | 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 ListFoldersForResourceRequest { +export interface DescribeTopicRefreshScheduleRequest { /** - *

The ID for the Amazon Web Services account that contains the resource.

+ *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** - *

The Amazon Resource Name (ARN) the resource whose folders you need to list.

- * @public - */ - ResourceArn: string | undefined; - - /** - *

The token for the next set of results, or null if there are no more results.

+ *

The ID of the topic that contains the refresh schedule that you want to describe. This + * ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - NextToken?: string | undefined; + TopicId: string | undefined; /** - *

The maximum number of results to be returned per request.

+ *

The ID of the dataset.

* @public */ - MaxResults?: number | undefined; + DatasetId: string | undefined; } /** * @public */ -export interface ListFoldersForResourceResponse { +export interface DescribeTopicRefreshScheduleResponse { /** - *

The HTTP status of the request.

+ *

The ID of the topic that contains the refresh schedule that you want to describe. This + * ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - Status?: number | undefined; + TopicId?: string | undefined; /** - *

A list that contains the Amazon Resource Names (ARNs) of all folders that the resource is a member of.

+ *

The Amazon Resource Name (ARN) of the topic.

* @public */ - Folders?: string[] | undefined; + TopicArn?: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The Amazon Resource Name (ARN) of the dataset.

* @public */ - NextToken?: string | undefined; + DatasetArn?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The definition of a refresh schedule.

* @public */ - RequestId?: string | undefined; -} + RefreshSchedule?: TopicRefreshSchedule | undefined; -/** - * @public - */ -export interface ListGroupMembershipsRequest { /** - *

The name of the group that you want to see a membership list of.

+ *

The HTTP status of the request.

* @public */ - GroupName: string | undefined; + Status?: number | undefined; /** - *

A pagination token that can be used in a subsequent request.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - NextToken?: string | undefined; + RequestId?: string | undefined; +} +/** + * @public + */ +export interface DescribeUserRequest { /** - *

The maximum number of results to return from this request.

+ *

The name of the user that you want to describe.

* @public */ - MaxResults?: number | undefined; + UserName: string | undefined; /** - *

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the + *

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 */ AwsAccountId: string | undefined; /** - *

The namespace of the group that you want a list of users from.

+ *

The namespace. Currently, you should set this to default.

* @public */ Namespace: string | undefined; @@ -3660,1105 +3584,1452 @@ export interface ListGroupMembershipsRequest { /** * @public + * @enum */ -export interface ListGroupMembershipsResponse { - /** - *

The list of the members of the group.

- * @public - */ - GroupMemberList?: GroupMember[] | undefined; +export const IdentityType = { + IAM: "IAM", + IAM_IDENTITY_CENTER: "IAM_IDENTITY_CENTER", + QUICKSIGHT: "QUICKSIGHT", +} as const; + +/** + * @public + */ +export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType]; + +/** + * @public + * @enum + */ +export const UserRole = { + ADMIN: "ADMIN", + ADMIN_PRO: "ADMIN_PRO", + AUTHOR: "AUTHOR", + AUTHOR_PRO: "AUTHOR_PRO", + READER: "READER", + READER_PRO: "READER_PRO", + RESTRICTED_AUTHOR: "RESTRICTED_AUTHOR", + RESTRICTED_READER: "RESTRICTED_READER", +} as const; + +/** + * @public + */ +export type UserRole = (typeof UserRole)[keyof typeof UserRole]; +/** + *

A registered user of Amazon QuickSight.

+ * @public + */ +export interface User { /** - *

A pagination token that can be used in a subsequent request.

+ *

The Amazon Resource Name (ARN) for the user.

* @public */ - NextToken?: string | undefined; + Arn?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is + * N/A when the value for IdentityType is IAM + * and the corresponding IAM user is deleted.

* @public */ - RequestId?: string | undefined; + UserName?: string | undefined; /** - *

The HTTP status of the request.

+ *

The user's email address.

* @public */ - Status?: number | undefined; -} + Email?: string | undefined; -/** - * @public - */ -export interface ListGroupsRequest { /** - *

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 Amazon QuickSight role for the user. The user role can be one of the + * following:.

+ *
    + *
  • + *

    + * READER: A user who has read-only access to dashboards.

    + *
  • + *
  • + *

    + * AUTHOR: A user who can create data sources, datasets, analyses, + * and dashboards.

    + *
  • + *
  • + *

    + * ADMIN: A user who is an author, who can also manage Amazon + * Amazon QuickSight settings.

    + *
  • + *
  • + *

    + * READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

    + *
  • + *
  • + *

    + * AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

    + *
  • + *
  • + *

    + * ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.

    + *
  • + *
  • + *

    + * RESTRICTED_READER: This role isn't currently available for + * use.

    + *
  • + *
  • + *

    + * RESTRICTED_AUTHOR: This role isn't currently available for + * use.

    + *
  • + *
* @public */ - AwsAccountId: string | undefined; + Role?: UserRole | undefined; /** - *

A pagination token that can be used in a subsequent request.

+ *

The type of identity authentication used by the user.

* @public */ - NextToken?: string | undefined; + IdentityType?: IdentityType | undefined; /** - *

The maximum number of results to return.

+ *

The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a + * password.

* @public */ - MaxResults?: number | undefined; + Active?: boolean | undefined; /** - *

The namespace that you want a list of groups from.

+ *

The principal ID of the user.

* @public */ - Namespace: string | undefined; -} + PrincipalId?: string | undefined; -/** - * @public - */ -export interface ListGroupsResponse { /** - *

The list of the groups.

+ *

The custom permissions profile associated with this user.

* @public */ - GroupList?: Group[] | undefined; + CustomPermissionsName?: string | undefined; /** - *

A pagination token that can be used in a subsequent request.

+ *

The type of supported external login provider that provides identity to let the user + * federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.

+ *
    + *
  • + *

    + * COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.

    + *
  • + *
  • + *

    + * CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.

    + *
  • + *
* @public */ - NextToken?: string | undefined; + ExternalLoginFederationProviderType?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The URL of the external login provider.

* @public */ - RequestId?: string | undefined; + ExternalLoginFederationProviderUrl?: string | undefined; /** - *

The HTTP status of the request.

+ *

The identity ID for the user in the external login provider.

* @public */ - Status?: number | undefined; + ExternalLoginId?: string | undefined; } /** * @public */ -export interface ListIAMPolicyAssignmentsRequest { +export interface DescribeUserResponse { /** - *

The ID of the Amazon Web Services account that contains these IAM policy - * assignments.

+ *

The user name.

* @public */ - AwsAccountId: string | undefined; + User?: User | undefined; /** - *

The status of the assignments.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AssignmentStatus?: AssignmentStatus | undefined; + RequestId?: string | undefined; /** - *

The namespace for the assignments.

+ *

The HTTP status of the request.

* @public */ - Namespace: string | undefined; + Status?: number | undefined; +} +/** + * @public + */ +export interface DescribeVPCConnectionRequest { /** - *

The token for the next set of results, or null if there are no more results.

+ *

The Amazon Web Services account ID of the account that contains the VPC connection that + * you want described.

* @public */ - NextToken?: string | undefined; + AwsAccountId: string | undefined; /** - *

The maximum number of results to be returned per request.

+ *

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 */ - MaxResults?: number | undefined; + VPCConnectionId: string | undefined; } /** * @public + * @enum */ -export interface ListIAMPolicyAssignmentsResponse { +export const NetworkInterfaceStatus = { + ATTACHMENT_FAILED_ROLLBACK_FAILED: "ATTACHMENT_FAILED_ROLLBACK_FAILED", + AVAILABLE: "AVAILABLE", + CREATING: "CREATING", + CREATION_FAILED: "CREATION_FAILED", + DELETED: "DELETED", + DELETING: "DELETING", + DELETION_FAILED: "DELETION_FAILED", + DELETION_SCHEDULED: "DELETION_SCHEDULED", + UPDATE_FAILED: "UPDATE_FAILED", + UPDATING: "UPDATING", +} as const; + +/** + * @public + */ +export type NetworkInterfaceStatus = (typeof NetworkInterfaceStatus)[keyof typeof NetworkInterfaceStatus]; + +/** + *

The structure that contains information about a network interface.

+ * @public + */ +export interface NetworkInterface { + /** + *

The subnet ID associated with the network interface.

+ * @public + */ + SubnetId?: string | undefined; + /** - *

Information describing the IAM policy assignments.

+ *

The availability zone that the network interface resides in.

* @public */ - IAMPolicyAssignments?: IAMPolicyAssignmentSummary[] | undefined; + AvailabilityZone?: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

An error message.

* @public */ - NextToken?: string | undefined; + ErrorMessage?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The status of the network interface.

* @public */ - RequestId?: string | undefined; + Status?: NetworkInterfaceStatus | undefined; /** - *

The HTTP status of the request.

+ *

The network interface ID.

* @public */ - Status?: number | undefined; + NetworkInterfaceId?: string | undefined; } /** + *

The structure of a VPC connection.

* @public */ -export interface ListIAMPolicyAssignmentsForUserRequest { +export interface VPCConnection { /** - *

The ID of the Amazon Web Services account that contains the assignments.

+ *

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 */ - AwsAccountId: string | undefined; + VPCConnectionId?: string | undefined; /** - *

The name of the user.

+ *

The Amazon Resource Name (ARN) of the VPC connection.

* @public */ - UserName: string | undefined; + Arn?: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The display name for the VPC connection.

* @public */ - NextToken?: string | undefined; + Name?: string | undefined; /** - *

The maximum number of results to be returned per request.

+ *

The Amazon EC2 VPC ID associated with the VPC connection.

* @public */ - MaxResults?: number | undefined; + VPCId?: string | undefined; /** - *

The namespace of the assignment.

+ *

The Amazon EC2 security group IDs associated with the VPC connection.

* @public */ - Namespace: string | undefined; -} + SecurityGroupIds?: string[] | undefined; -/** - * @public - */ -export interface ListIAMPolicyAssignmentsForUserResponse { /** - *

The active assignments for this user.

+ *

A list of IP addresses of DNS resolver endpoints for the VPC connection.

* @public */ - ActiveAssignments?: ActiveIAMPolicyAssignment[] | undefined; + DnsResolvers?: string[] | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The status of the VPC connection.

* @public */ - RequestId?: string | undefined; + Status?: VPCConnectionResourceStatus | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The availability status of the VPC connection.

* @public */ - NextToken?: string | undefined; + AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; /** - *

The HTTP status of the request.

+ *

A list of network interfaces.

* @public */ - Status?: number | undefined; -} + NetworkInterfaces?: NetworkInterface[] | undefined; -/** - * @public - */ -export interface ListIdentityPropagationConfigsRequest { /** - *

The ID of the Amazon Web Services account that contain the identity propagation configurations of.

+ *

The ARN of the + * IAM role associated with the VPC + * connection.

* @public */ - AwsAccountId: string | undefined; + RoleArn?: string | undefined; /** - *

The maximum number of results to be returned.

+ *

The time that the VPC connection was created.

* @public */ - MaxResults?: number | undefined; + CreatedTime?: Date | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The time that the VPC connection was last updated.

* @public */ - NextToken?: string | undefined; + LastUpdatedTime?: Date | undefined; } /** * @public */ -export interface ListIdentityPropagationConfigsResponse { +export interface DescribeVPCConnectionResponse { /** - *

A list of services and their authorized targets that the Amazon QuickSight IAM Identity Center application can access.

+ *

A response object that provides information for the specified VPC connection.

* @public */ - Services?: AuthorizedTargetsByService[] | undefined; + VPCConnection?: VPCConnection | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - NextToken?: string | 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; } /** + *

The domain specified isn't on the allow list. All domains for embedded dashboards must be + * added to the approved list by an Amazon QuickSight admin.

* @public */ -export interface ListIngestionsRequest { +export class DomainNotWhitelistedException extends __BaseException { + readonly name: "DomainNotWhitelistedException" = "DomainNotWhitelistedException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; /** - *

The ID of the dataset used in the ingestion.

+ *

The Amazon Web Services request ID for this request.

* @public */ - DataSetId: string | undefined; - + RequestId?: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

- * @public + * @internal */ - NextToken?: string | undefined; + constructor(opts: __ExceptionOptionType) { + super({ + name: "DomainNotWhitelistedException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, DomainNotWhitelistedException.prototype); + this.Message = opts.Message; + this.RequestId = opts.RequestId; + } +} - /** - *

The Amazon Web Services account ID.

- * @public - */ - AwsAccountId: string | undefined; +/** + * @public + * @enum + */ +export const EmbeddingIdentityType = { + ANONYMOUS: "ANONYMOUS", + IAM: "IAM", + QUICKSIGHT: "QUICKSIGHT", +} as const; - /** - *

The maximum number of results to be returned per request.

- * @public - */ - MaxResults?: number | undefined; -} +/** + * @public + */ +export type EmbeddingIdentityType = (typeof EmbeddingIdentityType)[keyof typeof EmbeddingIdentityType]; /** + *

An entry that appears when a KeyRegistration update to Amazon QuickSight fails.

* @public */ -export interface ListIngestionsResponse { +export interface FailedKeyRegistrationEntry { /** - *

A list of the ingestions.

+ *

The ARN of the KMS key that failed to update.

* @public */ - Ingestions?: Ingestion[] | undefined; + KeyArn?: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

A message that provides information about why a FailedKeyRegistrationEntry error occurred.

* @public */ - NextToken?: string | undefined; + Message: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The HTTP status of a FailedKeyRegistrationEntry error.

* @public */ - RequestId?: string | undefined; + StatusCode: number | undefined; /** - *

The HTTP status of the request.

+ *

A boolean that indicates whether a FailedKeyRegistrationEntry resulted from user error. If the value of this property is True, the error was caused by user error. If the value of this property is False, the error occurred on the backend. If your job continues fail and with a False + * SenderFault value, contact Amazon Web Services Support.

* @public */ - Status?: number | undefined; + SenderFault: boolean | undefined; } /** * @public + * @enum */ -export interface ListNamespacesRequest { - /** - *

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.

- * @public - */ - AwsAccountId: string | undefined; - - /** - *

A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

- * @public - */ - NextToken?: string | undefined; - - /** - *

The maximum number of results to return.

- * @public - */ - MaxResults?: number | undefined; -} +export const FolderFilterAttribute = { + DIRECT_QUICKSIGHT_OWNER: "DIRECT_QUICKSIGHT_OWNER", + DIRECT_QUICKSIGHT_SOLE_OWNER: "DIRECT_QUICKSIGHT_SOLE_OWNER", + DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER", + FOLDER_NAME: "FOLDER_NAME", + PARENT_FOLDER_ARN: "PARENT_FOLDER_ARN", + QUICKSIGHT_OWNER: "QUICKSIGHT_OWNER", + QUICKSIGHT_VIEWER_OR_OWNER: "QUICKSIGHT_VIEWER_OR_OWNER", +} as const; /** * @public */ -export interface ListNamespacesResponse { - /** - *

The information about the namespaces in this Amazon Web Services account. The response includes - * the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and - * identity store.

- * @public - */ - Namespaces?: NamespaceInfoV2[] | undefined; - - /** - *

A unique pagination token that can be used in a subsequent request. Receiving NextToken in your response inticates that there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

- * @public - */ - NextToken?: string | undefined; +export type FolderFilterAttribute = (typeof FolderFilterAttribute)[keyof typeof FolderFilterAttribute]; +/** + *

An object that consists of a member Amazon Resource Name (ARN) and a member ID.

+ * @public + */ +export interface MemberIdArnPair { /** - *

The Amazon Web Services request ID for this operation.

+ *

The ID of the member.

* @public */ - RequestId?: string | undefined; + MemberId?: string | undefined; /** - *

The HTTP status of the request.

+ *

The Amazon Resource Name (ARN) of the member.

* @public */ - Status?: number | undefined; + MemberArn?: string | undefined; } /** + *

A filter to use to search an Amazon QuickSight folder.

* @public */ -export interface ListRefreshSchedulesRequest { +export interface FolderSearchFilter { /** - *

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 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":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value FOLDER_NAME.

+ * @public + */ + Operator?: FilterOperator | undefined; + + /** + *

The name of a value that you want to use in the 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 folders with that ARN listed as one of the folder'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 folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered.

    + *
  • + *
  • + *

    + * DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered.

    + *
  • + *
  • + *

    + * DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders 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 folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered.

    + *
  • + *
  • + *

    + * FOLDER_NAME: Any folders whose names have a substring match to this value will be returned.

    + *
  • + *
  • + *

    + * PARENT_FOLDER_ARN: Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned.

    + *
  • + *
* @public */ - AwsAccountId: string | undefined; + Name?: FolderFilterAttribute | undefined; /** - *

The ID of the dataset.

+ *

The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId".

* @public */ - DataSetId: string | undefined; + Value?: string | undefined; } /** + *

A summary of information about an existing Amazon QuickSight folder.

* @public */ -export interface ListRefreshSchedulesResponse { - /** - *

The list of refresh schedules for the dataset.

- * @public - */ - RefreshSchedules?: RefreshSchedule[] | undefined; - +export interface FolderSummary { /** - *

The HTTP status of the request.

+ *

The Amazon Resource Name (ARN) of the folder.

* @public */ - Status?: number | undefined; + Arn?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The ID of the folder.

* @public */ - RequestId?: string | undefined; -} + FolderId?: string | undefined; -/** - * @public - */ -export interface ListRoleMembershipsRequest { /** - *

The name of the role.

+ *

The display name of the folder.

* @public */ - Role: Role | undefined; + Name?: string | undefined; /** - *

A pagination token that can be used in a subsequent request.

+ *

The type of folder.

* @public */ - NextToken?: string | undefined; + FolderType?: FolderType | undefined; /** - *

The maximum number of results to return.

+ *

The time that the folder was created.

* @public */ - MaxResults?: number | undefined; + CreatedTime?: Date | 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 time that the folder was last updated.

* @public */ - AwsAccountId: string | undefined; + LastUpdatedTime?: Date | undefined; /** - *

The namespace that includes the role.

+ *

The sharing scope of the folder.

* @public */ - Namespace: string | undefined; + SharingModel?: SharingModel | undefined; } /** + *

The key-value pair used for the row-level security tags feature.

* @public */ -export interface ListRoleMembershipsResponse { - /** - *

The list of groups associated with a role

- * @public - */ - MembersList?: string[] | undefined; - - /** - *

A pagination token that can be used in a subsequent request.

- * @public - */ - NextToken?: string | undefined; - - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; - +export interface SessionTag { /** - *

The HTTP status of the request.

+ *

The key for the tag.

* @public */ - Status?: number | undefined; -} + Key: string | undefined; -/** - * @public - */ -export interface ListTagsForResourceRequest { /** - *

The Amazon Resource Name (ARN) of the resource that you want a list of tags for.

+ *

The value that you want to assign the tag.

* @public */ - ResourceArn: string | undefined; + Value: string | undefined; } /** * @public */ -export interface ListTagsForResourceResponse { +export interface GenerateEmbedUrlForAnonymousUserRequest { /** - *

Contains a map of the key-value pairs for the resource tag or tags assigned to the - * resource.

+ *

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

* @public */ - Tags?: Tag[] | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

* @public */ - RequestId?: string | undefined; + SessionLifetimeInMinutes?: number | undefined; /** - *

The HTTP status of the request.

+ *

The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

* @public */ - Status?: number | undefined; -} + Namespace: string | undefined; -/** - * @public - */ -export interface ListTemplateAliasesRequest { /** - *

The ID of the Amazon Web Services account that contains the template aliases that you're listing.

+ *

The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

+ *

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

* @public */ - AwsAccountId: string | undefined; + SessionTags?: SessionTag[] | undefined; /** - *

The ID for the template.

+ *

The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user + * is authorized to access during the lifetime of the session.

+ *

If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the + * account that you want the user to be able to view.

+ *

If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.

+ *

Currently, you can pass up to 25 theme ARNs in each API call.

* @public */ - TemplateId: string | undefined; + AuthorizedResourceArns: string[] | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The configuration of the experience that you are embedding.

* @public */ - NextToken?: string | undefined; + ExperienceConfiguration: AnonymousUserEmbeddingExperienceConfiguration | undefined; /** - *

The maximum number of results to be returned per request.

+ *

The domains that you want to add to the allow list for access to the generated URL that + * is then embedded. This optional parameter overrides the static domains that are + * configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it + * allows only the domains that you include in this parameter. You can list up to three + * domains or subdomains in each API call.

+ *

To include all subdomains under a specific domain to the allow list, use *. + * For example, https://*.sapp.amazon.com includes all subdomains under + * https://sapp.amazon.com.

* @public */ - MaxResults?: number | undefined; + AllowedDomains?: string[] | undefined; } /** * @public */ -export interface ListTemplateAliasesResponse { +export interface GenerateEmbedUrlForAnonymousUserResponse { /** - *

A structure containing the list of the template's aliases.

+ *

The embed URL for the dashboard.

* @public */ - TemplateAliasList?: TemplateAlias[] | undefined; + EmbedUrl: string | undefined; /** *

The HTTP status of the request.

* @public */ - Status?: number | undefined; + Status: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ - RequestId?: string | undefined; + RequestId: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.

* @public */ - NextToken?: string | undefined; + AnonymousUserArn: string | undefined; } /** + *

The number of minutes specified for the lifetime of a session isn't valid. The session + * lifetime must be 15-600 minutes.

* @public */ -export interface ListTemplatesRequest { - /** - *

The ID of the Amazon Web Services account that contains the templates that you're listing.

- * @public - */ - AwsAccountId: string | undefined; - +export class SessionLifetimeInMinutesInvalidException extends __BaseException { + readonly name: "SessionLifetimeInMinutesInvalidException" = "SessionLifetimeInMinutesInvalidException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The Amazon Web Services request ID for this request.

* @public */ - NextToken?: string | undefined; - + RequestId?: string | undefined; /** - *

The maximum number of results to be returned per request.

- * @public + * @internal */ - MaxResults?: number | undefined; + constructor(opts: __ExceptionOptionType) { + super({ + name: "SessionLifetimeInMinutesInvalidException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, SessionLifetimeInMinutesInvalidException.prototype); + this.Message = opts.Message; + this.RequestId = opts.RequestId; + } } /** - *

The template summary.

+ *

This error indicates that you are calling an embedding operation in Amazon QuickSight + * without the required pricing plan on your Amazon Web Services account. Before you can use embedding + * for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You + * can do this on the Manage Amazon QuickSight page.

+ *

After capacity pricing is added, you can use the + * + * GetDashboardEmbedUrl + * API operation with the + * --identity-type ANONYMOUS option.

* @public */ -export interface TemplateSummary { - /** - *

A summary of a template.

- * @public - */ - Arn?: string | undefined; - - /** - *

The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

- * @public - */ - TemplateId?: string | undefined; - - /** - *

A display name for the template.

- * @public - */ - Name?: string | undefined; - - /** - *

A structure containing a list of version numbers for the template summary.

- * @public - */ - LatestVersionNumber?: number | undefined; - +export class UnsupportedPricingPlanException extends __BaseException { + readonly name: "UnsupportedPricingPlanException" = "UnsupportedPricingPlanException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; /** - *

The last time that this template was created.

+ *

The Amazon Web Services request ID for this request.

* @public */ - CreatedTime?: Date | undefined; - + RequestId?: string | undefined; /** - *

The last time that this template was updated.

- * @public + * @internal */ - LastUpdatedTime?: Date | undefined; + constructor(opts: __ExceptionOptionType) { + super({ + name: "UnsupportedPricingPlanException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, UnsupportedPricingPlanException.prototype); + this.Message = opts.Message; + this.RequestId = opts.RequestId; + } } /** + *

The state perssitence configuration of an embedded dashboard.

* @public */ -export interface ListTemplatesResponse { +export interface StatePersistenceConfigurations { /** - *

A structure containing information about the templates in the list.

+ *

Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.

* @public */ - TemplateSummaryList?: TemplateSummary[] | undefined; + Enabled: boolean | undefined; +} +/** + *

The feature configuration for an embedded dashboard.

+ * @public + */ +export interface RegisteredUserDashboardFeatureConfigurations { /** - *

The token for the next set of results, or null if there are no more results.

+ *

The state persistence settings of an embedded dashboard.

* @public */ - NextToken?: string | undefined; + StatePersistence?: StatePersistenceConfigurations | undefined; /** - *

The HTTP status of the request.

+ *

The shared view settings of an embedded dashboard.

* @public */ - Status?: number | undefined; + SharedView?: SharedViewConfigurations | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The bookmarks configuration for an embedded dashboard in Amazon QuickSight.

* @public */ - RequestId?: string | undefined; + Bookmarks?: BookmarksConfigurations | undefined; } /** + *

Information about the dashboard you want to embed.

* @public */ -export interface ListTemplateVersionsRequest { +export interface RegisteredUserDashboardEmbeddingConfiguration { /** - *

The ID of the Amazon Web Services account that contains the templates that you're listing.

+ *

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.

+ *

If the user does not have permission to view this dashboard, they see a permissions error message.

* @public */ - AwsAccountId: string | undefined; + InitialDashboardId: string | undefined; /** - *

The ID for the template.

+ *

The feature configurations of an embbedded Amazon QuickSight dashboard.

* @public */ - TemplateId: string | undefined; + FeatureConfigurations?: RegisteredUserDashboardFeatureConfigurations | undefined; +} +/** + *

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

+ * @public + */ +export interface RegisteredUserDashboardVisualEmbeddingConfiguration { /** - *

The token for the next set of results, or null if there are no more results.

+ *

The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

+ *

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

* @public */ - NextToken?: string | undefined; + InitialDashboardVisualId: DashboardVisualId | undefined; +} +/** + *

An object that provides information about the configuration of a Generative Q&A experience.

+ * @public + */ +export interface RegisteredUserGenerativeQnAEmbeddingConfiguration { /** - *

The maximum number of results to be returned per request.

+ *

The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience. + * You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening + * a topic. The ID is in the URL for the topic that you open.

+ *

If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.

* @public */ - MaxResults?: number | undefined; + InitialTopicId?: string | undefined; } /** - *

The template version.

+ *

Information about the Q search bar embedding experience.

* @public */ -export interface TemplateVersionSummary { +export interface RegisteredUserQSearchBarEmbeddingConfiguration { /** - *

The Amazon Resource Name (ARN) of the template version.

+ *

The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Amazon QuickSight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers + * are allowed to select other topics from the list of available topics.

+ *

If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.

* @public */ - Arn?: string | undefined; + InitialTopicId?: string | undefined; +} +/** + *

The feature configurations of an embedded Amazon QuickSight console.

+ * @public + */ +export interface RegisteredUserConsoleFeatureConfigurations { /** - *

The version number of the template version.

+ *

The state persistence configurations of an embedded Amazon QuickSight console.

* @public */ - VersionNumber?: number | undefined; + StatePersistence?: StatePersistenceConfigurations | undefined; /** - *

The time that this template version was created.

+ *

The shared view settings of an embedded dashboard.

* @public */ - CreatedTime?: Date | undefined; + SharedView?: SharedViewConfigurations | undefined; +} +/** + *

Information about the Amazon QuickSight console that you want to embed.

+ * @public + */ +export interface RegisteredUserQuickSightConsoleEmbeddingConfiguration { /** - *

The status of the template version.

+ *

The initial URL path for the Amazon QuickSight console. InitialPath is required.

+ *

The entry point URL is constrained to the following paths:

+ *
    + *
  • + *

    + * /start + *

    + *
  • + *
  • + *

    + * /start/analyses + *

    + *
  • + *
  • + *

    + * /start/dashboards + *

    + *
  • + *
  • + *

    + * /start/favorites + *

    + *
  • + *
  • + *

    + * /dashboards/DashboardId. DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard.

    + *
  • + *
  • + *

    + * /analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis.

    + *
  • + *
* @public */ - Status?: ResourceStatus | undefined; + InitialPath?: string | undefined; /** - *

The description of the template version.

+ *

The embedding configuration of an embedded Amazon QuickSight console.

* @public */ - Description?: string | undefined; + FeatureConfigurations?: RegisteredUserConsoleFeatureConfigurations | undefined; } /** + *

The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.

+ * + *

Exactly one of the experience configurations is required. You can choose + * Dashboard or QuickSightConsole. You cannot choose more + * than one experience configuration.

+ *
* @public */ -export interface ListTemplateVersionsResponse { +export interface RegisteredUserEmbeddingExperienceConfiguration { /** - *

A structure containing a list of all the versions of the specified template.

+ *

The configuration details for providing a dashboard embedding experience.

* @public */ - TemplateVersionSummaryList?: TemplateVersionSummary[] | undefined; + Dashboard?: RegisteredUserDashboardEmbeddingConfiguration | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User + * Guide.

+ *

Use + * GenerateEmbedUrlForRegisteredUser + * + * where + * you want to provide an authoring portal that allows users to create data sources, + * datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console + * needs to belong to the author or admin security cohort. If you want to restrict permissions + * to some of these features, add a custom permissions profile to the user with the + * + * UpdateUser + * API operation. Use the + * RegisterUser + * API operation to add a new user with a custom permission profile attached. For more + * information, see the following sections in the Amazon QuickSight User + * Guide:

+ * + *

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

* @public */ - NextToken?: string | undefined; + QuickSightConsole?: RegisteredUserQuickSightConsoleEmbeddingConfiguration | undefined; /** - *

The HTTP status of the request.

+ *

The configuration details for embedding the Q search bar.

+ *

For more information about embedding the Q search bar, see Embedding Overview in + * the Amazon QuickSight User Guide.

* @public */ - Status?: number | undefined; + QSearchBar?: RegisteredUserQSearchBarEmbeddingConfiguration | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The type of embedding experience. In this case, Amazon QuickSight visuals.

* @public */ - RequestId?: string | undefined; + DashboardVisual?: RegisteredUserDashboardVisualEmbeddingConfiguration | undefined; + + /** + *

The configuration details for embedding the Generative Q&A experience.

+ *

For more information about embedding the Generative Q&A experience, see Embedding Overview in + * the Amazon QuickSight User Guide.

+ * @public + */ + GenerativeQnA?: RegisteredUserGenerativeQnAEmbeddingConfiguration | undefined; } /** * @public */ -export interface ListThemeAliasesRequest { +export interface GenerateEmbedUrlForRegisteredUserRequest { /** - *

The ID of the Amazon Web Services account that contains the theme aliases that you're listing.

+ *

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the theme.

+ *

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

* @public */ - ThemeId: string | undefined; + SessionLifetimeInMinutes?: number | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The Amazon Resource Name for the registered user.

* @public */ - NextToken?: string | undefined; + UserArn: string | undefined; /** - *

The maximum number of results to be returned per request.

+ *

The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

* @public */ - MaxResults?: number | undefined; + ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfiguration | undefined; + + /** + *

The domains that you want to add to the allow list for access to the generated URL that + * is then embedded. This optional parameter overrides the static domains that are + * configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it + * allows only the domains that you include in this parameter. You can list up to three + * domains or subdomains in each API call.

+ *

To include all subdomains under a specific domain to the allow list, use *. + * For example, https://*.sapp.amazon.com includes all subdomains under + * https://sapp.amazon.com.

+ * @public + */ + AllowedDomains?: string[] | undefined; } /** * @public */ -export interface ListThemeAliasesResponse { +export interface GenerateEmbedUrlForRegisteredUserResponse { /** - *

A structure containing the list of the theme's aliases.

+ *

The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.

* @public */ - ThemeAliasList?: ThemeAlias[] | undefined; + EmbedUrl: string | undefined; /** *

The HTTP status of the request.

* @public */ - Status?: number | undefined; + Status: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ - RequestId?: string | undefined; + RequestId: string | undefined; +} +/** + *

The user with the provided name isn't found. This error can happen in any operation + * that requires finding a user based on a provided user name, such as + * DeleteUser, DescribeUser, and so on.

+ * @public + */ +export class QuickSightUserNotFoundException extends __BaseException { + readonly name: "QuickSightUserNotFoundException" = "QuickSightUserNotFoundException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The Amazon Web Services request ID for this request.

* @public */ - NextToken?: string | undefined; + RequestId?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType) { + super({ + name: "QuickSightUserNotFoundException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, QuickSightUserNotFoundException.prototype); + this.Message = opts.Message; + this.RequestId = opts.RequestId; + } } /** * @public */ -export interface ListThemesRequest { +export interface GetDashboardEmbedUrlRequest { /** - *

The ID of the Amazon Web Services account that contains the themes that you're listing.

+ *

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

* @public */ AwsAccountId: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The ID for the dashboard, also added to the Identity and Access Management (IAM) + * policy.

* @public */ - NextToken?: string | undefined; + DashboardId: string | undefined; /** - *

The maximum number of results to be returned per request.

+ *

The authentication method that the user uses to sign in.

* @public */ - MaxResults?: number | undefined; + IdentityType: EmbeddingIdentityType | undefined; /** - *

The type of themes that you want to list. Valid options include the following:

- *
    - *
  • - *

    - * ALL (default)- Display all existing themes.

    - *
  • - *
  • - *

    - * CUSTOM - Display only the themes created by people using Amazon QuickSight.

    - *
  • - *
  • - *

    - * QUICKSIGHT - Display only the starting themes defined by Amazon QuickSight.

    - *
  • - *
+ *

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

* @public */ - Type?: ThemeType | undefined; -} + SessionLifetimeInMinutes?: number | undefined; -/** - *

The theme summary.

- * @public - */ -export interface ThemeSummary { /** - *

The Amazon Resource Name (ARN) of the resource.

+ *

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables + * the undo/redo button.

* @public */ - Arn?: string | undefined; + UndoRedoDisabled?: boolean | undefined; /** - *

the display name for the theme.

+ *

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the + * reset button.

* @public */ - Name?: string | undefined; + ResetDisabled?: boolean | undefined; /** - *

The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

Adds persistence of state for the user session in an embedded dashboard. Persistence + * applies to the sheet and the parameter settings. These are control settings that the + * dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is + * set to TRUE, the settings are the same when the subscriber reopens the same + * dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is + * set to FALSE, the state of the user session is not persisted. The default is + * FALSE.

* @public */ - ThemeId?: string | undefined; + StatePersistenceEnabled?: boolean | undefined; /** - *

The latest version number for the theme.

+ *

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. + * You can use this for any Amazon QuickSight users in your account (readers, authors, or + * admins) authenticated as one of the following:

+ *
    + *
  • + *

    Active Directory (AD) users or group members

    + *
  • + *
  • + *

    Invited nonfederated users

    + *
  • + *
  • + *

    IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using + * SAML, OpenID Connect, or IAM federation.

    + *
  • + *
+ *

Omit this parameter for users in the third group – IAM users and IAM + * role-based sessions.

* @public */ - LatestVersionNumber?: number | undefined; + UserArn?: string | undefined; /** - *

The date and time that this theme was created.

+ *

The Amazon QuickSight namespace that contains the dashboard IDs in this request. + * If you're not using a custom namespace, set Namespace = default.

* @public */ - CreatedTime?: Date | undefined; + Namespace?: string | undefined; /** - *

The last date and time that this theme was updated.

+ *

A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

* @public */ - LastUpdatedTime?: Date | undefined; + AdditionalDashboardIds?: string[] | undefined; } /** + *

Output returned from the GetDashboardEmbedUrl operation.

* @public */ -export interface ListThemesResponse { +export interface GetDashboardEmbedUrlResponse { /** - *

Information about the themes in the list.

+ *

A single-use URL that you can put into your server-side webpage to embed your + * dashboard. This URL is valid for 5 minutes. The API operation provides the URL with an + * auth_code value that enables one (and only one) sign-on to a user session + * that is valid for 10 hours.

* @public */ - ThemeSummaryList?: ThemeSummary[] | undefined; + EmbedUrl?: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The HTTP status of the request.

* @public */ - NextToken?: 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; +} +/** + *

The identity type specified isn't supported. Supported identity types include + * IAM and QUICKSIGHT.

+ * @public + */ +export class IdentityTypeNotSupportedException extends __BaseException { + readonly name: "IdentityTypeNotSupportedException" = "IdentityTypeNotSupportedException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The Amazon Web Services request ID for this request.

* @public */ RequestId?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType) { + super({ + name: "IdentityTypeNotSupportedException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, IdentityTypeNotSupportedException.prototype); + this.Message = opts.Message; + this.RequestId = opts.RequestId; + } } /** * @public */ -export interface ListThemeVersionsRequest { +export interface GetSessionEmbedUrlRequest { /** - *

The ID of the Amazon Web Services account that contains the themes that you're listing.

+ *

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the theme.

+ *

The URL you use to access the embedded session. The entry point URL is constrained to + * the following paths:

+ *
    + *
  • + *

    + * /start + *

    + *
  • + *
  • + *

    + * /start/analyses + *

    + *
  • + *
  • + *

    + * /start/dashboards + *

    + *
  • + *
  • + *

    + * /start/favorites + *

    + *
  • + *
  • + *

    + * /dashboards/DashboardId + * - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard

    + *
  • + *
  • + *

    + * /analyses/AnalysisId + * - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis

    + *
  • + *
* @public */ - ThemeId: string | undefined; + EntryPoint?: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

* @public */ - NextToken?: string | undefined; + SessionLifetimeInMinutes?: number | undefined; /** - *

The maximum number of results to be returned per request.

+ *

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. + * You can use this for any type of Amazon QuickSight users in your account (readers, authors, or + * admins). They need to be authenticated as one of the following:

+ *
    + *
  1. + *

    Active Directory (AD) users or group members

    + *
  2. + *
  3. + *

    Invited nonfederated users

    + *
  4. + *
  5. + *

    IAM users and IAM role-based sessions authenticated + * through Federated Single Sign-On using SAML, OpenID Connect, or IAM + * federation

    + *
  6. + *
+ *

Omit this parameter for users in the third group, IAM users and IAM role-based + * sessions.

* @public */ - MaxResults?: number | undefined; + UserArn?: string | undefined; } /** - *

The theme version.

* @public */ -export interface ThemeVersionSummary { +export interface GetSessionEmbedUrlResponse { /** - *

The version number of the theme version.

+ *

A single-use URL that you can put into your server-side web page to embed your + * Amazon QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an + * auth_code value that enables one (and only one) sign-on to a user session + * that is valid for 10 hours.

* @public */ - VersionNumber?: number | undefined; + EmbedUrl?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the theme version.

+ *

The HTTP status of the request.

* @public */ - Arn?: string | undefined; + Status?: number | undefined; /** - *

The description of the theme version.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Description?: string | undefined; + RequestId?: string | undefined; +} - /** - *

The date and time that this theme version was created.

- * @public - */ - CreatedTime?: Date | undefined; +/** + * @public + * @enum + */ +export const GroupFilterAttribute = { + GROUP_NAME: "GROUP_NAME", +} as const; - /** - *

The status of the theme version.

- * @public - */ - Status?: ResourceStatus | undefined; -} +/** + * @public + */ +export type GroupFilterAttribute = (typeof GroupFilterAttribute)[keyof typeof GroupFilterAttribute]; /** * @public + * @enum */ -export interface ListThemeVersionsResponse { - /** - *

A structure containing a list of all the versions of the specified theme.

- * @public - */ - ThemeVersionSummaryList?: ThemeVersionSummary[] | undefined; +export const GroupFilterOperator = { + StartsWith: "StartsWith", +} as const; + +/** + * @public + */ +export type GroupFilterOperator = (typeof GroupFilterOperator)[keyof typeof GroupFilterOperator]; +/** + *

A GroupSearchFilter object that you want to apply to your search.

+ * @public + */ +export interface GroupSearchFilter { /** - *

The token for the next set of results, or null if there are no more results.

+ *

The comparison operator that you want to use as a filter, for example "Operator": + * "StartsWith". Currently, the only supported operator is + * StartsWith.

* @public */ - NextToken?: string | undefined; + Operator: GroupFilterOperator | undefined; /** - *

The HTTP status of the request.

+ *

The name of the value that you want to use as a filter, for example "Name": + * "GROUP_NAME". Currently, the only supported name is + * GROUP_NAME.

* @public */ - Status?: number | undefined; + Name: GroupFilterAttribute | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The value of the named item, in this case GROUP_NAME, that you want to use as a filter.

* @public */ - RequestId?: string | undefined; + Value: string | undefined; } /** + *

IAM policy assignment summary.

* @public */ -export interface ListTopicRefreshSchedulesRequest { +export interface IAMPolicyAssignmentSummary { /** - *

The ID of the Amazon Web Services account that contains the topic whose refresh schedule - * you want described.

+ *

Assignment name.

* @public */ - AwsAccountId: string | undefined; + AssignmentName?: string | undefined; /** - *

The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

Assignment status.

* @public */ - TopicId: string | undefined; + AssignmentStatus?: AssignmentStatus | undefined; } /** - *

A summary of the refresh schedule details for a dataset.

* @public */ -export interface TopicRefreshScheduleSummary { - /** - *

The ID of the dataset.

- * @public - */ - DatasetId?: string | undefined; - +export interface ListAnalysesRequest { /** - *

The Amazon Resource Name (ARN) of the dataset.

+ *

The ID of the Amazon Web Services account that contains the analyses.

* @public */ - DatasetArn?: string | undefined; + AwsAccountId: string | undefined; /** - *

The name of the dataset.

+ *

A pagination token that can be used in a subsequent request.

* @public */ - DatasetName?: string | undefined; + NextToken?: string | undefined; /** - *

The definition of a refresh schedule.

+ *

The maximum number of results to return.

* @public */ - RefreshSchedule?: TopicRefreshSchedule | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface ListTopicRefreshSchedulesResponse { - /** - *

The ID for 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; - +export interface ListAnalysesResponse { /** - *

The Amazon Resource Name (ARN) of the topic.

+ *

Metadata describing each of the analyses that are listed.

* @public */ - TopicArn?: string | undefined; + AnalysisSummaryList?: AnalysisSummary[] | undefined; /** - *

The list of topic refresh schedules.

+ *

A pagination token that can be used in a subsequent request.

* @public */ - RefreshSchedules?: TopicRefreshScheduleSummary[] | undefined; + NextToken?: string | undefined; /** *

The HTTP status of the request.

@@ -4776,30 +5047,35 @@ export interface ListTopicRefreshSchedulesResponse { /** * @public */ -export interface ListTopicReviewedAnswersRequest { +export interface ListAssetBundleExportJobsRequest { /** - *

The ID of the Amazon Web Services account that containd the reviewed answers that you want listed.

+ *

The ID of the Amazon Web Services account that the export jobs were executed in.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - TopicId: string | undefined; + NextToken?: string | undefined; + + /** + *

The maximum number of results to be returned per request.

+ * @public + */ + MaxResults?: number | undefined; } /** * @public */ -export interface ListTopicsRequest { +export interface ListAssetBundleExportJobsResponse { /** - *

The ID of the Amazon Web Services account that contains the topics that you want to - * list.

+ *

A list of export job summaries.

* @public */ - AwsAccountId: string | undefined; + AssetBundleExportJobSummaryList?: AssetBundleExportJobSummary[] | undefined; /** *

The token for the next set of results, or null if there are no more results.

@@ -4808,51 +5084,50 @@ export interface ListTopicsRequest { NextToken?: string | undefined; /** - *

The maximum number of results to be returned per request.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - MaxResults?: number | undefined; -} + RequestId?: string | undefined; -/** - *

A topic summary.

- * @public - */ -export interface TopicSummary { /** - *

The Amazon Resource Name (ARN) of the topic.

+ *

The HTTP status of the request.

* @public */ - Arn?: string | undefined; + Status?: number | undefined; +} +/** + * @public + */ +export interface ListAssetBundleImportJobsRequest { /** - *

The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The ID of the Amazon Web Services account that the import jobs were executed in.

* @public */ - TopicId?: string | undefined; + AwsAccountId: string | undefined; /** - *

The name of the topic.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - Name?: string | undefined; + NextToken?: string | undefined; /** - *

The user experience version of the topic.

+ *

The maximum number of results to be returned per request.

* @public */ - UserExperienceVersion?: TopicUserExperienceVersion | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface ListTopicsResponse { +export interface ListAssetBundleImportJobsResponse { /** - *

A list of topic summaries.

+ *

A list of import job summaries.

* @public */ - TopicsSummaries?: TopicSummary[] | undefined; + AssetBundleImportJobSummaryList?: AssetBundleImportJobSummary[] | undefined; /** *

The token for the next set of results, or null if there are no more results.

@@ -4867,7 +5142,7 @@ export interface ListTopicsResponse { RequestId?: string | undefined; /** - *

The HTTP status of the request.

+ *

The HTTP status of the response.

* @public */ Status?: number | undefined; @@ -4876,138 +5151,167 @@ export interface ListTopicsResponse { /** * @public */ -export interface ListUserGroupsRequest { +export interface ListBrandsRequest { /** - *

The Amazon QuickSight user name that you want to list group memberships for.

+ *

The ID of the Amazon Web Services account that owns the brands that you want to list.

* @public */ - UserName: string | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account - * that contains your Amazon QuickSight account.

+ *

The maximum number of results to be returned in a single request.

* @public */ - AwsAccountId: string | undefined; + MaxResults?: number | undefined; /** - *

The namespace. Currently, you should set this to default.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - Namespace: string | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface ListBrandsResponse { /** - *

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 from this request.

+ *

A list of all brands in your Amazon Web Services account. This structure provides basic + * information about each brand.

* @public */ - MaxResults?: number | undefined; + Brands?: BrandSummary[] | undefined; } /** * @public */ -export interface ListUserGroupsResponse { +export interface ListCustomPermissionsRequest { /** - *

The list of groups the user is a member of.

+ *

The ID of the Amazon Web Services account that contains the custom permissions profiles that you want to list.

* @public */ - GroupList?: Group[] | undefined; + AwsAccountId: string | undefined; /** - *

A pagination token that can be used in a subsequent request.

+ *

The maximum number of results to return.

* @public */ - NextToken?: string | undefined; + MaxResults?: number | 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; +} +/** + * @public + */ +export interface ListCustomPermissionsResponse { /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; + + /** + *

A list of custom permissions profiles.

+ * @public + */ + CustomPermissionsList?: CustomPermissions[] | 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; } /** * @public */ -export interface ListUsersRequest { +export interface ListDashboardsRequest { /** - *

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 of the Amazon Web Services account that contains the dashboards that you're + * listing.

* @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 from this request.

+ *

The maximum number of results to be returned per request.

* @public */ MaxResults?: number | undefined; - - /** - *

The namespace. Currently, you should set this to default.

- * @public - */ - Namespace: string | undefined; } /** * @public */ -export interface ListUsersResponse { +export interface ListDashboardsResponse { /** - *

The list of users.

+ *

A structure that contains all of the dashboards in your Amazon Web Services account. This structure + * provides basic information about the dashboards.

* @public */ - UserList?: User[] | undefined; + DashboardSummaryList?: DashboardSummary[] | 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 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 ListVPCConnectionsRequest { +export interface ListDashboardVersionsRequest { /** - *

The Amazon Web Services account ID of the account that contains the VPC connections - * that you want to list.

+ *

The ID of the Amazon Web Services account that contains the dashboard that you're listing versions + * for.

* @public */ AwsAccountId: string | undefined; + /** + *

The ID for the dashboard.

+ * @public + */ + DashboardId: string | undefined; + /** *

The token for the next set of results, or null if there are no more results.

* @public @@ -5022,101 +5326,121 @@ export interface ListVPCConnectionsRequest { } /** - *

The summary metadata that describes a VPC connection.

* @public */ -export interface VPCConnectionSummary { +export interface ListDashboardVersionsResponse { /** - *

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 structure that contains information about each version of the dashboard.

* @public */ - VPCConnectionId?: string | undefined; + DashboardVersionSummaryList?: DashboardVersionSummary[] | undefined; /** - *

The Amazon Resource Name (ARN) of the VPC connection.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - Arn?: string | undefined; + 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 ListDataSetsRequest { /** - *

The display name for the VPC connection.

+ *

The Amazon Web Services account ID.

* @public */ - Name?: string | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon EC2 VPC ID associated with the VPC connection.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - VPCId?: string | undefined; + NextToken?: string | undefined; /** - *

The Amazon EC2 security group IDs associated with the VPC connection.

+ *

The maximum number of results to be returned per request.

* @public */ - SecurityGroupIds?: string[] | undefined; + MaxResults?: number | undefined; +} +/** + * @public + */ +export interface ListDataSetsResponse { /** - *

A list of IP addresses of DNS resolver endpoints for the VPC connection.

+ *

The list of dataset summaries.

* @public */ - DnsResolvers?: string[] | undefined; + DataSetSummaries?: DataSetSummary[] | undefined; /** - *

The status of the VPC connection.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - Status?: VPCConnectionResourceStatus | undefined; + NextToken?: string | undefined; /** - *

The availability status of the VPC connection.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; + RequestId?: string | undefined; /** - *

A list of network interfaces.

+ *

The HTTP status of the request.

* @public */ - NetworkInterfaces?: NetworkInterface[] | undefined; + Status?: number | undefined; +} +/** + * @public + */ +export interface ListDataSourcesRequest { /** - *

The ARN of the IAM role associated - * with the VPC connection.

+ *

The Amazon Web Services account ID.

* @public */ - RoleArn?: string | undefined; + AwsAccountId: string | undefined; /** - *

The time that the VPC connection was created.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - CreatedTime?: Date | undefined; + NextToken?: string | undefined; /** - *

The time that the VPC connection was last updated.

+ *

The maximum number of results to be returned per request.

* @public */ - LastUpdatedTime?: Date | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface ListVPCConnectionsResponse { +export interface ListDataSourcesResponse { /** - *

A VPCConnectionSummaries object that returns a summary of VPC connection - * objects.

+ *

A list of data sources.

* @public */ - VPCConnectionSummaries?: VPCConnectionSummary[] | undefined; + DataSources?: DataSource[] | undefined; /** - *

The token for the next set of results, or null if there are no more - * results.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ NextToken?: string | undefined; @@ -5134,305 +5458,225 @@ export interface ListVPCConnectionsResponse { Status?: number | undefined; } -/** - * @public - * @enum - */ -export const PurchaseMode = { - AUTO_PURCHASE: "AUTO_PURCHASE", - MANUAL: "MANUAL", -} as const; - -/** - * @public - */ -export type PurchaseMode = (typeof PurchaseMode)[keyof typeof PurchaseMode]; - /** * @public */ -export interface PutDataSetRefreshPropertiesRequest { +export interface ListFolderMembersRequest { /** - *

The Amazon Web Services account ID.

+ *

The ID for the Amazon Web Services account that contains the folder.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the dataset.

+ *

The ID of the folder.

* @public */ - DataSetId: string | undefined; + FolderId: string | undefined; /** - *

The dataset refresh properties.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - DataSetRefreshProperties: DataSetRefreshProperties | undefined; + NextToken?: string | undefined; + + /** + *

The maximum number of results to be returned per request.

+ * @public + */ + MaxResults?: number | undefined; } /** * @public */ -export interface PutDataSetRefreshPropertiesResponse { +export interface ListFolderMembersResponse { /** - *

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.

+ *

A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.

* @public */ - Status?: number | undefined; -} + FolderMemberList?: MemberIdArnPair[] | undefined; -/** - * @public - */ -export interface RegisterUserRequest { /** - *

The identity type that your Amazon QuickSight account uses to manage the identity of users.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - IdentityType: IdentityType | undefined; + NextToken?: string | undefined; /** - *

The email address of the user that you want to register.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Email: string | undefined; + RequestId?: string | undefined; +} +/** + * @public + */ +export interface ListFoldersRequest { /** - *

The Amazon QuickSight role for the user. The user role can be one of the - * following:

- *
    - *
  • - *

    - * READER: A user who has read-only access to dashboards.

    - *
  • - *
  • - *

    - * AUTHOR: A user who can create data sources, datasets, analyses, and - * dashboards.

    - *
  • - *
  • - *

    - * ADMIN: A user who is an author, who can also manage Amazon QuickSight - * settings.

    - *
  • - *
  • - *

    - * READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

    - *
  • - *
  • - *

    - * AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

    - *
  • - *
  • - *

    - * ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.

    - *
  • - *
  • - *

    - * RESTRICTED_READER: This role isn't currently available for - * use.

    - *
  • - *
  • - *

    - * RESTRICTED_AUTHOR: This role isn't currently available for - * use.

    - *
  • - *
+ *

The ID for the Amazon Web Services account that contains the folder.

* @public */ - UserRole: UserRole | undefined; + AwsAccountId: string | undefined; /** - *

The ARN of the IAM user or role that you are registering with Amazon QuickSight.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - IamArn?: string | undefined; + NextToken?: string | undefined; /** - *

You need to use this parameter only when you register one or more users using an assumed - * IAM role. You don't need to provide the session name for other scenarios, for example when - * you are registering an IAM user or an Amazon QuickSight user. You can register multiple - * users using the same IAM role if each user has a different session name. For more - * information on assuming IAM roles, see - * assume-role - * in the CLI Reference. - *

+ *

The maximum number of results to be returned per request.

* @public */ - SessionName?: string | undefined; + MaxResults?: number | undefined; +} +/** + * @public + */ +export interface ListFoldersResponse { /** - *

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 HTTP status of the request.

* @public */ - AwsAccountId: string | undefined; + Status?: number | undefined; /** - *

The namespace. Currently, you should set this to default.

+ *

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

* @public */ - Namespace: string | undefined; + FolderSummaryList?: FolderSummary[] | undefined; /** - *

The Amazon QuickSight user name that you want to create for the user you are - * registering.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - UserName?: string | undefined; + NextToken?: string | undefined; /** - *

(Enterprise edition only) The name of the custom permissions profile that you want to - * assign to this user. Customized permissions allows you to control a user's access by - * restricting access the following operations:

- *
    - *
  • - *

    Create and update data sources

    - *
  • - *
  • - *

    Create and update datasets

    - *
  • - *
  • - *

    Create and update email reports

    - *
  • - *
  • - *

    Subscribe to email reports

    - *
  • - *
- *

To add custom permissions to an existing user, use - * UpdateUser - * instead.

- *

A set of custom permissions includes any combination of these restrictions. Currently, - * you need to create the profile names for custom permission sets by using the Amazon QuickSight - * console. Then, you use the RegisterUser API operation to assign the named set of - * permissions to a Amazon QuickSight user.

- *

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they - * override the permissions typically granted by assigning Amazon QuickSight users to one of the - * default security cohorts in Amazon QuickSight (admin, author, reader, admin pro, author pro, reader pro).

- *

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - CustomPermissionsName?: string | undefined; + RequestId?: string | undefined; +} +/** + * @public + */ +export interface ListFoldersForResourceRequest { /** - *

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

- *
    - *
  • - *

    - * COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

    - *
  • - *
  • - *

    - * CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

    - *
  • - *
+ *

The ID for the Amazon Web Services account that contains the resource.

* @public */ - ExternalLoginFederationProviderType?: string | undefined; + AwsAccountId: string | undefined; /** - *

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate - * into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should - * only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

+ *

The Amazon Resource Name (ARN) the resource whose folders you need to list.

* @public */ - CustomFederationProviderUrl?: string | undefined; + ResourceArn: string | undefined; /** - *

The identity ID for a user in the external login provider.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - ExternalLoginId?: string | undefined; + NextToken?: string | undefined; /** - *

The tags to associate with the user.

+ *

The maximum number of results to be returned per request.

* @public */ - Tags?: Tag[] | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface RegisterUserResponse { +export interface ListFoldersForResourceResponse { /** - *

The user's user name.

+ *

The HTTP status of the request.

* @public */ - User?: User | undefined; + Status?: number | undefined; /** - *

The URL the user visits to complete registration and provide a password. This is - * returned only for users with an identity type of QUICKSIGHT.

+ *

A list that contains the Amazon Resource Names (ARNs) of all folders that the resource is a member of.

* @public */ - UserInvitationUrl?: string | undefined; + Folders?: string[] | 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 request.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Status?: number | undefined; + RequestId?: string | undefined; } /** * @public */ -export interface RestoreAnalysisRequest { +export interface ListGroupMembershipsRequest { /** - *

The ID of the Amazon Web Services account that contains the analysis.

+ *

The name of the group that you want to see a membership list of.

* @public */ - AwsAccountId: string | undefined; + GroupName: string | undefined; /** - *

The ID of the analysis that you're restoring.

+ *

A pagination token that can be used in a subsequent request.

* @public */ - AnalysisId: string | undefined; + NextToken?: string | undefined; /** - *

A boolean value that determines if the analysis will be restored to folders that it previously resided in. A True value restores analysis back to all folders that it previously resided in. A False value restores the analysis but does not restore the analysis back to all previously resided folders. Restoring a restricted analysis requires this parameter to be set to True.

+ *

The maximum number of results to return from this request.

* @public */ - RestoreToFolders?: boolean | undefined; -} + MaxResults?: number | undefined; -/** - * @public - */ -export interface RestoreAnalysisResponse { /** - *

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 Resource Name (ARN) of the analysis that you're restoring.

+ *

The namespace of the group that you want a list of users from.

* @public */ - Arn?: string | undefined; + Namespace: string | undefined; +} +/** + * @public + */ +export interface ListGroupMembershipsResponse { /** - *

The ID of the analysis that you're restoring. - *

+ *

The list of the members of the group.

* @public */ - AnalysisId?: string | undefined; + GroupMemberList?: GroupMember[] | undefined; + + /** + *

A pagination token that can be used in a subsequent request.

+ * @public + */ + NextToken?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -5441,29 +5685,23 @@ export interface RestoreAnalysisResponse { RequestId?: string | undefined; /** - *

A list of folder arns thatthe analysis failed to be restored to.

+ *

The HTTP status of the request.

* @public */ - RestorationFailedFolderArns?: string[] | undefined; + Status?: number | undefined; } /** * @public */ -export interface SearchAnalysesRequest { +export interface ListGroupsRequest { /** - *

The ID of the Amazon Web Services account that contains the analyses that you're searching - * for.

+ *

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; - /** - *

The structure for the search filters that you want to apply to your search.

- * @public - */ - Filters: AnalysisSearchFilter[] | undefined; - /** *

A pagination token that can be used in a subsequent request.

* @public @@ -5475,57 +5713,65 @@ export interface SearchAnalysesRequest { * @public */ MaxResults?: number | undefined; + + /** + *

The namespace that you want a list of groups from.

+ * @public + */ + Namespace: string | undefined; } /** * @public */ -export interface SearchAnalysesResponse { +export interface ListGroupsResponse { /** - *

Metadata describing the analyses that you searched for.

+ *

The list of the groups.

* @public */ - AnalysisSummaryList?: AnalysisSummary[] | undefined; + GroupList?: Group[] | undefined; /** - *

A pagination token that can be used in a subsequent request. - *

+ *

A pagination token that can be used in a subsequent request.

* @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 request.

* @public */ - RequestId?: string | undefined; + Status?: number | undefined; } /** * @public */ -export interface SearchDashboardsRequest { +export interface ListIAMPolicyAssignmentsRequest { /** - *

The ID of the Amazon Web Services account that contains the user whose dashboards you're searching - * for.

+ *

The ID of the Amazon Web Services account that contains these IAM policy + * assignments.

* @public */ AwsAccountId: string | undefined; /** - *

The filters to apply to the search. Currently, you can search only by user name, for - * example, "Filters": [ \{ "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", - * "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" \} ] - *

+ *

The status of the assignments.

* @public */ - Filters: DashboardSearchFilter[] | undefined; + AssignmentStatus?: AssignmentStatus | undefined; + + /** + *

The namespace for the assignments.

+ * @public + */ + Namespace: string | undefined; /** *

The token for the next set of results, or null if there are no more results.

@@ -5543,13 +5789,12 @@ export interface SearchDashboardsRequest { /** * @public */ -export interface SearchDashboardsResponse { +export interface ListIAMPolicyAssignmentsResponse { /** - *

The list of dashboards owned by the user specified in Filters in your - * request.

+ *

Information describing the IAM policy assignments.

* @public */ - DashboardSummaryList?: DashboardSummary[] | undefined; + IAMPolicyAssignments?: IAMPolicyAssignmentSummary[] | undefined; /** *

The token for the next set of results, or null if there are no more results.

@@ -5558,36 +5803,36 @@ export interface SearchDashboardsResponse { 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 request.

* @public */ - RequestId?: string | undefined; + Status?: number | undefined; } /** * @public */ -export interface SearchDataSetsRequest { +export interface ListIAMPolicyAssignmentsForUserRequest { /** - *

The Amazon Web Services account ID.

+ *

The ID of the Amazon Web Services account that contains the assignments.

* @public */ AwsAccountId: string | undefined; /** - *

The filters to apply to the search.

+ *

The name of the user.

* @public */ - Filters: DataSetSearchFilter[] | undefined; + UserName: 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; @@ -5597,78 +5842,78 @@ export interface SearchDataSetsRequest { * @public */ MaxResults?: number | undefined; + + /** + *

The namespace of the assignment.

+ * @public + */ + Namespace: string | undefined; } /** * @public */ -export interface SearchDataSetsResponse { +export interface ListIAMPolicyAssignmentsForUserResponse { /** - *

A DataSetSummaries object that returns a summary of a dataset.

+ *

The active assignments for this user.

* @public */ - DataSetSummaries?: DataSetSummary[] | undefined; + ActiveAssignments?: ActiveIAMPolicyAssignment[] | undefined; /** - *

A pagination token that can be used in a subsequent request.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - NextToken?: string | undefined; + RequestId?: string | undefined; /** - *

The HTTP status of the request.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - Status?: number | undefined; + NextToken?: 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 SearchDataSourcesRequest { +export interface ListIdentityPropagationConfigsRequest { /** - *

The Amazon Web Services account ID.

+ *

The ID of the Amazon Web Services account that contain the identity propagation configurations of.

* @public */ AwsAccountId: string | undefined; /** - *

The filters to apply to the search.

+ *

The maximum number of results to be returned.

* @public */ - Filters: DataSourceSearchFilter[] | undefined; + MaxResults?: number | 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 be returned per request.

- * @public - */ - MaxResults?: number | undefined; } /** * @public */ -export interface SearchDataSourcesResponse { +export interface ListIdentityPropagationConfigsResponse { /** - *

A DataSourceSummaries object that returns a summary of a data source.

+ *

A list of services and their authorized targets that the Amazon QuickSight IAM Identity Center application can access.

* @public */ - DataSourceSummaries?: DataSourceSummary[] | undefined; + Services?: AuthorizedTargetsByService[] | 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; @@ -5689,24 +5934,24 @@ export interface SearchDataSourcesResponse { /** * @public */ -export interface SearchFoldersRequest { +export interface ListIngestionsRequest { /** - *

The ID for the Amazon Web Services account that contains the folder.

+ *

The ID of the dataset used in the ingestion.

* @public */ - AwsAccountId: string | undefined; + DataSetId: string | undefined; /** - *

The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ \{ "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" \} ].

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - Filters: FolderSearchFilter[] | undefined; + NextToken?: string | undefined; /** - *

The token for the next set of results, or null if there are no more results.

+ *

The Amazon Web Services account ID.

* @public */ - NextToken?: string | undefined; + AwsAccountId: string | undefined; /** *

The maximum number of results to be returned per request.

@@ -5718,18 +5963,12 @@ export interface SearchFoldersRequest { /** * @public */ -export interface SearchFoldersResponse { - /** - *

The HTTP status of the request.

- * @public - */ - Status?: number | undefined; - +export interface ListIngestionsResponse { /** - *

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

+ *

A list of the ingestions.

* @public */ - FolderSummaryList?: FolderSummary[] | undefined; + Ingestions?: Ingestion[] | undefined; /** *

The token for the next set of results, or null if there are no more results.

@@ -5742,56 +5981,51 @@ export interface SearchFoldersResponse { * @public */ RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; } /** * @public */ -export interface SearchGroupsRequest { +export interface ListNamespacesRequest { /** - *

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 for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.

* @public */ AwsAccountId: string | undefined; /** - *

A pagination token that can be used in a subsequent request.

+ *

A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

* @public */ NextToken?: string | undefined; /** - *

The maximum number of results to return from this request.

- * @public - */ - MaxResults?: number | undefined; - - /** - *

The namespace that you want to search.

- * @public - */ - Namespace: string | undefined; - - /** - *

The structure for the search filters that you want to apply to your search.

+ *

The maximum number of results to return.

* @public */ - Filters: GroupSearchFilter[] | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface SearchGroupsResponse { +export interface ListNamespacesResponse { /** - *

A list of groups in a specified namespace that match the filters you set in your SearchGroups request.

+ *

The information about the namespaces in this Amazon Web Services account. The response includes + * the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and + * identity store.

* @public */ - GroupList?: Group[] | undefined; + Namespaces?: NamespaceInfoV2[] | undefined; /** - *

A pagination token that can be used in a subsequent request.

+ *

A unique pagination token that can be used in a subsequent request. Receiving NextToken in your response inticates that there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

* @public */ NextToken?: string | undefined; @@ -5812,142 +6046,102 @@ export interface SearchGroupsResponse { /** * @public */ -export interface StartAssetBundleExportJobRequest { +export interface ListRefreshSchedulesRequest { /** - *

The ID of the Amazon Web Services account to export assets from.

+ *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

- * @public - */ - AssetBundleExportJobId: string | undefined; - - /** - *

An array of resource ARNs to export. The following resources are supported.

- *
    - *
  • - *

    - * Analysis - *

    - *
  • - *
  • - *

    - * Dashboard - *

    - *
  • - *
  • - *

    - * DataSet - *

    - *
  • - *
  • - *

    - * DataSource - *

    - *
  • - *
  • - *

    - * RefreshSchedule - *

    - *
  • - *
  • - *

    - * Theme - *

    - *
  • - *
  • - *

    - * VPCConnection - *

    - *
  • - *
- *

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

+ *

The ID of the dataset.

* @public */ - ResourceArns: string[] | undefined; + DataSetId: string | undefined; +} +/** + * @public + */ +export interface ListRefreshSchedulesResponse { /** - *

A Boolean that determines whether all dependencies of each resource ARN are recursively - * exported with the job. For example, say you provided a Dashboard ARN to the - * ResourceArns parameter. If you set IncludeAllDependencies to - * TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also - * exported.

+ *

The list of refresh schedules for the dataset.

* @public */ - IncludeAllDependencies?: boolean | undefined; + RefreshSchedules?: RefreshSchedule[] | undefined; /** - *

The export data format.

+ *

The HTTP status of the request.

* @public */ - ExportFormat: AssetBundleExportFormat | undefined; + Status?: number | undefined; /** - *

An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

- *

Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - CloudFormationOverridePropertyConfiguration?: AssetBundleCloudFormationOverridePropertyConfiguration | undefined; + RequestId?: string | undefined; +} +/** + * @public + */ +export interface ListRoleMembershipsRequest { /** - *

A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported. - *

+ *

The name of the role.

* @public */ - IncludePermissions?: boolean | undefined; + Role: Role | undefined; /** - *

A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

+ *

A pagination token that can be used in a subsequent request.

* @public */ - IncludeTags?: boolean | undefined; + NextToken?: string | undefined; /** - *

An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

+ *

The maximum number of results to return.

* @public */ - ValidationStrategy?: AssetBundleExportJobValidationStrategy | undefined; + MaxResults?: number | undefined; /** - *

A Boolean that determines if the exported asset carries over information about the folders that the asset is a member of.

+ *

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 */ - IncludeFolderMemberships?: boolean | undefined; + AwsAccountId: string | undefined; /** - *

A setting that indicates whether you want to include folder assets. You can also use this setting to recusrsively include all subfolders of an exported folder.

+ *

The namespace that includes the role.

* @public */ - IncludeFolderMembers?: IncludeFolderMembers | undefined; + Namespace: string | undefined; } /** * @public */ -export interface StartAssetBundleExportJobResponse { +export interface ListRoleMembershipsResponse { /** - *

The Amazon Resource Name (ARN) for the export job.

+ *

The list of groups associated with a role

* @public */ - Arn?: string | undefined; + MembersList?: string[] | undefined; /** - *

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

+ *

A pagination token that can be used in a subsequent request.

* @public */ - AssetBundleExportJobId?: string | undefined; + NextToken?: string | undefined; /** - *

The Amazon Web Services response ID for this operation.

+ *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** - *

The HTTP status of the response.

+ *

The HTTP status of the request.

* @public */ Status?: number | undefined; @@ -5956,345 +6150,328 @@ export interface StartAssetBundleExportJobResponse { /** * @public */ -export interface StartAssetBundleImportJobRequest { +export interface ListTagsForResourceRequest { /** - *

The ID of the Amazon Web Services account to import assets into.

+ *

The Amazon Resource Name (ARN) of the resource that you want a list of tags for.

* @public */ - AwsAccountId: string | undefined; + ResourceArn: string | undefined; +} +/** + * @public + */ +export interface ListTagsForResourceResponse { /** - *

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

+ *

Contains a map of the key-value pairs for the resource tag or tags assigned to the + * resource.

* @public */ - AssetBundleImportJobId: string | undefined; + Tags?: Tag[] | undefined; /** - *

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format. - *

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AssetBundleImportSource: AssetBundleImportSource | undefined; + RequestId?: string | undefined; /** - *

Optional overrides that are applied to the resource configuration before import.

+ *

The HTTP status of the request.

* @public */ - OverrideParameters?: AssetBundleImportJobOverrideParameters | undefined; + Status?: number | undefined; +} +/** + * @public + */ +export interface ListTemplateAliasesRequest { /** - *

The failure action for the import job.

- *

If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.

- *

If you choose DO_NOTHING, failed import jobs will not attempt to roll back - * any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.

+ *

The ID of the Amazon Web Services account that contains the template aliases that you're listing.

* @public */ - FailureAction?: AssetBundleImportFailureAction | undefined; + AwsAccountId: string | undefined; /** - *

Optional permission overrides that are applied to the resource configuration before import.

+ *

The ID for the template.

* @public */ - OverridePermissions?: AssetBundleImportJobOverridePermissions | undefined; + TemplateId: string | undefined; /** - *

Optional tag overrides that are applied to the resource configuration before import.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - OverrideTags?: AssetBundleImportJobOverrideTags | undefined; + NextToken?: string | undefined; /** - *

An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.

+ *

The maximum number of results to be returned per request.

* @public */ - OverrideValidationStrategy?: AssetBundleImportJobOverrideValidationStrategy | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface StartAssetBundleImportJobResponse { +export interface ListTemplateAliasesResponse { /** - *

The Amazon Resource Name (ARN) for the import job.

+ *

A structure containing the list of the template's aliases.

* @public */ - Arn?: string | undefined; + TemplateAliasList?: TemplateAlias[] | undefined; /** - *

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

+ *

The HTTP status of the request.

* @public */ - AssetBundleImportJobId?: string | undefined; + Status?: number | undefined; /** - *

The Amazon Web Services response ID for this operation.

+ *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** - *

The HTTP status of the response.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - Status?: number | undefined; + NextToken?: string | undefined; } /** - *

A structure that contains information on the anonymous user configuration.

* @public */ -export interface SnapshotAnonymousUser { +export interface ListTemplatesRequest { /** - *

The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a DataSet$RowLevelPermissionTagConfiguration API call.

- *

These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon QuickSight, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

+ *

The ID of the Amazon Web Services account that contains the templates that you're listing.

* @public */ - RowLevelPermissionTags?: SessionTag[] | undefined; -} + AwsAccountId: string | undefined; -/** - *

A structure that contains information about the users that the dashboard snapshot is generated for.

- * @public - */ -export interface SnapshotUserConfiguration { /** - *

An array of records that describe the anonymous users that the dashboard snapshot is generated for.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - AnonymousUsers?: SnapshotAnonymousUser[] | undefined; + NextToken?: string | undefined; + + /** + *

The maximum number of results to be returned per request.

+ * @public + */ + MaxResults?: number | undefined; } /** + *

The template summary.

* @public */ -export interface StartDashboardSnapshotJobRequest { +export interface TemplateSummary { /** - *

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

+ *

A summary of a template.

* @public */ - AwsAccountId: string | undefined; + Arn?: string | undefined; /** - *

The ID of the dashboard that you want to start a snapshot job for. - *

+ *

The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - DashboardId: string | undefined; + TemplateId?: string | undefined; /** - *

An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.

+ *

A display name for the template.

* @public */ - SnapshotJobId: string | undefined; + Name?: string | undefined; /** - *

- * A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.

+ *

A structure containing a list of version numbers for the template summary.

* @public */ - UserConfiguration: SnapshotUserConfiguration | undefined; + LatestVersionNumber?: number | undefined; /** - *

A structure that describes the configuration of the dashboard snapshot.

+ *

The last time that this template was created.

* @public */ - SnapshotConfiguration: SnapshotConfiguration | undefined; + CreatedTime?: Date | undefined; + + /** + *

The last time that this template was updated.

+ * @public + */ + LastUpdatedTime?: Date | undefined; } /** * @public */ -export interface StartDashboardSnapshotJobResponse { +export interface ListTemplatesResponse { /** - *

The Amazon Resource Name (ARN) for the dashboard snapshot job.

+ *

A structure containing information about the templates in the list.

* @public */ - Arn?: string | undefined; + TemplateSummaryList?: TemplateSummary[] | undefined; /** - *

The ID of the job. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - SnapshotJobId?: string | undefined; + NextToken?: string | 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 StartDashboardSnapshotJobScheduleRequest { +export interface ListTemplateVersionsRequest { /** - *

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 templates that you're listing.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the dashboard that you want to start a snapshot job schedule for. - *

- * @public - */ - DashboardId: string | undefined; - - /** - *

The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the Amazon QuickSight console in the Schedules pane of the dashboard that the schedule is configured for.

+ *

The ID for the template.

* @public */ - ScheduleId: string | undefined; -} + TemplateId: string | undefined; -/** - * @public - */ -export interface StartDashboardSnapshotJobScheduleResponse { /** - *

- * 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 request

+ *

The maximum number of results to be returned per request.

* @public */ - Status?: number | undefined; + MaxResults?: number | undefined; } /** + *

The template version.

* @public */ -export interface TagResourceRequest { +export interface TemplateVersionSummary { /** - *

The Amazon Resource Name (ARN) of the resource that you want to tag.

+ *

The Amazon Resource Name (ARN) of the template version.

* @public */ - ResourceArn: string | undefined; + Arn?: string | undefined; /** - *

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

+ *

The version number of the template version.

* @public */ - Tags: Tag[] | undefined; -} + VersionNumber?: number | undefined; -/** - * @public - */ -export interface TagResourceResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

The time that this template version was created.

* @public */ - RequestId?: string | undefined; + CreatedTime?: Date | undefined; /** - *

The HTTP status of the request.

+ *

The status of the template version.

* @public */ - Status?: number | undefined; + Status?: ResourceStatus | undefined; + + /** + *

The description of the template version.

+ * @public + */ + Description?: string | undefined; } /** * @public */ -export interface UntagResourceRequest { +export interface ListTemplateVersionsResponse { /** - *

The Amazon Resource Name (ARN) of the resource that you want to untag.

+ *

A structure containing a list of all the versions of the specified template.

* @public */ - ResourceArn: string | undefined; + TemplateVersionSummaryList?: TemplateVersionSummary[] | undefined; /** - *

The keys of the key-value pairs for the resource tag or tags assigned to the resource.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - TagKeys: string[] | undefined; -} + NextToken?: string | undefined; -/** - * @public - */ -export interface UntagResourceResponse { /** - *

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 UpdateAccountCustomizationRequest { +export interface ListThemeAliasesRequest { /** - *

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations - * for.

+ *

The ID of the Amazon Web Services account that contains the theme aliases that you're listing.

* @public */ AwsAccountId: string | undefined; /** - *

The namespace that you want to update Amazon QuickSight customizations for.

- * @public - */ - Namespace?: string | undefined; - - /** - *

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

+ *

The ID for the theme.

* @public */ - AccountCustomization: AccountCustomization | undefined; -} + ThemeId: string | undefined; -/** - * @public - */ -export interface UpdateAccountCustomizationResponse { /** - *

The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - Arn?: string | undefined; + NextToken?: string | undefined; /** - *

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations - * for.

+ *

The maximum number of results to be returned per request.

* @public */ - AwsAccountId?: string | undefined; + MaxResults?: number | undefined; +} +/** + * @public + */ +export interface ListThemeAliasesResponse { /** - *

The namespace associated with the customization that you're updating.

+ *

A structure containing the list of the theme's aliases.

* @public */ - Namespace?: string | undefined; + ThemeAliasList?: ThemeAlias[] | undefined; /** - *

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

+ *

The HTTP status of the request.

* @public */ - AccountCustomization?: AccountCustomization | undefined; + Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -6303,657 +6480,650 @@ export interface UpdateAccountCustomizationResponse { RequestId?: string | undefined; /** - *

The HTTP status of the request.

+ *

The 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 UpdateAccountSettingsRequest { +export interface ListThemesRequest { /** - *

The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to - * list.

+ *

The ID of the Amazon Web Services account that contains the themes that you're listing.

* @public */ AwsAccountId: string | undefined; /** - *

The default namespace for this Amazon Web Services account. Currently, the default is - * default. IAM users that - * register for the first time with Amazon QuickSight provide an email address that becomes - * associated with the default namespace. - *

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - DefaultNamespace: string | undefined; + NextToken?: string | undefined; /** - *

The email address that you want Amazon QuickSight to send notifications to regarding your - * Amazon Web Services account or Amazon QuickSight subscription.

+ *

The maximum number of results to be returned per request.

* @public */ - NotificationEmail?: string | undefined; + MaxResults?: number | undefined; /** - *

A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.

+ *

The type of themes that you want to list. Valid options include the following:

+ *
    + *
  • + *

    + * ALL (default)- Display all existing themes.

    + *
  • + *
  • + *

    + * CUSTOM - Display only the themes created by people using Amazon QuickSight.

    + *
  • + *
  • + *

    + * QUICKSIGHT - Display only the starting themes defined by Amazon QuickSight.

    + *
  • + *
* @public */ - TerminationProtectionEnabled?: boolean | undefined; + Type?: ThemeType | undefined; } /** + *

The theme summary.

* @public */ -export interface UpdateAccountSettingsResponse { +export interface ThemeSummary { /** - *

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.

+ *

the display name for the theme.

* @public */ - Status?: number | undefined; -} + Name?: string | undefined; -/** - * @public - */ -export interface UpdateAnalysisRequest { /** - *

The ID of the Amazon Web Services account that contains the analysis that you're updating.

+ *

The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - AwsAccountId: string | undefined; + ThemeId?: string | undefined; /** - *

The ID for the analysis that you're updating. This ID displays in the URL of the - * analysis.

+ *

The latest version number for the theme.

* @public */ - AnalysisId: string | undefined; + LatestVersionNumber?: number | undefined; /** - *

A descriptive name for the analysis that you're updating. This name displays for the - * analysis in the Amazon QuickSight console.

+ *

The date and time that this theme was created.

* @public */ - Name: string | undefined; + CreatedTime?: Date | 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.

+ *

The last date and time that this theme was updated.

* @public */ - Parameters?: _Parameters | undefined; + LastUpdatedTime?: Date | undefined; +} +/** + * @public + */ +export interface ListThemesResponse { /** - *

A source entity to use for the analysis that you're updating. This metadata structure - * contains details that describe a source template and one or more datasets.

+ *

Information about the themes in the list.

* @public */ - SourceEntity?: AnalysisSourceEntity | undefined; + ThemeSummaryList?: ThemeSummary[] | undefined; /** - *

The Amazon Resource Name (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 token for the next set of results, or null if there are no more results.

* @public */ - ThemeArn?: string | undefined; + NextToken?: string | undefined; /** - *

The definition of an analysis.

- *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

+ *

The HTTP status of the request.

* @public */ - Definition?: AnalysisDefinition | undefined; + Status?: number | undefined; /** - *

The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - ValidationStrategy?: ValidationStrategy | undefined; + RequestId?: string | undefined; } /** * @public */ -export interface UpdateAnalysisResponse { - /** - *

The ARN of the analysis that you're updating.

- * @public - */ - Arn?: string | undefined; - +export interface ListThemeVersionsRequest { /** - *

The ID of the analysis.

+ *

The ID of the Amazon Web Services account that contains the themes that you're listing.

* @public */ - AnalysisId?: string | undefined; + AwsAccountId: string | undefined; /** - *

The update status of the last update that was made to the analysis.

+ *

The ID for the theme.

* @public */ - UpdateStatus?: ResourceStatus | undefined; + ThemeId: string | undefined; /** - *

The HTTP status of the request.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - Status?: number | undefined; + NextToken?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The maximum number of results to be returned per request.

* @public */ - RequestId?: string | undefined; + MaxResults?: number | undefined; } /** + *

The theme version.

* @public */ -export interface UpdateAnalysisPermissionsRequest { +export interface ThemeVersionSummary { /** - *

The ID of the Amazon Web Services account that contains the analysis whose permissions you're - * updating. You must be using the Amazon Web Services account that the analysis is in.

+ *

The version number of the theme version.

* @public */ - AwsAccountId: string | undefined; + VersionNumber?: number | undefined; /** - *

The ID of the analysis whose permissions you're updating. The ID is part of the - * analysis URL.

+ *

The Amazon Resource Name (ARN) of the theme version.

* @public */ - AnalysisId: string | undefined; + Arn?: string | undefined; /** - *

A structure that describes the permissions to add and the principal to add them - * to.

+ *

The description of the theme version.

* @public */ - GrantPermissions?: ResourcePermission[] | undefined; + Description?: string | undefined; /** - *

A structure that describes the permissions to remove and the principal to remove them - * from.

+ *

The date and time that this theme version was created.

* @public */ - RevokePermissions?: ResourcePermission[] | undefined; + CreatedTime?: Date | undefined; + + /** + *

The status of the theme version.

+ * @public + */ + Status?: ResourceStatus | undefined; } /** * @public */ -export interface UpdateAnalysisPermissionsResponse { +export interface ListThemeVersionsResponse { /** - *

The Amazon Resource Name (ARN) of the analysis that you updated.

+ *

A structure containing a list of all the versions of the specified theme.

* @public */ - AnalysisArn?: string | undefined; + ThemeVersionSummaryList?: ThemeVersionSummary[] | undefined; /** - *

The ID of the analysis that you updated permissions for.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - AnalysisId?: string | undefined; + NextToken?: string | undefined; /** - *

A structure that describes the principals and the resource-level permissions on an - * analysis.

+ *

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; +} +/** + * @public + */ +export interface ListTopicRefreshSchedulesRequest { /** - *

The HTTP status of the request.

+ *

The ID of the Amazon Web Services account that contains the topic whose refresh schedule + * you want described.

* @public */ - Status?: number | undefined; + AwsAccountId: string | undefined; + + /** + *

The ID for 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; } /** + *

A summary of the refresh schedule details for a dataset.

* @public */ -export interface UpdateBrandRequest { +export interface TopicRefreshScheduleSummary { /** - *

The ID of the Amazon Web Services account that owns the brand.

+ *

The ID of the dataset.

* @public */ - AwsAccountId: string | undefined; + DatasetId?: string | undefined; /** - *

The ID of the Amazon QuickSight brand.

+ *

The Amazon Resource Name (ARN) of the dataset.

* @public */ - BrandId: string | undefined; + DatasetArn?: string | undefined; /** - *

The definition of the brand.

+ *

The name of the dataset.

* @public */ - BrandDefinition?: BrandDefinition | undefined; + DatasetName?: string | undefined; + + /** + *

The definition of a refresh schedule.

+ * @public + */ + RefreshSchedule?: TopicRefreshSchedule | undefined; } /** * @public */ -export interface UpdateBrandResponse { +export interface ListTopicRefreshSchedulesResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - RequestId?: string | undefined; + TopicId?: string | undefined; /** - *

The details of the brand.

+ *

The Amazon Resource Name (ARN) of the topic.

* @public */ - BrandDetail?: BrandDetail | undefined; + TopicArn?: string | undefined; /** - *

The definition of the brand.

+ *

The list of topic refresh schedules.

* @public */ - BrandDefinition?: BrandDefinition | undefined; -} + RefreshSchedules?: TopicRefreshScheduleSummary[] | undefined; -/** - * @public - */ -export interface UpdateBrandAssignmentRequest { /** - *

The ID of the Amazon Web Services account that owns the brand assignment.

+ *

The HTTP status of the request.

* @public */ - AwsAccountId: string | undefined; + Status?: number | undefined; /** - *

The Amazon Resource Name (ARN) of the brand.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - BrandArn: string | undefined; + RequestId?: string | undefined; } /** * @public */ -export interface UpdateBrandAssignmentResponse { +export interface ListTopicReviewedAnswersRequest { /** - *

The Amazon Web Services request ID for this operation.

+ *

The ID of the Amazon Web Services account that containd the reviewed answers that you want listed.

* @public */ - RequestId?: string | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Resource Name (ARN) of the brand.

+ *

The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - BrandArn?: string | undefined; + TopicId: string | undefined; } /** * @public */ -export interface UpdateBrandPublishedVersionRequest { +export interface ListTopicsRequest { /** - *

The ID of the Amazon Web Services account that owns the brand.

+ *

The ID of the Amazon Web Services account that contains the topics that you want to + * list.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the Amazon QuickSight brand.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - BrandId: string | undefined; + NextToken?: string | undefined; /** - *

The ID of the published version.

+ *

The maximum number of results to be returned per request.

* @public */ - VersionId: string | undefined; + MaxResults?: number | undefined; } /** + *

A topic summary.

* @public */ -export interface UpdateBrandPublishedVersionResponse { - /** - *

The Amazon Web Services request ID for this operation.

- * @public - */ - RequestId?: string | undefined; - +export interface TopicSummary { /** - *

The ID of the published version.

+ *

The Amazon Resource Name (ARN) of the topic.

* @public */ - VersionId?: string | undefined; -} + Arn?: 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.

+ *

The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ - AwsAccountId: string | undefined; + TopicId?: string | undefined; /** - *

The name of the custom permissions profile that you want to update.

+ *

The name of the topic.

* @public */ - CustomPermissionsName: string | undefined; + Name?: string | undefined; /** - *

A set of actions to include in the custom permissions profile.

+ *

The user experience version of the topic.

* @public */ - Capabilities?: Capabilities | undefined; + UserExperienceVersion?: TopicUserExperienceVersion | undefined; } /** * @public */ -export interface UpdateCustomPermissionsResponse { +export interface ListTopicsResponse { /** - *

The HTTP status of the request.

+ *

A list of topic summaries.

* @public */ - Status?: number | undefined; + TopicsSummaries?: TopicSummary[] | undefined; /** - *

The Amazon Resource Name (ARN) of the custom permissions profile.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - Arn?: string | undefined; + NextToken?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; -} -/** - * @public - */ -export interface UpdateDashboardRequest { /** - *

The ID of the Amazon Web Services account that contains the dashboard that you're - * updating.

+ *

The HTTP status of the request.

* @public */ - AwsAccountId: string | undefined; + Status?: number | undefined; +} +/** + * @public + */ +export interface ListUserGroupsRequest { /** - *

The ID for the dashboard.

+ *

The Amazon QuickSight user name that you want to list group memberships for.

* @public */ - DashboardId: string | undefined; + UserName: string | undefined; /** - *

The display name of the dashboard.

+ *

The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account + * that contains your Amazon QuickSight account.

* @public */ - Name: string | undefined; + AwsAccountId: string | undefined; /** - *

The entity that you are using as a source when you update the dashboard. In - * SourceEntity, you specify the type of object you're using as source. You - * can only update a dashboard from a template, so you use a SourceTemplate - * entity. If you need to update 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 SourceTemplate ARN 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.

+ *

The namespace. Currently, you should set this to default.

* @public */ - SourceEntity?: DashboardSourceEntity | undefined; + Namespace: string | undefined; /** - *

A structure that contains the parameters of the dashboard. These are parameter - * overrides for a dashboard. A dashboard can have any type of parameters, and some - * parameters might accept multiple values.

+ *

A pagination token that can be used in a subsequent request.

* @public */ - Parameters?: _Parameters | undefined; + NextToken?: string | undefined; /** - *

A description for the first version of the dashboard being created.

+ *

The maximum number of results to return from this request.

* @public */ - VersionDescription?: string | undefined; + MaxResults?: number | undefined; +} +/** + * @public + */ +export interface ListUserGroupsResponse { /** - *

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 list of groups the user is a member of.

* @public */ - DashboardPublishOptions?: DashboardPublishOptions | undefined; + GroupList?: Group[] | 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 was originally associated - * with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the - * dashboard.

+ *

A pagination token that can be used in a subsequent request.

* @public */ - ThemeArn?: string | undefined; + NextToken?: string | undefined; /** - *

The definition of a dashboard.

- *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Definition?: DashboardVersionDefinition | undefined; + RequestId?: string | undefined; /** - *

The option to relax the validation needed to update a dashboard 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 UpdateDashboardResponse { +export interface ListUsersRequest { /** - *

The Amazon Resource Name (ARN) of the resource.

+ *

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; /** - *

The ARN of the dashboard, including the version number.

+ *

A pagination token that can be used in a subsequent request.

* @public */ - VersionArn?: string | undefined; + NextToken?: string | undefined; /** - *

The ID for the dashboard.

+ *

The maximum number of results to return from this request.

* @public */ - DashboardId?: string | undefined; + MaxResults?: number | undefined; /** - *

The creation status of the request.

+ *

The namespace. Currently, you should set this to default.

* @public */ - CreationStatus?: ResourceStatus | undefined; + Namespace: string | undefined; +} +/** + * @public + */ +export interface ListUsersResponse { /** - *

The HTTP status of the request.

+ *

The list of users.

* @public */ - Status?: number | undefined; + UserList?: User[] | undefined; + + /** + *

A pagination token that can be used in a subsequent request.

+ * @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 UpdateDashboardLinksRequest { +export interface ListVPCConnectionsRequest { /** - *

The ID of the Amazon Web Services account that contains the dashboard whose links you want to update.

+ *

The Amazon Web Services account ID of the account that contains the VPC connections + * that you want to list.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the dashboard.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - DashboardId: string | undefined; + NextToken?: string | undefined; /** - *

list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

+ *

The maximum number of results to be returned per request.

* @public */ - LinkEntities: string[] | undefined; + MaxResults?: number | undefined; } /** + *

The summary metadata that describes a VPC connection.

* @public */ -export interface UpdateDashboardLinksResponse { +export interface VPCConnectionSummary { /** - *

The Amazon Web Services request ID for this operation.

+ *

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 */ - RequestId?: string | undefined; + VPCConnectionId?: string | undefined; /** - *

The HTTP status of the request.

+ *

The Amazon Resource Name (ARN) of the VPC connection.

* @public */ - Status?: number | undefined; + Arn?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the dashboard.

+ *

The display name for the VPC connection.

* @public */ - DashboardArn?: string | undefined; + Name?: string | undefined; /** - *

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

+ *

The Amazon EC2 VPC ID associated with the VPC connection.

* @public */ - LinkEntities?: string[] | undefined; -} + VPCId?: string | undefined; -/** - * @public - */ -export interface UpdateDashboardPermissionsRequest { /** - *

The ID of the Amazon Web Services account that contains the dashboard whose permissions you're - * updating.

+ *

The Amazon EC2 security group IDs associated with the VPC connection.

* @public */ - AwsAccountId: string | undefined; + SecurityGroupIds?: string[] | undefined; /** - *

The ID for the dashboard.

+ *

A list of IP addresses of DNS resolver endpoints for the VPC connection.

* @public */ - DashboardId: string | undefined; + DnsResolvers?: string[] | undefined; /** - *

The permissions that you want to grant on this resource.

+ *

The status of the VPC connection.

* @public */ - GrantPermissions?: ResourcePermission[] | undefined; + Status?: VPCConnectionResourceStatus | undefined; /** - *

The permissions that you want to revoke from this resource.

+ *

The availability status of the VPC connection.

* @public */ - RevokePermissions?: ResourcePermission[] | undefined; + AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; /** - *

Grants link permissions to all users in a defined namespace.

+ *

A list of network interfaces.

* @public */ - GrantLinkPermissions?: ResourcePermission[] | undefined; + NetworkInterfaces?: NetworkInterface[] | undefined; /** - *

Revokes link permissions from all users in a defined namespace.

+ *

The ARN of the IAM role associated + * with the VPC connection.

* @public */ - RevokeLinkPermissions?: ResourcePermission[] | undefined; -} + RoleArn?: string | undefined; -/** - * @public - */ -export interface UpdateDashboardPermissionsResponse { /** - *

The Amazon Resource Name (ARN) of the dashboard.

+ *

The time that the VPC connection was created.

* @public */ - DashboardArn?: string | undefined; + CreatedTime?: Date | undefined; /** - *

The ID for the dashboard.

+ *

The time that the VPC connection was last updated.

* @public */ - DashboardId?: string | undefined; + LastUpdatedTime?: Date | undefined; +} +/** + * @public + */ +export interface ListVPCConnectionsResponse { /** - *

Information about the permissions on the dashboard.

+ *

A VPCConnectionSummaries object that returns a summary of VPC connection + * objects.

* @public */ - Permissions?: ResourcePermission[] | undefined; + VPCConnectionSummaries?: VPCConnectionSummary[] | 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.

@@ -6966,182 +7136,307 @@ export interface UpdateDashboardPermissionsResponse { * @public */ Status?: number | undefined; +} + +/** + * @public + * @enum + */ +export const PurchaseMode = { + AUTO_PURCHASE: "AUTO_PURCHASE", + MANUAL: "MANUAL", +} as const; + +/** + * @public + */ +export type PurchaseMode = (typeof PurchaseMode)[keyof typeof PurchaseMode]; +/** + * @public + */ +export interface PutDataSetRefreshPropertiesRequest { /** - *

Updates the permissions of a shared link to an Amazon QuickSight dashboard.

+ *

The Amazon Web Services account ID.

* @public */ - LinkSharingConfiguration?: LinkSharingConfiguration | undefined; + AwsAccountId: string | undefined; + + /** + *

The ID of the dataset.

+ * @public + */ + DataSetId: string | undefined; + + /** + *

The dataset refresh properties.

+ * @public + */ + DataSetRefreshProperties: DataSetRefreshProperties | undefined; } /** * @public */ -export interface UpdateDashboardPublishedVersionRequest { +export interface PutDataSetRefreshPropertiesResponse { /** - *

The ID of the Amazon Web Services account that contains the dashboard that you're - * updating.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - AwsAccountId: string | undefined; + RequestId?: string | undefined; /** - *

The ID for the dashboard.

+ *

The HTTP status of the request.

* @public */ - DashboardId: string | undefined; + Status?: number | undefined; +} +/** + * @public + */ +export interface RegisterUserRequest { /** - *

The version number of the dashboard.

+ *

The identity type that your Amazon QuickSight account uses to manage the identity of users.

+ * @public + */ + IdentityType: IdentityType | undefined; + + /** + *

The email address of the user that you want to register.

+ * @public + */ + Email: string | undefined; + + /** + *

The Amazon QuickSight role for the user. The user role can be one of the + * following:

+ *
    + *
  • + *

    + * READER: A user who has read-only access to dashboards.

    + *
  • + *
  • + *

    + * AUTHOR: A user who can create data sources, datasets, analyses, and + * dashboards.

    + *
  • + *
  • + *

    + * ADMIN: A user who is an author, who can also manage Amazon QuickSight + * settings.

    + *
  • + *
  • + *

    + * READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

    + *
  • + *
  • + *

    + * AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

    + *
  • + *
  • + *

    + * ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.

    + *
  • + *
  • + *

    + * RESTRICTED_READER: This role isn't currently available for + * use.

    + *
  • + *
  • + *

    + * RESTRICTED_AUTHOR: This role isn't currently available for + * use.

    + *
  • + *
* @public */ - VersionNumber: number | undefined; -} + UserRole: UserRole | undefined; -/** - * @public - */ -export interface UpdateDashboardPublishedVersionResponse { /** - *

The ID for the dashboard.

+ *

The ARN of the IAM user or role that you are registering with Amazon QuickSight.

* @public */ - DashboardId?: string | undefined; + IamArn?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the dashboard.

+ *

You need to use this parameter only when you register one or more users using an assumed + * IAM role. You don't need to provide the session name for other scenarios, for example when + * you are registering an IAM user or an Amazon QuickSight user. You can register multiple + * users using the same IAM role if each user has a different session name. For more + * information on assuming IAM roles, see + * assume-role + * in the CLI Reference. + *

* @public */ - DashboardArn?: string | undefined; + SessionName?: string | undefined; /** - *

The HTTP status of the request.

+ *

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 */ - Status?: number | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The namespace. Currently, you should set this to default.

* @public */ - RequestId?: string | undefined; -} + Namespace: string | undefined; -/** - * @public - */ -export interface UpdateDataSetRequest { /** - *

The Amazon Web Services account ID.

+ *

The Amazon QuickSight user name that you want to create for the user you are + * registering.

* @public */ - AwsAccountId: string | undefined; + UserName?: string | undefined; /** - *

The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each - * Amazon Web Services account.

+ *

(Enterprise edition only) The name of the custom permissions profile that you want to + * assign to this user. Customized permissions allows you to control a user's access by + * restricting access the following operations:

+ *
    + *
  • + *

    Create and update data sources

    + *
  • + *
  • + *

    Create and update datasets

    + *
  • + *
  • + *

    Create and update email reports

    + *
  • + *
  • + *

    Subscribe to email reports

    + *
  • + *
+ *

To add custom permissions to an existing user, use + * UpdateUser + * instead.

+ *

A set of custom permissions includes any combination of these restrictions. Currently, + * you need to create the profile names for custom permission sets by using the Amazon QuickSight + * console. Then, you use the RegisterUser API operation to assign the named set of + * permissions to a Amazon QuickSight user.

+ *

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they + * override the permissions typically granted by assigning Amazon QuickSight users to one of the + * default security cohorts in Amazon QuickSight (admin, author, reader, admin pro, author pro, reader pro).

+ *

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

* @public */ - DataSetId: string | undefined; + CustomPermissionsName?: string | undefined; /** - *

The display name for the dataset.

+ *

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

+ *
    + *
  • + *

    + * COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

    + *
  • + *
  • + *

    + * CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

    + *
  • + *
* @public */ - Name: string | undefined; + ExternalLoginFederationProviderType?: string | undefined; /** - *

Declares the physical tables that are available in the underlying data sources.

+ *

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate + * into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should + * only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

* @public */ - PhysicalTableMap: Record | undefined; + CustomFederationProviderUrl?: string | undefined; /** - *

Configures the combination and transformation of the data from the physical tables.

+ *

The identity ID for a user in the external login provider.

* @public */ - LogicalTableMap?: Record | undefined; + ExternalLoginId?: string | undefined; /** - *

Indicates whether you want to import the data into SPICE.

+ *

The tags to associate with the user.

* @public */ - ImportMode: DataSetImportMode | undefined; + Tags?: Tag[] | undefined; +} +/** + * @public + */ +export interface RegisterUserResponse { /** - *

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

+ *

The user's user name.

* @public */ - ColumnGroups?: ColumnGroup[] | undefined; + User?: User | undefined; /** - *

The folder that contains fields and nested subfolders for your dataset.

+ *

The URL the user visits to complete registration and provide a password. This is + * returned only for users with an identity type of QUICKSIGHT.

* @public */ - FieldFolders?: Record | undefined; + UserInvitationUrl?: string | undefined; /** - *

The row-level security configuration for the data you want to create.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; + RequestId?: string | undefined; /** - *

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

+ *

The HTTP status of the request.

* @public */ - RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration | undefined; + Status?: number | undefined; +} +/** + * @public + */ +export interface RestoreAnalysisRequest { /** - *

A set of one or more definitions of a - * ColumnLevelPermissionRule - * .

+ *

The ID of the Amazon Web Services account that contains the analysis.

* @public */ - ColumnLevelPermissionRules?: ColumnLevelPermissionRule[] | undefined; + AwsAccountId: string | undefined; /** - *

The usage configuration to apply to child datasets that reference this dataset as a source.

+ *

The ID of the analysis that you're restoring.

* @public */ - DataSetUsageConfiguration?: DataSetUsageConfiguration | undefined; + AnalysisId: string | undefined; /** - *

The parameter declarations of the dataset.

+ *

A boolean value that determines if the analysis will be restored to folders that it previously resided in. A True value restores analysis back to all folders that it previously resided in. A False value restores the analysis but does not restore the analysis back to all previously resided folders. Restoring a restricted analysis requires this parameter to be set to True.

* @public */ - DatasetParameters?: DatasetParameter[] | undefined; + RestoreToFolders?: boolean | undefined; } /** * @public */ -export interface UpdateDataSetResponse { - /** - *

The Amazon Resource Name (ARN) of the dataset.

- * @public - */ - Arn?: string | undefined; - +export interface RestoreAnalysisResponse { /** - *

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 ARN for the ingestion, which is triggered as a result of dataset creation if the import - * mode is SPICE.

+ *

The Amazon Resource Name (ARN) of the analysis that you're restoring.

* @public */ - IngestionArn?: string | undefined; + Arn?: string | undefined; /** - *

The ID of the ingestion, which is triggered as a result of dataset creation if the import - * mode is SPICE.

+ *

The ID of the analysis that you're restoring. + *

* @public */ - IngestionId?: string | undefined; + AnalysisId?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -7150,161 +7445,139 @@ export interface UpdateDataSetResponse { RequestId?: string | undefined; /** - *

The HTTP status of the request.

+ *

A list of folder arns thatthe analysis failed to be restored to.

* @public */ - Status?: number | undefined; + RestorationFailedFolderArns?: string[] | undefined; } /** * @public */ -export interface UpdateDataSetPermissionsRequest { +export interface SearchAnalysesRequest { /** - *

The Amazon Web Services account ID.

+ *

The ID of the Amazon Web Services account that contains the analyses that you're searching + * for.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the dataset whose permissions you want to update. This ID is unique per - * Amazon Web Services Region for each Amazon Web Services account.

+ *

The structure for the search filters that you want to apply to your search.

* @public */ - DataSetId: string | undefined; + Filters: AnalysisSearchFilter[] | undefined; /** - *

The resource permissions that you want to grant to the dataset.

+ *

A pagination token that can be used in a subsequent request.

* @public */ - GrantPermissions?: ResourcePermission[] | undefined; + NextToken?: string | undefined; /** - *

The resource permissions that you want to revoke from the dataset.

+ *

The maximum number of results to return.

* @public */ - RevokePermissions?: ResourcePermission[] | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface UpdateDataSetPermissionsResponse { +export interface SearchAnalysesResponse { /** - *

The Amazon Resource Name (ARN) of the dataset.

+ *

Metadata describing the analyses that you searched for.

* @public */ - DataSetArn?: string | undefined; + AnalysisSummaryList?: AnalysisSummary[] | undefined; /** - *

The ID for the dataset whose permissions you want to update. This ID is unique per - * Amazon Web Services Region for each Amazon Web Services account.

+ *

A pagination token that can be used in a subsequent request. + *

* @public */ - DataSetId?: string | undefined; + NextToken?: string | 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 UpdateDataSourceRequest { +export interface SearchDashboardsRequest { /** - *

The Amazon Web Services account ID.

+ *

The ID of the Amazon Web Services account that contains the user whose dashboards you're searching + * for.

* @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; - - /** - *

A display name for the data source.

- * @public - */ - Name: string | undefined; - - /** - *

The parameters that Amazon QuickSight uses to connect to your underlying source.

- * @public - */ - DataSourceParameters?: DataSourceParameters | undefined; - - /** - *

The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently, - * only credentials based on user name and password are supported.

+ *

The filters to apply to the search. Currently, you can search only by user name, for + * example, "Filters": [ \{ "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", + * "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" \} ] + *

* @public */ - Credentials?: DataSourceCredentials | undefined; + Filters: DashboardSearchFilter[] | undefined; /** - *

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to - * your underlying source.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - VpcConnectionProperties?: VpcConnectionProperties | undefined; + NextToken?: string | undefined; /** - *

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying - * source.

+ *

The maximum number of results to be returned per request.

* @public */ - SslProperties?: SslProperties | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface UpdateDataSourceResponse { +export interface SearchDashboardsResponse { /** - *

The Amazon Resource Name (ARN) of the data source.

+ *

The list of dashboards owned by the user specified in Filters in your + * request.

* @public */ - Arn?: string | undefined; + DashboardSummaryList?: DashboardSummary[] | undefined; /** - *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - DataSourceId?: string | undefined; + NextToken?: string | undefined; /** - *

The update status of the data source's last update.

+ *

The HTTP status of the request.

* @public */ - UpdateStatus?: ResourceStatus | 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 UpdateDataSourcePermissionsRequest { +export interface SearchDataSetsRequest { /** *

The Amazon Web Services account ID.

* @public @@ -7312,97 +7585,103 @@ export interface UpdateDataSourcePermissionsRequest { 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 filters to apply to the search.

* @public */ - DataSourceId: string | undefined; + Filters: DataSetSearchFilter[] | undefined; /** - *

A list of resource permissions that you want to grant on the data source.

+ *

A pagination token that can be used in a subsequent request.

* @public */ - GrantPermissions?: ResourcePermission[] | undefined; + NextToken?: string | undefined; /** - *

A list of resource permissions that you want to revoke on the data source.

+ *

The maximum number of results to be returned per request.

* @public */ - RevokePermissions?: ResourcePermission[] | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface UpdateDataSourcePermissionsResponse { +export interface SearchDataSetsResponse { /** - *

The Amazon Resource Name (ARN) of the data source.

+ *

A DataSetSummaries object that returns a summary of a dataset.

* @public */ - DataSourceArn?: string | undefined; + DataSetSummaries?: DataSetSummary[] | undefined; /** - *

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

A pagination token that can be used in a subsequent request.

* @public */ - DataSourceId?: string | undefined; + NextToken?: string | 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 UpdateFolderRequest { +export interface SearchDataSourcesRequest { /** - *

The ID for the Amazon Web Services account that contains the folder to update.

+ *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the folder.

+ *

The filters to apply to the search.

* @public */ - FolderId: string | undefined; + Filters: DataSourceSearchFilter[] | undefined; + + /** + *

A pagination token that can be used in a subsequent request.

+ * @public + */ + NextToken?: string | undefined; /** - *

The name of the folder.

+ *

The maximum number of results to be returned per request.

* @public */ - Name: string | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface UpdateFolderResponse { +export interface SearchDataSourcesResponse { /** - *

The HTTP status of the request.

+ *

A DataSourceSummaries object that returns a summary of a data source.

* @public */ - Status?: number | undefined; + DataSourceSummaries?: DataSourceSummary[] | undefined; /** - *

The Amazon Resource Name (ARN) of the folder.

+ *

A pagination token that can be used in a subsequent request.

* @public */ - Arn?: string | undefined; + NextToken?: string | undefined; /** - *

The ID of the folder.

+ *

The HTTP status of the request.

* @public */ - FolderId?: string | undefined; + Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -7414,36 +7693,36 @@ export interface UpdateFolderResponse { /** * @public */ -export interface UpdateFolderPermissionsRequest { +export interface SearchFoldersRequest { /** - *

The ID for the Amazon Web Services account that contains the folder to update.

+ *

The ID for the Amazon Web Services account that contains the folder.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the folder.

+ *

The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ \{ "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" \} ].

* @public */ - FolderId: string | undefined; + Filters: FolderSearchFilter[] | undefined; /** - *

The permissions that you want to grant on a resource. Namespace ARNs are not supported Principal values for folder permissions.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - GrantPermissions?: ResourcePermission[] | undefined; + NextToken?: string | undefined; /** - *

The permissions that you want to revoke from a resource. Namespace ARNs are not supported Principal values for folder permissions.

+ *

The maximum number of results to be returned per request.

* @public */ - RevokePermissions?: ResourcePermission[] | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface UpdateFolderPermissionsResponse { +export interface SearchFoldersResponse { /** *

The HTTP status of the request.

* @public @@ -7451,22 +7730,16 @@ export interface UpdateFolderPermissionsResponse { Status?: number | undefined; /** - *

The Amazon Resource Name (ARN) of the folder.

- * @public - */ - Arn?: string | undefined; - - /** - *

The ID of the folder.

+ *

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

* @public */ - FolderId?: string | undefined; + FolderSummaryList?: FolderSummary[] | undefined; /** - *

Information about the permissions for the folder.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - Permissions?: ResourcePermission[] | undefined; + NextToken?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -7478,42 +7751,54 @@ export interface UpdateFolderPermissionsResponse { /** * @public */ -export interface UpdateGroupRequest { +export interface SearchGroupsRequest { /** - *

The name of the group that you want to update.

+ *

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 */ - GroupName: string | undefined; + AwsAccountId: string | undefined; /** - *

The description for the group that you want to update.

+ *

A pagination token that can be used in a subsequent request.

* @public */ - Description?: string | undefined; + NextToken?: 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 maximum number of results to return from this request.

* @public */ - AwsAccountId: string | undefined; + MaxResults?: number | undefined; /** - *

The namespace of the group that you want to update.

+ *

The namespace that you want to search.

* @public */ Namespace: string | undefined; + + /** + *

The structure for the search filters that you want to apply to your search.

+ * @public + */ + Filters: GroupSearchFilter[] | undefined; } /** * @public */ -export interface UpdateGroupResponse { +export interface SearchGroupsResponse { /** - *

The name of the group.

+ *

A list of groups in a specified namespace that match the filters you set in your SearchGroups request.

* @public */ - Group?: Group | undefined; + GroupList?: Group[] | undefined; + + /** + *

A pagination token that can be used in a subsequent request.

+ * @public + */ + NextToken?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -7530,227 +7815,258 @@ export interface UpdateGroupResponse { /** * @public + * @enum */ -export interface UpdateIAMPolicyAssignmentRequest { - /** - *

The ID of the Amazon Web Services account that contains the IAM policy - * assignment.

- * @public - */ - AwsAccountId: string | undefined; +export const TopicFilterAttribute = { + 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", + TOPIC_NAME: "TOPIC_NAME", +} as const; - /** - *

The name of the assignment, also called a rule. - * The - * name must be unique within the - * Amazon Web Services account.

- * @public - */ - AssignmentName: string | undefined; +/** + * @public + */ +export type TopicFilterAttribute = (typeof TopicFilterAttribute)[keyof typeof TopicFilterAttribute]; - /** - *

The namespace of the assignment.

- * @public - */ - Namespace: string | undefined; +/** + * @public + * @enum + */ +export const TopicFilterOperator = { + StringEquals: "StringEquals", + StringLike: "StringLike", +} as const; + +/** + * @public + */ +export type TopicFilterOperator = (typeof TopicFilterOperator)[keyof typeof TopicFilterOperator]; +/** + *

The filter that is used to search for a topic.

+ * @public + */ +export interface TopicSearchFilter { /** - *

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 operator like equals or like.

* @public */ - AssignmentStatus?: AssignmentStatus | undefined; + Operator: TopicFilterOperator | undefined; /** - *

The ARN for the IAM policy to apply to the Amazon QuickSight users and - * groups specified in this assignment.

+ *

The name of the topic search filter.

* @public */ - PolicyArn?: string | undefined; + Name: TopicFilterAttribute | undefined; /** - *

The Amazon QuickSight users, groups, or both that you want to assign the policy - * to.

+ *

The value of the topic search filter.

* @public */ - Identities?: Record | undefined; + Value: string | undefined; } /** * @public */ -export interface UpdateIAMPolicyAssignmentResponse { +export interface SearchTopicsRequest { /** - *

The name of the assignment or rule.

+ *

The ID of the Amazon Web Services account that contains the topic that you want to find.

* @public */ - AssignmentName?: string | undefined; + AwsAccountId: string | undefined; /** - *

The ID of the assignment.

+ *

The filters that you want to use to search for the topic.

* @public */ - AssignmentId?: string | undefined; + Filters: TopicSearchFilter[] | undefined; /** - *

The ARN for the IAM policy applied to the Amazon QuickSight users and - * groups specified in this assignment.

+ *

The token for the next set of results, or null if there are no more results.

* @public */ - PolicyArn?: string | undefined; + NextToken?: string | undefined; /** - *

The Amazon QuickSight users, groups, or both that the IAM policy is - * assigned to.

+ *

The maximum number of results to be returned per request.

* @public */ - Identities?: Record | undefined; + MaxResults?: number | undefined; +} +/** + * @public + */ +export interface SearchTopicsResponse { /** - *

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.

    - *
  • - *
+ *

A list of topic summaries that is returned by the search topic request.

* @public */ - AssignmentStatus?: AssignmentStatus | undefined; + TopicSummaryList?: TopicSummary[] | 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 request.

* @public */ Status?: number | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; } /** * @public */ -export interface UpdateIdentityPropagationConfigRequest { +export interface StartAssetBundleExportJobRequest { /** - *

The ID of the Amazon Web Services account that contains the identity propagation configuration that you want to update.

+ *

The ID of the Amazon Web Services account to export assets from.

* @public */ AwsAccountId: string | undefined; /** - *

The name of the Amazon Web Services service that contains the authorized targets that you want to add or update.

+ *

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

+ * @public + */ + AssetBundleExportJobId: string | undefined; + + /** + *

An array of resource ARNs to export. The following resources are supported.

+ *
    + *
  • + *

    + * Analysis + *

    + *
  • + *
  • + *

    + * Dashboard + *

    + *
  • + *
  • + *

    + * DataSet + *

    + *
  • + *
  • + *

    + * DataSource + *

    + *
  • + *
  • + *

    + * RefreshSchedule + *

    + *
  • + *
  • + *

    + * Theme + *

    + *
  • + *
  • + *

    + * VPCConnection + *

    + *
  • + *
+ *

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

* @public */ - Service: ServiceType | undefined; + ResourceArns: string[] | undefined; /** - *

Specifies a list of application ARNs that represent the authorized targets for a service.

+ *

A Boolean that determines whether all dependencies of each resource ARN are recursively + * exported with the job. For example, say you provided a Dashboard ARN to the + * ResourceArns parameter. If you set IncludeAllDependencies to + * TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also + * exported.

* @public */ - AuthorizedTargets?: string[] | undefined; -} + IncludeAllDependencies?: boolean | undefined; -/** - * @public - */ -export interface UpdateIdentityPropagationConfigResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

The export data format.

* @public */ - RequestId?: string | undefined; + ExportFormat: AssetBundleExportFormat | undefined; /** - *

The HTTP status of the request.

+ *

An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

+ *

Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.

* @public */ - Status?: number | undefined; -} + CloudFormationOverridePropertyConfiguration?: AssetBundleCloudFormationOverridePropertyConfiguration | undefined; -/** - * @public - */ -export interface UpdateIpRestrictionRequest { /** - *

The ID of the Amazon Web Services account that contains the IP rules.

+ *

A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported. + *

* @public */ - AwsAccountId: string | undefined; + IncludePermissions?: boolean | undefined; /** - *

A map that describes the updated IP rules with CIDR ranges and descriptions.

+ *

A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

* @public */ - IpRestrictionRuleMap?: Record | undefined; + IncludeTags?: boolean | undefined; /** - *

A map of VPC IDs and their corresponding rules. When you configure this parameter, traffic from all VPC endpoints that are present in the specified VPC is allowed.

+ *

An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

* @public */ - VpcIdRestrictionRuleMap?: Record | undefined; + ValidationStrategy?: AssetBundleExportJobValidationStrategy | undefined; /** - *

A map of allowed VPC endpoint IDs and their corresponding rule descriptions.

+ *

A Boolean that determines if the exported asset carries over information about the folders that the asset is a member of.

* @public */ - VpcEndpointIdRestrictionRuleMap?: Record | undefined; + IncludeFolderMemberships?: boolean | undefined; /** - *

A value that specifies whether IP rules are turned on.

+ *

A setting that indicates whether you want to include folder assets. You can also use this setting to recusrsively include all subfolders of an exported folder.

* @public */ - Enabled?: boolean | undefined; + IncludeFolderMembers?: IncludeFolderMembers | undefined; } /** * @public */ -export interface UpdateIpRestrictionResponse { +export interface StartAssetBundleExportJobResponse { /** - *

The ID of the Amazon Web Services account that contains the IP rules.

+ *

The Amazon Resource Name (ARN) for the export job.

* @public */ - AwsAccountId?: string | undefined; + Arn?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

+ * @public + */ + AssetBundleExportJobId?: string | undefined; + + /** + *

The Amazon Web Services response ID for this operation.

* @public */ RequestId?: string | undefined; /** - *

The HTTP status of the request.

+ *

The HTTP status of the response.

* @public */ Status?: number | undefined; @@ -7759,228 +8075,220 @@ export interface UpdateIpRestrictionResponse { /** * @public */ -export interface UpdateKeyRegistrationRequest { +export interface StartAssetBundleImportJobRequest { /** - *

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to update.

+ *

The ID of the Amazon Web Services account to import assets into.

* @public */ AwsAccountId: string | undefined; /** - *

A list of RegisteredCustomerManagedKey objects to be updated to the Amazon QuickSight account.

+ *

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

* @public */ - KeyRegistration: RegisteredCustomerManagedKey[] | undefined; -} + AssetBundleImportJobId: string | undefined; -/** - *

A success entry that occurs when a KeyRegistration job is successfully applied to the Amazon QuickSight account.

- * @public - */ -export interface SuccessfulKeyRegistrationEntry { /** - *

The ARN of the KMS key that is associated with the SuccessfulKeyRegistrationEntry entry.

+ *

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format. + *

* @public */ - KeyArn: string | undefined; + AssetBundleImportSource: AssetBundleImportSource | undefined; /** - *

The HTTP status of a SuccessfulKeyRegistrationEntry entry.

+ *

Optional overrides that are applied to the resource configuration before import.

* @public */ - StatusCode: number | undefined; -} + OverrideParameters?: AssetBundleImportJobOverrideParameters | undefined; + + /** + *

The failure action for the import job.

+ *

If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.

+ *

If you choose DO_NOTHING, failed import jobs will not attempt to roll back + * any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.

+ * @public + */ + FailureAction?: AssetBundleImportFailureAction | undefined; -/** - * @public - */ -export interface UpdateKeyRegistrationResponse { /** - *

A list of all customer managed key registrations that failed to update.

+ *

Optional permission overrides that are applied to the resource configuration before import.

* @public */ - FailedKeyRegistration?: FailedKeyRegistrationEntry[] | undefined; + OverridePermissions?: AssetBundleImportJobOverridePermissions | undefined; /** - *

A list of all customer managed key registrations that were successfully updated.

+ *

Optional tag overrides that are applied to the resource configuration before import.

* @public */ - SuccessfulKeyRegistration?: SuccessfulKeyRegistrationEntry[] | undefined; + OverrideTags?: AssetBundleImportJobOverrideTags | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.

* @public */ - RequestId?: string | undefined; + OverrideValidationStrategy?: AssetBundleImportJobOverrideValidationStrategy | undefined; } /** * @public */ -export interface UpdatePublicSharingSettingsRequest { +export interface StartAssetBundleImportJobResponse { /** - *

The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

+ *

The Amazon Resource Name (ARN) for the import job.

* @public */ - AwsAccountId: string | undefined; + Arn?: string | undefined; /** - *

A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.

+ *

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

* @public */ - PublicSharingEnabled?: boolean | undefined; -} + AssetBundleImportJobId?: string | undefined; -/** - * @public - */ -export interface UpdatePublicSharingSettingsResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

The Amazon Web Services response ID for this operation.

* @public */ RequestId?: string | undefined; /** - *

The HTTP status of the request.

+ *

The HTTP status of the response.

* @public */ Status?: number | undefined; } /** + *

A structure that contains information on the anonymous user configuration.

* @public */ -export interface UpdateQPersonalizationConfigurationRequest { - /** - *

The ID of the Amazon Web Services account account that contains the personalization configuration that the user wants to update.

- * @public - */ - AwsAccountId: string | undefined; - +export interface SnapshotAnonymousUser { /** - *

An option to allow Amazon QuickSight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance.

+ *

The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a DataSet$RowLevelPermissionTagConfiguration API call.

+ *

These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon QuickSight, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

* @public */ - PersonalizationMode: PersonalizationMode | undefined; + RowLevelPermissionTags?: SessionTag[] | undefined; } /** + *

A structure that contains information about the users that the dashboard snapshot is generated for.

* @public */ -export interface UpdateQPersonalizationConfigurationResponse { +export interface SnapshotUserConfiguration { /** - *

The personalization mode that is used for the personalization configuration.

+ *

An array of records that describe the anonymous users that the dashboard snapshot is generated for.

* @public */ - PersonalizationMode?: PersonalizationMode | undefined; + AnonymousUsers?: SnapshotAnonymousUser[] | undefined; +} +/** + * @public + */ +export interface StartDashboardSnapshotJobRequest { /** - *

The Amazon Web Services request ID for this operation.

+ *

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

* @public */ - RequestId?: string | undefined; + AwsAccountId: string | undefined; /** - *

The HTTP status of the request.

+ *

The ID of the dashboard that you want to start a snapshot job for. + *

* @public */ - Status?: number | undefined; -} + DashboardId: string | undefined; -/** - * @public - */ -export interface UpdateRefreshScheduleRequest { /** - *

The ID of the dataset.

+ *

An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.

* @public */ - DataSetId: string | undefined; + SnapshotJobId: string | undefined; /** - *

The Amazon Web Services account ID.

+ *

+ * A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.

* @public */ - AwsAccountId: string | undefined; + UserConfiguration: SnapshotUserConfiguration | undefined; /** - *

The refresh schedule.

+ *

A structure that describes the configuration of the dashboard snapshot.

* @public */ - Schedule: RefreshSchedule | undefined; + SnapshotConfiguration: SnapshotConfiguration | undefined; } /** * @public */ -export interface UpdateRefreshScheduleResponse { +export interface StartDashboardSnapshotJobResponse { /** - *

The HTTP status of the request.

+ *

The Amazon Resource Name (ARN) for the dashboard snapshot job.

* @public */ - Status?: number | undefined; + Arn?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The ID of the job. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

* @public */ - RequestId?: string | undefined; + SnapshotJobId?: string | undefined; /** - *

The ID of the refresh schedule.

+ *

+ * The Amazon Web Services request ID for this operation. + *

* @public */ - ScheduleId?: string | undefined; + 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 UpdateRoleCustomPermissionRequest { - /** - *

The name of the custom permission that you want to update the role with.

- * @public - */ - CustomPermissionsName: string | undefined; - +export interface StartDashboardSnapshotJobScheduleRequest { /** - *

The name of role tht you want to update.

+ *

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

* @public */ - Role: Role | 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 dashboard that you want to start a snapshot job schedule for. + *

* @public */ - AwsAccountId: string | undefined; + DashboardId: string | undefined; /** - *

The namespace that contains the role that you want to update.

+ *

The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the Amazon QuickSight console in the Schedules pane of the dashboard that the schedule is configured for.

* @public */ - Namespace: string | undefined; + ScheduleId: string | undefined; } /** * @public */ -export interface UpdateRoleCustomPermissionResponse { +export interface StartDashboardSnapshotJobScheduleResponse { /** - *

The Amazon Web Services request ID for this operation.

+ *

+ * The Amazon Web Services request ID for this operation. + *

* @public */ RequestId?: string | undefined; /** - *

The HTTP status of the request.

+ *

The HTTP status of the request

* @public */ Status?: number | undefined; @@ -7989,34 +8297,24 @@ export interface UpdateRoleCustomPermissionResponse { /** * @public */ -export interface UpdateSPICECapacityConfigurationRequest { +export interface TagResourceRequest { /** - *

The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.

+ *

The Amazon Resource Name (ARN) of the resource that you want to tag.

* @public */ - AwsAccountId: string | undefined; + ResourceArn: string | undefined; /** - *

Determines how SPICE capacity can be purchased. The following options are available.

- *
    - *
  • - *

    - * MANUAL: SPICE capacity can only be purchased manually.

    - *
  • - *
  • - *

    - * AUTO_PURCHASE: Extra SPICE capacity is automatically purchased on your behalf as needed. SPICE capacity can also be purchased manually with this option.

    - *
  • - *
+ *

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

* @public */ - PurchaseMode: PurchaseMode | undefined; + Tags: Tag[] | undefined; } /** * @public */ -export interface UpdateSPICECapacityConfigurationResponse { +export interface TagResourceResponse { /** *

The Amazon Web Services request ID for this operation.

* @public @@ -8033,210 +8331,142 @@ export interface UpdateSPICECapacityConfigurationResponse { /** * @public */ -export interface UpdateTemplateRequest { - /** - *

The ID of the Amazon Web Services account that contains the template that you're updating.

- * @public - */ - AwsAccountId: string | undefined; - - /** - *

The ID for the template.

- * @public - */ - TemplateId: string | undefined; - - /** - *

The entity that you are using as a source when you update 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.

- * @public - */ - SourceEntity?: TemplateSourceEntity | undefined; - - /** - *

A description of the current template version that is being updated. Every time you call - * UpdateTemplate, you create a new version of the template. Each version - * of the template maintains a description of the version in the - * VersionDescription field.

- * @public - */ - VersionDescription?: string | undefined; - - /** - *

The name for the template.

- * @public - */ - Name?: string | undefined; - +export interface UntagResourceRequest { /** - *

The definition of a template.

- *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

+ *

The Amazon Resource Name (ARN) of the resource that you want to untag.

* @public */ - Definition?: TemplateVersionDefinition | undefined; + ResourceArn: string | undefined; /** - *

The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.

+ *

The keys of the key-value pairs for the resource tag or tags assigned to the resource.

* @public */ - ValidationStrategy?: ValidationStrategy | undefined; + TagKeys: string[] | undefined; } /** * @public */ -export interface UpdateTemplateResponse { - /** - *

The ID for the template.

- * @public - */ - TemplateId?: string | undefined; - +export interface UntagResourceResponse { /** - *

The Amazon Resource Name (ARN) for the template.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Arn?: string | undefined; + RequestId?: string | undefined; /** - *

The ARN for the template, including the version information of the first version.

+ *

The HTTP status of the request.

* @public */ - VersionArn?: string | undefined; + Status?: number | undefined; +} +/** + * @public + */ +export interface UpdateAccountCustomizationRequest { /** - *

The creation status of the template.

+ *

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations + * for.

* @public */ - CreationStatus?: ResourceStatus | undefined; + AwsAccountId: string | undefined; /** - *

The HTTP status of the request.

+ *

The namespace that you want to update Amazon QuickSight customizations for.

* @public */ - Status?: number | undefined; + Namespace?: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

* @public */ - RequestId?: string | undefined; + AccountCustomization: AccountCustomization | undefined; } /** * @public */ -export interface UpdateTemplateAliasRequest { +export interface UpdateAccountCustomizationResponse { /** - *

The ID of the Amazon Web Services account that contains the template alias that you're updating.

+ *

The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.

* @public */ - AwsAccountId: string | undefined; + Arn?: string | undefined; /** - *

The ID for the template.

+ *

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations + * for.

* @public */ - TemplateId: string | undefined; + AwsAccountId?: string | undefined; /** - *

The alias of the template that you want to update. If you name a specific alias, you update - * 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 namespace associated with the customization that you're updating.

* @public */ - AliasName: string | undefined; + Namespace?: string | undefined; /** - *

The version number of the template.

+ *

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

* @public */ - TemplateVersionNumber: number | undefined; -} + AccountCustomization?: AccountCustomization | undefined; -/** - * @public - */ -export interface UpdateTemplateAliasResponse { /** - *

The template alias.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - TemplateAlias?: TemplateAlias | 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 UpdateTemplatePermissionsRequest { +export interface UpdateAccountSettingsRequest { /** - *

The ID of the Amazon Web Services account that contains the template.

+ *

The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to + * list.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the template.

+ *

The default namespace for this Amazon Web Services account. Currently, the default is + * default. IAM users that + * register for the first time with Amazon QuickSight provide an email address that becomes + * associated with the default namespace. + *

* @public */ - TemplateId: string | undefined; + DefaultNamespace: string | undefined; /** - *

A list of resource permissions to be granted on the template.

+ *

The email address that you want Amazon QuickSight to send notifications to regarding your + * Amazon Web Services account or Amazon QuickSight subscription.

* @public */ - GrantPermissions?: ResourcePermission[] | undefined; + NotificationEmail?: string | undefined; /** - *

A list of resource permissions to be revoked from the template.

+ *

A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.

* @public */ - RevokePermissions?: ResourcePermission[] | undefined; + TerminationProtectionEnabled?: boolean | undefined; } /** * @public */ -export interface UpdateTemplatePermissionsResponse { - /** - *

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; - +export interface UpdateAccountSettingsResponse { /** *

The Amazon Web Services request ID for this operation.

* @public @@ -8253,74 +8483,84 @@ export interface UpdateTemplatePermissionsResponse { /** * @public */ -export interface UpdateThemeRequest { +export interface UpdateAnalysisRequest { /** - *

The ID of the Amazon Web Services account that contains the theme that you're updating.

+ *

The ID of the Amazon Web Services account that contains the analysis that you're updating.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the theme.

+ *

The ID for the analysis that you're updating. This ID displays in the URL of the + * analysis.

* @public */ - ThemeId: string | undefined; + AnalysisId: string | undefined; /** - *

The name for the theme.

+ *

A descriptive name for the analysis that you're updating. This name displays for the + * analysis in the Amazon QuickSight console.

* @public */ - Name?: string | undefined; + Name: string | undefined; /** - *

The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. - * All themes initially inherit from a default Amazon QuickSight theme.

+ *

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 */ - BaseThemeId: string | undefined; + Parameters?: _Parameters | undefined; /** - *

A description of the theme version that you're updating Every time that you call - * UpdateTheme, you create a new version of the theme. Each version of the - * theme maintains a description of the version in VersionDescription.

+ *

A source entity to use for the analysis that you're updating. This metadata structure + * contains details that describe a source template and one or more datasets.

* @public */ - VersionDescription?: string | undefined; + SourceEntity?: AnalysisSourceEntity | undefined; /** - *

The theme configuration, which contains the theme display properties.

+ *

The Amazon Resource Name (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 */ - Configuration?: ThemeConfiguration | undefined; -} + ThemeArn?: string | undefined; -/** - * @public - */ -export interface UpdateThemeResponse { /** - *

The ID for the theme.

+ *

The definition of an analysis.

+ *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

* @public */ - ThemeId?: string | undefined; + Definition?: AnalysisDefinition | undefined; + + /** + *

The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.

+ * @public + */ + ValidationStrategy?: ValidationStrategy | undefined; +} +/** + * @public + */ +export interface UpdateAnalysisResponse { /** - *

The Amazon Resource Name (ARN) for the theme.

+ *

The ARN of the analysis that you're updating.

* @public */ Arn?: string | undefined; /** - *

The Amazon Resource Name (ARN) for the new version of the theme.

+ *

The ID of the analysis.

* @public */ - VersionArn?: string | undefined; + AnalysisId?: string | undefined; /** - *

The creation status of the theme.

+ *

The update status of the last update that was made to the analysis.

* @public */ - CreationStatus?: ResourceStatus | undefined; + UpdateStatus?: ResourceStatus | undefined; /** *

The HTTP status of the request.

@@ -8338,106 +8578,139 @@ export interface UpdateThemeResponse { /** * @public */ -export interface UpdateThemeAliasRequest { +export interface UpdateAnalysisPermissionsRequest { /** - *

The ID of the Amazon Web Services account that contains the theme alias that you're updating.

+ *

The ID of the Amazon Web Services account that contains the analysis whose permissions you're + * updating. You must be using the Amazon Web Services account that the analysis is in.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the theme.

+ *

The ID of the analysis whose permissions you're updating. The ID is part of the + * analysis URL.

* @public */ - ThemeId: string | undefined; + AnalysisId: string | undefined; /** - *

The name of the theme alias that you want to update.

+ *

A structure that describes the permissions to add and the principal to add them + * to.

* @public */ - AliasName: string | undefined; + GrantPermissions?: ResourcePermission[] | undefined; /** - *

The version number of the theme that the alias should reference.

+ *

A structure that describes the permissions to remove and the principal to remove them + * from.

* @public */ - ThemeVersionNumber: number | undefined; + RevokePermissions?: ResourcePermission[] | undefined; } /** * @public */ -export interface UpdateThemeAliasResponse { +export interface UpdateAnalysisPermissionsResponse { /** - *

Information about the theme alias.

+ *

The Amazon Resource Name (ARN) of the analysis that you updated.

* @public */ - ThemeAlias?: ThemeAlias | undefined; + AnalysisArn?: string | undefined; /** - *

The HTTP status of the request.

+ *

The ID of the analysis that you updated permissions for.

* @public */ - Status?: number | undefined; + AnalysisId?: string | undefined; + + /** + *

A structure that describes the principals and the resource-level permissions on an + * analysis.

+ * @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 UpdateThemePermissionsRequest { +export interface UpdateBrandRequest { /** - *

The ID of the Amazon Web Services account that contains the theme.

+ *

The ID of the Amazon Web Services account that owns the brand.

* @public */ AwsAccountId: string | undefined; /** - *

The ID for the theme.

- * @public - */ - ThemeId: string | undefined; - - /** - *

A list of resource permissions to be granted for the theme.

+ *

The ID of the Amazon QuickSight brand.

* @public */ - GrantPermissions?: ResourcePermission[] | undefined; + BrandId: string | undefined; /** - *

A list of resource permissions to be revoked from the theme.

+ *

The definition of the brand.

* @public */ - RevokePermissions?: ResourcePermission[] | undefined; + BrandDefinition?: BrandDefinition | undefined; } /** * @public */ -export interface UpdateThemePermissionsResponse { +export interface UpdateBrandResponse { /** - *

The ID for the theme.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - ThemeId?: string | undefined; + RequestId?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the theme.

+ *

The details of the brand.

* @public */ - ThemeArn?: string | undefined; + BrandDetail?: BrandDetail | undefined; /** - *

The resulting list of resource permissions for the theme.

+ *

The definition of the brand.

* @public */ - Permissions?: ResourcePermission[] | undefined; + 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 @@ -8445,187 +8718,232 @@ export interface UpdateThemePermissionsResponse { 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 UpdateTopicRequest { +export interface UpdateBrandPublishedVersionRequest { /** - *

The ID of the Amazon Web Services account that contains the topic that you want to - * update.

+ *

The ID of the Amazon Web Services account that owns the brand.

* @public */ AwsAccountId: string | 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 ID of the Amazon QuickSight brand.

* @public */ - TopicId: string | undefined; + BrandId: string | undefined; /** - *

The definition of the topic that you want to update.

+ *

The ID of the published version.

* @public */ - Topic: TopicDetails | undefined; + VersionId: string | undefined; } /** * @public */ -export interface UpdateTopicResponse { +export interface UpdateBrandPublishedVersionResponse { /** - *

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 Amazon Web Services request ID for this operation.

* @public */ - TopicId?: string | undefined; + RequestId?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the topic.

+ *

The ID of the published version.

* @public */ - Arn?: string | undefined; + VersionId?: string | undefined; +} +/** + * @public + */ +export interface UpdateCustomPermissionsRequest { /** - *

The Amazon Resource Name (ARN) of the topic refresh.

+ *

The ID of the Amazon Web Services account that contains the custom permissions profile that you want to update.

* @public */ - RefreshArn?: string | undefined; + AwsAccountId: string | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The name of the custom permissions profile that you want to update.

* @public */ - RequestId?: string | undefined; + CustomPermissionsName: string | undefined; /** - *

The HTTP status of the request.

+ *

A set of actions to include in the custom permissions profile.

* @public */ - Status?: number | undefined; + Capabilities?: Capabilities | undefined; } /** * @public */ -export interface UpdateTopicPermissionsRequest { +export interface UpdateCustomPermissionsResponse { /** - *

The ID of the Amazon Web Services account that contains the topic that you want to update - * the permissions for.

+ *

The HTTP status of the request.

* @public */ - AwsAccountId: string | undefined; + Status?: number | 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 Amazon Resource Name (ARN) of the custom permissions profile.

* @public */ - TopicId: string | undefined; + Arn?: string | undefined; /** - *

The resource permissions that you want to grant to the topic.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - GrantPermissions?: ResourcePermission[] | undefined; + RequestId?: string | undefined; +} +/** + * @public + */ +export interface UpdateDashboardRequest { /** - *

The resource permissions that you want to revoke from the topic.

+ *

The ID of the Amazon Web Services account that contains the dashboard that you're + * updating.

* @public */ - RevokePermissions?: ResourcePermission[] | undefined; -} + AwsAccountId: string | undefined; -/** - * @public - */ -export interface UpdateTopicPermissionsResponse { /** - *

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 ID for the dashboard.

* @public */ - TopicId?: string | undefined; + DashboardId: string | undefined; /** - *

The Amazon Resource Name (ARN) of the topic.

+ *

The display name of the dashboard.

* @public */ - TopicArn?: string | undefined; + Name: string | undefined; /** - *

A list of resource permissions on the topic.

+ *

The entity that you are using as a source when you update the dashboard. In + * SourceEntity, you specify the type of object you're using as source. You + * can only update a dashboard from a template, so you use a SourceTemplate + * entity. If you need to update 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 SourceTemplate ARN 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.

* @public */ - Permissions?: ResourcePermission[] | undefined; + SourceEntity?: DashboardSourceEntity | undefined; /** - *

The HTTP status of the request.

+ *

A structure that contains the parameters of the dashboard. These are parameter + * overrides for a dashboard. A dashboard can have any type of parameters, and some + * parameters might accept multiple values.

* @public */ - Status?: number | undefined; + Parameters?: _Parameters | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

A description for the first version of the dashboard being created.

* @public */ - RequestId?: string | undefined; -} + VersionDescription?: string | undefined; -/** - * @public - */ -export interface UpdateTopicRefreshScheduleRequest { /** - *

The ID of the Amazon Web Services account that contains the topic whose refresh schedule - * you want to update.

+ *

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 */ - AwsAccountId: string | undefined; + DashboardPublishOptions?: DashboardPublishOptions | 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 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 was originally associated + * with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the + * dashboard.

* @public */ - TopicId: string | undefined; + ThemeArn?: string | undefined; /** - *

The ID of the dataset.

+ *

The definition of a dashboard.

+ *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

* @public */ - DatasetId: string | undefined; + Definition?: DashboardVersionDefinition | undefined; /** - *

The definition of a refresh schedule.

+ *

The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

* @public */ - RefreshSchedule: TopicRefreshSchedule | undefined; + ValidationStrategy?: ValidationStrategy | undefined; } /** * @public */ -export interface UpdateTopicRefreshScheduleResponse { +export interface UpdateDashboardResponse { /** - *

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 Amazon Resource Name (ARN) of the resource.

* @public */ - TopicId?: string | undefined; + Arn?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the topic.

+ *

The ARN of the dashboard, including the version number.

* @public */ - TopicArn?: string | undefined; + VersionArn?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the dataset.

+ *

The ID for the dashboard.

* @public */ - DatasetArn?: string | undefined; + DashboardId?: string | undefined; + + /** + *

The creation status of the request.

+ * @public + */ + CreationStatus?: ResourceStatus | undefined; /** *

The HTTP status of the request.

@@ -8643,203 +8961,119 @@ export interface UpdateTopicRefreshScheduleResponse { /** * @public */ -export interface UpdateUserRequest { +export interface UpdateDashboardLinksRequest { /** - *

The Amazon QuickSight user name that you want to update.

+ *

The ID of the Amazon Web Services account that contains the dashboard whose links you want to update.

* @public */ - UserName: string | undefined; + AwsAccountId: string | undefined; /** - *

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 dashboard.

* @public */ - AwsAccountId: string | undefined; + DashboardId: string | undefined; /** - *

The namespace. Currently, you should set this to default.

+ *

list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

* @public */ - Namespace: string | undefined; + LinkEntities: string[] | undefined; +} +/** + * @public + */ +export interface UpdateDashboardLinksResponse { /** - *

The email address of the user that you want to update.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - Email: string | undefined; + RequestId?: string | undefined; /** - *

The Amazon QuickSight role of the user. The role can be one of the - * following default security cohorts:

- *
    - *
  • - *

    - * READER: A user who has read-only access to dashboards.

    - *
  • - *
  • - *

    - * AUTHOR: A user who can create data sources, datasets, analyses, and - * dashboards.

    - *
  • - *
  • - *

    - * ADMIN: A user who is an author, who can also manage Amazon QuickSight - * settings.

    - *
  • - *
  • - *

    - * READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

    - *
  • - *
  • - *

    - * AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

    - *
  • - *
  • - *

    - * ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.

    - *
  • - *
- *

The name of the Amazon QuickSight role is invisible to the user except for the console - * screens dealing with permissions.

+ *

The HTTP status of the request.

* @public */ - Role: UserRole | undefined; + Status?: number | undefined; /** - *

(Enterprise edition only) The name of the custom permissions profile that you want to - * assign to this user. Customized permissions allows you to control a user's access by - * restricting access the following operations:

- *
    - *
  • - *

    Create and update data sources

    - *
  • - *
  • - *

    Create and update datasets

    - *
  • - *
  • - *

    Create and update email reports

    - *
  • - *
  • - *

    Subscribe to email reports

    - *
  • - *
- *

A set of custom permissions includes any combination of these restrictions. Currently, - * you need to create the profile names for custom permission sets by using the Amazon QuickSight - * console. Then, you use the RegisterUser API operation to assign the named set of - * permissions to a Amazon QuickSight user.

- *

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they - * override the permissions typically granted by assigning Amazon QuickSight users to one of the - * default security cohorts in Amazon QuickSight (admin, author, reader).

- *

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

+ *

The Amazon Resource Name (ARN) of the dashboard.

* @public */ - CustomPermissionsName?: string | undefined; + DashboardArn?: string | undefined; /** - *

A flag that you use to indicate that you want to remove all custom permissions - * from this user. Using this parameter resets the user to the state - * it was in before a custom permissions profile was applied. This parameter defaults to - * NULL and it doesn't accept any other value.

+ *

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

* @public */ - UnapplyCustomPermissions?: boolean | undefined; + LinkEntities?: string[] | undefined; +} +/** + * @public + */ +export interface UpdateDashboardPermissionsRequest { /** - *

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

- *
    - *
  • - *

    - * COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

    - *
  • - *
  • - *

    - * CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

    - *
  • - *
  • - *

    - * NONE: This clears all the previously saved external login information for a user. Use the - * - * DescribeUser - * - * API operation to check the external login information.

    - *
  • - *
+ *

The ID of the Amazon Web Services account that contains the dashboard whose permissions you're + * updating.

* @public */ - ExternalLoginFederationProviderType?: string | undefined; + AwsAccountId: string | undefined; /** - *

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate - * into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should - * only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

+ *

The ID for the dashboard.

* @public */ - CustomFederationProviderUrl?: string | undefined; + DashboardId: string | undefined; /** - *

The identity ID for a user in the external login provider.

+ *

The permissions that you want to grant on this resource.

* @public */ - ExternalLoginId?: string | undefined; -} + GrantPermissions?: ResourcePermission[] | undefined; -/** - * @public - */ -export interface UpdateUserResponse { /** - *

The Amazon QuickSight user.

+ *

The permissions that you want to revoke from this resource.

* @public */ - User?: User | undefined; + RevokePermissions?: ResourcePermission[] | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

Grants link permissions to all users in a defined namespace.

* @public */ - RequestId?: string | undefined; + GrantLinkPermissions?: ResourcePermission[] | undefined; /** - *

The HTTP status of the request.

+ *

Revokes link permissions from all users in a defined namespace.

* @public */ - Status?: number | undefined; + RevokeLinkPermissions?: ResourcePermission[] | undefined; } /** * @public */ -export interface UpdateUserCustomPermissionRequest { - /** - *

The username of the user that you want to update custom permissions for.

- * @public - */ - UserName: string | undefined; - +export interface UpdateDashboardPermissionsResponse { /** - *

The ID of the Amazon Web Services account that contains the custom permission configuration that you want to update.

+ *

The Amazon Resource Name (ARN) of the dashboard.

* @public */ - AwsAccountId: string | undefined; + DashboardArn?: string | undefined; /** - *

The namespace that the user belongs to.

+ *

The ID for the dashboard.

* @public */ - Namespace: string | undefined; + DashboardId?: string | undefined; /** - *

The name of the custom permissions that you want to update.

+ *

Information about the permissions on the dashboard.

* @public */ - CustomPermissionsName: string | undefined; -} + Permissions?: ResourcePermission[] | undefined; -/** - * @public - */ -export interface UpdateUserCustomPermissionResponse { /** *

The Amazon Web Services request ID for this operation.

* @public @@ -8851,85 +9085,93 @@ export interface UpdateUserCustomPermissionResponse { * @public */ Status?: number | undefined; + + /** + *

Updates the permissions of a shared link to an Amazon QuickSight dashboard.

+ * @public + */ + LinkSharingConfiguration?: LinkSharingConfiguration | undefined; } /** * @public */ -export interface UpdateVPCConnectionRequest { +export interface UpdateDashboardPublishedVersionRequest { /** - *

The Amazon Web Services account ID of the account that contains the VPC connection that - * you want to update.

+ *

The ID of the Amazon Web Services account that contains the dashboard that you're + * updating.

* @public */ AwsAccountId: string | undefined; /** - *

The ID of the VPC connection that - * you're updating. This ID is a unique identifier for each Amazon Web Services Region in an - * Amazon Web Services account.

+ *

The ID for the dashboard.

* @public */ - VPCConnectionId: string | undefined; + DashboardId: string | undefined; /** - *

The display name for the VPC connection.

+ *

The version number of the dashboard.

* @public */ - Name: string | undefined; + VersionNumber: number | undefined; +} +/** + * @public + */ +export interface UpdateDashboardPublishedVersionResponse { /** - *

A list of subnet IDs for the VPC connection.

+ *

The ID for the dashboard.

* @public */ - SubnetIds: string[] | undefined; + DashboardId?: string | undefined; /** - *

A list of security group IDs for the VPC connection.

+ *

The Amazon Resource Name (ARN) of the dashboard.

* @public */ - SecurityGroupIds: string[] | undefined; + DashboardArn?: string | undefined; /** - *

A list of IP addresses of DNS resolver endpoints for the VPC connection.

+ *

The HTTP status of the request.

* @public */ - DnsResolvers?: string[] | undefined; + Status?: number | undefined; /** - *

An IAM role associated with the VPC connection.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - RoleArn: string | undefined; + RequestId?: string | undefined; } /** * @public */ -export interface UpdateVPCConnectionResponse { - /** - *

The Amazon Resource Name (ARN) of the VPC connection.

- * @public - */ - Arn?: string | undefined; - +export interface UpdateDashboardsQAConfigurationRequest { /** - *

The ID of the VPC connection that you are updating. This ID is a unique identifier for each Amazon Web Services Region in anAmazon Web Services account.

+ *

The ID of the Amazon Web Services account that contains the dashboard QA configuration that you want to update.

* @public */ - VPCConnectionId?: string | undefined; + AwsAccountId: string | undefined; /** - *

The update status of the VPC connection's last update.

+ *

The status of dashboards QA configuration that you want to update.

* @public */ - UpdateStatus?: VPCConnectionResourceStatus | undefined; + DashboardsQAStatus: DashboardsQAStatus | undefined; +} +/** + * @public + */ +export interface UpdateDashboardsQAConfigurationResponse { /** - *

The availability status of the VPC connection.

+ *

A value that indicates whether the dashboard QA configuration is enabled or not.

* @public */ - AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; + DashboardsQAStatus?: DashboardsQAStatus | undefined; /** *

The Amazon Web Services request ID for this operation.

@@ -8945,183 +9187,264 @@ export interface UpdateVPCConnectionResponse { } /** - *

The definition for a TopicVisual.

* @public */ -export interface TopicVisual { - /** - *

The visual ID for the TopicVisual.

- * @public - */ - VisualId?: string | undefined; - +export interface UpdateDataSetRequest { /** - *

The role for the TopicVisual.

+ *

The Amazon Web Services account ID.

* @public */ - Role?: VisualRole | undefined; + AwsAccountId: string | undefined; /** - *

The ir for the TopicVisual.

+ *

The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each + * Amazon Web Services account.

* @public */ - Ir?: TopicIR | undefined; + DataSetId: string | undefined; /** - *

The supporting visuals for the TopicVisual.

+ *

The display name for the dataset.

* @public */ - SupportingVisuals?: TopicVisual[] | undefined; -} + Name: string | undefined; -/** - *

The definition for a CreateTopicReviewedAnswer.

- * @public - */ -export interface CreateTopicReviewedAnswer { /** - *

The answer ID for the CreateTopicReviewedAnswer.

+ *

Declares the physical tables that are available in the underlying data sources.

* @public */ - AnswerId: string | undefined; + PhysicalTableMap: Record | undefined; /** - *

The Dataset arn for the CreateTopicReviewedAnswer.

+ *

Configures the combination and transformation of the data from the physical tables.

* @public */ - DatasetArn: string | undefined; + LogicalTableMap?: Record | undefined; /** - *

The Question to be created.

+ *

Indicates whether you want to import the data into SPICE.

* @public */ - Question: string | undefined; + ImportMode: DataSetImportMode | undefined; /** - *

The Mir for the CreateTopicReviewedAnswer.

+ *

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

* @public */ - Mir?: TopicIR | undefined; + ColumnGroups?: ColumnGroup[] | undefined; /** - *

The PrimaryVisual for the CreateTopicReviewedAnswer.

+ *

The folder that contains fields and nested subfolders for your dataset.

* @public */ - PrimaryVisual?: TopicVisual | undefined; + FieldFolders?: Record | undefined; /** - *

The template for the CreateTopicReviewedAnswer.

+ *

The row-level security configuration for the data you want to create.

* @public */ - Template?: TopicTemplate | undefined; -} + RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; -/** - *

The deinition for a TopicReviewedAnswer.

- * @public - */ -export interface TopicReviewedAnswer { /** - *

The Amazon Resource Name (ARN) of the reviewed answer.

+ *

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

* @public */ - Arn?: string | undefined; + RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration | undefined; /** - *

The answer ID of the reviewed answer.

+ *

A set of one or more definitions of a + * ColumnLevelPermissionRule + * .

* @public */ - AnswerId: string | undefined; + ColumnLevelPermissionRules?: ColumnLevelPermissionRule[] | undefined; /** - *

The Dataset ARN for the TopicReviewedAnswer.

+ *

The usage configuration to apply to child datasets that reference this dataset as a source.

* @public */ - DatasetArn: string | undefined; + DataSetUsageConfiguration?: DataSetUsageConfiguration | undefined; /** - *

The question for the TopicReviewedAnswer.

+ *

The parameter declarations of the dataset.

* @public */ - Question: string | undefined; + DatasetParameters?: DatasetParameter[] | undefined; +} +/** + * @public + */ +export interface UpdateDataSetResponse { /** - *

The mir for the TopicReviewedAnswer.

+ *

The Amazon Resource Name (ARN) of the dataset.

* @public */ - Mir?: TopicIR | undefined; + Arn?: string | undefined; /** - *

The primary visual for the TopicReviewedAnswer.

+ *

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 */ - PrimaryVisual?: TopicVisual | undefined; + DataSetId?: string | undefined; /** - *

The template for the TopicReviewedAnswer.

+ *

The ARN for the ingestion, which is triggered as a result of dataset creation if the import + * mode is SPICE.

* @public */ - Template?: TopicTemplate | undefined; -} + IngestionArn?: string | undefined; -/** - * @public - */ -export interface BatchCreateTopicReviewedAnswerRequest { /** - *

The ID of the Amazon Web Services account that you want to create a reviewed answer in.

+ *

The ID of the ingestion, which is triggered as a result of dataset creation if the import + * mode is SPICE.

* @public */ - AwsAccountId: string | undefined; + IngestionId?: string | undefined; /** - *

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ *

The Amazon Web Services request ID for this operation.

* @public */ - TopicId: string | undefined; + RequestId?: string | undefined; /** - *

The definition of the Answers to be created.

+ *

The HTTP status of the request.

* @public */ - Answers: CreateTopicReviewedAnswer[] | undefined; + Status?: number | undefined; } /** * @public */ -export interface ListTopicReviewedAnswersResponse { - /** - *

The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

- * @public - */ - TopicId?: string | undefined; - +export interface UpdateDataSetPermissionsRequest { /** - *

The Amazon Resource Name (ARN) of the topic.

+ *

The Amazon Web Services account ID.

* @public */ - TopicArn?: string | undefined; + AwsAccountId: string | undefined; /** - *

The definition of all Answers in the topic.

+ *

The ID for the dataset whose permissions you want to update. This ID is unique per + * Amazon Web Services Region for each Amazon Web Services account.

* @public */ - Answers?: TopicReviewedAnswer[] | undefined; + DataSetId: string | undefined; /** - *

The HTTP status of the request.

+ *

The resource permissions that you want to grant to the dataset.

* @public */ - Status?: number | undefined; + GrantPermissions?: ResourcePermission[] | undefined; /** - *

The Amazon Web Services request ID for this operation.

+ *

The resource permissions that you want to revoke from the dataset.

* @public */ - RequestId?: string | undefined; + RevokePermissions?: ResourcePermission[] | undefined; } +/** + * @internal + */ +export const DescribeAssetBundleExportJobResponseFilterSensitiveLog = ( + obj: DescribeAssetBundleExportJobResponse +): any => ({ + ...obj, + ...(obj.DownloadUrl && { DownloadUrl: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const DescribeAssetBundleImportJobResponseFilterSensitiveLog = ( + obj: DescribeAssetBundleImportJobResponse +): any => ({ + ...obj, + ...(obj.AssetBundleImportSource && { + AssetBundleImportSource: AssetBundleImportSourceDescriptionFilterSensitiveLog(obj.AssetBundleImportSource), + }), +}); + +/** + * @internal + */ +export const DescribeDashboardResponseFilterSensitiveLog = (obj: DescribeDashboardResponse): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DescribeDashboardDefinitionResponseFilterSensitiveLog = ( + obj: DescribeDashboardDefinitionResponse +): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const SnapshotConfigurationFilterSensitiveLog = (obj: SnapshotConfiguration): any => ({ + ...obj, + ...(obj.Parameters && { Parameters: _ParametersFilterSensitiveLog(obj.Parameters) }), +}); + +/** + * @internal + */ +export const DescribeDashboardSnapshotJobResponseFilterSensitiveLog = ( + obj: DescribeDashboardSnapshotJobResponse +): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const SnapshotJobResultFilterSensitiveLog = (obj: SnapshotJobResult): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DescribeDashboardSnapshotJobResultResponseFilterSensitiveLog = ( + obj: DescribeDashboardSnapshotJobResultResponse +): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DescribeDataSetResponseFilterSensitiveLog = (obj: DescribeDataSetResponse): any => ({ + ...obj, + ...(obj.DataSet && { DataSet: DataSetFilterSensitiveLog(obj.DataSet) }), +}); + +/** + * @internal + */ +export const TemplateVersionFilterSensitiveLog = (obj: TemplateVersion): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const TemplateFilterSensitiveLog = (obj: Template): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DescribeTemplateResponseFilterSensitiveLog = (obj: DescribeTemplateResponse): any => ({ + ...obj, +}); + /** * @internal */ @@ -9263,68 +9586,3 @@ export const UpdateDataSetRequestFilterSensitiveLog = (obj: UpdateDataSetRequest ), }), }); - -/** - * @internal - */ -export const UpdateDataSourceRequestFilterSensitiveLog = (obj: UpdateDataSourceRequest): any => ({ - ...obj, - ...(obj.DataSourceParameters && { DataSourceParameters: obj.DataSourceParameters }), - ...(obj.Credentials && { Credentials: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const UpdateTemplateRequestFilterSensitiveLog = (obj: UpdateTemplateRequest): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const UpdateTopicRequestFilterSensitiveLog = (obj: UpdateTopicRequest): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const TopicVisualFilterSensitiveLog = (obj: TopicVisual): any => ({ - ...obj, - ...(obj.Ir && { Ir: TopicIRFilterSensitiveLog(obj.Ir) }), -}); - -/** - * @internal - */ -export const CreateTopicReviewedAnswerFilterSensitiveLog = (obj: CreateTopicReviewedAnswer): any => ({ - ...obj, - ...(obj.Mir && { Mir: TopicIRFilterSensitiveLog(obj.Mir) }), - ...(obj.PrimaryVisual && { PrimaryVisual: TopicVisualFilterSensitiveLog(obj.PrimaryVisual) }), -}); - -/** - * @internal - */ -export const TopicReviewedAnswerFilterSensitiveLog = (obj: TopicReviewedAnswer): any => ({ - ...obj, - ...(obj.Mir && { Mir: TopicIRFilterSensitiveLog(obj.Mir) }), - ...(obj.PrimaryVisual && { PrimaryVisual: TopicVisualFilterSensitiveLog(obj.PrimaryVisual) }), -}); - -/** - * @internal - */ -export const BatchCreateTopicReviewedAnswerRequestFilterSensitiveLog = ( - obj: BatchCreateTopicReviewedAnswerRequest -): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const ListTopicReviewedAnswersResponseFilterSensitiveLog = (obj: ListTopicReviewedAnswersResponse): any => ({ - ...obj, -}); diff --git a/clients/client-quicksight/src/models/models_5.ts b/clients/client-quicksight/src/models/models_5.ts new file mode 100644 index 000000000000..821c0d4abc1a --- /dev/null +++ b/clients/client-quicksight/src/models/models_5.ts @@ -0,0 +1,2044 @@ +// smithy-typescript generated code +import { SENSITIVE_STRING } from "@smithy/smithy-client"; + +import { ResourceStatus } from "./models_0"; + +import { + AssignmentStatus, + DataSourceParameters, + ServiceType, + SslProperties, + TopicIR, + TopicIRFilterSensitiveLog, + TopicTemplate, + VisualRole, + VpcConnectionProperties, +} from "./models_2"; + +import { + DataSourceCredentials, + Group, + RefreshSchedule, + ResourcePermission, + Role, + TemplateAlias, + TemplateSourceEntity, + TemplateVersionDefinition, + ThemeAlias, + ThemeConfiguration, + TopicDetails, + TopicRefreshSchedule, + ValidationStrategy, + VPCConnectionAvailabilityStatus, + VPCConnectionResourceStatus, +} from "./models_3"; + +import { + FailedKeyRegistrationEntry, + PersonalizationMode, + PurchaseMode, + RegisteredCustomerManagedKey, + User, + UserRole, +} from "./models_4"; + +/** + * @public + */ +export interface UpdateDataSetPermissionsResponse { + /** + *

The Amazon Resource Name (ARN) of the dataset.

+ * @public + */ + DataSetArn?: string | undefined; + + /** + *

The ID for the dataset whose permissions you want to update. 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.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; +} + +/** + * @public + */ +export interface UpdateDataSourceRequest { + /** + *

The Amazon Web Services account ID.

+ * @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; + + /** + *

A display name for the data source.

+ * @public + */ + Name: string | undefined; + + /** + *

The parameters that Amazon QuickSight uses to connect to your underlying source.

+ * @public + */ + DataSourceParameters?: DataSourceParameters | undefined; + + /** + *

The credentials that 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; + + /** + *

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; +} + +/** + * @public + */ +export interface UpdateDataSourceResponse { + /** + *

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 update status of the data source's last update.

+ * @public + */ + UpdateStatus?: ResourceStatus | 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 UpdateDataSourcePermissionsRequest { + /** + *

The Amazon Web Services account ID.

+ * @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; + + /** + *

A list of resource permissions that you want to grant on the data source.

+ * @public + */ + GrantPermissions?: ResourcePermission[] | undefined; + + /** + *

A list of resource permissions that you want to revoke on the data source.

+ * @public + */ + RevokePermissions?: ResourcePermission[] | undefined; +} + +/** + * @public + */ +export interface UpdateDataSourcePermissionsResponse { + /** + *

The Amazon Resource Name (ARN) of the data source.

+ * @public + */ + DataSourceArn?: 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 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 UpdateFolderRequest { + /** + *

The ID for the Amazon Web Services account that contains the folder to update.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID of the folder.

+ * @public + */ + FolderId: string | undefined; + + /** + *

The name of the folder.

+ * @public + */ + Name: string | undefined; +} + +/** + * @public + */ +export interface UpdateFolderResponse { + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; + + /** + *

The Amazon Resource Name (ARN) of the folder.

+ * @public + */ + Arn?: string | undefined; + + /** + *

The ID of the folder.

+ * @public + */ + FolderId?: string | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; +} + +/** + * @public + */ +export interface UpdateFolderPermissionsRequest { + /** + *

The ID for the Amazon Web Services account that contains the folder to update.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID of the folder.

+ * @public + */ + FolderId: string | undefined; + + /** + *

The permissions that you want to grant on a resource. Namespace ARNs are not supported Principal values for folder permissions.

+ * @public + */ + GrantPermissions?: ResourcePermission[] | undefined; + + /** + *

The permissions that you want to revoke from a resource. Namespace ARNs are not supported Principal values for folder permissions.

+ * @public + */ + RevokePermissions?: ResourcePermission[] | undefined; +} + +/** + * @public + */ +export interface UpdateFolderPermissionsResponse { + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; + + /** + *

The Amazon Resource Name (ARN) of the folder.

+ * @public + */ + Arn?: string | undefined; + + /** + *

The ID of the folder.

+ * @public + */ + FolderId?: string | undefined; + + /** + *

Information about the permissions for the folder.

+ * @public + */ + Permissions?: ResourcePermission[] | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; +} + +/** + * @public + */ +export interface UpdateGroupRequest { + /** + *

The name of the group that you want to update.

+ * @public + */ + GroupName: string | undefined; + + /** + *

The description for the group that you want to update.

+ * @public + */ + Description?: 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.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The namespace of the group that you want to update.

+ * @public + */ + Namespace: string | undefined; +} + +/** + * @public + */ +export interface UpdateGroupResponse { + /** + *

The name of the group.

+ * @public + */ + Group?: Group | 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 UpdateIAMPolicyAssignmentRequest { + /** + *

The ID of the Amazon Web Services account that contains the IAM policy + * assignment.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The name of the assignment, also called a rule. + * The + * name must be unique within the + * Amazon Web Services account.

+ * @public + */ + AssignmentName: string | undefined; + + /** + *

The namespace of the assignment.

+ * @public + */ + Namespace: 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.

    + *
  • + *
+ * @public + */ + AssignmentStatus?: AssignmentStatus | undefined; + + /** + *

The ARN for the IAM policy to apply to the Amazon QuickSight users and + * groups specified in this assignment.

+ * @public + */ + PolicyArn?: string | undefined; + + /** + *

The Amazon QuickSight users, groups, or both that you want to assign the policy + * to.

+ * @public + */ + Identities?: Record | undefined; +} + +/** + * @public + */ +export interface UpdateIAMPolicyAssignmentResponse { + /** + *

The name of the assignment or rule.

+ * @public + */ + AssignmentName?: string | undefined; + + /** + *

The ID of the assignment.

+ * @public + */ + AssignmentId?: string | undefined; + + /** + *

The ARN for the IAM policy applied to the Amazon QuickSight users and + * groups specified in this assignment.

+ * @public + */ + PolicyArn?: string | undefined; + + /** + *

The Amazon QuickSight users, groups, or both that the IAM policy is + * assigned to.

+ * @public + */ + Identities?: Record | 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.

    + *
  • + *
+ * @public + */ + AssignmentStatus?: AssignmentStatus | 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 UpdateIdentityPropagationConfigRequest { + /** + *

The ID of the Amazon Web Services account that contains the identity propagation configuration that you want to update.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The name of the Amazon Web Services service that contains the authorized targets that you want to add or update.

+ * @public + */ + Service: ServiceType | undefined; + + /** + *

Specifies a list of application ARNs that represent the authorized targets for a service.

+ * @public + */ + AuthorizedTargets?: string[] | undefined; +} + +/** + * @public + */ +export interface UpdateIdentityPropagationConfigResponse { + /** + *

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 UpdateIpRestrictionRequest { + /** + *

The ID of the Amazon Web Services account that contains the IP rules.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

A map that describes the updated IP rules with CIDR ranges and descriptions.

+ * @public + */ + IpRestrictionRuleMap?: Record | undefined; + + /** + *

A map of VPC IDs and their corresponding rules. When you configure this parameter, traffic from all VPC endpoints that are present in the specified VPC is allowed.

+ * @public + */ + VpcIdRestrictionRuleMap?: Record | undefined; + + /** + *

A map of allowed VPC endpoint IDs and their corresponding rule descriptions.

+ * @public + */ + VpcEndpointIdRestrictionRuleMap?: Record | undefined; + + /** + *

A value that specifies whether IP rules are turned on.

+ * @public + */ + Enabled?: boolean | undefined; +} + +/** + * @public + */ +export interface UpdateIpRestrictionResponse { + /** + *

The ID of the Amazon Web Services account that contains the IP rules.

+ * @public + */ + 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 UpdateKeyRegistrationRequest { + /** + *

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to update.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

A list of RegisteredCustomerManagedKey objects to be updated to the Amazon QuickSight account.

+ * @public + */ + KeyRegistration: RegisteredCustomerManagedKey[] | undefined; +} + +/** + *

A success entry that occurs when a KeyRegistration job is successfully applied to the Amazon QuickSight account.

+ * @public + */ +export interface SuccessfulKeyRegistrationEntry { + /** + *

The ARN of the KMS key that is associated with the SuccessfulKeyRegistrationEntry entry.

+ * @public + */ + KeyArn: string | undefined; + + /** + *

The HTTP status of a SuccessfulKeyRegistrationEntry entry.

+ * @public + */ + StatusCode: number | undefined; +} + +/** + * @public + */ +export interface UpdateKeyRegistrationResponse { + /** + *

A list of all customer managed key registrations that failed to update.

+ * @public + */ + FailedKeyRegistration?: FailedKeyRegistrationEntry[] | undefined; + + /** + *

A list of all customer managed key registrations that were successfully updated.

+ * @public + */ + SuccessfulKeyRegistration?: SuccessfulKeyRegistrationEntry[] | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; +} + +/** + * @public + */ +export interface UpdatePublicSharingSettingsRequest { + /** + *

The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.

+ * @public + */ + PublicSharingEnabled?: boolean | undefined; +} + +/** + * @public + */ +export interface UpdatePublicSharingSettingsResponse { + /** + *

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 UpdateQPersonalizationConfigurationRequest { + /** + *

The ID of the Amazon Web Services account account that contains the personalization configuration that the user wants to update.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

An option to allow Amazon QuickSight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance.

+ * @public + */ + PersonalizationMode: PersonalizationMode | undefined; +} + +/** + * @public + */ +export interface UpdateQPersonalizationConfigurationResponse { + /** + *

The personalization mode that is used for the personalization configuration.

+ * @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 UpdateRefreshScheduleRequest { + /** + *

The ID of the dataset.

+ * @public + */ + DataSetId: string | undefined; + + /** + *

The Amazon Web Services account ID.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The refresh schedule.

+ * @public + */ + Schedule: RefreshSchedule | undefined; +} + +/** + * @public + */ +export interface UpdateRefreshScheduleResponse { + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The ID of the refresh schedule.

+ * @public + */ + ScheduleId?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) for the refresh schedule.

+ * @public + */ + Arn?: string | undefined; +} + +/** + * @public + */ +export interface UpdateRoleCustomPermissionRequest { + /** + *

The name of the custom permission that you want to update the role with.

+ * @public + */ + CustomPermissionsName: string | undefined; + + /** + *

The name of role tht you want to update.

+ * @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 that you want to update.

+ * @public + */ + Namespace: string | undefined; +} + +/** + * @public + */ +export interface UpdateRoleCustomPermissionResponse { + /** + *

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 UpdateSPICECapacityConfigurationRequest { + /** + *

The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

Determines how SPICE capacity can be purchased. The following options are available.

+ *
    + *
  • + *

    + * MANUAL: SPICE capacity can only be purchased manually.

    + *
  • + *
  • + *

    + * AUTO_PURCHASE: Extra SPICE capacity is automatically purchased on your behalf as needed. SPICE capacity can also be purchased manually with this option.

    + *
  • + *
+ * @public + */ + PurchaseMode: PurchaseMode | undefined; +} + +/** + * @public + */ +export interface UpdateSPICECapacityConfigurationResponse { + /** + *

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 UpdateTemplateRequest { + /** + *

The ID of the Amazon Web Services account that contains the template that you're updating.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID for the template.

+ * @public + */ + TemplateId: string | undefined; + + /** + *

The entity that you are using as a source when you update 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.

+ * @public + */ + SourceEntity?: TemplateSourceEntity | undefined; + + /** + *

A description of the current template version that is being updated. Every time you call + * UpdateTemplate, you create a new version of the template. Each version + * of the template maintains a description of the version in the + * VersionDescription field.

+ * @public + */ + VersionDescription?: string | undefined; + + /** + *

The name for the template.

+ * @public + */ + Name?: string | undefined; + + /** + *

The definition of a template.

+ *

A definition is the data model of all features in a Dashboard, Template, or Analysis.

+ * @public + */ + Definition?: TemplateVersionDefinition | undefined; + + /** + *

The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.

+ * @public + */ + ValidationStrategy?: ValidationStrategy | undefined; +} + +/** + * @public + */ +export interface UpdateTemplateResponse { + /** + *

The ID for the template.

+ * @public + */ + TemplateId?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) for the template.

+ * @public + */ + Arn?: string | undefined; + + /** + *

The ARN for the template, including the version information of the first version.

+ * @public + */ + VersionArn?: string | undefined; + + /** + *

The creation status of the template.

+ * @public + */ + CreationStatus?: ResourceStatus | 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 UpdateTemplateAliasRequest { + /** + *

The ID of the Amazon Web Services account that contains the template alias that you're updating.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID for the template.

+ * @public + */ + TemplateId: string | undefined; + + /** + *

The alias of the template that you want to update. If you name a specific alias, you update + * 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; + + /** + *

The version number of the template.

+ * @public + */ + TemplateVersionNumber: number | undefined; +} + +/** + * @public + */ +export interface UpdateTemplateAliasResponse { + /** + *

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 UpdateTemplatePermissionsRequest { + /** + *

The ID of the Amazon Web Services account that contains the template.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID for the template.

+ * @public + */ + TemplateId: string | undefined; + + /** + *

A list of resource permissions to be granted on the template.

+ * @public + */ + GrantPermissions?: ResourcePermission[] | undefined; + + /** + *

A list of resource permissions to be revoked from the template.

+ * @public + */ + RevokePermissions?: ResourcePermission[] | undefined; +} + +/** + * @public + */ +export interface UpdateTemplatePermissionsResponse { + /** + *

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 UpdateThemeRequest { + /** + *

The ID of the Amazon Web Services account that contains the theme that you're updating.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID for the theme.

+ * @public + */ + ThemeId: string | undefined; + + /** + *

The name for the theme.

+ * @public + */ + Name?: string | undefined; + + /** + *

The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. + * All themes initially inherit from a default Amazon QuickSight theme.

+ * @public + */ + BaseThemeId: string | undefined; + + /** + *

A description of the theme version that you're updating Every time that you call + * UpdateTheme, you create a new version of the theme. Each version of the + * theme maintains a description of the version in VersionDescription.

+ * @public + */ + VersionDescription?: string | undefined; + + /** + *

The theme configuration, which contains the theme display properties.

+ * @public + */ + Configuration?: ThemeConfiguration | undefined; +} + +/** + * @public + */ +export interface UpdateThemeResponse { + /** + *

The ID for the theme.

+ * @public + */ + ThemeId?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) for the theme.

+ * @public + */ + Arn?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) for the new version of the theme.

+ * @public + */ + VersionArn?: string | undefined; + + /** + *

The creation status of the theme.

+ * @public + */ + CreationStatus?: ResourceStatus | 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 UpdateThemeAliasRequest { + /** + *

The ID of the Amazon Web Services account that contains the theme alias that you're updating.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID for the theme.

+ * @public + */ + ThemeId: string | undefined; + + /** + *

The name of the theme alias that you want to update.

+ * @public + */ + AliasName: string | undefined; + + /** + *

The version number of the theme that the alias should reference.

+ * @public + */ + ThemeVersionNumber: number | undefined; +} + +/** + * @public + */ +export interface UpdateThemeAliasResponse { + /** + *

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; +} + +/** + * @public + */ +export interface UpdateThemePermissionsRequest { + /** + *

The ID of the Amazon Web Services account that contains the theme.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID for the theme.

+ * @public + */ + ThemeId: string | undefined; + + /** + *

A list of resource permissions to be granted for the theme.

+ * @public + */ + GrantPermissions?: ResourcePermission[] | undefined; + + /** + *

A list of resource permissions to be revoked from the theme.

+ * @public + */ + RevokePermissions?: ResourcePermission[] | undefined; +} + +/** + * @public + */ +export interface UpdateThemePermissionsResponse { + /** + *

The ID for the theme.

+ * @public + */ + ThemeId?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the theme.

+ * @public + */ + ThemeArn?: string | undefined; + + /** + *

The resulting list of resource permissions for 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 UpdateTopicRequest { + /** + *

The ID of the Amazon Web Services account that contains the topic that you want to + * update.

+ * @public + */ + AwsAccountId: string | 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.

+ * @public + */ + TopicId: string | undefined; + + /** + *

The definition of the topic that you want to update.

+ * @public + */ + Topic: TopicDetails | undefined; +} + +/** + * @public + */ +export interface UpdateTopicResponse { + /** + *

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 + */ + TopicId?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the topic.

+ * @public + */ + Arn?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the topic refresh.

+ * @public + */ + RefreshArn?: 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 UpdateTopicPermissionsRequest { + /** + *

The ID of the Amazon Web Services account that contains the topic that you want to update + * the permissions for.

+ * @public + */ + AwsAccountId: string | 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.

+ * @public + */ + TopicId: string | undefined; + + /** + *

The resource permissions that you want to grant to the topic.

+ * @public + */ + GrantPermissions?: ResourcePermission[] | undefined; + + /** + *

The resource permissions that you want to revoke from the topic.

+ * @public + */ + RevokePermissions?: ResourcePermission[] | undefined; +} + +/** + * @public + */ +export interface UpdateTopicPermissionsResponse { + /** + *

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 + */ + TopicId?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the topic.

+ * @public + */ + TopicArn?: string | undefined; + + /** + *

A list of resource permissions on the topic.

+ * @public + */ + Permissions?: ResourcePermission[] | 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 UpdateTopicRefreshScheduleRequest { + /** + *

The ID of the Amazon Web Services account that contains the topic whose refresh schedule + * you want to update.

+ * @public + */ + AwsAccountId: string | 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.

+ * @public + */ + TopicId: string | undefined; + + /** + *

The ID of the dataset.

+ * @public + */ + DatasetId: string | undefined; + + /** + *

The definition of a refresh schedule.

+ * @public + */ + RefreshSchedule: TopicRefreshSchedule | undefined; +} + +/** + * @public + */ +export interface UpdateTopicRefreshScheduleResponse { + /** + *

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 + */ + TopicId?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the topic.

+ * @public + */ + TopicArn?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the dataset.

+ * @public + */ + DatasetArn?: 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 UpdateUserRequest { + /** + *

The Amazon QuickSight user name that you want to update.

+ * @public + */ + UserName: string | undefined; + + /** + *

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 + */ + AwsAccountId: string | undefined; + + /** + *

The namespace. Currently, you should set this to default.

+ * @public + */ + Namespace: string | undefined; + + /** + *

The email address of the user that you want to update.

+ * @public + */ + Email: string | undefined; + + /** + *

The Amazon QuickSight role of the user. The role can be one of the + * following default security cohorts:

+ *
    + *
  • + *

    + * READER: A user who has read-only access to dashboards.

    + *
  • + *
  • + *

    + * AUTHOR: A user who can create data sources, datasets, analyses, and + * dashboards.

    + *
  • + *
  • + *

    + * ADMIN: A user who is an author, who can also manage Amazon QuickSight + * settings.

    + *
  • + *
  • + *

    + * READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

    + *
  • + *
  • + *

    + * AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

    + *
  • + *
  • + *

    + * ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.

    + *
  • + *
+ *

The name of the Amazon QuickSight role is invisible to the user except for the console + * screens dealing with permissions.

+ * @public + */ + Role: UserRole | undefined; + + /** + *

(Enterprise edition only) The name of the custom permissions profile that you want to + * assign to this user. Customized permissions allows you to control a user's access by + * restricting access the following operations:

+ *
    + *
  • + *

    Create and update data sources

    + *
  • + *
  • + *

    Create and update datasets

    + *
  • + *
  • + *

    Create and update email reports

    + *
  • + *
  • + *

    Subscribe to email reports

    + *
  • + *
+ *

A set of custom permissions includes any combination of these restrictions. Currently, + * you need to create the profile names for custom permission sets by using the Amazon QuickSight + * console. Then, you use the RegisterUser API operation to assign the named set of + * permissions to a Amazon QuickSight user.

+ *

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they + * override the permissions typically granted by assigning Amazon QuickSight users to one of the + * default security cohorts in Amazon QuickSight (admin, author, reader).

+ *

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

+ * @public + */ + CustomPermissionsName?: string | undefined; + + /** + *

A flag that you use to indicate that you want to remove all custom permissions + * from this user. Using this parameter resets the user to the state + * it was in before a custom permissions profile was applied. This parameter defaults to + * NULL and it doesn't accept any other value.

+ * @public + */ + UnapplyCustomPermissions?: boolean | undefined; + + /** + *

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

+ *
    + *
  • + *

    + * COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

    + *
  • + *
  • + *

    + * CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

    + *
  • + *
  • + *

    + * NONE: This clears all the previously saved external login information for a user. Use the + * + * DescribeUser + * + * API operation to check the external login information.

    + *
  • + *
+ * @public + */ + ExternalLoginFederationProviderType?: string | undefined; + + /** + *

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate + * into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should + * only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

+ * @public + */ + CustomFederationProviderUrl?: string | undefined; + + /** + *

The identity ID for a user in the external login provider.

+ * @public + */ + ExternalLoginId?: string | undefined; +} + +/** + * @public + */ +export interface UpdateUserResponse { + /** + *

The Amazon QuickSight user.

+ * @public + */ + User?: User | 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 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 + */ +export interface UpdateVPCConnectionRequest { + /** + *

The Amazon Web Services account ID of the account that contains the VPC connection that + * you want to update.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID of the VPC connection that + * you're updating. This ID is a unique identifier for each Amazon Web Services Region in an + * Amazon Web Services account.

+ * @public + */ + VPCConnectionId: string | undefined; + + /** + *

The display name for the VPC connection.

+ * @public + */ + Name: string | undefined; + + /** + *

A list of subnet IDs for the VPC connection.

+ * @public + */ + SubnetIds: string[] | undefined; + + /** + *

A list of security group IDs for the VPC connection.

+ * @public + */ + SecurityGroupIds: string[] | undefined; + + /** + *

A list of IP addresses of DNS resolver endpoints for the VPC connection.

+ * @public + */ + DnsResolvers?: string[] | undefined; + + /** + *

An IAM role associated with the VPC connection.

+ * @public + */ + RoleArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateVPCConnectionResponse { + /** + *

The Amazon Resource Name (ARN) of the VPC connection.

+ * @public + */ + Arn?: string | undefined; + + /** + *

The ID of the VPC connection that you are updating. This ID is a unique identifier for each Amazon Web Services Region in anAmazon Web Services account.

+ * @public + */ + VPCConnectionId?: string | undefined; + + /** + *

The update status of the VPC connection's last update.

+ * @public + */ + UpdateStatus?: VPCConnectionResourceStatus | undefined; + + /** + *

The availability status of the VPC connection.

+ * @public + */ + AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; +} + +/** + *

The definition for a TopicVisual.

+ * @public + */ +export interface TopicVisual { + /** + *

The visual ID for the TopicVisual.

+ * @public + */ + VisualId?: string | undefined; + + /** + *

The role for the TopicVisual.

+ * @public + */ + Role?: VisualRole | undefined; + + /** + *

The ir for the TopicVisual.

+ * @public + */ + Ir?: TopicIR | undefined; + + /** + *

The supporting visuals for the TopicVisual.

+ * @public + */ + SupportingVisuals?: TopicVisual[] | undefined; +} + +/** + *

The definition for a CreateTopicReviewedAnswer.

+ * @public + */ +export interface CreateTopicReviewedAnswer { + /** + *

The answer ID for the CreateTopicReviewedAnswer.

+ * @public + */ + AnswerId: string | undefined; + + /** + *

The Dataset arn for the CreateTopicReviewedAnswer.

+ * @public + */ + DatasetArn: string | undefined; + + /** + *

The Question to be created.

+ * @public + */ + Question: string | undefined; + + /** + *

The Mir for the CreateTopicReviewedAnswer.

+ * @public + */ + Mir?: TopicIR | undefined; + + /** + *

The PrimaryVisual for the CreateTopicReviewedAnswer.

+ * @public + */ + PrimaryVisual?: TopicVisual | undefined; + + /** + *

The template for the CreateTopicReviewedAnswer.

+ * @public + */ + Template?: TopicTemplate | undefined; +} + +/** + *

The deinition for a TopicReviewedAnswer.

+ * @public + */ +export interface TopicReviewedAnswer { + /** + *

The Amazon Resource Name (ARN) of the reviewed answer.

+ * @public + */ + Arn?: string | undefined; + + /** + *

The answer ID of the reviewed answer.

+ * @public + */ + AnswerId: string | undefined; + + /** + *

The Dataset ARN for the TopicReviewedAnswer.

+ * @public + */ + DatasetArn: string | undefined; + + /** + *

The question for the TopicReviewedAnswer.

+ * @public + */ + Question: string | undefined; + + /** + *

The mir for the TopicReviewedAnswer.

+ * @public + */ + Mir?: TopicIR | undefined; + + /** + *

The primary visual for the TopicReviewedAnswer.

+ * @public + */ + PrimaryVisual?: TopicVisual | undefined; + + /** + *

The template for the TopicReviewedAnswer.

+ * @public + */ + Template?: TopicTemplate | undefined; +} + +/** + * @public + */ +export interface BatchCreateTopicReviewedAnswerRequest { + /** + *

The ID of the Amazon Web Services account that you want to create a reviewed answer in.

+ * @public + */ + AwsAccountId: string | undefined; + + /** + *

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ * @public + */ + TopicId: string | undefined; + + /** + *

The definition of the Answers to be created.

+ * @public + */ + Answers: CreateTopicReviewedAnswer[] | undefined; +} + +/** + * @public + */ +export interface ListTopicReviewedAnswersResponse { + /** + *

The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

+ * @public + */ + TopicId?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the topic.

+ * @public + */ + TopicArn?: string | undefined; + + /** + *

The definition of all Answers in the topic.

+ * @public + */ + Answers?: TopicReviewedAnswer[] | undefined; + + /** + *

The HTTP status of the request.

+ * @public + */ + Status?: number | undefined; + + /** + *

The Amazon Web Services request ID for this operation.

+ * @public + */ + RequestId?: string | undefined; +} + +/** + * @internal + */ +export const UpdateDataSourceRequestFilterSensitiveLog = (obj: UpdateDataSourceRequest): any => ({ + ...obj, + ...(obj.DataSourceParameters && { DataSourceParameters: obj.DataSourceParameters }), + ...(obj.Credentials && { Credentials: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const UpdateTemplateRequestFilterSensitiveLog = (obj: UpdateTemplateRequest): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const UpdateTopicRequestFilterSensitiveLog = (obj: UpdateTopicRequest): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const TopicVisualFilterSensitiveLog = (obj: TopicVisual): any => ({ + ...obj, + ...(obj.Ir && { Ir: TopicIRFilterSensitiveLog(obj.Ir) }), +}); + +/** + * @internal + */ +export const CreateTopicReviewedAnswerFilterSensitiveLog = (obj: CreateTopicReviewedAnswer): any => ({ + ...obj, + ...(obj.Mir && { Mir: TopicIRFilterSensitiveLog(obj.Mir) }), + ...(obj.PrimaryVisual && { PrimaryVisual: TopicVisualFilterSensitiveLog(obj.PrimaryVisual) }), +}); + +/** + * @internal + */ +export const TopicReviewedAnswerFilterSensitiveLog = (obj: TopicReviewedAnswer): any => ({ + ...obj, + ...(obj.Mir && { Mir: TopicIRFilterSensitiveLog(obj.Mir) }), + ...(obj.PrimaryVisual && { PrimaryVisual: TopicVisualFilterSensitiveLog(obj.PrimaryVisual) }), +}); + +/** + * @internal + */ +export const BatchCreateTopicReviewedAnswerRequestFilterSensitiveLog = ( + obj: BatchCreateTopicReviewedAnswerRequest +): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ListTopicReviewedAnswersResponseFilterSensitiveLog = (obj: ListTopicReviewedAnswersResponse): any => ({ + ...obj, +}); diff --git a/clients/client-quicksight/src/pagination/SearchTopicsPaginator.ts b/clients/client-quicksight/src/pagination/SearchTopicsPaginator.ts new file mode 100644 index 000000000000..1f259252b3fb --- /dev/null +++ b/clients/client-quicksight/src/pagination/SearchTopicsPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + SearchTopicsCommand, + SearchTopicsCommandInput, + SearchTopicsCommandOutput, +} from "../commands/SearchTopicsCommand"; +import { QuickSightClient } from "../QuickSightClient"; +import { QuickSightPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateSearchTopics: ( + config: QuickSightPaginationConfiguration, + input: SearchTopicsCommandInput, + ...rest: any[] +) => Paginator = createPaginator< + QuickSightPaginationConfiguration, + SearchTopicsCommandInput, + SearchTopicsCommandOutput +>(QuickSightClient, SearchTopicsCommand, "NextToken", "NextToken", "MaxResults"); diff --git a/clients/client-quicksight/src/pagination/index.ts b/clients/client-quicksight/src/pagination/index.ts index 159aa2685f12..b0fe094f8c16 100644 --- a/clients/client-quicksight/src/pagination/index.ts +++ b/clients/client-quicksight/src/pagination/index.ts @@ -37,3 +37,4 @@ export * from "./SearchDataSetsPaginator"; export * from "./SearchDataSourcesPaginator"; export * from "./SearchFoldersPaginator"; export * from "./SearchGroupsPaginator"; +export * from "./SearchTopicsPaginator"; diff --git a/clients/client-quicksight/src/protocols/Aws_restJson1.ts b/clients/client-quicksight/src/protocols/Aws_restJson1.ts index d669524c3d06..597a4968a4d7 100644 --- a/clients/client-quicksight/src/protocols/Aws_restJson1.ts +++ b/clients/client-quicksight/src/protocols/Aws_restJson1.ts @@ -239,6 +239,10 @@ import { DescribeDashboardSnapshotJobResultCommandInput, DescribeDashboardSnapshotJobResultCommandOutput, } from "../commands/DescribeDashboardSnapshotJobResultCommand"; +import { + DescribeDashboardsQAConfigurationCommandInput, + DescribeDashboardsQAConfigurationCommandOutput, +} from "../commands/DescribeDashboardsQAConfigurationCommand"; import { DescribeDataSetCommandInput, DescribeDataSetCommandOutput } from "../commands/DescribeDataSetCommand"; import { DescribeDataSetPermissionsCommandInput, @@ -437,6 +441,7 @@ import { SearchDataSetsCommandInput, SearchDataSetsCommandOutput } from "../comm import { SearchDataSourcesCommandInput, SearchDataSourcesCommandOutput } from "../commands/SearchDataSourcesCommand"; import { SearchFoldersCommandInput, SearchFoldersCommandOutput } from "../commands/SearchFoldersCommand"; import { SearchGroupsCommandInput, SearchGroupsCommandOutput } from "../commands/SearchGroupsCommand"; +import { SearchTopicsCommandInput, SearchTopicsCommandOutput } from "../commands/SearchTopicsCommand"; import { StartAssetBundleExportJobCommandInput, StartAssetBundleExportJobCommandOutput, @@ -494,6 +499,10 @@ import { UpdateDashboardPublishedVersionCommandInput, UpdateDashboardPublishedVersionCommandOutput, } from "../commands/UpdateDashboardPublishedVersionCommand"; +import { + UpdateDashboardsQAConfigurationCommandInput, + UpdateDashboardsQAConfigurationCommandOutput, +} from "../commands/UpdateDashboardsQAConfigurationCommand"; import { UpdateDataSetCommandInput, UpdateDataSetCommandOutput } from "../commands/UpdateDataSetCommand"; import { UpdateDataSetPermissionsCommandInput, @@ -710,6 +719,10 @@ import { GridLayoutElement, GridLayoutScreenCanvasSizeOptions, HeaderFooterSectionConfiguration, + ImageCustomAction, + ImageCustomActionOperation, + ImageInteractionOptions, + ImageMenuOption, InnerFilter, IntegerDefaultValues, IntegerParameterDeclaration, @@ -741,8 +754,6 @@ import { NumericRangeFilter, NumericRangeFilterValue, NumericSeparatorConfiguration, - PanelConfiguration, - PanelTitleOptions, ParameterControl, ParameterDateTimePickerControl, ParameterDeclaration, @@ -757,13 +768,10 @@ import { PercentVisibleRange, QueryExecutionOptions, RangeEndsLabelType, - ReferenceLine, ReferenceLineCustomLabelConfiguration, ReferenceLineDataConfiguration, ReferenceLineDynamicDataConfiguration, - ReferenceLineLabelConfiguration, ReferenceLineStaticDataConfiguration, - ReferenceLineStyleConfiguration, ReferenceLineValueLabelConfiguration, RelativeDatesFilter, RelativeDateTimeControlDisplayOptions, @@ -779,16 +787,21 @@ import { SectionStyle, SelectedSheetsFilterScopeConfiguration, SetParameterValueConfiguration, + Sheet, SheetControlInfoIconLabelOptions, SheetControlLayout, SheetControlLayoutConfiguration, SheetElementConfigurationOverrides, SheetElementRenderingRule, + SheetImage, + SheetImageScalingConfiguration, + SheetImageSource, + SheetImageStaticFileSource, + SheetImageTooltipConfiguration, + SheetImageTooltipText, SheetTextBox, SheetVisualScopingConfiguration, SliderControlDisplayOptions, - SmallMultiplesAxisProperties, - SmallMultiplesOptions, Spacing, StringDefaultValues, StringFormatConfiguration, @@ -850,7 +863,6 @@ import { CustomContentConfiguration, CustomContentVisual, CustomNarrativeOptions, - DataBarsOptions, DataColor, DataFieldSeriesItem, DataPathColor, @@ -894,16 +906,44 @@ import { GaugeChartOptions, GaugeChartPrimaryValueConditionalFormatting, GaugeChartVisual, + GeospatialCategoricalColor, + GeospatialCategoricalDataColor, + GeospatialCircleRadius, + GeospatialCircleSymbolStyle, + GeospatialColor, GeospatialCoordinateBounds, + GeospatialDataSourceItem, + GeospatialGradientColor, + GeospatialGradientStepColor, GeospatialHeatmapColorScale, GeospatialHeatmapConfiguration, GeospatialHeatmapDataColor, + GeospatialLayerColorField, + GeospatialLayerDefinition, + GeospatialLayerItem, + GeospatialLayerJoinDefinition, + GeospatialLayerMapConfiguration, + GeospatialLineLayer, + GeospatialLineStyle, + GeospatialLineSymbolStyle, + GeospatialLineWidth, GeospatialMapAggregatedFieldWells, GeospatialMapConfiguration, GeospatialMapFieldWells, + GeospatialMapState, + GeospatialMapStyle, GeospatialMapStyleOptions, GeospatialMapVisual, + GeospatialNullDataSettings, + GeospatialNullSymbolStyle, + GeospatialPointLayer, + GeospatialPointStyle, GeospatialPointStyleOptions, + GeospatialPolygonLayer, + GeospatialPolygonStyle, + GeospatialPolygonSymbolStyle, + GeospatialSolidColor, + GeospatialStaticFileSource, GeospatialWindowOptions, GlobalTableBorderOptions, GradientColor, @@ -936,6 +976,9 @@ import { KPIVisual, KPIVisualLayoutOptions, KPIVisualStandardLayout, + LayerCustomAction, + LayerCustomActionOperation, + LayerMapVisual, LineChartAggregatedFieldWells, LineChartConfiguration, LineChartDefaultSeriesSettings, @@ -952,6 +995,8 @@ import { MissingDataConfiguration, NumericEqualityDrillDownFilter, PaginationConfiguration, + PanelConfiguration, + PanelTitleOptions, PeriodOverPeriodComputation, PeriodToDateComputation, PieChartAggregatedFieldWells, @@ -981,61 +1026,28 @@ import { PivotTableTotalOptions, PivotTableVisual, PivotTotalOptions, + PluginVisualFieldWell, + PluginVisualItemsLimitConfiguration, + PluginVisualTableQuerySort, PredefinedHierarchy, ProgressBarOptions, - RadarChartAggregatedFieldWells, - RadarChartAreaStyleSettings, - RadarChartConfiguration, - RadarChartFieldWells, - RadarChartSeriesSettings, - RadarChartSortConfiguration, - RadarChartVisual, + ReferenceLine, + ReferenceLineLabelConfiguration, + ReferenceLineStyleConfiguration, RowAlternateColorOptions, - SankeyDiagramAggregatedFieldWells, - SankeyDiagramChartConfiguration, - SankeyDiagramFieldWells, - SankeyDiagramSortConfiguration, - SankeyDiagramVisual, - ScatterPlotCategoricallyAggregatedFieldWells, - ScatterPlotConfiguration, - ScatterPlotFieldWells, - ScatterPlotSortConfiguration, - ScatterPlotUnaggregatedFieldWells, - ScatterPlotVisual, SecondaryValueOptions, SeriesItem, ShapeConditionalFormat, ShortFormatText, SimpleClusterMarker, SingleAxisOptions, + SmallMultiplesAxisProperties, + SmallMultiplesOptions, SubtotalOptions, - TableAggregatedFieldWells, TableBorderOptions, - TableCellConditionalFormatting, - TableCellImageSizingConfiguration, TableCellStyle, - TableConditionalFormatting, - TableConditionalFormattingOption, - TableConfiguration, - TableFieldCustomIconContent, - TableFieldCustomTextContent, - TableFieldImageConfiguration, - TableFieldLinkConfiguration, - TableFieldLinkContentConfiguration, - TableFieldOption, - TableFieldOptions, - TableFieldURLConfiguration, - TableFieldWells, - TableInlineVisualization, - TableOptions, - TablePaginatedReportOptions, - TablePinnedFieldOptions, - TableRowConditionalFormatting, TableSideBorderOptions, - TableSortConfiguration, TableStyleTarget, - TableUnaggregatedFieldWells, - TableVisual, TextConditionalFormat, TimeBasedForecastProperties, TimeRangeDrillDownFilter, @@ -1046,10 +1058,6 @@ import { TotalAggregationComputation, TotalAggregationFunction, TotalAggregationOption, - TotalOptions, - TreeMapAggregatedFieldWells, - TreeMapFieldWells, - TreeMapSortConfiguration, TrendArrowOptions, UnaggregatedField, UniqueValuesComputation, @@ -1061,7 +1069,6 @@ import { YAxisOptions, } from "../models/models_1"; import { - _Parameters, AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, @@ -1153,39 +1160,16 @@ import { ColumnGroupColumnSchema, ColumnGroupSchema, ColumnLevelPermissionRule, - ColumnSchema, - ColumnTag, - ColumnTagName, - ComparativeOrder, - ConcurrentUpdatingException, ConflictException, ContributionAnalysisFactor, ContributionAnalysisTimeRanges, - CreateColumnsOperation, - DashboardPublishOptions, - DashboardSourceEntity, - DashboardSourceTemplate, - DashboardVersionDefinition, DashboardVisualId, - DashboardVisualPublishOptions, + DataBarsOptions, DatabricksParameters, - DataPointDrillUpDownOption, - DataPointMenuLabelOption, - DataPointTooltipOption, - DatasetParameter, DataSetReference, DataSourceParameters, - DateTimeDatasetParameter, - DateTimeDatasetParameterDefaultValues, - DateTimeParameter, - DecimalDatasetParameter, - DecimalDatasetParameterDefaultValues, - DecimalParameter, DisplayFormatOptions, ExasolParameters, - ExportHiddenFieldsOption, - ExportToCSVOption, - ExportWithHiddenFieldsOption, FilterAggMetrics, GeoSpatialColumnGroup, Identifier, @@ -1193,16 +1177,10 @@ import { ImageConfiguration, ImageSetConfiguration, ImageSource, - IntegerDatasetParameter, - IntegerDatasetParameterDefaultValues, - IntegerParameter, + ImageStaticFile, InternalFailureException, - InternalServerException, InvalidParameterValueException, - InvalidRequestException, JiraParameters, - LimitExceededException, - LinkSharingConfiguration, LogoConfiguration, LogoSetConfiguration, ManifestFileLocation, @@ -1214,35 +1192,78 @@ import { OAuthParameters, OracleParameters, Palette, + PluginVisual, + PluginVisualConfiguration, + PluginVisualOptions, + PluginVisualProperty, + PluginVisualSortConfiguration, PostgreSqlParameters, - PreconditionNotMetException, PrestoParameters, + RadarChartAggregatedFieldWells, + RadarChartAreaStyleSettings, + RadarChartConfiguration, + RadarChartFieldWells, + RadarChartSeriesSettings, + RadarChartSortConfiguration, + RadarChartVisual, RdsParameters, RedshiftIAMParameters, RedshiftParameters, ResourceExistsException, ResourceNotFoundException, - ResourcePermission, - ResourceUnavailableException, S3BucketConfiguration, S3Parameters, + SankeyDiagramAggregatedFieldWells, + SankeyDiagramChartConfiguration, + SankeyDiagramFieldWells, + SankeyDiagramSortConfiguration, + SankeyDiagramVisual, + ScatterPlotCategoricallyAggregatedFieldWells, + ScatterPlotConfiguration, + ScatterPlotFieldWells, + ScatterPlotSortConfiguration, + ScatterPlotUnaggregatedFieldWells, + ScatterPlotVisual, ServiceNowParameters, SharedViewConfigurations, - SheetControlsOption, SheetDefinition, - SheetLayoutElementMaximizationOption, Slot, SnapshotFile, SnapshotFileSheetSelection, SnapshotS3DestinationConfiguration, SnowflakeParameters, SparkParameters, + SpatialStaticFile, SqlServerParameters, SslProperties, StarburstParameters, - StringDatasetParameter, - StringDatasetParameterDefaultValues, - StringParameter, + StaticFile, + StaticFileS3SourceOptions, + StaticFileSource, + StaticFileUrlSourceOptions, + TableAggregatedFieldWells, + TableCellConditionalFormatting, + TableCellImageSizingConfiguration, + TableConditionalFormatting, + TableConditionalFormattingOption, + TableConfiguration, + TableFieldCustomIconContent, + TableFieldCustomTextContent, + TableFieldImageConfiguration, + TableFieldLinkConfiguration, + TableFieldLinkContentConfiguration, + TableFieldOption, + TableFieldOptions, + TableFieldURLConfiguration, + TableFieldWells, + TableInlineVisualization, + TableOptions, + TablePaginatedReportOptions, + TablePinnedFieldOptions, + TableRowConditionalFormatting, + TableSortConfiguration, + TableUnaggregatedFieldWells, + TableVisual, Tag, TeradataParameters, ThrottlingException, @@ -1255,14 +1276,15 @@ import { TopicIRMetric, TopicSortClause, TopicTemplate, + TotalOptions, + TreeMapAggregatedFieldWells, TreeMapConfiguration, + TreeMapFieldWells, + TreeMapSortConfiguration, TreeMapVisual, TrinoParameters, TwitterParameters, - UnsupportedUserEditionException, - ValidationStrategy, Visual, - VisualAxisSortOption, VisualOptions, VpcConnectionProperties, WaterfallChartAggregatedFieldWells, @@ -1281,19 +1303,35 @@ import { WordCloudVisual, } from "../models/models_2"; import { + _Parameters, + ColumnSchema, + ColumnTag, + ColumnTagName, + ComparativeOrder, + ConcurrentUpdatingException, + CreateColumnsOperation, CredentialPair, CustomerManagedKeyUnavailableException, CustomSql, Dashboard, + DashboardPublishOptions, DashboardSearchFilter, + DashboardSourceEntity, + DashboardSourceTemplate, DashboardSummary, DashboardVersion, + DashboardVersionDefinition, DashboardVersionSummary, + DashboardVisualPublishOptions, DataAggregation, DataColorPalette, + DataPointDrillUpDownOption, + DataPointMenuLabelOption, + DataPointTooltipOption, DataSet, DataSetConfiguration, DatasetMetadata, + DatasetParameter, DataSetRefreshProperties, DataSetSchema, DataSetSearchFilter, @@ -1303,18 +1341,31 @@ import { DataSourceCredentials, DataSourceSearchFilter, DataSourceSummary, + DateTimeDatasetParameter, + DateTimeDatasetParameterDefaultValues, + DateTimeParameter, + DecimalDatasetParameter, + DecimalDatasetParameterDefaultValues, + DecimalParameter, DefaultFormatting, + ExportHiddenFieldsOption, + ExportToCSVOption, + ExportWithHiddenFieldsOption, FieldFolder, FilterOperation, - Folder, Font, GutterStyle, IncrementalRefresh, - Ingestion, InputColumn, - InvalidNextTokenException, + IntegerDatasetParameter, + IntegerDatasetParameterDefaultValues, + IntegerParameter, + InternalServerException, + InvalidRequestException, JoinInstruction, JoinKeyProperties, + LimitExceededException, + LinkSharingConfiguration, LogicalTable, LogicalTableSource, LookbackWindow, @@ -1324,6 +1375,7 @@ import { NewDefaultValues, OverrideDatasetParameterOperation, PhysicalTable, + PreconditionNotMetException, ProjectOperation, RangeConstant, RefreshConfiguration, @@ -1331,6 +1383,8 @@ import { RefreshSchedule, RelationalTable, RenameColumnOperation, + ResourcePermission, + ResourceUnavailableException, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, RowLevelPermissionTagRule, @@ -1338,10 +1392,12 @@ import { ScheduleRefreshOnEntity, SemanticEntityType, SemanticType, + SheetControlsOption, + SheetLayoutElementMaximizationOption, SheetStyle, - SnapshotConfiguration, - SnapshotDestinationConfiguration, - SnapshotFileGroup, + StringDatasetParameter, + StringDatasetParameterDefaultValues, + StringParameter, TagColumnOperation, TemplateSourceAnalysis, TemplateSourceEntity, @@ -1368,16 +1424,21 @@ import { TransformOperation, Typography, UIColorPalette, + UnsupportedUserEditionException, UntagColumnOperation, UploadSettings, + ValidationStrategy, + VisualAxisSortOption, } from "../models/models_3"; import { - CreateTopicReviewedAnswer, DomainNotWhitelistedException, + Folder, FolderSearchFilter, FolderSummary, GroupSearchFilter, IdentityTypeNotSupportedException, + Ingestion, + InvalidNextTokenException, QuickSightUserNotFoundException, RegisteredCustomerManagedKey, RegisteredUserConsoleFeatureConfigurations, @@ -1391,6 +1452,9 @@ import { SessionLifetimeInMinutesInvalidException, SessionTag, SnapshotAnonymousUser, + SnapshotConfiguration, + SnapshotDestinationConfiguration, + SnapshotFileGroup, SnapshotUserConfiguration, StatePersistenceConfigurations, Template, @@ -1402,12 +1466,12 @@ import { ThemeVersion, ThemeVersionSummary, TopicRefreshScheduleSummary, - TopicReviewedAnswer, - TopicVisual, + TopicSearchFilter, UnsupportedPricingPlanException, VPCConnection, VPCConnectionSummary, } from "../models/models_4"; +import { CreateTopicReviewedAnswer, TopicReviewedAnswer, TopicVisual } from "../models/models_5"; import { QuickSightServiceException as __BaseException } from "../models/QuickSightServiceException"; /** @@ -2067,6 +2131,7 @@ export const se_CreateTopicCommand = async ( let body: any; body = JSON.stringify( take(input, { + FolderArns: (_) => _json(_), Tags: (_) => _json(_), Topic: (_) => _json(_), TopicId: [], @@ -2972,6 +3037,22 @@ export const se_DescribeDashboardSnapshotJobResultCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1DescribeDashboardsQAConfigurationCommand + */ +export const se_DescribeDashboardsQAConfigurationCommand = async ( + input: DescribeDashboardsQAConfigurationCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/accounts/{AwsAccountId}/dashboards-qa-configuration"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + let body: any; + b.m("GET").h(headers).b(body); + return b.build(); +}; + /** * serializeAws_restJson1DescribeDataSetCommand */ @@ -4554,6 +4635,31 @@ export const se_SearchGroupsCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1SearchTopicsCommand + */ +export const se_SearchTopicsCommand = async ( + input: SearchTopicsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = { + "content-type": "application/json", + }; + b.bp("/accounts/{AwsAccountId}/search/topics"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + let body: any; + body = JSON.stringify( + take(input, { + Filters: (_) => _json(_), + MaxResults: [], + NextToken: [], + }) + ); + b.m("POST").h(headers).b(body); + return b.build(); +}; + /** * serializeAws_restJson1StartAssetBundleExportJobCommand */ @@ -5002,33 +5108,56 @@ export const se_UpdateDashboardPublishedVersionCommand = async ( }; /** - * serializeAws_restJson1UpdateDataSetCommand + * serializeAws_restJson1UpdateDashboardsQAConfigurationCommand */ -export const se_UpdateDataSetCommand = async ( - input: UpdateDataSetCommandInput, +export const se_UpdateDashboardsQAConfigurationCommand = async ( + input: UpdateDashboardsQAConfigurationCommandInput, context: __SerdeContext ): Promise<__HttpRequest> => { const b = rb(input, context); const headers: any = { "content-type": "application/json", }; - b.bp("/accounts/{AwsAccountId}/data-sets/{DataSetId}"); + b.bp("/accounts/{AwsAccountId}/dashboards-qa-configuration"); b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); - b.p("DataSetId", () => input.DataSetId!, "{DataSetId}", false); let body: any; body = JSON.stringify( take(input, { - ColumnGroups: (_) => _json(_), - ColumnLevelPermissionRules: (_) => _json(_), - DataSetUsageConfiguration: (_) => _json(_), - DatasetParameters: (_) => se_DatasetParameterList(_, context), - FieldFolders: (_) => _json(_), - ImportMode: [], - LogicalTableMap: (_) => se_LogicalTableMap(_, context), - Name: [], - PhysicalTableMap: (_) => _json(_), - RowLevelPermissionDataSet: (_) => _json(_), - RowLevelPermissionTagConfiguration: (_) => _json(_), + DashboardsQAStatus: [], + }) + ); + b.m("PUT").h(headers).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1UpdateDataSetCommand + */ +export const se_UpdateDataSetCommand = async ( + input: UpdateDataSetCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = { + "content-type": "application/json", + }; + b.bp("/accounts/{AwsAccountId}/data-sets/{DataSetId}"); + b.p("AwsAccountId", () => input.AwsAccountId!, "{AwsAccountId}", false); + b.p("DataSetId", () => input.DataSetId!, "{DataSetId}", false); + let body: any; + body = JSON.stringify( + take(input, { + ColumnGroups: (_) => _json(_), + ColumnLevelPermissionRules: (_) => _json(_), + DataSetUsageConfiguration: (_) => _json(_), + DatasetParameters: (_) => se_DatasetParameterList(_, context), + FieldFolders: (_) => _json(_), + ImportMode: [], + LogicalTableMap: (_) => se_LogicalTableMap(_, context), + Name: [], + PhysicalTableMap: (_) => _json(_), + RowLevelPermissionDataSet: (_) => _json(_), + RowLevelPermissionTagConfiguration: (_) => _json(_), }) ); b.m("PUT").h(headers).b(body); @@ -7648,6 +7777,31 @@ export const de_DescribeDashboardSnapshotJobResultCommand = async ( return contents; }; +/** + * deserializeAws_restJson1DescribeDashboardsQAConfigurationCommand + */ +export const de_DescribeDashboardsQAConfigurationCommand = 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, { + DashboardsQAStatus: __expectString, + RequestId: __expectString, + }); + Object.assign(contents, doc); + map(contents, { + Status: [, output.statusCode], + }); + return contents; +}; + /** * deserializeAws_restJson1DescribeDataSetCommand */ @@ -9663,6 +9817,32 @@ export const de_SearchGroupsCommand = async ( return contents; }; +/** + * deserializeAws_restJson1SearchTopicsCommand + */ +export const de_SearchTopicsCommand = 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, { + NextToken: __expectString, + RequestId: __expectString, + TopicSummaryList: _json, + }); + Object.assign(contents, doc); + map(contents, { + Status: [, output.statusCode], + }); + return contents; +}; + /** * deserializeAws_restJson1StartAssetBundleExportJobCommand */ @@ -10115,6 +10295,31 @@ export const de_UpdateDashboardPublishedVersionCommand = async ( return contents; }; +/** + * deserializeAws_restJson1UpdateDashboardsQAConfigurationCommand + */ +export const de_UpdateDashboardsQAConfigurationCommand = 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, { + DashboardsQAStatus: __expectString, + RequestId: __expectString, + }); + Object.assign(contents, doc); + map(contents, { + Status: [, output.statusCode], + }); + return contents; +}; + /** * deserializeAws_restJson1UpdateDataSetCommand */ @@ -11432,6 +11637,7 @@ const se_AnalysisDefinition = (input: AnalysisDefinition, context: __SerdeContex ParameterDeclarations: (_) => se_ParameterDeclarationList(_, context), QueryExecutionOptions: _json, Sheets: (_) => se_SheetDefinitionList(_, context), + StaticFiles: _json, }); }; @@ -11892,6 +12098,7 @@ const se_BarChartVisual = (input: BarChartVisual, context: __SerdeContext): any ColumnHierarchies: (_) => se_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; @@ -12095,6 +12302,7 @@ const se_BoxPlotVisual = (input: BoxPlotVisual, context: __SerdeContext): any => ColumnHierarchies: (_) => se_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; @@ -12355,6 +12563,7 @@ const se_ComboChartVisual = (input: ComboChartVisual, context: __SerdeContext): ColumnHierarchies: (_) => se_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; @@ -12510,6 +12719,7 @@ const se_CustomContentVisual = (input: CustomContentVisual, context: __SerdeCont DataSetIdentifier: [], Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; @@ -12567,6 +12777,7 @@ const se_DashboardVersionDefinition = (input: DashboardVersionDefinition, contex Options: _json, ParameterDeclarations: (_) => se_ParameterDeclarationList(_, context), Sheets: (_) => se_SheetDefinitionList(_, context), + StaticFiles: _json, }); }; @@ -13227,6 +13438,7 @@ const se_FilledMapVisual = (input: FilledMapVisual, context: __SerdeContext): an ConditionalFormatting: (_) => se_FilledMapConditionalFormatting(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; @@ -13513,6 +13725,7 @@ const se_FunnelChartVisual = (input: FunnelChartVisual, context: __SerdeContext) ColumnHierarchies: (_) => se_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; @@ -13628,210 +13841,184 @@ const se_GaugeChartVisual = (input: GaugeChartVisual, context: __SerdeContext): ConditionalFormatting: (_) => se_GaugeChartConditionalFormatting(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; -// se_GeoSpatialColumnGroup omitted. - /** - * serializeAws_restJson1GeospatialCoordinateBounds + * serializeAws_restJson1GeospatialCategoricalColor */ -const se_GeospatialCoordinateBounds = (input: GeospatialCoordinateBounds, context: __SerdeContext): any => { +const se_GeospatialCategoricalColor = (input: GeospatialCategoricalColor, context: __SerdeContext): any => { return take(input, { - East: __serializeFloat, - North: __serializeFloat, - South: __serializeFloat, - West: __serializeFloat, + CategoryDataColors: _json, + DefaultOpacity: __serializeFloat, + NullDataSettings: (_) => se_GeospatialNullDataSettings(_, context), + NullDataVisibility: [], }); }; -// se_GeospatialHeatmapColorScale omitted. - -// se_GeospatialHeatmapConfiguration omitted. - -// se_GeospatialHeatmapDataColor omitted. - -// se_GeospatialHeatmapDataColorList omitted. +// se_GeospatialCategoricalDataColor omitted. -/** - * serializeAws_restJson1GeospatialMapAggregatedFieldWells - */ -const se_GeospatialMapAggregatedFieldWells = ( - input: GeospatialMapAggregatedFieldWells, - context: __SerdeContext -): any => { - return take(input, { - Colors: _json, - Geospatial: _json, - Values: (_) => se_MeasureFieldList(_, context), - }); -}; +// se_GeospatialCategoricalDataColorList omitted. /** - * serializeAws_restJson1GeospatialMapConfiguration + * serializeAws_restJson1GeospatialCircleRadius */ -const se_GeospatialMapConfiguration = (input: GeospatialMapConfiguration, context: __SerdeContext): any => { +const se_GeospatialCircleRadius = (input: GeospatialCircleRadius, context: __SerdeContext): any => { return take(input, { - FieldWells: (_) => se_GeospatialMapFieldWells(_, context), - Interactions: _json, - Legend: _json, - MapStyleOptions: _json, - PointStyleOptions: _json, - Tooltip: (_) => se_TooltipOptions(_, context), - VisualPalette: _json, - WindowOptions: (_) => se_GeospatialWindowOptions(_, context), + Radius: __serializeFloat, }); }; /** - * serializeAws_restJson1GeospatialMapFieldWells + * serializeAws_restJson1GeospatialCircleSymbolStyle */ -const se_GeospatialMapFieldWells = (input: GeospatialMapFieldWells, context: __SerdeContext): any => { +const se_GeospatialCircleSymbolStyle = (input: GeospatialCircleSymbolStyle, context: __SerdeContext): any => { return take(input, { - GeospatialMapAggregatedFieldWells: (_) => se_GeospatialMapAggregatedFieldWells(_, context), + CircleRadius: (_) => se_GeospatialCircleRadius(_, context), + FillColor: (_) => se_GeospatialColor(_, context), + StrokeColor: (_) => se_GeospatialColor(_, context), + StrokeWidth: (_) => se_GeospatialLineWidth(_, context), }); }; -// se_GeospatialMapStyleOptions omitted. - /** - * serializeAws_restJson1GeospatialMapVisual + * serializeAws_restJson1GeospatialColor */ -const se_GeospatialMapVisual = (input: GeospatialMapVisual, context: __SerdeContext): any => { +const se_GeospatialColor = (input: GeospatialColor, context: __SerdeContext): any => { return take(input, { - Actions: (_) => se_VisualCustomActionList(_, context), - ChartConfiguration: (_) => se_GeospatialMapConfiguration(_, context), - ColumnHierarchies: (_) => se_ColumnHierarchyList(_, context), - Subtitle: _json, - Title: _json, - VisualId: [], + Categorical: (_) => se_GeospatialCategoricalColor(_, context), + Gradient: (_) => se_GeospatialGradientColor(_, context), + Solid: _json, }); }; -// se_GeospatialPointStyleOptions omitted. +// se_GeoSpatialColumnGroup omitted. /** - * serializeAws_restJson1GeospatialWindowOptions + * serializeAws_restJson1GeospatialCoordinateBounds */ -const se_GeospatialWindowOptions = (input: GeospatialWindowOptions, context: __SerdeContext): any => { +const se_GeospatialCoordinateBounds = (input: GeospatialCoordinateBounds, context: __SerdeContext): any => { return take(input, { - Bounds: (_) => se_GeospatialCoordinateBounds(_, context), - MapZoomMode: [], + East: __serializeFloat, + North: __serializeFloat, + South: __serializeFloat, + West: __serializeFloat, }); }; -// se_GlobalTableBorderOptions omitted. +// se_GeospatialDataSourceItem omitted. /** - * serializeAws_restJson1GradientColor + * serializeAws_restJson1GeospatialGradientColor */ -const se_GradientColor = (input: GradientColor, context: __SerdeContext): any => { +const se_GeospatialGradientColor = (input: GeospatialGradientColor, context: __SerdeContext): any => { return take(input, { - Stops: (_) => se_GradientStopList(_, context), + DefaultOpacity: __serializeFloat, + NullDataSettings: (_) => se_GeospatialNullDataSettings(_, context), + NullDataVisibility: [], + StepColors: (_) => se_GeospatialGradientStepColorList(_, context), }); }; /** - * serializeAws_restJson1GradientStop + * serializeAws_restJson1GeospatialGradientStepColor */ -const se_GradientStop = (input: GradientStop, context: __SerdeContext): any => { +const se_GeospatialGradientStepColor = (input: GeospatialGradientStepColor, context: __SerdeContext): any => { return take(input, { Color: [], DataValue: __serializeFloat, - GradientOffset: __serializeFloat, }); }; /** - * serializeAws_restJson1GradientStopList + * serializeAws_restJson1GeospatialGradientStepColorList */ -const se_GradientStopList = (input: GradientStop[], context: __SerdeContext): any => { +const se_GeospatialGradientStepColorList = (input: GeospatialGradientStepColor[], context: __SerdeContext): any => { return input .filter((e: any) => e != null) .map((entry) => { - return se_GradientStop(entry, context); + return se_GeospatialGradientStepColor(entry, context); }); }; -// se_GridLayoutCanvasSizeOptions omitted. - -// se_GridLayoutConfiguration omitted. - -// se_GridLayoutElement omitted. - -// se_GridLayoutElementList omitted. - -// se_GridLayoutScreenCanvasSizeOptions omitted. +// se_GeospatialHeatmapColorScale omitted. -// se_GroupSearchFilter omitted. +// se_GeospatialHeatmapConfiguration omitted. -// se_GroupSearchFilterList omitted. +// se_GeospatialHeatmapDataColor omitted. -// se_GroupsList omitted. +// se_GeospatialHeatmapDataColorList omitted. /** - * serializeAws_restJson1GrowthRateComputation + * serializeAws_restJson1GeospatialLayerColorField */ -const se_GrowthRateComputation = (input: GrowthRateComputation, context: __SerdeContext): any => { +const se_GeospatialLayerColorField = (input: GeospatialLayerColorField, context: __SerdeContext): any => { return take(input, { - ComputationId: [], - Name: [], - PeriodSize: [], - Time: _json, - Value: (_) => se_MeasureField(_, context), + ColorDimensionsFields: _json, + ColorValuesFields: (_) => se_GeospatialLayerMeasureFieldList(_, context), }); }; -// se_GutterStyle omitted. - -// se_HeaderFooterSectionConfiguration omitted. - -// se_HeaderFooterSectionConfigurationList omitted. - /** - * serializeAws_restJson1HeatMapAggregatedFieldWells + * serializeAws_restJson1GeospatialLayerDefinition */ -const se_HeatMapAggregatedFieldWells = (input: HeatMapAggregatedFieldWells, context: __SerdeContext): any => { +const se_GeospatialLayerDefinition = (input: GeospatialLayerDefinition, context: __SerdeContext): any => { return take(input, { - Columns: _json, - Rows: _json, - Values: (_) => se_HeatMapMeasureFieldList(_, context), + LineLayer: (_) => se_GeospatialLineLayer(_, context), + PointLayer: (_) => se_GeospatialPointLayer(_, context), + PolygonLayer: (_) => se_GeospatialPolygonLayer(_, context), }); }; +// se_GeospatialLayerDimensionFieldList omitted. + /** - * serializeAws_restJson1HeatMapConfiguration + * serializeAws_restJson1GeospatialLayerItem */ -const se_HeatMapConfiguration = (input: HeatMapConfiguration, context: __SerdeContext): any => { +const se_GeospatialLayerItem = (input: GeospatialLayerItem, context: __SerdeContext): any => { return take(input, { - ColorScale: (_) => se_ColorScale(_, context), - ColumnLabelOptions: _json, - DataLabels: _json, - FieldWells: (_) => se_HeatMapFieldWells(_, context), - Interactions: _json, - Legend: _json, - RowLabelOptions: _json, - SortConfiguration: (_) => se_HeatMapSortConfiguration(_, context), + Actions: (_) => se_LayerCustomActionList(_, context), + DataSource: _json, + JoinDefinition: (_) => se_GeospatialLayerJoinDefinition(_, context), + Label: [], + LayerDefinition: (_) => se_GeospatialLayerDefinition(_, context), + LayerId: [], + LayerType: [], Tooltip: (_) => se_TooltipOptions(_, context), + Visibility: [], }); }; -// se_HeatMapDimensionFieldList omitted. +/** + * serializeAws_restJson1GeospatialLayerJoinDefinition + */ +const se_GeospatialLayerJoinDefinition = (input: GeospatialLayerJoinDefinition, context: __SerdeContext): any => { + return take(input, { + ColorField: (_) => se_GeospatialLayerColorField(_, context), + DatasetKeyField: _json, + ShapeKeyField: [], + }); +}; /** - * serializeAws_restJson1HeatMapFieldWells + * serializeAws_restJson1GeospatialLayerMapConfiguration */ -const se_HeatMapFieldWells = (input: HeatMapFieldWells, context: __SerdeContext): any => { +const se_GeospatialLayerMapConfiguration = (input: GeospatialLayerMapConfiguration, context: __SerdeContext): any => { return take(input, { - HeatMapAggregatedFieldWells: (_) => se_HeatMapAggregatedFieldWells(_, context), + Interactions: _json, + Legend: _json, + MapLayers: (_) => se_GeospatialMapLayerList(_, context), + MapState: (_) => se_GeospatialMapState(_, context), + MapStyle: _json, }); }; /** - * serializeAws_restJson1HeatMapMeasureFieldList + * serializeAws_restJson1GeospatialLayerMeasureFieldList */ -const se_HeatMapMeasureFieldList = (input: MeasureField[], context: __SerdeContext): any => { +const se_GeospatialLayerMeasureFieldList = (input: MeasureField[], context: __SerdeContext): any => { return input .filter((e: any) => e != null) .map((entry) => { @@ -13840,54 +14027,372 @@ const se_HeatMapMeasureFieldList = (input: MeasureField[], context: __SerdeConte }; /** - * serializeAws_restJson1HeatMapSortConfiguration + * serializeAws_restJson1GeospatialLineLayer */ -const se_HeatMapSortConfiguration = (input: HeatMapSortConfiguration, context: __SerdeContext): any => { +const se_GeospatialLineLayer = (input: GeospatialLineLayer, context: __SerdeContext): any => { return take(input, { - HeatMapColumnItemsLimitConfiguration: _json, - HeatMapColumnSort: (_) => se_FieldSortOptionsList(_, context), - HeatMapRowItemsLimitConfiguration: _json, - HeatMapRowSort: (_) => se_FieldSortOptionsList(_, context), + Style: (_) => se_GeospatialLineStyle(_, context), }); }; /** - * serializeAws_restJson1HeatMapVisual + * serializeAws_restJson1GeospatialLineStyle */ -const se_HeatMapVisual = (input: HeatMapVisual, context: __SerdeContext): any => { +const se_GeospatialLineStyle = (input: GeospatialLineStyle, context: __SerdeContext): any => { return take(input, { - Actions: (_) => se_VisualCustomActionList(_, context), - ChartConfiguration: (_) => se_HeatMapConfiguration(_, context), - ColumnHierarchies: (_) => se_ColumnHierarchyList(_, context), - Subtitle: _json, - Title: _json, - VisualId: [], + LineSymbolStyle: (_) => se_GeospatialLineSymbolStyle(_, context), }); }; /** - * serializeAws_restJson1HistogramAggregatedFieldWells + * serializeAws_restJson1GeospatialLineSymbolStyle */ -const se_HistogramAggregatedFieldWells = (input: HistogramAggregatedFieldWells, context: __SerdeContext): any => { +const se_GeospatialLineSymbolStyle = (input: GeospatialLineSymbolStyle, context: __SerdeContext): any => { return take(input, { - Values: (_) => se_HistogramMeasureFieldList(_, context), + FillColor: (_) => se_GeospatialColor(_, context), + LineWidth: (_) => se_GeospatialLineWidth(_, context), }); }; /** - * serializeAws_restJson1HistogramBinOptions + * serializeAws_restJson1GeospatialLineWidth */ -const se_HistogramBinOptions = (input: HistogramBinOptions, context: __SerdeContext): any => { +const se_GeospatialLineWidth = (input: GeospatialLineWidth, context: __SerdeContext): any => { return take(input, { - BinCount: _json, - BinWidth: (_) => se_BinWidthOptions(_, context), - SelectedBinType: [], - StartValue: __serializeFloat, + LineWidth: __serializeFloat, }); }; /** - * serializeAws_restJson1HistogramConfiguration + * serializeAws_restJson1GeospatialMapAggregatedFieldWells + */ +const se_GeospatialMapAggregatedFieldWells = ( + input: GeospatialMapAggregatedFieldWells, + context: __SerdeContext +): any => { + return take(input, { + Colors: _json, + Geospatial: _json, + Values: (_) => se_MeasureFieldList(_, context), + }); +}; + +/** + * serializeAws_restJson1GeospatialMapConfiguration + */ +const se_GeospatialMapConfiguration = (input: GeospatialMapConfiguration, context: __SerdeContext): any => { + return take(input, { + FieldWells: (_) => se_GeospatialMapFieldWells(_, context), + Interactions: _json, + Legend: _json, + MapStyleOptions: _json, + PointStyleOptions: _json, + Tooltip: (_) => se_TooltipOptions(_, context), + VisualPalette: _json, + WindowOptions: (_) => se_GeospatialWindowOptions(_, context), + }); +}; + +/** + * serializeAws_restJson1GeospatialMapFieldWells + */ +const se_GeospatialMapFieldWells = (input: GeospatialMapFieldWells, context: __SerdeContext): any => { + return take(input, { + GeospatialMapAggregatedFieldWells: (_) => se_GeospatialMapAggregatedFieldWells(_, context), + }); +}; + +/** + * serializeAws_restJson1GeospatialMapLayerList + */ +const se_GeospatialMapLayerList = (input: GeospatialLayerItem[], context: __SerdeContext): any => { + return input + .filter((e: any) => e != null) + .map((entry) => { + return se_GeospatialLayerItem(entry, context); + }); +}; + +/** + * serializeAws_restJson1GeospatialMapState + */ +const se_GeospatialMapState = (input: GeospatialMapState, context: __SerdeContext): any => { + return take(input, { + Bounds: (_) => se_GeospatialCoordinateBounds(_, context), + MapNavigation: [], + }); +}; + +// se_GeospatialMapStyle omitted. + +// se_GeospatialMapStyleOptions omitted. + +/** + * serializeAws_restJson1GeospatialMapVisual + */ +const se_GeospatialMapVisual = (input: GeospatialMapVisual, context: __SerdeContext): any => { + return take(input, { + Actions: (_) => se_VisualCustomActionList(_, context), + ChartConfiguration: (_) => se_GeospatialMapConfiguration(_, context), + ColumnHierarchies: (_) => se_ColumnHierarchyList(_, context), + Subtitle: _json, + Title: _json, + VisualContentAltText: [], + VisualId: [], + }); +}; + +/** + * serializeAws_restJson1GeospatialNullDataSettings + */ +const se_GeospatialNullDataSettings = (input: GeospatialNullDataSettings, context: __SerdeContext): any => { + return take(input, { + SymbolStyle: (_) => se_GeospatialNullSymbolStyle(_, context), + }); +}; + +/** + * serializeAws_restJson1GeospatialNullSymbolStyle + */ +const se_GeospatialNullSymbolStyle = (input: GeospatialNullSymbolStyle, context: __SerdeContext): any => { + return take(input, { + FillColor: [], + StrokeColor: [], + StrokeWidth: __serializeFloat, + }); +}; + +/** + * serializeAws_restJson1GeospatialPointLayer + */ +const se_GeospatialPointLayer = (input: GeospatialPointLayer, context: __SerdeContext): any => { + return take(input, { + Style: (_) => se_GeospatialPointStyle(_, context), + }); +}; + +/** + * serializeAws_restJson1GeospatialPointStyle + */ +const se_GeospatialPointStyle = (input: GeospatialPointStyle, context: __SerdeContext): any => { + return take(input, { + CircleSymbolStyle: (_) => se_GeospatialCircleSymbolStyle(_, context), + }); +}; + +// se_GeospatialPointStyleOptions omitted. + +/** + * serializeAws_restJson1GeospatialPolygonLayer + */ +const se_GeospatialPolygonLayer = (input: GeospatialPolygonLayer, context: __SerdeContext): any => { + return take(input, { + Style: (_) => se_GeospatialPolygonStyle(_, context), + }); +}; + +/** + * serializeAws_restJson1GeospatialPolygonStyle + */ +const se_GeospatialPolygonStyle = (input: GeospatialPolygonStyle, context: __SerdeContext): any => { + return take(input, { + PolygonSymbolStyle: (_) => se_GeospatialPolygonSymbolStyle(_, context), + }); +}; + +/** + * serializeAws_restJson1GeospatialPolygonSymbolStyle + */ +const se_GeospatialPolygonSymbolStyle = (input: GeospatialPolygonSymbolStyle, context: __SerdeContext): any => { + return take(input, { + FillColor: (_) => se_GeospatialColor(_, context), + StrokeColor: (_) => se_GeospatialColor(_, context), + StrokeWidth: (_) => se_GeospatialLineWidth(_, context), + }); +}; + +// se_GeospatialSolidColor omitted. + +// se_GeospatialStaticFileSource omitted. + +/** + * serializeAws_restJson1GeospatialWindowOptions + */ +const se_GeospatialWindowOptions = (input: GeospatialWindowOptions, context: __SerdeContext): any => { + return take(input, { + Bounds: (_) => se_GeospatialCoordinateBounds(_, context), + MapZoomMode: [], + }); +}; + +// se_GlobalTableBorderOptions omitted. + +/** + * serializeAws_restJson1GradientColor + */ +const se_GradientColor = (input: GradientColor, context: __SerdeContext): any => { + return take(input, { + Stops: (_) => se_GradientStopList(_, context), + }); +}; + +/** + * serializeAws_restJson1GradientStop + */ +const se_GradientStop = (input: GradientStop, context: __SerdeContext): any => { + return take(input, { + Color: [], + DataValue: __serializeFloat, + GradientOffset: __serializeFloat, + }); +}; + +/** + * serializeAws_restJson1GradientStopList + */ +const se_GradientStopList = (input: GradientStop[], context: __SerdeContext): any => { + return input + .filter((e: any) => e != null) + .map((entry) => { + return se_GradientStop(entry, context); + }); +}; + +// se_GridLayoutCanvasSizeOptions omitted. + +// se_GridLayoutConfiguration omitted. + +// se_GridLayoutElement omitted. + +// se_GridLayoutElementList omitted. + +// se_GridLayoutScreenCanvasSizeOptions omitted. + +// se_GroupSearchFilter omitted. + +// se_GroupSearchFilterList omitted. + +// se_GroupsList omitted. + +/** + * serializeAws_restJson1GrowthRateComputation + */ +const se_GrowthRateComputation = (input: GrowthRateComputation, context: __SerdeContext): any => { + return take(input, { + ComputationId: [], + Name: [], + PeriodSize: [], + Time: _json, + Value: (_) => se_MeasureField(_, context), + }); +}; + +// se_GutterStyle omitted. + +// se_HeaderFooterSectionConfiguration omitted. + +// se_HeaderFooterSectionConfigurationList omitted. + +/** + * serializeAws_restJson1HeatMapAggregatedFieldWells + */ +const se_HeatMapAggregatedFieldWells = (input: HeatMapAggregatedFieldWells, context: __SerdeContext): any => { + return take(input, { + Columns: _json, + Rows: _json, + Values: (_) => se_HeatMapMeasureFieldList(_, context), + }); +}; + +/** + * serializeAws_restJson1HeatMapConfiguration + */ +const se_HeatMapConfiguration = (input: HeatMapConfiguration, context: __SerdeContext): any => { + return take(input, { + ColorScale: (_) => se_ColorScale(_, context), + ColumnLabelOptions: _json, + DataLabels: _json, + FieldWells: (_) => se_HeatMapFieldWells(_, context), + Interactions: _json, + Legend: _json, + RowLabelOptions: _json, + SortConfiguration: (_) => se_HeatMapSortConfiguration(_, context), + Tooltip: (_) => se_TooltipOptions(_, context), + }); +}; + +// se_HeatMapDimensionFieldList omitted. + +/** + * serializeAws_restJson1HeatMapFieldWells + */ +const se_HeatMapFieldWells = (input: HeatMapFieldWells, context: __SerdeContext): any => { + return take(input, { + HeatMapAggregatedFieldWells: (_) => se_HeatMapAggregatedFieldWells(_, context), + }); +}; + +/** + * serializeAws_restJson1HeatMapMeasureFieldList + */ +const se_HeatMapMeasureFieldList = (input: MeasureField[], context: __SerdeContext): any => { + return input + .filter((e: any) => e != null) + .map((entry) => { + return se_MeasureField(entry, context); + }); +}; + +/** + * serializeAws_restJson1HeatMapSortConfiguration + */ +const se_HeatMapSortConfiguration = (input: HeatMapSortConfiguration, context: __SerdeContext): any => { + return take(input, { + HeatMapColumnItemsLimitConfiguration: _json, + HeatMapColumnSort: (_) => se_FieldSortOptionsList(_, context), + HeatMapRowItemsLimitConfiguration: _json, + HeatMapRowSort: (_) => se_FieldSortOptionsList(_, context), + }); +}; + +/** + * serializeAws_restJson1HeatMapVisual + */ +const se_HeatMapVisual = (input: HeatMapVisual, context: __SerdeContext): any => { + return take(input, { + Actions: (_) => se_VisualCustomActionList(_, context), + ChartConfiguration: (_) => se_HeatMapConfiguration(_, context), + ColumnHierarchies: (_) => se_ColumnHierarchyList(_, context), + Subtitle: _json, + Title: _json, + VisualContentAltText: [], + VisualId: [], + }); +}; + +/** + * serializeAws_restJson1HistogramAggregatedFieldWells + */ +const se_HistogramAggregatedFieldWells = (input: HistogramAggregatedFieldWells, context: __SerdeContext): any => { + return take(input, { + Values: (_) => se_HistogramMeasureFieldList(_, context), + }); +}; + +/** + * serializeAws_restJson1HistogramBinOptions + */ +const se_HistogramBinOptions = (input: HistogramBinOptions, context: __SerdeContext): any => { + return take(input, { + BinCount: _json, + BinWidth: (_) => se_BinWidthOptions(_, context), + SelectedBinType: [], + StartValue: __serializeFloat, + }); +}; + +/** + * serializeAws_restJson1HistogramConfiguration */ const se_HistogramConfiguration = (input: HistogramConfiguration, context: __SerdeContext): any => { return take(input, { @@ -13932,6 +14437,7 @@ const se_HistogramVisual = (input: HistogramVisual, context: __SerdeContext): an ChartConfiguration: (_) => se_HistogramConfiguration(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; @@ -13946,10 +14452,62 @@ const se_HistogramVisual = (input: HistogramVisual, context: __SerdeContext): an // se_ImageConfiguration omitted. +/** + * serializeAws_restJson1ImageCustomAction + */ +const se_ImageCustomAction = (input: ImageCustomAction, context: __SerdeContext): any => { + return take(input, { + ActionOperations: (_) => se_ImageCustomActionOperationList(_, context), + CustomActionId: [], + Name: [], + Status: [], + Trigger: [], + }); +}; + +/** + * serializeAws_restJson1ImageCustomActionList + */ +const se_ImageCustomActionList = (input: ImageCustomAction[], context: __SerdeContext): any => { + return input + .filter((e: any) => e != null) + .map((entry) => { + return se_ImageCustomAction(entry, context); + }); +}; + +/** + * serializeAws_restJson1ImageCustomActionOperation + */ +const se_ImageCustomActionOperation = (input: ImageCustomActionOperation, context: __SerdeContext): any => { + return take(input, { + NavigationOperation: _json, + SetParametersOperation: (_) => se_CustomActionSetParametersOperation(_, context), + URLOperation: _json, + }); +}; + +/** + * serializeAws_restJson1ImageCustomActionOperationList + */ +const se_ImageCustomActionOperationList = (input: ImageCustomActionOperation[], context: __SerdeContext): any => { + return input + .filter((e: any) => e != null) + .map((entry) => { + return se_ImageCustomActionOperation(entry, context); + }); +}; + +// se_ImageInteractionOptions omitted. + +// se_ImageMenuOption omitted. + // se_ImageSetConfiguration omitted. // se_ImageSource omitted. +// se_ImageStaticFile omitted. + // se_IncrementalRefresh omitted. /** @@ -13986,6 +14544,7 @@ const se_InsightVisual = (input: InsightVisual, context: __SerdeContext): any => InsightConfiguration: (_) => se_InsightConfiguration(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; @@ -14120,49 +14679,111 @@ const se_KPIPrimaryValueConditionalFormatting = ( }; /** - * serializeAws_restJson1KPIProgressBarConditionalFormatting + * serializeAws_restJson1KPIProgressBarConditionalFormatting + */ +const se_KPIProgressBarConditionalFormatting = ( + input: KPIProgressBarConditionalFormatting, + context: __SerdeContext +): any => { + return take(input, { + ForegroundColor: (_) => se_ConditionalFormattingColor(_, context), + }); +}; + +/** + * serializeAws_restJson1KPISortConfiguration + */ +const se_KPISortConfiguration = (input: KPISortConfiguration, context: __SerdeContext): any => { + return take(input, { + TrendGroupSort: (_) => se_FieldSortOptionsList(_, context), + }); +}; + +// se_KPISparklineOptions omitted. + +/** + * serializeAws_restJson1KPIVisual + */ +const se_KPIVisual = (input: KPIVisual, context: __SerdeContext): any => { + return take(input, { + Actions: (_) => se_VisualCustomActionList(_, context), + ChartConfiguration: (_) => se_KPIConfiguration(_, context), + ColumnHierarchies: (_) => se_ColumnHierarchyList(_, context), + ConditionalFormatting: (_) => se_KPIConditionalFormatting(_, context), + Subtitle: _json, + Title: _json, + VisualContentAltText: [], + VisualId: [], + }); +}; + +// se_KPIVisualLayoutOptions omitted. + +// se_KPIVisualStandardLayout omitted. + +// se_LabelOptions omitted. + +/** + * serializeAws_restJson1LayerCustomAction + */ +const se_LayerCustomAction = (input: LayerCustomAction, context: __SerdeContext): any => { + return take(input, { + ActionOperations: (_) => se_LayerCustomActionOperationList(_, context), + CustomActionId: [], + Name: [], + Status: [], + Trigger: [], + }); +}; + +/** + * serializeAws_restJson1LayerCustomActionList */ -const se_KPIProgressBarConditionalFormatting = ( - input: KPIProgressBarConditionalFormatting, - context: __SerdeContext -): any => { - return take(input, { - ForegroundColor: (_) => se_ConditionalFormattingColor(_, context), - }); +const se_LayerCustomActionList = (input: LayerCustomAction[], context: __SerdeContext): any => { + return input + .filter((e: any) => e != null) + .map((entry) => { + return se_LayerCustomAction(entry, context); + }); }; /** - * serializeAws_restJson1KPISortConfiguration + * serializeAws_restJson1LayerCustomActionOperation */ -const se_KPISortConfiguration = (input: KPISortConfiguration, context: __SerdeContext): any => { +const se_LayerCustomActionOperation = (input: LayerCustomActionOperation, context: __SerdeContext): any => { return take(input, { - TrendGroupSort: (_) => se_FieldSortOptionsList(_, context), + FilterOperation: _json, + NavigationOperation: _json, + SetParametersOperation: (_) => se_CustomActionSetParametersOperation(_, context), + URLOperation: _json, }); }; -// se_KPISparklineOptions omitted. +/** + * serializeAws_restJson1LayerCustomActionOperationList + */ +const se_LayerCustomActionOperationList = (input: LayerCustomActionOperation[], context: __SerdeContext): any => { + return input + .filter((e: any) => e != null) + .map((entry) => { + return se_LayerCustomActionOperation(entry, context); + }); +}; /** - * serializeAws_restJson1KPIVisual + * serializeAws_restJson1LayerMapVisual */ -const se_KPIVisual = (input: KPIVisual, context: __SerdeContext): any => { +const se_LayerMapVisual = (input: LayerMapVisual, context: __SerdeContext): any => { return take(input, { - Actions: (_) => se_VisualCustomActionList(_, context), - ChartConfiguration: (_) => se_KPIConfiguration(_, context), - ColumnHierarchies: (_) => se_ColumnHierarchyList(_, context), - ConditionalFormatting: (_) => se_KPIConditionalFormatting(_, context), + ChartConfiguration: (_) => se_GeospatialLayerMapConfiguration(_, context), + DataSetIdentifier: [], Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; -// se_KPIVisualLayoutOptions omitted. - -// se_KPIVisualStandardLayout omitted. - -// se_LabelOptions omitted. - /** * serializeAws_restJson1Layout */ @@ -14277,6 +14898,7 @@ const se_LineChartVisual = (input: LineChartVisual, context: __SerdeContext): an ColumnHierarchies: (_) => se_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; @@ -14776,6 +15398,7 @@ const se_PieChartVisual = (input: PieChartVisual, context: __SerdeContext): any ColumnHierarchies: (_) => se_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; @@ -14961,12 +15584,88 @@ const se_PivotTableVisual = (input: PivotTableVisual, context: __SerdeContext): ConditionalFormatting: (_) => se_PivotTableConditionalFormatting(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; // se_PivotTotalOptions omitted. +/** + * serializeAws_restJson1PluginVisual + */ +const se_PluginVisual = (input: PluginVisual, context: __SerdeContext): any => { + return take(input, { + ChartConfiguration: (_) => se_PluginVisualConfiguration(_, context), + PluginArn: [], + Subtitle: _json, + Title: _json, + VisualContentAltText: [], + VisualId: [], + }); +}; + +/** + * serializeAws_restJson1PluginVisualConfiguration + */ +const se_PluginVisualConfiguration = (input: PluginVisualConfiguration, context: __SerdeContext): any => { + return take(input, { + FieldWells: (_) => se_PluginVisualFieldWells(_, context), + SortConfiguration: (_) => se_PluginVisualSortConfiguration(_, context), + VisualOptions: _json, + }); +}; + +/** + * serializeAws_restJson1PluginVisualFieldWell + */ +const se_PluginVisualFieldWell = (input: PluginVisualFieldWell, context: __SerdeContext): any => { + return take(input, { + AxisName: [], + Dimensions: _json, + Measures: (_) => se_MeasureFieldList(_, context), + Unaggregated: _json, + }); +}; + +/** + * serializeAws_restJson1PluginVisualFieldWells + */ +const se_PluginVisualFieldWells = (input: PluginVisualFieldWell[], context: __SerdeContext): any => { + return input + .filter((e: any) => e != null) + .map((entry) => { + return se_PluginVisualFieldWell(entry, context); + }); +}; + +// se_PluginVisualItemsLimitConfiguration omitted. + +// se_PluginVisualOptions omitted. + +// se_PluginVisualPropertiesList omitted. + +// se_PluginVisualProperty omitted. + +/** + * serializeAws_restJson1PluginVisualSortConfiguration + */ +const se_PluginVisualSortConfiguration = (input: PluginVisualSortConfiguration, context: __SerdeContext): any => { + return take(input, { + PluginVisualTableQuerySort: (_) => se_PluginVisualTableQuerySort(_, context), + }); +}; + +/** + * serializeAws_restJson1PluginVisualTableQuerySort + */ +const se_PluginVisualTableQuerySort = (input: PluginVisualTableQuerySort, context: __SerdeContext): any => { + return take(input, { + ItemsLimitConfiguration: _json, + RowSort: (_) => se_RowSortList(_, context), + }); +}; + // se_PostgreSqlParameters omitted. /** @@ -15079,6 +15778,7 @@ const se_RadarChartVisual = (input: RadarChartVisual, context: __SerdeContext): ColumnHierarchies: (_) => se_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; @@ -15318,6 +16018,7 @@ const se_SankeyDiagramVisual = (input: SankeyDiagramVisual, context: __SerdeCont ChartConfiguration: (_) => se_SankeyDiagramChartConfiguration(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; @@ -15395,6 +16096,7 @@ const se_ScatterPlotVisual = (input: ScatterPlotVisual, context: __SerdeContext) ColumnHierarchies: (_) => se_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; @@ -15536,6 +16238,7 @@ const se_SheetDefinition = (input: SheetDefinition, context: __SerdeContext): an ContentType: [], Description: [], FilterControls: (_) => se_FilterControlList(_, context), + Images: (_) => se_SheetImageList(_, context), Layouts: (_) => se_LayoutList(_, context), Name: [], ParameterControls: (_) => se_ParameterControlList(_, context), @@ -15564,6 +16267,42 @@ const se_SheetDefinitionList = (input: SheetDefinition[], context: __SerdeContex // se_SheetElementRenderingRuleList omitted. +/** + * serializeAws_restJson1SheetImage + */ +const se_SheetImage = (input: SheetImage, context: __SerdeContext): any => { + return take(input, { + Actions: (_) => se_ImageCustomActionList(_, context), + ImageContentAltText: [], + Interactions: _json, + Scaling: _json, + SheetImageId: [], + Source: _json, + Tooltip: _json, + }); +}; + +/** + * serializeAws_restJson1SheetImageList + */ +const se_SheetImageList = (input: SheetImage[], context: __SerdeContext): any => { + return input + .filter((e: any) => e != null) + .map((entry) => { + return se_SheetImage(entry, context); + }); +}; + +// se_SheetImageScalingConfiguration omitted. + +// se_SheetImageSource omitted. + +// se_SheetImageStaticFileSource omitted. + +// se_SheetImageTooltipConfiguration omitted. + +// se_SheetImageTooltipText omitted. + // se_SheetLayoutElementMaximizationOption omitted. // se_SheetStyle omitted. @@ -15637,6 +16376,8 @@ const se_SnapshotConfiguration = (input: SnapshotConfiguration, context: __Serde // se_SparkParameters omitted. +// se_SpatialStaticFile omitted. + // se_SqlServerParameters omitted. // se_SslProperties omitted. @@ -15645,6 +16386,16 @@ const se_SnapshotConfiguration = (input: SnapshotConfiguration, context: __Serde // se_StatePersistenceConfigurations omitted. +// se_StaticFile omitted. + +// se_StaticFileList omitted. + +// se_StaticFileS3SourceOptions omitted. + +// se_StaticFileSource omitted. + +// se_StaticFileUrlSourceOptions omitted. + // se_StringDatasetParameter omitted. // se_StringDatasetParameterDefaultValues omitted. @@ -15826,6 +16577,7 @@ const se_TableVisual = (input: TableVisual, context: __SerdeContext): any => { ConditionalFormatting: (_) => se_TableConditionalFormatting(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; @@ -15858,6 +16610,7 @@ const se_TemplateVersionDefinition = (input: TemplateVersionDefinition, context: ParameterDeclarations: (_) => se_ParameterDeclarationList(_, context), QueryExecutionOptions: _json, Sheets: (_) => se_SheetDefinitionList(_, context), + StaticFiles: _json, }); }; @@ -16105,6 +16858,10 @@ const se_TopicRefreshSchedule = (input: TopicRefreshSchedule, context: __SerdeCo // se_TopicRelativeDateFilter omitted. +// se_TopicSearchFilter omitted. + +// se_TopicSearchFilterList omitted. + // se_TopicSingularFilterConstant omitted. // se_TopicSortClause omitted. @@ -16254,6 +17011,7 @@ const se_TreeMapVisual = (input: TreeMapVisual, context: __SerdeContext): any => ColumnHierarchies: (_) => se_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; @@ -16313,9 +17071,11 @@ const se_Visual = (input: Visual, context: __SerdeContext): any => { HistogramVisual: (_) => se_HistogramVisual(_, context), InsightVisual: (_) => se_InsightVisual(_, context), KPIVisual: (_) => se_KPIVisual(_, context), + LayerMapVisual: (_) => se_LayerMapVisual(_, context), LineChartVisual: (_) => se_LineChartVisual(_, context), PieChartVisual: (_) => se_PieChartVisual(_, context), PivotTableVisual: (_) => se_PivotTableVisual(_, context), + PluginVisual: (_) => se_PluginVisual(_, context), RadarChartVisual: (_) => se_RadarChartVisual(_, context), SankeyDiagramVisual: (_) => se_SankeyDiagramVisual(_, context), ScatterPlotVisual: (_) => se_ScatterPlotVisual(_, context), @@ -16473,6 +17233,7 @@ const se_WaterfallVisual = (input: WaterfallVisual, context: __SerdeContext): an ColumnHierarchies: (_) => se_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; @@ -16565,6 +17326,7 @@ const se_WordCloudVisual = (input: WordCloudVisual, context: __SerdeContext): an ColumnHierarchies: (_) => se_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: [], VisualId: [], }); }; @@ -16648,7 +17410,7 @@ const de_Analysis = (output: any, context: __SerdeContext): Analysis => { Errors: _json, LastUpdatedTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), Name: __expectString, - Sheets: _json, + Sheets: (_: any) => de_SheetList(_, context), Status: __expectString, ThemeArn: __expectString, }) as any; @@ -16670,6 +17432,7 @@ const de_AnalysisDefinition = (output: any, context: __SerdeContext): AnalysisDe ParameterDeclarations: (_: any) => de_ParameterDeclarationList(_, context), QueryExecutionOptions: _json, Sheets: (_: any) => de_SheetDefinitionList(_, context), + StaticFiles: _json, }) as any; }; @@ -17202,6 +17965,7 @@ const de_BarChartVisual = (output: any, context: __SerdeContext): BarChartVisual ColumnHierarchies: (_: any) => de_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -17407,6 +18171,7 @@ const de_BoxPlotVisual = (output: any, context: __SerdeContext): BoxPlotVisual = ColumnHierarchies: (_: any) => de_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -17713,6 +18478,7 @@ const de_ComboChartVisual = (output: any, context: __SerdeContext): ComboChartVi ColumnHierarchies: (_: any) => de_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -17842,6 +18608,7 @@ const de_CustomContentVisual = (output: any, context: __SerdeContext): CustomCon DataSetIdentifier: __expectString, Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -17939,7 +18706,7 @@ const de_DashboardVersion = (output: any, context: __SerdeContext): DashboardVer DataSetArns: _json, Description: __expectString, Errors: _json, - Sheets: _json, + Sheets: (_: any) => de_SheetList(_, context), SourceEntityArn: __expectString, Status: __expectString, ThemeArn: __expectString, @@ -17960,6 +18727,7 @@ const de_DashboardVersionDefinition = (output: any, context: __SerdeContext): Da Options: _json, ParameterDeclarations: (_: any) => de_ParameterDeclarationList(_, context), Sheets: (_: any) => de_SheetDefinitionList(_, context), + StaticFiles: _json, }) as any; }; @@ -18770,6 +19538,7 @@ const de_FilledMapVisual = (output: any, context: __SerdeContext): FilledMapVisu ConditionalFormatting: (_: any) => de_FilledMapConditionalFormatting(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -19106,6 +19875,7 @@ const de_FunnelChartVisual = (output: any, context: __SerdeContext): FunnelChart ColumnHierarchies: (_: any) => de_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -19222,32 +19992,230 @@ const de_GaugeChartVisual = (output: any, context: __SerdeContext): GaugeChartVi ConditionalFormatting: (_: any) => de_GaugeChartConditionalFormatting(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; -// de_GeoSpatialColumnGroup omitted. - /** - * deserializeAws_restJson1GeospatialCoordinateBounds + * deserializeAws_restJson1GeospatialCategoricalColor + */ +const de_GeospatialCategoricalColor = (output: any, context: __SerdeContext): GeospatialCategoricalColor => { + return take(output, { + CategoryDataColors: _json, + DefaultOpacity: __limitedParseDouble, + NullDataSettings: (_: any) => de_GeospatialNullDataSettings(_, context), + NullDataVisibility: __expectString, + }) as any; +}; + +// de_GeospatialCategoricalDataColor omitted. + +// de_GeospatialCategoricalDataColorList omitted. + +/** + * deserializeAws_restJson1GeospatialCircleRadius + */ +const de_GeospatialCircleRadius = (output: any, context: __SerdeContext): GeospatialCircleRadius => { + return take(output, { + Radius: __limitedParseDouble, + }) as any; +}; + +/** + * deserializeAws_restJson1GeospatialCircleSymbolStyle + */ +const de_GeospatialCircleSymbolStyle = (output: any, context: __SerdeContext): GeospatialCircleSymbolStyle => { + return take(output, { + CircleRadius: (_: any) => de_GeospatialCircleRadius(_, context), + FillColor: (_: any) => de_GeospatialColor(_, context), + StrokeColor: (_: any) => de_GeospatialColor(_, context), + StrokeWidth: (_: any) => de_GeospatialLineWidth(_, context), + }) as any; +}; + +/** + * deserializeAws_restJson1GeospatialColor + */ +const de_GeospatialColor = (output: any, context: __SerdeContext): GeospatialColor => { + return take(output, { + Categorical: (_: any) => de_GeospatialCategoricalColor(_, context), + Gradient: (_: any) => de_GeospatialGradientColor(_, context), + Solid: _json, + }) as any; +}; + +// de_GeoSpatialColumnGroup omitted. + +/** + * deserializeAws_restJson1GeospatialCoordinateBounds + */ +const de_GeospatialCoordinateBounds = (output: any, context: __SerdeContext): GeospatialCoordinateBounds => { + return take(output, { + East: __limitedParseDouble, + North: __limitedParseDouble, + South: __limitedParseDouble, + West: __limitedParseDouble, + }) as any; +}; + +// de_GeospatialDataSourceItem omitted. + +/** + * deserializeAws_restJson1GeospatialGradientColor + */ +const de_GeospatialGradientColor = (output: any, context: __SerdeContext): GeospatialGradientColor => { + return take(output, { + DefaultOpacity: __limitedParseDouble, + NullDataSettings: (_: any) => de_GeospatialNullDataSettings(_, context), + NullDataVisibility: __expectString, + StepColors: (_: any) => de_GeospatialGradientStepColorList(_, context), + }) as any; +}; + +/** + * deserializeAws_restJson1GeospatialGradientStepColor + */ +const de_GeospatialGradientStepColor = (output: any, context: __SerdeContext): GeospatialGradientStepColor => { + return take(output, { + Color: __expectString, + DataValue: __limitedParseDouble, + }) as any; +}; + +/** + * deserializeAws_restJson1GeospatialGradientStepColorList + */ +const de_GeospatialGradientStepColorList = (output: any, context: __SerdeContext): GeospatialGradientStepColor[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_GeospatialGradientStepColor(entry, context); + }); + return retVal; +}; + +// de_GeospatialHeatmapColorScale omitted. + +// de_GeospatialHeatmapConfiguration omitted. + +// de_GeospatialHeatmapDataColor omitted. + +// de_GeospatialHeatmapDataColorList omitted. + +/** + * deserializeAws_restJson1GeospatialLayerColorField + */ +const de_GeospatialLayerColorField = (output: any, context: __SerdeContext): GeospatialLayerColorField => { + return take(output, { + ColorDimensionsFields: _json, + ColorValuesFields: (_: any) => de_GeospatialLayerMeasureFieldList(_, context), + }) as any; +}; + +/** + * deserializeAws_restJson1GeospatialLayerDefinition + */ +const de_GeospatialLayerDefinition = (output: any, context: __SerdeContext): GeospatialLayerDefinition => { + return take(output, { + LineLayer: (_: any) => de_GeospatialLineLayer(_, context), + PointLayer: (_: any) => de_GeospatialPointLayer(_, context), + PolygonLayer: (_: any) => de_GeospatialPolygonLayer(_, context), + }) as any; +}; + +// de_GeospatialLayerDimensionFieldList omitted. + +/** + * deserializeAws_restJson1GeospatialLayerItem + */ +const de_GeospatialLayerItem = (output: any, context: __SerdeContext): GeospatialLayerItem => { + return take(output, { + Actions: (_: any) => de_LayerCustomActionList(_, context), + DataSource: _json, + JoinDefinition: (_: any) => de_GeospatialLayerJoinDefinition(_, context), + Label: __expectString, + LayerDefinition: (_: any) => de_GeospatialLayerDefinition(_, context), + LayerId: __expectString, + LayerType: __expectString, + Tooltip: (_: any) => de_TooltipOptions(_, context), + Visibility: __expectString, + }) as any; +}; + +/** + * deserializeAws_restJson1GeospatialLayerJoinDefinition + */ +const de_GeospatialLayerJoinDefinition = (output: any, context: __SerdeContext): GeospatialLayerJoinDefinition => { + return take(output, { + ColorField: (_: any) => de_GeospatialLayerColorField(_, context), + DatasetKeyField: _json, + ShapeKeyField: __expectString, + }) as any; +}; + +/** + * deserializeAws_restJson1GeospatialLayerMapConfiguration + */ +const de_GeospatialLayerMapConfiguration = (output: any, context: __SerdeContext): GeospatialLayerMapConfiguration => { + return take(output, { + Interactions: _json, + Legend: _json, + MapLayers: (_: any) => de_GeospatialMapLayerList(_, context), + MapState: (_: any) => de_GeospatialMapState(_, context), + MapStyle: _json, + }) as any; +}; + +/** + * deserializeAws_restJson1GeospatialLayerMeasureFieldList + */ +const de_GeospatialLayerMeasureFieldList = (output: any, context: __SerdeContext): MeasureField[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_MeasureField(entry, context); + }); + return retVal; +}; + +/** + * deserializeAws_restJson1GeospatialLineLayer + */ +const de_GeospatialLineLayer = (output: any, context: __SerdeContext): GeospatialLineLayer => { + return take(output, { + Style: (_: any) => de_GeospatialLineStyle(_, context), + }) as any; +}; + +/** + * deserializeAws_restJson1GeospatialLineStyle + */ +const de_GeospatialLineStyle = (output: any, context: __SerdeContext): GeospatialLineStyle => { + return take(output, { + LineSymbolStyle: (_: any) => de_GeospatialLineSymbolStyle(_, context), + }) as any; +}; + +/** + * deserializeAws_restJson1GeospatialLineSymbolStyle + */ +const de_GeospatialLineSymbolStyle = (output: any, context: __SerdeContext): GeospatialLineSymbolStyle => { + return take(output, { + FillColor: (_: any) => de_GeospatialColor(_, context), + LineWidth: (_: any) => de_GeospatialLineWidth(_, context), + }) as any; +}; + +/** + * deserializeAws_restJson1GeospatialLineWidth */ -const de_GeospatialCoordinateBounds = (output: any, context: __SerdeContext): GeospatialCoordinateBounds => { +const de_GeospatialLineWidth = (output: any, context: __SerdeContext): GeospatialLineWidth => { return take(output, { - East: __limitedParseDouble, - North: __limitedParseDouble, - South: __limitedParseDouble, - West: __limitedParseDouble, + LineWidth: __limitedParseDouble, }) as any; }; -// de_GeospatialHeatmapColorScale omitted. - -// de_GeospatialHeatmapConfiguration omitted. - -// de_GeospatialHeatmapDataColor omitted. - -// de_GeospatialHeatmapDataColorList omitted. - /** * deserializeAws_restJson1GeospatialMapAggregatedFieldWells */ @@ -19287,6 +20255,30 @@ const de_GeospatialMapFieldWells = (output: any, context: __SerdeContext): Geosp }) as any; }; +/** + * deserializeAws_restJson1GeospatialMapLayerList + */ +const de_GeospatialMapLayerList = (output: any, context: __SerdeContext): GeospatialLayerItem[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_GeospatialLayerItem(entry, context); + }); + return retVal; +}; + +/** + * deserializeAws_restJson1GeospatialMapState + */ +const de_GeospatialMapState = (output: any, context: __SerdeContext): GeospatialMapState => { + return take(output, { + Bounds: (_: any) => de_GeospatialCoordinateBounds(_, context), + MapNavigation: __expectString, + }) as any; +}; + +// de_GeospatialMapStyle omitted. + // de_GeospatialMapStyleOptions omitted. /** @@ -19299,12 +20291,84 @@ const de_GeospatialMapVisual = (output: any, context: __SerdeContext): Geospatia ColumnHierarchies: (_: any) => de_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; +/** + * deserializeAws_restJson1GeospatialNullDataSettings + */ +const de_GeospatialNullDataSettings = (output: any, context: __SerdeContext): GeospatialNullDataSettings => { + return take(output, { + SymbolStyle: (_: any) => de_GeospatialNullSymbolStyle(_, context), + }) as any; +}; + +/** + * deserializeAws_restJson1GeospatialNullSymbolStyle + */ +const de_GeospatialNullSymbolStyle = (output: any, context: __SerdeContext): GeospatialNullSymbolStyle => { + return take(output, { + FillColor: __expectString, + StrokeColor: __expectString, + StrokeWidth: __limitedParseDouble, + }) as any; +}; + +/** + * deserializeAws_restJson1GeospatialPointLayer + */ +const de_GeospatialPointLayer = (output: any, context: __SerdeContext): GeospatialPointLayer => { + return take(output, { + Style: (_: any) => de_GeospatialPointStyle(_, context), + }) as any; +}; + +/** + * deserializeAws_restJson1GeospatialPointStyle + */ +const de_GeospatialPointStyle = (output: any, context: __SerdeContext): GeospatialPointStyle => { + return take(output, { + CircleSymbolStyle: (_: any) => de_GeospatialCircleSymbolStyle(_, context), + }) as any; +}; + // de_GeospatialPointStyleOptions omitted. +/** + * deserializeAws_restJson1GeospatialPolygonLayer + */ +const de_GeospatialPolygonLayer = (output: any, context: __SerdeContext): GeospatialPolygonLayer => { + return take(output, { + Style: (_: any) => de_GeospatialPolygonStyle(_, context), + }) as any; +}; + +/** + * deserializeAws_restJson1GeospatialPolygonStyle + */ +const de_GeospatialPolygonStyle = (output: any, context: __SerdeContext): GeospatialPolygonStyle => { + return take(output, { + PolygonSymbolStyle: (_: any) => de_GeospatialPolygonSymbolStyle(_, context), + }) as any; +}; + +/** + * deserializeAws_restJson1GeospatialPolygonSymbolStyle + */ +const de_GeospatialPolygonSymbolStyle = (output: any, context: __SerdeContext): GeospatialPolygonSymbolStyle => { + return take(output, { + FillColor: (_: any) => de_GeospatialColor(_, context), + StrokeColor: (_: any) => de_GeospatialColor(_, context), + StrokeWidth: (_: any) => de_GeospatialLineWidth(_, context), + }) as any; +}; + +// de_GeospatialSolidColor omitted. + +// de_GeospatialStaticFileSource omitted. + /** * deserializeAws_restJson1GeospatialWindowOptions */ @@ -19461,6 +20525,7 @@ const de_HeatMapVisual = (output: any, context: __SerdeContext): HeatMapVisual = ColumnHierarchies: (_: any) => de_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -19533,6 +20598,7 @@ const de_HistogramVisual = (output: any, context: __SerdeContext): HistogramVisu ChartConfiguration: (_: any) => de_HistogramConfiguration(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -19555,12 +20621,66 @@ const de_HistogramVisual = (output: any, context: __SerdeContext): HistogramVisu // de_ImageConfiguration omitted. +/** + * deserializeAws_restJson1ImageCustomAction + */ +const de_ImageCustomAction = (output: any, context: __SerdeContext): ImageCustomAction => { + return take(output, { + ActionOperations: (_: any) => de_ImageCustomActionOperationList(_, context), + CustomActionId: __expectString, + Name: __expectString, + Status: __expectString, + Trigger: __expectString, + }) as any; +}; + +/** + * deserializeAws_restJson1ImageCustomActionList + */ +const de_ImageCustomActionList = (output: any, context: __SerdeContext): ImageCustomAction[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_ImageCustomAction(entry, context); + }); + return retVal; +}; + +/** + * deserializeAws_restJson1ImageCustomActionOperation + */ +const de_ImageCustomActionOperation = (output: any, context: __SerdeContext): ImageCustomActionOperation => { + return take(output, { + NavigationOperation: _json, + SetParametersOperation: (_: any) => de_CustomActionSetParametersOperation(_, context), + URLOperation: _json, + }) as any; +}; + +/** + * deserializeAws_restJson1ImageCustomActionOperationList + */ +const de_ImageCustomActionOperationList = (output: any, context: __SerdeContext): ImageCustomActionOperation[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_ImageCustomActionOperation(entry, context); + }); + return retVal; +}; + +// de_ImageInteractionOptions omitted. + +// de_ImageMenuOption omitted. + // de_ImageSet omitted. // de_ImageSetConfiguration omitted. // de_ImageSource omitted. +// de_ImageStaticFile omitted. + // de_IncrementalRefresh omitted. /** @@ -19628,6 +20748,7 @@ const de_InsightVisual = (output: any, context: __SerdeContext): InsightVisual = InsightConfiguration: (_: any) => de_InsightConfiguration(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -19800,6 +20921,7 @@ const de_KPIVisual = (output: any, context: __SerdeContext): KPIVisual => { ConditionalFormatting: (_: any) => de_KPIConditionalFormatting(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -19810,6 +20932,69 @@ const de_KPIVisual = (output: any, context: __SerdeContext): KPIVisual => { // de_LabelOptions omitted. +/** + * deserializeAws_restJson1LayerCustomAction + */ +const de_LayerCustomAction = (output: any, context: __SerdeContext): LayerCustomAction => { + return take(output, { + ActionOperations: (_: any) => de_LayerCustomActionOperationList(_, context), + CustomActionId: __expectString, + Name: __expectString, + Status: __expectString, + Trigger: __expectString, + }) as any; +}; + +/** + * deserializeAws_restJson1LayerCustomActionList + */ +const de_LayerCustomActionList = (output: any, context: __SerdeContext): LayerCustomAction[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_LayerCustomAction(entry, context); + }); + return retVal; +}; + +/** + * deserializeAws_restJson1LayerCustomActionOperation + */ +const de_LayerCustomActionOperation = (output: any, context: __SerdeContext): LayerCustomActionOperation => { + return take(output, { + FilterOperation: _json, + NavigationOperation: _json, + SetParametersOperation: (_: any) => de_CustomActionSetParametersOperation(_, context), + URLOperation: _json, + }) as any; +}; + +/** + * deserializeAws_restJson1LayerCustomActionOperationList + */ +const de_LayerCustomActionOperationList = (output: any, context: __SerdeContext): LayerCustomActionOperation[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_LayerCustomActionOperation(entry, context); + }); + return retVal; +}; + +/** + * deserializeAws_restJson1LayerMapVisual + */ +const de_LayerMapVisual = (output: any, context: __SerdeContext): LayerMapVisual => { + return take(output, { + ChartConfiguration: (_: any) => de_GeospatialLayerMapConfiguration(_, context), + DataSetIdentifier: __expectString, + Subtitle: _json, + Title: _json, + VisualContentAltText: __expectString, + VisualId: __expectString, + }) as any; +}; + /** * deserializeAws_restJson1Layout */ @@ -19925,6 +21110,7 @@ const de_LineChartVisual = (output: any, context: __SerdeContext): LineChartVisu ColumnHierarchies: (_: any) => de_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -20449,6 +21635,7 @@ const de_PieChartVisual = (output: any, context: __SerdeContext): PieChartVisual ColumnHierarchies: (_: any) => de_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -20637,12 +21824,89 @@ const de_PivotTableVisual = (output: any, context: __SerdeContext): PivotTableVi ConditionalFormatting: (_: any) => de_PivotTableConditionalFormatting(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; // de_PivotTotalOptions omitted. +/** + * deserializeAws_restJson1PluginVisual + */ +const de_PluginVisual = (output: any, context: __SerdeContext): PluginVisual => { + return take(output, { + ChartConfiguration: (_: any) => de_PluginVisualConfiguration(_, context), + PluginArn: __expectString, + Subtitle: _json, + Title: _json, + VisualContentAltText: __expectString, + VisualId: __expectString, + }) as any; +}; + +/** + * deserializeAws_restJson1PluginVisualConfiguration + */ +const de_PluginVisualConfiguration = (output: any, context: __SerdeContext): PluginVisualConfiguration => { + return take(output, { + FieldWells: (_: any) => de_PluginVisualFieldWells(_, context), + SortConfiguration: (_: any) => de_PluginVisualSortConfiguration(_, context), + VisualOptions: _json, + }) as any; +}; + +/** + * deserializeAws_restJson1PluginVisualFieldWell + */ +const de_PluginVisualFieldWell = (output: any, context: __SerdeContext): PluginVisualFieldWell => { + return take(output, { + AxisName: __expectString, + Dimensions: _json, + Measures: (_: any) => de_MeasureFieldList(_, context), + Unaggregated: _json, + }) as any; +}; + +/** + * deserializeAws_restJson1PluginVisualFieldWells + */ +const de_PluginVisualFieldWells = (output: any, context: __SerdeContext): PluginVisualFieldWell[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_PluginVisualFieldWell(entry, context); + }); + return retVal; +}; + +// de_PluginVisualItemsLimitConfiguration omitted. + +// de_PluginVisualOptions omitted. + +// de_PluginVisualPropertiesList omitted. + +// de_PluginVisualProperty omitted. + +/** + * deserializeAws_restJson1PluginVisualSortConfiguration + */ +const de_PluginVisualSortConfiguration = (output: any, context: __SerdeContext): PluginVisualSortConfiguration => { + return take(output, { + PluginVisualTableQuerySort: (_: any) => de_PluginVisualTableQuerySort(_, context), + }) as any; +}; + +/** + * deserializeAws_restJson1PluginVisualTableQuerySort + */ +const de_PluginVisualTableQuerySort = (output: any, context: __SerdeContext): PluginVisualTableQuerySort => { + return take(output, { + ItemsLimitConfiguration: _json, + RowSort: (_: any) => de_RowSortList(_, context), + }) as any; +}; + // de_PostgreSqlParameters omitted. /** @@ -20758,6 +22022,7 @@ const de_RadarChartVisual = (output: any, context: __SerdeContext): RadarChartVi ColumnHierarchies: (_: any) => de_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -20997,6 +22262,7 @@ const de_SankeyDiagramVisual = (output: any, context: __SerdeContext): SankeyDia ChartConfiguration: (_: any) => de_SankeyDiagramChartConfiguration(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -21075,6 +22341,7 @@ const de_ScatterPlotVisual = (output: any, context: __SerdeContext): ScatterPlot ColumnHierarchies: (_: any) => de_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -21197,7 +22464,16 @@ const de_ShapeConditionalFormat = (output: any, context: __SerdeContext): ShapeC }) as any; }; -// de_Sheet omitted. +/** + * deserializeAws_restJson1Sheet + */ +const de_Sheet = (output: any, context: __SerdeContext): Sheet => { + return take(output, { + Images: (_: any) => de_SheetImageList(_, context), + Name: __expectString, + SheetId: __expectString, + }) as any; +}; // de_SheetControlInfoIconLabelOptions omitted. @@ -21217,6 +22493,7 @@ const de_SheetDefinition = (output: any, context: __SerdeContext): SheetDefiniti ContentType: __expectString, Description: __expectString, FilterControls: (_: any) => de_FilterControlList(_, context), + Images: (_: any) => de_SheetImageList(_, context), Layouts: (_: any) => de_LayoutList(_, context), Name: __expectString, ParameterControls: (_: any) => de_ParameterControlList(_, context), @@ -21246,9 +22523,56 @@ const de_SheetDefinitionList = (output: any, context: __SerdeContext): SheetDefi // de_SheetElementRenderingRuleList omitted. +/** + * deserializeAws_restJson1SheetImage + */ +const de_SheetImage = (output: any, context: __SerdeContext): SheetImage => { + return take(output, { + Actions: (_: any) => de_ImageCustomActionList(_, context), + ImageContentAltText: __expectString, + Interactions: _json, + Scaling: _json, + SheetImageId: __expectString, + Source: _json, + Tooltip: _json, + }) as any; +}; + +/** + * deserializeAws_restJson1SheetImageList + */ +const de_SheetImageList = (output: any, context: __SerdeContext): SheetImage[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_SheetImage(entry, context); + }); + return retVal; +}; + +// de_SheetImageScalingConfiguration omitted. + +// de_SheetImageSource omitted. + +// de_SheetImageStaticFileSource omitted. + +// de_SheetImageTooltipConfiguration omitted. + +// de_SheetImageTooltipText omitted. + // de_SheetLayoutElementMaximizationOption omitted. -// de_SheetList omitted. +/** + * deserializeAws_restJson1SheetList + */ +const de_SheetList = (output: any, context: __SerdeContext): Sheet[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_Sheet(entry, context); + }); + return retVal; +}; // de_SheetStyle omitted. @@ -21339,12 +22663,24 @@ const de_SnapshotConfiguration = (output: any, context: __SerdeContext): Snapsho // de_SparkParameters omitted. +// de_SpatialStaticFile omitted. + // de_SqlServerParameters omitted. // de_SslProperties omitted. // de_StarburstParameters omitted. +// de_StaticFile omitted. + +// de_StaticFileList omitted. + +// de_StaticFileS3SourceOptions omitted. + +// de_StaticFileSource omitted. + +// de_StaticFileUrlSourceOptions omitted. + // de_StringDatasetParameter omitted. // de_StringDatasetParameterDefaultValues omitted. @@ -21538,6 +22874,7 @@ const de_TableVisual = (output: any, context: __SerdeContext): TableVisual => { ConditionalFormatting: (_: any) => de_TableConditionalFormatting(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -21607,7 +22944,7 @@ const de_TemplateVersion = (output: any, context: __SerdeContext): TemplateVersi DataSetConfigurations: _json, Description: __expectString, Errors: _json, - Sheets: _json, + Sheets: (_: any) => de_SheetList(_, context), SourceEntityArn: __expectString, Status: __expectString, ThemeArn: __expectString, @@ -21629,6 +22966,7 @@ const de_TemplateVersionDefinition = (output: any, context: __SerdeContext): Tem ParameterDeclarations: (_: any) => de_ParameterDeclarationList(_, context), QueryExecutionOptions: _json, Sheets: (_: any) => de_SheetDefinitionList(_, context), + StaticFiles: _json, }) as any; }; @@ -22232,6 +23570,7 @@ const de_TreeMapVisual = (output: any, context: __SerdeContext): TreeMapVisual = ColumnHierarchies: (_: any) => de_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -22291,9 +23630,11 @@ const de_Visual = (output: any, context: __SerdeContext): Visual => { HistogramVisual: (_: any) => de_HistogramVisual(_, context), InsightVisual: (_: any) => de_InsightVisual(_, context), KPIVisual: (_: any) => de_KPIVisual(_, context), + LayerMapVisual: (_: any) => de_LayerMapVisual(_, context), LineChartVisual: (_: any) => de_LineChartVisual(_, context), PieChartVisual: (_: any) => de_PieChartVisual(_, context), PivotTableVisual: (_: any) => de_PivotTableVisual(_, context), + PluginVisual: (_: any) => de_PluginVisual(_, context), RadarChartVisual: (_: any) => de_RadarChartVisual(_, context), SankeyDiagramVisual: (_: any) => de_SankeyDiagramVisual(_, context), ScatterPlotVisual: (_: any) => de_ScatterPlotVisual(_, context), @@ -22506,6 +23847,7 @@ const de_WaterfallVisual = (output: any, context: __SerdeContext): WaterfallVisu ColumnHierarchies: (_: any) => de_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; @@ -22599,6 +23941,7 @@ const de_WordCloudVisual = (output: any, context: __SerdeContext): WordCloudVisu ColumnHierarchies: (_: any) => de_ColumnHierarchyList(_, context), Subtitle: _json, Title: _json, + VisualContentAltText: __expectString, VisualId: __expectString, }) as any; }; diff --git a/codegen/sdk-codegen/aws-models/quicksight.json b/codegen/sdk-codegen/aws-models/quicksight.json index 5770d4245966..c65fee4218cd 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.json +++ b/codegen/sdk-codegen/aws-models/quicksight.json @@ -720,6 +720,12 @@ }, "QueryExecutionOptions": { "target": "com.amazonaws.quicksight#QueryExecutionOptions" + }, + "StaticFiles": { + "target": "com.amazonaws.quicksight#StaticFileList", + "traits": { + "smithy.api#documentation": "

The static files for the definition.

" + } } }, "traits": { @@ -3442,13 +3448,13 @@ "Body": { "target": "com.amazonaws.quicksight#AssetBundleImportBodyBlob", "traits": { - "smithy.api#documentation": "

The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.

\n

If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or\n PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using\n an SDK for a different language or receiving related errors, try to base64 encode your data.

" + "smithy.api#documentation": "

The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB. If the size of the file that you want to upload is more than 20 MB, add the file to your Amazon S3 bucket and use S3Uri of the file for this operation.

\n

If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using an SDK for a different language or receiving related errors, try to base64 encode your data.

" } }, "S3Uri": { "target": "com.amazonaws.quicksight#S3Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller\n has read access to. The file must be a zip format file and can't exceed 20 MB.

" + "smithy.api#documentation": "

The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read access to. The file must be a zip format file and can't exceed 1 GB.

" } } }, @@ -4417,6 +4423,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -5278,6 +5290,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -7323,6 +7341,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -11139,6 +11163,12 @@ "traits": { "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags that are assigned to\n the dataset.

" } + }, + "FolderArns": { + "target": "com.amazonaws.quicksight#FolderArnList", + "traits": { + "smithy.api#documentation": "

The Folder ARN of the folder that you want the topic to reside in.

" + } } }, "traits": { @@ -11745,6 +11775,12 @@ "smithy.api#documentation": "

The dataset that is used to create the custom content visual. You can't create a visual without a dataset.

", "smithy.api#required": {} } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -12584,6 +12620,12 @@ "traits": { "smithy.api#documentation": "

An array of option definitions for a dashboard.

" } + }, + "StaticFiles": { + "target": "com.amazonaws.quicksight#StaticFileList", + "traits": { + "smithy.api#documentation": "

The static files for the definition.

" + } } }, "traits": { @@ -12689,6 +12731,23 @@ "smithy.api#documentation": "

The visual publish options of a visual in a dashboard

" } }, + "com.amazonaws.quicksight#DashboardsQAStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.quicksight#DataAggregation": { "type": "structure", "members": { @@ -20556,149 +20615,20 @@ "smithy.api#output": {} } }, - "com.amazonaws.quicksight#DescribeDataSet": { + "com.amazonaws.quicksight#DescribeDashboardsQAConfiguration": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#DescribeDataSetRequest" + "target": "com.amazonaws.quicksight#DescribeDashboardsQAConfigurationRequest" }, "output": { - "target": "com.amazonaws.quicksight#DescribeDataSetResponse" + "target": "com.amazonaws.quicksight#DescribeDashboardsQAConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.quicksight#AccessDeniedException" }, { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDataSetPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the permissions on a dataset.

\n

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse": { - "type": "structure", - "members": { - "DataSetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions on the dataset.

" - } - }, - "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#DescribeDataSetRefreshProperties": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" + "target": "com.amazonaws.quicksight#ConflictException" }, { "target": "com.amazonaws.quicksight#InternalFailureException" @@ -20706,12 +20636,6 @@ { "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, { "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, @@ -20720,81 +20644,21 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the refresh properties of a dataset.

", + "smithy.api#documentation": "

Describes an existing dashboard QA configuration.

", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", + "uri": "/accounts/{AwsAccountId}/dashboards-qa-configuration", "code": 200 } } }, - "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse": { - "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": {} - } - }, - "DataSetRefreshProperties": { - "target": "com.amazonaws.quicksight#DataSetRefreshProperties", - "traits": { - "smithy.api#documentation": "

The dataset refresh properties.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSetRequest": { + "com.amazonaws.quicksight#DescribeDashboardsQAConfigurationRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

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.

", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard QA configuration that you want described.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -20804,13 +20668,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.quicksight#DescribeDataSetResponse": { + "com.amazonaws.quicksight#DescribeDashboardsQAConfigurationResponse": { "type": "structure", "members": { - "DataSet": { - "target": "com.amazonaws.quicksight#DataSet", + "DashboardsQAStatus": { + "target": "com.amazonaws.quicksight#DashboardsQAStatus", "traits": { - "smithy.api#documentation": "

Information on the dataset.

" + "smithy.api#documentation": "

The status of dashboards QA configuration that you want described.

" } }, "RequestId": { @@ -20832,13 +20696,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.quicksight#DescribeDataSource": { + "com.amazonaws.quicksight#DescribeDataSet": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#DescribeDataSourceRequest" + "target": "com.amazonaws.quicksight#DescribeDataSetRequest" }, "output": { - "target": "com.amazonaws.quicksight#DescribeDataSourceResponse" + "target": "com.amazonaws.quicksight#DescribeDataSetResponse" }, "errors": [ { @@ -20858,21 +20722,21 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a data source.

", + "smithy.api#documentation": "

Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.

", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", "code": 200 } } }, - "com.amazonaws.quicksight#DescribeDataSourcePermissions": { + "com.amazonaws.quicksight#DescribeDataSetPermissions": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest" + "target": "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest" }, "output": { - "target": "com.amazonaws.quicksight#DescribeDataSourcePermissionsResponse" + "target": "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse" }, "errors": [ { @@ -20892,15 +20756,15 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the resource permissions for a data source.

", + "smithy.api#documentation": "

Describes the permissions on a dataset.

\n

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions", "code": 200 } } }, - "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest": { + "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest": { "type": "structure", "members": { "AwsAccountId": { @@ -20911,10 +20775,10 @@ "smithy.api#required": {} } }, - "DataSourceId": { + "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#documentation": "

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.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -20924,25 +20788,301 @@ "smithy.api#input": {} } }, - "com.amazonaws.quicksight#DescribeDataSourcePermissionsResponse": { + "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse": { "type": "structure", "members": { - "DataSourceArn": { + "DataSetArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" } }, - "DataSourceId": { + "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + "smithy.api#documentation": "

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.

" } }, "Permissions": { "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "

A list of resource permissions on the data source.

" + "smithy.api#documentation": "

A list of resource permissions on the dataset.

" + } + }, + "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#DescribeDataSetRefreshProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the refresh properties of a dataset.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse": { + "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": {} + } + }, + "DataSetRefreshProperties": { + "target": "com.amazonaws.quicksight#DataSetRefreshProperties", + "traits": { + "smithy.api#documentation": "

The dataset refresh properties.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetResponse": { + "type": "structure", + "members": { + "DataSet": { + "target": "com.amazonaws.quicksight#DataSet", + "traits": { + "smithy.api#documentation": "

Information on the dataset.

" + } + }, + "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#DescribeDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a data source.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSourcePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSourcePermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the resource permissions for a data source.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSourcePermissionsResponse": { + "type": "structure", + "members": { + "DataSourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions on the data source.

" } }, "RequestId": { @@ -24969,6 +25109,12 @@ "traits": { "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -26129,6 +26275,12 @@ "traits": { "smithy.api#documentation": "

Determines the text display face that is inherited by the given font family.

" } + }, + "FontFamily": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The font family that you want to use.

" + } } }, "traits": { @@ -26172,6 +26324,12 @@ "traits": { "smithy.api#documentation": "

The lexical name for the text size, proportional to its surrounding context.

" } + }, + "Absolute": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The font size that you want to use in px.

" + } } }, "traits": { @@ -26865,6 +27023,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -27118,6 +27282,12 @@ "traits": { "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -27465,6 +27635,156 @@ } } }, + "com.amazonaws.quicksight#GeospatialCategoricalColor": { + "type": "structure", + "members": { + "CategoryDataColors": { + "target": "com.amazonaws.quicksight#GeospatialCategoricalDataColorList", + "traits": { + "smithy.api#documentation": "

A list of categorical data colors for each category.

", + "smithy.api#required": {} + } + }, + "NullDataVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The state of visibility for null data.

" + } + }, + "NullDataSettings": { + "target": "com.amazonaws.quicksight#GeospatialNullDataSettings", + "traits": { + "smithy.api#documentation": "

The null data visualization settings.

" + } + }, + "DefaultOpacity": { + "target": "com.amazonaws.quicksight#Opacity", + "traits": { + "smithy.api#documentation": "

The default opacity of a categorical color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a categorical color.

" + } + }, + "com.amazonaws.quicksight#GeospatialCategoricalDataColor": { + "type": "structure", + "members": { + "Color": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the category data color.

", + "smithy.api#required": {} + } + }, + "DataValue": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The data value for the category data color.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The categorical data color for a single category.

" + } + }, + "com.amazonaws.quicksight#GeospatialCategoricalDataColorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GeospatialCategoricalDataColor" + } + }, + "com.amazonaws.quicksight#GeospatialCircleRadius": { + "type": "structure", + "members": { + "Radius": { + "target": "com.amazonaws.quicksight#GeospatialRadius", + "traits": { + "smithy.api#documentation": "

The positive value for the radius of a circle.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The geospatial radius for a circle.

" + } + }, + "com.amazonaws.quicksight#GeospatialCircleSymbolStyle": { + "type": "structure", + "members": { + "FillColor": { + "target": "com.amazonaws.quicksight#GeospatialColor", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the fill color.

" + } + }, + "StrokeColor": { + "target": "com.amazonaws.quicksight#GeospatialColor", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the stroke color.

" + } + }, + "StrokeWidth": { + "target": "com.amazonaws.quicksight#GeospatialLineWidth", + "traits": { + "smithy.api#documentation": "

The width of the stroke (border).

" + } + }, + "CircleRadius": { + "target": "com.amazonaws.quicksight#GeospatialCircleRadius", + "traits": { + "smithy.api#documentation": "

The radius of the circle.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties for a circle symbol style.

" + } + }, + "com.amazonaws.quicksight#GeospatialColor": { + "type": "structure", + "members": { + "Solid": { + "target": "com.amazonaws.quicksight#GeospatialSolidColor", + "traits": { + "smithy.api#documentation": "

The visualization properties for the solid color.

" + } + }, + "Gradient": { + "target": "com.amazonaws.quicksight#GeospatialGradientColor", + "traits": { + "smithy.api#documentation": "

The visualization properties for the gradient color.

" + } + }, + "Categorical": { + "target": "com.amazonaws.quicksight#GeospatialCategoricalColor", + "traits": { + "smithy.api#documentation": "

The visualization properties for the categorical color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The visualization properties for solid, gradient, and categorical colors.

" + } + }, + "com.amazonaws.quicksight#GeospatialColorState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.quicksight#GeospatialCoordinateBounds": { "type": "structure", "members": { @@ -27501,6 +27821,88 @@ "smithy.api#documentation": "

The bound\n options (north, south, west, east) of the geospatial window options.

" } }, + "com.amazonaws.quicksight#GeospatialDataSourceItem": { + "type": "structure", + "members": { + "StaticFileDataSource": { + "target": "com.amazonaws.quicksight#GeospatialStaticFileSource", + "traits": { + "smithy.api#documentation": "

The static file data source properties for the geospatial data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data source properties for the geospatial data.

" + } + }, + "com.amazonaws.quicksight#GeospatialGradientColor": { + "type": "structure", + "members": { + "StepColors": { + "target": "com.amazonaws.quicksight#GeospatialGradientStepColorList", + "traits": { + "smithy.api#documentation": "

A list of gradient step colors for the gradient.

", + "smithy.api#required": {} + } + }, + "NullDataVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The state of visibility for null data.

" + } + }, + "NullDataSettings": { + "target": "com.amazonaws.quicksight#GeospatialNullDataSettings", + "traits": { + "smithy.api#documentation": "

The null data visualization settings.

" + } + }, + "DefaultOpacity": { + "target": "com.amazonaws.quicksight#Opacity", + "traits": { + "smithy.api#documentation": "

The default opacity for the gradient color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a gradient color.

" + } + }, + "com.amazonaws.quicksight#GeospatialGradientStepColor": { + "type": "structure", + "members": { + "Color": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the gradient step color.

", + "smithy.api#required": {} + } + }, + "DataValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The data value for the gradient step color.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The gradient step color for a single step.

" + } + }, + "com.amazonaws.quicksight#GeospatialGradientStepColorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GeospatialGradientStepColor" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 3 + } + } + }, "com.amazonaws.quicksight#GeospatialHeatmapColorScale": { "type": "structure", "members": { @@ -27556,6 +27958,277 @@ } } }, + "com.amazonaws.quicksight#GeospatialLayerColorField": { + "type": "structure", + "members": { + "ColorDimensionsFields": { + "target": "com.amazonaws.quicksight#GeospatialLayerDimensionFieldList", + "traits": { + "smithy.api#documentation": "

A list of color dimension fields.

" + } + }, + "ColorValuesFields": { + "target": "com.amazonaws.quicksight#GeospatialLayerMeasureFieldList", + "traits": { + "smithy.api#documentation": "

A list of color measure fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The color field that defines a gradient or categorical style.

" + } + }, + "com.amazonaws.quicksight#GeospatialLayerDefinition": { + "type": "structure", + "members": { + "PointLayer": { + "target": "com.amazonaws.quicksight#GeospatialPointLayer", + "traits": { + "smithy.api#documentation": "

The definition for a point layer.

" + } + }, + "LineLayer": { + "target": "com.amazonaws.quicksight#GeospatialLineLayer", + "traits": { + "smithy.api#documentation": "

The definition for a line layer.

" + } + }, + "PolygonLayer": { + "target": "com.amazonaws.quicksight#GeospatialPolygonLayer", + "traits": { + "smithy.api#documentation": "

The definition for a polygon layer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition properties for a geospatial layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialLayerDimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#GeospatialLayerItem": { + "type": "structure", + "members": { + "LayerId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the layer.

", + "smithy.api#required": {} + } + }, + "LayerType": { + "target": "com.amazonaws.quicksight#GeospatialLayerType", + "traits": { + "smithy.api#documentation": "

The layer type.

" + } + }, + "DataSource": { + "target": "com.amazonaws.quicksight#GeospatialDataSourceItem", + "traits": { + "smithy.api#documentation": "

The data source for the layer.

" + } + }, + "Label": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The label that is displayed for the layer.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The state of visibility for the layer.

" + } + }, + "LayerDefinition": { + "target": "com.amazonaws.quicksight#GeospatialLayerDefinition", + "traits": { + "smithy.api#documentation": "

The definition properties for a layer.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions" + }, + "JoinDefinition": { + "target": "com.amazonaws.quicksight#GeospatialLayerJoinDefinition", + "traits": { + "smithy.api#documentation": "

The join definition properties for a layer.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#LayerCustomActionList", + "traits": { + "smithy.api#documentation": "

A list of custom actions for a layer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties for a single geospatial layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialLayerJoinDefinition": { + "type": "structure", + "members": { + "ShapeKeyField": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of the field or property in the geospatial data source.

" + } + }, + "DatasetKeyField": { + "target": "com.amazonaws.quicksight#UnaggregatedField" + }, + "ColorField": { + "target": "com.amazonaws.quicksight#GeospatialLayerColorField", + "traits": { + "smithy.api#documentation": "

The geospatial color field for the join definition.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The custom actions for a layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialLayerMapConfiguration": { + "type": "structure", + "members": { + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions" + }, + "MapLayers": { + "target": "com.amazonaws.quicksight#GeospatialMapLayerList", + "traits": { + "smithy.api#documentation": "

The geospatial layers to visualize on the map.

" + } + }, + "MapState": { + "target": "com.amazonaws.quicksight#GeospatialMapState", + "traits": { + "smithy.api#documentation": "

The map state properties for the map.

" + } + }, + "MapStyle": { + "target": "com.amazonaws.quicksight#GeospatialMapStyle", + "traits": { + "smithy.api#documentation": "

The map style properties for the map.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions" + } + }, + "traits": { + "smithy.api#documentation": "

The map definition that defines map state, map style, and geospatial layers.

" + } + }, + "com.amazonaws.quicksight#GeospatialLayerMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#GeospatialLayerType": { + "type": "enum", + "members": { + "POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POINT" + } + }, + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE" + } + }, + "POLYGON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POLYGON" + } + } + } + }, + "com.amazonaws.quicksight#GeospatialLineLayer": { + "type": "structure", + "members": { + "Style": { + "target": "com.amazonaws.quicksight#GeospatialLineStyle", + "traits": { + "smithy.api#documentation": "

The visualization style for a line layer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The geospatial Line layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialLineStyle": { + "type": "structure", + "members": { + "LineSymbolStyle": { + "target": "com.amazonaws.quicksight#GeospatialLineSymbolStyle", + "traits": { + "smithy.api#documentation": "

The symbol style for a line style.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The visualization style for a line layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialLineSymbolStyle": { + "type": "structure", + "members": { + "FillColor": { + "target": "com.amazonaws.quicksight#GeospatialColor", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the fill color.

" + } + }, + "LineWidth": { + "target": "com.amazonaws.quicksight#GeospatialLineWidth", + "traits": { + "smithy.api#documentation": "

The width value for a line.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The symbol style for a line layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialLineWidth": { + "type": "structure", + "members": { + "LineWidth": { + "target": "com.amazonaws.quicksight#GeospatialWidth", + "traits": { + "smithy.api#documentation": "

The positive value for the width of a line.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The width properties for a line.

" + } + }, "com.amazonaws.quicksight#GeospatialMapAggregatedFieldWells": { "type": "structure", "members": { @@ -27649,6 +28322,72 @@ "smithy.api#documentation": "

The field wells of a GeospatialMapVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" } }, + "com.amazonaws.quicksight#GeospatialMapLayerList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GeospatialLayerItem" + } + }, + "com.amazonaws.quicksight#GeospatialMapNavigation": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.quicksight#GeospatialMapState": { + "type": "structure", + "members": { + "Bounds": { + "target": "com.amazonaws.quicksight#GeospatialCoordinateBounds" + }, + "MapNavigation": { + "target": "com.amazonaws.quicksight#GeospatialMapNavigation", + "traits": { + "smithy.api#documentation": "

Enables or disables map navigation for a map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The map state properties for a map.

" + } + }, + "com.amazonaws.quicksight#GeospatialMapStyle": { + "type": "structure", + "members": { + "BaseMapStyle": { + "target": "com.amazonaws.quicksight#BaseMapStyleType", + "traits": { + "smithy.api#documentation": "

The selected base map style.

" + } + }, + "BackgroundColor": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

The background color and opacity values for a map.

" + } + }, + "BaseMapVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The state of visibility for the base map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The map style properties for a map.

" + } + }, "com.amazonaws.quicksight#GeospatialMapStyleOptions": { "type": "structure", "members": { @@ -27702,12 +28441,88 @@ "traits": { "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { "smithy.api#documentation": "

A geospatial map or a points on map visual.

\n

For more information, see Creating point maps in the Amazon QuickSight User Guide.

" } }, + "com.amazonaws.quicksight#GeospatialNullDataSettings": { + "type": "structure", + "members": { + "SymbolStyle": { + "target": "com.amazonaws.quicksight#GeospatialNullSymbolStyle", + "traits": { + "smithy.api#documentation": "

The symbol style for null data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties for the visualization of null data.

" + } + }, + "com.amazonaws.quicksight#GeospatialNullSymbolStyle": { + "type": "structure", + "members": { + "FillColor": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the fill color.

" + } + }, + "StrokeColor": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the stroke color.

" + } + }, + "StrokeWidth": { + "target": "com.amazonaws.quicksight#GeospatialWidth", + "traits": { + "smithy.api#documentation": "

The width of the border stroke.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The symbol style for null data.

" + } + }, + "com.amazonaws.quicksight#GeospatialPointLayer": { + "type": "structure", + "members": { + "Style": { + "target": "com.amazonaws.quicksight#GeospatialPointStyle", + "traits": { + "smithy.api#documentation": "

The visualization style for a point layer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The geospatial Point layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialPointStyle": { + "type": "structure", + "members": { + "CircleSymbolStyle": { + "target": "com.amazonaws.quicksight#GeospatialCircleSymbolStyle", + "traits": { + "smithy.api#documentation": "

The circle symbol style for a point layer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The point style for a point layer.

" + } + }, "com.amazonaws.quicksight#GeospatialPointStyleOptions": { "type": "structure", "members": { @@ -27734,6 +28549,69 @@ "smithy.api#documentation": "

The point style of the geospatial map.

" } }, + "com.amazonaws.quicksight#GeospatialPolygonLayer": { + "type": "structure", + "members": { + "Style": { + "target": "com.amazonaws.quicksight#GeospatialPolygonStyle", + "traits": { + "smithy.api#documentation": "

The visualization style for a polygon layer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The geospatial polygon layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialPolygonStyle": { + "type": "structure", + "members": { + "PolygonSymbolStyle": { + "target": "com.amazonaws.quicksight#GeospatialPolygonSymbolStyle", + "traits": { + "smithy.api#documentation": "

The polygon symbol style for a polygon layer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The polygon style for a polygon layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialPolygonSymbolStyle": { + "type": "structure", + "members": { + "FillColor": { + "target": "com.amazonaws.quicksight#GeospatialColor", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the fill color.

" + } + }, + "StrokeColor": { + "target": "com.amazonaws.quicksight#GeospatialColor", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the stroke color.

" + } + }, + "StrokeWidth": { + "target": "com.amazonaws.quicksight#GeospatialLineWidth", + "traits": { + "smithy.api#documentation": "

The width of the border stroke.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The polygon symbol style for a polygon layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialRadius": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.quicksight#GeospatialSelectedPointStyle": { "type": "enum", "members": { @@ -27757,6 +28635,50 @@ } } }, + "com.amazonaws.quicksight#GeospatialSolidColor": { + "type": "structure", + "members": { + "Color": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the color.

", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.quicksight#GeospatialColorState", + "traits": { + "smithy.api#documentation": "

Enables and disables the view state of the color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a solid color.

" + } + }, + "com.amazonaws.quicksight#GeospatialStaticFileSource": { + "type": "structure", + "members": { + "StaticFileId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the static file.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The source properties for a geospatial static file.

" + } + }, + "com.amazonaws.quicksight#GeospatialWidth": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.quicksight#GeospatialWindowOptions": { "type": "structure", "members": { @@ -28741,6 +29663,12 @@ "traits": { "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -28953,6 +29881,12 @@ "traits": { "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -29396,6 +30330,143 @@ "smithy.api#documentation": "

The logo image configuration.

" } }, + "com.amazonaws.quicksight#ImageCustomAction": { + "type": "structure", + "members": { + "CustomActionId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the custom action.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ImageCustomActionName", + "traits": { + "smithy.api#documentation": "

The name of the custom action.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.quicksight#WidgetStatus", + "traits": { + "smithy.api#documentation": "

The status of the custom action.

" + } + }, + "Trigger": { + "target": "com.amazonaws.quicksight#ImageCustomActionTrigger", + "traits": { + "smithy.api#documentation": "

The trigger of the VisualCustomAction.

\n

Valid values are defined as follows:

\n
    \n
  • \n

    \n CLICK: Initiates a custom action by a left pointer click on a data point.

    \n
  • \n
  • \n

    \n MENU: Initiates a custom action by right pointer click from the menu.

    \n
  • \n
", + "smithy.api#required": {} + } + }, + "ActionOperations": { + "target": "com.amazonaws.quicksight#ImageCustomActionOperationList", + "traits": { + "smithy.api#documentation": "

A list of ImageCustomActionOperations.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom action defined on an image.

" + } + }, + "com.amazonaws.quicksight#ImageCustomActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ImageCustomAction" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#ImageCustomActionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#ImageCustomActionOperation": { + "type": "structure", + "members": { + "NavigationOperation": { + "target": "com.amazonaws.quicksight#CustomActionNavigationOperation" + }, + "URLOperation": { + "target": "com.amazonaws.quicksight#CustomActionURLOperation" + }, + "SetParametersOperation": { + "target": "com.amazonaws.quicksight#CustomActionSetParametersOperation" + } + }, + "traits": { + "smithy.api#documentation": "

The operation that is defined by the custom action.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#ImageCustomActionOperationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ImageCustomActionOperation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#ImageCustomActionTrigger": { + "type": "enum", + "members": { + "CLICK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLICK" + } + }, + "MENU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MENU" + } + } + } + }, + "com.amazonaws.quicksight#ImageInteractionOptions": { + "type": "structure", + "members": { + "ImageMenuOption": { + "target": "com.amazonaws.quicksight#ImageMenuOption", + "traits": { + "smithy.api#documentation": "

The menu options for the image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The general image interactions setup for image publish options.

" + } + }, + "com.amazonaws.quicksight#ImageMenuOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The availability status of the image menu. If the value of this property is set to ENABLED, dashboard readers can interact with the image menu.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The menu options for the interactions of an image.

" + } + }, "com.amazonaws.quicksight#ImageSet": { "type": "structure", "members": { @@ -29458,6 +30529,27 @@ "smithy.api#documentation": "

The source of the image.

" } }, + "com.amazonaws.quicksight#ImageStaticFile": { + "type": "structure", + "members": { + "StaticFileId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the static file that contains an image.

", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.quicksight#StaticFileSource", + "traits": { + "smithy.api#documentation": "

The source of the image static file.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A static file that contains an image.

" + } + }, "com.amazonaws.quicksight#IncludeFolderMembers": { "type": "enum", "members": { @@ -30146,6 +31238,12 @@ "smithy.api#documentation": "

The dataset that is used in the insight visual.

", "smithy.api#required": {} } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -30984,6 +32082,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -31077,6 +32181,158 @@ } } }, + "com.amazonaws.quicksight#LayerCustomAction": { + "type": "structure", + "members": { + "CustomActionId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the custom action.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#LayerCustomActionName", + "traits": { + "smithy.api#documentation": "

The name of the custom action.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.quicksight#WidgetStatus", + "traits": { + "smithy.api#documentation": "

The status of the LayerCustomAction.

" + } + }, + "Trigger": { + "target": "com.amazonaws.quicksight#LayerCustomActionTrigger", + "traits": { + "smithy.api#documentation": "

The trigger of the LayerCustomAction.

\n

Valid values are defined as follows:

\n
    \n
  • \n

    \n DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.

    \n
  • \n
  • \n

    \n DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.

    \n
  • \n
", + "smithy.api#required": {} + } + }, + "ActionOperations": { + "target": "com.amazonaws.quicksight#LayerCustomActionOperationList", + "traits": { + "smithy.api#documentation": "

A list of LayerCustomActionOperations.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A layer custom action.

" + } + }, + "com.amazonaws.quicksight#LayerCustomActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#LayerCustomAction" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#LayerCustomActionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#LayerCustomActionOperation": { + "type": "structure", + "members": { + "FilterOperation": { + "target": "com.amazonaws.quicksight#CustomActionFilterOperation" + }, + "NavigationOperation": { + "target": "com.amazonaws.quicksight#CustomActionNavigationOperation" + }, + "URLOperation": { + "target": "com.amazonaws.quicksight#CustomActionURLOperation" + }, + "SetParametersOperation": { + "target": "com.amazonaws.quicksight#CustomActionSetParametersOperation" + } + }, + "traits": { + "smithy.api#documentation": "

The operation that is defined by the custom action.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#LayerCustomActionOperationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#LayerCustomActionOperation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#LayerCustomActionTrigger": { + "type": "enum", + "members": { + "DATA_POINT_CLICK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_POINT_CLICK" + } + }, + "DATA_POINT_MENU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_POINT_MENU" + } + } + } + }, + "com.amazonaws.quicksight#LayerMapVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the visual.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions" + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions" + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#GeospatialLayerMapConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "DataSetIdentifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

The dataset that is used to create the layer map visual. You can't create a visual without a dataset.

", + "smithy.api#required": {} + } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A layer map visual.

" + } + }, "com.amazonaws.quicksight#Layout": { "type": "structure", "members": { @@ -31144,6 +32400,12 @@ "traits": { "smithy.api#enumValue": "TEXT_BOX" } + }, + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE" + } } } }, @@ -31191,6 +32453,9 @@ "traits": { "smithy.api#documentation": "

The height of the legend. If this value is omitted, a default height is used when\n rendering.

" } + }, + "ValueFontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration" } }, "traits": { @@ -31711,6 +32976,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -36716,6 +37987,18 @@ "traits": { "smithy.api#documentation": "

An error that occurred when the namespace was created.

" } + }, + "IamIdentityCenterApplicationArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM Identity Center application.

" + } + }, + "IamIdentityCenterInstanceArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

" + } } }, "traits": { @@ -37643,6 +38926,15 @@ } } }, + "com.amazonaws.quicksight#Opacity": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.quicksight#OperandList": { "type": "list", "member": { @@ -38965,6 +40257,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -39761,6 +41059,12 @@ "traits": { "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -39829,6 +41133,222 @@ "smithy.api#documentation": "String based length that is composed of value and unit in px" } }, + "com.amazonaws.quicksight#PluginVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the visual that you want to use.

", + "smithy.api#required": {} + } + }, + "PluginArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that reflects the plugin and version.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions" + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions" + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#PluginVisualConfiguration", + "traits": { + "smithy.api#documentation": "

\n A description of the plugin field wells and their persisted properties.\n

" + } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A flexible visualization type that allows engineers \n to create new custom charts in Amazon QuickSight.

" + } + }, + "com.amazonaws.quicksight#PluginVisualAxisName": { + "type": "enum", + "members": { + "GROUP_BY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUP_BY" + } + }, + "VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE" + } + } + } + }, + "com.amazonaws.quicksight#PluginVisualConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#PluginVisualFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells configuration of the plugin visual.

" + } + }, + "VisualOptions": { + "target": "com.amazonaws.quicksight#PluginVisualOptions", + "traits": { + "smithy.api#documentation": "

The persisted properties of the plugin visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#PluginVisualSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of the plugin visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The plugin visual configuration. This includes the field wells, sorting options, and persisted options of the plugin visual.

" + } + }, + "com.amazonaws.quicksight#PluginVisualFieldWell": { + "type": "structure", + "members": { + "AxisName": { + "target": "com.amazonaws.quicksight#PluginVisualAxisName", + "traits": { + "smithy.api#documentation": "

The semantic axis name for the field well.

" + } + }, + "Dimensions": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

A list of dimensions for the field well.

" + } + }, + "Measures": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

A list of measures that exist in the field well.

" + } + }, + "Unaggregated": { + "target": "com.amazonaws.quicksight#UnaggregatedFieldList", + "traits": { + "smithy.api#documentation": "

A list of unaggregated fields that exist in the field well.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of field wells for a plugin visual.

" + } + }, + "com.amazonaws.quicksight#PluginVisualFieldWells": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PluginVisualFieldWell" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#PluginVisualItemsLimitConfiguration": { + "type": "structure", + "members": { + "ItemsLimit": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Determines how many values are be fetched at once.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A query limits configuration.

" + } + }, + "com.amazonaws.quicksight#PluginVisualOptions": { + "type": "structure", + "members": { + "VisualProperties": { + "target": "com.amazonaws.quicksight#PluginVisualPropertiesList", + "traits": { + "smithy.api#documentation": "

The persisted properties and their values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options and persisted properties for the plugin visual.

" + } + }, + "com.amazonaws.quicksight#PluginVisualPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PluginVisualProperty" + } + }, + "com.amazonaws.quicksight#PluginVisualProperty": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of the plugin visual property.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the plugin visual property.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The key value pair of the persisted property.

" + } + }, + "com.amazonaws.quicksight#PluginVisualSortConfiguration": { + "type": "structure", + "members": { + "PluginVisualTableQuerySort": { + "target": "com.amazonaws.quicksight#PluginVisualTableQuerySort", + "traits": { + "smithy.api#documentation": "

The table query sorting options for the plugin visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines how the plugin visual sorts the data during query.

" + } + }, + "com.amazonaws.quicksight#PluginVisualTableQuerySort": { + "type": "structure", + "members": { + "RowSort": { + "target": "com.amazonaws.quicksight#RowSortList", + "traits": { + "smithy.api#documentation": "

Determines how data is sorted in the response.

" + } + }, + "ItemsLimitConfiguration": { + "target": "com.amazonaws.quicksight#PluginVisualItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The maximum amount of data to be returned by a query.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The table query sorting options for the plugin visual.

" + } + }, "com.amazonaws.quicksight#Port": { "type": "integer", "traits": { @@ -40544,6 +42064,9 @@ { "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResult" }, + { + "target": "com.amazonaws.quicksight#DescribeDashboardsQAConfiguration" + }, { "target": "com.amazonaws.quicksight#DescribeDataSet" }, @@ -40778,6 +42301,9 @@ { "target": "com.amazonaws.quicksight#SearchGroups" }, + { + "target": "com.amazonaws.quicksight#SearchTopics" + }, { "target": "com.amazonaws.quicksight#StartAssetBundleExportJob" }, @@ -40832,6 +42358,9 @@ { "target": "com.amazonaws.quicksight#UpdateDashboardPublishedVersion" }, + { + "target": "com.amazonaws.quicksight#UpdateDashboardsQAConfiguration" + }, { "target": "com.amazonaws.quicksight#UpdateDataSet" }, @@ -42084,6 +43613,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -44280,6 +45815,12 @@ "traits": { "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -44506,6 +46047,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -45246,6 +46793,118 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#SearchTopics": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#SearchTopicsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#SearchTopicsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches for any Q topic that exists in an Amazon QuickSight account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/search/topics", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TopicSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#SearchTopicsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want to find.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#TopicSearchFilterList", + "traits": { + "smithy.api#documentation": "

The filters that you want to use to search for the topic.

", + "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.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#SearchTopicsResponse": { + "type": "structure", + "members": { + "TopicSummaryList": { + "target": "com.amazonaws.quicksight#TopicSummaries", + "traits": { + "smithy.api#documentation": "

A list of topic summaries that is returned by the search topic request.

" + } + }, + "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.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "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#Seasonality": { "type": "integer", "traits": { @@ -45919,6 +47578,12 @@ "traits": { "smithy.api#documentation": "

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

" } + }, + "Images": { + "target": "com.amazonaws.quicksight#SheetImageList", + "traits": { + "smithy.api#documentation": "

A list of images on a sheet.

" + } } }, "traits": { @@ -46138,6 +47803,12 @@ "smithy.api#documentation": "

The text boxes that are on a sheet.

" } }, + "Images": { + "target": "com.amazonaws.quicksight#SheetImageList", + "traits": { + "smithy.api#documentation": "

A list of images on a sheet.

" + } + }, "Layouts": { "target": "com.amazonaws.quicksight#LayoutList", "traits": { @@ -46230,6 +47901,176 @@ } } }, + "com.amazonaws.quicksight#SheetImage": { + "type": "structure", + "members": { + "SheetImageId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the sheet image.

", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.quicksight#SheetImageSource", + "traits": { + "smithy.api#documentation": "

The source of the image.

", + "smithy.api#required": {} + } + }, + "Scaling": { + "target": "com.amazonaws.quicksight#SheetImageScalingConfiguration", + "traits": { + "smithy.api#documentation": "

Determines how the image is scaled.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#SheetImageTooltipConfiguration", + "traits": { + "smithy.api#documentation": "

The tooltip to be shown when hovering over the image.

" + } + }, + "ImageContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the image.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#ImageInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general image interactions setup for an image.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#ImageCustomActionList", + "traits": { + "smithy.api#documentation": "

A list of custom actions that are configured for an image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An image that is located on a sheet.

" + } + }, + "com.amazonaws.quicksight#SheetImageList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SheetImage" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#SheetImageScalingConfiguration": { + "type": "structure", + "members": { + "ScalingType": { + "target": "com.amazonaws.quicksight#SheetImageScalingType", + "traits": { + "smithy.api#documentation": "

The scaling option to use when fitting the image inside the container.

\n

Valid values are defined as follows:

\n
    \n
  • \n

    \n SCALE_TO_WIDTH: The image takes up the entire width of the container. The image aspect ratio is preserved.

    \n
  • \n
  • \n

    \n SCALE_TO_HEIGHT: The image takes up the entire height of the container. The image aspect ratio is preserved.

    \n
  • \n
  • \n

    \n SCALE_TO_CONTAINER: The image takes up the entire width and height of the container. The image aspect ratio is not preserved.

    \n
  • \n
  • \n

    \n SCALE_NONE: The image is displayed in its original size and is not scaled to the container.

    \n
  • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines how the image is scaled

" + } + }, + "com.amazonaws.quicksight#SheetImageScalingType": { + "type": "enum", + "members": { + "SCALE_TO_WIDTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCALE_TO_WIDTH" + } + }, + "SCALE_TO_HEIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCALE_TO_HEIGHT" + } + }, + "SCALE_TO_CONTAINER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCALE_TO_CONTAINER" + } + }, + "SCALE_NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCALE_NONE" + } + } + } + }, + "com.amazonaws.quicksight#SheetImageSource": { + "type": "structure", + "members": { + "SheetImageStaticFileSource": { + "target": "com.amazonaws.quicksight#SheetImageStaticFileSource", + "traits": { + "smithy.api#documentation": "

The source of the static file that contains the image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source of the image.

" + } + }, + "com.amazonaws.quicksight#SheetImageStaticFileSource": { + "type": "structure", + "members": { + "StaticFileId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the static file that contains the image.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The source of the static file that contains the image.

" + } + }, + "com.amazonaws.quicksight#SheetImageTooltipConfiguration": { + "type": "structure", + "members": { + "TooltipText": { + "target": "com.amazonaws.quicksight#SheetImageTooltipText", + "traits": { + "smithy.api#documentation": "

The text that appears in the tooltip.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the tooltip.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tooltip configuration for a sheet image.

" + } + }, + "com.amazonaws.quicksight#SheetImageTooltipText": { + "type": "structure", + "members": { + "PlainText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The plain text format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The text that appears in the sheet image tooltip.

" + } + }, "com.amazonaws.quicksight#SheetLayoutElementMaximizationOption": { "type": "structure", "members": { @@ -47340,6 +49181,27 @@ "smithy.api#documentation": "

The parameters for Spark.

" } }, + "com.amazonaws.quicksight#SpatialStaticFile": { + "type": "structure", + "members": { + "StaticFileId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the spatial static file.

", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.quicksight#StaticFileSource", + "traits": { + "smithy.api#documentation": "

The source of the spatial static file.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A static file that contains the geospatial data.

" + } + }, "com.amazonaws.quicksight#SpecialValue": { "type": "enum", "members": { @@ -48021,6 +49883,102 @@ "smithy.api#documentation": "

The state perssitence configuration of an embedded dashboard.

" } }, + "com.amazonaws.quicksight#StaticFile": { + "type": "structure", + "members": { + "ImageStaticFile": { + "target": "com.amazonaws.quicksight#ImageStaticFile", + "traits": { + "smithy.api#documentation": "

The image static file.

" + } + }, + "SpatialStaticFile": { + "target": "com.amazonaws.quicksight#SpatialStaticFile", + "traits": { + "smithy.api#documentation": "

The spacial static file.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The static file.

" + } + }, + "com.amazonaws.quicksight#StaticFileList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#StaticFile" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#StaticFileS3SourceOptions": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket.

", + "smithy.api#required": {} + } + }, + "ObjectKey": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The identifier of the static file in the Amazon S3 bucket.

", + "smithy.api#required": {} + } + }, + "Region": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Region of the Amazon S3 account that contains the bucket.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The structure that contains the Amazon S3 location to download the static file from.

" + } + }, + "com.amazonaws.quicksight#StaticFileSource": { + "type": "structure", + "members": { + "UrlOptions": { + "target": "com.amazonaws.quicksight#StaticFileUrlSourceOptions", + "traits": { + "smithy.api#documentation": "

The structure that contains the URL to download the static file from.

" + } + }, + "S3Options": { + "target": "com.amazonaws.quicksight#StaticFileS3SourceOptions", + "traits": { + "smithy.api#documentation": "

The structure that contains the Amazon S3 location to download the static file from.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source of the static file.

" + } + }, + "com.amazonaws.quicksight#StaticFileUrlSourceOptions": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The URL to download the static file from.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The structure that contains the URL to download the static file from.

" + } + }, "com.amazonaws.quicksight#Status": { "type": "enum", "members": { @@ -49275,6 +51233,12 @@ "traits": { "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -49855,6 +51819,12 @@ }, "QueryExecutionOptions": { "target": "com.amazonaws.quicksight#QueryExecutionOptions" + }, + "StaticFiles": { + "target": "com.amazonaws.quicksight#StaticFileList", + "traits": { + "smithy.api#documentation": "

The static files for the definition.

" + } } }, "traits": { @@ -51596,6 +53566,70 @@ "smithy.api#documentation": "

A structure that represents a filter used to select items for a topic.

" } }, + "com.amazonaws.quicksight#TopicFilterAttribute": { + "type": "enum", + "members": { + "QUICKSIGHT_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_USER" + } + }, + "QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_SOLE_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" + } + }, + "TOPIC_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOPIC_NAME" + } + } + } + }, + "com.amazonaws.quicksight#TopicFilterOperator": { + "type": "enum", + "members": { + "StringEquals": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StringEquals" + } + }, + "StringLike": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StringLike" + } + } + } + }, "com.amazonaws.quicksight#TopicFilters": { "type": "list", "member": { @@ -52530,6 +54564,47 @@ } } }, + "com.amazonaws.quicksight#TopicSearchFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.quicksight#TopicFilterOperator", + "traits": { + "smithy.api#documentation": "

The operator like equals or like.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#TopicFilterAttribute", + "traits": { + "smithy.api#documentation": "

The name of the topic search filter.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the topic search filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter that is used to search for a topic.

" + } + }, + "com.amazonaws.quicksight#TopicSearchFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicSearchFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.quicksight#TopicSingularFilterConstant": { "type": "structure", "members": { @@ -53126,6 +55201,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -54933,6 +57014,94 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#UpdateDashboardsQAConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDashboardsQAConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDashboardsQAConfigurationResponse" + }, + "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#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a Dashboard QA configuration.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/dashboards-qa-configuration", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDashboardsQAConfigurationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard QA configuration that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardsQAStatus": { + "target": "com.amazonaws.quicksight#DashboardsQAStatus", + "traits": { + "smithy.api#documentation": "

The status of dashboards QA configuration that you want to update.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboardsQAConfigurationResponse": { + "type": "structure", + "members": { + "DashboardsQAStatus": { + "target": "com.amazonaws.quicksight#DashboardsQAStatus", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the dashboard QA configuration is enabled or not.

" + } + }, + "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#UpdateDataSet": { "type": "operation", "input": { @@ -58818,6 +60987,12 @@ "smithy.api#documentation": "

A filled map.

\n

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

" } }, + "LayerMapVisual": { + "target": "com.amazonaws.quicksight#LayerMapVisual", + "traits": { + "smithy.api#documentation": "

The properties for a layer map visual

" + } + }, "FunnelChartVisual": { "target": "com.amazonaws.quicksight#FunnelChartVisual", "traits": { @@ -58889,6 +61064,12 @@ "traits": { "smithy.api#documentation": "

A radar chart visual.

\n

For more information, see Using radar charts in the Amazon QuickSight User Guide.

" } + }, + "PluginVisual": { + "target": "com.amazonaws.quicksight#PluginVisual", + "traits": { + "smithy.api#documentation": "

The custom plugin visual type.

" + } } }, "traits": { @@ -59501,6 +61682,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -59802,6 +61989,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": {