[ aws . quicksight ]
Updates a theme.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
update-theme
--aws-account-id <value>
--theme-id <value>
[--name <value>]
--base-theme-id <value>
[--version-description <value>]
[--configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--aws-account-id
(string)
The ID of the Amazon Web Services account that contains the theme that you’re updating.
--theme-id
(string)
The ID for the theme.
--name
(string)
The name for the theme.
--base-theme-id
(string)
The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.
--version-description
(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 inVersionDescription
.
--configuration
(structure)
The theme configuration, which contains the theme display properties.
DataColorPalette -> (structure)
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 -> (structure)
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 -> (structure)
Display options related to sheets.
Tile -> (structure)
The display options for tiles.
Border -> (structure)
The border around a tile.
Show -> (boolean)
The option to enable display of borders for visuals.
TileLayout -> (structure)
The layout options for tiles.
Gutter -> (structure)
The gutter settings that apply between tiles.
Show -> (boolean)
This Boolean value controls whether to display a gutter space between sheet tiles.
Margin -> (structure)
The margin settings that apply around the outside edge of sheets.
Show -> (boolean)
This Boolean value controls whether to display sheet margins.
JSON Syntax:
{
"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": {
"Border": {
"Show": true|false
}
},
"TileLayout": {
"Gutter": {
"Show": true|false
},
"Margin": {
"Show": true|false
}
}
}
}
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
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.