--- title: "PUT /accounts/{AwsAccountId}/templates/{TemplateId}" method: PUT path: "/accounts/{AwsAccountId}/templates/{TemplateId}" --- # PUT /accounts/{AwsAccountId}/templates/{TemplateId} `PUT /accounts/{AwsAccountId}/templates/{TemplateId}` Updates a template from an existing Amazon QuickSight analysis or another template. ## Path parameters - `AwsAccountId` string, required - `TemplateId` string, required ## Request body - object - `SourceEntity` object — The source entity of the template. - `SourceAnalysis` object — The source analysis, if it is based on an analysis. - `Arn` string, required — The Amazon Resource Name (ARN) of the resource. - `DataSetReferences` DataSetReference[], required — A structure containing information about the dataset references used as placeholders in the template. - `DataSetPlaceholder` string, required — Dataset placeholder. - `DataSetArn` string, required — Dataset Amazon Resource Name (ARN). - `SourceTemplate` object — The source template, if it is based on an template. - `Arn` string, required — The Amazon Resource Name (ARN) of the resource. - `VersionDescription` string — 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. - `Name` string — The name for the template. - `Definition` object — The detailed definition of a template. - `DataSetConfigurations` DataSetConfiguration[] — An array of dataset configurations. These configurations define the required columns for each dataset used within a template. - `Placeholder` string — Placeholder. - `DataSetSchema` object — Dataset schema. - `ColumnSchemaList` ColumnSchema[] — A structure containing the list of column schemas. - `Name` string — The name of the column schema. - `DataType` string — The data type of the column schema. - `GeographicRole` string — The geographic role of the column schema. - `ColumnGroupSchemaList` ColumnGroupSchema[] — A structure containing the list of column group schemas. - `Name` string — The name of the column group schema. - `ColumnGroupColumnSchemaList` ColumnGroupColumnSchema[] — A structure containing the list of schemas for column group columns. - `Name` string — The name of the column group's column schema. - `Sheets` SheetDefinition[] — An array of sheet definitions for a template. - `SheetId` string, required — The unique identifier of a sheet. - `Title` string — The title of the sheet. - `Description` string — A description of the sheet. - `Name` string — The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console. - `ParameterControls` ParameterControl[] —

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.

- `DateTimePicker` object — A control from a date parameter that specifies date and time. - `ParameterControlId` string, required — The ID of the ParameterDateTimePickerControl. - `Title` string, required — The title of the ParameterDateTimePickerControl. - `SourceParameterName` string, required — The name of the ParameterDateTimePickerControl. - `DisplayOptions` object — The display options of a control. - `TitleOptions` object — The options to configure the title visibility, name, and font size. - … - `DateTimeFormat` string — Customize how dates are formatted in controls. - `List` object — A control to display a list with buttons or boxes that are used to select either a single value or multiple values. - `ParameterControlId` string, required — The ID of the ParameterListControl. - `Title` string, required — The title of the ParameterListControl. - `SourceParameterName` string, required — The source parameter name of the ParameterListControl. - `DisplayOptions` object — The display options of a control. - `SearchOptions` object — The configuration of the search options in a list control. - … - `SelectAllOptions` object — The configuration of the Select all options in a list control. - … - `TitleOptions` object — The options to configure the title visibility, name, and font size. - … - `Type` 'MULTI_SELECT' | 'SINGLE_SELECT' — The type of ParameterListControl. - `SelectableValues` object — A list of selectable values that are used in a control. - `Values` String[] — The values that are used in ParameterSelectableValues. - `LinkToDataSetColumn` object — The column identifier that fetches values from the data set. - … - `CascadingControlConfiguration` object — The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls. - `SourceControls` CascadingControlSource[] — A list of source controls that determine the values that are used in the current control. - … - `Dropdown` object — A control to display a dropdown list with buttons that are used to select a single value. - `ParameterControlId` string, required — The ID of the ParameterDropDownControl. - `Title` string, required — The title of the ParameterDropDownControl. - `SourceParameterName` string, required — The source parameter name of the ParameterDropDownControl. - `DisplayOptions` object — The display options of a control. - `SelectAllOptions` object — The configuration of the Select all options in a dropdown control. - … - `TitleOptions` object — The options to configure the title visibility, name, and font size. - … - `Type` 'MULTI_SELECT' | 'SINGLE_SELECT' — The type parameter name of the ParameterDropDownControl. - `SelectableValues` object — A list of selectable values that are used in a control. - `Values` String[] — The values that are used in ParameterSelectableValues. - `LinkToDataSetColumn` object — The column identifier that fetches values from the data set. - … - `CascadingControlConfiguration` object — The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls. - `SourceControls` CascadingControlSource[] — A list of source controls that determine the values that are used in the current control. - … - `TextField` object — A control to display a text box that is used to enter a single entry. - `ParameterControlId` string, required — The ID of the ParameterTextFieldControl. - `Title` string, required — The title of the ParameterTextFieldControl. - `SourceParameterName` string, required — The source parameter name of the ParameterTextFieldControl. - `DisplayOptions` object — The display options of a control. - `TitleOptions` object — The options to configure the title visibility, name, and font size. - … - `PlaceholderOptions` object — The configuration of the placeholder options in a text field control. - … - `TextArea` object — A control to display a text box that is used to enter multiple entries. - `ParameterControlId` string, required — The ID of the ParameterTextAreaControl. - `Title` string, required — The title of the ParameterTextAreaControl. - `SourceParameterName` string, required — The source parameter name of the ParameterTextAreaControl. - `Delimiter` string — The delimiter that is used to separate the lines in text. - `DisplayOptions` object — The display options of a control. - `TitleOptions` object — The options to configure the title visibility, name, and font size. - … - `PlaceholderOptions` object — The configuration of the placeholder options in a text area control. - … - `Slider` object — A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle. - `ParameterControlId` string, required — The ID of the ParameterSliderControl. - `Title` string, required — The title of the ParameterSliderControl. - `SourceParameterName` string, required — The source parameter name of the ParameterSliderControl. - `DisplayOptions` object — The display options of a control. - `TitleOptions` object — The options to configure the title visibility, name, and font size. - … - `MaximumValue` number, double, required — The smaller value that is displayed at the left of the slider. - `MinimumValue` number, double, required — The larger value that is displayed at the right of the slider. - `StepSize` number, double, required — The number of increments that the slider bar is divided into. - `FilterControls` FilterControl[] —

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.

- `DateTimePicker` object — A control from a date filter that is used to specify date and time. - `FilterControlId` string, required — The ID of the FilterDateTimePickerControl. - `Title` string, required — The title of the FilterDateTimePickerControl. - `SourceFilterId` string, required — The source filter ID of the FilterDateTimePickerControl. - `DisplayOptions` object — The display options of a control. - `TitleOptions` object — The options to configure the title visibility, name, and font size. - … - `DateTimeFormat` string — Customize how dates are formatted in controls. - `Type` 'SINGLE_VALUED' | 'DATE_RANGE' —

The date time picker type of a FilterDateTimePickerControl. Choose one of the following options:

- `List` object — A control to display a list of buttons or boxes. This is used to select either a single value or multiple values. - `FilterControlId` string, required — The ID of the FilterListControl. - `Title` string, required — The title of the FilterListControl. - `SourceFilterId` string, required — The source filter ID of the FilterListControl. - `DisplayOptions` object — The display options of a control. - `SearchOptions` object — The configuration of the search options in a list control. - … - `SelectAllOptions` object — The configuration of the Select all options in a list control. - … - `TitleOptions` object — The options to configure the title visibility, name, and font size. - … - `Type` 'MULTI_SELECT' | 'SINGLE_SELECT' —

The type of FilterListControl. Choose one of the following options:

- `SelectableValues` object — A list of selectable values that are used in a control. - `Values` String[] — The values that are used in the FilterSelectableValues. - `CascadingControlConfiguration` object — The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls. - `SourceControls` CascadingControlSource[] — A list of source controls that determine the values that are used in the current control. - … - `Dropdown` object — A control to display a dropdown list with buttons that are used to select a single value. - `FilterControlId` string, required — The ID of the FilterDropDownControl. - `Title` string, required — The title of the FilterDropDownControl. - `SourceFilterId` string, required — The source filter ID of the FilterDropDownControl. - `DisplayOptions` object — The display options of the FilterDropDownControl. - `SelectAllOptions` object — The configuration of the Select all options in a dropdown control. - … - `TitleOptions` object — The options to configure the title visibility, name, and font size. - … - `Type` 'MULTI_SELECT' | 'SINGLE_SELECT' —

The type of the FilterDropDownControl. Choose one of the following options:

- `SelectableValues` object — A list of selectable values that are used in a control. - `Values` String[] — The values that are used in the FilterSelectableValues. - `CascadingControlConfiguration` object — The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls. - `SourceControls` CascadingControlSource[] — A list of source controls that determine the values that are used in the current control. - … - `TextField` object — A control to display a text box that is used to enter a single entry. - `FilterControlId` string, required — The ID of the FilterTextFieldControl. - `Title` string, required — The title of the FilterTextFieldControl. - `SourceFilterId` string, required — The source filter ID of the FilterTextFieldControl. - `DisplayOptions` object — The display options of a control. - `TitleOptions` object — The options to configure the title visibility, name, and font size. - … - `PlaceholderOptions` object — The configuration of the placeholder options in a text field control. - … - `TextArea` object — A control to display a text box that is used to enter multiple entries. - `FilterControlId` string, required — The ID of the FilterTextAreaControl. - `Title` string, required — The title of the FilterTextAreaControl. - `SourceFilterId` string, required — The source filter ID of the FilterTextAreaControl. - `Delimiter` string — The delimiter that is used to separate the lines in text. - `DisplayOptions` object — The display options of a control. - `TitleOptions` object — The options to configure the title visibility, name, and font size. - … - `PlaceholderOptions` object — The configuration of the placeholder options in a text area control. - … - `Slider` object — A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle. - `FilterControlId` string, required — The ID of the FilterSliderControl. - `Title` string, required — The title of the FilterSliderControl. - `SourceFilterId` string, required — The source filter ID of the FilterSliderControl. - `DisplayOptions` object — The display options of a control. - `TitleOptions` object — The options to configure the title visibility, name, and font size. - … - `Type` 'SINGLE_POINT' | 'RANGE' —

The type of FilterSliderControl. Choose one of the following options:

- `MaximumValue` number, double, required — The smaller value that is displayed at the left of the slider. - `MinimumValue` number, double, required — The larger value that is displayed at the right of the slider. - `StepSize` number, double, required — The number of increments that the slider bar is divided into. - `RelativeDateTime` object — A control from a date filter that is used to specify the relative date. - `FilterControlId` string, required — The ID of the FilterTextAreaControl. - `Title` string, required — The title of the FilterTextAreaControl. - `SourceFilterId` string, required — The source filter ID of the FilterTextAreaControl. - `DisplayOptions` object — The display options of a control. - `TitleOptions` object — The options to configure the title visibility, name, and font size. - … - `DateTimeFormat` string — Customize how dates are formatted in controls. - `Visuals` Visual[] — A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet. - `TableVisual` object —

A table visual.

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

- `VisualId` string, required — 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.. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration settings of the visual. - `FieldWells` object — The field wells of the visual. - … - `SortConfiguration` object — The sort configuration for a TableVisual. - … - `TableOptions` object — The table options for a table visual. - … - `TotalOptions` object — The total options for a table visual. - … - `FieldOptions` object — The field options for a table visual. - … - `PaginatedReportOptions` object — The paginated report options for a table visual. - … - `TableInlineVisualizations` TableInlineVisualization[] — A collection of inline visualizations to display within a chart. - … - `ConditionalFormatting` object — The conditional formatting for a PivotTableVisual. - `ConditionalFormattingOptions` TableConditionalFormattingOption[] — Conditional formatting options for a PivotTableVisual. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `PivotTableVisual` object —

A pivot table.

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

- `VisualId` string, required — 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.. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration settings of the visual. - `FieldWells` object — The field wells of the visual. - … - `SortConfiguration` object — The sort configuration for a PivotTableVisual. - … - `TableOptions` object — The table options for a pivot table visual. - … - `TotalOptions` object — The total options for a pivot table visual. - … - `FieldOptions` object — The field options for a pivot table visual. - … - `PaginatedReportOptions` object — The paginated report options for a pivot table visual. - … - `ConditionalFormatting` object — The conditional formatting for a PivotTableVisual. - `ConditionalFormattingOptions` PivotTableConditionalFormattingOption[] — Conditional formatting options for a PivotTableVisual. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `BarChartVisual` object —

A bar chart.

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

- `VisualId` string, required — 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. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration settings of the visual. - `FieldWells` object — The field wells of the visual. - … - `SortConfiguration` object — The sort configuration of a BarChartVisual. - … - `Orientation` 'HORIZONTAL' | 'VERTICAL' —

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

- `BarsArrangement` 'CLUSTERED' | 'STACKED' | 'STACKED_PERCENT' — Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual. - `VisualPalette` object — The palette (chart color) display setup of the visual. - … - `SmallMultiplesOptions` object — The small multiples setup for the visual. - … - `CategoryAxis` object — The label display options (grid line, range, scale, axis step) for bar chart category. - … - `CategoryLabelOptions` object — The label options (label text, label visibility and sort icon visibility) for a bar chart. - … - `ValueAxis` object — The label display options (grid line, range, scale, axis step) for a bar chart value. - … - `ValueLabelOptions` object — The label options (label text, label visibility and sort icon visibility) for a bar chart value. - … - `ColorLabelOptions` object — The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart. - … - `Legend` object — The legend display setup of the visual. - … - `DataLabels` object — The options that determine if visual data labels are displayed. - … - `Tooltip` object — The tooltip display setup of the visual. - … - `ReferenceLines` ReferenceLine[] — The reference line setup of the visual. - … - `ContributionAnalysisDefaults` ContributionAnalysisDefault[] — The contribution analysis (anomaly configuration) setup of the visual. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `ColumnHierarchies` ColumnHierarchy[] — The column hierarchy that is used during drill-downs and drill-ups. - `ExplicitHierarchy` object — 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. - … - `DateTimeHierarchy` object — The option that determines the hierarchy of any DateTime fields. - … - `PredefinedHierarchy` object — 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. - … - `KPIVisual` object —

A key performance indicator (KPI).

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

- `VisualId` string, required — 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. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration of a KPI visual. - `FieldWells` object — The field well configuration of a KPI visual. - … - `SortConfiguration` object — The sort configuration of a KPI visual. - … - `KPIOptions` object — The options that determine the presentation of a KPI visual. - … - `ConditionalFormatting` object — The conditional formatting of a KPI visual. - `ConditionalFormattingOptions` KPIConditionalFormattingOption[] — The conditional formatting options of a KPI visual. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `ColumnHierarchies` ColumnHierarchy[] — The column hierarchy that is used during drill-downs and drill-ups. - `ExplicitHierarchy` object — 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. - … - `DateTimeHierarchy` object — The option that determines the hierarchy of any DateTime fields. - … - `PredefinedHierarchy` object — 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. - … - `PieChartVisual` object —

A pie or donut chart.

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

- `VisualId` string, required — 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. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration of a pie chart. - `FieldWells` object — The field wells of the visual. - … - `SortConfiguration` object — The sort configuration of a pie chart. - … - `DonutOptions` object — The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart. - … - `SmallMultiplesOptions` object — The small multiples setup for the visual. - … - `CategoryLabelOptions` object — The label options of the group/color that is displayed in a pie chart. - … - `ValueLabelOptions` object — The label options for the value that is displayed in a pie chart. - … - `Legend` object — The legend display setup of the visual. - … - `DataLabels` object — The options that determine if visual data labels are displayed. - … - `Tooltip` object — The tooltip display setup of the visual. - … - `VisualPalette` object — The palette (chart color) display setup of the visual. - … - `ContributionAnalysisDefaults` ContributionAnalysisDefault[] — The contribution analysis (anomaly configuration) setup of the visual. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `ColumnHierarchies` ColumnHierarchy[] — The column hierarchy that is used during drill-downs and drill-ups. - `ExplicitHierarchy` object — 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. - … - `DateTimeHierarchy` object — The option that determines the hierarchy of any DateTime fields. - … - `PredefinedHierarchy` object — 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. - … - `GaugeChartVisual` object —

A gauge chart.

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

- `VisualId` string, required — 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. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration of a GaugeChartVisual. - `FieldWells` object — The field well configuration of a GaugeChartVisual. - … - `GaugeChartOptions` object — The options that determine the presentation of the GaugeChartVisual. - … - `DataLabels` object — The data label configuration of a GaugeChartVisual. - … - `TooltipOptions` object — The tooltip configuration of a GaugeChartVisual. - … - `VisualPalette` object — The visual palette configuration of a GaugeChartVisual. - … - `ConditionalFormatting` object — The conditional formatting of a GaugeChartVisual. - `ConditionalFormattingOptions` GaugeChartConditionalFormattingOption[] — Conditional formatting options of a GaugeChartVisual. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `LineChartVisual` object —

A line chart.

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

- `VisualId` string, required — 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. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration of a line chart. - `FieldWells` object — The field well configuration of a line chart. - … - `SortConfiguration` object — The sort configuration of a line chart. - … - `ForecastConfigurations` ForecastConfiguration[] — The forecast configuration of a line chart. - … - `Type` 'LINE' | 'AREA' | 'STACKED_AREA' — Determines the type of the line chart. - `SmallMultiplesOptions` object — The small multiples setup for the visual. - … - `XAxisDisplayOptions` object — The options that determine the presentation of the x-axis. - … - `XAxisLabelOptions` object — The options that determine the presentation of the x-axis label. - … - `PrimaryYAxisDisplayOptions` object — The series axis configuration of a line chart. - … - `PrimaryYAxisLabelOptions` object — The options that determine the presentation of the y-axis label. - … - `SecondaryYAxisDisplayOptions` object — The series axis configuration of a line chart. - … - `SecondaryYAxisLabelOptions` object — The options that determine the presentation of the secondary y-axis label. - … - `DefaultSeriesSettings` object — The options that determine the default presentation of all line series in LineChartVisual. - … - `Series` SeriesItem[] — The series item configuration of a line chart. - … - `Legend` object — The legend configuration of a line chart. - … - `DataLabels` object — The data label configuration of a line chart. - … - `ReferenceLines` ReferenceLine[] — The reference lines configuration of a line chart. - … - `Tooltip` object — The tooltip configuration of a line chart. - … - `ContributionAnalysisDefaults` ContributionAnalysisDefault[] — The default configuration of a line chart's contribution analysis. - … - `VisualPalette` object — The visual palette configuration of a line chart. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `ColumnHierarchies` ColumnHierarchy[] — The column hierarchy that is used during drill-downs and drill-ups. - `ExplicitHierarchy` object — 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. - … - `DateTimeHierarchy` object — The option that determines the hierarchy of any DateTime fields. - … - `PredefinedHierarchy` object — 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. - … - `HeatMapVisual` object —

A heat map.

For more information, see Using heat maps in the Amazon QuickSight User Guide.

- `VisualId` string, required — 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. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration of a heat map. - `FieldWells` object — The field wells of the visual. - … - `SortConfiguration` object — The sort configuration of a heat map. - … - `RowLabelOptions` object — The label options of the row that is displayed in a heat map. - … - `ColumnLabelOptions` object — The label options of the column that is displayed in a heat map. - … - `ColorScale` object — The color options (gradient color, point of divergence) in a heat map. - … - `Legend` object — The legend display setup of the visual. - … - `DataLabels` object — The options that determine if visual data labels are displayed. - … - `Tooltip` object — The tooltip display setup of the visual. - … - `ColumnHierarchies` ColumnHierarchy[] — The column hierarchy that is used during drill-downs and drill-ups. - `ExplicitHierarchy` object — 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. - … - `DateTimeHierarchy` object — The option that determines the hierarchy of any DateTime fields. - … - `PredefinedHierarchy` object — 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. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `TreeMapVisual` object —

A tree map.

For more information, see Using tree maps in the Amazon QuickSight User Guide.

- `VisualId` string, required — 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.. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration settings of the visual. - `FieldWells` object — The field wells of the visual. - … - `SortConfiguration` object — The sort configuration of a tree map. - … - `GroupLabelOptions` object — The label options (label text, label visibility) of the groups that are displayed in a tree map. - … - `SizeLabelOptions` object — The label options (label text, label visibility) of the sizes that are displayed in a tree map. - … - `ColorLabelOptions` object — The label options (label text, label visibility) for the colors displayed in a tree map. - … - `ColorScale` object — The color options (gradient color, point of divergence) of a tree map. - … - `Legend` object — The legend display setup of the visual. - … - `DataLabels` object — The options that determine if visual data labels are displayed. - … - `Tooltip` object — The tooltip display setup of the visual. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `ColumnHierarchies` ColumnHierarchy[] — The column hierarchy that is used during drill-downs and drill-ups. - `ExplicitHierarchy` object — 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. - … - `DateTimeHierarchy` object — The option that determines the hierarchy of any DateTime fields. - … - `PredefinedHierarchy` object — 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. - … - `GeospatialMapVisual` object —

A geospatial map or a points on map visual.

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

- `VisualId` string, required — 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.. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration settings of the visual. - `FieldWells` object — The field wells of the visual. - … - `Legend` object — The legend display setup of the visual. - … - `Tooltip` object — The tooltip display setup of the visual. - … - `WindowOptions` object — The window options of the geospatial map. - … - `MapStyleOptions` object — The map style options of the geospatial map. - … - `PointStyleOptions` object — The point style options of the geospatial map. - … - `VisualPalette` VisualPalette — The visual display options for the visual palette. - … - `ColumnHierarchies` ColumnHierarchy[] — The column hierarchy that is used during drill-downs and drill-ups. - `ExplicitHierarchy` object — 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. - … - `DateTimeHierarchy` object — The option that determines the hierarchy of any DateTime fields. - … - `PredefinedHierarchy` object — 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. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `FilledMapVisual` object —

A filled map.

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

- `VisualId` string, required — 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.. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration settings of the visual. - `FieldWells` object — The field wells of the visual. - … - `SortConfiguration` object — The sort configuration of a FilledMapVisual. - … - `Legend` object — The legend display setup of the visual. - … - `Tooltip` object — The tooltip display setup of the visual. - … - `WindowOptions` object — The window options of the filled map visual. - … - `MapStyleOptions` object — The map style options of the filled map visual. - … - `ConditionalFormatting` object — The conditional formatting of a FilledMapVisual. - `ConditionalFormattingOptions` FilledMapConditionalFormattingOption[], required — Conditional formatting options of a FilledMapVisual. - … - `ColumnHierarchies` ColumnHierarchy[] — The column hierarchy that is used during drill-downs and drill-ups. - `ExplicitHierarchy` object — 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. - … - `DateTimeHierarchy` object — The option that determines the hierarchy of any DateTime fields. - … - `PredefinedHierarchy` object — 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. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `FunnelChartVisual` object —

A funnel chart.

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

- `VisualId` string, required — 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.. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration of a FunnelChartVisual. - `FieldWells` object — The field well configuration of a FunnelChartVisual. - … - `SortConfiguration` object — The sort configuration of a FunnelChartVisual. - … - `CategoryLabelOptions` object — The label options of the categories that are displayed in a FunnelChartVisual. - … - `ValueLabelOptions` object — The label options for the values that are displayed in a FunnelChartVisual. - … - `Tooltip` object — The tooltip configuration of a FunnelChartVisual. - … - `DataLabelOptions` object — The options that determine the presentation of the data labels. - … - `VisualPalette` object — The visual palette configuration of a FunnelChartVisual. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `ColumnHierarchies` ColumnHierarchy[] — The column hierarchy that is used during drill-downs and drill-ups. - `ExplicitHierarchy` object — 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. - … - `DateTimeHierarchy` object — The option that determines the hierarchy of any DateTime fields. - … - `PredefinedHierarchy` object — 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. - … - `ScatterPlotVisual` object —

A scatter plot.

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

- `VisualId` string, required — 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. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration settings of the visual. - `FieldWells` object — The field wells of the visual. - … - `XAxisLabelOptions` object — The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis. - … - `XAxisDisplayOptions` object — The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis. - … - `YAxisLabelOptions` object — The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis. - … - `YAxisDisplayOptions` object — The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis. - … - `Legend` object — The legend display setup of the visual. - … - `DataLabels` object — The options that determine if visual data labels are displayed. - … - `Tooltip` object — The legend display setup of the visual. - … - `VisualPalette` object — The palette (chart color) display setup of the visual. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `ColumnHierarchies` ColumnHierarchy[] — The column hierarchy that is used during drill-downs and drill-ups. - `ExplicitHierarchy` object — 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. - … - `DateTimeHierarchy` object — The option that determines the hierarchy of any DateTime fields. - … - `PredefinedHierarchy` object — 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. - … - `ComboChartVisual` object —

A combo chart.

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

- `VisualId` string, required — 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. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration settings of the visual. - `FieldWells` object — The field wells of the visual. - … - `SortConfiguration` object — The sort configuration of a ComboChartVisual. - … - `BarsArrangement` 'CLUSTERED' | 'STACKED' | 'STACKED_PERCENT' —

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

- `CategoryAxis` object — The category axis of a combo chart. - … - `CategoryLabelOptions` object — The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well. - … - `PrimaryYAxisDisplayOptions` object — The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well. - … - `PrimaryYAxisLabelOptions` object — The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well. - … - `SecondaryYAxisDisplayOptions` object — The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well. - … - `SecondaryYAxisLabelOptions` object — The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well. - … - `ColorLabelOptions` object — The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well. - … - `Legend` object — The legend display setup of the visual. - … - `BarDataLabels` object —

The options that determine if visual data labels are displayed.

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

- … - `LineDataLabels` object —

The options that determine if visual data labels are displayed.

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

- … - `Tooltip` object — The legend display setup of the visual. - … - `ReferenceLines` ReferenceLine[] — The reference line setup of the visual. - … - `VisualPalette` object — The palette (chart color) display setup of the visual. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `ColumnHierarchies` ColumnHierarchy[] — The column hierarchy that is used during drill-downs and drill-ups. - `ExplicitHierarchy` object — 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. - … - `DateTimeHierarchy` object — The option that determines the hierarchy of any DateTime fields. - … - `PredefinedHierarchy` object — 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. - … - `BoxPlotVisual` object —

A box plot.

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

- `VisualId` string, required — 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.. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration settings of the visual. - `FieldWells` object — The field wells of the visual. - … - `SortConfiguration` object — The sort configuration of a BoxPlotVisual. - … - `BoxPlotOptions` object — The box plot chart options for a box plot visual - … - `CategoryAxis` object — The label display options (grid line, range, scale, axis step) of a box plot category. - … - `CategoryLabelOptions` object — The label options (label text, label visibility and sort Icon visibility) of a box plot category. - … - `PrimaryYAxisDisplayOptions` object — The label display options (grid line, range, scale, axis step) of a box plot category. - … - `PrimaryYAxisLabelOptions` object — The label options (label text, label visibility and sort icon visibility) of a box plot value. - … - `Legend` LegendOptions — The options for the legend setup of a visual. - … - `Tooltip` object — The tooltip display setup of the visual. - … - `ReferenceLines` ReferenceLine[] — The reference line setup of the visual. - … - `VisualPalette` object — The palette (chart color) display setup of the visual. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `ColumnHierarchies` ColumnHierarchy[] — The column hierarchy that is used during drill-downs and drill-ups. - `ExplicitHierarchy` object — 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. - … - `DateTimeHierarchy` object — The option that determines the hierarchy of any DateTime fields. - … - `PredefinedHierarchy` object — 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. - … - `WaterfallVisual` object —

A waterfall chart.

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

- `VisualId` string, required — 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. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration for a waterfall visual. - `FieldWells` object — The field well configuration of a waterfall visual. - … - `SortConfiguration` object — The sort configuration of a waterfall visual. - … - `WaterfallChartOptions` object — The options that determine the presentation of a waterfall visual. - … - `CategoryAxisLabelOptions` object — The options that determine the presentation of the category axis label. - … - `CategoryAxisDisplayOptions` object — The options that determine the presentation of the category axis. - … - `PrimaryYAxisLabelOptions` object — The options that determine the presentation of the y-axis label. - … - `PrimaryYAxisDisplayOptions` object — The options that determine the presentation of the y-axis. - … - `Legend` object — The legend configuration of a waterfall visual. - … - `DataLabels` object — The data label configuration of a waterfall visual. - … - `VisualPalette` object — The visual palette configuration of a waterfall visual. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `ColumnHierarchies` ColumnHierarchy[] — The column hierarchy that is used during drill-downs and drill-ups. - `ExplicitHierarchy` object — 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. - … - `DateTimeHierarchy` object — The option that determines the hierarchy of any DateTime fields. - … - `PredefinedHierarchy` object — 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. - … - `HistogramVisual` object —

A histogram.

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

- `VisualId` string, required — 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. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration for a HistogramVisual. - `FieldWells` object — The field well configuration of a histogram. - … - `XAxisDisplayOptions` object — The options that determine the presentation of the x-axis. - … - `XAxisLabelOptions` object — The options that determine the presentation of the x-axis label. - … - `YAxisDisplayOptions` object — The options that determine the presentation of the y-axis. - … - `BinOptions` object — The options that determine the presentation of histogram bins. - … - `DataLabels` object — The data label configuration of a histogram. - … - `Tooltip` object — The tooltip configuration of a histogram. - … - `VisualPalette` object — The visual palette configuration of a histogram. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `WordCloudVisual` object —

A word cloud.

For more information, see Using word clouds in the Amazon QuickSight User Guide.

- `VisualId` string, required — 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.. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration settings of the visual. - `FieldWells` object — The field wells of the visual. - … - `SortConfiguration` object — The sort configuration of a word cloud visual. - … - `CategoryLabelOptions` object — The label options (label text, label visibility, and sort icon visibility) for the word cloud category. - … - `WordCloudOptions` object — The options for a word cloud visual. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `ColumnHierarchies` ColumnHierarchy[] — The column hierarchy that is used during drill-downs and drill-ups. - `ExplicitHierarchy` object — 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. - … - `DateTimeHierarchy` object — The option that determines the hierarchy of any DateTime fields. - … - `PredefinedHierarchy` object — 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. - … - `InsightVisual` object —

An insight visual.

For more information, see Working with insights in the Amazon QuickSight User Guide.

- `VisualId` string, required — 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. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `InsightConfiguration` object — The configuration of an insight visual. - `Computations` Computation[] — The computations configurations of the insight visual - … - `CustomNarrative` object — The custom narrative of the insight visual. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `DataSetIdentifier` string, required — The dataset that is used in the insight visual. - `SankeyDiagramVisual` object —

A sankey diagram.

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

- `VisualId` string, required — 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. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration of a sankey diagram. - `FieldWells` object — The field well configuration of a sankey diagram. - … - `SortConfiguration` object — The sort configuration of a sankey diagram. - … - `DataLabels` object — The data label configuration of a sankey diagram. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `CustomContentVisual` object —

A visual that contains custom content.

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

- `VisualId` string, required — 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. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration of a CustomContentVisual. - `ContentUrl` string — The input URL that links to the custom content that you want in the custom visual. - `ContentType` 'IMAGE' | 'OTHER_EMBEDDED_CONTENT' — The content type of the custom content visual. You can use this to have the visual render as an image. - `ImageScaling` 'FIT_TO_HEIGHT' | 'FIT_TO_WIDTH' | 'DO_NOT_SCALE' | 'SCALE_TO_VISUAL' — The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'. - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `DataSetIdentifier` string, required — The dataset that is used to create the custom content visual. You can't create a visual without a dataset. - `EmptyVisual` object — An empty visual. - `VisualId` string, required — 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. - `DataSetIdentifier` string, required — The data set that is used in the empty visual. Every visual requires a dataset to render. - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `RadarChartVisual` object —

A radar chart visual.

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

- `VisualId` string, required — 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. - `Title` object — The title that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the title label. - `FormatText` object — The short text format of the title label, such as plain text or rich text. - … - `Subtitle` object — The subtitle that is displayed on the visual. - `Visibility` 'HIDDEN' | 'VISIBLE' — The visibility of the subtitle label. - `FormatText` object — The long text format of the subtitle label, such as plain text or rich text. - … - `ChartConfiguration` object — The configuration settings of the visual. - `FieldWells` object — The field well configuration of a RadarChartVisual. - … - `SortConfiguration` object — The sort configuration of a RadarChartVisual. - … - `Shape` 'CIRCLE' | 'POLYGON' — The shape of the radar chart. - `BaseSeriesSettings` object — The base sreies settings of a radar chart. - … - `StartAngle` number, double — The start angle of a radar chart's axis. - `VisualPalette` object — The palette (chart color) display setup of the visual. - … - `AlternateBandColorsVisibility` 'HIDDEN' | 'VISIBLE' — Determines the visibility of the colors of alternatign bands in a radar chart. - `AlternateBandEvenColor` string — The color of the even-numbered alternate bands of a radar chart. - `AlternateBandOddColor` string — The color of the odd-numbered alternate bands of a radar chart. - `CategoryAxis` object — The category axis of a radar chart. - … - `CategoryLabelOptions` object — The category label options of a radar chart. - … - `ColorAxis` object — The color axis of a radar chart. - … - `ColorLabelOptions` object — The color label options of a radar chart. - … - `Legend` object — The legend display setup of the visual. - … - `Actions` VisualCustomAction[] — The list of custom actions that are configured for a visual. - `CustomActionId` string, required — The ID of the VisualCustomAction. - `Name` string, required — The name of the VisualCustomAction. - `Status` 'ENABLED' | 'DISABLED' — The status of the VisualCustomAction. - `Trigger` 'DATA_POINT_CLICK' | 'DATA_POINT_MENU', required —

The trigger of the VisualCustomAction.

Valid values are defined as follows:

- `ActionOperations` VisualCustomActionOperation[], required —

A list of VisualCustomActionOperations.

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

- … - `ColumnHierarchies` ColumnHierarchy[] — The column hierarchy that is used during drill-downs and drill-ups. - `ExplicitHierarchy` object — 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. - … - `DateTimeHierarchy` object — The option that determines the hierarchy of any DateTime fields. - … - `PredefinedHierarchy` object — 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. - … - `TextBoxes` SheetTextBox[] — The text boxes that are on a sheet. - `SheetTextBoxId` string, required — The unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers. - `Content` string — The content that is displayed in the text box. - `Layouts` Layout[] —

Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon QuickSight User Guide.

- `Configuration` object, required — The configuration that determines what the type of layout for a sheet. - `GridLayout` object — A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED or RESPONSIVE. - `Elements` GridLayoutElement[], required — The elements that are included in a grid layout. - … - `CanvasSizeOptions` GridLayoutCanvasSizeOptions — Configuration options for the canvas of a grid layout. - … - `FreeFormLayout` object — A free-form is optimized for a fixed width and has more control over the exact placement of layout elements. - `Elements` FreeFormLayoutElement[], required — The elements that are included in a free-form layout. - … - `CanvasSizeOptions` FreeFormLayoutCanvasSizeOptions — Configuration options for the canvas of a free-form layout. - … - `SectionBasedLayout` object — A section based layout organizes visuals into multiple sections and has customized header, footer and page break. - `HeaderSections` HeaderFooterSectionConfiguration[], required — A list of header section configurations. - … - `BodySections` BodySectionConfiguration[], required — A list of body section configurations. - … - `FooterSections` HeaderFooterSectionConfiguration[], required — A list of footer section configurations. - … - `CanvasSizeOptions` object, required — The options for the canvas of a section-based layout. - … - `SheetControlLayouts` SheetControlLayout[] — The control layouts of the sheet. - `Configuration` object, required — The configuration that determines the elements and canvas size options of sheet control. - `GridLayout` object — The configuration that determines the elements and canvas size options of sheet control. - `Elements` GridLayoutElement[], required — The elements that are included in a grid layout. - … - `CanvasSizeOptions` GridLayoutCanvasSizeOptions — Configuration options for the canvas of a grid layout. - … - `ContentType` 'PAGINATED' | 'INTERACTIVE' —

The layout content type of the sheet. Choose one of the following options:

- `CalculatedFields` CalculatedField[] — An array of calculated field definitions for the template. - `DataSetIdentifier` string, required — The data set that is used in this calculated field. - `Name` string, required — The name of the calculated field. - `Expression` string, password, required — The expression of the calculated field. - `ParameterDeclarations` ParameterDeclaration[] —

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.

- `StringParameterDeclaration` object — A parameter declaration for the String data type. - `ParameterValueType` 'MULTI_VALUED' | 'SINGLE_VALUED', required — The value type determines whether the parameter is a single-value or multi-value parameter. - `Name` string, required — The name of the parameter that is being declared. - `DefaultValues` object — The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided. - `DynamicValue` object — The dynamic value of the StringDefaultValues. Different defaults displayed according to users, groups, and values mapping. - `UserNameColumn` object — The column that contains the username. - … - `GroupNameColumn` object — The column that contains the group name. - … - `DefaultValueColumn` object, required — The column that contains the default value of each user or group. - … - `StaticValues` SensitiveStringObject[] — The static values of the DecimalDefaultValues. - `ValueWhenUnset` object — The configuration that defines the default value of a String parameter when a value has not been set. - `ValueWhenUnsetOption` 'RECOMMENDED_VALUE' | 'NULL' —

The built-in options for default values. The value can be one of the following:

- `CustomValue` string, password — A custom value that's used when the value of a parameter isn't set. - `DecimalParameterDeclaration` object — A parameter declaration for the Decimal data type. - `ParameterValueType` 'MULTI_VALUED' | 'SINGLE_VALUED', required — The value type determines whether the parameter is a single-value or multi-value parameter. - `Name` string, required — The name of the parameter that is being declared. - `DefaultValues` object — The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided. - `DynamicValue` object — The dynamic value of the DecimalDefaultValues. Different defaults are displayed according to users, groups, and values mapping. - `UserNameColumn` object — The column that contains the username. - … - `GroupNameColumn` object — The column that contains the group name. - … - `DefaultValueColumn` object, required — The column that contains the default value of each user or group. - … - `StaticValues` SensitiveDoubleObject[] — The static values of the DecimalDefaultValues. - `ValueWhenUnset` object — The configuration that defines the default value of a Decimal parameter when a value has not been set. - `ValueWhenUnsetOption` 'RECOMMENDED_VALUE' | 'NULL' —

The built-in options for default values. The value can be one of the following:

- `CustomValue` number, double — A custom value that's used when the value of a parameter isn't set. - `IntegerParameterDeclaration` object — A parameter declaration for the Integer data type. - `ParameterValueType` 'MULTI_VALUED' | 'SINGLE_VALUED', required — The value type determines whether the parameter is a single-value or multi-value parameter. - `Name` string, required — The name of the parameter that is being declared. - `DefaultValues` object — The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided. - `DynamicValue` object — The dynamic value of the IntegerDefaultValues. Different defaults are displayed according to users, groups, and values mapping. - `UserNameColumn` object — The column that contains the username. - … - `GroupNameColumn` object — The column that contains the group name. - … - `DefaultValueColumn` object, required — The column that contains the default value of each user or group. - … - `StaticValues` SensitiveLongObject[] — The static values of the IntegerDefaultValues. - `ValueWhenUnset` object — A parameter declaration for the Integer data type. - `ValueWhenUnsetOption` 'RECOMMENDED_VALUE' | 'NULL' —

The built-in options for default values. The value can be one of the following:

- `CustomValue` integer — A custom value that's used when the value of a parameter isn't set. - `DateTimeParameterDeclaration` object — A parameter declaration for the DateTime data type. - `Name` string, required — The name of the parameter that is being declared. - `DefaultValues` object — The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided. - `DynamicValue` object — The dynamic value of the DataTimeDefaultValues. Different defaults are displayed according to users, groups, and values mapping. - `UserNameColumn` object — The column that contains the username. - … - `GroupNameColumn` object — The column that contains the group name. - … - `DefaultValueColumn` object, required — The column that contains the default value of each user or group. - … - `StaticValues` SensitiveTimestamp[] — The static values of the DataTimeDefaultValues. - `RollingDate` object — The rolling date of the DataTimeDefaultValues. The date is determined from the dataset based on input expression. - `DataSetIdentifier` string — The data set that is used in the rolling date configuration. - `Expression` string, password, required — The expression of the rolling date configuration. - `TimeGranularity` 'YEAR' | 'QUARTER' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND' | 'MILLISECOND' — The level of time precision that is used to aggregate DateTime values. - `ValueWhenUnset` object — The configuration that defines the default value of a DateTime parameter when a value has not been set. - `ValueWhenUnsetOption` 'RECOMMENDED_VALUE' | 'NULL' —

The built-in options for default values. The value can be one of the following:

- `CustomValue` string, date-time — A custom value that's used when the value of a parameter isn't set. - `FilterGroups` FilterGroup[] —

Filter definitions for a template.

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

- `FilterGroupId` string, required — The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis. - `Filters` Filter[], required — The list of filters that are present in a FilterGroup. - `CategoryFilter` object —

A CategoryFilter filters text values.

For more information, see Adding text filters in the Amazon QuickSight User Guide.

- `FilterId` string, required — An identifier that uniquely identifies a filter within a dashboard, analysis, or template. - `Column` object, required — The column that the filter is applied to. - `DataSetIdentifier` string, required — The data set that the column belongs to. - `ColumnName` string, required — The name of the column. - `Configuration` object, required — The configuration for a CategoryFilter. - `FilterListConfiguration` object — A list of filter configurations. In the Amazon QuickSight console, this filter type is called a filter list. - … - `CustomFilterListConfiguration` object — A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list. - … - `CustomFilterConfiguration` object — A custom filter that filters based on a single value. This filter can be partially matched. - … - `NumericRangeFilter` object — A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range. - `FilterId` string, required — An identifier that uniquely identifies a filter within a dashboard, analysis, or template. - `Column` object, required — The column that the filter is applied to. - `DataSetIdentifier` string, required — The data set that the column belongs to. - `ColumnName` string, required — The name of the column. - `IncludeMinimum` boolean — Determines whether the minimum value in the filter value range should be included in the filtered results. - `IncludeMaximum` boolean — Determines whether the maximum value in the filter value range should be included in the filtered results. - `RangeMinimum` object — The minimum value for the filter value range. - `StaticValue` number, double — The static value of the numeric range filter. - `Parameter` string — The parameter that is used in the numeric range. - `RangeMaximum` object — The maximum value for the filter value range. - `StaticValue` number, double — The static value of the numeric range filter. - `Parameter` string — The parameter that is used in the numeric range. - `SelectAllOptions` 'FILTER_ALL_VALUES' —

Select all of the values. Null is not the assigned value of select all.

- `AggregationFunction` object — The aggregation function of the filter. - `NumericalAggregationFunction` object — Aggregation for numerical values. - … - `CategoricalAggregationFunction` 'COUNT' | 'DISTINCT_COUNT' —

Aggregation for categorical values.

- `DateAggregationFunction` 'COUNT' | 'DISTINCT_COUNT' | 'MIN' | 'MAX' —

Aggregation for date values.

- `NullOption` 'ALL_VALUES' | 'NULLS_ONLY' | 'NON_NULLS_ONLY', required —

This option determines how null values should be treated when filtering data.

- `NumericEqualityFilter` object — A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value. - `FilterId` string, required — An identifier that uniquely identifies a filter within a dashboard, analysis, or template. - `Column` object, required — The column that the filter is applied to. - `DataSetIdentifier` string, required — The data set that the column belongs to. - `ColumnName` string, required — The name of the column. - `Value` number, double — The input value. - `SelectAllOptions` 'FILTER_ALL_VALUES' —

Select all of the values. Null is not the assigned value of select all.

- `MatchOperator` 'EQUALS' | 'DOES_NOT_EQUAL', required — The match operator that is used to determine if a filter should be applied. - `AggregationFunction` object — The aggregation function of the filter. - `NumericalAggregationFunction` object — Aggregation for numerical values. - … - `CategoricalAggregationFunction` 'COUNT' | 'DISTINCT_COUNT' —

Aggregation for categorical values.

- `DateAggregationFunction` 'COUNT' | 'DISTINCT_COUNT' | 'MIN' | 'MAX' —

Aggregation for date values.

- `ParameterName` string — The parameter whose value should be used for the filter value. - `NullOption` 'ALL_VALUES' | 'NULLS_ONLY' | 'NON_NULLS_ONLY', required —

This option determines how null values should be treated when filtering data.

- `TimeEqualityFilter` object — A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value. - `FilterId` string, required — An identifier that uniquely identifies a filter within a dashboard, analysis, or template. - `Column` object, required — The column that the filter is applied to. - `DataSetIdentifier` string, required — The data set that the column belongs to. - `ColumnName` string, required — The name of the column. - `Value` string, date-time —

The value of a TimeEquality filter.

This field is mutually exclusive to ParameterName.

- `ParameterName` string —

The parameter whose value should be used for the filter value.

This field is mutually exclusive to Value.

- `TimeGranularity` 'YEAR' | 'QUARTER' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND' | 'MILLISECOND' — The level of time precision that is used to aggregate DateTime values. - `TimeRangeFilter` object — A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range. - `FilterId` string, required — An identifier that uniquely identifies a filter within a dashboard, analysis, or template. - `Column` object, required — The column that the filter is applied to. - `DataSetIdentifier` string, required — The data set that the column belongs to. - `ColumnName` string, required — The name of the column. - `IncludeMinimum` boolean — Determines whether the minimum value in the filter value range should be included in the filtered results. - `IncludeMaximum` boolean — Determines whether the maximum value in the filter value range should be included in the filtered results. - `RangeMinimumValue` object — The minimum value for the filter value range. - `StaticValue` string, date-time — The static input value. - `RollingDate` object — The rolling date input value. - … - `Parameter` string — The parameter type input value. - `RangeMaximumValue` object — The maximum value for the filter value range. - `StaticValue` string, date-time — The static input value. - `RollingDate` object — The rolling date input value. - … - `Parameter` string — The parameter type input value. - `NullOption` 'ALL_VALUES' | 'NULLS_ONLY' | 'NON_NULLS_ONLY', required —

This option determines how null values should be treated when filtering data.

- `ExcludePeriodConfiguration` object — The exclude period of the time range filter. - `Amount` integer, required — The amount or number of the exclude period. - `Granularity` 'YEAR' | 'QUARTER' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND' | 'MILLISECOND', required — The granularity or unit (day, month, year) of the exclude period. - `Status` 'ENABLED' | 'DISABLED' —

The status of the exclude period. Choose from the following options:

- `TimeGranularity` 'YEAR' | 'QUARTER' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND' | 'MILLISECOND' — The level of time precision that is used to aggregate DateTime values. - `RelativeDatesFilter` object — A RelativeDatesFilter filters date values that are relative to a given date. - `FilterId` string, required — An identifier that uniquely identifies a filter within a dashboard, analysis, or template. - `Column` object, required — The column that the filter is applied to. - `DataSetIdentifier` string, required — The data set that the column belongs to. - `ColumnName` string, required — The name of the column. - `AnchorDateConfiguration` object, required — The date configuration of the filter. - `AnchorOption` 'NOW' —

The options for the date configuration. Choose one of the options below:

- `ParameterName` string — The name of the parameter that is used for the anchor date configuration. - `MinimumGranularity` 'YEAR' | 'QUARTER' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND' | 'MILLISECOND' — The minimum granularity (period granularity) of the relative dates filter. - `TimeGranularity` 'YEAR' | 'QUARTER' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND' | 'MILLISECOND', required — The level of time precision that is used to aggregate DateTime values. - `RelativeDateType` 'PREVIOUS' | 'THIS' | 'LAST' | 'NOW' | 'NEXT', required —

The range date type of the filter. Choose one of the options below:

- `RelativeDateValue` integer — The date value of the filter. - `ParameterName` string — The parameter whose value should be used for the filter value. - `NullOption` 'ALL_VALUES' | 'NULLS_ONLY' | 'NON_NULLS_ONLY', required —

This option determines how null values should be treated when filtering data.

- `ExcludePeriodConfiguration` object — The configuration for the exclude period of the filter. - `Amount` integer, required — The amount or number of the exclude period. - `Granularity` 'YEAR' | 'QUARTER' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND' | 'MILLISECOND', required — The granularity or unit (day, month, year) of the exclude period. - `Status` 'ENABLED' | 'DISABLED' —

The status of the exclude period. Choose from the following options:

- `TopBottomFilter` object — A TopBottomFilter filters data to the top or bottom values for a given column. - `FilterId` string, required — An identifier that uniquely identifies a filter within a dashboard, analysis, or template. - `Column` object, required — The column that the filter is applied to. - `DataSetIdentifier` string, required — The data set that the column belongs to. - `ColumnName` string, required — The name of the column. - `Limit` integer — The number of items to include in the top bottom filter results. - `AggregationSortConfigurations` AggregationSortConfiguration[], required — The aggregation and sort configuration of the top bottom filter. - `Column` object, required — The column that determines the sort order of aggregated values. - … - `SortDirection` 'ASC' | 'DESC', required —

The sort direction of values.

- `AggregationFunction` object, required — The function that aggregates the values in Column. - … - `TimeGranularity` 'YEAR' | 'QUARTER' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND' | 'MILLISECOND' — The level of time precision that is used to aggregate DateTime values. - `ParameterName` string — The parameter whose value should be used for the filter value. - `ScopeConfiguration` object, required —

The configuration that specifies what scope to apply to a FilterGroup.

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

- `SelectedSheets` object — The configuration for applying a filter to specific sheets. - `SheetVisualScopingConfigurations` SheetVisualScopingConfiguration[] — The sheet ID and visual IDs of the sheet and visuals that the filter is applied to. - `SheetId` string, required — The selected sheet that the filter is applied to. - `Scope` 'ALL_VISUALS' | 'SELECTED_VISUALS', required —

The scope of the applied entities. Choose one of the following options:

- `VisualIds` ShortRestrictiveResourceId[] — The selected visuals that the filter is applied to. - `Status` 'ENABLED' | 'DISABLED' — The status of the FilterGroup. - `CrossDataset` 'ALL_DATASETS' | 'SINGLE_DATASET', required —

The filter new feature which can apply filter group to all data sets. Choose one of the following options:

- `ColumnConfigurations` ColumnConfiguration[] — An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template. - `Column` object, required — The column. - `DataSetIdentifier` string, required — The data set that the column belongs to. - `ColumnName` string, required — The name of the column. - `FormatConfiguration` object — The format configuration of a column. - `StringFormatConfiguration` object — Formatting configuration for string fields. - `NullValueFormatConfiguration` object — The options that determine the null value format configuration. - `NullString` string, password, required — Determines the null string of null values. - `NumericFormatConfiguration` object — The formatting configuration for numeric strings. - `NumberDisplayFormatConfiguration` object — The options that determine the number display format configuration. - … - `CurrencyDisplayFormatConfiguration` object — The options that determine the currency display format configuration. - … - `PercentageDisplayFormatConfiguration` object — The options that determine the percentage display format configuration. - … - `NumberFormatConfiguration` object — Formatting configuration for number fields. - `FormatConfiguration` object — The options that determine the numeric format configuration. - `NumberDisplayFormatConfiguration` object — The options that determine the number display format configuration. - … - `CurrencyDisplayFormatConfiguration` object — The options that determine the currency display format configuration. - … - `PercentageDisplayFormatConfiguration` object — The options that determine the percentage display format configuration. - … - `DateTimeFormatConfiguration` object — Formatting configuration for DateTime fields. - `DateTimeFormat` string — Determines the DateTime format. - `NullValueFormatConfiguration` object — The options that determine the null value format configuration. - `NullString` string, password, required — Determines the null string of null values. - `NumericFormatConfiguration` object — The formatting configuration for numeric DateTime fields. - `NumberDisplayFormatConfiguration` object — The options that determine the number display format configuration. - … - `CurrencyDisplayFormatConfiguration` object — The options that determine the currency display format configuration. - … - `PercentageDisplayFormatConfiguration` object — The options that determine the percentage display format configuration. - … - `Role` 'DIMENSION' | 'MEASURE' — The role of the column. - `AnalysisDefaults` AnalysisDefaults — The configuration for default analysis settings. - `DefaultNewSheetConfiguration` object, required — The configuration for default new sheet settings. - `InteractiveLayoutConfiguration` object — The options that determine the default settings for interactive layout configuration. - `Grid` object — The options that determine the default settings for a grid layout configuration. - `CanvasSizeOptions` object, required — Determines the screen canvas size options for a grid layout. - … - `FreeForm` object — The options that determine the default settings of a free-form layout configuration. - `CanvasSizeOptions` object, required — Determines the screen canvas size options for a free-form layout. - … - `PaginatedLayoutConfiguration` object — The options that determine the default settings for a paginated layout configuration. - `SectionBased` object — The options that determine the default settings for a section-based layout configuration. - `CanvasSizeOptions` object, required — Determines the screen canvas size options for a section-based layout. - … - `SheetContentType` 'PAGINATED' | 'INTERACTIVE' — The option that determines the sheet content type. ## Response `200` Success - UpdateTemplateResponse - `TemplateId` string — The ID for the template. - `Arn` string — The Amazon Resource Name (ARN) for the template. - `VersionArn` string — The ARN for the template, including the version information of the first version. - `CreationStatus` 'CREATION_IN_PROGRESS' | 'CREATION_SUCCESSFUL' | 'CREATION_FAILED' | 'UPDATE_IN_PROGRESS' | 'UPDATE_SUCCESSFUL' | 'UPDATE_FAILED' | 'DELETED' — The creation status of the template. - `Status` integer — The HTTP status of the request. - `RequestId` string — The Amazon Web Services request ID for this operation. ## Other responses - `480` — InvalidParameterValueException - `481` — ResourceExistsException - `482` — ResourceNotFoundException - `483` — ThrottlingException - `484` — ConflictException - `485` — LimitExceededException - `486` — UnsupportedUserEditionException - `487` — InternalFailureException --- [API](https://skmtc.net/aws/apis/quicksight.md) · [All operations](https://skmtc.net/aws/apis/quicksight/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/quicksight/versions/2f2bbd7e70ca/schema)