本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
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"
}請求參數
如需所有動作的一般參數資訊，請參閱《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用活動目錄組的名稱替換。
用來驗證此參數的規則運算式是由不含空格的大寫和小寫英數字元組成的字元字串。您也可以包含底線或下列任何字元：=, 。 @：/-
類型：字串
長度限制：長度下限為 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，才能設定此值。以下是
Entry和配Target對範例。[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]在大多數情況下，您可以使用此值而非工作階段原則，將使用者鎖定到指定的主目錄 (」
chroot「)。若要執行此操作，您可以設Entry定為/並Target將其設定為HomeDirectory參數值。以下是的
Entry和Target配對範例chroot。[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]類型：HomeDirectoryMapEntry 物件陣列
陣列成員：項目數下限為 1。5 萬個物品的最大數量。
必要：否
- HomeDirectoryType
-
使用者登入伺服器時，您希望的使用者主目錄之登陸目錄 (資料夾) 類型。如果將其設定為
PATH，使用者將在其檔案傳輸協定用戶端中看到絕對的 Amazon S3 儲存貯體或 Amazon EFS 路徑。如果將其設定為LOGICAL，則需要在中提供對應，以便讓使用者看到 Amazon S3 或 Amazon EFS 路徑的方式。HomeDirectoryMappings注意
如果
HomeDirectoryType是LOGICAL，則必須使用HomeDirectoryMappings參數提供對映。另一方面，HomeDirectoryType如果您使用HomeDirectory參數提供絕對路徑。PATH您的範本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 資源名稱 (ARN)。您會將政策作為 JSON blob 儲存，並在
Policy引數中傳遞它。如需工作階段政策的範例，請參閱 Example session policy (工作階段政策範例)。
如需詳細資訊，請參閱 AWS安全性權杖服務 API 參考AssumeRole中的。
類型：字串
長度限制：長度下限為 0。長度上限為 2048。
必要：否
- PosixProfile
-
控制使用者存取 Amazon EFS 檔案系統的完整 POSIX 身分，包括使用者 ID (
Uid)、群組 ID (Gid) 和任何次要群組 ID (SecondaryGids)。對檔案系統中的檔案和目錄設定的 POSIX 許可，會決定使用者在 Amazon EFS 檔案系統中傳入和傳出檔案時所取得的存取等級。類型：PosixProfile 物件
必要：否
- Role
-
(IAM) 角色的亞馬遜資源名稱 AWS Identity and Access Management (ARN)，用於控制使用者對 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
-
群組的外部識別碼，其使用者可以使用 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 的詳細資訊，請參閱下列內容：
