翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
UpdateUser
新しいプロパティをユーザーに割り当てます。渡されたパラメータは、指定する UserName および ServerId のホームディレクトリ、ロール、およびポリシーのいずれかまたはすべてを変更します。
レスポンスは更新されたユーザーの ServerId と UserName を返します。
コンソールで、ユーザーを作成または更新するときに制限付きを選択できます。これにより、ユーザーはホームディレクトリ以外のものにアクセスできなくなります。この動作を設定するプログラムによる方法は、ユーザーを更新することです。を HomeDirectoryTypeに設定しLOGICAL、 HomeDirectoryMappings をルート (/) Entry として、 をホームディレクトリTargetとして指定します。
例えば、ユーザーのホームディレクトリが の場合/test/admin-user、次のコマンドはユーザーを更新して、コンソールの設定に選択した制限付きフラグが表示されるようにします。
aws transfer update-user --server-id <server-id> --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings "[{\"Entry\":\"/\", \"Target\":\"/test/admin-user\"}]"
リクエストの構文
{
"HomeDirectory": "string",
"HomeDirectoryMappings": [
{
"Entry": "string",
"Target": "string",
"Type": "string"
}
],
"HomeDirectoryType": "string",
"Policy": "string",
"PosixProfile": {
"Gid": number,
"SecondaryGids": [ number ],
"Uid": number
},
"Role": "string",
"ServerId": "string",
"UserName": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは、次のJSON形式のデータを受け入れます。
- HomeDirectory
-
ユーザーがクライアントを使用してサーバーにログインするときの、ユーザーのランディングディレクトリ (フォルダ)。
HomeDirectoryの例は/bucket_name/home/mydirectoryです。注記
HomeDirectoryパラメータは、HomeDirectoryTypeがPATHに設定されている場合のみ使用されます。型: 文字列
長さの制限: 最小長は 0 です。最大長は 1,024 です。
パターン:
(|/.*)必須: いいえ
- HomeDirectoryMappings
-
Amazon S3 または Amazon EFSパスとキーをユーザーに表示する方法と表示方法を指定する論理ディレクトリマッピング。
EntryとTargetペアを指定する必要があります。 はパスの表示方法Entryを示し、Targetは実際の Amazon S3 または Amazon EFSパスです。ターゲットを指定しただけの場合は、そのまま表示されます。また、 AWS Identity and Access Management （IAM) ロールが のパスへのアクセスを提供するようにする必要がありますTarget。この値は、HomeDirectoryTypeが に設定されている場合にのみ設定できますLOGICAL。以下は
EntryとTargetのペアの例です。[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]ほとんどの場合、セッションポリシーの代わりにこの値を使用することで、指定されたホームディレクトリ (
chroot) にユーザーをロックダウンできます。これを行うには、Entryを '/' に設定し、Targetパラメータ HomeDirectory値に設定できます。以下は、
chrootについてのEntryとTargetのペアの例です。[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]型: HomeDirectoryMapEntry オブジェクトの配列
配列メンバー：最小数は 1 項目です。最大数は 50,000 項目です。
必須：いいえ
- HomeDirectoryType
-
ユーザーがサーバーにログインするときにホームディレクトリにするランディングディレクトリ (フォルダ) のタイプ。に設定すると
PATH、ファイル転送プロトコルクライアントに、絶対 Amazon S3 バケットまたは Amazon EFSパスがそのまま表示されます。に設定する場合はLOGICAL、Amazon S3 または Amazon EFSパスをユーザーに表示させる方法HomeDirectoryMappingsのマッピングを に提供する必要があります。注記
HomeDirectoryTypeがLOGICALの場合は、HomeDirectoryMappingsパラメータを使用してマッピングを指定する必要があります。一方、HomeDirectoryTypeがPATHの場合は、HomeDirectoryパラメータを使用して絶対パスを指定します。テンプレートにHomeDirectoryとHomeDirectoryMappingsの両方を含めることはできません。型: 文字列
有効な値:
PATH | LOGICAL必須：いいえ
- Policy
-
複数のユーザーで同じ AWS Identity and Access Management （IAM) ロールを使用できるように、ユーザーのセッションポリシー。このポリシーは、ユーザーアクセスのスコープを Amazon S3 バケットの一部に絞り込みます。このポリシー内に使用できる変数には、
${Transfer:UserName}、${Transfer:HomeDirectory}、${Transfer:HomeBucket}があります。注記
このポリシーは、
ServerIdドメインが Amazon S3 の場合にのみ適用されます。Amazon EFSはセッションポリシーを使用しません。セッションポリシーの場合、 はポリシーの Amazon リソースネーム (ARN) ではなく、ポリシーを BLOB JSON として AWS Transfer Family 保存します。ポリシーを BLOB JSON として保存し、引
Policy数に渡します。セッションポリシーの例については、「セッションポリシーの例」を参照してください。
詳細については、 AWS 「 セキュリティトークンサービスAPIリファレンスAssumeRole」の「」を参照してください。
型: 文字列
長さの制限: 最小長は 0 です。最大長は 2048 です。
必須：いいえ
- PosixProfile
-
ユーザー ID (
Uid）、グループ ID (Gid）、Amazon Elastic File Systems IDs (Amazon ) へのユーザーのアクセスを制御するセカンダリグループ (SecondaryGids) など、完全な POSIX ID を指定しますEFS。ファイルシステム内のファイルとディレクトリに設定されたPOSIXアクセス許可により、Amazon EFS ファイルシステムとの間でファイルを転送する際にユーザーが得るアクセスレベルが決まります。型: PosixProfile オブジェクト
必須：いいえ
- Role
-
Amazon S3 バケットまたは Amazon EFS ファイルシステムへのユーザーのアクセスを制御する () ロールARNの Amazon リソースネーム AWS Identity and Access Management （IAM）。このロールにアタッチされたポリシーは、Amazon S3 バケットまたは Amazon EFS ファイルシステムとの間でファイルを転送する際にユーザーに提供するアクセスレベルを決定します。IAM ロールには、ユーザーの転送リクエストを処理するときにサーバーがリソースにアクセスできるようにする信頼関係も含める必要があります。
型: 文字列
長さの制限: 最小長は 20 です。最大長は 2,048 です。
パターン:
arn:.*role/\S+必須: いいえ
- ServerId
-
ユーザーが割り当てられている Transfer Family サーバーインスタンスの、システムから割り当てられた一意の識別子。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
s-([0-9a-f]{17})必須：はい
- UserName
-
ユーザーを識別する一意の文字列で、
ServerIdによる指定に従いサーバーに関連付けられています。このユーザー名は、最小 3 文字、最大 100 文字にする必要があります。有効な文字は a～z、A～Z、0～9、アンダースコア (_)、ハイフン (-)、ピリオド (。)、アットマーク (@) です。ユーザー名をハイフン、ピリオド、アットマークで始めることはできません。型: 文字列
長さの制限: 最小長は 3 です。最大長は 100 です。
Pattern:
[\w][\w@.-]{2,99}必須：はい
レスポンスの構文
{
"ServerId": "string",
"UserName": "string"
}レスポンス要素
アクションが成功すると、サービスは 200 HTTP レスポンスを送り返します。
次のデータは、 サービスによって JSON 形式で返されます。
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalServiceError
-
この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
- ResourceNotFoundException
-
この例外は、 AWS Transfer Family サービスによってリソースが見つからない場合にスローされます。
HTTP ステータスコード: 400
- ServiceUnavailableException
-
AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。
HTTP ステータスコード: 500
- ThrottlingException
-
リクエストのスロットリングにより、リクエストが拒否されました。
HTTP ステータスコード: 400
例
例
次の例では、Transfer Family ユーザーを更新します。
リクエスト例
{
"HomeDirectory": "/bucket2/documentation",
"HomeDirectoryMappings": [
{
"Entry": "/directory1",
"Target": "/bucket_name/home/mydirectory"
}
],
"HomeDirectoryType:" "PATH",
"Role": "AssumeRole",
"ServerId": "s-01234567890abcdef",
"UserName": "my_user"
}例
これは、このAPI呼び出しのサンプルレスポンスです。
レスポンス例
{
"ServerId": "s-01234567890abcdef",
"UserName": "my_user"
}以下の資料も参照してください。
言語固有の のいずれかAPIでこれを使用する方法の詳細については AWS SDKs、以下を参照してください。
