AWS Transfer for SFTP
User Guide

UpdateUser

Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.

The response returns the ServerId and the UserName for the updated user.

Request Syntax

{ "HomeDirectory": "string", "Policy": "string", "Role": "string", "ServerId": "string", "UserName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

HomeDirectory

The HomeDirectory parameter specifies the landing directory (folder) for a user when they log in to the server using their client. An example would be: /home/username .

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^$|/.*

Required: No

Policy

Allows you to supply a scope-down policy for your user so you can use the same AWS Identity and Access Management (IAM) role across multiple users. The policy scopes down users access to portions of your Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

Type: String

Required: No

Role

The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the Secure File Transfer Protocol (SFTP) server to access your resources when servicing your SFTP user's transfer requests.

Type: String

Pattern: arn:.*role/.*

Required: No

ServerId

A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

Type: String

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

Required: Yes

UserName

A unique string that identifies a user and is associated with a server as specified by the ServerId. This is the string that will be used by your user when they log in to your SFTP server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

Type: String

Pattern: ^[a-z0-9]{3,32}$

Required: Yes

Response Syntax

{ "ServerId": "string", "UserName": "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.

ServerId

A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

Type: String

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

UserName

The unique identifier for a user that is assigned to the SFTP server instance that was specified in the request.

Type: String

Pattern: ^[a-z0-9]{3,32}$

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceError

This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

HTTP Status Code: 500

InvalidRequestException

This exception is thrown when the client submits a malformed request.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed because the AWS Transfer for SFTP service is not available.

HTTP Status Code: 500

Examples

Example

The following example updates a user account.

Sample Request

{ "HomeDirectory": "/home/thechuckster", "Role": "AssumeRole", "ServerId": "s-01234567890abcdef", "UserName": "charlie" }

Example

Sample Response

{ "ServerId": "s-01234567890abcdef" "UserName": "charlie" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: