Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeDashboard

Provides a summary for a dashboard.

Request Syntax


GET /accounts/AwsAccountId/dashboards/DashboardId?alias-name=AliasName&version-number=VersionNumber HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AliasName

The alias name.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

AwsAccountId

The ID of the AWS account that contains the dashboard that you're describing.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

DashboardId

The ID for the dashboard.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

Required: Yes

VersionNumber

The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.

Valid Range: Minimum value of 1.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "Dashboard": { 
      "Arn": "string",
      "CreatedTime": number,
      "DashboardId": "string",
      "LastPublishedTime": number,
      "LastUpdatedTime": number,
      "LinkEntities": [ "string" ],
      "Name": "string",
      "Version": { 
         "Arn": "string",
         "CreatedTime": number,
         "DataSetArns": [ "string" ],
         "Description": "string",
         "Errors": [ 
            { 
               "Message": "string",
               "Type": "string",
               "ViolatedEntities": [ 
                  { 
                     "Path": "string"
                  }
               ]
            }
         ],
         "Sheets": [ 
            { 
               "Images": [ 
                  { 
                     "Actions": [ 
                        { 
                           "ActionOperations": [ 
                              { 
                                 "NavigationOperation": { 
                                    "LocalNavigationConfiguration": { 
                                       "TargetSheetId": "string"
                                    }
                                 },
                                 "SetParametersOperation": { 
                                    "ParameterValueConfigurations": [ 
                                       { 
                                          "DestinationParameterName": "string",
                                          "Value": { 
                                             "CustomValuesConfiguration": { 
                                                "CustomValues": { 
                                                   "DateTimeValues": [ number ],
                                                   "DecimalValues": [ number ],
                                                   "IntegerValues": [ number ],
                                                   "StringValues": [ "string" ]
                                                },
                                                "IncludeNullValue": boolean
                                             },
                                             "SelectAllValueOptions": "string",
                                             "SourceColumn": { 
                                                "ColumnName": "string",
                                                "DataSetIdentifier": "string"
                                             },
                                             "SourceField": "string",
                                             "SourceParameterName": "string"
                                          }
                                       }
                                    ]
                                 },
                                 "URLOperation": { 
                                    "URLTarget": "string",
                                    "URLTemplate": "string"
                                 }
                              }
                           ],
                           "CustomActionId": "string",
                           "Name": "string",
                           "Status": "string",
                           "Trigger": "string"
                        }
                     ],
                     "ImageContentAltText": "string",
                     "Interactions": { 
                        "ImageMenuOption": { 
                           "AvailabilityStatus": "string"
                        }
                     },
                     "Scaling": { 
                        "ScalingType": "string"
                     },
                     "SheetImageId": "string",
                     "Source": { 
                        "SheetImageStaticFileSource": { 
                           "StaticFileId": "string"
                        }
                     },
                     "Tooltip": { 
                        "TooltipText": { 
                           "PlainText": "string"
                        },
                        "Visibility": "string"
                     }
                  }
               ],
               "Name": "string",
               "SheetId": "string"
            }
         ],
         "SourceEntityArn": "string",
         "Status": "string",
         "ThemeArn": "string",
         "VersionNumber": number
      }
   },
   "RequestId": "string"
}

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status: The HTTP status of this request.

The following data is returned in JSON format by the service.

Dashboard

Information about the dashboard.

Type: Dashboard object

RequestId

The AWS request ID for this operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

HTTP Status Code: 429

UnsupportedUserEditionException

This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

HTTP Status Code: 403