# Theme operations A *theme* is a collection of settings that you can apply to analyses and dashboards in Amazon Quick Sight. You can apply themes to modify the appearance of dashboards and analyses. With theme operations, you can perform actions on Quick Sight themes. For more information, see the following API operations. **Topics** + [ # Theme permissions ](theme-permissions.md) + [ # CreateTheme ](create-theme.md) + [ # DeleteTheme ](delete-theme.md) + [ # DescribeTheme ](describe-theme.md) + [ # ListThemes ](list-themes.md) + [ # ListThemeVersions ](list-theme-versions.md) + [ # UpdateTheme ](update-theme.md) # Theme permissions With theme permissions API operations, you can view and update permissions for themes. For more information, see the following API operations. + [DescribeThemePermissions](describe-theme-permissions.md) + [UpdateThemePermissions](update-theme-permissions.md) # DescribeThemePermissions Use the `DescribeThemePermissions` operation to describe the read and write permissions for a theme. To use this operation, you need the ID of the theme that you want to describe. You can use the `ListThemes` operation to list all themes and their corresponding theme IDs. Following is an example AWS CLI command for this operation. ------ #### [ AWS CLI ] ``` aws quicksight describe-theme-permissions --aws-account-id AWSACCOUNTID --theme-id THEMEID ``` ------ For more information about the `UpdateThemePermissions` operation, see [UpdateThemePermissions](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateThemePermissions.html) in the*Quick Sight API Reference*. # UpdateThemePermissions Use the `UpdateThemePermissions` operation to update the resource permissions for a template. You can grant or revoke permissions in the same command. To use this operation, you need the ID of the theme that you want to update. You can use the `ListThemes` operation to list all themes and their corresponding theme IDs. Following is an example AWS CLI command for this operation. ------ #### [ AWS CLI ] ``` aws quicksight update-theme-permissions --aws-account-id 555555555555 --theme-id 111122223333 --grant-permissions Principal=arn:aws:quicksight:us-east-1:AWSACCOUNTID:user/default/USERNAME,Actions=quicksight:ListThemeVersions, quicksight:UpdateThemeAlias, quicksight: DescribeThemeAlias, quicksight:UpdateThemePermissions, quicksight:DeleteThemeAlias, quicksight: DeleteTheme, quicksight:ListThemeAliases, quicksight:DescribeTheme, quicksight: CreateThemeAlias, quicksight:UpdateTheme, quicksight: DescribeThemePermissions --revoke-permissions Principal=arn:aws:quicksight:us-east-1:AWSACCOUNTID:user/default/USERNAME,Actions=quicksight:ListThemeVersions, quicksight:UpdateThemeAlias, quicksight: DescribeThemeAlias, quicksight:UpdateThemePermissions, quicksight:DeleteThemeAlias, quicksight: DeleteTheme, quicksight:ListThemeAliases, quicksight:DescribeTheme, quicksight: CreateThemeAlias, quicksight:UpdateTheme, quicksight: DescribeThemePermissions ``` If your `region` has already been configured within the CLI, it doesn't need to be included as an argument. You can also make this command using a CLI skeleton file with the following command. For more information about CLI skeleton files, see [Use CLI skeleton files](cli-skeletons.md). ``` aws quicksight update-theme-permissions --cli-input-json file//:updatethemepermissions.json ``` ------ If your region has already been configured with the CLI, it does not need to be included in an argument. For more information on the `UpdateThemePermissions` operation, see [UpdateThemePermissions](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateThemePermissions.html) in the * Quick Sight API Reference*. # CreateTheme Use the `CreateTheme` operation to create a theme. The `base-theme-id` is the ID of the theme that you want to base the new theme off of. You can use the `ListThemes` operation to list all themes and their corresponding theme IDs. Following is an example AWS CLI command for this operation. ------ #### [ AWS CLI ] ``` aws quicksight create-theme --aws-account-id AWSACCOUNTID --theme-id THEMEID --name NAME --base-theme-id THEMEID --configuration '{"Configuration":{"DataColorPalette":{"Colors":[""],"MinMaxGradient":[""],"EmptyFillColor":""},"UIColorPalette":{"PrimaryForeground":"","PrimaryBackground": "","SecondaryForeground":"","SecondaryBackground":"","Accent":"","AccentForeground":"","Danger":"","DangerForeground":"","Warning":"","WarningForeground":"","Success":"","SuccessForeground":"","Dimension":"","DimensionForeground":"","Measure":"","MeasureForeground":""},"Sheet":{"Tile":{"Border":{"Show":true}},"TileLayout":{"Gutter":{"Show":true},"Margin":{"Show":true}}}}' ``` You can also make this command using a CLI skeleton file with the following command. For more information about CLI skeleton files, see [Use CLI skeleton files](cli-skeletons.md). ``` aws quicksight create-theme --cli-input-json file//:createtheme.json ``` ------ For more information about the `CreateTheme` operation, see [CreateTheme](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTheme.html) in the*Quick Sight API Reference*. # DeleteTheme Use the `DeleteTheme` operation to delete a theme. To use this operation, you need the ID of the theme that you want to delete. You can use the `ListThemes` operation to list all themes and their corresponding theme IDs. Following is an example AWS CLI command for this operation. ------ #### [ AWS CLI ] ``` aws quicksight delete-theme --aws-account-id AWSACCOUNTID --theme-id THEMEID ``` ------ For more information about the `DeleteTheme` operation, see [DeleteTheme](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DeleteTheme.html) in the *Quick Sight API Reference*. # DescribeTheme Use the `DescribeTheme` operation to describe a theme. To use this operation, you need the ID of the theme that you want to describe. You can use the `ListThemes` operation to list all themes and their corresponding theme IDs. Following is an example AWS CLI command for this operation. ------ #### [ AWS CLI ] ``` aws quicksight describe-theme --aws-account-id AWSACCOUNTID --theme-id THEMEID --version-number 1 --alias-name ALIAS ``` ------ The parameter value for `alias-name` can be `$LATEST`. For more information about the `DescribeTheme` operation, see [DescribeTheme](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeTheme.html) in the *Quick Sight API Reference*. # ListThemes Use the `ListThemes` operation to list all the themes in the current AWS account. Following is an example AWS CLI command for this operation. ------ #### [ AWS CLI ] ``` aws quicksight list-themes --aws-account-id AWSACCOUNTID --type QUICKSIGHT --page-size 10 --max-items 100 ``` ------ For more information about the `ListThemes` operation, see [ListThemes](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ListThemes.html) in the *Quick Sight API Reference*. # ListThemeVersions Use the `ListThemeVersions` operation to list all the versions of the themes in the current AWS account. To use this operation to list the versions of a theme, you need that theme's ID. You can use the `ListThemes` operation to list all themes and their corresponding theme IDs. Following is an example AWS CLI command for this operation. ------ #### [ AWS CLI ] ``` aws quicksight list-theme-version --aws-account-id AWSACCOUNTID --theme-id THEMEID --page-size 10 --max-items 100 ``` ------ To list all themes and their theme IDs, call the `ListThemes` operation. For more information about the `ListThemeVersions` operation, see [ListThemeVersions](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ListThemeVersions.html) in the *Quick Sight API Reference*. # UpdateTheme Use the `UpdateTheme` operation to update a theme. Following is an example AWS CLI command for this operation. ------ #### [ AWS CLI ] ``` aws quicksight update-theme --aws-account-id 555555555555 --theme-id THEMEID --base-theme-id BASETHEMEID ``` You can also make this command using a CLI skeleton file with the following command. For more information about CLI skeleton files, see [Use CLI skeleton files](cli-skeletons.md). ``` aws quicksight update-theme --cli-input-json file//:updatetheme.json ``` ------ For more information about the `UpdateTheme` operation, see [UpdateTheme](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateTheme.html) in the*Quick Sight API Reference*.