本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
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"
}請求參數
如需所有動作的一般參數資訊，請參閱《Common Parameters》。
請求接受下列JSON格式的資料。
- ExternalId
-
識別目錄中特定群組所需的唯一識別碼。您關聯的群組使用者可透過使用 的已啟用通訊協定存取您的 Amazon S3 或 Amazon EFS 資源 AWS Transfer Family。如果您知道群組名稱，則可以使用 Windows 執行下列命令來檢視SID值 PowerShell。
Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid在該命令中，YourGroupName以 Active Directory 群組的名稱取代 。
用來驗證此參數的規則運算式是由大寫和小寫英數字元組成的字串，不含空格。您也可以包含底線或以下任何字元：=，.@：/-
類型：字串
長度限制：長度下限為 1。長度上限為 256。
模式：
S-1-[\d-]+必要：是
- HomeDirectory
-
使用者使用其用戶端登入伺服器時的登陸目錄 (資料夾)。
HomeDirectory範例為/bucket_name/home/mydirectory。注意
只有在
HomeDirectoryType設為PATH時才會使用HomeDirectory參數。類型：字串
長度限制：長度下限為 0。長度上限為 1024。
模式：
(|/.*)必要：否
- 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參數值。以下是 的
Entry和Target對範例chroot。[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]類型：HomeDirectoryMapEntry 物件陣列
陣列成員：項目數下限為 1。最多 50000 個項目。
必要：否
- HomeDirectoryType
-
使用者登入伺服器時，您希望的使用者主目錄之登陸目錄 (資料夾) 類型。如果您將其設定為
PATH，則使用者會看到絕對 Amazon S3 儲存貯體或 Amazon EFS 路徑，就像在其檔案傳輸通訊協定用戶端一樣。如果您將其設定為LOGICAL，則需要在 中提供映射，HomeDirectoryMappings以了解如何讓使用者看見 Amazon S3 或 Amazon EFS 路徑。注意
如果
HomeDirectoryType是LOGICAL，您必須使用HomeDirectoryMappings參數提供映射。另一方面，如果HomeDirectoryType是PATH，則您使用HomeDirectory參數提供絕對路徑。您無法在範本HomeDirectoryMappings中同時擁有HomeDirectory和 。類型：字串
有效值:
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 儲存為 JSON Blob，而不是政策的 Amazon Resource Name （ARN）。您可以將政策儲存為 BlobJSON，並將其傳遞到
Policy引數中。如需工作階段政策的範例，請參閱 Example session policy (工作階段政策範例)。
如需詳細資訊，請參閱 參考 AssumeRole中的 。 AWS Security Token Service API
類型：字串
長度限制：長度下限為 0。長度上限為 2048。
必要：否
- PosixProfile
-
完整的POSIX身分，包括使用者 ID （
Uid）、群組 ID （Gid） 和任何次要群組 IDs（SecondaryGids），可控制使用者對 Amazon EFS 檔案系統的存取。檔案系統中檔案和目錄上設定的POSIX許可決定了使用者在將檔案移入和移出 Amazon EFS 檔案系統時所取得的存取層級。類型：PosixProfile 物件
必要：否
- Role
-
（ARN） 角色的 Amazon Resource Name AWS Identity and Access Management （IAM），可控制使用者對 Amazon S3 儲存貯體或 Amazon EFS 檔案系統的存取。附加至此角色的政策會決定在將檔案移入和移出 Amazon S3 儲存貯體或 Amazon EFS 檔案系統時，您要為使用者提供的存取層級。此IAM角色也應包含信任關係，允許伺服器在服務使用者的傳輸請求時存取您的資源。
類型：字串
長度限制︰長度下限為 20。長度上限為 2048。
模式：
arn:.*role/\S+必要：是
- ServerId
-
伺服器執行個體的系統指派唯一識別碼。這是您新增使用者的特定目標伺服器。
類型：字串
長度限制條件：固定長度為 19。
模式：
s-([0-9a-f]{17})必要：是
回應語法
{
"ExternalId": "string",
"ServerId": "string"
}回應元素
如果動作成功，服務會傳回 HTTP 200 個回應。
服務會以 JSON 格式傳回下列資料。
- ExternalId
-
群組的外部識別碼，其使用者可透過使用 的已啟用通訊協定存取您的 Amazon S3 或 Amazon EFS 資源 AWS Transfer Family。
類型：字串
長度限制：長度下限為 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
另請參閱
如需在其中一種語言特定的 API中使用此功能的詳細資訊 AWS SDKs，請參閱下列內容：
