CreateAccountSubscription - Amazon QuickSight

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

CreateAccountSubscription

建立 Amazon QuickSight 帳戶,或訂閱亞馬遜 QuickSight Q。

所以此AWS 區域對於該帳戶是從中配置的內容衍生出來的AWS CLI或開發套件。美國東部 (俄亥俄) 區域、南美洲 (聖保羅) 區域或亞太區域 (新加坡) 區域不支援此作業。

在使用此操作之前,請確保您可以連接到現有AWS 帳戶。如果您沒有AWS 帳戶,請參閱註冊AWS中的亞馬遜 QuickSight 使用者指南。註冊亞馬遜的人 QuickSight 需要有正確的AWS Identity and Access Management(IAM) 許可權。如需詳細資訊,請參閱「」Amazon 政策範例 QuickSight中的亞馬遜 QuickSight 使用者指南

如果您的 IAM 政策同時包含SubscribeCreateAccountSubscription動作,請確定兩個動作都設定為Allow。如果其中一個動作設定為Deny,該Deny動作盛行,您的 API 呼叫失敗。

您無法傳遞現有的 IAM 角色來存取其他角色AWS使用此 API 操作的服務。將您現有的 IAM 角色傳遞給亞馬遜 QuickSight,請參閱將 IAM 角色傳遞給亞馬遜 QuickSight中的亞馬遜 QuickSight 使用者指南

您無法從亞馬遜對新帳戶設置默認資源訪問 QuickSightAPI。相反,從亞馬遜添加默認資源訪問 QuickSight console (英文) 如需將預設資源存取權設定為的相關資訊AWS服務,請參閱將預設資源存取權限設定為AWS服務中的亞馬遜 QuickSight使用者指南

請求語法

POST /account/AwsAccountId HTTP/1.1 Content-type: application/json { "AccountName": "string", "ActiveDirectoryName": "string", "AdminGroup": [ "string" ], "AuthenticationMethod": "string", "AuthorGroup": [ "string" ], "ContactNumber": "string", "DirectoryId": "string", "Edition": "string", "EmailAddress": "string", "FirstName": "string", "LastName": "string", "NotificationEmail": "string", "ReaderGroup": [ "string" ], "Realm": "string" }

URI 請求參數

請求會使用下列 URI 參數。

AwsAccountId

所以此AWS 帳戶您用來建立 Amazon Amazon 的帳戶 ID QuickSight 帳戶。

長度限制:長度固定為 12。

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

必要:是

請求主體

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

AccountName

Amazon 的名稱 QuickSight 帳戶。這個名稱在所有人中都是唯一的AWS,只有在使用者登入時才會顯示。您無法變更AccountName亞馬遜後的價值 QuickSight 已建立帳戶。

類型:字串

必要:是

AuthenticationMethod

您想要用來身份驗證您的亞馬遜方法 QuickSight 帳戶。目前,此參數的有效值為IAM_AND_QUICKSIGHTIAM_ONLY,以及ACTIVE_DIRECTORY

如果選擇ACTIVE_DIRECTORY,提供一個ActiveDirectoryName和一個AdminGroup與您的 Active Directory 相關聯。

類型:字串

有效值: IAM_AND_QUICKSIGHT | IAM_ONLY | ACTIVE_DIRECTORY

必要:是

Edition

亞馬遜版 QuickSight 您希望您的帳戶擁有。目前,您可以選擇ENTERPRISE或者ENTERPRISE_AND_Q

如果選擇ENTERPRISE_AND_Q,下列是必要參數:

  • FirstName

  • LastName

  • EmailAddress

  • ContactNumber

類型:字串

有效值: STANDARD | ENTERPRISE | ENTERPRISE_AND_Q

必要:是

NotificationEmail

您希望亞馬遜的電子郵件地址 QuickSight 傳送通知給您的 Amazon 相關資訊 QuickSight 帳戶或亞馬遜 QuickSight 訂閱。

類型:字串

必要:是

ActiveDirectoryName

您的 Active Directory 的名稱。如果您有,即需要此欄位ACTIVE_DIRECTORY是新亞馬遜選定的身份驗證方法 QuickSight 帳戶。

類型:字串

必要:否

AdminGroup

與您 Active Directory 相關聯的管理員群組。如果您有,即需要此欄位ACTIVE_DIRECTORY是新亞馬遜選定的身份驗證方法 QuickSight 帳戶。有關在亞馬遜使用 Active Directory 的詳細資訊 QuickSight,請參閱Amazon 使用 Active Directory QuickSight 企業版本在 Amazon QuickSight使用者指南。

類型:字串陣列

必要:否

AuthorGroup

與您 Active Directory 相關聯的作者群組。有關在亞馬遜使用 Active Directory 的詳細資訊 QuickSight,請參閱Amazon 使用 Active Directory QuickSight 企業版本在 Amazon QuickSight使用者指南。

類型:字串陣列

必要:否

ContactNumber

亞馬遜作者的 10 位數電話號碼 QuickSight 用於 future 通信的帳戶。如果您有,即需要此欄位ENTERPPRISE_AND_Q是新亞馬遜的精選版本 QuickSight 帳戶。

類型:字串

必要:否

DirectoryId

與您的 Amazon 相關聯的 Active Directory Directory ID QuickSight 帳戶。

類型:字串

必要:否

EmailAddress

亞馬遜作者的電子郵件地址 QuickSight 用於 future 通信的帳戶。如果您有,即需要此欄位ENTERPPRISE_AND_Q是新亞馬遜的精選版本 QuickSight 帳戶。

類型:字串

必要:否

FirstName

亞馬遜作者的名字 QuickSight 用於 future 通信的帳戶。如果您有,即需要此欄位ENTERPPRISE_AND_Q是新亞馬遜的精選版本 QuickSight 帳戶。

類型:字串

必要:否

LastName

亞馬遜作者的姓氏 QuickSight 用於 future 通信的帳戶。如果您有,即需要此欄位ENTERPPRISE_AND_Q是新亞馬遜的精選版本 QuickSight 帳戶。

類型:字串

必要:否

ReaderGroup

與您的「作用中導覽」相關聯的讀取器群組。有關在亞馬遜使用 Active Directory 的詳細資訊 QuickSight,請參閱Amazon 使用 Active Directory QuickSight 企業版本中的亞馬遜 QuickSight使用者指南

類型:字串陣列

必要:否

Realm

與您的亞馬遜相關聯的活動目錄的領域 QuickSight 帳戶。如果您有,即需要此欄位ACTIVE_DIRECTORY是新亞馬遜選定的身份驗證方法 QuickSight 帳戶。

類型:字串

必要:否

回應語法

HTTP/1.1 Status Content-type: application/json { "RequestId": "string", "SignupResponse": { "accountName": "string", "directoryType": "string", "IAMUser": boolean, "userLoginName": "string" } }

回應元素

如果動作成功,則服務傳回下列 HTTP 回應。

Status

請求的 HTTP 狀態。

服務會傳回下列 JSON 格式的資料。

RequestId

所以此AWS此操作的請求 ID。

類型:字串

SignupResponse

一個SignupResponse返回有關新創建的亞馬遜信息的對象 QuickSight 帳戶。

類型:SignupResponse 物件

錯誤

如需所有動作常見的錯誤相關資訊,請參閱常見錯誤

AccessDeniedException

您無法存取此項目。提供的登入資料無法驗證。您可能無法取得授權以執行請求。確保您的帳戶已獲授權使用亞馬遜 QuickSight 服務,您的政策有正確許可,以及您使用正確的存取金鑰。

HTTP 狀態碼:HTTP 狀態碼:401

ConflictException

更新或刪除資源可能會導致不一致的狀態。

HTTP 狀態碼:HTTP 狀態碼:409

InternalFailureException

發生內部故障。

HTTP 狀態碼:HTTP 狀態碼:500

InvalidParameterValueException

一或多個參數的值無效。

HTTP 狀態碼:HTTP 狀態碼:400

PreconditionNotMetException

未滿足一個或多個先決條件。

HTTP 狀態碼:HTTP 狀態碼:400

ResourceExistsException

指定的資源已存在。

HTTP 狀態碼:HTTP 狀態碼:409

ResourceNotFoundException

無法找到一個或多個資源。

HTTP 狀態碼:HTTP 狀態碼:404

ResourceUnavailableException

此資源目前無法使用。

HTTP 狀態碼:HTTP 狀態碼:503

ThrottlingException

存取已調節。

HTTP 狀態碼:HTTP 狀態碼:429

另請參閱

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