2025/11/20 - Amazon QuickSight - 12 updated api methods
Changes Introducing comprehensive theme styling controls. New features include border customization (radius, width, color), flexible padding controls, background styling for cards and sheets, centralized typography management, and visual-level override support across layouts.
{'Definition': {'Sheets': {'Layouts': {'Configuration': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}},
'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}},
'SectionBasedLayout': {'BodySections': {'Content': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}},
'FooterSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}},
'HeaderSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}}}},
'SheetControlLayouts': {'Configuration': {'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}}}}}}}
Creates an analysis in Amazon Quick Sight. Analyses can be created either from a template or from an AnalysisDefinition.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'AnalysisId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN for the analysis.
AnalysisId (string) --
The ID of the analysis.
CreationStatus (string) --
The status of the creation of the analysis.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Sheets': {'Layouts': {'Configuration': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}},
'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}},
'SectionBasedLayout': {'BodySections': {'Content': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}},
'FooterSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}},
'HeaderSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}}}},
'SheetControlLayouts': {'Configuration': {'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}}}}}}}
Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in Amazon Quick Sight that identifies Amazon Quick Sight reports, created from analyses. You can share Amazon Quick Sight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the dashboard.
VersionArn (string) --
The ARN of the dashboard, including the version number of the first version that is created.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The status of the dashboard creation request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Sheets': {'Layouts': {'Configuration': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}},
'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}},
'SectionBasedLayout': {'BodySections': {'Content': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}},
'FooterSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}},
'HeaderSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}}}},
'SheetControlLayouts': {'Configuration': {'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}}}}}}}
Creates a template either from a TemplateDefinition or from an existing Quick Sight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.
A template is an entity in Quick Sight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'TemplateId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN for the template.
VersionArn (string) --
The ARN for the template, including the version information of the first version.
TemplateId (string) --
The ID of the template.
CreationStatus (string) --
The template creation status.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Configuration': {'Sheet': {'Background': {'Color': 'string',
'Gradient': 'string'},
'Tile': {'BackgroundColor': 'string',
'Border': {'Color': 'string',
'Width': 'string'},
'BorderRadius': 'string',
'Padding': 'string'}},
'Typography': {'AxisLabelFontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'AxisTitleFontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'DataLabelFontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'LegendTitleFontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'LegendValueFontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'VisualSubtitleFontConfiguration': {'FontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'TextAlignment': 'LEFT '
'| '
'CENTER '
'| '
'RIGHT '
'| '
'AUTO',
'TextTransform': 'CAPITALIZE'},
'VisualTitleFontConfiguration': {'FontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'TextAlignment': 'LEFT '
'| '
'CENTER '
'| '
'RIGHT '
'| '
'AUTO',
'TextTransform': 'CAPITALIZE'}}}}
Creates a theme.
A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon Quick Sight in the Amazon Quick Sight User Guide.
See also: AWS API Documentation
Request Syntax
client.create_theme(
AwsAccountId='string',
ThemeId='string',
Name='string',
BaseThemeId='string',
VersionDescription='string',
Configuration={
'DataColorPalette': {
'Colors': [
'string',
],
'MinMaxGradient': [
'string',
],
'EmptyFillColor': 'string'
},
'UIColorPalette': {
'PrimaryForeground': 'string',
'PrimaryBackground': 'string',
'SecondaryForeground': 'string',
'SecondaryBackground': 'string',
'Accent': 'string',
'AccentForeground': 'string',
'Danger': 'string',
'DangerForeground': 'string',
'Warning': 'string',
'WarningForeground': 'string',
'Success': 'string',
'SuccessForeground': 'string',
'Dimension': 'string',
'DimensionForeground': 'string',
'Measure': 'string',
'MeasureForeground': 'string'
},
'Sheet': {
'Tile': {
'BackgroundColor': 'string',
'Border': {
'Color': 'string',
'Show': True|False,
'Width': 'string'
},
'BorderRadius': 'string',
'Padding': 'string'
},
'TileLayout': {
'Gutter': {
'Show': True|False
},
'Margin': {
'Show': True|False
}
},
'Background': {
'Color': 'string',
'Gradient': 'string'
}
},
'Typography': {
'FontFamilies': [
{
'FontFamily': 'string'
},
],
'AxisTitleFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'AxisLabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'LegendTitleFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'LegendValueFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'DataLabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'VisualTitleFontConfiguration': {
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'TextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'TextTransform': 'CAPITALIZE'
},
'VisualSubtitleFontConfiguration': {
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'TextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'TextTransform': 'CAPITALIZE'
}
}
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account where you want to store the new theme.
string
[REQUIRED]
An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.
string
[REQUIRED]
A display name for the theme.
string
[REQUIRED]
The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon Quick Sight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis.
string
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.
dict
[REQUIRED]
The theme configuration, which contains the theme display properties.
DataColorPalette (dict) --
Color properties that apply to chart data colors.
Colors (list) --
The hexadecimal codes for the colors.
(string) --
MinMaxGradient (list) --
The minimum and maximum hexadecimal codes that describe a color gradient.
(string) --
EmptyFillColor (string) --
The hexadecimal code of a color that applies to charts where a lack of data is highlighted.
UIColorPalette (dict) --
Color properties that apply to the UI and to charts, excluding the colors that apply to data.
PrimaryForeground (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.
PrimaryBackground (string) --
The background color that applies to visuals and other high emphasis UI.
SecondaryForeground (string) --
The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.
SecondaryBackground (string) --
The background color that applies to the sheet background and sheet controls.
Accent (string) --
This color is that applies to selected states and buttons.
AccentForeground (string) --
The foreground color that applies to any text or other elements that appear over the accent color.
Danger (string) --
The color that applies to error messages.
DangerForeground (string) --
The foreground color that applies to any text or other elements that appear over the error color.
Warning (string) --
This color that applies to warning and informational messages.
WarningForeground (string) --
The foreground color that applies to any text or other elements that appear over the warning color.
Success (string) --
The color that applies to success messages, for example the check mark for a successful download.
SuccessForeground (string) --
The foreground color that applies to any text or other elements that appear over the success color.
Dimension (string) --
The color that applies to the names of fields that are identified as dimensions.
DimensionForeground (string) --
The foreground color that applies to any text or other elements that appear over the dimension color.
Measure (string) --
The color that applies to the names of fields that are identified as measures.
MeasureForeground (string) --
The foreground color that applies to any text or other elements that appear over the measure color.
Sheet (dict) --
Display options related to sheets.
Tile (dict) --
The display options for tiles.
BackgroundColor (string) --
The background color of a tile.
Border (dict) --
The border around a tile.
Color (string) --
The option to add color for tile borders for visuals.
Show (boolean) --
The option to enable display of borders for visuals.
Width (string) --
The option to set the width of tile borders for visuals.
BorderRadius (string) --
The border radius of a tile.
Padding (string) --
The padding of a tile.
TileLayout (dict) --
The layout options for tiles.
Gutter (dict) --
The gutter settings that apply between tiles.
Show (boolean) --
This Boolean value controls whether to display a gutter space between sheet tiles.
Margin (dict) --
The margin settings that apply around the outside edge of sheets.
Show (boolean) --
This Boolean value controls whether to display sheet margins.
Background (dict) --
The background for sheets.
Color (string) --
The solid color background option for sheets.
Gradient (string) --
The gradient background option for sheets.
Typography (dict) --
Determines the typography options.
FontFamilies (list) --
Determines the list of font families.
(dict) --
Determines the font settings.
FontFamily (string) --
Determines the font family settings.
AxisTitleFontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
AxisLabelFontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
LegendTitleFontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
LegendValueFontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
DataLabelFontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
VisualTitleFontConfiguration (dict) --
Configures the display properties of the visual title.
FontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
TextAlignment (string) --
Determines the alignment of visual title.
TextTransform (string) --
Determines the text transformation of visual title.
VisualSubtitleFontConfiguration (dict) --
Configures the display properties of the visual sub-title.
FontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
TextAlignment (string) --
Determines the alignment of visual sub-title.
TextTransform (string) --
Determines the text transformation of visual sub-title.
list
A valid grouping of resource permissions to apply to the new theme.
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)
The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
list
A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'ThemeId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) for the theme.
VersionArn (string) --
The Amazon Resource Name (ARN) for the new theme.
ThemeId (string) --
The ID of the theme.
CreationStatus (string) --
The theme creation status.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Sheets': {'Layouts': {'Configuration': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}},
'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}},
'SectionBasedLayout': {'BodySections': {'Content': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}},
'FooterSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}},
'HeaderSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}}}},
'SheetControlLayouts': {'Configuration': {'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}}}}}}}
Provides a detailed description of the definition of an analysis.
See also: AWS API Documentation
Request Syntax
client.describe_analysis_definition(
AwsAccountId='string',
AnalysisId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.
string
[REQUIRED]
The ID of the analysis that you're describing. The ID is part of the URL of the analysis.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'Definition': {'Sheets': {'Layouts': {'Configuration': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}},
'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}},
'SectionBasedLayout': {'BodySections': {'Content': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}},
'FooterSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}},
'HeaderSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}}}},
'SheetControlLayouts': {'Configuration': {'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}}}}}}}
Provides a detailed description of the definition of a dashboard.
See also: AWS API Documentation
Request Syntax
client.describe_dashboard_definition(
AwsAccountId='string',
DashboardId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard that you're describing.
string
[REQUIRED]
The ID for the dashboard.
integer
The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
string
The alias name.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'Definition': {'Sheets': {'Layouts': {'Configuration': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}},
'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}},
'SectionBasedLayout': {'BodySections': {'Content': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}},
'FooterSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}},
'HeaderSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}}}},
'SheetControlLayouts': {'Configuration': {'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}}}}}}}
Provides a detailed description of the definition of a template.
See also: AWS API Documentation
Request Syntax
client.describe_template_definition(
AwsAccountId='string',
TemplateId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.
string
[REQUIRED]
The ID of the template that you're describing.
integer
The version number of the template.
string
The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'Theme': {'Version': {'Configuration': {'Sheet': {'Background': {'Color': 'string',
'Gradient': 'string'},
'Tile': {'BackgroundColor': 'string',
'Border': {'Color': 'string',
'Width': 'string'},
'BorderRadius': 'string',
'Padding': 'string'}},
'Typography': {'AxisLabelFontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'AxisTitleFontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'DataLabelFontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'LegendTitleFontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'LegendValueFontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'VisualSubtitleFontConfiguration': {'FontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'TextAlignment': 'LEFT '
'| '
'CENTER '
'| '
'RIGHT '
'| '
'AUTO',
'TextTransform': 'CAPITALIZE'},
'VisualTitleFontConfiguration': {'FontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'TextAlignment': 'LEFT '
'| '
'CENTER '
'| '
'RIGHT '
'| '
'AUTO',
'TextTransform': 'CAPITALIZE'}}}}}}
Describes a theme.
See also: AWS API Documentation
Request Syntax
client.describe_theme(
AwsAccountId='string',
ThemeId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the theme that you're describing.
string
[REQUIRED]
The ID for the theme.
integer
The version number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the theme is described.
string
The alias of the theme that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the theme by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to themes.
dict
Response Syntax
{
'Theme': {
'Arn': 'string',
'Name': 'string',
'ThemeId': 'string',
'Version': {
'VersionNumber': 123,
'Arn': 'string',
'Description': 'string',
'BaseThemeId': 'string',
'CreatedTime': datetime(2015, 1, 1),
'Configuration': {
'DataColorPalette': {
'Colors': [
'string',
],
'MinMaxGradient': [
'string',
],
'EmptyFillColor': 'string'
},
'UIColorPalette': {
'PrimaryForeground': 'string',
'PrimaryBackground': 'string',
'SecondaryForeground': 'string',
'SecondaryBackground': 'string',
'Accent': 'string',
'AccentForeground': 'string',
'Danger': 'string',
'DangerForeground': 'string',
'Warning': 'string',
'WarningForeground': 'string',
'Success': 'string',
'SuccessForeground': 'string',
'Dimension': 'string',
'DimensionForeground': 'string',
'Measure': 'string',
'MeasureForeground': 'string'
},
'Sheet': {
'Tile': {
'BackgroundColor': 'string',
'Border': {
'Color': 'string',
'Show': True|False,
'Width': 'string'
},
'BorderRadius': 'string',
'Padding': 'string'
},
'TileLayout': {
'Gutter': {
'Show': True|False
},
'Margin': {
'Show': True|False
}
},
'Background': {
'Color': 'string',
'Gradient': 'string'
}
},
'Typography': {
'FontFamilies': [
{
'FontFamily': 'string'
},
],
'AxisTitleFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'AxisLabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'LegendTitleFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'LegendValueFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'DataLabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'VisualTitleFontConfiguration': {
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'TextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'TextTransform': 'CAPITALIZE'
},
'VisualSubtitleFontConfiguration': {
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'TextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'TextTransform': 'CAPITALIZE'
}
}
},
'Errors': [
{
'Type': 'INTERNAL_FAILURE',
'Message': 'string'
},
],
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED'
},
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'Type': 'QUICKSIGHT'|'CUSTOM'|'ALL'
},
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Theme (dict) --
The information about the theme that you are describing.
Arn (string) --
The Amazon Resource Name (ARN) of the theme.
Name (string) --
The name that the user gives to the theme.
ThemeId (string) --
The identifier that the user gives to the theme.
Version (dict) --
A version of a theme.
VersionNumber (integer) --
The version number of the theme.
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
Description (string) --
The description of the theme.
BaseThemeId (string) --
The Quick Sight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default Quick Sight theme.
CreatedTime (datetime) --
The date and time that this theme version was created.
Configuration (dict) --
The theme configuration, which contains all the theme display properties.
DataColorPalette (dict) --
Color properties that apply to chart data colors.
Colors (list) --
The hexadecimal codes for the colors.
(string) --
MinMaxGradient (list) --
The minimum and maximum hexadecimal codes that describe a color gradient.
(string) --
EmptyFillColor (string) --
The hexadecimal code of a color that applies to charts where a lack of data is highlighted.
UIColorPalette (dict) --
Color properties that apply to the UI and to charts, excluding the colors that apply to data.
PrimaryForeground (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.
PrimaryBackground (string) --
The background color that applies to visuals and other high emphasis UI.
SecondaryForeground (string) --
The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.
SecondaryBackground (string) --
The background color that applies to the sheet background and sheet controls.
Accent (string) --
This color is that applies to selected states and buttons.
AccentForeground (string) --
The foreground color that applies to any text or other elements that appear over the accent color.
Danger (string) --
The color that applies to error messages.
DangerForeground (string) --
The foreground color that applies to any text or other elements that appear over the error color.
Warning (string) --
This color that applies to warning and informational messages.
WarningForeground (string) --
The foreground color that applies to any text or other elements that appear over the warning color.
Success (string) --
The color that applies to success messages, for example the check mark for a successful download.
SuccessForeground (string) --
The foreground color that applies to any text or other elements that appear over the success color.
Dimension (string) --
The color that applies to the names of fields that are identified as dimensions.
DimensionForeground (string) --
The foreground color that applies to any text or other elements that appear over the dimension color.
Measure (string) --
The color that applies to the names of fields that are identified as measures.
MeasureForeground (string) --
The foreground color that applies to any text or other elements that appear over the measure color.
Sheet (dict) --
Display options related to sheets.
Tile (dict) --
The display options for tiles.
BackgroundColor (string) --
The background color of a tile.
Border (dict) --
The border around a tile.
Color (string) --
The option to add color for tile borders for visuals.
Show (boolean) --
The option to enable display of borders for visuals.
Width (string) --
The option to set the width of tile borders for visuals.
BorderRadius (string) --
The border radius of a tile.
Padding (string) --
The padding of a tile.
TileLayout (dict) --
The layout options for tiles.
Gutter (dict) --
The gutter settings that apply between tiles.
Show (boolean) --
This Boolean value controls whether to display a gutter space between sheet tiles.
Margin (dict) --
The margin settings that apply around the outside edge of sheets.
Show (boolean) --
This Boolean value controls whether to display sheet margins.
Background (dict) --
The background for sheets.
Color (string) --
The solid color background option for sheets.
Gradient (string) --
The gradient background option for sheets.
Typography (dict) --
Determines the typography options.
FontFamilies (list) --
Determines the list of font families.
(dict) --
Determines the font settings.
FontFamily (string) --
Determines the font family settings.
AxisTitleFontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
AxisLabelFontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
LegendTitleFontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
LegendValueFontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
DataLabelFontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
VisualTitleFontConfiguration (dict) --
Configures the display properties of the visual title.
FontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
TextAlignment (string) --
Determines the alignment of visual title.
TextTransform (string) --
Determines the text transformation of visual title.
VisualSubtitleFontConfiguration (dict) --
Configures the display properties of the visual sub-title.
FontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
TextAlignment (string) --
Determines the alignment of visual sub-title.
TextTransform (string) --
Determines the text transformation of visual sub-title.
Errors (list) --
Errors associated with the theme.
(dict) --
Theme error.
Type (string) --
The type of error.
Message (string) --
The error message.
Status (string) --
The status of the theme version.
CreatedTime (datetime) --
The date and time that the theme was created.
LastUpdatedTime (datetime) --
The date and time that the theme was last updated.
Type (string) --
The type of theme, based on how it was created. Valid values include: QUICKSIGHT and CUSTOM.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Sheets': {'Layouts': {'Configuration': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}},
'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}},
'SectionBasedLayout': {'BodySections': {'Content': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}},
'FooterSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}},
'HeaderSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}}}},
'SheetControlLayouts': {'Configuration': {'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}}}}}}}
Updates an analysis in Amazon Quick Sight
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'AnalysisId': 'string',
'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the analysis that you're updating.
AnalysisId (string) --
The ID of the analysis.
UpdateStatus (string) --
The update status of the last update that was made to the analysis.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Sheets': {'Layouts': {'Configuration': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}},
'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}},
'SectionBasedLayout': {'BodySections': {'Content': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}},
'FooterSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}},
'HeaderSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}}}},
'SheetControlLayouts': {'Configuration': {'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}}}}}}}
Updates a dashboard in an Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
VersionArn (string) --
The ARN of the dashboard, including the version number.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The creation status of the request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Sheets': {'Layouts': {'Configuration': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}},
'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}},
'SectionBasedLayout': {'BodySections': {'Content': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}},
'FooterSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}},
'HeaderSections': {'Layout': {'FreeFormLayout': {'Elements': {'BorderRadius': 'string',
'BorderStyle': {'Width': 'string'},
'Padding': 'string',
'SelectedBorderStyle': {'Width': 'string'}}}}}}}},
'SheetControlLayouts': {'Configuration': {'GridLayout': {'Elements': {'BackgroundStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'BorderRadius': 'string',
'BorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'},
'LoadingAnimation': {'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'Padding': 'string',
'SelectedBorderStyle': {'Color': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE',
'Width': 'string'}}}}}}}}
Updates a template from an existing Amazon Quick Sight analysis or another template.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'TemplateId': 'string',
'Arn': 'string',
'VersionArn': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
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 (string) --
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.
{'Configuration': {'Sheet': {'Background': {'Color': 'string',
'Gradient': 'string'},
'Tile': {'BackgroundColor': 'string',
'Border': {'Color': 'string',
'Width': 'string'},
'BorderRadius': 'string',
'Padding': 'string'}},
'Typography': {'AxisLabelFontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'AxisTitleFontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'DataLabelFontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'LegendTitleFontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'LegendValueFontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'VisualSubtitleFontConfiguration': {'FontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'TextAlignment': 'LEFT '
'| '
'CENTER '
'| '
'RIGHT '
'| '
'AUTO',
'TextTransform': 'CAPITALIZE'},
'VisualTitleFontConfiguration': {'FontConfiguration': {'FontColor': 'string',
'FontDecoration': 'UNDERLINE '
'| '
'NONE',
'FontFamily': 'string',
'FontSize': {'Absolute': 'string',
'Relative': 'EXTRA_SMALL '
'| '
'SMALL '
'| '
'MEDIUM '
'| '
'LARGE '
'| '
'EXTRA_LARGE'},
'FontStyle': 'NORMAL '
'| '
'ITALIC',
'FontWeight': {'Name': 'NORMAL '
'| '
'BOLD'}},
'TextAlignment': 'LEFT '
'| '
'CENTER '
'| '
'RIGHT '
'| '
'AUTO',
'TextTransform': 'CAPITALIZE'}}}}
Updates a theme.
See also: AWS API Documentation
Request Syntax
client.update_theme(
AwsAccountId='string',
ThemeId='string',
Name='string',
BaseThemeId='string',
VersionDescription='string',
Configuration={
'DataColorPalette': {
'Colors': [
'string',
],
'MinMaxGradient': [
'string',
],
'EmptyFillColor': 'string'
},
'UIColorPalette': {
'PrimaryForeground': 'string',
'PrimaryBackground': 'string',
'SecondaryForeground': 'string',
'SecondaryBackground': 'string',
'Accent': 'string',
'AccentForeground': 'string',
'Danger': 'string',
'DangerForeground': 'string',
'Warning': 'string',
'WarningForeground': 'string',
'Success': 'string',
'SuccessForeground': 'string',
'Dimension': 'string',
'DimensionForeground': 'string',
'Measure': 'string',
'MeasureForeground': 'string'
},
'Sheet': {
'Tile': {
'BackgroundColor': 'string',
'Border': {
'Color': 'string',
'Show': True|False,
'Width': 'string'
},
'BorderRadius': 'string',
'Padding': 'string'
},
'TileLayout': {
'Gutter': {
'Show': True|False
},
'Margin': {
'Show': True|False
}
},
'Background': {
'Color': 'string',
'Gradient': 'string'
}
},
'Typography': {
'FontFamilies': [
{
'FontFamily': 'string'
},
],
'AxisTitleFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'AxisLabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'LegendTitleFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'LegendValueFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'DataLabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'VisualTitleFontConfiguration': {
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'TextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'TextTransform': 'CAPITALIZE'
},
'VisualSubtitleFontConfiguration': {
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE',
'Absolute': 'string'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC',
'FontFamily': 'string'
},
'TextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'TextTransform': 'CAPITALIZE'
}
}
}
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the theme that you're updating.
string
[REQUIRED]
The ID for the theme.
string
The name for the theme.
string
[REQUIRED]
The theme ID, defined by Amazon Quick Sight, that a custom theme inherits from. All themes initially inherit from a default Quick Sight theme.
string
A description of the theme version that you're updating Every time that you call UpdateTheme, you create a new version of the theme. Each version of the theme maintains a description of the version in VersionDescription.
dict
The theme configuration, which contains the theme display properties.
DataColorPalette (dict) --
Color properties that apply to chart data colors.
Colors (list) --
The hexadecimal codes for the colors.
(string) --
MinMaxGradient (list) --
The minimum and maximum hexadecimal codes that describe a color gradient.
(string) --
EmptyFillColor (string) --
The hexadecimal code of a color that applies to charts where a lack of data is highlighted.
UIColorPalette (dict) --
Color properties that apply to the UI and to charts, excluding the colors that apply to data.
PrimaryForeground (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.
PrimaryBackground (string) --
The background color that applies to visuals and other high emphasis UI.
SecondaryForeground (string) --
The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.
SecondaryBackground (string) --
The background color that applies to the sheet background and sheet controls.
Accent (string) --
This color is that applies to selected states and buttons.
AccentForeground (string) --
The foreground color that applies to any text or other elements that appear over the accent color.
Danger (string) --
The color that applies to error messages.
DangerForeground (string) --
The foreground color that applies to any text or other elements that appear over the error color.
Warning (string) --
This color that applies to warning and informational messages.
WarningForeground (string) --
The foreground color that applies to any text or other elements that appear over the warning color.
Success (string) --
The color that applies to success messages, for example the check mark for a successful download.
SuccessForeground (string) --
The foreground color that applies to any text or other elements that appear over the success color.
Dimension (string) --
The color that applies to the names of fields that are identified as dimensions.
DimensionForeground (string) --
The foreground color that applies to any text or other elements that appear over the dimension color.
Measure (string) --
The color that applies to the names of fields that are identified as measures.
MeasureForeground (string) --
The foreground color that applies to any text or other elements that appear over the measure color.
Sheet (dict) --
Display options related to sheets.
Tile (dict) --
The display options for tiles.
BackgroundColor (string) --
The background color of a tile.
Border (dict) --
The border around a tile.
Color (string) --
The option to add color for tile borders for visuals.
Show (boolean) --
The option to enable display of borders for visuals.
Width (string) --
The option to set the width of tile borders for visuals.
BorderRadius (string) --
The border radius of a tile.
Padding (string) --
The padding of a tile.
TileLayout (dict) --
The layout options for tiles.
Gutter (dict) --
The gutter settings that apply between tiles.
Show (boolean) --
This Boolean value controls whether to display a gutter space between sheet tiles.
Margin (dict) --
The margin settings that apply around the outside edge of sheets.
Show (boolean) --
This Boolean value controls whether to display sheet margins.
Background (dict) --
The background for sheets.
Color (string) --
The solid color background option for sheets.
Gradient (string) --
The gradient background option for sheets.
Typography (dict) --
Determines the typography options.
FontFamilies (list) --
Determines the list of font families.
(dict) --
Determines the font settings.
FontFamily (string) --
Determines the font family settings.
AxisTitleFontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
AxisLabelFontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
LegendTitleFontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
LegendValueFontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
DataLabelFontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
VisualTitleFontConfiguration (dict) --
Configures the display properties of the visual title.
FontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
TextAlignment (string) --
Determines the alignment of visual title.
TextTransform (string) --
Determines the text transformation of visual title.
VisualSubtitleFontConfiguration (dict) --
Configures the display properties of the visual sub-title.
FontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
Absolute (string) --
The font size that you want to use in px.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontFamily (string) --
The font family that you want to use.
TextAlignment (string) --
Determines the alignment of visual sub-title.
TextTransform (string) --
Determines the text transformation of visual sub-title.
dict
Response Syntax
{
'ThemeId': 'string',
'Arn': 'string',
'VersionArn': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
ThemeId (string) --
The ID for the theme.
Arn (string) --
The Amazon Resource Name (ARN) for the theme.
VersionArn (string) --
The Amazon Resource Name (ARN) for the new version of the theme.
CreationStatus (string) --
The creation status of the theme.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.