QuickSight / Client / delete_dashboard

delete_dashboard#

QuickSight.Client.delete_dashboard(**kwargs)#

Deletes a dashboard.

See also: AWS API Documentation

Request Syntax

response = client.delete_dashboard(
    AwsAccountId='string',
    DashboardId='string',
    VersionNumber=123
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the dashboard that you’re deleting.

  • DashboardId (string) –

    [REQUIRED]

    The ID for the dashboard.

  • VersionNumber (integer) – The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 123,
    'Arn': 'string',
    'DashboardId': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • Status (integer) –

      The HTTP status of the request.

    • Arn (string) –

      The Secure Socket Layer (SSL) properties that apply for the resource.

    • DashboardId (string) –

      The ID of the dashboard.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.ConflictException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.UnsupportedUserEditionException

  • QuickSight.Client.exceptions.InternalFailureException