# Dashboard operations
With dashboard API operations, you can perform actions on Amazon Quick Sight dashboards. For more information, see the following API operations.
**Topics**
+ [Dashboard permissions](dashboard-permissions.md)
+ [CreateDashboard](create-dashboard.md)
+ [DeleteDashboard](delete-dashboard.md)
+ [DescribeDashboard](describe-dashboard.md)
+ [ListDashboards](list-dashboards.md)
+ [ListDashboardVersions](list-dashboard-versions.md)
+ [SearchDashboards](search-dashboards.md)
+ [UpdateDashboard](update-dashboard.md)
+ [UpdateDashboardPublishedVersion](update-dashboard-published-version.md)
# Dashboard permissions
With dashboard permissions API operations, you can view and update permissions for dashboards. For more information, see the following API operations.
**Topics**
+ [DescribeDashboardPermissions](describe-dashboard-permissions.md)
+ [UpdateDashboardPermissions](update-dashboard-permissions.md)
# DescribeDashboardPermissions
Use the `DescribeDashboardPermissions` API operation to view the read and write permissions for a dashboard. To use this operation, you need the ID of the dashboard whose permissions you want to view. The dashboard ID is part of the dashboard URL in Quick Sight. You can also use the `ListDashboards` API operation to get the ID.
Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
```
aws quicksight describe-dashboard-permissions
--aws-account-id 555555555555
--dashboard-id 111122223333
```
------
For more information about the `DescribeDashboardPermissions` API operation, see [DescribeDashboardPermissions](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboardPermissions.html) in the *Amazon Quick Sight API Reference*.
# UpdateDashboardPermissions
Use the `UpdateDashboardPermissions` API operation to update read and write permissions for a dashboard. You can grant or revoke permissions in the same command. To use this operation, you need the ID of the dashboard whose permissions you want to update. The dashboard ID is part of the dashboard URL in Quick Sight. You can also use the `ListDashboards` API operation to get the ID.
Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
```
aws quicksight update-dashboard-permissions
--aws-account-id 555555555555
--dashboard-id DASHBOARDID
--grant-permissions Principal=arn:aws:quicksight:us-east-1:555555555555:user/default/USERNAME,Actions=quicksight:DescribeDashboard,quicksight:QueryDashboard,quicksight:ListDashboardVersions
--revoke-permissions Principal=arn:aws:quicksight:us-east-1:555555555555:user/default/USERNAME,Actions=quicksight:DescribeDashboard,quicksight:QueryDashboard,quicksight:ListDashboardVersions
```
If your `region` has already been configured within the CLI, it doesn't need to be included as an argument.
You can also make this command using a CLI skeleton file with the following command. For more information about CLI skeleton files, see [Use CLI skeleton files](cli-skeletons.md).
```
aws quicksight update-dashboard-permisisons
--cli-input-json file://updatedashboardpermissions.json
```
------
If your region has already been configured with the CLI, it does not need to be included in an argument.
For more information about the `UpdateDashboardPermissions` API operation, see [UpdateDashboardPermissions](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPermissions.html) in the *Amazon Quick Sight API Reference*.
# CreateDashboard
Use the `CreateDashboard` API operation to create a dashboard. Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
```
aws quicksight create-dashboard
--aws-account-id 555555555555
--dashboard-id newDash
--name Dashboard1
--source-entity '{"SourceTemplate":{"DataSetReferences":[{"DataSetPlaceholder":"PLACEHOLDER","DataSetArn":"arn:aws:quicksight:REGION:555555555555:dataset/DATASETID"}],"Arn":"arn:aws:quicksight:REGION:555555555555:template/TEMPLATEID"}}'
```
If your `region` has already been configured within the CLI, it doesn't need to be included as an argument.
You can also make this command using a CLI skeleton file with the following command. For more information about CLI skeleton files, see [Use CLI skeleton files](cli-skeletons.md).
```
aws quicksight create-dashbord
--cli-input-json file://createdashboard.json
```
------
If your region has already been configured with the CLI, it does not need to be included in an argument.
For more information about the `CreateDashboard` API operation, see [CreateDashboard](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateDashboard.html) in the *Amazon Quick Sight API Reference*.
# DeleteDashboard
Use the `DeleteDashboard` API operation to delete a dashboard. To use this operation, you need the ID of the dashboard that you want to delete. The dashboard ID is part of the dashboard URL in Quick Sight. You can also use the `ListDashboards` API operation to get the ID.
You can add a `VersionNumber` parameter to this operation to only delete the specified version of the dashboard.
Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
```
aws quicksight delete-dashboard
--aws-account-id 555555555555
--dashboard-id DASHBOARDID
```
------
For more information about the `DeleteDashboard` API operation, see [DeleteDashboard](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DeleteDashboard.html) in the *Amazon Quick Sight API Reference*.
# DescribeDashboard
Use the `DescribeDashboard` API operation to view the summary of a dashboard. To use this operation, you need the ID of the dashboard that you want to view. The dashboard ID is part of the dashboard URL in Quick Sight. You can also use the `ListDashboards` API operation to get the ID.
Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
```
aws quicksight describe-dashboard
--aws-account-id 555555555555
--dashboard-id DASHBOARDID
```
------
For more information about the `DescribeDashboard` API operation, see [DescribeDashboard](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboard.html) in the *Amazon Quick Sight API Reference*.
# ListDashboards
Use the `ListDashboards` API operation to list dashboards in an AWS account. Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
```
aws quicksight list-dashboards
--aws-account-id 555555555555
--page-size 10
--max-items 100
```
------
For more information about the `ListDashboards` API operation, see [ListDashboards](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ListDashboards.html) in the *Amazon Quick Sight API Reference*.
# ListDashboardVersions
Use the `ListDashboardVersions` API operation to list all the versions of a dashboard in an AWS account. To use this operation, you need the ID of the dashboard that you want to update. The dashboard ID is part of the dashboard URL in Quick Sight. You can also use the `ListDashboards` API operation to get the ID.
Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
```
aws quicksight list-dashboard-versions
--aws-account-id AWSACCOUNTID
--dashboard-id DASHBOARD
--page-size 10
--max-items 100
```
------
For more information about the `ListDashboardVersions` API operation, see [ListDashboardVersions](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ListDashboardVersions.html) in the *Amazon Quick Sight API Reference*.
# SearchDashboards
Use the `SearchDashboards` API operation to search for dashboards in an AWS account. Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
```
aws quicksight search-dashboards
--aws-account-id 555555555555
--filters Operator=StringEquals,Name=QUICKSIGHT_USER,Value=arn:aws:quicksight:us-east-1:555555555555:user/default/USERNAME
--page-size 10
--max-items 100
```
If your `region` has already been configured within the CLI, it doesn't need to be included as an argument.
------
If your region has already been configured with the CLI, it does not need to be included in an argument.
For more information about the `SearchDashboards` API operation, see [SearchDashboards](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_SearchDashboards.html) in the *Amazon Quick Sight API Reference*.
# UpdateDashboard
Use the `UpdateDashboard` API operation to update a dashboard in an AWS account. To use this operation, you need the ID of the dashboard that you want to update. The dashboard ID is part of the dashboard URL in Quick Sight. You can also use the `ListDashboards` API operation to get the ID.
Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
```
aws quicksight update-dashboard
--aws-account-id 555555555555
--dashboard-id DASHBOARDID
--name Dashboard
--source-entity '{"SourceTemplate":{"DataSetReferences":[{"DataSetPlaceholder": "PLACEHOLDER","DataSetArn": "arn:aws:quicksight:::dataset/"}],"Arn": "arn:aws:quicksight:::template/"}}'
--version-description VERSION
--dashboard-publish-options AdHocFilteringOption={AvailabilityStatus=ENABLED},ExportToCSVOption={AvailabilityStatus=ENABLED},SheetControlsOption={VisibilityState=EXPANDED} /
--theme-arn THEMEARN
```
If your `region` has already been configured within the CLI, it doesn't need to be included as an argument.
You can also make this command using a CLI skeleton file with the following command. For more information about CLI skeleton files, see [Use CLI skeleton files](cli-skeletons.md).
```
aws quicksight update-dashboard
--cli-input-json file://updatedashboard.json
```
------
If your region has already been configured with the CLI, it does not need to be included in an argument.
For more information about the `UpdateDashboard` API operation, see [UpdateDashboard](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboard.html) in the *Amazon Quick Sight API Reference*.
# UpdateDashboardPublishedVersion
Use the `UpdateDashboardPublishedVersion` API operation to update the published version of a dashboard. To use this operation, you need the ID of the published dashboard that you want to update. The dashboard ID is part of the dashboard URL in Quick Sight. You can also use the `ListDashboards` API operation to get the ID.
Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
```
aws quicksight update-dashboard-published-version
--aws-account-id 555555555555
--dashboard-id DASHBOARDID
--dashboard-version-number VERSION
```
You can also make this command using a CLI skeleton file with the following command. For more information about CLI skeleton files, see [Use CLI skeleton files](cli-skeletons.md).
```
aws quicksight update-dashboard-published-version
--cli-input-json file://updatedashboardpublishedversion.json
```
------
For more information about the `UpdateDashboardPublishedVersion` API operation, see [UpdateDashboardPublishedVersion](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html) in the *Amazon Quick Sight API Reference*.