AWSTransferAsyncClient (AWS SDK for Java

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

All Implemented Interfaces:

AWSTransfer, AWSTransferAsync
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSTransferAsyncClient
extends AWSTransferClient
implements AWSTransferAsync
```
Client for accessing AWS Transfer asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Amazon Web Services Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3). Amazon Web Services helps you seamlessly migrate your file transfer workflows to Amazon Web Services Transfer Family 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 Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and archiving. Getting started with Amazon Web Services Transfer Family is easy since there is no infrastructure to buy and set up.

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 AWSTransferAsyncClientBuilder`	`asyncBuilder()`
`Future<CreateAccessResult>`	`createAccessAsync(CreateAccessRequest request)` Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Amazon Web Services Transfer Family.
`Future<CreateAccessResult>`	`createAccessAsync(CreateAccessRequest request, AsyncHandler<CreateAccessRequest,CreateAccessResult> asyncHandler)` Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Amazon Web Services Transfer Family.
`Future<CreateServerResult>`	`createServerAsync(CreateServerRequest request)` Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
`Future<CreateServerResult>`	`createServerAsync(CreateServerRequest request, AsyncHandler<CreateServerRequest,CreateServerResult> asyncHandler)` Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
`Future<CreateUserResult>`	`createUserAsync(CreateUserRequest request)` Creates a user and associates them with an existing file transfer protocol-enabled server.
`Future<CreateUserResult>`	`createUserAsync(CreateUserRequest request, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)` Creates a user and associates them with an existing file transfer protocol-enabled server.
`Future<CreateWorkflowResult>`	`createWorkflowAsync(CreateWorkflowRequest request)` Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.
`Future<CreateWorkflowResult>`	`createWorkflowAsync(CreateWorkflowRequest request, AsyncHandler<CreateWorkflowRequest,CreateWorkflowResult> asyncHandler)` Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.
`Future<DeleteAccessResult>`	`deleteAccessAsync(DeleteAccessRequest request)` Allows you to delete the access specified in the `ServerID` and `ExternalID` parameters.
`Future<DeleteAccessResult>`	`deleteAccessAsync(DeleteAccessRequest request, AsyncHandler<DeleteAccessRequest,DeleteAccessResult> asyncHandler)` Allows you to delete the access specified in the `ServerID` and `ExternalID` parameters.
`Future<DeleteServerResult>`	`deleteServerAsync(DeleteServerRequest request)` Deletes the file transfer protocol-enabled server that you specify.
`Future<DeleteServerResult>`	`deleteServerAsync(DeleteServerRequest request, AsyncHandler<DeleteServerRequest,DeleteServerResult> asyncHandler)` Deletes the file transfer protocol-enabled 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 a file transfer protocol-enabled server you specify.
`Future<DeleteUserResult>`	`deleteUserAsync(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)` Deletes the user belonging to a file transfer protocol-enabled server you specify.
`Future<DeleteWorkflowResult>`	`deleteWorkflowAsync(DeleteWorkflowRequest request)` Deletes the specified workflow.
`Future<DeleteWorkflowResult>`	`deleteWorkflowAsync(DeleteWorkflowRequest request, AsyncHandler<DeleteWorkflowRequest,DeleteWorkflowResult> asyncHandler)` Deletes the specified workflow.
`Future<DescribeAccessResult>`	`describeAccessAsync(DescribeAccessRequest request)` Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its `ServerId` property and its `ExternalID`.
`Future<DescribeAccessResult>`	`describeAccessAsync(DescribeAccessRequest request, AsyncHandler<DescribeAccessRequest,DescribeAccessResult> asyncHandler)` Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its `ServerId` property and its `ExternalID`.
`Future<DescribeExecutionResult>`	`describeExecutionAsync(DescribeExecutionRequest request)` You can use `DescribeExecution` to check the details of the execution of the specified workflow.
`Future<DescribeExecutionResult>`	`describeExecutionAsync(DescribeExecutionRequest request, AsyncHandler<DescribeExecutionRequest,DescribeExecutionResult> asyncHandler)` You can use `DescribeExecution` to check the details of the execution of the specified workflow.
`Future<DescribeSecurityPolicyResult>`	`describeSecurityPolicyAsync(DescribeSecurityPolicyRequest request)` Describes the security policy that is attached to your file transfer protocol-enabled server.
`Future<DescribeSecurityPolicyResult>`	`describeSecurityPolicyAsync(DescribeSecurityPolicyRequest request, AsyncHandler<DescribeSecurityPolicyRequest,DescribeSecurityPolicyResult> asyncHandler)` Describes the security policy that is attached to your file transfer protocol-enabled server.
`Future<DescribeServerResult>`	`describeServerAsync(DescribeServerRequest request)` Describes a file transfer protocol-enabled server that you specify by passing the `ServerId` parameter.
`Future<DescribeServerResult>`	`describeServerAsync(DescribeServerRequest request, AsyncHandler<DescribeServerRequest,DescribeServerResult> asyncHandler)` Describes a file transfer protocol-enabled server that you specify by passing the `ServerId` parameter.
`Future<DescribeUserResult>`	`describeUserAsync(DescribeUserRequest request)` Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its `ServerId` property.
`Future<DescribeUserResult>`	`describeUserAsync(DescribeUserRequest request, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)` Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its `ServerId` property.
`Future<DescribeWorkflowResult>`	`describeWorkflowAsync(DescribeWorkflowRequest request)` Describes the specified workflow.
`Future<DescribeWorkflowResult>`	`describeWorkflowAsync(DescribeWorkflowRequest request, AsyncHandler<DescribeWorkflowRequest,DescribeWorkflowResult> asyncHandler)` Describes the specified workflow.
`ExecutorService`	`getExecutorService()` Returns the executor service used by this client to execute async requests.
`Future<ImportSshPublicKeyResult>`	`importSshPublicKeyAsync(ImportSshPublicKeyRequest request)` Adds a Secure Shell (SSH) public key to a user account identified by a `UserName` value assigned to the specific file transfer protocol-enabled 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 the specific file transfer protocol-enabled server, identified by `ServerId`.
`Future<ListAccessesResult>`	`listAccessesAsync(ListAccessesRequest request)` Lists the details for all the accesses you have on your server.
`Future<ListAccessesResult>`	`listAccessesAsync(ListAccessesRequest request, AsyncHandler<ListAccessesRequest,ListAccessesResult> asyncHandler)` Lists the details for all the accesses you have on your server.
`Future<ListExecutionsResult>`	`listExecutionsAsync(ListExecutionsRequest request)` Lists all executions for the specified workflow.
`Future<ListExecutionsResult>`	`listExecutionsAsync(ListExecutionsRequest request, AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler)` Lists all executions for the specified workflow.
`Future<ListSecurityPoliciesResult>`	`listSecurityPoliciesAsync(ListSecurityPoliciesRequest request)` Lists the security policies that are attached to your file transfer protocol-enabled servers.
`Future<ListSecurityPoliciesResult>`	`listSecurityPoliciesAsync(ListSecurityPoliciesRequest request, AsyncHandler<ListSecurityPoliciesRequest,ListSecurityPoliciesResult> asyncHandler)` Lists the security policies that are attached to your file transfer protocol-enabled servers.
`Future<ListServersResult>`	`listServersAsync(ListServersRequest request)` Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
`Future<ListServersResult>`	`listServersAsync(ListServersRequest request, AsyncHandler<ListServersRequest,ListServersResult> asyncHandler)` Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
`Future<ListTagsForResourceResult>`	`listTagsForResourceAsync(ListTagsForResourceRequest request)` Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
`Future<ListTagsForResourceResult>`	`listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)` Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
`Future<ListUsersResult>`	`listUsersAsync(ListUsersRequest request)` Lists the users for a file transfer protocol-enabled server that you specify by passing the `ServerId` parameter.
`Future<ListUsersResult>`	`listUsersAsync(ListUsersRequest request, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)` Lists the users for a file transfer protocol-enabled server that you specify by passing the `ServerId` parameter.
`Future<ListWorkflowsResult>`	`listWorkflowsAsync(ListWorkflowsRequest request)` Lists all of your workflows.
`Future<ListWorkflowsResult>`	`listWorkflowsAsync(ListWorkflowsRequest request, AsyncHandler<ListWorkflowsRequest,ListWorkflowsResult> asyncHandler)` Lists all of your workflows.
`Future<SendWorkflowStepStateResult>`	`sendWorkflowStepStateAsync(SendWorkflowStepStateRequest request)` Sends a callback for asynchronous custom steps.
`Future<SendWorkflowStepStateResult>`	`sendWorkflowStepStateAsync(SendWorkflowStepStateRequest request, AsyncHandler<SendWorkflowStepStateRequest,SendWorkflowStepStateResult> asyncHandler)` Sends a callback for asynchronous custom steps.
`void`	`shutdown()` Shuts down the client, releasing all managed resources.
`Future<StartServerResult>`	`startServerAsync(StartServerRequest request)` Changes the state of a file transfer protocol-enabled server from `OFFLINE` to `ONLINE`.
`Future<StartServerResult>`	`startServerAsync(StartServerRequest request, AsyncHandler<StartServerRequest,StartServerResult> asyncHandler)` Changes the state of a file transfer protocol-enabled server from `OFFLINE` to `ONLINE`.
`Future<StopServerResult>`	`stopServerAsync(StopServerRequest request)` Changes the state of a file transfer protocol-enabled server from `ONLINE` to `OFFLINE`.
`Future<StopServerResult>`	`stopServerAsync(StopServerRequest request, AsyncHandler<StopServerRequest,StopServerResult> asyncHandler)` Changes the state of a file transfer protocol-enabled 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 a file transfer protocol-enabled server is `AWS_DIRECTORY_SERVICE` or `API_Gateway`, tests whether your identity provider is set up successfully.
`Future<TestIdentityProviderResult>`	`testIdentityProviderAsync(TestIdentityProviderRequest request, AsyncHandler<TestIdentityProviderRequest,TestIdentityProviderResult> asyncHandler)` If the `IdentityProviderType` of a file transfer protocol-enabled server is `AWS_DIRECTORY_SERVICE` or `API_Gateway`, tests whether your identity provider 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<UpdateAccessResult>`	`updateAccessAsync(UpdateAccessRequest request)` Allows you to update parameters for the access specified in the `ServerID` and `ExternalID` parameters.
`Future<UpdateAccessResult>`	`updateAccessAsync(UpdateAccessRequest request, AsyncHandler<UpdateAccessRequest,UpdateAccessResult> asyncHandler)` Allows you to update parameters for the access specified in the `ServerID` and `ExternalID` parameters.
`Future<UpdateServerResult>`	`updateServerAsync(UpdateServerRequest request)` Updates the file transfer protocol-enabled server's properties after that server has been created.
`Future<UpdateServerResult>`	`updateServerAsync(UpdateServerRequest request, AsyncHandler<UpdateServerRequest,UpdateServerResult> asyncHandler)` Updates the file transfer protocol-enabled server's 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.AWSTransferClient
builder, createAccess, createServer, createUser, createWorkflow, deleteAccess, deleteServer, deleteSshPublicKey, deleteUser, deleteWorkflow, describeAccess, describeExecution, describeSecurityPolicy, describeServer, describeUser, describeWorkflow, getCachedResponseMetadata, importSshPublicKey, listAccesses, listExecutions, listSecurityPolicies, listServers, listTagsForResource, listUsers, listWorkflows, sendWorkflowStepState, startServer, stopServer, tagResource, testIdentityProvider, untagResource, updateAccess, 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
createAccess, createServer, createUser, createWorkflow, deleteAccess, deleteServer, deleteSshPublicKey, deleteUser, deleteWorkflow, describeAccess, describeExecution, describeSecurityPolicy, describeServer, describeUser, describeWorkflow, getCachedResponseMetadata, importSshPublicKey, listAccesses, listExecutions, listSecurityPolicies, listServers, listTagsForResource, listUsers, listWorkflows, sendWorkflowStepState, startServer, stopServer, tagResource, testIdentityProvider, untagResource, updateAccess, updateServer, updateUser

- Method Detail
  - asyncBuilder
```
public static AWSTransferAsyncClientBuilder asyncBuilder()
```
  - getExecutorService
```
public ExecutorService getExecutorService()
```
    Returns the executor service used by this client to execute async requests.
    
    Returns:
    
    The executor service used by this client to execute async requests.
  - createAccessAsync
```
public Future<CreateAccessResult> createAccessAsync(CreateAccessRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Amazon Web Services Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.
    
    Specified by:
    
    createAccessAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the CreateAccess operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAccessAsync
```
public Future<CreateAccessResult> createAccessAsync(CreateAccessRequest request,
                                                    AsyncHandler<CreateAccessRequest,CreateAccessResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Amazon Web Services Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.
    
    Specified by:
    
    createAccessAsync 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 CreateAccess operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createServerAsync
```
public Future<CreateServerResult> createServerAsync(CreateServerRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to 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 auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to 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
    
    Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. 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 Amazon Web Services Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.
    
    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
    
    Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. 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 Amazon Web Services Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.
    
    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
  - createWorkflowAsync
```
public Future<CreateWorkflowResult> createWorkflowAsync(CreateWorkflowRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.
    
    Specified by:
    
    createWorkflowAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the CreateWorkflow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createWorkflowAsync
```
public Future<CreateWorkflowResult> createWorkflowAsync(CreateWorkflowRequest request,
                                                        AsyncHandler<CreateWorkflowRequest,CreateWorkflowResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.
    
    Specified by:
    
    createWorkflowAsync 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 CreateWorkflow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAccessAsync
```
public Future<DeleteAccessResult> deleteAccessAsync(DeleteAccessRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Allows you to delete the access specified in the ServerID and ExternalID parameters.
    
    Specified by:
    
    deleteAccessAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the DeleteAccess operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAccessAsync
```
public Future<DeleteAccessResult> deleteAccessAsync(DeleteAccessRequest request,
                                                    AsyncHandler<DeleteAccessRequest,DeleteAccessResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    Allows you to delete the access specified in the ServerID and ExternalID parameters.
    
    Specified by:
    
    deleteAccessAsync 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 DeleteAccess operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteServerAsync
```
public Future<DeleteServerResult> deleteServerAsync(DeleteServerRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Deletes the file transfer protocol-enabled server that you specify.
    
    No response returns from this operation.
    
    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 file transfer protocol-enabled server that you specify.
    
    No response returns from this operation.
    
    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.
    
    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.
    
    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 a file transfer protocol-enabled server you specify.
    
    No response returns from this operation.
    
    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 a file transfer protocol-enabled server you specify.
    
    No response returns from this operation.
    
    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
  - deleteWorkflowAsync
```
public Future<DeleteWorkflowResult> deleteWorkflowAsync(DeleteWorkflowRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Deletes the specified workflow.
    
    Specified by:
    
    deleteWorkflowAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the DeleteWorkflow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkflowAsync
```
public Future<DeleteWorkflowResult> deleteWorkflowAsync(DeleteWorkflowRequest request,
                                                        AsyncHandler<DeleteWorkflowRequest,DeleteWorkflowResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    Deletes the specified workflow.
    
    Specified by:
    
    deleteWorkflowAsync 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 DeleteWorkflow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAccessAsync
```
public Future<DescribeAccessResult> describeAccessAsync(DescribeAccessRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalID.
    
    The response from this call returns the properties of the access that is associated with the ServerId value that was specified.
    
    Specified by:
    
    describeAccessAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the DescribeAccess operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAccessAsync
```
public Future<DescribeAccessResult> describeAccessAsync(DescribeAccessRequest request,
                                                        AsyncHandler<DescribeAccessRequest,DescribeAccessResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalID.
    
    The response from this call returns the properties of the access that is associated with the ServerId value that was specified.
    
    Specified by:
    
    describeAccessAsync 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 DescribeAccess operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeExecutionAsync
```
public Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    You can use DescribeExecution to check the details of the execution of the specified workflow.
    
    Specified by:
    
    describeExecutionAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the DescribeExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeExecutionAsync
```
public Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest request,
                                                              AsyncHandler<DescribeExecutionRequest,DescribeExecutionResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    You can use DescribeExecution to check the details of the execution of the specified workflow.
    
    Specified by:
    
    describeExecutionAsync 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 DescribeExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSecurityPolicyAsync
```
public Future<DescribeSecurityPolicyResult> describeSecurityPolicyAsync(DescribeSecurityPolicyRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.
    
    Specified by:
    
    describeSecurityPolicyAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the DescribeSecurityPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSecurityPolicyAsync
```
public Future<DescribeSecurityPolicyResult> describeSecurityPolicyAsync(DescribeSecurityPolicyRequest request,
                                                                        AsyncHandler<DescribeSecurityPolicyRequest,DescribeSecurityPolicyResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.
    
    Specified by:
    
    describeSecurityPolicyAsync 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 DescribeSecurityPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeServerAsync
```
public Future<DescribeServerResult> describeServerAsync(DescribeServerRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
    
    The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.
    
    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 a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
    
    The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.
    
    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 the specific file transfer protocol-enabled 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 the specific file transfer protocol-enabled 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
  - describeWorkflowAsync
```
public Future<DescribeWorkflowResult> describeWorkflowAsync(DescribeWorkflowRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Describes the specified workflow.
    
    Specified by:
    
    describeWorkflowAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the DescribeWorkflow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeWorkflowAsync
```
public Future<DescribeWorkflowResult> describeWorkflowAsync(DescribeWorkflowRequest request,
                                                            AsyncHandler<DescribeWorkflowRequest,DescribeWorkflowResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    Describes the specified workflow.
    
    Specified by:
    
    describeWorkflowAsync 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 DescribeWorkflow 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 the specific file transfer protocol-enabled 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 the specific file transfer protocol-enabled 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
  - listAccessesAsync
```
public Future<ListAccessesResult> listAccessesAsync(ListAccessesRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Lists the details for all the accesses you have on your server.
    
    Specified by:
    
    listAccessesAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the ListAccesses operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAccessesAsync
```
public Future<ListAccessesResult> listAccessesAsync(ListAccessesRequest request,
                                                    AsyncHandler<ListAccessesRequest,ListAccessesResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    Lists the details for all the accesses you have on your server.
    
    Specified by:
    
    listAccessesAsync 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 ListAccesses operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listExecutionsAsync
```
public Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Lists all executions for the specified workflow.
    
    Specified by:
    
    listExecutionsAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the ListExecutions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listExecutionsAsync
```
public Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest request,
                                                        AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    Lists all executions for the specified workflow.
    
    Specified by:
    
    listExecutionsAsync 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 ListExecutions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSecurityPoliciesAsync
```
public Future<ListSecurityPoliciesResult> listSecurityPoliciesAsync(ListSecurityPoliciesRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Lists the security policies that are attached to your file transfer protocol-enabled servers.
    
    Specified by:
    
    listSecurityPoliciesAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the ListSecurityPolicies operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSecurityPoliciesAsync
```
public Future<ListSecurityPoliciesResult> listSecurityPoliciesAsync(ListSecurityPoliciesRequest request,
                                                                    AsyncHandler<ListSecurityPoliciesRequest,ListSecurityPoliciesResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    Lists the security policies that are attached to your file transfer protocol-enabled servers.
    
    Specified by:
    
    listSecurityPoliciesAsync 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 ListSecurityPolicies operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listServersAsync
```
public Future<ListServersResult> listServersAsync(ListServersRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services 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 file transfer protocol-enabled servers that are associated with your Amazon Web Services 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 Name (ARN) that 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 Name (ARN) that 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 a file transfer protocol-enabled 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 a file transfer protocol-enabled 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
  - listWorkflowsAsync
```
public Future<ListWorkflowsResult> listWorkflowsAsync(ListWorkflowsRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Lists all of your workflows.
    
    Specified by:
    
    listWorkflowsAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the ListWorkflows operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listWorkflowsAsync
```
public Future<ListWorkflowsResult> listWorkflowsAsync(ListWorkflowsRequest request,
                                                      AsyncHandler<ListWorkflowsRequest,ListWorkflowsResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    Lists all of your workflows.
    
    Specified by:
    
    listWorkflowsAsync 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 ListWorkflows operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - sendWorkflowStepStateAsync
```
public Future<SendWorkflowStepStateResult> sendWorkflowStepStateAsync(SendWorkflowStepStateRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Sends a callback for asynchronous custom steps.
    
    The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.
    
    Specified by:
    
    sendWorkflowStepStateAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the SendWorkflowStepState operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - sendWorkflowStepStateAsync
```
public Future<SendWorkflowStepStateResult> sendWorkflowStepStateAsync(SendWorkflowStepStateRequest request,
                                                                      AsyncHandler<SendWorkflowStepStateRequest,SendWorkflowStepStateResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    Sends a callback for asynchronous custom steps.
    
    The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.
    
    Specified by:
    
    sendWorkflowStepStateAsync 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 SendWorkflowStepState 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 file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a 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 file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a 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 a file transfer protocol-enabled 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 the server will not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.
    
    The state 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 a file transfer protocol-enabled 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 the server will not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.
    
    The state 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 a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.
    
    The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional.
    
    You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.
    - If you provide any incorrect values for any parameters, the Response field is empty.
    - If you provide a server ID for a server that uses service-managed users, you get an error:
      
      An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth
    - If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error:
      
      An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server
    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 a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.
    
    The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional.
    
    You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.
    - If you provide any incorrect values for any parameters, the Response field is empty.
    - If you provide a server ID for a server that uses service-managed users, you get an error:
      
      An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth
    - If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error:
      
      An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server
    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
  - updateAccessAsync
```
public Future<UpdateAccessResult> updateAccessAsync(UpdateAccessRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.
    
    Specified by:
    
    updateAccessAsync in interface AWSTransferAsync
    
    Returns:
    
    A Java Future containing the result of the UpdateAccess operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAccessAsync
```
public Future<UpdateAccessResult> updateAccessAsync(UpdateAccessRequest request,
                                                    AsyncHandler<UpdateAccessRequest,UpdateAccessResult> asyncHandler)
```
    Description copied from interface: AWSTransferAsync
    
    Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.
    
    Specified by:
    
    updateAccessAsync 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 UpdateAccess operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateServerAsync
```
public Future<UpdateServerResult> updateServerAsync(UpdateServerRequest request)
```
    Description copied from interface: AWSTransferAsync
    
    Updates the file transfer protocol-enabled server's properties after that server has been created.
    
    The UpdateServer call returns the ServerId of the 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 file transfer protocol-enabled server's properties after that server has been created.
    
    The UpdateServer call returns the ServerId of the 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
  - shutdown
```
public void shutdown()
```
    Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.
    
    Specified by:
    
    shutdown in interface AWSTransfer
    
    Overrides:
    
    shutdown in class AWSTransferClient

Did this page help you?

Class AWSTransferAsyncClient

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.services.transfer.AWSTransferClient

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

asyncBuilder

getExecutorService

createAccessAsync

createAccessAsync

createServerAsync

createServerAsync

createUserAsync

createUserAsync

createWorkflowAsync

createWorkflowAsync

deleteAccessAsync

deleteAccessAsync

deleteServerAsync

deleteServerAsync

deleteSshPublicKeyAsync

deleteSshPublicKeyAsync

deleteUserAsync

deleteUserAsync

deleteWorkflowAsync

deleteWorkflowAsync

describeAccessAsync

describeAccessAsync

describeExecutionAsync

describeExecutionAsync

describeSecurityPolicyAsync

describeSecurityPolicyAsync

describeServerAsync

describeServerAsync

describeUserAsync

describeUserAsync

describeWorkflowAsync

describeWorkflowAsync

importSshPublicKeyAsync

importSshPublicKeyAsync

listAccessesAsync

listAccessesAsync

listExecutionsAsync

listExecutionsAsync

listSecurityPoliciesAsync

listSecurityPoliciesAsync

listServersAsync

listServersAsync

listTagsForResourceAsync

listTagsForResourceAsync

listUsersAsync

listUsersAsync

listWorkflowsAsync

listWorkflowsAsync

sendWorkflowStepStateAsync

sendWorkflowStepStateAsync

startServerAsync

startServerAsync

stopServerAsync

stopServerAsync

tagResourceAsync

tagResourceAsync

testIdentityProviderAsync

testIdentityProviderAsync

untagResourceAsync

untagResourceAsync

updateAccessAsync

updateAccessAsync

updateServerAsync

updateServerAsync

updateUserAsync

updateUserAsync

shutdown