DescribeAccountCustomization - Amazon QuickSight

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

DescribeAccountCustomization

描述与提供的相关联的自定义AWS账户和亚马逊亚马逊 QuickSight 命名空间AWS 区域. Amazon on QuickSight 控制台通过运行此 API 操作来评估要应用哪些自定义设置Resolved包括标记。

要确定运行此命令时显示的自定义项,它有助于直观显示所涉及的实体的关系。

  • AWS account-该AWS账户位于层次结构的顶部。它有可能使用所有的AWS 区域和AWS服务。当您订阅 Amamazon on on 时 QuickSight,你选一个AWS 区域用作你的家乡地区。这就是您的免费 SPICE 容量所在的位置。你可以使用亚马逊 QuickSight 在任何受支持的环境中AWS 区域.

  • AWS 区域 -在每个AWS 区域您在哪里登录亚马逊 QuickSightAmazon on 至少一次 QuickSight 充当同一服务的单独实例。如果您有用户目录,则它位于 us-east-est-est-est-eas-est-1,即美国东部(弗吉尼亚北部)。一般来说,这些用户可以访问亚马逊 QuickSight 在任何AWS 区域,除非它们被限制在命名空间中。

    在其他的环境中运行AWS 区域,则可以更改区域设置。如果您使用的是AWS CLI,您可以使用以下选项之一:

  • Namespace-一个 QuickSight namespace 是一个包含用户和资产(数据源、数据集、仪表板等)的分区。要访问位于特定命名空间中的资产,用户和组也必须属于同一命名空间。共享命名空间的人与其他命名空间中的用户和资产完全隔离,即使他们在同一个命名空间中AWS账户和AWS 区域.

  • Applied customizations-在AWS 区域,一套亚马逊 QuickSight 自定义项可以应用于AWS账户或命名空间。应用于命名空间的设置会覆盖应用于命名空间的设置AWSaccount. 所有设置都隔离到一个AWS 区域. 将它们应用于其他AWS 区域,运行CreateAccountCustomization每个命令AWS 区域要在其中应用相同的自定义。

请求语法

GET /accounts/AwsAccountId/customizations?namespace=Namespace&resolved=Resolved HTTP/1.1

URI 请求参数

请求使用以下 URI 参数。

AwsAccountId

的的 IDAWS您希望描述Amazon 的账户 QuickSight 的自定义。

长度约束:固定长度为 12

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

必需:是

Namespace

Amazon on QuickSight 您希望描述Amazon 的命名空间 QuickSight 的自定义。

长度约束:最大长度为 64。

模式:^[a-zA-Z0-9._-]*$

Resolved

这些区域有:Resolvedflag 与其他参数一起使用以确定亚马逊的哪个视图 QuickSight 返回自定义项。您可以将此标志添加到您的命令中,以使用与 Amazon 相同的视图 QuickSight 用于标识要应用于控制台的自定义项。省略此标志,或将其设置为no-resolved,以显示在不同级别配置的自定义项。

请求正文

该请求没有请求体。

响应语法

HTTP/1.1 Status Content-type: application/json { "AccountCustomization": { "DefaultEmailCustomizationTemplate": "string", "DefaultTheme": "string" }, "Arn": "string", "AwsAccountId": "string", "Namespace": "string", "RequestId": "string" }

响应元素

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

Status

请求的 HTTP 状态。

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

AccountCustomization

Amazon on QuickSight 当前版本中存在的自定义AWS 区域.

类型:AccountCustomization 对象

Arn

与此相关联的自定义 (ARN) 的自定义AWSaccount.

类型: 字符串

AwsAccountId

的的 IDAWS你描述的账户。

类型: 字符串

长度约束:固定长度为 12

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

Namespace

Amazon on QuickSight 你正在描述的命名空间。

类型: 字符串

长度约束:最大长度为 64。

模式:^[a-zA-Z0-9._-]*$

RequestId

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

类型: 字符串

错误

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

AccessDeniedException

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

HT状态代码:401

InternalFailureException

出现内部故障。

HT状态代码:500

InvalidParameterValueException

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

HT状态代码:400

ResourceNotFoundException

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

HT状态代码:404

ResourceUnavailableException

此资源当前不可用。

HT状态代码:503

ThrottlingException

访问受限。

HT状态代码:429

另请参阅

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