リクエストの構文リクエストパラメータレスポンスの構文レスポンス要素エラーその他の参照資料

UpdateAccess

ServerID および ExternalID パラメータで指定されたアクセス権についてパラメータを更新できます。

リクエストの構文


{
   "ExternalId": "string",
   "HomeDirectory": "string",
   "HomeDirectoryMappings": [ 
      { 
         "Entry": "string",
         "Target": "string",
         "Type": "string"
      }
   ],
   "HomeDirectoryType": "string",
   "Policy": "string",
   "PosixProfile": { 
      "Gid": number,
      "SecondaryGids": [ number ],
      "Uid": number
   },
   "Role": "string",
   "ServerId": "string"
}

リクエストパラメータ

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

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

ExternalId

ディレクトリ内の特定のグループを識別するために必要な一意の識別子。関連付けするグループのユーザーは、AWS Transfer Family を使用して、有効なプロトコル経由で Amazon S3 または Amazon EFS リソースにアクセスできます。グループ名がわかっている場合は、Windows を使用して次のコマンドを実行することで SID 値を表示できます PowerShell。

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

そのコマンドで、を Active Directory グループの名前YourGroupNameに置き換えます。

このパラメータの検証に使用される正規表現は、スペースを含まない大文字と小文字の英数字からなる文字列です。下線文字 (_) や =,.@:/- の文字を含めることもできます。

型: 文字列

長さの制限：最小長は 1 です。最大長は 256 です。

パターン：S-1-[\d-]+

必須：はい

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 はセッション・ポリシーを使用しません。

セッションポリシーの場合、AWS Transfer Family は、ポリシーの Amazon リソースネーム (ARN) ではなく、JSON blob としてポリシーを保存します。JSON blob としてポリシーを保存し、Policy 因数に渡します。

セッションポリシーの例については、「セッションポリシーの例」を参照してください。

詳細については、AWS「 Security Token Service API リファレンスAssumeRole」の「」を参照してください。

型: 文字列

長さの制限: 最小長は 0 です。最大長は 2048 です。

必須: いいえ

PosixProfile

ユーザーの Amazon EFS ファイルシステムへのアクセスを制御する、ユーザー ID (Uid Gid)、グループ ID (SecondaryGids)、およびセカンダリグループ ID () を含む完全な POSIX ID。ファイルシステム内のファイルとディレクトリに設定される POSIX アクセス許可によって、Amazon EFS ファイルシステムとの間でファイルを転送するときにユーザーが得るアクセスのレベルが決まります。

型: PosixProfile オブジェクト

必須: いいえ

Role

Amazon S3 バケットまたは Amazon EFS ファイルシステムへのユーザーのアクセスを制御する AWS Identity and Access Management IAM ロールの Amazon リソースネーム (ARN) を指定します。このロールにアタッチされたポリシーにより、ファイルを Amazon S3 バケットまたは Amazon EFS ファイルシステム間で転送する際の、ユーザーに付与するアクセスレベルが決定されます。IAM ロールには、ユーザーの転送リクエストを処理する際に、サーバーによるリソースへのアクセスを許可する信頼関係も含まれる必要があります。

型: 文字列

長さの制限: 最小長は 20 です。最大長は 2,048 です。

パターン: arn:.*role/\S+

必須: いいえ

ServerId

サーバーインスタンスにシステムで割り当てられた一意の識別子。これはユーザーを追加したサーバーに固有です。

型: 文字列

長さの制限: 固定長は 19 です。

Pattern: s-([0-9a-f]{17})

必須：はい

レスポンスの構文


{
   "ExternalId": "string",
   "ServerId": "string"
}

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

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

ExternalId

AWS Transfer Familyを使用して、有効なプロトコル上で Amazon S3 または Amazon EFS リソースにアクセスできるユーザーを持つグループの外部識別子。

型: 文字列

長さの制限：最小長は 1 です。最大長は 256 です。

パターン：S-1-[\d-]+

ServerId

ユーザーが接続しているサーバーの識別子。

型: 文字列

長さの制限: 固定長は 19 です。

パターン：s-([0-9a-f]{17})

エラー

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

InternalServiceError

この例外は、AWS Transfer Family サービスでエラーが発生した場合にスローされます。

HTTP ステータスコード：500

InvalidRequestException

この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。

HTTP ステータスコード：400

ResourceExistsException

要求されたリソースは存在しないか、コマンドに指定されたリージョン以外のリージョンに存在します。

HTTP ステータスコード：400

ResourceNotFoundException

この例外は、AWS Transfer Family サービスでリソースが見つからない場合にスローされます。

HTTP ステータスコード：400

ServiceUnavailableException

AWS Transfer Family サービスを利用できないためリクエストは失敗しました。

HTTP ステータスコード：500

ThrottlingException

リクエストのスロットリングにより、リクエストが拒否されました。

HTTP ステータスコード：400

その他の参照資料

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

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

UntagResource

UpdateAgreement