翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ListUsers
ServerId パラメータを渡すことで指定したファイル転送プロトコル対応サーバーのユーザーを一覧表示します。
リクエストの構文
{
"MaxResults": number,
"NextToken": "string",
"ServerId": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは、次のJSON形式のデータを受け入れます。
- MaxResults
-
ListUsersクエリへのレスポンスとして返すユーザーの数を指定します。型: 整数
有効範囲: 最小値 は 1 です。最大値は 1000 です。
必須：いいえ
- NextToken
-
ListUsersコールからさらに結果を得られる場合、出力でNextTokenパラメータが返されます。以降のListUsersコマンドでNextTokenを渡すことで、追加のユーザーを引き続き一覧表示できます。型: 文字列
長さの制限：最小長は 1 です。最大長は 6,144 です。
必須：いいえ
- ServerId
-
ユーザーが割り当てられたサーバーにシステムで割り当てられた一意の識別子。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
s-([0-9a-f]{17})必須：はい
レスポンスの構文
{
"NextToken": "string",
"ServerId": "string",
"Users": [
{
"Arn": "string",
"HomeDirectory": "string",
"HomeDirectoryType": "string",
"Role": "string",
"SshPublicKeyCount": number,
"UserName": "string"
}
]
}レスポンス要素
アクションが成功すると、サービスは 200 HTTP レスポンスを送り返します。
次のデータは、 サービスによって JSON 形式で返されます。
- NextToken
-
ListUsersからさらに結果を得られる場合、出力でNextTokenパラメータが返されます。以降のコマンドでNextTokenパラメータを渡すことで、追加のユーザーを引き続き一覧表示できます。型: 文字列
長さの制限：最小長は 1 です。最大長は 6,144 です。
- ServerId
-
ユーザーの割り当て先サーバーにシステムで割り当てられた一意の識別子。
型: 文字列
長さの制限: 固定長は 19 です。
パターン:
s-([0-9a-f]{17}) - Users
-
指定する
ServerId値 について Transfer Family ユーザーとそのプロパティを返します。型: ListedUser オブジェクトの配列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalServiceError
-
この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
- InvalidNextTokenException
-
渡された
NextTokenパラメータが無効です。HTTP ステータスコード: 400
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
- ResourceNotFoundException
-
この例外は、 AWS Transfer Family サービスによってリソースが見つからない場合にスローされます。
HTTP ステータスコード: 400
- ServiceUnavailableException
-
AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。
HTTP ステータスコード: 500
例
例
ListUsers API 呼び出しは、指定したサーバーに関連付けられたユーザーのリストを返します。
リクエスト例
{
"MaxResults": 100,
"NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==",
"ServerId": "s-01234567890abcdef"
}
例
これは、このAPI呼び出しのサンプルレスポンスです。
レスポンス例
{
"NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==",
"ServerId": "s-01234567890abcdef",
"Users": [
{
"Arn": "arn:aws:transfer:us-east-1:176354371281:user/s-01234567890abcdef/charlie",
"HomeDirectory": "/tests/home/charlie",
"SshPublicKeyCount": 1,
"Role": "arn:aws:iam::176354371281:role/transfer-role1",
"Tags": [
{
"Key": "Name",
"Value": "user1"
}
],
"UserName": "my_user"
}
]
}以下の資料も参照してください。
言語固有の のいずれかAPIでこれを使用する方法の詳細については AWS SDKs、以下を参照してください。
