Unsupported config for heatmaps appears through dashboard/analysis export [Row/Column, OtherCategories: INCLUDE]

Q&A
, , ,
1

Hello, it seems that our team stumbled upon a bug recently. When exporting a dashboard or analysis definition .json file through the aws cli, the following fields appear for any dashboard sheets that contain the ‘heatmap’ visual. This of course presents us with multiple build errors in our pipeline when importing these .json files because the heatmap visual CANNOT have INCLUDE in these options.

HeatMapColumnSort
OtherCategories: “INCLUDE”
HeatMapRowItemsLimitConfiguration
OtherCategories: “INCLUDE”

We have resorted to manually scripting out these options so they are removed from the definitions in order to eliminate this issue but we must ask what made them to appear in the first place? There is no option in the UI to change this so we must do it through the cli.
The problem could be related to the fact that the default option for heatmaps is EXCLUDE and is completely omitted from the .json when this is the case.

The Error:
[{‘Arn’: ‘arn:aws:quicksight:::analysis/72cd15ac-ec16-4043-ade9-3f1b513e541d’, ‘Type’: ‘com.amazonaws.services.quicksight.model.InvalidParameterValueException’, ‘Message’: ‘OtherCategories only accepts the EXCLUDE for HeatMap, \n\t at Visual 55f15c82-8ea7-4fad-94e9-16d4c3119e17, \n\t at Sheet 1074f80e-cf86-4066-a7e3-2a53d4af9176.’}]

We haven’t experienced this in the past, is this a new error on Amazon’s end?

2

Hi @stefanorca,

It is definitely interesting that you are encountering this error, as I have not previously seen this occurrence as well. I would definitely reach out to AWS Support by creating a support case so that they can look into the issue further!

4

Same problem here. Has anyone found a solution for this?

5

The only solution I have found is to work around it, open the .json definition files directly with a python script and eliminate the illegal config lines. Since the default is EXCLUDE, having no lines present means it defaults to that and no error appears. Hope that helps!

6

I ran into this too. Glad I found this thread. We run into so many import errors that are so hard to figure out the root problem and fix.

7

It is definitely a new bug as I just received the same error trying to import a previously working analysis definition with my python deployment script. It was working about two months ago.

8

Thank you for posting about this. We have the same issue and I wasted a bunch of time yesterday trying to figure this out. Definitely a Quicksight bug that has been introduced as it was working before and we haven’t changed the visuals. Did you raise a support ticket?

9

Same problem for me. Any solutions?

10

Hello,

I also encountered the same issue. Till AWS resolves this issue, you can use the following Python script or create similar code in your programming language to update the dashboard’s or analysis’s JSON content.

import boto3

def find_and_update_heatmap_visual(definition):

sheet_index = -1

for sheet in definition['Sheets']:

    sheet_index +=1

    visual_index = -1

    for visual in sheet['Visuals']:

        visual_index +=1

        keys = visual.keys()

        for key in keys:

            if key == 'HeatMapVisual':

                visual = visual[key]

                print(f"Updating Sheet {sheet_index} Visual Index {visual_index} key = {key}")

                definition['Sheets'][sheet_index]['Visuals'][visual_index][key]['ChartConfiguration']["SortConfiguration"]["HeatMapRowItemsLimitConfiguration"]["OtherCategories"]='EXCLUDE'

                definition['Sheets'][sheet_index]['Visuals'][visual_index][key]['ChartConfiguration']["SortConfiguration"]["HeatMapColumnItemsLimitConfiguration"]["OtherCategories"]='EXCLUDE'

quicksight_client = boto3.client(‘quicksight’)

// Get Dahsboard or Analysis Definition

response = quicksight_client.describe_analysis_definition(

    AwsAccountId=aws_accountid,

    AnalysisId=analysis_id)

find_and_update_heatmap_visual(response[‘Definition’])

// Now you can create your dashboard or analysis

11

Hi @stefanorca,

Hope everything is well! Just checking in since this thread hasn’t received a response in a while. Were you able to see qsuer’s recent post and/or find a workaround yourself in the meantime? If we do not hear back within the next 3 business days, I’ll go ahead and close out this topic.

Thank you!

12

Hi @stefanorca,

Since we have not heard back, I’ll go ahead and close out of this topic. However, if you have any additional questions, please feel free to post again in the Quick Suite Community and link this thread for any questions.

Thank you!