2020/08/17 - Amazon QuickSight - 9 new 16 updated api methods
Changes Amazon QuickSight now supports programmatic creation and management of analyses with new APIs.
Provides a summary of the metadata for an analysis.
See also: AWS API Documentation
Request Syntax
client.describe_analysis(
AwsAccountId='string',
AnalysisId='string'
)
string
[REQUIRED]
The ID of the AWS account that contains the analysis. You must be using the AWS 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
{
'Analysis': {
'AnalysisId': 'string',
'Arn': 'string',
'Name': 'string',
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Errors': [
{
'Type': 'ACCESS_DENIED'|'SOURCE_NOT_FOUND'|'DATA_SET_NOT_FOUND'|'INTERNAL_FAILURE'|'PARAMETER_VALUE_INCOMPATIBLE'|'PARAMETER_TYPE_INVALID'|'PARAMETER_NOT_FOUND'|'COLUMN_TYPE_MISMATCH'|'COLUMN_GEOGRAPHIC_ROLE_MISMATCH'|'COLUMN_REPLACEMENT_MISSING',
'Message': 'string'
},
],
'DataSetArns': [
'string',
],
'ThemeArn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Analysis (dict) --
A metadata structure that contains summary information for the analysis that you're describing.
AnalysisId (string) --
The ID of the analysis.
Arn (string) --
The Amazon Resource Name (ARN) of the analysis.
Name (string) --
The descriptive name of the analysis.
Status (string) --
Status associated with the analysis.
Errors (list) --
Errors associated with the analysis.
(dict) --
A metadata error structure for an analysis.
Type (string) --
The type of the analysis error.
Message (string) --
The message associated with the analysis error.
DataSetArns (list) --
The ARNs of the datasets of the analysis.
(string) --
ThemeArn (string) --
The ARN of the theme of the analysis.
CreatedTime (datetime) --
The time that the analysis was created.
LastUpdatedTime (datetime) --
The time that the analysis was last updated.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
Updates the read and write permissions for an analysis.
See also: AWS API Documentation
Request Syntax
client.update_analysis_permissions(
AwsAccountId='string',
AnalysisId='string',
GrantPermissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
RevokePermissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
]
)
string
[REQUIRED]
The ID of the AWS account that contains the analysis whose permissions you're updating. You must be using the AWS account that the analysis is in.
string
[REQUIRED]
The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.
list
A structure that describes the permissions to add and the principal to add them to.
(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 IAM action to grant or revoke permissions on, for example "quicksight:DescribeDashboard" .
(string) --
list
A structure that describes the permissions to remove and the principal to remove them from.
(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 IAM action to grant or revoke permissions on, for example "quicksight:DescribeDashboard" .
(string) --
dict
Response Syntax
{
'AnalysisArn': 'string',
'AnalysisId': 'string',
'Permissions': [
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
AnalysisArn (string) --
The Amazon Resource Name (ARN) of the analysis that you updated.
AnalysisId (string) --
The ID of the analysis that you updated permissions for.
Permissions (list) --
A structure that describes the principals and the resource-level permissions on an analysis.
(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 IAM 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.
Updates an analysis in Amazon QuickSight
See also: AWS API Documentation
Request Syntax
client.update_analysis(
AwsAccountId='string',
AnalysisId='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),
]
},
]
},
SourceEntity={
'SourceTemplate': {
'DataSetReferences': [
{
'DataSetPlaceholder': 'string',
'DataSetArn': 'string'
},
],
'Arn': 'string'
}
},
ThemeArn='string'
)
string
[REQUIRED]
The ID of the AWS account that contains the analysis that you're updating.
string
[REQUIRED]
The ID for the analysis that you're updating. This ID displays in the URL of the analysis.
string
[REQUIRED]
A descriptive name for the analysis that you're updating. This name displays for the analysis in the QuickSight console.
dict
The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
StringParameters (list) --
String parameters.
(dict) --
A string parameter.
Name (string) -- [REQUIRED]
A display name for a string parameter.
Values (list) -- [REQUIRED]
The values of a string parameter.
(string) --
IntegerParameters (list) --
Integer parameters.
(dict) --
An integer parameter.
Name (string) -- [REQUIRED]
The name of the integer parameter.
Values (list) -- [REQUIRED]
The values for the integer parameter.
(integer) --
DecimalParameters (list) --
Decimal parameters.
(dict) --
A decimal parameter.
Name (string) -- [REQUIRED]
A display name for the decimal parameter.
Values (list) -- [REQUIRED]
The values for the decimal parameter.
(float) --
DateTimeParameters (list) --
Date-time parameters.
(dict) --
A date-time parameter.
Name (string) -- [REQUIRED]
A display name for the date-time parameter.
Values (list) -- [REQUIRED]
The values for the date-time parameter.
(datetime) --
dict
[REQUIRED]
A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.
SourceTemplate (dict) --
The source template for the source entity of the analysis.
DataSetReferences (list) -- [REQUIRED]
The dataset references of the source template of an analysis.
(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 source template of an analysis.
string
The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.
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 AWS request ID for this operation.
Lists Amazon QuickSight analyses that exist in the specified AWS account.
See also: AWS API Documentation
Request Syntax
client.list_analyses(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID of the AWS account that contains the analyses.
string
A pagination token that can be used in a subsequent request.
integer
The maximum number of results to return.
dict
Response Syntax
{
'AnalysisSummaryList': [
{
'Arn': 'string',
'AnalysisId': 'string',
'Name': '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)
},
],
'NextToken': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
AnalysisSummaryList (list) --
Metadata describing each of the analyses that are listed.
(dict) --
The summary metadata that describes an analysis.
Arn (string) --
The Amazon Resource Name (ARN) for the analysis.
AnalysisId (string) --
The ID of the analysis. This ID displays in the URL.
Name (string) --
The name of the analysis. This name is displayed in the QuickSight console.
Status (string) --
The last known status for the analysis.
CreatedTime (datetime) --
The time that the analysis was created.
LastUpdatedTime (datetime) --
The time that the analysis was last updated.
NextToken (string) --
A pagination token that can be used in a subsequent request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
Creates an analysis in Amazon QuickSight.
See also: AWS API Documentation
Request Syntax
client.create_analysis(
AwsAccountId='string',
AnalysisId='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'
}
},
ThemeArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the AWS account where you are creating an analysis.
string
[REQUIRED]
The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
string
[REQUIRED]
A descriptive name for the analysis that you're creating. This name displays for the analysis in the QuickSight console.
dict
The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
StringParameters (list) --
String parameters.
(dict) --
A string parameter.
Name (string) -- [REQUIRED]
A display name for a string parameter.
Values (list) -- [REQUIRED]
The values of a string parameter.
(string) --
IntegerParameters (list) --
Integer parameters.
(dict) --
An integer parameter.
Name (string) -- [REQUIRED]
The name of the integer parameter.
Values (list) -- [REQUIRED]
The values for the integer parameter.
(integer) --
DecimalParameters (list) --
Decimal parameters.
(dict) --
A decimal parameter.
Name (string) -- [REQUIRED]
A display name for the decimal parameter.
Values (list) -- [REQUIRED]
The values for the decimal parameter.
(float) --
DateTimeParameters (list) --
Date-time parameters.
(dict) --
A date-time parameter.
Name (string) -- [REQUIRED]
A display name for the date-time parameter.
Values (list) -- [REQUIRED]
The values for the date-time parameter.
(datetime) --
list
A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).
To specify no permissions, omit Permissions .
(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 IAM action to grant or revoke permissions on, for example "quicksight:DescribeDashboard" .
(string) --
dict
[REQUIRED]
A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.
SourceTemplate (dict) --
The source template for the source entity of the analysis.
DataSetReferences (list) -- [REQUIRED]
The dataset references of the source template of an analysis.
(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 source template of an analysis.
string
The ARN for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.
list
Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
(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',
'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 AWS request ID for this operation.
Restores an analysis.
See also: AWS API Documentation
Request Syntax
client.restore_analysis(
AwsAccountId='string',
AnalysisId='string'
)
string
[REQUIRED]
The ID of the AWS account that contains the analysis.
string
[REQUIRED]
The ID of the analysis that you're restoring.
dict
Response Syntax
{
'Status': 123,
'Arn': 'string',
'AnalysisId': 'string',
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
Arn (string) --
The Amazon Resource Name (ARN) of the analysis that you're restoring.
AnalysisId (string) --
The ID of the analysis that you're restoring.
RequestId (string) --
The AWS request ID for this operation.
Searches for analyses that belong to the user specified in the filter.
See also: AWS API Documentation
Request Syntax
client.search_analyses(
AwsAccountId='string',
Filters=[
{
'Operator': 'StringEquals',
'Name': 'QUICKSIGHT_USER',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID of the AWS account that contains the analyses that you're searching for.
list
[REQUIRED]
The structure for the search filters that you want to apply to your search.
(dict) --
A filter that you apply when searching for one or more analyses.
Operator (string) --
The comparison operator that you want to use as a filter, for example "Operator": "StringEquals" .
Name (string) --
The name of the value that you want to use as a filter, for example "Name": "QUICKSIGHT_USER" .
Value (string) --
The value of the named item, in this case QUICKSIGHT_USER , that you want to use as a filter, for example "Value" . An example is "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
string
A pagination token that can be used in a subsequent request.
integer
The maximum number of results to return.
dict
Response Syntax
{
'AnalysisSummaryList': [
{
'Arn': 'string',
'AnalysisId': 'string',
'Name': '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)
},
],
'NextToken': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
AnalysisSummaryList (list) --
Metadata describing the analyses that you searched for.
(dict) --
The summary metadata that describes an analysis.
Arn (string) --
The Amazon Resource Name (ARN) for the analysis.
AnalysisId (string) --
The ID of the analysis. This ID displays in the URL.
Name (string) --
The name of the analysis. This name is displayed in the QuickSight console.
Status (string) --
The last known status for the analysis.
CreatedTime (datetime) --
The time that the analysis was created.
LastUpdatedTime (datetime) --
The time that the analysis was last updated.
NextToken (string) --
A pagination token that can be used in a subsequent request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
See also: AWS API Documentation
Request Syntax
client.delete_analysis(
AwsAccountId='string',
AnalysisId='string',
RecoveryWindowInDays=123,
ForceDeleteWithoutRecovery=True|False
)
string
[REQUIRED]
The ID of the AWS account where you want to delete an analysis.
string
[REQUIRED]
The ID of the analysis that you're deleting.
integer
A value that specifies the number of days that QuickSight waits before it deletes the analysis. You can't use this parameter with the ForceDeleteWithoutRecovery option in the same API call. The default value is 30.
boolean
This option defaults to the value NoForceDeleteWithoutRecovery . To immediately delete the analysis, add the ForceDeleteWithoutRecovery option. You can't restore an analysis after it's deleted.
dict
Response Syntax
{
'Status': 123,
'Arn': 'string',
'AnalysisId': 'string',
'DeletionTime': datetime(2015, 1, 1),
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
Arn (string) --
The Amazon Resource Name (ARN) of the deleted analysis.
AnalysisId (string) --
The ID of the deleted analysis.
DeletionTime (datetime) --
The date and time that the analysis is scheduled to be deleted.
RequestId (string) --
The AWS request ID for this operation.
Provides the read and write permissions for an analysis.
See also: AWS API Documentation
Request Syntax
client.describe_analysis_permissions(
AwsAccountId='string',
AnalysisId='string'
)
string
[REQUIRED]
The ID of the AWS account that contains the analysis whose permissions you're describing. You must be using the AWS account that the analysis is in.
string
[REQUIRED]
The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL.
dict
Response Syntax
{
'AnalysisId': 'string',
'AnalysisArn': 'string',
'Permissions': [
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
AnalysisId (string) --
The ID of the analysis whose permissions you're describing.
AnalysisArn (string) --
The Amazon Resource Name (ARN) of the analysis whose permissions you're describing.
Permissions (list) --
A structure that describes the principals and the resource-level permissions on an analysis.
(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 IAM action to grant or revoke permissions on, for example "quicksight:DescribeDashboard" .
(string) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
{'CreationStatus': {'DELETED'}}
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. 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) --
A string parameter.
Name (string) -- [REQUIRED]
A display name for a string parameter.
Values (list) -- [REQUIRED]
The values of a string parameter.
(string) --
IntegerParameters (list) --
Integer parameters.
(dict) --
An integer parameter.
Name (string) -- [REQUIRED]
The name of the integer parameter.
Values (list) -- [REQUIRED]
The values for the integer parameter.
(integer) --
DecimalParameters (list) --
Decimal parameters.
(dict) --
A decimal parameter.
Name (string) -- [REQUIRED]
A display name for the decimal parameter.
Values (list) -- [REQUIRED]
The values for the decimal parameter.
(float) --
DateTimeParameters (list) --
Date-time parameters.
(dict) --
A date-time parameter.
Name (string) -- [REQUIRED]
A display name for the date-time parameter.
Values (list) -- [REQUIRED]
The values for the date-time parameter.
(datetime) --
list
A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
(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 IAM 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'|'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 AWS request ID for this operation.
{'CreationStatus': {'DELETED'}}
Creates a data source.
See also: AWS API Documentation
Request Syntax
client.create_data_source(
AwsAccountId='string',
DataSourceId='string',
Name='string',
Type='ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER',
DataSourceParameters={
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
}
},
]
},
'CopySourceArn': 'string'
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The AWS account ID.
string
[REQUIRED]
An ID for the data source. This ID is unique per AWS Region for each AWS account.
string
[REQUIRED]
A display name for the data source.
string
[REQUIRED]
The type of the data source. Currently, the supported types for this operation are: ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA . Use ListDataSources to return a list of all data sources.
dict
The parameters that QuickSight uses to connect to your underlying source.
AmazonElasticsearchParameters (dict) --
Amazon Elasticsearch Service parameters.
Domain (string) -- [REQUIRED]
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
S3Parameters (dict) --
S3 parameters.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
dict
The credentials QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
CredentialPair (dict) --
Credential pair. For more information, see CredentialPair.
Username (string) -- [REQUIRED]
User name.
Password (string) -- [REQUIRED]
Password.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allowlist. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
Amazon Elasticsearch Service parameters.
Domain (string) -- [REQUIRED]
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
S3Parameters (dict) --
S3 parameters.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
CopySourceArn (string) --
The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.
list
A list of resource permissions on the data source.
(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 IAM action to grant or revoke permissions on, for example "quicksight:DescribeDashboard" .
(string) --
dict
Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
dict
Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
list
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
(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',
'DataSourceId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per AWS Region for each AWS account.
CreationStatus (string) --
The status of creating the data source.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'CreationStatus': {'DELETED'}}
Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.
A template is an entity in QuickSight 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
client.create_template(
AwsAccountId='string',
TemplateId='string',
Name='string',
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
SourceEntity={
'SourceAnalysis': {
'Arn': 'string',
'DataSetReferences': [
{
'DataSetPlaceholder': 'string',
'DataSetArn': 'string'
},
]
},
'SourceTemplate': {
'Arn': 'string'
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
VersionDescription='string'
)
string
[REQUIRED]
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
string
[REQUIRED]
An ID for the template that you want to create. This template is unique per AWS Region in each AWS account.
string
A display name for the template.
list
A list of resource permissions to be set on the template.
(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 IAM 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 template. In SourceEntity , you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate , specify the ARN of the source template. For SourceAnalysis , specify the ARN of the source analysis. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.
Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
SourceAnalysis (dict) --
The source analysis, if it is based on an analysis.
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the resource.
DataSetReferences (list) -- [REQUIRED]
A structure containing information about the dataset references used as placeholders in the template.
(dict) --
Dataset reference.
DataSetPlaceholder (string) -- [REQUIRED]
Dataset placeholder.
DataSetArn (string) -- [REQUIRED]
Dataset Amazon Resource Name (ARN).
SourceTemplate (dict) --
The source template, if it is based on an template.
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 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.
string
A description of the current template version being created. This API operation creates the first version of the template. Every time UpdateTemplate is called, a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.
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 AWS request ID for this operation.
{'CreationStatus': {'DELETED'}}
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 IAM 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'|'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 AWS request ID for this operation.
{'Dashboard': {'Version': {'Status': {'DELETED'}, 'ThemeArn': 'string'}}}
Provides a summary for a dashboard.
See also: AWS API Documentation
Request Syntax
client.describe_dashboard(
AwsAccountId='string',
DashboardId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the AWS 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
{
'Dashboard': {
'DashboardId': 'string',
'Arn': 'string',
'Name': 'string',
'Version': {
'CreatedTime': datetime(2015, 1, 1),
'Errors': [
{
'Type': 'ACCESS_DENIED'|'SOURCE_NOT_FOUND'|'DATA_SET_NOT_FOUND'|'INTERNAL_FAILURE'|'PARAMETER_VALUE_INCOMPATIBLE'|'PARAMETER_TYPE_INVALID'|'PARAMETER_NOT_FOUND'|'COLUMN_TYPE_MISMATCH'|'COLUMN_GEOGRAPHIC_ROLE_MISMATCH'|'COLUMN_REPLACEMENT_MISSING',
'Message': 'string'
},
],
'VersionNumber': 123,
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Arn': 'string',
'SourceEntityArn': 'string',
'DataSetArns': [
'string',
],
'Description': 'string',
'ThemeArn': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'LastPublishedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Dashboard (dict) --
Information about the dashboard.
DashboardId (string) --
Dashboard ID.
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
Name (string) --
A display name for the dashboard.
Version (dict) --
Version.
CreatedTime (datetime) --
The time that this dashboard version was created.
Errors (list) --
Errors associated with this dashboard version.
(dict) --
Dashboard error.
Type (string) --
Type.
Message (string) --
Message.
VersionNumber (integer) --
Version number for this version of the dashboard.
Status (string) --
The HTTP status of the request.
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
SourceEntityArn (string) --
Source entity ARN.
DataSetArns (list) --
The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.
(string) --
Description (string) --
Description.
ThemeArn (string) --
The ARN of the theme associated with a version of the dashboard.
CreatedTime (datetime) --
The time that this dataset was created.
LastPublishedTime (datetime) --
The last time that this dataset was published.
LastUpdatedTime (datetime) --
The last time that this dataset was updated.
Status (integer) --
The HTTP status of this request.
RequestId (string) --
The AWS request ID for this operation.
{'DataSource': {'Status': {'DELETED'}}}
Describes a data source.
See also: AWS API Documentation
Request Syntax
client.describe_data_source(
AwsAccountId='string',
DataSourceId='string'
)
string
[REQUIRED]
The AWS account ID.
string
[REQUIRED]
The ID of the data source. This ID is unique per AWS Region for each AWS account.
dict
Response Syntax
{
'DataSource': {
'Arn': 'string',
'DataSourceId': 'string',
'Name': 'string',
'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER',
'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),
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
}
},
],
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'ErrorInfo': {
'Type': 'ACCESS_DENIED'|'COPY_SOURCE_NOT_FOUND'|'TIMEOUT'|'ENGINE_VERSION_NOT_SUPPORTED'|'UNKNOWN_HOST'|'GENERIC_SQL_FAILURE'|'CONFLICT'|'UNKNOWN',
'Message': 'string'
}
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
DataSource (dict) --
The information on the data source.
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per AWS Region for each AWS account.
Name (string) --
A display name for the data source.
Type (string) --
The type of the data source. This type indicates which database engine the data source connects to.
Status (string) --
The HTTP status of the request.
CreatedTime (datetime) --
The time that this data source was created.
LastUpdatedTime (datetime) --
The last time that this data source was updated.
DataSourceParameters (dict) --
The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
Amazon Elasticsearch Service parameters.
Domain (string) --
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
S3Parameters (dict) --
S3 parameters.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allowlist. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
Amazon Elasticsearch Service parameters.
Domain (string) --
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
S3Parameters (dict) --
S3 parameters.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
VpcConnectionProperties (dict) --
The VPC connection information. You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
ErrorInfo (dict) --
Error information from the last update or the creation of the data source.
Type (string) --
Error type.
Message (string) --
Error message.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Template': {'Version': {'Errors': {'Type': {'ACCESS_DENIED'}},
'Status': {'DELETED'},
'ThemeArn': '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'|'ACCESS_DENIED',
'Message': 'string'
},
],
'VersionNumber': 123,
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'DataSetConfigurations': [
{
'Placeholder': 'string',
'DataSetSchema': {
'ColumnSchemaList': [
{
'Name': 'string',
'DataType': 'string',
'GeographicRole': 'string'
},
]
},
'ColumnGroupSchemaList': [
{
'Name': 'string',
'ColumnGroupColumnSchemaList': [
{
'Name': 'string'
},
]
},
]
},
],
'Description': 'string',
'SourceEntityArn': 'string',
'ThemeArn': '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 this template version.
(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 version.
Status (string) --
The HTTP status of the request.
DataSetConfigurations (list) --
Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.
(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 an analysis or template that was used to create this template.
ThemeArn (string) --
The ARN of the theme associated with this version of the 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) --
The AWS request ID for this operation.
{'Theme': {'Version': {'Status': {'DELETED'}}}}
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'|'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 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.
{'DashboardVersionSummaryList': {'Status': {'DELETED'}}}
Lists all the versions of the dashboards in the QuickSight subscription.
See also: AWS API Documentation
Request Syntax
client.list_dashboard_versions(
AwsAccountId='string',
DashboardId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID of the AWS account that contains the dashboard that you're listing versions for.
string
[REQUIRED]
The ID for the dashboard.
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
{
'DashboardVersionSummaryList': [
{
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'VersionNumber': 123,
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'SourceEntityArn': 'string',
'Description': 'string'
},
],
'NextToken': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
DashboardVersionSummaryList (list) --
A structure that contains information about each version of the dashboard.
(dict) --
Dashboard version summary.
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
CreatedTime (datetime) --
The time that this dashboard version was created.
VersionNumber (integer) --
Version number.
Status (string) --
The HTTP status of the request.
SourceEntityArn (string) --
Source entity ARN.
Description (string) --
Description.
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.
{'DataSources': {'Status': {'DELETED'}}}
Lists data sources in current AWS Region that belong to this AWS account.
See also: AWS API Documentation
Request Syntax
client.list_data_sources(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The AWS account ID.
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
{
'DataSources': [
{
'Arn': 'string',
'DataSourceId': 'string',
'Name': 'string',
'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER',
'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),
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
}
},
],
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'ErrorInfo': {
'Type': 'ACCESS_DENIED'|'COPY_SOURCE_NOT_FOUND'|'TIMEOUT'|'ENGINE_VERSION_NOT_SUPPORTED'|'UNKNOWN_HOST'|'GENERIC_SQL_FAILURE'|'CONFLICT'|'UNKNOWN',
'Message': 'string'
}
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
DataSources (list) --
A list of data sources.
(dict) --
The structure of a data source.
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per AWS Region for each AWS account.
Name (string) --
A display name for the data source.
Type (string) --
The type of the data source. This type indicates which database engine the data source connects to.
Status (string) --
The HTTP status of the request.
CreatedTime (datetime) --
The time that this data source was created.
LastUpdatedTime (datetime) --
The last time that this data source was updated.
DataSourceParameters (dict) --
The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
Amazon Elasticsearch Service parameters.
Domain (string) --
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
S3Parameters (dict) --
S3 parameters.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allowlist. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
Amazon Elasticsearch Service parameters.
Domain (string) --
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
S3Parameters (dict) --
S3 parameters.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
VpcConnectionProperties (dict) --
The VPC connection information. You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
ErrorInfo (dict) --
Error information from the last update or the creation of the data source.
Type (string) --
Error type.
Message (string) --
Error message.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'TemplateVersionSummaryList': {'Status': {'DELETED'}}}
Lists all the versions of the templates in the current Amazon QuickSight account.
See also: AWS API Documentation
Request Syntax
client.list_template_versions(
AwsAccountId='string',
TemplateId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID of the AWS account that contains the templates that you're listing.
string
[REQUIRED]
The ID for the template.
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
{
'TemplateVersionSummaryList': [
{
'Arn': 'string',
'VersionNumber': 123,
'CreatedTime': datetime(2015, 1, 1),
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Description': 'string'
},
],
'NextToken': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
TemplateVersionSummaryList (list) --
A structure containing a list of all the versions of the specified template.
(dict) --
The template version.
Arn (string) --
The Amazon Resource Name (ARN) of the template version.
VersionNumber (integer) --
The version number of the template version.
CreatedTime (datetime) --
The time that this template version was created.
Status (string) --
The status of the template version.
Description (string) --
The description of the template 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.
{'ThemeVersionSummaryList': {'Status': {'DELETED'}}}
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'|'DELETED'
},
],
'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.
{'CreationStatus': {'DELETED'}}
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) --
A string parameter.
Name (string) -- [REQUIRED]
A display name for a string parameter.
Values (list) -- [REQUIRED]
The values of a string parameter.
(string) --
IntegerParameters (list) --
Integer parameters.
(dict) --
An integer parameter.
Name (string) -- [REQUIRED]
The name of the integer parameter.
Values (list) -- [REQUIRED]
The values for the integer parameter.
(integer) --
DecimalParameters (list) --
Decimal parameters.
(dict) --
A decimal parameter.
Name (string) -- [REQUIRED]
A display name for the decimal parameter.
Values (list) -- [REQUIRED]
The values for the decimal parameter.
(float) --
DateTimeParameters (list) --
Date-time parameters.
(dict) --
A date-time parameter.
Name (string) -- [REQUIRED]
A display name for the date-time parameter.
Values (list) -- [REQUIRED]
The values for the date-time parameter.
(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'|'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 AWS request ID for this operation.
{'UpdateStatus': {'DELETED'}}
Updates a data source.
See also: AWS API Documentation
Request Syntax
client.update_data_source(
AwsAccountId='string',
DataSourceId='string',
Name='string',
DataSourceParameters={
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
}
},
]
},
'CopySourceArn': 'string'
},
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
}
)
string
[REQUIRED]
The AWS account ID.
string
[REQUIRED]
The ID of the data source. This ID is unique per AWS Region for each AWS account.
string
[REQUIRED]
A display name for the data source.
dict
The parameters that QuickSight uses to connect to your underlying source.
AmazonElasticsearchParameters (dict) --
Amazon Elasticsearch Service parameters.
Domain (string) -- [REQUIRED]
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
S3Parameters (dict) --
S3 parameters.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
dict
The credentials that QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
CredentialPair (dict) --
Credential pair. For more information, see CredentialPair.
Username (string) -- [REQUIRED]
User name.
Password (string) -- [REQUIRED]
Password.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allowlist. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
Amazon Elasticsearch Service parameters.
Domain (string) -- [REQUIRED]
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
S3Parameters (dict) --
S3 parameters.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
CopySourceArn (string) --
The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.
dict
Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
dict
Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
dict
Response Syntax
{
'Arn': 'string',
'DataSourceId': 'string',
'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per AWS Region for each AWS account.
UpdateStatus (string) --
The update status of the data source's last update.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'CreationStatus': {'DELETED'}}
Updates a template from an existing Amazon QuickSight analysis or another template.
See also: AWS API Documentation
Request Syntax
client.update_template(
AwsAccountId='string',
TemplateId='string',
SourceEntity={
'SourceAnalysis': {
'Arn': 'string',
'DataSetReferences': [
{
'DataSetPlaceholder': 'string',
'DataSetArn': 'string'
},
]
},
'SourceTemplate': {
'Arn': 'string'
}
},
VersionDescription='string',
Name='string'
)
string
[REQUIRED]
The ID of the AWS account that contains the template that you're updating.
string
[REQUIRED]
The ID for the template.
dict
[REQUIRED]
The entity that you are using as a source when you update the template. In SourceEntity , you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate , specify the ARN of the source template. For SourceAnalysis , specify the ARN of the source analysis. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.
Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
SourceAnalysis (dict) --
The source analysis, if it is based on an analysis.
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the resource.
DataSetReferences (list) -- [REQUIRED]
A structure containing information about the dataset references used as placeholders in the template.
(dict) --
Dataset reference.
DataSetPlaceholder (string) -- [REQUIRED]
Dataset placeholder.
DataSetArn (string) -- [REQUIRED]
Dataset Amazon Resource Name (ARN).
SourceTemplate (dict) --
The source template, if it is based on an template.
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the resource.
string
A description of the current template version that is being updated. Every time you call UpdateTemplate , you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.
string
The name for the template.
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 AWS request ID for this operation.
{'CreationStatus': {'DELETED'}}
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'|'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 AWS request ID for this operation.