/* eslint-disable */ /** * This file was automatically generated by json-schema-to-typescript. * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, * and run json-schema-to-typescript to regenerate this file. */ export type ThemeType = "QUICKSIGHT" | "CUSTOM" | "ALL"; export type ResourceStatus = | "CREATION_IN_PROGRESS" | "CREATION_SUCCESSFUL" | "CREATION_FAILED" | "UPDATE_IN_PROGRESS" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED" | "DELETED"; export type ThemeErrorType = "INTERNAL_FAILURE"; /** * Definition of the AWS::QuickSight::Theme Resource Type. */ export interface AwsQuicksightTheme { /** *

The Amazon Resource Name (ARN) of the theme.

*/ Arn?: string; AwsAccountId: string; /** *

The ID of the theme that a custom theme will inherit from. All themes inherit from one of * the starting themes defined by Amazon QuickSight. For a list of the starting themes, use * ListThemes or choose Themes from * within a QuickSight analysis.

*/ BaseThemeId?: string; Configuration?: ThemeConfiguration; /** *

The date and time that the theme was created.

*/ CreatedTime?: string; /** *

The date and time that the theme was last updated.

*/ LastUpdatedTime?: string; /** *

A display name for the theme.

*/ Name?: string; /** *

A valid grouping of resource permissions to apply to the new theme. *

* * @minItems 1 * @maxItems 64 */ Permissions?: [ResourcePermission, ...ResourcePermission[]]; /** *

A map of the key-value pairs for the resource tag or tags that you want to add to the * resource.

* * @minItems 1 * @maxItems 200 */ Tags?: [Tag, ...Tag[]]; ThemeId: string; Type?: ThemeType; Version?: ThemeVersion; /** *

A description of the first version of the theme that you're creating. Every time * UpdateTheme is called, a new version is created. Each version of the * theme has a description of the version in the VersionDescription * field.

*/ VersionDescription?: string; } /** *

The theme configuration. This configuration contains all of the display properties for * a theme.

*/ export interface ThemeConfiguration { DataColorPalette?: DataColorPalette; UIColorPalette?: UIColorPalette; Sheet?: SheetStyle; Typography?: Typography; } /** *

The theme colors that are used for data colors in charts. The colors description is a * hexadecimal color code that consists of six alphanumerical characters, prefixed with * #, for example #37BFF5.

*/ export interface DataColorPalette { /** *

The hexadecimal code of a color that applies to charts where a lack of data is * highlighted.

*/ EmptyFillColor?: string; /** *

The hexadecimal codes for the colors.

* * @minItems 0 * @maxItems 100 */ Colors?: string[]; /** *

The minimum and maximum hexadecimal codes that describe a color gradient.

* * @minItems 0 * @maxItems 100 */ MinMaxGradient?: string[]; } /** *

The theme colors that apply to UI and to charts, excluding data colors. The colors * description is a hexadecimal color code that consists of six alphanumerical characters, * prefixed with #, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User * Guide. *

*/ export interface UIColorPalette { /** *

This color that applies to warning and informational messages.

*/ Warning?: string; /** *

This color is that applies to selected states and buttons.

*/ Accent?: string; /** *

The foreground color that applies to any text or other elements that appear over the * accent color.

*/ AccentForeground?: string; /** *

The background color that applies to the sheet background and sheet controls.

*/ SecondaryBackground?: string; /** *

The foreground color that applies to any text or other elements that appear over the * error color.

*/ DangerForeground?: string; /** *

The background color that applies to visuals and other high emphasis UI.

*/ PrimaryBackground?: string; /** *

The color that applies to the names of fields that are identified as * dimensions.

*/ Dimension?: string; /** *

The foreground color that applies to any sheet title, sheet control text, or UI that * appears over the secondary background.

*/ SecondaryForeground?: string; /** *

The foreground color that applies to any text or other elements that appear over the * warning color.

*/ WarningForeground?: string; /** *

The foreground color that applies to any text or other elements that appear over the * dimension color.

*/ DimensionForeground?: string; /** *

The color of text and other foreground elements that appear over the primary * background regions, such as grid lines, borders, table banding, icons, and so on.

*/ PrimaryForeground?: string; /** *

The color that applies to success messages, for example the check mark for a * successful download.

*/ Success?: string; /** *

The color that applies to error messages.

*/ Danger?: string; /** *

The foreground color that applies to any text or other elements that appear over the * success color.

*/ SuccessForeground?: string; /** *

The color that applies to the names of fields that are identified as measures.

*/ Measure?: string; /** *

The foreground color that applies to any text or other elements that appear over the * measure color.

*/ MeasureForeground?: string; } /** *

The theme display options for sheets.

*/ export interface SheetStyle { TileLayout?: TileLayoutStyle; Tile?: TileStyle; } /** *

The display options for the layout of tiles on a sheet.

*/ export interface TileLayoutStyle { Gutter?: GutterStyle; Margin?: MarginStyle; } /** *

The display options for gutter spacing between tiles on a sheet.

*/ export interface GutterStyle { /** *

This Boolean value controls whether to display a gutter space between sheet tiles. *

*/ Show?: boolean; } /** *

The display options for margins around the outside edge of sheets.

*/ export interface MarginStyle { /** *

This Boolean value controls whether to display sheet margins.

*/ Show?: boolean; } /** *

Display options related to tiles on a sheet.

*/ export interface TileStyle { Border?: BorderStyle; } /** *

The display options for tile borders for visuals.

*/ export interface BorderStyle { /** *

The option to enable display of borders for visuals.

*/ Show?: boolean; } /** *

The typeface for the theme.

*/ export interface Typography { /** * @minItems 0 * @maxItems 5 */ FontFamilies?: | [] | [Font] | [Font, Font] | [Font, Font, Font] | [Font, Font, Font, Font] | [Font, Font, Font, Font, Font]; } export interface Font { FontFamily?: string; } /** *

Permission for the resource.

*/ export interface ResourcePermission { /** *

The IAM action to grant or revoke permissions on.

* * @minItems 1 * @maxItems 16 */ Actions: | [string] | [string, string] | [string, string, string] | [string, string, string, string] | [string, string, string, string, string] | [string, string, string, string, string, string] | [string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [ string, string, string, string, string, string, string, string, string, string, string, string, string, string, string ] | [ string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string ]; /** *

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

* */ Principal: string; } /** *

The key or keys of the key-value pairs for the resource tag or tags assigned to the * resource.

*/ export interface Tag { /** *

Tag value.

*/ Value: string; /** *

Tag key.

*/ Key: string; } /** *

A version of a theme.

*/ export interface ThemeVersion { Status?: ResourceStatus; /** *

Errors associated with the theme.

* * @minItems 1 */ Errors?: [ThemeError, ...ThemeError[]]; /** *

The description of the theme.

*/ Description?: string; /** *

The date and time that this theme version was created.

*/ CreatedTime?: string; Configuration?: ThemeConfiguration; /** *

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

*/ BaseThemeId?: string; /** *

The Amazon Resource Name (ARN) of the resource.

*/ Arn?: string; /** *

The version number of the theme.

*/ VersionNumber?: number; } /** *

Theme error.

*/ export interface ThemeError { Type?: ThemeErrorType; /** *

The error message.

*/ Message?: string; }