Serialized Form (AWS Java SDK for AWS Transfer for SFTP 1.11.558 API)

Package com.amazonaws.services.transfer.model
- Class com.amazonaws.services.transfer.model.AWSTransferException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.transfer.model.CreateServerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - endpointDetails
```
EndpointDetails endpointDetails
```
      The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server.
    - endpointType
```
String endpointType
```
      The type of VPC endpoint that you want your SFTP server connect to. If you connect to a VPC endpoint, your SFTP server isn't accessible over the public internet.
    - hostKey
```
String hostKey
```
      The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key command.
      
      If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive. For more information, see change-host-key in the AWS SFTP User Guide.
    - identityProviderDetails
```
IdentityProviderDetails identityProviderDetails
```
      An array containing all of the information required to call a customer-supplied authentication API. This parameter is not required when the IdentityProviderType value of server that is created uses the SERVICE_MANAGED authentication method.
    - identityProviderType
```
String identityProviderType
```
      The mode of authentication enabled for this service. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the service. An IdentityProviderType value of API_GATEWAY indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.
    - loggingRole
```
String loggingRole
```
      A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
    - tags
```
List<E> tags
```
      Key-value pairs that can be used to group and search for servers.
- Class com.amazonaws.services.transfer.model.CreateServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - serverId
```
String serverId
```
      The service-assigned ID of the SFTP server that is created.
- Class com.amazonaws.services.transfer.model.CreateUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - homeDirectory
```
String homeDirectory
```
      The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is /home/username .
    - policy
```
String policy
```
      A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
    - role
```
String 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 SFTP server to access your resources when servicing your SFTP user's transfer requests.
    - serverId
```
String serverId
```
      A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
    - sshPublicKeyBody
```
String sshPublicKeyBody
```
      The public portion of the Secure Shall (SSH) key used to authenticate the user to the SFTP server.
    - tags
```
List<E> tags
```
      Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
    - userName
```
String userName
```
      A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be 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.
- Class com.amazonaws.services.transfer.model.CreateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - serverId
```
String serverId
```
      The ID of the SFTP server that the user is attached to.
    - userName
```
String userName
```
      A unique string that identifies a user account associated with an SFTP server.
- Class com.amazonaws.services.transfer.model.DeleteServerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - serverId
```
String serverId
```
      A unique system-assigned identifier for an SFTP server instance.
- Class com.amazonaws.services.transfer.model.DeleteServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.transfer.model.DeleteSshPublicKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - serverId
```
String serverId
```
      A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
    - sshPublicKeyId
```
String sshPublicKeyId
```
      A unique identifier used to reference your user's specific SSH key.
    - userName
```
String userName
```
      A unique string that identifies a user whose public key is being deleted.
- Class com.amazonaws.services.transfer.model.DeleteSshPublicKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.transfer.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - serverId
```
String serverId
```
      A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
    - userName
```
String userName
```
      A unique string that identifies a user that is being deleted from the server.
- Class com.amazonaws.services.transfer.model.DeleteUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.transfer.model.DescribedServer extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Specifies the unique Amazon Resource Name (ARN) for the server to be described.
    - endpointDetails
```
EndpointDetails endpointDetails
```
      The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
    - endpointType
```
String endpointType
```
      The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    - hostKeyFingerprint
```
String hostKeyFingerprint
```
      This value contains the Message-Digest Algorithm (MD5) hash of the server's host key. This value is equivalent to the output of ssh-keygen -l -E md5 -f my-new-server-key command.
    - identityProviderDetails
```
IdentityProviderDetails identityProviderDetails
```
      Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
    - identityProviderType
```
String identityProviderType
```
      This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED, means that you are using this Server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
    - loggingRole
```
String loggingRole
```
      This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be view in your CloudWatch logs.
    - serverId
```
String serverId
```
      This property is a unique system assigned identifier for the SFTP server that you instantiate.
    - state
```
String state
```
      The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
      
      The states of STARTING and STOPPING indicated that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
    - tags
```
List<E> tags
```
      This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
    - userCount
```
Integer userCount
```
      The number of users that are assigned to the SFTP server you specified with the ServerId.
- Class com.amazonaws.services.transfer.model.DescribedUser extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
    - homeDirectory
```
String homeDirectory
```
      This property specifies the landing directory (or folder) which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example would be: /bucket_name/home/username .
    - policy
```
String policy
```
      Specifies the name of the policy in use for the described user.
    - role
```
String role
```
      This property specifies 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 SFTP server to access your resources when servicing your SFTP user's transfer requests.
    - sshPublicKeys
```
List<E> sshPublicKeys
```
      This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
    - tags
```
List<E> tags
```
      This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
    - userName
```
String userName
```
      This property is the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your SFTP server.
- Class com.amazonaws.services.transfer.model.DescribeServerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - serverId
```
String serverId
```
      A system-assigned unique identifier for an SFTP server.
- Class com.amazonaws.services.transfer.model.DescribeServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - server
```
DescribedServer server
```
      An array containing the properties of the server with the ServerID you specified.
- Class com.amazonaws.services.transfer.model.DescribeUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - serverId
```
String serverId
```
      A system-assigned unique identifier for an SFTP server that has this user assigned.
    - userName
```
String userName
```
      The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer service and perform file transfer tasks.
- Class com.amazonaws.services.transfer.model.DescribeUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - serverId
```
String serverId
```
      A system-assigned unique identifier for an SFTP server that has this user assigned.
    - user
```
DescribedUser user
```
      An array containing the properties of the user account for the ServerID value that you specified.
- Class com.amazonaws.services.transfer.model.EndpointDetails extends Object implements Serializable
  - Serialized Fields
    - vpcEndpointId
```
String vpcEndpointId
```
      The ID of the VPC endpoint.
- Class com.amazonaws.services.transfer.model.IdentityProviderDetails extends Object implements Serializable
  - Serialized Fields
    - url
```
String url
```
      The IdentityProviderDetail parameter contains the location of the service endpoint used to authenticate users.
    - invocationRole
```
String invocationRole
```
      The Role parameter provides the type of InvocationRole used to authenticate the user account.
- Class com.amazonaws.services.transfer.model.ImportSshPublicKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - serverId
```
String serverId
```
      A system-assigned unique identifier for an SFTP server.
    - sshPublicKeyBody
```
String sshPublicKeyBody
```
      The public key portion of an SSH key pair.
    - userName
```
String userName
```
      The name of the user account that is assigned to one or more servers.
- Class com.amazonaws.services.transfer.model.ImportSshPublicKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - serverId
```
String serverId
```
      A system-assigned unique identifier for an SFTP server.
    - sshPublicKeyId
```
String sshPublicKeyId
```
      This identifier is the name given to a public key by the system that was imported.
    - userName
```
String userName
```
      A user name assigned to the ServerID value that you specified.
- Class com.amazonaws.services.transfer.model.InternalServiceErrorException extends AWSTransferException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.transfer.model.InvalidNextTokenException extends AWSTransferException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.transfer.model.InvalidRequestException extends AWSTransferException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.transfer.model.ListedServer extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The unique Amazon Resource Name (ARN) for the server to be listed.
    - identityProviderType
```
String identityProviderType
```
      The authentication method used to validate a user for the server that was specified. listed. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.
    - endpointType
```
String endpointType
```
      The type of VPC endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    - loggingRole
```
String loggingRole
```
      The AWS Identity and Access Management entity that allows the server to turn on Amazon CloudWatch logging.
    - serverId
```
String serverId
```
      This value is the unique system assigned identifier for the SFTP servers that were listed.
    - state
```
String state
```
      This property describes the condition of the SFTP server for the server that was described. A value of ONLINE> indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
      
      The states of STARTING and STOPPING indicated that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
    - userCount
```
Integer userCount
```
      This property is a numeric value that indicates the number of users that are assigned to the SFTP server you specified with the ServerId.
- Class com.amazonaws.services.transfer.model.ListedUser extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      This property is the unique Amazon Resource Name (ARN) for the user that you wish to learn about.
    - homeDirectory
```
String homeDirectory
```
      This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.
    - role
```
String role
```
      The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that in this case allows the SFTP server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.
    - sshPublicKeyCount
```
Integer sshPublicKeyCount
```
      This value is the number of SSH public keys stored for the user you specified.
    - userName
```
String userName
```
      The name of the user whose ARN was specified. User names are used for authentication purposes.
- Class com.amazonaws.services.transfer.model.ListServersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      Specifies the number of servers to return as a response to the ListServers query.
    - nextToken
```
String nextToken
```
      When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.
- Class com.amazonaws.services.transfer.model.ListServersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers.
    - servers
```
List<E> servers
```
      An array of servers that were listed.
- Class com.amazonaws.services.transfer.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific AWS resource, such as a server, user, or role.
    - maxResults
```
Integer maxResults
```
      Specifies the number of tags to return as a response to the ListTagsForResource request.
    - nextToken
```
String nextToken
```
      When you request additional results from the ListTagsForResource call, a NextToken parameter is returned in the input. You can then pass in a subsequent command the NextToken parameter to continue listing additional tags.
- Class com.amazonaws.services.transfer.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      This value is the ARN you specified to list the tags of.
    - nextToken
```
String nextToken
```
      When you can get additional results from the ListTagsForResource call, a NextToken parameter is returned in the output. You can then pass in a subsequent command the NextToken parameter to continue listing additional tags.
    - tags
```
List<E> tags
```
      Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define that you can use for any purpose.
- Class com.amazonaws.services.transfer.model.ListUsersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      Specifies the number of users to return as a response to the ListUsers request.
    - nextToken
```
String nextToken
```
      When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command the NextToken parameter to continue listing additional users.
    - serverId
```
String serverId
```
      A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server that has users are assigned to it.
- Class com.amazonaws.services.transfer.model.ListUsersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command the NextToken parameter to continue listing additional users.
    - serverId
```
String serverId
```
      A system-assigned unique identifier for an SFTP server that the users are assigned to.
    - users
```
List<E> users
```
      Returns the user accounts and their properties for the ServerId value that you specify.
- Class com.amazonaws.services.transfer.model.ResourceExistsException extends AWSTransferException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resource
```
String resource
```
    - resourceType
```
String resourceType
```
- Class com.amazonaws.services.transfer.model.ResourceNotFoundException extends AWSTransferException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resource
```
String resource
```
    - resourceType
```
String resourceType
```
- Class com.amazonaws.services.transfer.model.ServiceUnavailableException extends AWSTransferException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.transfer.model.SshPublicKey extends Object implements Serializable
  - Serialized Fields
    - dateImported
```
Date dateImported
```
      The date that the public key was added to the user account.
    - sshPublicKeyBody
```
String sshPublicKeyBody
```
      The content of the SSH public key as specified by the PublicKeyId.
    - sshPublicKeyId
```
String sshPublicKeyId
```
      The SshPublicKeyId parameter contains the identifier of the public key.
- Class com.amazonaws.services.transfer.model.StartServerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - serverId
```
String serverId
```
      A system-assigned unique identifier for an SFTP server that you start.
- Class com.amazonaws.services.transfer.model.StartServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.transfer.model.StopServerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - serverId
```
String serverId
```
      A system-assigned unique identifier for an SFTP server that you stopped.
- Class com.amazonaws.services.transfer.model.StopServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.transfer.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The name assigned to the tag that you create.
    - value
```
String value
```
      This property contains one or more values that you assigned to the key name you create.
- Class com.amazonaws.services.transfer.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      An Amazon Resource Name (ARN) for a specific AWS resource, such as a server, user, or role.
    - tags
```
List<E> tags
```
      Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to user accounts for any purpose.
- Class com.amazonaws.services.transfer.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.transfer.model.TestIdentityProviderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - serverId
```
String serverId
```
      A system assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.
    - userName
```
String userName
```
      This request parameter is name of the user account to be tested.
    - userPassword
```
String userPassword
```
      The password of the user account to be tested.
- Class com.amazonaws.services.transfer.model.TestIdentityProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - message
```
String message
```
      The result of the authorization test as a message.
    - statusCode
```
Integer statusCode
```
      The HTTP status code that is the response from your API Gateway.
    - url
```
String url
```
      The endpoint of the service used to authenticate a user.
- Class com.amazonaws.services.transfer.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      This is the value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role.
    - tagKeys
```
List<E> tagKeys
```
      TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose.
- Class com.amazonaws.services.transfer.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.transfer.model.UpdateServerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - endpointDetails
```
EndpointDetails endpointDetails
```
      The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, your SFTP server isn't accessible over the public internet.
    - endpointType
```
String endpointType
```
      The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet.
    - hostKey
```
String hostKey
```
      The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key.
      
      If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive. For more information, see change-host-key in the AWS SFTP User Guide.
    - identityProviderDetails
```
IdentityProviderDetails identityProviderDetails
```
      This response parameter is an array containing all of the information required to call a customer's authentication API method.
    - loggingRole
```
String loggingRole
```
      A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.
    - serverId
```
String serverId
```
      A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.
- Class com.amazonaws.services.transfer.model.UpdateServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - serverId
```
String serverId
```
      A system-assigned unique identifier for an SFTP server that the user account is assigned to.
- Class com.amazonaws.services.transfer.model.UpdateUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - homeDirectory
```
String 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 .
    - policy
```
String 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}.
    - role
```
String 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.
    - serverId
```
String serverId
```
      A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.
    - userName
```
String 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.
- Class com.amazonaws.services.transfer.model.UpdateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - serverId
```
String serverId
```
      A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.
    - userName
```
String userName
```
      The unique identifier for a user that is assigned to the SFTP server instance that was specified in the request.

Serialized Form

Package com.amazonaws.services.transfer.model

Class com.amazonaws.services.transfer.model.AWSTransferException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.transfer.model.CreateServerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endpointDetails

endpointType

hostKey

identityProviderDetails

identityProviderType

loggingRole

tags

Class com.amazonaws.services.transfer.model.CreateServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

serverId

Class com.amazonaws.services.transfer.model.CreateUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

homeDirectory

policy

role

serverId

sshPublicKeyBody

tags

userName

Class com.amazonaws.services.transfer.model.CreateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

serverId

userName

Class com.amazonaws.services.transfer.model.DeleteServerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverId

Class com.amazonaws.services.transfer.model.DeleteServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.transfer.model.DeleteSshPublicKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverId

sshPublicKeyId

userName

Class com.amazonaws.services.transfer.model.DeleteSshPublicKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.transfer.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverId

userName

Class com.amazonaws.services.transfer.model.DeleteUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.transfer.model.DescribedServer extends Object implements Serializable

Serialized Fields

arn

endpointDetails

endpointType

hostKeyFingerprint

identityProviderDetails

identityProviderType

loggingRole

serverId

state

tags

userCount

Class com.amazonaws.services.transfer.model.DescribedUser extends Object implements Serializable

Serialized Fields

arn

homeDirectory

policy

role

sshPublicKeys

tags

userName

Class com.amazonaws.services.transfer.model.DescribeServerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverId

Class com.amazonaws.services.transfer.model.DescribeServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

server

Class com.amazonaws.services.transfer.model.DescribeUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverId

userName

Class com.amazonaws.services.transfer.model.DescribeUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

serverId

user

Class com.amazonaws.services.transfer.model.EndpointDetails extends Object implements Serializable