CreateAnalysis - Amazon QuickSight

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

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

的 IDAWS您正在建立分析的帳戶。

長度限制:12。

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

必要 是

請求主體

請求接受採用 JSON 格式的下列資料。

Name

您正在建立之分析的描述名稱。此名稱顯示在亞馬遜分析 QuickSight 主控台。

類型:字串

長度限制:長度下限為 1。長度上限為 2048。

必要 是

SourceEntity

用於您建立之分析的來源實體。此中繼資料結構包含描述來源範本和一或多個資料集的詳細資料。

類型:AnalysisSourceEntity 物件

必要 是

Parameters

參數名稱和覆寫您要使用的值。一個分析可以有任何參數類型,並且某些參數可能接受多個值。

類型:Parameters 物件

必要 否

Permissions

描述分析的主參與者和資源層級權限的結構。您可以使用Permissions通過提供列表授予權限的結構AWS Identity and Access ManagementIAM) 依據 Amazon Resource Name (ARN) 列出的每個主要項目的操作資訊。

若不指定任何權限,請省略Permissions

類型:的陣列ResourcePermission對象

陣列成員:項目數下限為 1。項目數上限為 64。

必要 否

Tags

包含資源標籤或指定給分析的標籤的鍵值配對的對映。

類型:的陣列Tag對象

陣列成員:項目數下限為 1。項目數上限為 200。

必要 否

ThemeArn

佈景主題的 ARN 會套用至您正在建立的分析。要 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 目前包含 Standard Edition (企業版)。不是每個版本都會提供所有操作和功能。

HTTP 狀態碼:403

另請參閱

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊,請參閱下列說明: