# UpdateAccess Allows you to update parameters for the access specified in the `ServerID` and `ExternalID` parameters. ## Request Syntax ``` { "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" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ExternalId](#API_UpdateAccess_RequestSyntax) ** A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell. `Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid` In that command, replace *YourGroupName* with the name of your Active Directory group. The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `S-1-[\d-]+` Required: Yes ** [HomeDirectory](#API_UpdateAccess_RequestSyntax) ** The landing directory (folder) for a user when they log in to the server using the client. A `HomeDirectory` example is `/bucket_name/home/mydirectory`. You can use the `HomeDirectory` parameter for `HomeDirectoryType` when it is set to either `PATH` or `LOGICAL`. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `(|/.*)` Required: No ** [HomeDirectoryMappings](#API_UpdateAccess_RequestSyntax) ** Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the `Entry` and `Target` pair, where `Entry` shows how the path is made visible and `Target` is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your AWS Identity and Access Management (IAM) role provides access to paths in `Target`. This value can be set only when `HomeDirectoryType` is set to *LOGICAL*. The following is an `Entry` and `Target` pair example. `[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]` In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("`chroot`"). To do this, you can set `Entry` to `/` and set `Target` to the `HomeDirectory` parameter value. The following is an `Entry` and `Target` pair example for `chroot`. `[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]` Type: Array of [HomeDirectoryMapEntry](API_HomeDirectoryMapEntry.md) objects Array Members: Minimum number of 1 item. Maximum number of 50000 items. Required: No ** [HomeDirectoryType](#API_UpdateAccess_RequestSyntax) ** The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to `PATH`, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings` for how you want to make Amazon S3 or Amazon EFS paths visible to your users. If `HomeDirectoryType` is `LOGICAL`, you must provide mappings, using the `HomeDirectoryMappings` parameter. If, on the other hand, `HomeDirectoryType` is `PATH`, you provide an absolute path using the `HomeDirectory` parameter. You cannot have both `HomeDirectory` and `HomeDirectoryMappings` in your template. Type: String Valid Values: `PATH | LOGICAL` Required: No ** [Policy](#API_UpdateAccess_RequestSyntax) ** A session policy for your user so that you can use the same AWS Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and `${Transfer:HomeBucket}`. This policy applies only when the domain of `ServerId` is Amazon S3. Amazon EFS does not use session policies. For session policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the `Policy` argument. For an example of a session policy, see [Example session policy](https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html). For more information, see [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) in the * AWSSecurity Token Service API Reference*. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No ** [PosixProfile](#API_UpdateAccess_RequestSyntax) ** The full POSIX identity, including user ID (`Uid`), group ID (`Gid`), and any secondary groups IDs (`SecondaryGids`), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems. Type: [PosixProfile](API_PosixProfile.md) object Required: No ** [Role](#API_UpdateAccess_RequestSyntax) ** The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:.*role/\S+` Required: No ** [ServerId](#API_UpdateAccess_RequestSyntax) ** A system-assigned unique identifier for a server instance. This is the specific server that you added your user to. Type: String Length Constraints: Fixed length of 19. Pattern: `s-([0-9a-f]{17})` Required: Yes ## Response Syntax ``` { "ExternalId": "string", "ServerId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ExternalId](#API_UpdateAccess_ResponseSyntax) ** The external identifier of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWSTransfer Family. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `S-1-[\d-]+` ** [ServerId](#API_UpdateAccess_ResponseSyntax) ** The identifier of the server that the user is attached to. Type: String Length Constraints: Fixed length of 19. Pattern: `s-([0-9a-f]{17})` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServiceError ** This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 ** InvalidRequestException ** This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ** ResourceExistsException ** The requested resource does not exist, or exists in a region other than the one specified for the command. HTTP Status Code: 400 ** ResourceNotFoundException ** This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ** ServiceUnavailableException ** The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/transfer-2018-11-05/UpdateAccess) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/transfer-2018-11-05/UpdateAccess) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/UpdateAccess) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/transfer-2018-11-05/UpdateAccess) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/UpdateAccess) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/transfer-2018-11-05/UpdateAccess) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/transfer-2018-11-05/UpdateAccess) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/transfer-2018-11-05/UpdateAccess) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/transfer-2018-11-05/UpdateAccess) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/UpdateAccess)