diff --git a/clients/client-quicksight/src/commands/CreateAnalysisCommand.ts b/clients/client-quicksight/src/commands/CreateAnalysisCommand.ts index 4f26657db1f6..1820ba4b44d3 100644 --- a/clients/client-quicksight/src/commands/CreateAnalysisCommand.ts +++ b/clients/client-quicksight/src/commands/CreateAnalysisCommand.ts @@ -1690,6 +1690,14 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { // SmallMultiplesAxisProperties + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, * }, * CategoryAxis: { // AxisDisplayOptions * TickLabelOptions: { // AxisTickLabelOptions @@ -2404,6 +2412,14 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, * }, * CategoryLabelOptions: { * Visibility: "HIDDEN" || "VISIBLE", @@ -2801,6 +2817,11 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: "", * }, * XAxisDisplayOptions: { * TickLabelOptions: { @@ -4334,7 +4355,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * { // AggregationSortConfiguration * Column: "", // required * SortDirection: "ASC" || "DESC", // required - * AggregationFunction: "", // required + * AggregationFunction: "", * }, * ], * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", @@ -4368,6 +4389,15 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M * DateTimeFormatConfiguration: "", * }, * Role: "DIMENSION" || "MEASURE", + * ColorsConfiguration: { // ColorsConfiguration + * CustomColors: [ // CustomColorsList + * { // CustomColor + * FieldValue: "STRING_VALUE", + * Color: "STRING_VALUE", // required + * SpecialValue: "EMPTY" || "NULL" || "OTHER", + * }, + * ], + * }, * }, * ], * AnalysisDefaults: { // AnalysisDefaults diff --git a/clients/client-quicksight/src/commands/CreateDashboardCommand.ts b/clients/client-quicksight/src/commands/CreateDashboardCommand.ts index 4f5c6c68f80e..bddd50341bbc 100644 --- a/clients/client-quicksight/src/commands/CreateDashboardCommand.ts +++ b/clients/client-quicksight/src/commands/CreateDashboardCommand.ts @@ -1736,6 +1736,14 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { // SmallMultiplesAxisProperties + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, * }, * CategoryAxis: { // AxisDisplayOptions * TickLabelOptions: { // AxisTickLabelOptions @@ -2450,6 +2458,14 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, * }, * CategoryLabelOptions: { * Visibility: "HIDDEN" || "VISIBLE", @@ -2847,6 +2863,11 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: "", * }, * XAxisDisplayOptions: { * TickLabelOptions: { @@ -4380,7 +4401,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * { // AggregationSortConfiguration * Column: "", // required * SortDirection: "ASC" || "DESC", // required - * AggregationFunction: "", // required + * AggregationFunction: "", * }, * ], * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", @@ -4414,6 +4435,15 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * DateTimeFormatConfiguration: "", * }, * Role: "DIMENSION" || "MEASURE", + * ColorsConfiguration: { // ColorsConfiguration + * CustomColors: [ // CustomColorsList + * { // CustomColor + * FieldValue: "STRING_VALUE", + * Color: "STRING_VALUE", // required + * SpecialValue: "EMPTY" || "NULL" || "OTHER", + * }, + * ], + * }, * }, * ], * AnalysisDefaults: { // AnalysisDefaults diff --git a/clients/client-quicksight/src/commands/CreateTemplateCommand.ts b/clients/client-quicksight/src/commands/CreateTemplateCommand.ts index 2e6bf23b40b5..02360a749f9e 100644 --- a/clients/client-quicksight/src/commands/CreateTemplateCommand.ts +++ b/clients/client-quicksight/src/commands/CreateTemplateCommand.ts @@ -1684,6 +1684,14 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { // SmallMultiplesAxisProperties + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, * }, * CategoryAxis: { // AxisDisplayOptions * TickLabelOptions: { // AxisTickLabelOptions @@ -2398,6 +2406,14 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, * }, * CategoryLabelOptions: { * Visibility: "HIDDEN" || "VISIBLE", @@ -2795,6 +2811,11 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: "", * }, * XAxisDisplayOptions: { * TickLabelOptions: { @@ -4328,7 +4349,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * { // AggregationSortConfiguration * Column: "", // required * SortDirection: "ASC" || "DESC", // required - * AggregationFunction: "", // required + * AggregationFunction: "", * }, * ], * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", @@ -4362,6 +4383,15 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * DateTimeFormatConfiguration: "", * }, * Role: "DIMENSION" || "MEASURE", + * ColorsConfiguration: { // ColorsConfiguration + * CustomColors: [ // CustomColorsList + * { // CustomColor + * FieldValue: "STRING_VALUE", + * Color: "STRING_VALUE", // required + * SpecialValue: "EMPTY" || "NULL" || "OTHER", + * }, + * ], + * }, * }, * ], * AnalysisDefaults: { // AnalysisDefaults diff --git a/clients/client-quicksight/src/commands/DeleteFolderCommand.ts b/clients/client-quicksight/src/commands/DeleteFolderCommand.ts index 83206fd07d33..35f8e191ea51 100644 --- a/clients/client-quicksight/src/commands/DeleteFolderCommand.ts +++ b/clients/client-quicksight/src/commands/DeleteFolderCommand.ts @@ -13,7 +13,8 @@ import { SerdeContext as __SerdeContext, } from "@smithy/types"; -import { DeleteFolderRequest, DeleteFolderResponse } from "../models/models_2"; +import { DeleteFolderRequest } from "../models/models_2"; +import { DeleteFolderResponse } from "../models/models_3"; import { de_DeleteFolderCommand, se_DeleteFolderCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DeleteFolderMembershipCommand.ts b/clients/client-quicksight/src/commands/DeleteFolderMembershipCommand.ts index 9f80fe1407bc..6c92463320c1 100644 --- a/clients/client-quicksight/src/commands/DeleteFolderMembershipCommand.ts +++ b/clients/client-quicksight/src/commands/DeleteFolderMembershipCommand.ts @@ -13,7 +13,7 @@ import { SerdeContext as __SerdeContext, } from "@smithy/types"; -import { DeleteFolderMembershipRequest, DeleteFolderMembershipResponse } from "../models/models_2"; +import { DeleteFolderMembershipRequest, DeleteFolderMembershipResponse } from "../models/models_3"; import { de_DeleteFolderMembershipCommand, se_DeleteFolderMembershipCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DeleteGroupCommand.ts b/clients/client-quicksight/src/commands/DeleteGroupCommand.ts index bc39ea415a76..96feaa01bd4f 100644 --- a/clients/client-quicksight/src/commands/DeleteGroupCommand.ts +++ b/clients/client-quicksight/src/commands/DeleteGroupCommand.ts @@ -13,7 +13,7 @@ import { SerdeContext as __SerdeContext, } from "@smithy/types"; -import { DeleteGroupRequest, DeleteGroupResponse } from "../models/models_2"; +import { DeleteGroupRequest, DeleteGroupResponse } from "../models/models_3"; import { de_DeleteGroupCommand, se_DeleteGroupCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DeleteGroupMembershipCommand.ts b/clients/client-quicksight/src/commands/DeleteGroupMembershipCommand.ts index 08533971963e..fe24252517ad 100644 --- a/clients/client-quicksight/src/commands/DeleteGroupMembershipCommand.ts +++ b/clients/client-quicksight/src/commands/DeleteGroupMembershipCommand.ts @@ -13,8 +13,7 @@ import { SerdeContext as __SerdeContext, } from "@smithy/types"; -import { DeleteGroupMembershipRequest } from "../models/models_2"; -import { DeleteGroupMembershipResponse } from "../models/models_3"; +import { DeleteGroupMembershipRequest, DeleteGroupMembershipResponse } from "../models/models_3"; import { de_DeleteGroupMembershipCommand, se_DeleteGroupMembershipCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/DescribeAnalysisDefinitionCommand.ts b/clients/client-quicksight/src/commands/DescribeAnalysisDefinitionCommand.ts index a4a0ff8bc007..15a3b8cd0bab 100644 --- a/clients/client-quicksight/src/commands/DescribeAnalysisDefinitionCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeAnalysisDefinitionCommand.ts @@ -1656,6 +1656,14 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // BackgroundVisibility: "HIDDEN" || "VISIBLE", * // BackgroundColor: "STRING_VALUE", * // }, + * // XAxis: { // SmallMultiplesAxisProperties + * // Scale: "SHARED" || "INDEPENDENT", + * // Placement: "OUTSIDE" || "INSIDE", + * // }, + * // YAxis: { + * // Scale: "SHARED" || "INDEPENDENT", + * // Placement: "OUTSIDE" || "INSIDE", + * // }, * // }, * // CategoryAxis: { // AxisDisplayOptions * // TickLabelOptions: { // AxisTickLabelOptions @@ -2370,6 +2378,14 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // BackgroundVisibility: "HIDDEN" || "VISIBLE", * // BackgroundColor: "STRING_VALUE", * // }, + * // XAxis: { + * // Scale: "SHARED" || "INDEPENDENT", + * // Placement: "OUTSIDE" || "INSIDE", + * // }, + * // YAxis: { + * // Scale: "SHARED" || "INDEPENDENT", + * // Placement: "OUTSIDE" || "INSIDE", + * // }, * // }, * // CategoryLabelOptions: { * // Visibility: "HIDDEN" || "VISIBLE", @@ -2767,6 +2783,11 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // BackgroundVisibility: "HIDDEN" || "VISIBLE", * // BackgroundColor: "STRING_VALUE", * // }, + * // XAxis: { + * // Scale: "SHARED" || "INDEPENDENT", + * // Placement: "OUTSIDE" || "INSIDE", + * // }, + * // YAxis: "", * // }, * // XAxisDisplayOptions: { * // TickLabelOptions: { @@ -4300,7 +4321,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // { // AggregationSortConfiguration * // Column: "", // required * // SortDirection: "ASC" || "DESC", // required - * // AggregationFunction: "", // required + * // AggregationFunction: "", * // }, * // ], * // TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", @@ -4334,6 +4355,15 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // DateTimeFormatConfiguration: "", * // }, * // Role: "DIMENSION" || "MEASURE", + * // ColorsConfiguration: { // ColorsConfiguration + * // CustomColors: [ // CustomColorsList + * // { // CustomColor + * // FieldValue: "STRING_VALUE", + * // Color: "STRING_VALUE", // required + * // SpecialValue: "EMPTY" || "NULL" || "OTHER", + * // }, + * // ], + * // }, * // }, * // ], * // AnalysisDefaults: { // AnalysisDefaults diff --git a/clients/client-quicksight/src/commands/DescribeDashboardDefinitionCommand.ts b/clients/client-quicksight/src/commands/DescribeDashboardDefinitionCommand.ts index aa4a69e1d3be..149e7bbfc01c 100644 --- a/clients/client-quicksight/src/commands/DescribeDashboardDefinitionCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeDashboardDefinitionCommand.ts @@ -1663,6 +1663,14 @@ export interface DescribeDashboardDefinitionCommandOutput * // BackgroundVisibility: "HIDDEN" || "VISIBLE", * // BackgroundColor: "STRING_VALUE", * // }, + * // XAxis: { // SmallMultiplesAxisProperties + * // Scale: "SHARED" || "INDEPENDENT", + * // Placement: "OUTSIDE" || "INSIDE", + * // }, + * // YAxis: { + * // Scale: "SHARED" || "INDEPENDENT", + * // Placement: "OUTSIDE" || "INSIDE", + * // }, * // }, * // CategoryAxis: { // AxisDisplayOptions * // TickLabelOptions: { // AxisTickLabelOptions @@ -2377,6 +2385,14 @@ export interface DescribeDashboardDefinitionCommandOutput * // BackgroundVisibility: "HIDDEN" || "VISIBLE", * // BackgroundColor: "STRING_VALUE", * // }, + * // XAxis: { + * // Scale: "SHARED" || "INDEPENDENT", + * // Placement: "OUTSIDE" || "INSIDE", + * // }, + * // YAxis: { + * // Scale: "SHARED" || "INDEPENDENT", + * // Placement: "OUTSIDE" || "INSIDE", + * // }, * // }, * // CategoryLabelOptions: { * // Visibility: "HIDDEN" || "VISIBLE", @@ -2774,6 +2790,11 @@ export interface DescribeDashboardDefinitionCommandOutput * // BackgroundVisibility: "HIDDEN" || "VISIBLE", * // BackgroundColor: "STRING_VALUE", * // }, + * // XAxis: { + * // Scale: "SHARED" || "INDEPENDENT", + * // Placement: "OUTSIDE" || "INSIDE", + * // }, + * // YAxis: "", * // }, * // XAxisDisplayOptions: { * // TickLabelOptions: { @@ -4307,7 +4328,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // { // AggregationSortConfiguration * // Column: "", // required * // SortDirection: "ASC" || "DESC", // required - * // AggregationFunction: "", // required + * // AggregationFunction: "", * // }, * // ], * // TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", @@ -4341,6 +4362,15 @@ export interface DescribeDashboardDefinitionCommandOutput * // DateTimeFormatConfiguration: "", * // }, * // Role: "DIMENSION" || "MEASURE", + * // ColorsConfiguration: { // ColorsConfiguration + * // CustomColors: [ // CustomColorsList + * // { // CustomColor + * // FieldValue: "STRING_VALUE", + * // Color: "STRING_VALUE", // required + * // SpecialValue: "EMPTY" || "NULL" || "OTHER", + * // }, + * // ], + * // }, * // }, * // ], * // AnalysisDefaults: { // AnalysisDefaults diff --git a/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts b/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts index 8609a72cfbe6..9971d3eeb033 100644 --- a/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts @@ -1676,6 +1676,14 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // BackgroundVisibility: "HIDDEN" || "VISIBLE", * // BackgroundColor: "STRING_VALUE", * // }, + * // XAxis: { // SmallMultiplesAxisProperties + * // Scale: "SHARED" || "INDEPENDENT", + * // Placement: "OUTSIDE" || "INSIDE", + * // }, + * // YAxis: { + * // Scale: "SHARED" || "INDEPENDENT", + * // Placement: "OUTSIDE" || "INSIDE", + * // }, * // }, * // CategoryAxis: { // AxisDisplayOptions * // TickLabelOptions: { // AxisTickLabelOptions @@ -2390,6 +2398,14 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // BackgroundVisibility: "HIDDEN" || "VISIBLE", * // BackgroundColor: "STRING_VALUE", * // }, + * // XAxis: { + * // Scale: "SHARED" || "INDEPENDENT", + * // Placement: "OUTSIDE" || "INSIDE", + * // }, + * // YAxis: { + * // Scale: "SHARED" || "INDEPENDENT", + * // Placement: "OUTSIDE" || "INSIDE", + * // }, * // }, * // CategoryLabelOptions: { * // Visibility: "HIDDEN" || "VISIBLE", @@ -2787,6 +2803,11 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // BackgroundVisibility: "HIDDEN" || "VISIBLE", * // BackgroundColor: "STRING_VALUE", * // }, + * // XAxis: { + * // Scale: "SHARED" || "INDEPENDENT", + * // Placement: "OUTSIDE" || "INSIDE", + * // }, + * // YAxis: "", * // }, * // XAxisDisplayOptions: { * // TickLabelOptions: { @@ -4320,7 +4341,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // { // AggregationSortConfiguration * // Column: "", // required * // SortDirection: "ASC" || "DESC", // required - * // AggregationFunction: "", // required + * // AggregationFunction: "", * // }, * // ], * // TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", @@ -4354,6 +4375,15 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // DateTimeFormatConfiguration: "", * // }, * // Role: "DIMENSION" || "MEASURE", + * // ColorsConfiguration: { // ColorsConfiguration + * // CustomColors: [ // CustomColorsList + * // { // CustomColor + * // FieldValue: "STRING_VALUE", + * // Color: "STRING_VALUE", // required + * // SpecialValue: "EMPTY" || "NULL" || "OTHER", + * // }, + * // ], + * // }, * // }, * // ], * // AnalysisDefaults: { // AnalysisDefaults diff --git a/clients/client-quicksight/src/commands/StartAssetBundleExportJobCommand.ts b/clients/client-quicksight/src/commands/StartAssetBundleExportJobCommand.ts index a02a86731851..d3d535293ecc 100644 --- a/clients/client-quicksight/src/commands/StartAssetBundleExportJobCommand.ts +++ b/clients/client-quicksight/src/commands/StartAssetBundleExportJobCommand.ts @@ -37,7 +37,7 @@ export interface StartAssetBundleExportJobCommandOutput extends StartAssetBundle /** * @public *

Starts an Asset Bundle export job.

- *

An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 10 export jobs concurrently.

+ *

An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently.

*

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-quicksight/src/commands/StartAssetBundleImportJobCommand.ts b/clients/client-quicksight/src/commands/StartAssetBundleImportJobCommand.ts index 17827dc778ad..2faf3a696f12 100644 --- a/clients/client-quicksight/src/commands/StartAssetBundleImportJobCommand.ts +++ b/clients/client-quicksight/src/commands/StartAssetBundleImportJobCommand.ts @@ -41,7 +41,7 @@ export interface StartAssetBundleImportJobCommandOutput extends StartAssetBundle /** * @public *

Starts an Asset Bundle import job.

- *

An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 10 import jobs concurrently.

+ *

An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.

*

The API caller must have the necessary "create", "describe", and "update" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-quicksight/src/commands/UpdateAnalysisCommand.ts b/clients/client-quicksight/src/commands/UpdateAnalysisCommand.ts index 9475f9a8c0db..efceea5a146d 100644 --- a/clients/client-quicksight/src/commands/UpdateAnalysisCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateAnalysisCommand.ts @@ -1676,6 +1676,14 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { // SmallMultiplesAxisProperties + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, * }, * CategoryAxis: { // AxisDisplayOptions * TickLabelOptions: { // AxisTickLabelOptions @@ -2390,6 +2398,14 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, * }, * CategoryLabelOptions: { * Visibility: "HIDDEN" || "VISIBLE", @@ -2787,6 +2803,11 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: "", * }, * XAxisDisplayOptions: { * TickLabelOptions: { @@ -4320,7 +4341,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * { // AggregationSortConfiguration * Column: "", // required * SortDirection: "ASC" || "DESC", // required - * AggregationFunction: "", // required + * AggregationFunction: "", * }, * ], * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", @@ -4354,6 +4375,15 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * DateTimeFormatConfiguration: "", * }, * Role: "DIMENSION" || "MEASURE", + * ColorsConfiguration: { // ColorsConfiguration + * CustomColors: [ // CustomColorsList + * { // CustomColor + * FieldValue: "STRING_VALUE", + * Color: "STRING_VALUE", // required + * SpecialValue: "EMPTY" || "NULL" || "OTHER", + * }, + * ], + * }, * }, * ], * AnalysisDefaults: { // AnalysisDefaults diff --git a/clients/client-quicksight/src/commands/UpdateDashboardCommand.ts b/clients/client-quicksight/src/commands/UpdateDashboardCommand.ts index 81303dc7e4d7..efa45b249203 100644 --- a/clients/client-quicksight/src/commands/UpdateDashboardCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateDashboardCommand.ts @@ -1721,6 +1721,14 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { // SmallMultiplesAxisProperties + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, * }, * CategoryAxis: { // AxisDisplayOptions * TickLabelOptions: { // AxisTickLabelOptions @@ -2435,6 +2443,14 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, * }, * CategoryLabelOptions: { * Visibility: "HIDDEN" || "VISIBLE", @@ -2832,6 +2848,11 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: "", * }, * XAxisDisplayOptions: { * TickLabelOptions: { @@ -4365,7 +4386,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * { // AggregationSortConfiguration * Column: "", // required * SortDirection: "ASC" || "DESC", // required - * AggregationFunction: "", // required + * AggregationFunction: "", * }, * ], * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", @@ -4399,6 +4420,15 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * DateTimeFormatConfiguration: "", * }, * Role: "DIMENSION" || "MEASURE", + * ColorsConfiguration: { // ColorsConfiguration + * CustomColors: [ // CustomColorsList + * { // CustomColor + * FieldValue: "STRING_VALUE", + * Color: "STRING_VALUE", // required + * SpecialValue: "EMPTY" || "NULL" || "OTHER", + * }, + * ], + * }, * }, * ], * AnalysisDefaults: { // AnalysisDefaults diff --git a/clients/client-quicksight/src/commands/UpdateTemplateAliasCommand.ts b/clients/client-quicksight/src/commands/UpdateTemplateAliasCommand.ts index f9cff4551177..fc138d9baf5b 100644 --- a/clients/client-quicksight/src/commands/UpdateTemplateAliasCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateTemplateAliasCommand.ts @@ -13,7 +13,8 @@ import { SerdeContext as __SerdeContext, } from "@smithy/types"; -import { UpdateTemplateAliasRequest, UpdateTemplateAliasResponse } from "../models/models_3"; +import { UpdateTemplateAliasRequest } from "../models/models_3"; +import { UpdateTemplateAliasResponse } from "../models/models_4"; 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 63f31b8ebf27..aac377131235 100644 --- a/clients/client-quicksight/src/commands/UpdateTemplateCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateTemplateCommand.ts @@ -1663,6 +1663,14 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { // SmallMultiplesAxisProperties + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, * }, * CategoryAxis: { // AxisDisplayOptions * TickLabelOptions: { // AxisTickLabelOptions @@ -2377,6 +2385,14 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, * }, * CategoryLabelOptions: { * Visibility: "HIDDEN" || "VISIBLE", @@ -2774,6 +2790,11 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, + * XAxis: { + * Scale: "SHARED" || "INDEPENDENT", + * Placement: "OUTSIDE" || "INSIDE", + * }, + * YAxis: "", * }, * XAxisDisplayOptions: { * TickLabelOptions: { @@ -4307,7 +4328,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * { // AggregationSortConfiguration * Column: "", // required * SortDirection: "ASC" || "DESC", // required - * AggregationFunction: "", // required + * AggregationFunction: "", * }, * ], * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", @@ -4341,6 +4362,15 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * DateTimeFormatConfiguration: "", * }, * Role: "DIMENSION" || "MEASURE", + * ColorsConfiguration: { // ColorsConfiguration + * CustomColors: [ // CustomColorsList + * { // CustomColor + * FieldValue: "STRING_VALUE", + * Color: "STRING_VALUE", // required + * SpecialValue: "EMPTY" || "NULL" || "OTHER", + * }, + * ], + * }, * }, * ], * AnalysisDefaults: { // AnalysisDefaults diff --git a/clients/client-quicksight/src/commands/UpdateTemplatePermissionsCommand.ts b/clients/client-quicksight/src/commands/UpdateTemplatePermissionsCommand.ts index e4b5b96fc052..080488544a9b 100644 --- a/clients/client-quicksight/src/commands/UpdateTemplatePermissionsCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateTemplatePermissionsCommand.ts @@ -13,7 +13,7 @@ import { SerdeContext as __SerdeContext, } from "@smithy/types"; -import { UpdateTemplatePermissionsRequest, UpdateTemplatePermissionsResponse } from "../models/models_3"; +import { UpdateTemplatePermissionsRequest, UpdateTemplatePermissionsResponse } from "../models/models_4"; 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 08d83fb52f50..10067b7b64e6 100644 --- a/clients/client-quicksight/src/commands/UpdateThemeAliasCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateThemeAliasCommand.ts @@ -13,8 +13,7 @@ import { SerdeContext as __SerdeContext, } from "@smithy/types"; -import { UpdateThemeAliasRequest } from "../models/models_3"; -import { UpdateThemeAliasResponse } from "../models/models_4"; +import { UpdateThemeAliasRequest, UpdateThemeAliasResponse } from "../models/models_4"; 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 0028107bfdbc..9a4d27816578 100644 --- a/clients/client-quicksight/src/commands/UpdateThemeCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateThemeCommand.ts @@ -13,7 +13,7 @@ import { SerdeContext as __SerdeContext, } from "@smithy/types"; -import { UpdateThemeRequest, UpdateThemeResponse } from "../models/models_3"; +import { UpdateThemeRequest, UpdateThemeResponse } from "../models/models_4"; import { de_UpdateThemeCommand, se_UpdateThemeCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/models/models_0.ts b/clients/client-quicksight/src/models/models_0.ts index 162b56b901f2..18527148c05e 100644 --- a/clients/client-quicksight/src/models/models_0.ts +++ b/clients/client-quicksight/src/models/models_0.ts @@ -432,7 +432,7 @@ export interface AggregationSortConfiguration { /** *

The function that aggregates the values in Column.

*/ - AggregationFunction: AggregationFunction | undefined; + AggregationFunction?: AggregationFunction; } /** @@ -914,6 +914,53 @@ export interface CalculatedField { Expression: string | undefined; } +/** + * @public + * @enum + */ +export const SpecialValue = { + EMPTY: "EMPTY", + NULL: "NULL", + OTHER: "OTHER", +} as const; + +/** + * @public + */ +export type SpecialValue = (typeof SpecialValue)[keyof typeof SpecialValue]; + +/** + * @public + *

Determines the color that's applied to a particular data value in a column.

+ */ +export interface CustomColor { + /** + *

The data value that the color is applied to.

+ */ + FieldValue?: string; + + /** + *

The color that is applied to the data value.

+ */ + Color: string | undefined; + + /** + *

The value of a special data value.

+ */ + SpecialValue?: SpecialValue | string; +} + +/** + * @public + *

The color configurations for a column.

+ */ +export interface ColorsConfiguration { + /** + *

A list of up to 50 custom colors.

+ */ + CustomColors?: CustomColor[]; +} + /** * @public *

The options that determine the null value format configuration.

@@ -1287,6 +1334,11 @@ export interface ColumnConfiguration { *

The role of the column.

*/ Role?: ColumnRole | string; + + /** + *

The color configurations of the column.

+ */ + ColorsConfiguration?: ColorsConfiguration; } /** @@ -5795,6 +5847,51 @@ export interface PanelConfiguration { BackgroundColor?: string; } +/** + * @public + * @enum + */ +export const SmallMultiplesAxisPlacement = { + INSIDE: "INSIDE", + OUTSIDE: "OUTSIDE", +} as const; + +/** + * @public + */ +export type SmallMultiplesAxisPlacement = + (typeof SmallMultiplesAxisPlacement)[keyof typeof SmallMultiplesAxisPlacement]; + +/** + * @public + * @enum + */ +export const SmallMultiplesAxisScale = { + INDEPENDENT: "INDEPENDENT", + SHARED: "SHARED", +} as const; + +/** + * @public + */ +export type SmallMultiplesAxisScale = (typeof SmallMultiplesAxisScale)[keyof typeof SmallMultiplesAxisScale]; + +/** + * @public + *

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

+ */ +export interface SmallMultiplesAxisProperties { + /** + *

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

+ */ + Scale?: SmallMultiplesAxisScale | string; + + /** + *

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

+ */ + Placement?: SmallMultiplesAxisPlacement | string; +} + /** * @public *

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

@@ -5818,6 +5915,16 @@ export interface SmallMultiplesOptions { *

Configures the display options for each small multiples panel.

*/ PanelConfiguration?: PanelConfiguration; + + /** + *

The properties of a small multiples X axis.

+ */ + XAxis?: SmallMultiplesAxisProperties; + + /** + *

The properties of a small multiples Y axis.

+ */ + YAxis?: SmallMultiplesAxisProperties; } /** @@ -6644,189 +6751,27 @@ export interface PaginationConfiguration { } /** - * @public - *

The sort configuration of a BoxPlotVisual.

- */ -export interface BoxPlotSortConfiguration { - /** - *

The sort configuration of a group by fields.

- */ - CategorySort?: FieldSortOptions[]; - - /** - *

The pagination configuration of a table visual or box plot.

- */ - PaginationConfiguration?: PaginationConfiguration; -} - -/** - * @public - *

The configuration of a BoxPlotVisual.

- */ -export interface BoxPlotChartConfiguration { - /** - *

The field wells of the visual.

- */ - FieldWells?: BoxPlotFieldWells; - - /** - *

The sort configuration of a BoxPlotVisual.

- */ - SortConfiguration?: BoxPlotSortConfiguration; - - /** - *

The box plot chart options for a box plot visual

- */ - BoxPlotOptions?: BoxPlotOptions; - - /** - *

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

- */ - CategoryAxis?: AxisDisplayOptions; - - /** - *

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

- */ - CategoryLabelOptions?: ChartAxisLabelOptions; - - /** - *

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

- */ - PrimaryYAxisDisplayOptions?: AxisDisplayOptions; - - /** - *

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

- */ - PrimaryYAxisLabelOptions?: ChartAxisLabelOptions; - - /** - *

The options for the legend setup of a visual.

- */ - Legend?: LegendOptions; - - /** - *

The tooltip display setup of the visual.

- */ - Tooltip?: TooltipOptions; - - /** - *

The reference line setup of the visual.

- */ - ReferenceLines?: ReferenceLine[]; - - /** - *

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

- */ - VisualPalette?: VisualPalette; -} - -/** - * @public - *

A box plot.

- *

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

- */ -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..

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

The title that is displayed on the visual.

- */ - Title?: VisualTitleLabelOptions; - - /** - *

The subtitle that is displayed on the visual.

- */ - Subtitle?: VisualSubtitleLabelOptions; - - /** - *

The configuration settings of the visual.

- */ - ChartConfiguration?: BoxPlotChartConfiguration; - - /** - *

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

- */ - Actions?: VisualCustomAction[]; - - /** - *

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

- */ - ColumnHierarchies?: ColumnHierarchy[]; -} - -/** - * @public - *

The aggregated field wells of a combo chart.

- */ -export interface ComboChartAggregatedFieldWells { - /** - *

The aggregated category field wells of a combo chart.

- */ - Category?: DimensionField[]; - - /** - *

The aggregated BarValues field well of a combo chart.

- */ - BarValues?: MeasureField[]; - - /** - *

The aggregated colors field well of a combo chart.

- */ - Colors?: DimensionField[]; - - /** - *

The aggregated LineValues field well of a combo chart.

- */ - LineValues?: MeasureField[]; -} - -/** - * @public - *

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.

+ * @internal */ -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.

- */ - ComboChartAggregatedFieldWells?: ComboChartAggregatedFieldWells; -} +export const CalculatedFieldFilterSensitiveLog = (obj: CalculatedField): any => ({ + ...obj, + ...(obj.Expression && { Expression: SENSITIVE_STRING }), +}); /** - * @public - *

The sort configuration of a ComboChartVisual.

+ * @internal */ -export interface ComboChartSortConfiguration { - /** - *

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

- */ - CategorySort?: FieldSortOptions[]; - - /** - *

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

- */ - CategoryItemsLimit?: ItemsLimitConfiguration; - - /** - *

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

- */ - ColorSort?: FieldSortOptions[]; - - /** - *

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

- */ - ColorItemsLimit?: ItemsLimitConfiguration; -} +export const CustomColorFilterSensitiveLog = (obj: CustomColor): any => ({ + ...obj, + ...(obj.FieldValue && { FieldValue: SENSITIVE_STRING }), +}); /** * @internal */ -export const CalculatedFieldFilterSensitiveLog = (obj: CalculatedField): any => ({ +export const ColorsConfigurationFilterSensitiveLog = (obj: ColorsConfiguration): any => ({ ...obj, - ...(obj.Expression && { Expression: SENSITIVE_STRING }), + ...(obj.CustomColors && { CustomColors: obj.CustomColors.map((item) => CustomColorFilterSensitiveLog(item)) }), }); /** @@ -6957,6 +6902,9 @@ export const ColumnConfigurationFilterSensitiveLog = (obj: ColumnConfiguration): ...(obj.FormatConfiguration && { FormatConfiguration: FormatConfigurationFilterSensitiveLog(obj.FormatConfiguration), }), + ...(obj.ColorsConfiguration && { + ColorsConfiguration: ColorsConfigurationFilterSensitiveLog(obj.ColorsConfiguration), + }), }); /** @@ -7519,37 +7467,3 @@ export const BoxPlotAggregatedFieldWellsFilterSensitiveLog = (obj: BoxPlotAggreg export const BoxPlotFieldWellsFilterSensitiveLog = (obj: BoxPlotFieldWells): any => ({ ...obj, }); - -/** - * @internal - */ -export const BoxPlotChartConfigurationFilterSensitiveLog = (obj: BoxPlotChartConfiguration): any => ({ - ...obj, - ...(obj.ReferenceLines && { - ReferenceLines: obj.ReferenceLines.map((item) => ReferenceLineFilterSensitiveLog(item)), - }), - ...(obj.VisualPalette && { VisualPalette: VisualPaletteFilterSensitiveLog(obj.VisualPalette) }), -}); - -/** - * @internal - */ -export const BoxPlotVisualFilterSensitiveLog = (obj: BoxPlotVisual): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const ComboChartAggregatedFieldWellsFilterSensitiveLog = (obj: ComboChartAggregatedFieldWells): any => ({ - ...obj, - ...(obj.BarValues && { BarValues: obj.BarValues.map((item) => MeasureFieldFilterSensitiveLog(item)) }), - ...(obj.LineValues && { LineValues: obj.LineValues.map((item) => MeasureFieldFilterSensitiveLog(item)) }), -}); - -/** - * @internal - */ -export const ComboChartFieldWellsFilterSensitiveLog = (obj: ComboChartFieldWells): any => ({ - ...obj, -}); diff --git a/clients/client-quicksight/src/models/models_1.ts b/clients/client-quicksight/src/models/models_1.ts index 5429dc066668..866be1c4d1aa 100644 --- a/clients/client-quicksight/src/models/models_1.ts +++ b/clients/client-quicksight/src/models/models_1.ts @@ -7,7 +7,8 @@ import { AxisDisplayOptions, BarChartVisual, BarsArrangement, - BoxPlotVisual, + BoxPlotFieldWells, + BoxPlotOptions, CalculatedField, CalculatedFieldFilterSensitiveLog, ChartAxisLabelOptions, @@ -16,8 +17,6 @@ import { ColumnHierarchy, ColumnIdentifier, ColumnSort, - ComboChartFieldWells, - ComboChartSortConfiguration, ContributionAnalysisDefault, DataLabelOptions, DataLabelOptionsFilterSensitiveLog, @@ -67,6 +66,184 @@ import { WidgetStatus, } from "./models_0"; +/** + * @public + *

The sort configuration of a BoxPlotVisual.

+ */ +export interface BoxPlotSortConfiguration { + /** + *

The sort configuration of a group by fields.

+ */ + CategorySort?: FieldSortOptions[]; + + /** + *

The pagination configuration of a table visual or box plot.

+ */ + PaginationConfiguration?: PaginationConfiguration; +} + +/** + * @public + *

The configuration of a BoxPlotVisual.

+ */ +export interface BoxPlotChartConfiguration { + /** + *

The field wells of the visual.

+ */ + FieldWells?: BoxPlotFieldWells; + + /** + *

The sort configuration of a BoxPlotVisual.

+ */ + SortConfiguration?: BoxPlotSortConfiguration; + + /** + *

The box plot chart options for a box plot visual

+ */ + BoxPlotOptions?: BoxPlotOptions; + + /** + *

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

+ */ + CategoryAxis?: AxisDisplayOptions; + + /** + *

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

+ */ + CategoryLabelOptions?: ChartAxisLabelOptions; + + /** + *

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

+ */ + PrimaryYAxisDisplayOptions?: AxisDisplayOptions; + + /** + *

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

+ */ + PrimaryYAxisLabelOptions?: ChartAxisLabelOptions; + + /** + *

The options for the legend setup of a visual.

+ */ + Legend?: LegendOptions; + + /** + *

The tooltip display setup of the visual.

+ */ + Tooltip?: TooltipOptions; + + /** + *

The reference line setup of the visual.

+ */ + ReferenceLines?: ReferenceLine[]; + + /** + *

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

+ */ + VisualPalette?: VisualPalette; +} + +/** + * @public + *

A box plot.

+ *

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

+ */ +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..

+ */ + VisualId: string | undefined; + + /** + *

The title that is displayed on the visual.

+ */ + Title?: VisualTitleLabelOptions; + + /** + *

The subtitle that is displayed on the visual.

+ */ + Subtitle?: VisualSubtitleLabelOptions; + + /** + *

The configuration settings of the visual.

+ */ + ChartConfiguration?: BoxPlotChartConfiguration; + + /** + *

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

+ */ + Actions?: VisualCustomAction[]; + + /** + *

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

+ */ + ColumnHierarchies?: ColumnHierarchy[]; +} + +/** + * @public + *

The aggregated field wells of a combo chart.

+ */ +export interface ComboChartAggregatedFieldWells { + /** + *

The aggregated category field wells of a combo chart.

+ */ + Category?: DimensionField[]; + + /** + *

The aggregated BarValues field well of a combo chart.

+ */ + BarValues?: MeasureField[]; + + /** + *

The aggregated colors field well of a combo chart.

+ */ + Colors?: DimensionField[]; + + /** + *

The aggregated LineValues field well of a combo chart.

+ */ + LineValues?: MeasureField[]; +} + +/** + * @public + *

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.

+ */ +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.

+ */ + ComboChartAggregatedFieldWells?: ComboChartAggregatedFieldWells; +} + +/** + * @public + *

The sort configuration of a ComboChartVisual.

+ */ +export interface ComboChartSortConfiguration { + /** + *

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

+ */ + CategorySort?: FieldSortOptions[]; + + /** + *

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

+ */ + CategoryItemsLimit?: ItemsLimitConfiguration; + + /** + *

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

+ */ + ColorSort?: FieldSortOptions[]; + + /** + *

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

+ */ + ColorItemsLimit?: ItemsLimitConfiguration; +} + /** * @public *

The configuration of a ComboChartVisual.

@@ -6830,105 +7007,38 @@ export interface AssetBundleImportJobDataSetOverrideParameters { } /** - * @public - *

A username and password credential pair to use to import a data source resource.

- */ -export interface AssetBundleImportJobDataSourceCredentialPair { - /** - *

The username for the data source connection.

- */ - Username: string | undefined; - - /** - *

The password for the data source connection.

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

The login credentials to use to import a data source resource.

- */ -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.

- */ - CredentialPair?: AssetBundleImportJobDataSourceCredentialPair; - - /** - *

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.

- */ - SecretArn?: string; -} - -/** - * @public - *

Parameters for Amazon Athena.

+ * @internal */ -export interface AthenaParameters { - /** - *

The workgroup that Amazon Athena uses.

- */ - WorkGroup?: string; - - /** - *

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.

- */ - RoleArn?: string; -} +export const BoxPlotChartConfigurationFilterSensitiveLog = (obj: BoxPlotChartConfiguration): any => ({ + ...obj, + ...(obj.ReferenceLines && { + ReferenceLines: obj.ReferenceLines.map((item) => ReferenceLineFilterSensitiveLog(item)), + }), + ...(obj.VisualPalette && { VisualPalette: VisualPaletteFilterSensitiveLog(obj.VisualPalette) }), +}); /** - * @public - *

Parameters for Amazon Aurora.

+ * @internal */ -export interface AuroraParameters { - /** - *

Host.

- */ - Host: string | undefined; - - /** - *

Port.

- */ - Port: number | undefined; - - /** - *

Database.

- */ - Database: string | undefined; -} +export const BoxPlotVisualFilterSensitiveLog = (obj: BoxPlotVisual): any => ({ + ...obj, +}); /** - * @public - *

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

+ * @internal */ -export interface AuroraPostgreSqlParameters { - /** - *

The Amazon Aurora PostgreSQL-Compatible host to connect to.

- */ - Host: string | undefined; - - /** - *

The port that Amazon Aurora PostgreSQL is listening on.

- */ - Port: number | undefined; - - /** - *

The Amazon Aurora PostgreSQL database to connect to.

- */ - Database: string | undefined; -} +export const ComboChartAggregatedFieldWellsFilterSensitiveLog = (obj: ComboChartAggregatedFieldWells): any => ({ + ...obj, + ...(obj.BarValues && { BarValues: obj.BarValues.map((item) => MeasureFieldFilterSensitiveLog(item)) }), + ...(obj.LineValues && { LineValues: obj.LineValues.map((item) => MeasureFieldFilterSensitiveLog(item)) }), +}); /** - * @public - *

The parameters for IoT Analytics.

+ * @internal */ -export interface AwsIotAnalyticsParameters { - /** - *

Dataset name.

- */ - DataSetName: string | undefined; -} +export const ComboChartFieldWellsFilterSensitiveLog = (obj: ComboChartFieldWells): any => ({ + ...obj, +}); /** * @internal @@ -8079,22 +8189,3 @@ export const AnalysisDefinitionFilterSensitiveLog = (obj: AnalysisDefinition): a ColumnConfigurations: obj.ColumnConfigurations.map((item) => ColumnConfigurationFilterSensitiveLog(item)), }), }); - -/** - * @internal - */ -export const AssetBundleImportJobDataSourceCredentialPairFilterSensitiveLog = ( - obj: AssetBundleImportJobDataSourceCredentialPair -): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const AssetBundleImportJobDataSourceCredentialsFilterSensitiveLog = ( - obj: AssetBundleImportJobDataSourceCredentials -): any => ({ - ...obj, - ...(obj.CredentialPair && { CredentialPair: SENSITIVE_STRING }), -}); diff --git a/clients/client-quicksight/src/models/models_2.ts b/clients/client-quicksight/src/models/models_2.ts index 63c58d953933..7364ca7f1598 100644 --- a/clients/client-quicksight/src/models/models_2.ts +++ b/clients/client-quicksight/src/models/models_2.ts @@ -30,18 +30,113 @@ import { AssetBundleImportJobAnalysisOverrideParameters, AssetBundleImportJobDashboardOverrideParameters, AssetBundleImportJobDataSetOverrideParameters, - AssetBundleImportJobDataSourceCredentials, - AssetBundleImportJobDataSourceCredentialsFilterSensitiveLog, - AthenaParameters, - AuroraParameters, - AuroraPostgreSqlParameters, - AwsIotAnalyticsParameters, DataSetReference, FilterOperator, SheetDefinition, } from "./models_1"; import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException"; +/** + * @public + *

A username and password credential pair to use to import a data source resource.

+ */ +export interface AssetBundleImportJobDataSourceCredentialPair { + /** + *

The username for the data source connection.

+ */ + Username: string | undefined; + + /** + *

The password for the data source connection.

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

The login credentials to use to import a data source resource.

+ */ +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.

+ */ + CredentialPair?: AssetBundleImportJobDataSourceCredentialPair; + + /** + *

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.

+ */ + SecretArn?: string; +} + +/** + * @public + *

Parameters for Amazon Athena.

+ */ +export interface AthenaParameters { + /** + *

The workgroup that Amazon Athena uses.

+ */ + WorkGroup?: string; + + /** + *

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.

+ */ + RoleArn?: string; +} + +/** + * @public + *

Parameters for Amazon Aurora.

+ */ +export interface AuroraParameters { + /** + *

Host.

+ */ + Host: string | undefined; + + /** + *

Port.

+ */ + Port: number | undefined; + + /** + *

Database.

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

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

+ */ +export interface AuroraPostgreSqlParameters { + /** + *

The Amazon Aurora PostgreSQL-Compatible host to connect to.

+ */ + Host: string | undefined; + + /** + *

The port that Amazon Aurora PostgreSQL is listening on.

+ */ + Port: number | undefined; + + /** + *

The Amazon Aurora PostgreSQL database to connect to.

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

The parameters for IoT Analytics.

+ */ +export interface AwsIotAnalyticsParameters { + /** + *

Dataset name.

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

The required parameters that are needed to connect to a Databricks data source.

@@ -1460,7 +1555,7 @@ export interface AssetBundleImportJobSummary { /** * @public - *

The source of the asset bundle zip file that contains the data that you want to import.

+ *

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.

*/ export interface AssetBundleImportSource { /** @@ -8448,132 +8543,23 @@ export interface DeleteFolderRequest { } /** - * @public - */ -export interface DeleteFolderResponse { - /** - *

The HTTP status of the request.

- */ - Status?: number; - - /** - *

The Amazon Resource Name of the deleted folder.

- */ - Arn?: string; - - /** - *

The ID of the folder.

- */ - FolderId?: string; - - /** - *

The Amazon Web Services request ID for this operation.

- */ - RequestId?: string; -} - -/** - * @public - */ -export interface DeleteFolderMembershipRequest { - /** - *

The ID for the Amazon Web Services account that contains the folder.

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

The Folder ID.

- */ - FolderId: string | undefined; - - /** - *

The ID of the asset (the dashboard, analysis, or dataset) that you want to delete.

- */ - MemberId: string | undefined; - - /** - *

The type of the member, including DASHBOARD, ANALYSIS, and DATASET - *

- */ - MemberType: MemberType | string | undefined; -} - -/** - * @public - */ -export interface DeleteFolderMembershipResponse { - /** - *

The HTTP status of the request.

- */ - Status?: number; - - /** - *

The Amazon Web Services request ID for this operation.

- */ - RequestId?: string; -} - -/** - * @public - */ -export interface DeleteGroupRequest { - /** - *

The name of the group that you want to delete.

- */ - 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.

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

The namespace of the group that you want to delete.

- */ - Namespace: string | undefined; -} - -/** - * @public + * @internal */ -export interface DeleteGroupResponse { - /** - *

The Amazon Web Services request ID for this operation.

- */ - RequestId?: string; - - /** - *

The HTTP status of the request.

- */ - Status?: number; -} +export const AssetBundleImportJobDataSourceCredentialPairFilterSensitiveLog = ( + obj: AssetBundleImportJobDataSourceCredentialPair +): any => ({ + ...obj, +}); /** - * @public + * @internal */ -export interface DeleteGroupMembershipRequest { - /** - *

The name of the user that you want to delete from the group membership.

- */ - MemberName: string | undefined; - - /** - *

The name of the group that you want to delete the user from.

- */ - 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.

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

The namespace of the group that you want to remove a user from.

- */ - Namespace: string | undefined; -} +export const AssetBundleImportJobDataSourceCredentialsFilterSensitiveLog = ( + obj: AssetBundleImportJobDataSourceCredentials +): any => ({ + ...obj, + ...(obj.CredentialPair && { CredentialPair: SENSITIVE_STRING }), +}); /** * @internal diff --git a/clients/client-quicksight/src/models/models_3.ts b/clients/client-quicksight/src/models/models_3.ts index abba2bd6dabf..071fb1298345 100644 --- a/clients/client-quicksight/src/models/models_3.ts +++ b/clients/client-quicksight/src/models/models_3.ts @@ -71,6 +71,7 @@ import { IngestionStatus, LogicalTable, LogicalTableFilterSensitiveLog, + MemberType, NamespaceStatus, PhysicalTable, RefreshSchedule, @@ -93,6 +94,134 @@ import { } from "./models_2"; import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException"; +/** + * @public + */ +export interface DeleteFolderResponse { + /** + *

The HTTP status of the request.

+ */ + Status?: number; + + /** + *

The Amazon Resource Name of the deleted folder.

+ */ + Arn?: string; + + /** + *

The ID of the folder.

+ */ + FolderId?: string; + + /** + *

The Amazon Web Services request ID for this operation.

+ */ + RequestId?: string; +} + +/** + * @public + */ +export interface DeleteFolderMembershipRequest { + /** + *

The ID for the Amazon Web Services account that contains the folder.

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

The Folder ID.

+ */ + FolderId: string | undefined; + + /** + *

The ID of the asset (the dashboard, analysis, or dataset) that you want to delete.

+ */ + MemberId: string | undefined; + + /** + *

The type of the member, including DASHBOARD, ANALYSIS, and DATASET + *

+ */ + MemberType: MemberType | string | undefined; +} + +/** + * @public + */ +export interface DeleteFolderMembershipResponse { + /** + *

The HTTP status of the request.

+ */ + Status?: number; + + /** + *

The Amazon Web Services request ID for this operation.

+ */ + RequestId?: string; +} + +/** + * @public + */ +export interface DeleteGroupRequest { + /** + *

The name of the group that you want to delete.

+ */ + 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.

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

The namespace of the group that you want to delete.

+ */ + Namespace: string | undefined; +} + +/** + * @public + */ +export interface DeleteGroupResponse { + /** + *

The Amazon Web Services request ID for this operation.

+ */ + RequestId?: string; + + /** + *

The HTTP status of the request.

+ */ + Status?: number; +} + +/** + * @public + */ +export interface DeleteGroupMembershipRequest { + /** + *

The name of the user that you want to delete from the group membership.

+ */ + MemberName: string | undefined; + + /** + *

The name of the group that you want to delete the user from.

+ */ + 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.

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

The namespace of the group that you want to remove a user from.

+ */ + Namespace: string | undefined; +} + /** * @public */ @@ -1043,7 +1172,7 @@ export interface DescribeAssetBundleExportJobResponse { IncludeAllDependencies?: boolean; /** - *

The format of the export.

+ *

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.

*/ ExportFormat?: AssetBundleExportFormat | string; @@ -6871,7 +7000,8 @@ export interface StartAssetBundleImportJobRequest { AssetBundleImportJobId: string | undefined; /** - *

The source of the asset bundle zip file that contains the data that you want to import.

+ *

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. + *

*/ AssetBundleImportSource: AssetBundleImportSource | undefined; @@ -8232,179 +8362,6 @@ export interface UpdateTemplateAliasRequest { TemplateVersionNumber: number | undefined; } -/** - * @public - */ -export interface UpdateTemplateAliasResponse { - /** - *

The template alias.

- */ - TemplateAlias?: TemplateAlias; - - /** - *

The HTTP status of the request.

- */ - Status?: number; - - /** - *

The Amazon Web Services request ID for this operation.

- */ - RequestId?: string; -} - -/** - * @public - */ -export interface UpdateTemplatePermissionsRequest { - /** - *

The ID of the Amazon Web Services account that contains the template.

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

The ID for the template.

- */ - TemplateId: string | undefined; - - /** - *

A list of resource permissions to be granted on the template.

- */ - GrantPermissions?: ResourcePermission[]; - - /** - *

A list of resource permissions to be revoked from the template.

- */ - RevokePermissions?: ResourcePermission[]; -} - -/** - * @public - */ -export interface UpdateTemplatePermissionsResponse { - /** - *

The ID for the template.

- */ - TemplateId?: string; - - /** - *

The Amazon Resource Name (ARN) of the template.

- */ - TemplateArn?: string; - - /** - *

A list of resource permissions to be set on the template.

- */ - Permissions?: ResourcePermission[]; - - /** - *

The Amazon Web Services request ID for this operation.

- */ - RequestId?: string; - - /** - *

The HTTP status of the request.

- */ - Status?: number; -} - -/** - * @public - */ -export interface UpdateThemeRequest { - /** - *

The ID of the Amazon Web Services account that contains the theme that you're updating.

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

The ID for the theme.

- */ - ThemeId: string | undefined; - - /** - *

The name for the theme.

- */ - Name?: string; - - /** - *

The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. - * All themes initially inherit from a default Amazon QuickSight theme.

- */ - 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.

- */ - VersionDescription?: string; - - /** - *

The theme configuration, which contains the theme display properties.

- */ - Configuration?: ThemeConfiguration; -} - -/** - * @public - */ -export interface UpdateThemeResponse { - /** - *

The ID for the theme.

- */ - ThemeId?: string; - - /** - *

The Amazon Resource Name (ARN) for the theme.

- */ - Arn?: string; - - /** - *

The Amazon Resource Name (ARN) for the new version of the theme.

- */ - VersionArn?: string; - - /** - *

The creation status of the theme.

- */ - CreationStatus?: ResourceStatus | string; - - /** - *

The HTTP status of the request.

- */ - Status?: number; - - /** - *

The Amazon Web Services request ID for this operation.

- */ - RequestId?: string; -} - -/** - * @public - */ -export interface UpdateThemeAliasRequest { - /** - *

The ID of the Amazon Web Services account that contains the theme alias that you're updating.

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

The ID for the theme.

- */ - ThemeId: string | undefined; - - /** - *

The name of the theme alias that you want to update.

- */ - AliasName: string | undefined; - - /** - *

The version number of the theme that the alias should reference.

- */ - ThemeVersionNumber: number | undefined; -} - /** * @internal */ diff --git a/clients/client-quicksight/src/models/models_4.ts b/clients/client-quicksight/src/models/models_4.ts index 298a3996e9f8..4e3785c6b217 100644 --- a/clients/client-quicksight/src/models/models_4.ts +++ b/clients/client-quicksight/src/models/models_4.ts @@ -1,7 +1,10 @@ // smithy-typescript generated code +import { ResourceStatus } from "./models_0"; import { ResourcePermission, + TemplateAlias, ThemeAlias, + ThemeConfiguration, TopicDetails, TopicRefreshSchedule, VPCConnectionAvailabilityStatus, @@ -9,6 +12,179 @@ import { } from "./models_2"; import { User, UserRole } from "./models_3"; +/** + * @public + */ +export interface UpdateTemplateAliasResponse { + /** + *

The template alias.

+ */ + TemplateAlias?: TemplateAlias; + + /** + *

The HTTP status of the request.

+ */ + Status?: number; + + /** + *

The Amazon Web Services request ID for this operation.

+ */ + RequestId?: string; +} + +/** + * @public + */ +export interface UpdateTemplatePermissionsRequest { + /** + *

The ID of the Amazon Web Services account that contains the template.

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

The ID for the template.

+ */ + TemplateId: string | undefined; + + /** + *

A list of resource permissions to be granted on the template.

+ */ + GrantPermissions?: ResourcePermission[]; + + /** + *

A list of resource permissions to be revoked from the template.

+ */ + RevokePermissions?: ResourcePermission[]; +} + +/** + * @public + */ +export interface UpdateTemplatePermissionsResponse { + /** + *

The ID for the template.

+ */ + TemplateId?: string; + + /** + *

The Amazon Resource Name (ARN) of the template.

+ */ + TemplateArn?: string; + + /** + *

A list of resource permissions to be set on the template.

+ */ + Permissions?: ResourcePermission[]; + + /** + *

The Amazon Web Services request ID for this operation.

+ */ + RequestId?: string; + + /** + *

The HTTP status of the request.

+ */ + Status?: number; +} + +/** + * @public + */ +export interface UpdateThemeRequest { + /** + *

The ID of the Amazon Web Services account that contains the theme that you're updating.

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

The ID for the theme.

+ */ + ThemeId: string | undefined; + + /** + *

The name for the theme.

+ */ + Name?: string; + + /** + *

The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. + * All themes initially inherit from a default Amazon QuickSight theme.

+ */ + 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.

+ */ + VersionDescription?: string; + + /** + *

The theme configuration, which contains the theme display properties.

+ */ + Configuration?: ThemeConfiguration; +} + +/** + * @public + */ +export interface UpdateThemeResponse { + /** + *

The ID for the theme.

+ */ + ThemeId?: string; + + /** + *

The Amazon Resource Name (ARN) for the theme.

+ */ + Arn?: string; + + /** + *

The Amazon Resource Name (ARN) for the new version of the theme.

+ */ + VersionArn?: string; + + /** + *

The creation status of the theme.

+ */ + CreationStatus?: ResourceStatus | string; + + /** + *

The HTTP status of the request.

+ */ + Status?: number; + + /** + *

The Amazon Web Services request ID for this operation.

+ */ + RequestId?: string; +} + +/** + * @public + */ +export interface UpdateThemeAliasRequest { + /** + *

The ID of the Amazon Web Services account that contains the theme alias that you're updating.

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

The ID for the theme.

+ */ + ThemeId: string | undefined; + + /** + *

The name of the theme alias that you want to update.

+ */ + AliasName: string | undefined; + + /** + *

The version number of the theme that the alias should reference.

+ */ + ThemeVersionNumber: number | undefined; +} + /** * @public */ diff --git a/clients/client-quicksight/src/protocols/Aws_restJson1.ts b/clients/client-quicksight/src/protocols/Aws_restJson1.ts index 6f407ab8ebf5..e43acdcdde34 100644 --- a/clients/client-quicksight/src/protocols/Aws_restJson1.ts +++ b/clients/client-quicksight/src/protocols/Aws_restJson1.ts @@ -458,12 +458,9 @@ import { BodySectionConfiguration, BodySectionContent, BoxPlotAggregatedFieldWells, - BoxPlotChartConfiguration, BoxPlotFieldWells, BoxPlotOptions, - BoxPlotSortConfiguration, BoxPlotStyleOptions, - BoxPlotVisual, CalculatedField, CalculatedMeasureField, CascadingControlConfiguration, @@ -474,20 +471,19 @@ import { CategoryFilter, CategoryFilterConfiguration, ChartAxisLabelOptions, + ColorsConfiguration, ColumnConfiguration, ColumnHierarchy, ColumnIdentifier, ColumnSort, ColumnTooltipItem, - ComboChartAggregatedFieldWells, - ComboChartFieldWells, - ComboChartSortConfiguration, ContributionAnalysisDefault, CurrencyDisplayFormatConfiguration, CustomActionFilterOperation, CustomActionNavigationOperation, CustomActionSetParametersOperation, CustomActionURLOperation, + CustomColor, CustomFilterConfiguration, CustomFilterListConfiguration, CustomParameterValues, @@ -639,6 +635,7 @@ import { SheetVisualScopingConfiguration, ShortFormatText, SliderControlDisplayOptions, + SmallMultiplesAxisProperties, SmallMultiplesOptions, Spacing, StringDefaultValues, @@ -697,18 +694,18 @@ import { AssetBundleImportJobAnalysisOverrideParameters, AssetBundleImportJobDashboardOverrideParameters, AssetBundleImportJobDataSetOverrideParameters, - AssetBundleImportJobDataSourceCredentialPair, - AssetBundleImportJobDataSourceCredentials, - AthenaParameters, - AuroraParameters, - AuroraPostgreSqlParameters, - AwsIotAnalyticsParameters, BinCountOptions, BinWidthOptions, + BoxPlotChartConfiguration, + BoxPlotSortConfiguration, + BoxPlotVisual, ClusterMarker, ClusterMarkerConfiguration, ColorScale, + ComboChartAggregatedFieldWells, ComboChartConfiguration, + ComboChartFieldWells, + ComboChartSortConfiguration, ComboChartVisual, ComparisonConfiguration, ComparisonFormatConfiguration, @@ -918,6 +915,8 @@ import { } from "../models/models_1"; import { _Parameters, + AssetBundleImportJobDataSourceCredentialPair, + AssetBundleImportJobDataSourceCredentials, AssetBundleImportJobDataSourceOverrideParameters, AssetBundleImportJobOverrideParameters, AssetBundleImportJobRefreshScheduleOverrideParameters, @@ -926,7 +925,11 @@ import { AssetBundleImportJobThemeOverrideParameters, AssetBundleImportJobVPCConnectionOverrideParameters, AssetBundleImportSource, + AthenaParameters, + AuroraParameters, + AuroraPostgreSqlParameters, AuthorSpecifiedAggregation, + AwsIotAnalyticsParameters, BookmarksConfigurations, BorderStyle, CalculatedColumn, @@ -19137,6 +19140,8 @@ const se_ColorScaleColorList = (input: DataColor[], context: __SerdeContext): an }); }; +// se_ColorsConfiguration omitted. + // se_ColumnConfiguration omitted. // se_ColumnConfigurationList omitted. @@ -19393,6 +19398,10 @@ const se_CustomActionSetParametersOperation = ( // se_CustomActionURLOperation omitted. +// se_CustomColor omitted. + +// se_CustomColorsList omitted. + // se_CustomContentConfiguration omitted. /** @@ -22265,6 +22274,8 @@ const se_SheetDefinitionList = (input: SheetDefinition[], context: __SerdeContex // se_SliderControlDisplayOptions omitted. +// se_SmallMultiplesAxisProperties omitted. + // se_SmallMultiplesDimensionFieldList omitted. // se_SmallMultiplesOptions omitted. @@ -23794,6 +23805,8 @@ const de_ColorScaleColorList = (output: any, context: __SerdeContext): DataColor return retVal; }; +// de_ColorsConfiguration omitted. + // de_ColumnConfiguration omitted. // de_ColumnConfigurationList omitted. @@ -24050,6 +24063,10 @@ const de_CustomActionSetParametersOperation = ( // de_CustomActionURLOperation omitted. +// de_CustomColor omitted. + +// de_CustomColorsList omitted. + // de_CustomContentConfiguration omitted. /** @@ -27165,6 +27182,8 @@ const de_SheetDefinitionList = (output: any, context: __SerdeContext): SheetDefi // de_SliderControlDisplayOptions omitted. +// de_SmallMultiplesAxisProperties omitted. + // de_SmallMultiplesDimensionFieldList omitted. // de_SmallMultiplesOptions omitted. diff --git a/codegen/sdk-codegen/aws-models/quicksight.json b/codegen/sdk-codegen/aws-models/quicksight.json index ed86f41ec95d..6b81dde83412 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.json +++ b/codegen/sdk-codegen/aws-models/quicksight.json @@ -271,8 +271,7 @@ "AggregationFunction": { "target": "com.amazonaws.quicksight#AggregationFunction", "traits": { - "smithy.api#documentation": "

The function that aggregates the values in Column.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The function that aggregates the values in Column.

" } } }, @@ -2249,7 +2248,7 @@ } }, "traits": { - "smithy.api#documentation": "

The source of the asset bundle zip file that contains the data that you want to import.

" + "smithy.api#documentation": "

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.

" } }, "com.amazonaws.quicksight#AssetBundleImportSourceDescription": { @@ -4263,6 +4262,20 @@ } } }, + "com.amazonaws.quicksight#ColorsConfiguration": { + "type": "structure", + "members": { + "CustomColors": { + "target": "com.amazonaws.quicksight#CustomColorsList", + "traits": { + "smithy.api#documentation": "

A list of up to 50 custom colors.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The color configurations for a column.

" + } + }, "com.amazonaws.quicksight#ColumnConfiguration": { "type": "structure", "members": { @@ -4284,6 +4297,12 @@ "traits": { "smithy.api#documentation": "

The role of the column.

" } + }, + "ColorsConfiguration": { + "target": "com.amazonaws.quicksight#ColorsConfiguration", + "traits": { + "smithy.api#documentation": "

The color configurations of the column.

" + } } }, "traits": { @@ -8615,6 +8634,45 @@ "smithy.api#documentation": "

The URL operation that opens a link to another webpage.

" } }, + "com.amazonaws.quicksight#CustomColor": { + "type": "structure", + "members": { + "FieldValue": { + "target": "com.amazonaws.quicksight#FieldValue", + "traits": { + "smithy.api#documentation": "

The data value that the color is applied to.

" + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color that is applied to the data value.

", + "smithy.api#required": {} + } + }, + "SpecialValue": { + "target": "com.amazonaws.quicksight#SpecialValue", + "traits": { + "smithy.api#documentation": "

The value of a special data value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the color that's applied to a particular data value in a column.

" + } + }, + "com.amazonaws.quicksight#CustomColorsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CustomColor" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.quicksight#CustomContentConfiguration": { "type": "structure", "members": { @@ -15190,7 +15248,7 @@ "ExportFormat": { "target": "com.amazonaws.quicksight#AssetBundleExportFormat", "traits": { - "smithy.api#documentation": "

The format of the export.

" + "smithy.api#documentation": "

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.

" } }, "CloudFormationOverridePropertyConfiguration": { @@ -38987,6 +39045,60 @@ "smithy.api#documentation": "

The display options of a control.

" } }, + "com.amazonaws.quicksight#SmallMultiplesAxisPlacement": { + "type": "enum", + "members": { + "OUTSIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTSIDE" + } + }, + "INSIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSIDE" + } + } + } + }, + "com.amazonaws.quicksight#SmallMultiplesAxisProperties": { + "type": "structure", + "members": { + "Scale": { + "target": "com.amazonaws.quicksight#SmallMultiplesAxisScale", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "Placement": { + "target": "com.amazonaws.quicksight#SmallMultiplesAxisPlacement", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "com.amazonaws.quicksight#SmallMultiplesAxisScale": { + "type": "enum", + "members": { + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED" + } + }, + "INDEPENDENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INDEPENDENT" + } + } + } + }, "com.amazonaws.quicksight#SmallMultiplesDimensionFieldList": { "type": "list", "member": { @@ -39019,6 +39131,18 @@ "traits": { "smithy.api#documentation": "

Configures the display options for each small multiples panel.

" } + }, + "XAxis": { + "target": "com.amazonaws.quicksight#SmallMultiplesAxisProperties", + "traits": { + "smithy.api#documentation": "

The properties of a small multiples X axis.

" + } + }, + "YAxis": { + "target": "com.amazonaws.quicksight#SmallMultiplesAxisProperties", + "traits": { + "smithy.api#documentation": "

The properties of a small multiples Y axis.

" + } } }, "traits": { @@ -39126,6 +39250,29 @@ "smithy.api#documentation": "

The parameters for Spark.

" } }, + "com.amazonaws.quicksight#SpecialValue": { + "type": "enum", + "members": { + "EMPTY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMPTY" + } + }, + "NULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NULL" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } + } + } + }, "com.amazonaws.quicksight#SqlEndpointPath": { "type": "string", "traits": { @@ -39221,7 +39368,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an Asset Bundle export job.

\n

An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 10 export jobs concurrently.

\n

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

", + "smithy.api#documentation": "

Starts an Asset Bundle export job.

\n

An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently.

\n

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/asset-bundle-export-jobs/export", @@ -39345,7 +39492,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an Asset Bundle import job.

\n

An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 10 import jobs concurrently.

\n

The API caller must have the necessary \"create\", \"describe\", and \"update\" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.

", + "smithy.api#documentation": "

Starts an Asset Bundle import job.

\n

An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.

\n

The API caller must have the necessary \"create\", \"describe\", and \"update\" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/asset-bundle-import-jobs/import", @@ -39374,7 +39521,7 @@ "AssetBundleImportSource": { "target": "com.amazonaws.quicksight#AssetBundleImportSource", "traits": { - "smithy.api#documentation": "

The source of the asset bundle zip file that contains the data that you want to import.

", + "smithy.api#documentation": "

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.\n

", "smithy.api#required": {} } },