QuickSight / Client / update_dashboard

update_dashboard#

QuickSight.Client.update_dashboard(**kwargs)#

Updates a dashboard in an Amazon Web Services account.

Note

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.

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

Exceptions

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.ConflictException

  • QuickSight.Client.exceptions.LimitExceededException

  • QuickSight.Client.exceptions.UnsupportedUserEditionException

  • QuickSight.Client.exceptions.InternalFailureException