dashboards

Creates, updates, deletes, gets or lists a dashboards resource.

Overview

Name	dashboards
Type	Resource
Id	aws.quicksight.dashboards

Fields

The following fields are returned by SELECT queries:

describe_dashboard

Name	Datatype	Description
dashboard	object	Information about the dashboard.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of this request.

search_dashboards

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the resource.
created_time	string (date-time)	The time that this dashboard was created.
dashboard_id	string	Dashboard ID. (pattern: <code>[\w-]+</code>)
last_published_time	string (date-time)	The last time that this dashboard was published.
last_updated_time	string (date-time)	The last time that this dashboard was updated.
name	string	A display name for the dashboard.
published_version_number	integer (int64)	Published version number.

list_dashboards

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the resource.
created_time	string (date-time)	The time that this dashboard was created.
dashboard_id	string	Dashboard ID. (pattern: <code>[\w-]+</code>)
last_published_time	string (date-time)	The last time that this dashboard was published.
last_updated_time	string (date-time)	The last time that this dashboard was updated.
name	string	A display name for the dashboard.
published_version_number	integer (int64)	Published version number.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_dashboard	select	aws_account_id, dashboard_id, region	version-number, alias-name	Provides a summary for a dashboard.
search_dashboards	select	aws_account_id, region		Searches for dashboards that belong to a user. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
list_dashboards	select	aws_account_id, region	next-token, max-results	Lists dashboards in an Amazon Web Services account.
create_dashboard	insert	aws_account_id, dashboard_id, region		Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in Amazon Quick Sight that identifies Amazon Quick Sight reports, created from analyses. You can share Amazon Quick Sight 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 Amazon Web Services account.
update_dashboard_links	update	aws_account_id, dashboard_id, region, LinkEntities		Updates the linked analyses on a dashboard.
update_dashboard_published_version	update	aws_account_id, dashboard_id, version_number, region		Updates the published version of a dashboard.
update_dashboard	update	aws_account_id, dashboard_id, region		Updates a dashboard in an Amazon Web Services account. Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.
delete_dashboard	delete	aws_account_id, dashboard_id, region	version-number	Deletes a dashboard.
start_dashboard_snapshot_job	exec	aws_account_id, dashboard_id, region, SnapshotJobId, SnapshotConfiguration		Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call. 1 PDF 1 Excel workbook that includes up to 5 table or pivot table visuals 5 CSVs from table or pivot table visuals Exporting CSV, Excel, or Pixel Perfect PDF reports requires Pixel Perfect Report Add-on. The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred. StartDashboardSnapshotJob API throttling Quick Sight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Quick Sight throttles the API calls to maintin an optimal experience and reliability for all Quick Sight users. Common throttling scenarios The following list provides information about the most commin throttling scenarios that can occur. A large number of SnapshotExport API jobs are running simultaneously on an Amazon Web Services account. When a new StartDashboardSnapshotJob is created and there are already 12 jobs with the RUNNING status, the new job request fails and returns a LimitExceededException error. Wait for a current job to comlpete before you resubmit the new job. A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Quick Sight API in one second, a ThrottlingException is returned. If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account. Best practices to handle throttling If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Quick Sight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline. The time that it takes to process a job can be impacted by the following factors: The dataset type (Direct Query or SPICE). The size of the dataset. The complexity of the calculated fields that are used in the dashboard. The number of visuals that are on a sheet. The types of visuals that are on the sheet. The number of formats and snapshots that are requested in the job configuration. The size of the generated snapshots. Registered user support You can generate snapshots for registered Quick Sight users by using the Snapshot Job APIs with identity-enhanced IAM role session credentials. This approach allows you to create snapshots on behalf of specific Quick Sight users while respecting their row-level security (RLS), column-level security (CLS), dynamic default parameters and dashboard parameter/filter settings. To generate snapshots for registered Quick Sight users, you need to: Obtain identity-enhanced IAM role session credentials from Amazon Web Services Security Token Service (STS). Use these credentials to call the Snapshot Job APIs. Identity-enhanced credentials are credentials that contain information about the end user (e.g., registered Quick Sight user). If your Quick Sight users are backed by Amazon Web Services Identity Center, then you need to set up a trusted token issuer. Then, getting identity-enhanced IAM credentials for a Quick Sight user will look like the following: Authenticate user with your OIDC compliant Identity Provider. You should get auth tokens back. Use the OIDC API, CreateTokenWithIAM, to exchange auth tokens to IAM tokens. One of the resulted tokens will be identity token. Call STS AssumeRole API as you normally would, but provide an extra ProvidedContexts parameter in the API request. The list of contexts must have a single trusted context assertion. The ProviderArn should be arn:aws:iam::aws:contextProvider/IdentityCenter while ContextAssertion will be the identity token you received in response from CreateTokenWithIAM For more details, see IdC documentation on Identity-enhanced IAM role sessions. To obtain Identity-enhanced credentials for Quick Sight native users, IAM federated users, or Active Directory users, follow the steps below: Call Quick Sight GetIdentityContext API to get identity token. Call STS AssumeRole API as you normally would, but provide extra ProvidedContexts parameter in the API request. The list of contexts must have a single trusted context assertion. The ProviderArn should be arn:aws:iam::aws:contextProvider/QuickSight while ContextAssertion will be the identity token you received in response from GetIdentityContext After obtaining the identity-enhanced IAM role session credentials, you can use them to start a job, describe the job and describe job result. You can use the same credentials as long as they haven't expired. All API requests made with these credentials are considered to be made by the impersonated Quick Sight user. When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid. Possible error scenarios The request fails with an Access Denied error in the following scenarios: The credentials have expired. The impersonated Quick Sight user doesn't have access to the specified dashboard. The impersonated Quick Sight user is restricted from exporting data in the selected formats. For more information about export restrictions, see Customizing access to Amazon Quick Sight capabilities.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
aws_account_id	string	The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
dashboard_id	string	The ID of the dashboard that you want to start a snapshot job for.
region	string	AWS region (default: us-east-1)
version_number	integer (int64)	The version number of the dashboard.
alias-name	string	The alias name.
max-results	integer	The maximum number of results to be returned per request.
next-token	string	The token for the next set of results, or null if there are no more results.
version-number	integer (int64)	The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.

SELECT examples

describe_dashboard

Provides a summary for a dashboard.

SELECT
dashboard,
request_id,
status
FROM aws.quicksight.dashboards
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND dashboard_id = '{{ dashboard_id }}' -- required
AND region = '{{ region }}' -- required
AND `version-number` = '{{ version-number }}'
AND `alias-name` = '{{ alias-name }}'
;

search_dashboards

Searches for dashboards that belong to a user. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

SELECT
arn,
created_time,
dashboard_id,
last_published_time,
last_updated_time,
name,
published_version_number
FROM aws.quicksight.dashboards
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
;

list_dashboards

Lists dashboards in an Amazon Web Services account.

SELECT
arn,
created_time,
dashboard_id,
last_published_time,
last_updated_time,
name,
published_version_number
FROM aws.quicksight.dashboards
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_dashboard

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in Amazon Quick Sight that identifies Amazon Quick Sight reports, created from analyses. You can share Amazon Quick Sight 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 Amazon Web Services account.

INSERT INTO aws.quicksight.dashboards (
Name,
Parameters,
Permissions,
SourceEntity,
Tags,
VersionDescription,
DashboardPublishOptions,
ThemeArn,
Definition,
ValidationStrategy,
FolderArns,
LinkSharingConfiguration,
LinkEntities,
aws_account_id,
dashboard_id,
region
)
SELECT 
'{{ Name }}',
'{{ Parameters }}',
'{{ Permissions }}',
'{{ SourceEntity }}',
'{{ Tags }}',
'{{ VersionDescription }}',
'{{ DashboardPublishOptions }}',
'{{ ThemeArn }}',
'{{ Definition }}',
'{{ ValidationStrategy }}',
'{{ FolderArns }}',
'{{ LinkSharingConfiguration }}',
'{{ LinkEntities }}',
'{{ aws_account_id }}',
'{{ dashboard_id }}',
'{{ region }}'
RETURNING
arn,
creation_status,
dashboard_id,
request_id,
status,
version_arn
;

Manifest

# Description fields are for documentation purposes
- name: dashboards
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the dashboards resource.
  - name: dashboard_id
    value: "{{ dashboard_id }}"
    description: Required parameter for the dashboards resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the dashboards resource.
  - name: Name
    value: "{{ Name }}"
  - name: Parameters
    description: |
      A list of Quick Sight parameters and the list's override values.
    value:
      StringParameters:
        - Name: "{{ Name }}"
          Values: "{{ Values }}"
      IntegerParameters:
        - Name: "{{ Name }}"
          Values: "{{ Values }}"
      DecimalParameters:
        - Name: "{{ Name }}"
          Values: "{{ Values }}"
      DateTimeParameters:
        - Name: "{{ Name }}"
          Values: "{{ Values }}"
  - name: Permissions
    value:
      - Principal: "{{ Principal }}"
        Actions: "{{ Actions }}"
  - name: SourceEntity
    description: |
      Dashboard source entity.
    value:
      SourceTemplate:
        DataSetReferences:
          - DataSetPlaceholder: "{{ DataSetPlaceholder }}"
            DataSetArn: "{{ DataSetArn }}"
        TopicReferences:
          - TopicPlaceholder: "{{ TopicPlaceholder }}"
            TopicArn: "{{ TopicArn }}"
        Arn: "{{ Arn }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: VersionDescription
    value: "{{ VersionDescription }}"
  - name: DashboardPublishOptions
    description: |
      Dashboard publish options.
    value:
      AdHocFilteringOption:
        AvailabilityStatus: "{{ AvailabilityStatus }}"
      ExportToCSVOption:
        AvailabilityStatus: "{{ AvailabilityStatus }}"
      SheetControlsOption:
        VisibilityState: "{{ VisibilityState }}"
      VisualPublishOptions:
        ExportHiddenFieldsOption:
          AvailabilityStatus: "{{ AvailabilityStatus }}"
      SheetLayoutElementMaximizationOption:
        AvailabilityStatus: "{{ AvailabilityStatus }}"
      VisualMenuOption:
        AvailabilityStatus: "{{ AvailabilityStatus }}"
      VisualAxisSortOption:
        AvailabilityStatus: "{{ AvailabilityStatus }}"
      ExportWithHiddenFieldsOption:
        AvailabilityStatus: "{{ AvailabilityStatus }}"
      DataPointDrillUpDownOption:
        AvailabilityStatus: "{{ AvailabilityStatus }}"
      DataPointMenuLabelOption:
        AvailabilityStatus: "{{ AvailabilityStatus }}"
      DataPointTooltipOption:
        AvailabilityStatus: "{{ AvailabilityStatus }}"
      DataQAEnabledOption:
        AvailabilityStatus: "{{ AvailabilityStatus }}"
      QuickSuiteActionsOption:
        AvailabilityStatus: "{{ AvailabilityStatus }}"
      ExecutiveSummaryOption:
        AvailabilityStatus: "{{ AvailabilityStatus }}"
      DataStoriesSharingOption:
        AvailabilityStatus: "{{ AvailabilityStatus }}"
  - name: ThemeArn
    value: "{{ ThemeArn }}"
  - name: Definition
    description: |
      The contents of a dashboard.
    value:
      DataSetIdentifierDeclarations:
        - Identifier: "{{ Identifier }}"
          DataSetArn: "{{ DataSetArn }}"
      TopicIdentifierDeclarations:
        - Identifier: "{{ Identifier }}"
          TopicArn: "{{ TopicArn }}"
      Sheets:
        - SheetId: "{{ SheetId }}"
          Title: "{{ Title }}"
          Description: "{{ Description }}"
          Name: "{{ Name }}"
          ParameterControls: "{{ ParameterControls }}"
          FilterControls: "{{ FilterControls }}"
          Visuals: "{{ Visuals }}"
          TextBoxes: "{{ TextBoxes }}"
          Images: "{{ Images }}"
          Layouts: "{{ Layouts }}"
          SheetControlLayouts: "{{ SheetControlLayouts }}"
          ContentType: "{{ ContentType }}"
          CustomActionDefaults:
            highlightOperation:
              Trigger: "{{ Trigger }}"
      TooltipSheets:
        - SheetId: "{{ SheetId }}"
          Name: "{{ Name }}"
          Visuals: "{{ Visuals }}"
          TextBoxes: "{{ TextBoxes }}"
          Images: "{{ Images }}"
          Layouts: "{{ Layouts }}"
      CalculatedFields:
        - DataSetIdentifier: "{{ DataSetIdentifier }}"
          TopicIdentifier: "{{ TopicIdentifier }}"
          Name: "{{ Name }}"
          Expression: "{{ Expression }}"
      ParameterDeclarations:
        - StringParameterDeclaration:
            ParameterValueType: "{{ ParameterValueType }}"
            Name: "{{ Name }}"
            DefaultValues:
              DynamicValue:
                UserNameColumn: "{{ UserNameColumn }}"
                GroupNameColumn: "{{ GroupNameColumn }}"
                DefaultValueColumn: "{{ DefaultValueColumn }}"
              StaticValues:
                - "{{ StaticValues }}"
            ValueWhenUnset:
              ValueWhenUnsetOption: "{{ ValueWhenUnsetOption }}"
              CustomValue: "{{ CustomValue }}"
            MappedDataSetParameters:
              - DataSetIdentifier: "{{ DataSetIdentifier }}"
                DataSetParameterName: "{{ DataSetParameterName }}"
          DecimalParameterDeclaration:
            ParameterValueType: "{{ ParameterValueType }}"
            Name: "{{ Name }}"
            DefaultValues:
              DynamicValue:
                UserNameColumn: "{{ UserNameColumn }}"
                GroupNameColumn: "{{ GroupNameColumn }}"
                DefaultValueColumn: "{{ DefaultValueColumn }}"
              StaticValues:
                - {{ StaticValues }}
            ValueWhenUnset:
              ValueWhenUnsetOption: "{{ ValueWhenUnsetOption }}"
              CustomValue: {{ CustomValue }}
            MappedDataSetParameters:
              - DataSetIdentifier: "{{ DataSetIdentifier }}"
                DataSetParameterName: "{{ DataSetParameterName }}"
          IntegerParameterDeclaration:
            ParameterValueType: "{{ ParameterValueType }}"
            Name: "{{ Name }}"
            DefaultValues:
              DynamicValue:
                UserNameColumn: "{{ UserNameColumn }}"
                GroupNameColumn: "{{ GroupNameColumn }}"
                DefaultValueColumn: "{{ DefaultValueColumn }}"
              StaticValues:
                - {{ StaticValues }}
            ValueWhenUnset:
              ValueWhenUnsetOption: "{{ ValueWhenUnsetOption }}"
              CustomValue: {{ CustomValue }}
            MappedDataSetParameters:
              - DataSetIdentifier: "{{ DataSetIdentifier }}"
                DataSetParameterName: "{{ DataSetParameterName }}"
          DateTimeParameterDeclaration:
            Name: "{{ Name }}"
            DefaultValues:
              DynamicValue:
                UserNameColumn: "{{ UserNameColumn }}"
                GroupNameColumn: "{{ GroupNameColumn }}"
                DefaultValueColumn: "{{ DefaultValueColumn }}"
              StaticValues:
                - "{{ StaticValues }}"
              RollingDate:
                DataSetIdentifier: "{{ DataSetIdentifier }}"
                Expression: "{{ Expression }}"
            TimeGranularity: "{{ TimeGranularity }}"
            ValueWhenUnset:
              ValueWhenUnsetOption: "{{ ValueWhenUnsetOption }}"
              CustomValue: "{{ CustomValue }}"
            MappedDataSetParameters:
              - DataSetIdentifier: "{{ DataSetIdentifier }}"
                DataSetParameterName: "{{ DataSetParameterName }}"
      FilterGroups:
        - FilterGroupId: "{{ FilterGroupId }}"
          Filters: "{{ Filters }}"
          ScopeConfiguration:
            SelectedSheets:
              SheetVisualScopingConfigurations:
                - SheetId: "{{ SheetId }}"
                  Scope: "{{ Scope }}"
                  VisualIds: "{{ VisualIds }}"
            AllSheets: "{{ AllSheets }}"
          Status: "{{ Status }}"
          CrossDataset: "{{ CrossDataset }}"
      ColumnConfigurations:
        - Column:
            DataSetIdentifier: "{{ DataSetIdentifier }}"
            TopicIdentifier: "{{ TopicIdentifier }}"
            ColumnName: "{{ ColumnName }}"
          FormatConfiguration:
            StringFormatConfiguration:
              NullValueFormatConfiguration:
                NullString: "{{ NullString }}"
              NumericFormatConfiguration:
                NumberDisplayFormatConfiguration: "{{ NumberDisplayFormatConfiguration }}"
                CurrencyDisplayFormatConfiguration: "{{ CurrencyDisplayFormatConfiguration }}"
                PercentageDisplayFormatConfiguration: "{{ PercentageDisplayFormatConfiguration }}"
            NumberFormatConfiguration:
              FormatConfiguration:
                NumberDisplayFormatConfiguration: "{{ NumberDisplayFormatConfiguration }}"
                CurrencyDisplayFormatConfiguration: "{{ CurrencyDisplayFormatConfiguration }}"
                PercentageDisplayFormatConfiguration: "{{ PercentageDisplayFormatConfiguration }}"
            DateTimeFormatConfiguration:
              DateTimeFormat: "{{ DateTimeFormat }}"
              NullValueFormatConfiguration:
                NullString: "{{ NullString }}"
              NumericFormatConfiguration:
                NumberDisplayFormatConfiguration: "{{ NumberDisplayFormatConfiguration }}"
                CurrencyDisplayFormatConfiguration: "{{ CurrencyDisplayFormatConfiguration }}"
                PercentageDisplayFormatConfiguration: "{{ PercentageDisplayFormatConfiguration }}"
          Role: "{{ Role }}"
          ColorsConfiguration:
            CustomColors:
              - FieldValue: "{{ FieldValue }}"
                Color: "{{ Color }}"
                SpecialValue: "{{ SpecialValue }}"
          DecalSettingsConfiguration:
            CustomDecalSettings:
              - ElementValue: "{{ ElementValue }}"
                DecalVisibility: "{{ DecalVisibility }}"
                DecalColor: "{{ DecalColor }}"
                DecalPatternType: "{{ DecalPatternType }}"
                DecalStyleType: "{{ DecalStyleType }}"
      AnalysisDefaults:
        DefaultNewSheetConfiguration:
          InteractiveLayoutConfiguration:
            Grid:
              CanvasSizeOptions: "{{ CanvasSizeOptions }}"
            FreeForm:
              CanvasSizeOptions: "{{ CanvasSizeOptions }}"
          PaginatedLayoutConfiguration:
            SectionBased:
              CanvasSizeOptions: "{{ CanvasSizeOptions }}"
          SheetContentType: "{{ SheetContentType }}"
      Options:
        Timezone: "{{ Timezone }}"
        WeekStart: "{{ WeekStart }}"
        QBusinessInsightsStatus: "{{ QBusinessInsightsStatus }}"
        ExcludedDataSetArns:
          - "{{ ExcludedDataSetArns }}"
        CustomActionDefaults:
          highlightOperation:
            Trigger: "{{ Trigger }}"
        VisualMessages:
          NoDataMessage:
            Enabled: {{ Enabled }}
            Title: "{{ Title }}"
            TitleVisibility: "{{ TitleVisibility }}"
            Description: "{{ Description }}"
            DescriptionVisibility: "{{ DescriptionVisibility }}"
            LinkText: "{{ LinkText }}"
            LinkUrl: "{{ LinkUrl }}"
            LinkVisibility: "{{ LinkVisibility }}"
      StaticFiles:
        - ImageStaticFile:
            StaticFileId: "{{ StaticFileId }}"
            Source:
              UrlOptions:
                Url: "{{ Url }}"
              S3Options:
                BucketName: "{{ BucketName }}"
                ObjectKey: "{{ ObjectKey }}"
                Region: "{{ Region }}"
          SpatialStaticFile:
            StaticFileId: "{{ StaticFileId }}"
            Source:
              UrlOptions:
                Url: "{{ Url }}"
              S3Options:
                BucketName: "{{ BucketName }}"
                ObjectKey: "{{ ObjectKey }}"
                Region: "{{ Region }}"
  - name: ValidationStrategy
    description: |
      The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.
    value:
      Mode: "{{ Mode }}"
  - name: FolderArns
    value:
      - "{{ FolderArns }}"
  - name: LinkSharingConfiguration
    description: |
      A structure that contains the configuration of a shareable link to the dashboard.
    value:
      Permissions:
        - Principal: "{{ Principal }}"
          Actions: "{{ Actions }}"
  - name: LinkEntities
    value:
      - "{{ LinkEntities }}"

UPDATE examples

update_dashboard_links

Updates the linked analyses on a dashboard.

UPDATE aws.quicksight.dashboards
SET 
LinkEntities = '{{ LinkEntities }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND dashboard_id = '{{ dashboard_id }}' --required
AND region = '{{ region }}' --required
AND LinkEntities = '{{ LinkEntities }}' --required
RETURNING
dashboard_arn,
link_entities,
request_id,
status;

update_dashboard_published_version

Updates the published version of a dashboard.

UPDATE aws.quicksight.dashboards
SET 
-- No updatable properties
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND dashboard_id = '{{ dashboard_id }}' --required
AND version_number = '{{ version_number }}' --required
AND region = '{{ region }}' --required
RETURNING
dashboard_arn,
dashboard_id,
request_id,
status;

update_dashboard

Updates a dashboard in an Amazon Web Services account. Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.

UPDATE aws.quicksight.dashboards
SET 
Name = '{{ Name }}',
SourceEntity = '{{ SourceEntity }}',
Parameters = '{{ Parameters }}',
VersionDescription = '{{ VersionDescription }}',
DashboardPublishOptions = '{{ DashboardPublishOptions }}',
ThemeArn = '{{ ThemeArn }}',
Definition = '{{ Definition }}',
ValidationStrategy = '{{ ValidationStrategy }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND dashboard_id = '{{ dashboard_id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
creation_status,
dashboard_id,
request_id,
status,
version_arn;

DELETE examples

delete_dashboard

Deletes a dashboard.

DELETE FROM aws.quicksight.dashboards
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND dashboard_id = '{{ dashboard_id }}' --required
AND region = '{{ region }}' --required
AND `version-number` = '{{ version-number }}'
;

Lifecycle Methods

start_dashboard_snapshot_job

Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call. 1 PDF 1 Excel workbook that includes up to 5 table or pivot table visuals 5 CSVs from table or pivot table visuals Exporting CSV, Excel, or Pixel Perfect PDF reports requires Pixel Perfect Report Add-on. The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred. StartDashboardSnapshotJob API throttling Quick Sight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Quick Sight throttles the API calls to maintin an optimal experience and reliability for all Quick Sight users. Common throttling scenarios The following list provides information about the most commin throttling scenarios that can occur. A large number of SnapshotExport API jobs are running simultaneously on an Amazon Web Services account. When a new StartDashboardSnapshotJob is created and there are already 12 jobs with the RUNNING status, the new job request fails and returns a LimitExceededException error. Wait for a current job to comlpete before you resubmit the new job. A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Quick Sight API in one second, a ThrottlingException is returned. If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account. Best practices to handle throttling If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Quick Sight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline. The time that it takes to process a job can be impacted by the following factors: The dataset type (Direct Query or SPICE). The size of the dataset. The complexity of the calculated fields that are used in the dashboard. The number of visuals that are on a sheet. The types of visuals that are on the sheet. The number of formats and snapshots that are requested in the job configuration. The size of the generated snapshots. Registered user support You can generate snapshots for registered Quick Sight users by using the Snapshot Job APIs with identity-enhanced IAM role session credentials. This approach allows you to create snapshots on behalf of specific Quick Sight users while respecting their row-level security (RLS), column-level security (CLS), dynamic default parameters and dashboard parameter/filter settings. To generate snapshots for registered Quick Sight users, you need to: Obtain identity-enhanced IAM role session credentials from Amazon Web Services Security Token Service (STS). Use these credentials to call the Snapshot Job APIs. Identity-enhanced credentials are credentials that contain information about the end user (e.g., registered Quick Sight user). If your Quick Sight users are backed by Amazon Web Services Identity Center, then you need to set up a trusted token issuer. Then, getting identity-enhanced IAM credentials for a Quick Sight user will look like the following: Authenticate user with your OIDC compliant Identity Provider. You should get auth tokens back. Use the OIDC API, CreateTokenWithIAM, to exchange auth tokens to IAM tokens. One of the resulted tokens will be identity token. Call STS AssumeRole API as you normally would, but provide an extra ProvidedContexts parameter in the API request. The list of contexts must have a single trusted context assertion. The ProviderArn should be arn:aws:iam::aws:contextProvider/IdentityCenter while ContextAssertion will be the identity token you received in response from CreateTokenWithIAM For more details, see IdC documentation on Identity-enhanced IAM role sessions. To obtain Identity-enhanced credentials for Quick Sight native users, IAM federated users, or Active Directory users, follow the steps below: Call Quick Sight GetIdentityContext API to get identity token. Call STS AssumeRole API as you normally would, but provide extra ProvidedContexts parameter in the API request. The list of contexts must have a single trusted context assertion. The ProviderArn should be arn:aws:iam::aws:contextProvider/QuickSight while ContextAssertion will be the identity token you received in response from GetIdentityContext After obtaining the identity-enhanced IAM role session credentials, you can use them to start a job, describe the job and describe job result. You can use the same credentials as long as they haven't expired. All API requests made with these credentials are considered to be made by the impersonated Quick Sight user. When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid. Possible error scenarios The request fails with an Access Denied error in the following scenarios: The credentials have expired. The impersonated Quick Sight user doesn't have access to the specified dashboard. The impersonated Quick Sight user is restricted from exporting data in the selected formats. For more information about export restrictions, see Customizing access to Amazon Quick Sight capabilities.

EXEC aws.quicksight.dashboards.start_dashboard_snapshot_job 
@aws_account_id='{{ aws_account_id }}' --required, 
@dashboard_id='{{ dashboard_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"SnapshotJobId": "{{ SnapshotJobId }}", 
"UserConfiguration": "{{ UserConfiguration }}", 
"SnapshotConfiguration": "{{ SnapshotConfiguration }}"
}'
;