本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
CreateDashboard
从模板创建控制面板。要首先创建模板,请参阅
CreateTemplate
API 操作。
仪表板是亚马逊中的一个实体 QuickSight 标识亚马逊 QuickSight 报告,从分析创建。你可以分享亚马逊 QuickSight 控制面板。您可以通过相应的权限从中创建计划的电子邮件报告。如果您具有正确的权限,则可以从存在于另一个AWSaccount.
请求语法
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 请求参数
请求使用以下 URI 参数。
- AwsAccountId
-
您要在其中创建控制面板的 AWS 账户的 ID。
长度约束:固定长度为 12。
模式:
^[0-9]{12}$
必需:必需 是
- DashboardId
-
控制面板的 ID,也添加到 IAM policy 中。
长度约束:最小长度为 1。长度上限为 2048。
模式:
[\w\-]+
必需:必需 是
请求正文
请求接受采用 JSON 格式的以下数据。
- Name
-
控制面板的显示名称。
类型: 字符串
长度约束:最小长度为 1。长度上限为 2048。
必需:必需 是
- SourceEntity
-
创建控制面板时用作源的实体。In
SourceEntity
,则指定要用作源的对象的类型。您只能从模板创建控制面板,因此请使用SourceTemplate
实体。如果需要从分析创建控制面板,请先使用CreateTemplate
API 操作将分析转换为模板。对于SourceTemplate
,指定源模板的 Amazon 资源名称(ARN)。这些区域有:SourceTemplate
ARN 可以包含任何AWS账户和任何亚马逊 QuickSight-支持AWS 区域.使用
SourceTemplate
中的DataSetReferences
实体列出原文中所列占位符的替换数据集。每个数据集中的架构必须与其占位符匹配。类型:DashboardSourceEntity 对象
必需:必需 是
- DashboardPublishOptions
-
创建时发布控制面板的选项:
-
AvailabilityStatus
的AdHocFilteringOption
- 此状态可以是ENABLED
或DISABLED
。当设置此属性时DISABLED
,Amazon QuickSight 禁用已发布仪表板上的左侧筛选器窗格,该窗格可用于临时(一次性)筛选。默认情况下,此选项为ENABLED
。 -
AvailabilityStatus
的ExportToCSVOption
- 此状态可以是ENABLED
或DISABLED
。此项设置为DISABLED
时,将数据导出为 .CSV 格式的可视选项未启用。默认情况下,此选项为ENABLED
。 -
VisibilityState
的SheetControlsOption
- 此可见性状态可以是COLLAPSED
或EXPANDED
。默认情况下,此选项为COLLAPSED
。
类型:DashboardPublishOptions 对象
必需:必需 否
-
- Parameters
-
用于创建控制面板的参数,您希望使用这些参数来覆盖默认设置。控制面板可以具有任何类型的参数,并且某些参数可接受多个值。
类型:Parameters 对象
必需:必需 否
- Permissions
-
包含控制面板权限的结构。通过为每个主体 ARN 提供 IAM 操作信息列表,您可以使用此结构授予权限。
如果不指定任何权限,请省略权限列表。
类型: 数组的ResourcePermission对象
数组成员:最少 1 项。最多 6项。
必需:必需 否
- Tags
-
包含分配给控制面板的一个或多个资源标签的键值对映射。
类型: 数组的Tag对象
数组成员:最少 1 项。最多 200 项。
必需:必需 否
- ThemeArn
-
用于此控制面板的主题的 Amazon 资源名称(ARN)。如果为此字段添加值,它将覆盖源实体中使用的值。主题 ARN 必须存在于创建控制面板的同一 AWS 账户中。
类型: 字符串
必需:必需 否
- VersionDescription
-
所创建控制面板的第一个版本的描述。
类型: 字符串
长度约束:最小长度为 1。长度上限为 512。
必需:必需 否
响应语法
HTTP/1.1 Status
Content-type: application/json
{
"Arn": "string",
"CreationStatus": "string",
"DashboardId": "string",
"RequestId": "string",
"VersionArn": "string"
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 响应。
- Status
-
请求的 HTTP 状态。
服务以 JSON 格式返回的以下数据。
- Arn
-
控制面板 ARN。
类型: 字符串
- CreationStatus
-
控制面板,创建请求的状态。
类型: 字符串
有效值:
CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED
- DashboardId
-
控制面板 ID。
类型: 字符串
长度约束:最小长度为 1。长度上限为 2048。
模式:
[\w\-]+
- RequestId
-
这些区域有:AWS用于此操作的请求 ID。
类型: 字符串
- VersionArn
-
控制面板的 ARN,包括创建的第一个版本的版本号。
类型: 字符串
错误
有关所有操作常见错误的信息,请参阅常见错误.
- 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
另请参阅
有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: