CreateAnalysis - Amazon QuickSight
请求语法URI 请求参数请求正文响应语法响应元素错误另请参阅

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

CreateAnalysis

在 Amazon 中创建分析 QuickSight.

请求语法

POST /accounts/AwsAccountId/analyses/AnalysisId HTTP/1.1
Content-type: application/json

{
   "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"
}

URI 请求参数

请求使用以下 URI 参数。

AnalysisId

您创建的分析的 ID。此 ID 在分析的 URL 中显示。

长度限制：最小长度为 1。长度上限为 2048。

模式：[\w\-]+

必需：是

AwsAccountId

您在其中创建分析的 AWS 账户的 ID。

长度限制：固定长度为 12。

模式：^[0-9]{12}$

必需：是

请求正文

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

Name

您创建的分析的描述性名称。此名称将显示在亚马逊进行分析 QuickSight 控制台。

类型: 字符串

长度限制：最小长度为 1。长度上限为 2048。

必需：是

SourceEntity

用于您创建的分析的源实体。此元数据结构包含描述源模板以及一个或多个数据集的详细信息。

类型：AnalysisSourceEntity 对象

必需：是

Parameters

要使用的参数名称和覆盖值。分析可以具有任何参数类型，并且某些参数可接受多个值。

类型：Parameters 对象

必需：否

Permissions

描述分析的主体和资源级别权限的结构。通过为 Amazon 资源名称（ARN）列出的每个主体提供 AWS Identity and Access Management（IAM）操作信息列表，可以使用 Permissions 结构授予权限。

如果不指定任何权限，请省略 Permissions。

类型: 数组ResourcePermission对象

数组成员：最少 1 项。最多 6项。

必需：否

Tags

包含分配给分析的一个或多个资源标签的键值对映射。

类型: 数组Tag对象

数组成员：最少 1 项。最多 20项。

必需：否

ThemeArn

要应用于您所创建分析主题的 ARN。在 Amazon 上看到主题 QuickSight 控制台上，请确保您可以访问它。

类型: 字符串

必需：否

响应语法

HTTP/1.1 Status
Content-type: application/json

{
   "AnalysisId": "string",
   "Arn": "string",
   "CreationStatus": "string",
   "RequestId": "string"
}

响应元素

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

Status

请求的 HTTP 状态。

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

AnalysisId

分析的 ID。

类型: 字符串

长度限制：最小长度为 1。长度上限为 2048。

模式：[\w\-]+

Arn

用于分析的 ARN。

类型: 字符串

CreationStatus

分析的创建状态。

类型: 字符串

有效值: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

RequestId

这些区域有：AWS用于此操作的请求 ID。

类型: 字符串

错误

有关所有操作共有的错误的信息，请参阅常见错误.

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 的更多信息，请参阅以下内容：