UpdateUser

Amazon QuickSight ユーザー。

リクエストの構文

PUT /accounts/AwsAccountId/namespaces/Namespace/users/UserName HTTP/1.1
Content-type: application/json

{
   "CustomFederationProviderUrl": "string",
   "CustomPermissionsName": "string",
   "Email": "string",
   "ExternalLoginFederationProviderType": "string",
   "ExternalLoginId": "string",
   "Role": "string",
   "UnapplyCustomPermissions": boolean
}

URI リクエストパラメータ

リクエストでは、次の URI パラメータを使用します。

AwsAccountId

のIDAWSユーザーが所属するアカウント。現在、この ID はAWSお使いのアカウントを含むアカウント QuickSight アカウント.

長さの制約: 固定長は 12 です。

パターン: ^[0-9]{12}$

必須 はい

Namespace

名前空間。現在、これdefault。

長さの制約: 最大長は 64 文字です。

パターン: ^[a-zA-Z0-9._-]*$

必須 はい

UserName

ザ・アマゾン QuickSight 更新するユーザー。

長さの制約: 最小長は 1 です｡

パターン: [\u0020-\u00FF]+

必須 はい

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

Email

更新するユーザーの E メールです。

Type: 文字列

必須 はい

Role

ザ・アマゾン QuickSight ユーザーの役割。この役割は、次のいずれかになります。

• READER: ダッシュボードに対する読み取り専用アクセス権を持つユーザーです。

• AUTHOR: データセット、ダッシュボードを作成できるユーザーです。

• ADMIN: 著者であり、Amazonも管理できるユーザー QuickSight[] 設定。

Amazon の名前 QuickSight ロールは、権限を処理するコンソール画面を除いて、ユーザーには表示されません。

Type: 文字列

有効な値: ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER

必須 はい

CustomFederationProviderUrl

ユーザーが Amazon にフェデレートできるようにするための ID を提供するカスタム OpenID Connect (OIDC) プロバイダーの URL QuickSight isAWS Identity and Access Management(必須)。このパラメータは、ExternalLoginFederationProviderTypeパラメータはに設定CUSTOM_OIDC。

Type: 文字列

必須 いいえ

CustomPermissionsName

(Enterprise エディションのみ) このユーザーに割り当てるカスタム権限プロファイルの名前。カスタマイズされた権限を使用すると、次の操作でアクセスを制限することにより、ユーザーのアクセスを制御できます。

• データソースの作成と更新

• データセットの作成と更新

• メールレポートの作成と更新

• E メール

一連のカスタム権限には、これらの制限の任意の組み合わせが含まれます。現在、Amazon を使用してカスタム権限セットのプロファイル名を作成する必要があります QuickSightconsole. 次に、RegisterUser名前付きアクセス権限のセットを Amazon に割り当てる API オペレーション QuickSight ユーザー。

アマゾン QuickSight カスタム許可は、IAM ポリシーによって適用されます。したがって、通常は Amazon を割り当てることによって付与されるアクセス許可を上書きします。 QuickSight Amazonのデフォルトのセキュリティコホートの1つにユーザーを参加させる QuickSight (管理者、著者、読者)。

この機能は、Amazon でのみ使用できます。 QuickSight Enterprise Edit

Type: 文字列

長さの制約: 最小長は 1 です｡ 最大長は 64 文字です。

パターン: ^[a-zA-Z0-9+=,.@_-]+$

必須 いいえ

ExternalLoginFederationProviderType

ユーザーが Amazon にフェデレートできるようにするための ID を提供する、サポートされている外部ログインプロバイダーのタイプ QuickSight isAWS Identity and Access Management(必須)。サポートされている外部ログインプロバイダーのタイプは、次のいずれかになります。

• COGNITO: Amazon Cognito。プロバイダー URL は cognito-identity.amazonaws.com です。を選択するときCOGNITOプロバイダタイプ、」CustomFederationProviderUrl「パラメータ。外部プロバイダがカスタムの場合にのみ必要です。

• CUSTOM_OIDC: OpenID Connect、OIDC 選ぶときCUSTOM_OIDCと入力し、CustomFederationProviderUrlパラメータを指定して、カスタム OIDC プロバイダー URL を指定します。

• NONE: これにより、以前に保存したユーザの外部ログイン情報がすべてクリアされます。を使用する DescribeUser 外部ログイン情報を確認するAPI操作。

Type: 文字列

必須 いいえ

ExternalLoginId

外部ログインプロバイダーのユーザーのアイデンティティ ID。

Type: 文字列

必須 いいえ

UnapplyCustomPermissions

このユーザーからすべてのカスタム権限を削除することを示すために使用するフラグ。このパラメータを使用すると、カスタム権限プロファイルが適用される前の状態にユーザーがリセットされます。このパラメータのデフォルトは NULL で、他の値は受け付けません。

Type: ブール値

必須 いいえ

レスポンスの構文

HTTP/1.1 Status
Content-type: application/json

{
   "RequestId": "string",
   "User": { 
      "Active": boolean,
      "Arn": "string",
      "CustomPermissionsName": "string",
      "Email": "string",
      "ExternalLoginFederationProviderType": "string",
      "ExternalLoginFederationProviderUrl": "string",
      "ExternalLoginId": "string",
      "IdentityType": "string",
      "PrincipalId": "string",
      "Role": "string",
      "UserName": "string"
   }
}

レスポンス要素

アクションが成功すると、以下の HTTP レスポンスが返されます。

Status

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

RequestId

-AWSこの処理のリクエストID。

Type: 文字列

User

ザ・アマゾン QuickSight ユーザー。

型: User オブジェクト

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

AccessDeniedException

このアイテムにはアクセスできません。提供された認証を検証できませんでした。リクエストを実行する権限がない可能性があります。アカウントがAmazonの使用を許可されていることを確認してください QuickSight サービスの利用を許可、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401

InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500

InvalidParameterValueException

1 つ以上のパラメータに無効な値があります。

HTTP ステータスコード: 400

PreconditionNotMetException

1 つ以上の前提条件が満たされていません。​

HTTP ステータスコード: 400

ResourceNotFoundException

1 つ以上のリソースが見つかりません。

HTTP ステータスコード: 404

ResourceUnavailableException

このリソースは現在使用できません。

HTTP ステータスコード: 503

ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS向け JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3