CreateAccountSubscription - Amazon QuickSight

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

CreateAccountSubscription

创建 Amazon QuickSight 账户,或订阅亚马逊 QuickSight Q。

这些区域有:AWS 区域因为该账户是从中配置的派生出来的AWS CLI或开发工具包。美国东部(俄亥俄)区域、南美洲(圣保罗)区域或亚太地区(新加坡)区域不支持此操作。

在使用此操作之前,请确保您可以连接到现有的AWS 账户. 如果您没有,则该设置AWS 账户,请参阅注册AWS中的亚马逊 QuickSight 用户指南. 注册亚马逊的人 QuickSight 需要有正确的AWS Identity and Access Management(IAM) 权限。有关更多信息,请参阅 。Amazon 的 IAM 策略示例 QuickSight中的亚马逊 QuickSight 用户指南.

如果您的 IAM 策略同时包含SubscribeCreateAccountSubscription操作,请确保两个操作都设置为Allow. 如果将任一操作设置为Deny,该Deny操作占上风,您的 API 调用失败。

您无法传递现有 IAM 角色来访问其他AWS使用 API 操作的服务。将您的现有 IAM 角色传递给亚马逊 QuickSight,请参阅将 IAM 角色传递给亚马逊 QuickSight中的亚马逊 QuickSight 用户指南.

您无法从亚马逊为新账户设置默认资源访问权限 QuickSightAPI。相反,添加来自亚马逊的默认资源访问权限 QuickSight 控制台。有关将默认资源访问设置为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 账户您要用于创建亚马逊的账户的 ID QuickSight account.

长度约束: 长度为 12。

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

必需: 是

请求正文

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

AccountName

您的 Amazon 的名称 QuickSight account. 这个名字在所有方面都是唯一的AWS,并且仅在用户登录时才会显示。无法更改此设置AccountName仅次于亚马逊的价值 QuickSight 账户已创建。

类型: 字符串

必需: 是

AuthenticationMethod

您希望用于对您的亚马逊进行身份验证的方法 QuickSight account. 目前,此参数的有效值为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 向发送有关您的亚马逊的通知 QuickSight 账户或亚马逊 QuickSight 订阅。

类型: 字符串

必需: 是

ActiveDirectoryName

您的 Act Directory 的名称。对于是必需的ACTIVE_DIRECTORY是新亚马逊的选定身份验证方法 QuickSight account.

类型: 字符串

必需: 否

AdminGroup

与您的 Active Directory 关联的管理员组。对于是必需的ACTIVE_DIRECTORY是新亚马逊的选定身份验证方法 QuickSight account. 有关在 Amazon 中使用活动目录的更多信息,请参阅 QuickSight,请参阅将 Active Direct QuickSight 企业版在Amazon QuickSight用户指南。

类型: 字符串数组

必需: 否

AuthorGroup

与您的 Active Directory 关联的作者组。有关在 Amazon 中使用活动目录的更多信息,请参阅 QuickSight,请参阅将 Active Direct QuickSight 企业版在Amazon QuickSight用户指南。

类型: 字符串数组

必需: 否

ContactNumber

亚马逊作者的10位电话号码 QuickSight 用于将future 通信的账户。对于是必需的ENTERPPRISE_AND_Q是全新亚马逊的精选版本 QuickSight account.

类型: 字符串

必需: 否

DirectoryId

与您的 Amazon 关联的 Active Directory 的 ID QuickSight account.

类型: 字符串

必需: 否

EmailAddress

亚马逊作者的电子邮件地址 QuickSight 用于将future 通信的账户。对于是必需的ENTERPPRISE_AND_Q是全新亚马逊的精选版本 QuickSight account.

类型: 字符串

必需: 否

FirstName

亚马逊作者的名字 QuickSight 用于将future 通信的账户。对于是必需的ENTERPPRISE_AND_Q是全新亚马逊的精选版本 QuickSight account.

类型: 字符串

必需: 否

LastName

亚马逊作者的姓氏 QuickSight 用于将future 通信的账户。对于是必需的ENTERPPRISE_AND_Q是全新亚马逊的精选版本 QuickSight account.

类型: 字符串

必需: 否

ReaderGroup

与您的活动目录关联的读者组。有关在 Amazon 中使用活动目录的更多信息,请参阅 QuickSight,请参阅将 Active Direct QuickSight 企业版中的亚马逊 QuickSight用户指南.

类型: 字符串数组

必需: 否

Realm

与您的亚马逊关联的 Active Directory 的领域 QuickSight account. 对于是必需的ACTIVE_DIRECTORY是新亚马逊的选定身份验证方法 QuickSight account.

类型: 字符串

必需: 否

响应语法

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 account.

类型:SignupResponse 对象

错误

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

AccessDeniedException

您无权访问此内容。无法验证提供的凭证。您可能无权执行请求。确保您的账户已获得使用亚马逊的授权 QuickSight 服务,您的策略具有正确的权限,并且您使用的是正确的访问密钥。

HTTP 状态代码:401

ConflictException

更新或删除资源可能会导致状态不一致。

HTTP 状态代码:409

InternalFailureException

出现内部故障。

HTTP 状态代码:500

InvalidParameterValueException

一个或多个参数的值无效。

HTTP 状态代码:400

PreconditionNotMetException

未满足一个或多个先决条件。

HTTP 状态代码:400

ResourceExistsException

已存在指定的资源。

HTTP 状态代码:409

ResourceNotFoundException

无法找到一个或多个资源。

HTTP 状态代码:404

ResourceUnavailableException

此资源当前不可用。

HTTP 状态代码:503

ThrottlingException

访问受限。

HTTP 状态代码:429

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: