CreateAccess - AWS Transfer Family
リクエストの構文リクエストパラメータレスポンスの構文レスポンス要素エラー以下の資料も参照してください。

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

CreateAccess

管理者が、 ディレクトリ内のどのグループが を使用して有効なプロトコル経由でファイルをアップロードおよびダウンロードするアクセス権限を持つかを選択するために使用します AWS Transfer Family。たとえば、Microsoft Active Directory に 50,000 ユーザーが含まれる可能性があってもサーバーにファイルを転送する能力を必要とするのはそのうちのごく一部のみです。管理者は CreateAccess を使用することで、この機能を必要とする適切なユーザーのセットにアクセス権を限定することができます。

リクエストの構文

{
   "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

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

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

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

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

型: 文字列

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

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

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

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

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

型: 文字列

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

必須：いいえ

PosixProfile

ユーザー ID (Uid）、グループ ID (Gid）、および Amazon EFS ファイルシステムへのユーザーのアクセスを制御するセカンダリグループ IDs (SecondaryGids) を含む完全な POSIX ID。ファイルシステム内のファイルとディレクトリに設定された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 です。

Pattern: arn:.*role/\S+

必須：はい

ServerId

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

型: 文字列

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

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

必須：はい

レスポンスの構文

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

レスポンス要素

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

次のデータは、 サービスによって JSON 形式で返されます。

ExternalId

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

型: 文字列

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

Pattern: 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

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

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