AWSTransferClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.transfer.AWSTransferClient

All Implemented Interfaces:

AWSTransfer

Direct Known Subclasses:

AWSTransferAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSTransferClient
extends AmazonWebServiceClient
implements AWSTransfer
```
Client for accessing AWS Transfer. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Transfer for SFTP is a fully managed service that enables the transfer of files directly into and out of Amazon S3 using the Secure File Transfer Protocol (SFTP)—also known as Secure Shell (SSH) File Transfer Protocol. AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer for SFTP—by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53—so nothing changes for your customers and partners, or their applications. With your data in S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer for SFTP (AWS SFTP) is easy; there is no infrastructure to buy and setup.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.transfer.AWSTransfer
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AWSTransferClientBuilder`	`builder()`
`CreateServerResult`	`createServer(CreateServerRequest request)` Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS.
`CreateUserResult`	`createUser(CreateUserRequest request)` Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server.
`DeleteServerResult`	`deleteServer(DeleteServerRequest request)` Deletes the Secure File Transfer Protocol (SFTP) server that you specify.
`DeleteSshPublicKeyResult`	`deleteSshPublicKey(DeleteSshPublicKeyRequest request)` Deletes a user's Secure Shell (SSH) public key.
`DeleteUserResult`	`deleteUser(DeleteUserRequest request)` Deletes the user belonging to the server you specify.
`DescribeServerResult`	`describeServer(DescribeServerRequest request)` Describes the server that you specify by passing the `ServerId` parameter.
`DescribeUserResult`	`describeUser(DescribeUserRequest request)` Describes the user assigned to a specific server, as identified by its `ServerId` property.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`ImportSshPublicKeyResult`	`importSshPublicKey(ImportSshPublicKeyRequest request)` Adds a Secure Shell (SSH) public key to a user account identified by a `UserName` value assigned to a specific server, identified by `ServerId`.
`ListServersResult`	`listServers(ListServersRequest request)` Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists all of the tags associated with the Amazon Resource Number (ARN) you specify.
`ListUsersResult`	`listUsers(ListUsersRequest request)` Lists the users for the server that you specify by passing the `ServerId` parameter.
`StartServerResult`	`startServer(StartServerRequest request)` Changes the state of a Secure File Transfer Protocol (SFTP) server from `OFFLINE` to `ONLINE`.
`StopServerResult`	`stopServer(StopServerRequest request)` Changes the state of an SFTP server from `ONLINE` to `OFFLINE`.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
`TestIdentityProviderResult`	`testIdentityProvider(TestIdentityProviderRequest request)` If the `IdentityProviderType` of the server is `API_Gateway`, tests whether your API Gateway is set up successfully.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
`UpdateServerResult`	`updateServer(UpdateServerRequest request)` Updates the server properties after that server has been created.
`UpdateUserResult`	`updateUser(UpdateUserRequest request)` Assigns new properties to a user.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.transfer.AWSTransfer
shutdown

- Method Detail
  - builder
```
public static AWSTransferClientBuilder builder()
```
  - createServer
```
public CreateServerResult createServer(CreateServerRequest request)
```
    Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. The call returns the ServerId property assigned by the service to the newly created server. Reference this ServerId property when you make updates to your server, or work with users.
    
    The response returns the ServerId value for the newly created server.
    
    Specified by:
    
    createServer in interface AWSTransfer
    
    Parameters:
    
    createServerRequest -
    
    Returns:
    
    Result of the CreateServer operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    ResourceExistsException - The requested resource does not exist.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
public CreateUserResult createUser(CreateUserRequest request)
```
    Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.
    
    The response returns the UserName and ServerId values of the new user for that server.
    
    Specified by:
    
    createUser in interface AWSTransfer
    
    Parameters:
    
    createUserRequest -
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    ResourceExistsException - The requested resource does not exist.
    
    ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
    
    See Also:
    
    AWS API Documentation
  - deleteServer
```
public DeleteServerResult deleteServer(DeleteServerRequest request)
```
    Deletes the Secure File Transfer Protocol (SFTP) server that you specify. If you used SERVICE_MANAGED as your IdentityProviderType, you need to delete all users associated with this server before deleting the server itself
    
    No response returns from this call.
    
    Specified by:
    
    deleteServer in interface AWSTransfer
    
    Parameters:
    
    deleteServerRequest -
    
    Returns:
    
    Result of the DeleteServer operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
    
    See Also:
    
    AWS API Documentation
  - deleteSshPublicKey
```
public DeleteSshPublicKeyResult deleteSshPublicKey(DeleteSshPublicKeyRequest request)
```
    Deletes a user's Secure Shell (SSH) public key.
    
    No response is returned from this call.
    
    Specified by:
    
    deleteSshPublicKey in interface AWSTransfer
    
    Parameters:
    
    deleteSshPublicKeyRequest -
    
    Returns:
    
    Result of the DeleteSshPublicKey operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
public DeleteUserResult deleteUser(DeleteUserRequest request)
```
    Deletes the user belonging to the server you specify.
    
    No response returns from this call.
    
    When you delete a user from a server, the user's information is lost.
    
    Specified by:
    
    deleteUser in interface AWSTransfer
    
    Parameters:
    
    deleteUserRequest -
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
    
    See Also:
    
    AWS API Documentation
  - describeServer
```
public DescribeServerResult describeServer(DescribeServerRequest request)
```
    Describes the server that you specify by passing the ServerId parameter.
    
    The response contains a description of the server's properties.
    
    Specified by:
    
    describeServer in interface AWSTransfer
    
    Parameters:
    
    describeServerRequest -
    
    Returns:
    
    Result of the DescribeServer operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
    
    See Also:
    
    AWS API Documentation
  - describeUser
```
public DescribeUserResult describeUser(DescribeUserRequest request)
```
    Describes the user assigned to a specific server, as identified by its ServerId property.
    
    The response from this call returns the properties of the user associated with the ServerId value that was specified.
    
    Specified by:
    
    describeUser in interface AWSTransfer
    
    Parameters:
    
    describeUserRequest -
    
    Returns:
    
    Result of the DescribeUser operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
    
    See Also:
    
    AWS API Documentation
  - importSshPublicKey
```
public ImportSshPublicKeyResult importSshPublicKey(ImportSshPublicKeyRequest request)
```
    Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to a specific server, identified by ServerId.
    
    The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.
    
    Specified by:
    
    importSshPublicKey in interface AWSTransfer
    
    Parameters:
    
    importSshPublicKeyRequest -
    
    Returns:
    
    Result of the ImportSshPublicKey operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    ResourceExistsException - The requested resource does not exist.
    
    ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
    
    See Also:
    
    AWS API Documentation
  - listServers
```
public ListServersResult listServers(ListServersRequest request)
```
    Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.
    
    Specified by:
    
    listServers in interface AWSTransfer
    
    Parameters:
    
    listServersRequest -
    
    Returns:
    
    Result of the ListServers operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidNextTokenException - The NextToken parameter that was passed is invalid.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.
    
    Specified by:
    
    listTagsForResource in interface AWSTransfer
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidNextTokenException - The NextToken parameter that was passed is invalid.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
public ListUsersResult listUsers(ListUsersRequest request)
```
    Lists the users for the server that you specify by passing the ServerId parameter.
    
    Specified by:
    
    listUsers in interface AWSTransfer
    
    Parameters:
    
    listUsersRequest -
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidNextTokenException - The NextToken parameter that was passed is invalid.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
    
    See Also:
    
    AWS API Documentation
  - startServer
```
public StartServerResult startServer(StartServerRequest request)
```
    Changes the state of a Secure File Transfer Protocol (SFTP) server from OFFLINE to ONLINE. It has no impact on an SFTP server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.
    
    The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.
    
    No response is returned from this call.
    
    Specified by:
    
    startServer in interface AWSTransfer
    
    Parameters:
    
    startServerRequest -
    
    Returns:
    
    Result of the StartServer operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
    
    See Also:
    
    AWS API Documentation
  - stopServer
```
public StopServerResult stopServer(StopServerRequest request)
```
    Changes the state of an SFTP server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server such as server and user properties are not affected by stopping your server. Stopping a server will not reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing.
    
    The states of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.
    
    No response is returned from this call.
    
    Specified by:
    
    stopServer in interface AWSTransfer
    
    Parameters:
    
    stopServerRequest -
    
    Returns:
    
    Result of the StopServer operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
    
    There is no response returned from this call.
    
    Specified by:
    
    tagResource in interface AWSTransfer
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - testIdentityProvider
```
public TestIdentityProviderResult testIdentityProvider(TestIdentityProviderRequest request)
```
    If the IdentityProviderType of the server is API_Gateway, tests whether your API Gateway is set up successfully. We highly recommend that you call this method to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service.
    
    Specified by:
    
    testIdentityProvider in interface AWSTransfer
    
    Parameters:
    
    testIdentityProviderRequest -
    
    Returns:
    
    Result of the TestIdentityProvider operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
    
    No response is returned from this call.
    
    Specified by:
    
    untagResource in interface AWSTransfer
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - updateServer
```
public UpdateServerResult updateServer(UpdateServerRequest request)
```
    Updates the server properties after that server has been created.
    
    The UpdateServer call returns the ServerId of the Secure File Transfer Protocol (SFTP) server you updated.
    
    Specified by:
    
    updateServer in interface AWSTransfer
    
    Parameters:
    
    updateServerRequest -
    
    Returns:
    
    Result of the UpdateServer operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
    
    See Also:
    
    AWS API Documentation
  - updateUser
```
public UpdateUserResult updateUser(UpdateUserRequest request)
```
    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.
    
    Specified by:
    
    updateUser in interface AWSTransfer
    
    Parameters:
    
    updateUserRequest -
    
    Returns:
    
    Result of the UpdateUser operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the AWS Transfer for SFTP service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSTransfer
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AWSTransferClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.transfer.AWSTransfer

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.transfer.AWSTransfer

Method Detail

builder

createServer

createUser

deleteServer

deleteSshPublicKey

deleteUser

describeServer

describeUser

importSshPublicKey

listServers

listTagsForResource

listUsers

startServer

stopServer

tagResource

testIdentityProvider

untagResource

updateServer

updateUser

getCachedResponseMetadata