

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# CreateDashboard
<a name="API_CreateDashboard"></a>

从模板创建控制面板。要首先创建模板，请参阅 ` [CreateTemplate](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html) ` API 操作。

仪表板是亚马逊中的一个实体 QuickSight 标识亚马逊 QuickSight 报告，从分析创建。你可以分享亚马逊 QuickSight 控制面板。您可以通过相应的权限从中创建计划的电子邮件报告。如果您具有正确的权限，则可以从存在于另一个AWSaccount.

## 请求语法
<a name="API_CreateDashboard_RequestSyntax"></a>

```
POST /accounts/AwsAccountId/dashboards/DashboardId HTTP/1.1
Content-type: application/json

{
   "DashboardPublishOptions": { 
      "AdHocFilteringOption": { 
         "AvailabilityStatus": "string"
      },
      "ExportToCSVOption": { 
         "AvailabilityStatus": "string"
      },
      "SheetControlsOption": { 
         "VisibilityState": "string"
      }
   },
   "Name": "string",
   "Parameters": { 
      "DateTimeParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "DecimalParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "IntegerParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "StringParameters": [ 
         { 
            "Name": "string",
            "Values": [ "string" ]
         }
      ]
   },
   "Permissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ],
   "SourceEntity": { 
      "SourceTemplate": { 
         "Arn": "string",
         "DataSetReferences": [ 
            { 
               "DataSetArn": "string",
               "DataSetPlaceholder": "string"
            }
         ]
      }
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "ThemeArn": "string",
   "VersionDescription": "string"
}
```

## URI 请求参数
<a name="API_CreateDashboard_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [AwsAccountId](#API_CreateDashboard_RequestSyntax) **   <a name="QS-CreateDashboard-request-AwsAccountId"></a>
您要在其中创建控制面板的 AWS 账户的 ID。  
长度约束：固定长度为 12。  
模式：`^[0-9]{12}$`  
必需：必需 是

 ** [DashboardId](#API_CreateDashboard_RequestSyntax) **   <a name="QS-CreateDashboard-request-DashboardId"></a>
控制面板的 ID，也添加到 IAM policy 中。  
长度约束：最小长度为 1。长度上限为 2048。  
模式：`[\w\-]+`  
必需：必需 是

## 请求正文
<a name="API_CreateDashboard_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [Name](#API_CreateDashboard_RequestSyntax) **   <a name="QS-CreateDashboard-request-Name"></a>
控制面板的显示名称。  
类型: 字符串  
长度约束：最小长度为 1。长度上限为 2048。  
必需：必需 是

 ** [SourceEntity](#API_CreateDashboard_RequestSyntax) **   <a name="QS-CreateDashboard-request-SourceEntity"></a>
创建控制面板时用作源的实体。In`SourceEntity`，则指定要用作源的对象的类型。您只能从模板创建控制面板，因此请使用 `SourceTemplate` 实体。如果需要从分析创建控制面板，请先使用 ` [CreateTemplate](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html) ` API 操作将分析转换为模板。对于 `SourceTemplate`，指定源模板的 Amazon 资源名称（ARN）。这些区域有：`SourceTemplate`ARN 可以包含任何AWS账户和任何亚马逊 QuickSight-支持AWS 区域.  
使用 `SourceTemplate` 中的 `DataSetReferences` 实体列出原文中所列占位符的替换数据集。每个数据集中的架构必须与其占位符匹配。  
类型：[DashboardSourceEntity](API_DashboardSourceEntity.md) 对象  
必需：必需 是

 ** [DashboardPublishOptions](#API_CreateDashboard_RequestSyntax) **   <a name="QS-CreateDashboard-request-DashboardPublishOptions"></a>
创建时发布控制面板的选项：  
+  `AvailabilityStatus` 的 `AdHocFilteringOption` - 此状态可以是 `ENABLED` 或 `DISABLED`。当设置此属性时`DISABLED`，Amazon QuickSight 禁用已发布仪表板上的左侧筛选器窗格，该窗格可用于临时（一次性）筛选。默认情况下，此选项为 `ENABLED`。
+  `AvailabilityStatus` 的 `ExportToCSVOption` - 此状态可以是 `ENABLED` 或 `DISABLED`。此项设置为 `DISABLED` 时，将数据导出为 .CSV 格式的可视选项未启用。默认情况下，此选项为 `ENABLED`。
+  `VisibilityState` 的 `SheetControlsOption` - 此可见性状态可以是 `COLLAPSED` 或 `EXPANDED`。默认情况下，此选项为 `COLLAPSED`。
类型：[DashboardPublishOptions](API_DashboardPublishOptions.md) 对象  
必需：必需 否

 ** [Parameters](#API_CreateDashboard_RequestSyntax) **   <a name="QS-CreateDashboard-request-Parameters"></a>
用于创建控制面板的参数，您希望使用这些参数来覆盖默认设置。控制面板可以具有任何类型的参数，并且某些参数可接受多个值。  
类型：[Parameters](API_Parameters.md) 对象  
必需：必需 否

 ** [Permissions](#API_CreateDashboard_RequestSyntax) **   <a name="QS-CreateDashboard-request-Permissions"></a>
包含控制面板权限的结构。通过为每个主体 ARN 提供 IAM 操作信息列表，您可以使用此结构授予权限。  
如果不指定任何权限，请省略权限列表。  
类型: 数组的[ResourcePermission](API_ResourcePermission.md)对象  
数组成员：最少 1 项。最多 6项。  
必需：必需 否

 ** [Tags](#API_CreateDashboard_RequestSyntax) **   <a name="QS-CreateDashboard-request-Tags"></a>
包含分配给控制面板的一个或多个资源标签的键值对映射。  
类型: 数组的[Tag](API_Tag.md)对象  
数组成员：最少 1 项。最多 200 项。  
必需：必需 否

 ** [ThemeArn](#API_CreateDashboard_RequestSyntax) **   <a name="QS-CreateDashboard-request-ThemeArn"></a>
用于此控制面板的主题的 Amazon 资源名称（ARN）。如果为此字段添加值，它将覆盖源实体中使用的值。主题 ARN 必须存在于创建控制面板的同一 AWS 账户中。  
类型: 字符串  
必需：必需 否

 ** [VersionDescription](#API_CreateDashboard_RequestSyntax) **   <a name="QS-CreateDashboard-request-VersionDescription"></a>
所创建控制面板的第一个版本的描述。  
类型: 字符串  
长度约束：最小长度为 1。长度上限为 512。  
必需：必需 否

## 响应语法
<a name="API_CreateDashboard_ResponseSyntax"></a>

```
HTTP/1.1 Status
Content-type: application/json

{
   "Arn": "string",
   "CreationStatus": "string",
   "DashboardId": "string",
   "RequestId": "string",
   "VersionArn": "string"
}
```

## 响应元素
<a name="API_CreateDashboard_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 响应。

 ** [Status](#API_CreateDashboard_ResponseSyntax) **   <a name="QS-CreateDashboard-response-Status"></a>
请求的 HTTP 状态。

服务以 JSON 格式返回的以下数据。

 ** [Arn](#API_CreateDashboard_ResponseSyntax) **   <a name="QS-CreateDashboard-response-Arn"></a>
控制面板 ARN。  
类型: 字符串

 ** [CreationStatus](#API_CreateDashboard_ResponseSyntax) **   <a name="QS-CreateDashboard-response-CreationStatus"></a>
控制面板，创建请求的状态。  
类型: 字符串  
有效值:` CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED` 

 ** [DashboardId](#API_CreateDashboard_ResponseSyntax) **   <a name="QS-CreateDashboard-response-DashboardId"></a>
控制面板 ID。  
类型: 字符串  
长度约束：最小长度为 1。长度上限为 2048。  
模式：`[\w\-]+`

 ** [RequestId](#API_CreateDashboard_ResponseSyntax) **   <a name="QS-CreateDashboard-response-RequestId"></a>
这些区域有：AWS用于此操作的请求 ID。  
类型: 字符串

 ** [VersionArn](#API_CreateDashboard_ResponseSyntax) **   <a name="QS-CreateDashboard-response-VersionArn"></a>
控制面板的 ARN，包括创建的第一个版本的版本号。  
类型: 字符串

## 错误
<a name="API_CreateDashboard_Errors"></a>

有关所有操作常见错误的信息，请参阅[常见错误](CommonErrors.md).

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** InternalFailureException **   
出现内部故障。  
HTTP 状态代码：500

 ** InvalidParameterValueException **   
一个或多个参数的值无效。  
HTTP 状态代码：400

 ** ResourceExistsException **   
已存在指定的资源。  
HTTP 状态代码：409

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ThrottlingException **   
访问受限。  
HTTP 状态代码：429

 ** UnsupportedUserEditionException **   
此错误指示您正在 Amazon 上调用某个操作 QuickSight该版本不支持该操作的订阅。亚马逊Amazon QuickSight 当前具有标准版和企业版。每个版本中并未提供所有操作和功能。  
HTTP 状态代码：403

## 另请参阅
<a name="API_CreateDashboard_SeeAlso"></a>

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：
+  [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/CreateDashboard) 
+  [适用于 .NET 的 AWS SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/CreateDashboard) 
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/CreateDashboard) 
+  [适用于 Go 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/CreateDashboard) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/CreateDashboard) 
+  [AWS适用于的开发工具包 JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/CreateDashboard) 
+  [适用于 PHP V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/CreateDashboard) 
+  [适用于 Python 的 AWS SDK](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/CreateDashboard) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/CreateDashboard) 