2020/07/06 - Amazon QuickSight - 13 new 3 updated api methods
Changes Add Theme APIs and update Dashboard APIs to support theme overrides.
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 AWS 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': {
'Border': {
'Show': True|False
}
},
'TileLayout': {
'Gutter': {
'Show': True|False
},
'Margin': {
'Show': True|False
}
}
}
},
'Errors': [
{
'Type': 'INTERNAL_FAILURE',
'Message': 'string'
},
],
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'
},
'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 Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default QuickSight 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.
Border (dict) --
The border around a tile.
Show (boolean) --
The option to enable display of borders for visuals.
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.
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 AWS request ID for this operation.
Describes the alias for a theme.
See also: AWS API Documentation
Request Syntax
client.describe_theme_alias(
AwsAccountId='string',
ThemeId='string',
AliasName='string'
)
string
[REQUIRED]
The ID of the AWS account that contains the theme alias that you're describing.
string
[REQUIRED]
The ID for the theme.
string
[REQUIRED]
The name of the theme alias that you want to describe.
dict
Response Syntax
{
'ThemeAlias': {
'Arn': 'string',
'AliasName': 'string',
'ThemeVersionNumber': 123
},
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
ThemeAlias (dict) --
Information about the theme alias.
Arn (string) --
The Amazon Resource Name (ARN) of the theme alias.
AliasName (string) --
The display name of the theme alias.
ThemeVersionNumber (integer) --
The version number of the theme alias.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
Creates a theme alias for a theme.
See also: AWS API Documentation
Request Syntax
client.create_theme_alias(
AwsAccountId='string',
ThemeId='string',
AliasName='string',
ThemeVersionNumber=123
)
string
[REQUIRED]
The ID of the AWS account that contains the theme for the new theme alias.
string
[REQUIRED]
An ID for the theme alias.
string
[REQUIRED]
The name that you want to give to the theme alias that you are creating. The alias name can't begin with a $ . Alias names that start with $ are reserved by Amazon QuickSight.
integer
[REQUIRED]
The version number of the theme.
dict
Response Syntax
{
'ThemeAlias': {
'Arn': 'string',
'AliasName': 'string',
'ThemeVersionNumber': 123
},
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
ThemeAlias (dict) --
Information about the theme alias.
Arn (string) --
The Amazon Resource Name (ARN) of the theme alias.
AliasName (string) --
The display name of the theme alias.
ThemeVersionNumber (integer) --
The version number of the theme alias.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
Deletes a theme.
See also: AWS API Documentation
Request Syntax
client.delete_theme(
AwsAccountId='string',
ThemeId='string',
VersionNumber=123
)
string
[REQUIRED]
The ID of the AWS account that contains the theme that you're deleting.
string
[REQUIRED]
An ID for the theme that you want to delete.
integer
The version of the theme that you want to delete.
Note: If you don't provide a version number, you're using this call to DeleteTheme to delete all versions of the theme.
dict
Response Syntax
{
'Arn': 'string',
'RequestId': 'string',
'Status': 123,
'ThemeId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
ThemeId (string) --
An ID for the theme.
Updates an alias of a theme.
See also: AWS API Documentation
Request Syntax
client.update_theme_alias(
AwsAccountId='string',
ThemeId='string',
AliasName='string',
ThemeVersionNumber=123
)
string
[REQUIRED]
The ID of the AWS account that contains the theme alias that you're updating.
string
[REQUIRED]
The ID for the theme.
string
[REQUIRED]
The name of the theme alias that you want to update.
integer
[REQUIRED]
The version number of the theme that the alias should reference.
dict
Response Syntax
{
'ThemeAlias': {
'Arn': 'string',
'AliasName': 'string',
'ThemeVersionNumber': 123
},
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
ThemeAlias (dict) --
Information about the theme alias.
Arn (string) --
The Amazon Resource Name (ARN) of the theme alias.
AliasName (string) --
The display name of the theme alias.
ThemeVersionNumber (integer) --
The version number of the theme alias.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
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 QuickSight in the Amazon QuickSight 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': {
'Border': {
'Show': True|False
}
},
'TileLayout': {
'Gutter': {
'Show': True|False
},
'Margin': {
'Show': True|False
}
}
}
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the AWS 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 AWS Region in each AWS 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 QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within a QuickSight 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.
Border (dict) --
The border around a tile.
Show (boolean) --
The option to enable display of borders for visuals.
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.
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 Amazon QuickSight user, group, or namespace. (This is most common.)
The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
Actions (list) -- [REQUIRED]
The action to grant or revoke permissions on, for example "quicksight:DescribeDashboard" .
(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',
'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 AWS request ID for this operation.
Lists all the aliases of a theme.
See also: AWS API Documentation
Request Syntax
client.list_theme_aliases(
AwsAccountId='string',
ThemeId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID of the AWS account that contains the theme aliases that you're listing.
string
[REQUIRED]
The ID for the theme.
string
The token for the next set of results, or null if there are no more results.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'ThemeAliasList': [
{
'Arn': 'string',
'AliasName': 'string',
'ThemeVersionNumber': 123
},
],
'Status': 123,
'RequestId': 'string',
'NextToken': 'string'
}
Response Structure
(dict) --
ThemeAliasList (list) --
A structure containing the list of the theme's aliases.
(dict) --
An alias for a theme.
Arn (string) --
The Amazon Resource Name (ARN) of the theme alias.
AliasName (string) --
The display name of the theme alias.
ThemeVersionNumber (integer) --
The version number of the theme alias.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
Lists all the versions of the themes in the current AWS account.
See also: AWS API Documentation
Request Syntax
client.list_theme_versions(
AwsAccountId='string',
ThemeId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID of the AWS account that contains the themes that you're listing.
string
[REQUIRED]
The ID for the theme.
string
The token for the next set of results, or null if there are no more results.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'ThemeVersionSummaryList': [
{
'VersionNumber': 123,
'Arn': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'
},
],
'NextToken': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
ThemeVersionSummaryList (list) --
A structure containing a list of all the versions of the specified theme.
(dict) --
The theme version.
VersionNumber (integer) --
The version number of the theme version.
Arn (string) --
The Amazon Resource Name (ARN) of the theme version.
Description (string) --
The description of the theme version.
CreatedTime (datetime) --
The date and time that this theme version was created.
Status (string) --
The status of the theme version.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
Lists all the themes in the current AWS account.
See also: AWS API Documentation
Request Syntax
client.list_themes(
AwsAccountId='string',
NextToken='string',
MaxResults=123,
Type='QUICKSIGHT'|'CUSTOM'|'ALL'
)
string
[REQUIRED]
The ID of the AWS account that contains the themes that you're listing.
string
The token for the next set of results, or null if there are no more results.
integer
The maximum number of results to be returned per request.
string
The type of themes that you want to list. Valid options include the following:
ALL (default) - Display all existing themes.
CUSTOM - Display only the themes created by people using Amazon QuickSight.
QUICKSIGHT - Display only the starting themes defined by QuickSight.
dict
Response Syntax
{
'ThemeSummaryList': [
{
'Arn': 'string',
'Name': 'string',
'ThemeId': 'string',
'LatestVersionNumber': 123,
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
ThemeSummaryList (list) --
Information about the themes in the list.
(dict) --
The theme summary.
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
Name (string) --
the display name for the theme.
ThemeId (string) --
The ID of the theme. This ID is unique per AWS Region for each AWS account.
LatestVersionNumber (integer) --
The latest version number for the theme.
CreatedTime (datetime) --
The date and time that this theme was created.
LastUpdatedTime (datetime) --
The last date and time that this theme was updated.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
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': {
'Border': {
'Show': True|False
}
},
'TileLayout': {
'Gutter': {
'Show': True|False
},
'Margin': {
'Show': True|False
}
}
}
}
)
string
[REQUIRED]
The ID of the AWS 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 QuickSight, that a custom theme inherits from. All themes initially inherit from a default QuickSight 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.
Border (dict) --
The border around a tile.
Show (boolean) --
The option to enable display of borders for visuals.
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.
dict
Response Syntax
{
'ThemeId': 'string',
'Arn': 'string',
'VersionArn': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED',
'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 AWS request ID for this operation.
Describes the read and write permissions for a theme.
See also: AWS API Documentation
Request Syntax
client.describe_theme_permissions(
AwsAccountId='string',
ThemeId='string'
)
string
[REQUIRED]
The ID of the AWS account that contains the theme that you're describing.
string
[REQUIRED]
The ID for the theme that you want to describe permissions for.
dict
Response Syntax
{
'ThemeId': 'string',
'ThemeArn': 'string',
'Permissions': [
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
ThemeId (string) --
The ID for the theme.
ThemeArn (string) --
The Amazon Resource Name (ARN) of the theme.
Permissions (list) --
A list of resource permissions set on the theme.
(dict) --
Permission for the resource.
Principal (string) --
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user, group, or namespace. (This is most common.)
The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
Actions (list) --
The action to grant or revoke permissions on, for example "quicksight:DescribeDashboard" .
(string) --
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
See also: AWS API Documentation
Request Syntax
client.delete_theme_alias(
AwsAccountId='string',
ThemeId='string',
AliasName='string'
)
string
[REQUIRED]
The ID of the AWS account that contains the theme alias to delete.
string
[REQUIRED]
The ID for the theme that the specified alias is for.
string
[REQUIRED]
The unique name for the theme alias to delete.
dict
Response Syntax
{
'AliasName': 'string',
'Arn': 'string',
'RequestId': 'string',
'Status': 123,
'ThemeId': 'string'
}
Response Structure
(dict) --
AliasName (string) --
The name for the theme alias.
Arn (string) --
The Amazon Resource Name (ARN) of the theme resource using the deleted alias.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
ThemeId (string) --
An ID for the theme associated with the deletion.
Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme" .
Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:
User
"quicksight:DescribeTheme"
"quicksight:DescribeThemeAlias"
"quicksight:ListThemeAliases"
"quicksight:ListThemeVersions"
Owner
"quicksight:DescribeTheme"
"quicksight:DescribeThemeAlias"
"quicksight:ListThemeAliases"
"quicksight:ListThemeVersions"
"quicksight:DeleteTheme"
"quicksight:UpdateTheme"
"quicksight:CreateThemeAlias"
"quicksight:DeleteThemeAlias"
"quicksight:UpdateThemeAlias"
"quicksight:UpdateThemePermissions"
"quicksight:DescribeThemePermissions"
To specify no permissions, omit the permissions list.
See also: AWS API Documentation
Request Syntax
client.update_theme_permissions(
AwsAccountId='string',
ThemeId='string',
GrantPermissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
RevokePermissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
]
)
string
[REQUIRED]
The ID of the AWS account that contains the theme.
string
[REQUIRED]
The ID for the theme.
list
A list of resource permissions to be granted for the 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 Amazon QuickSight user, group, or namespace. (This is most common.)
The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
Actions (list) -- [REQUIRED]
The action to grant or revoke permissions on, for example "quicksight:DescribeDashboard" .
(string) --
list
A list of resource permissions to be revoked from the 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 Amazon QuickSight user, group, or namespace. (This is most common.)
The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
Actions (list) -- [REQUIRED]
The action to grant or revoke permissions on, for example "quicksight:DescribeDashboard" .
(string) --
dict
Response Syntax
{
'ThemeId': 'string',
'ThemeArn': 'string',
'Permissions': [
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
ThemeId (string) --
The ID for the theme.
ThemeArn (string) --
The Amazon Resource Name (ARN) of the theme.
Permissions (list) --
The resulting list of resource permissions for the theme.
(dict) --
Permission for the resource.
Principal (string) --
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user, group, or namespace. (This is most common.)
The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
Actions (list) --
The action to grant or revoke permissions on, for example "quicksight:DescribeDashboard" .
(string) --
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'ThemeArn': 'string'}
Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. The CreateDashboard , DescribeDashboard , and ListDashboardsByUser API operations act on the dashboard entity. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.
See also: AWS API Documentation
Request Syntax
client.create_dashboard(
AwsAccountId='string',
DashboardId='string',
Name='string',
Parameters={
'StringParameters': [
{
'Name': 'string',
'Values': [
'string',
]
},
],
'IntegerParameters': [
{
'Name': 'string',
'Values': [
123,
]
},
],
'DecimalParameters': [
{
'Name': 'string',
'Values': [
123.0,
]
},
],
'DateTimeParameters': [
{
'Name': 'string',
'Values': [
datetime(2015, 1, 1),
]
},
]
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
SourceEntity={
'SourceTemplate': {
'DataSetReferences': [
{
'DataSetPlaceholder': 'string',
'DataSetArn': 'string'
},
],
'Arn': 'string'
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
VersionDescription='string',
DashboardPublishOptions={
'AdHocFilteringOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
},
'ExportToCSVOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
},
'SheetControlsOption': {
'VisibilityState': 'EXPANDED'|'COLLAPSED'
}
},
ThemeArn='string'
)
string
[REQUIRED]
The ID of the AWS account where you want to create the dashboard.
string
[REQUIRED]
The ID for the dashboard, also added to the IAM policy.
string
[REQUIRED]
The display name of the dashboard.
dict
The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.
StringParameters (list) --
String parameters.
(dict) --
String parameter.
Name (string) -- [REQUIRED]
A display name for the dataset.
Values (list) -- [REQUIRED]
Values.
(string) --
IntegerParameters (list) --
Integer parameters.
(dict) --
Integer parameter.
Name (string) -- [REQUIRED]
A display name for the dataset.
Values (list) -- [REQUIRED]
Values.
(integer) --
DecimalParameters (list) --
Decimal parameters.
(dict) --
Decimal parameter.
Name (string) -- [REQUIRED]
A display name for the dataset.
Values (list) -- [REQUIRED]
Values.
(float) --
DateTimeParameters (list) --
DateTime parameters.
(dict) --
Date time parameter.
Name (string) -- [REQUIRED]
A display name for the dataset.
Values (list) -- [REQUIRED]
Values.
(datetime) --
list
A structure that contains the permissions of the dashboard. You can use this structure for granting permissions with principal and action information.
(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 Amazon QuickSight user, group, or namespace. (This is most common.)
The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
Actions (list) -- [REQUIRED]
The action to grant or revoke permissions on, for example "quicksight:DescribeDashboard" .
(string) --
dict
[REQUIRED]
The entity that you are using as a source when you create the dashboard. In SourceEntity , you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate , specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.
Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
SourceTemplate (dict) --
Source template.
DataSetReferences (list) -- [REQUIRED]
Dataset references.
(dict) --
Dataset reference.
DataSetPlaceholder (string) -- [REQUIRED]
Dataset placeholder.
DataSetArn (string) -- [REQUIRED]
Dataset Amazon Resource Name (ARN).
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the resource.
list
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
(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.
string
A description for the first version of the dashboard being created.
dict
Options for publishing the dashboard when you create it:
AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED . When this is set to DISABLED , QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED . The visual option to export data to .csv format isn't enabled when this is set to DISABLED . This option is ENABLED by default.
VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED . This option is COLLAPSED by default.
AdHocFilteringOption (dict) --
Ad hoc (one-time) filtering option.
AvailabilityStatus (string) --
Availability status.
ExportToCSVOption (dict) --
Export to .csv option.
AvailabilityStatus (string) --
Availability status.
SheetControlsOption (dict) --
Sheet controls option.
VisibilityState (string) --
Visibility state.
string
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED',
'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 AWS request ID for this operation.
{'RequestId': 'string'}
Describes a template's metadata.
See also: AWS API Documentation
Request Syntax
client.describe_template(
AwsAccountId='string',
TemplateId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the AWS account that contains the template that you're describing.
string
[REQUIRED]
The ID for the template.
integer
(Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.
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
{
'Template': {
'Arn': 'string',
'Name': 'string',
'Version': {
'CreatedTime': datetime(2015, 1, 1),
'Errors': [
{
'Type': 'SOURCE_NOT_FOUND'|'DATA_SET_NOT_FOUND'|'INTERNAL_FAILURE',
'Message': 'string'
},
],
'VersionNumber': 123,
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED',
'DataSetConfigurations': [
{
'Placeholder': 'string',
'DataSetSchema': {
'ColumnSchemaList': [
{
'Name': 'string',
'DataType': 'string',
'GeographicRole': 'string'
},
]
},
'ColumnGroupSchemaList': [
{
'Name': 'string',
'ColumnGroupColumnSchemaList': [
{
'Name': 'string'
},
]
},
]
},
],
'Description': 'string',
'SourceEntityArn': 'string'
},
'TemplateId': 'string',
'LastUpdatedTime': datetime(2015, 1, 1),
'CreatedTime': datetime(2015, 1, 1)
},
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Template (dict) --
The template structure for the object you want to describe.
Arn (string) --
The Amazon Resource Name (ARN) of the template.
Name (string) --
The display name of the template.
Version (dict) --
A structure describing the versions of the template.
CreatedTime (datetime) --
The time that this template version was created.
Errors (list) --
Errors associated with the template.
(dict) --
List of errors that occurred when the template version creation failed.
Type (string) --
Type of error.
Message (string) --
Description of the error type.
VersionNumber (integer) --
The version number of the template.
Status (string) --
The HTTP status of the request.
DataSetConfigurations (list) --
Schema of the dataset identified by the placeholder. The idea is that any dashboard created from the template should be bound to new datasets matching the same schema described through this API. .
(dict) --
Dataset configuration.
Placeholder (string) --
Placeholder.
DataSetSchema (dict) --
Dataset schema.
ColumnSchemaList (list) --
A structure containing the list of column schemas.
(dict) --
The column schema.
Name (string) --
The name of the column schema.
DataType (string) --
The data type of the column schema.
GeographicRole (string) --
The geographic role of the column schema.
ColumnGroupSchemaList (list) --
A structure containing the list of column group schemas.
(dict) --
The column group schema.
Name (string) --
The name of the column group schema.
ColumnGroupColumnSchemaList (list) --
A structure containing the list of schemas for column group columns.
(dict) --
A structure describing the name, data type, and geographic role of the columns.
Name (string) --
The name of the column group's column schema.
Description (string) --
The description of the template.
SourceEntityArn (string) --
The Amazon Resource Name (ARN) of the analysis or template which was used to create this template.
TemplateId (string) --
The ID for the template. This is unique per AWS Region for each AWS account.
LastUpdatedTime (datetime) --
Time when this was last updated.
CreatedTime (datetime) --
Time when this was created.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
{'ThemeArn': 'string'}
Updates a dashboard in an AWS account.
See also: AWS API Documentation
Request Syntax
client.update_dashboard(
AwsAccountId='string',
DashboardId='string',
Name='string',
SourceEntity={
'SourceTemplate': {
'DataSetReferences': [
{
'DataSetPlaceholder': 'string',
'DataSetArn': 'string'
},
],
'Arn': 'string'
}
},
Parameters={
'StringParameters': [
{
'Name': 'string',
'Values': [
'string',
]
},
],
'IntegerParameters': [
{
'Name': 'string',
'Values': [
123,
]
},
],
'DecimalParameters': [
{
'Name': 'string',
'Values': [
123.0,
]
},
],
'DateTimeParameters': [
{
'Name': 'string',
'Values': [
datetime(2015, 1, 1),
]
},
]
},
VersionDescription='string',
DashboardPublishOptions={
'AdHocFilteringOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
},
'ExportToCSVOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
},
'SheetControlsOption': {
'VisibilityState': 'EXPANDED'|'COLLAPSED'
}
},
ThemeArn='string'
)
string
[REQUIRED]
The ID of the AWS account that contains the dashboard that you're updating.
string
[REQUIRED]
The ID for the dashboard.
string
[REQUIRED]
The display name of the dashboard.
dict
[REQUIRED]
The entity that you are using as a source when you update the dashboard. In SourceEntity , you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate , specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.
Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
SourceTemplate (dict) --
Source template.
DataSetReferences (list) -- [REQUIRED]
Dataset references.
(dict) --
Dataset reference.
DataSetPlaceholder (string) -- [REQUIRED]
Dataset placeholder.
DataSetArn (string) -- [REQUIRED]
Dataset Amazon Resource Name (ARN).
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the resource.
dict
A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.
StringParameters (list) --
String parameters.
(dict) --
String parameter.
Name (string) -- [REQUIRED]
A display name for the dataset.
Values (list) -- [REQUIRED]
Values.
(string) --
IntegerParameters (list) --
Integer parameters.
(dict) --
Integer parameter.
Name (string) -- [REQUIRED]
A display name for the dataset.
Values (list) -- [REQUIRED]
Values.
(integer) --
DecimalParameters (list) --
Decimal parameters.
(dict) --
Decimal parameter.
Name (string) -- [REQUIRED]
A display name for the dataset.
Values (list) -- [REQUIRED]
Values.
(float) --
DateTimeParameters (list) --
DateTime parameters.
(dict) --
Date time parameter.
Name (string) -- [REQUIRED]
A display name for the dataset.
Values (list) -- [REQUIRED]
Values.
(datetime) --
string
A description for the first version of the dashboard being created.
dict
Options for publishing the dashboard when you create it:
AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED . When this is set to DISABLED , QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED . The visual option to export data to .csv format isn't enabled when this is set to DISABLED . This option is ENABLED by default.
VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED . This option is COLLAPSED by default.
AdHocFilteringOption (dict) --
Ad hoc (one-time) filtering option.
AvailabilityStatus (string) --
Availability status.
ExportToCSVOption (dict) --
Export to .csv option.
AvailabilityStatus (string) --
Availability status.
SheetControlsOption (dict) --
Sheet controls option.
VisibilityState (string) --
Visibility state.
string
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same AWS account where you create the dashboard.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED',
'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 AWS request ID for this operation.