ListUsers - Amazon QuickSight
リクエストの構文URI リクエストパラメータリクエスト本文レスポンスの構文レスポンス要素エラー以下の資料も参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ListUsers

すべてのAmazonのリストを返します。 QuickSight このアカウントに属するユーザー。

リクエストの構文

GET /accounts/AwsAccountId/namespaces/Namespace/users?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI リクエストパラメータ

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

AwsAccountId

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

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

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

必須: はい

MaxResults

このリクエストから返す結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。

Namespace

名前空間。現在、これを設定する必要がありますdefault。

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

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

必須: はい

NextToken

後続のリクエストで使用できるページ分割トークン。

リクエスト本文

リクエストにリクエスト本文がありません。

レスポンスの構文

HTTP/1.1 Status
Content-type: application/json

{
   "NextToken": "string",
   "RequestId": "string",
   "UserList": [ 
      { 
         "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 形式で返されます。

NextToken

後続のリクエストで使用できるページ分割トークン。

Type: 文字列

RequestId

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

Type: 文字列

UserList

ユーザーのリスト。

Type: 配列:Userオブジェクト

エラー

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

AccessDeniedException

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

HTTP ステータスステータスステータスステータスステータス: 401

InternalFailureException

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

HTTP ステータスステータスステータスステータスステータス: 500

InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスステータスステータスステータスステータス: 400

InvalidParameterValueException

1 つ以上のパラメータに有効ではありません。

HTTP ステータスステータスステータスステータスステータス: 400

PreconditionNotMetException

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

HTTP ステータスステータスステータスステータスステータス: 400

ResourceNotFoundException

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

HTTP ステータスステータスステータスステータスステータス: 404

ResourceUnavailableException

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

HTTP ステータスステータスステータスステータスステータス: 503

ThrottlingException

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

HTTP ステータスステータスステータスステータスステータス: 429

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

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