AbstractAWSTransferAsync (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.transfer.AbstractAWSTransfer
- - com.amazonaws.services.transfer.AbstractAWSTransferAsync

All Implemented Interfaces:

AWSTransfer, AWSTransferAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSTransferAsync
extends AbstractAWSTransfer
implements AWSTransferAsync
```
Abstract implementation of AWSTransferAsync. Convenient method forms pass through to the corresponding overload that takes a request object and an AsyncHandler, which throws an UnsupportedOperationException.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Future<CreateServerResult>`	`createServerAsync(CreateServerRequest request)` Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS.
`Future<CreateServerResult>`	`createServerAsync(CreateServerRequest request, AsyncHandler<CreateServerRequest,CreateServerResult> asyncHandler)` Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS.
`Future<CreateUserResult>`	`createUserAsync(CreateUserRequest request)` Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server.
`Future<CreateUserResult>`	`createUserAsync(CreateUserRequest request, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)` Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server.
`Future<DeleteServerResult>`	`deleteServerAsync(DeleteServerRequest request)` Deletes the Secure File Transfer Protocol (SFTP) server that you specify.
`Future<DeleteServerResult>`	`deleteServerAsync(DeleteServerRequest request, AsyncHandler<DeleteServerRequest,DeleteServerResult> asyncHandler)` Deletes the Secure File Transfer Protocol (SFTP) server that you specify.
`Future<DeleteSshPublicKeyResult>`	`deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest request)` Deletes a user's Secure Shell (SSH) public key.
`Future<DeleteSshPublicKeyResult>`	`deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest request, AsyncHandler<DeleteSshPublicKeyRequest,DeleteSshPublicKeyResult> asyncHandler)` Deletes a user's Secure Shell (SSH) public key.
`Future<DeleteUserResult>`	`deleteUserAsync(DeleteUserRequest request)` Deletes the user belonging to the server you specify.
`Future<DeleteUserResult>`	`deleteUserAsync(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)` Deletes the user belonging to the server you specify.
`Future<DescribeServerResult>`	`describeServerAsync(DescribeServerRequest request)` Describes the server that you specify by passing the `ServerId` parameter.
`Future<DescribeServerResult>`	`describeServerAsync(DescribeServerRequest request, AsyncHandler<DescribeServerRequest,DescribeServerResult> asyncHandler)` Describes the server that you specify by passing the `ServerId` parameter.
`Future<DescribeUserResult>`	`describeUserAsync(DescribeUserRequest request)` Describes the user assigned to a specific server, as identified by its `ServerId` property.
`Future<DescribeUserResult>`	`describeUserAsync(DescribeUserRequest request, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)` Describes the user assigned to a specific server, as identified by its `ServerId` property.
`Future<ImportSshPublicKeyResult>`	`importSshPublicKeyAsync(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`.
`Future<ImportSshPublicKeyResult>`	`importSshPublicKeyAsync(ImportSshPublicKeyRequest request, AsyncHandler<ImportSshPublicKeyRequest,ImportSshPublicKeyResult> asyncHandler)` Adds a Secure Shell (SSH) public key to a user account identified by a `UserName` value assigned to a specific server, identified by `ServerId`.
`Future<ListServersResult>`	`listServersAsync(ListServersRequest request)` Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.
`Future<ListServersResult>`	`listServersAsync(ListServersRequest request, AsyncHandler<ListServersRequest,ListServersResult> asyncHandler)` Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.
`Future<ListTagsForResourceResult>`	`listTagsForResourceAsync(ListTagsForResourceRequest request)` Lists all of the tags associated with the Amazon Resource Number (ARN) you specify.
`Future<ListTagsForResourceResult>`	`listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)` Lists all of the tags associated with the Amazon Resource Number (ARN) you specify.
`Future<ListUsersResult>`	`listUsersAsync(ListUsersRequest request)` Lists the users for the server that you specify by passing the `ServerId` parameter.
`Future<ListUsersResult>`	`listUsersAsync(ListUsersRequest request, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)` Lists the users for the server that you specify by passing the `ServerId` parameter.
`Future<StartServerResult>`	`startServerAsync(StartServerRequest request)` Changes the state of a Secure File Transfer Protocol (SFTP) server from `OFFLINE` to `ONLINE`.
`Future<StartServerResult>`	`startServerAsync(StartServerRequest request, AsyncHandler<StartServerRequest,StartServerResult> asyncHandler)` Changes the state of a Secure File Transfer Protocol (SFTP) server from `OFFLINE` to `ONLINE`.
`Future<StopServerResult>`	`stopServerAsync(StopServerRequest request)` Changes the state of an SFTP server from `ONLINE` to `OFFLINE`.
`Future<StopServerResult>`	`stopServerAsync(StopServerRequest request, AsyncHandler<StopServerRequest,StopServerResult> asyncHandler)` Changes the state of an SFTP server from `ONLINE` to `OFFLINE`.
`Future<TagResourceResult>`	`tagResourceAsync(TagResourceRequest request)` Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
`Future<TagResourceResult>`	`tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)` Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
`Future<TestIdentityProviderResult>`	`testIdentityProviderAsync(TestIdentityProviderRequest request)` If the `IdentityProviderType` of the server is `API_Gateway`, tests whether your API Gateway is set up successfully.
`Future<TestIdentityProviderResult>`	`testIdentityProviderAsync(TestIdentityProviderRequest request, AsyncHandler<TestIdentityProviderRequest,TestIdentityProviderResult> asyncHandler)` If the `IdentityProviderType` of the server is `API_Gateway`, tests whether your API Gateway is set up successfully.
`Future<UntagResourceResult>`	`untagResourceAsync(UntagResourceRequest request)` Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
`Future<UntagResourceResult>`	`untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)` Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
`Future<UpdateServerResult>`	`updateServerAsync(UpdateServerRequest request)` Updates the server properties after that server has been created.
`Future<UpdateServerResult>`	`updateServerAsync(UpdateServerRequest request, AsyncHandler<UpdateServerRequest,UpdateServerResult> asyncHandler)` Updates the server properties after that server has been created.
`Future<UpdateUserResult>`	`updateUserAsync(UpdateUserRequest request)` Assigns new properties to a user.
`Future<UpdateUserResult>`	`updateUserAsync(UpdateUserRequest request, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)` Assigns new properties to a user.

Methods inherited from class com.amazonaws.services.transfer.AbstractAWSTransfer
createServer, createUser, deleteServer, deleteSshPublicKey, deleteUser, describeServer, describeUser, getCachedResponseMetadata, importSshPublicKey, listServers, listTagsForResource, listUsers, shutdown, startServer, stopServer, tagResource, testIdentityProvider, untagResource, updateServer, updateUser

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
createServer, createUser, deleteServer, deleteSshPublicKey, deleteUser, describeServer, describeUser, getCachedResponseMetadata, importSshPublicKey, listServers, listTagsForResource, listUsers, shutdown, startServer, stopServer, tagResource, testIdentityProvider, untagResource, updateServer, updateUser

- Method Detail
  - createServerAsync
```
public Future<CreateServerResult> createServerAsync(CreateServerRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    createServerAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the CreateServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createServerAsync
```
public Future<CreateServerResult> createServerAsync(CreateServerRequest request,
                                                    AsyncHandler<CreateServerRequest,CreateServerResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    createServerAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the CreateServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createUserAsync
```
public Future<CreateUserResult> createUserAsync(CreateUserRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    createUserAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the CreateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createUserAsync
```
public Future<CreateUserResult> createUserAsync(CreateUserRequest request,
                                                AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    createUserAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the CreateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteServerAsync
```
public Future<DeleteServerResult> deleteServerAsync(DeleteServerRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    deleteServerAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the DeleteServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteServerAsync
```
public Future<DeleteServerResult> deleteServerAsync(DeleteServerRequest request,
                                                    AsyncHandler<DeleteServerRequest,DeleteServerResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    deleteServerAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the DeleteServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteSshPublicKeyAsync
```
public Future<DeleteSshPublicKeyResult> deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Deletes a user's Secure Shell (SSH) public key.
    
    No response is returned from this call.
    
    Specified by:
    
    deleteSshPublicKeyAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the DeleteSshPublicKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteSshPublicKeyAsync
```
public Future<DeleteSshPublicKeyResult> deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest request,
                                                                AsyncHandler<DeleteSshPublicKeyRequest,DeleteSshPublicKeyResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    Deletes a user's Secure Shell (SSH) public key.
    
    No response is returned from this call.
    
    Specified by:
    
    deleteSshPublicKeyAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the DeleteSshPublicKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUserAsync
```
public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    deleteUserAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the DeleteUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUserAsync
```
public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request,
                                                AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    deleteUserAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the DeleteUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeServerAsync
```
public Future<DescribeServerResult> describeServerAsync(DescribeServerRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Describes the server that you specify by passing the ServerId parameter.
    
    The response contains a description of the server's properties.
    
    Specified by:
    
    describeServerAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the DescribeServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeServerAsync
```
public Future<DescribeServerResult> describeServerAsync(DescribeServerRequest request,
                                                        AsyncHandler<DescribeServerRequest,DescribeServerResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    Describes the server that you specify by passing the ServerId parameter.
    
    The response contains a description of the server's properties.
    
    Specified by:
    
    describeServerAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the DescribeServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeUserAsync
```
public Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    describeUserAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the DescribeUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeUserAsync
```
public Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request,
                                                    AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    describeUserAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the DescribeUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importSshPublicKeyAsync
```
public Future<ImportSshPublicKeyResult> importSshPublicKeyAsync(ImportSshPublicKeyRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    importSshPublicKeyAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the ImportSshPublicKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importSshPublicKeyAsync
```
public Future<ImportSshPublicKeyResult> importSshPublicKeyAsync(ImportSshPublicKeyRequest request,
                                                                AsyncHandler<ImportSshPublicKeyRequest,ImportSshPublicKeyResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    importSshPublicKeyAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the ImportSshPublicKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listServersAsync
```
public Future<ListServersResult> listServersAsync(ListServersRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.
    
    Specified by:
    
    listServersAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the ListServers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listServersAsync
```
public Future<ListServersResult> listServersAsync(ListServersRequest request,
                                                  AsyncHandler<ListServersRequest,ListServersResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.
    
    Specified by:
    
    listServersAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the ListServers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResourceAsync
```
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    listTagsForResourceAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResourceAsync
```
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request,
                                                                  AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    listTagsForResourceAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUsersAsync
```
public Future<ListUsersResult> listUsersAsync(ListUsersRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Lists the users for the server that you specify by passing the ServerId parameter.
    
    Specified by:
    
    listUsersAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the ListUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUsersAsync
```
public Future<ListUsersResult> listUsersAsync(ListUsersRequest request,
                                              AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    Lists the users for the server that you specify by passing the ServerId parameter.
    
    Specified by:
    
    listUsersAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the ListUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startServerAsync
```
public Future<StartServerResult> startServerAsync(StartServerRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    startServerAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the StartServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startServerAsync
```
public Future<StartServerResult> startServerAsync(StartServerRequest request,
                                                  AsyncHandler<StartServerRequest,StartServerResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    startServerAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the StartServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopServerAsync
```
public Future<StopServerResult> stopServerAsync(StopServerRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    stopServerAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the StopServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopServerAsync
```
public Future<StopServerResult> stopServerAsync(StopServerRequest request,
                                                AsyncHandler<StopServerRequest,StopServerResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    stopServerAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the StopServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResourceAsync
```
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    tagResourceAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResourceAsync
```
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request,
                                                  AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    tagResourceAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - testIdentityProviderAsync
```
public Future<TestIdentityProviderResult> testIdentityProviderAsync(TestIdentityProviderRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    testIdentityProviderAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the TestIdentityProvider operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - testIdentityProviderAsync
```
public Future<TestIdentityProviderResult> testIdentityProviderAsync(TestIdentityProviderRequest request,
                                                                    AsyncHandler<TestIdentityProviderRequest,TestIdentityProviderResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    testIdentityProviderAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the TestIdentityProvider operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResourceAsync
```
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    untagResourceAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResourceAsync
```
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request,
                                                      AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    untagResourceAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateServerAsync
```
public Future<UpdateServerResult> updateServerAsync(UpdateServerRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    updateServerAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the UpdateServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateServerAsync
```
public Future<UpdateServerResult> updateServerAsync(UpdateServerRequest request,
                                                    AsyncHandler<UpdateServerRequest,UpdateServerResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    updateServerAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the UpdateServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateUserAsync
```
public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    updateUserAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the UpdateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateUserAsync
```
public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request,
                                                AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    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:
    
    updateUserAsync in interface AWSTransferAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the UpdateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation

Did this page help you?

Class AbstractAWSTransferAsync

Field Summary

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

Method Summary

Methods inherited from class com.amazonaws.services.transfer.AbstractAWSTransfer

Methods inherited from class java.lang.Object

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

Method Detail

createServerAsync

createServerAsync

createUserAsync

createUserAsync

deleteServerAsync

deleteServerAsync

deleteSshPublicKeyAsync

deleteSshPublicKeyAsync

deleteUserAsync

deleteUserAsync

describeServerAsync

describeServerAsync

describeUserAsync

describeUserAsync

importSshPublicKeyAsync

importSshPublicKeyAsync

listServersAsync

listServersAsync

listTagsForResourceAsync

listTagsForResourceAsync

listUsersAsync

listUsersAsync

startServerAsync

startServerAsync

stopServerAsync

stopServerAsync

tagResourceAsync

tagResourceAsync

testIdentityProviderAsync

testIdentityProviderAsync

untagResourceAsync

untagResourceAsync

updateServerAsync

updateServerAsync

updateUserAsync

updateUserAsync