QuickSight / Client / create_dashboard

create_dashboard#

QuickSight.Client.create_dashboard(**kwargs)#

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 QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon 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 Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

Parameters

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

Return type:

dict

Returns:

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 Amazon Web Services request ID for this operation.

Exceptions